Reverting merge from trunk
[official-gcc.git] / gcc / doc / invoke.texi
bloba3fdbb5510d7b4a11487da7922eb2cfed20ab09f
1 @c Copyright (C) 1988-2013 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-2013 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{arg} -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-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 @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  -Wsizeof-pointer-memaccess @gol
266 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
267 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
268 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
269 -Wmissing-format-attribute @gol
270 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
271 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
272 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
273 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
274 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
275 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
276 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
277 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
278 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
280 @item C and Objective-C-only Warning Options
281 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
282 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
283 -Wold-style-declaration  -Wold-style-definition @gol
284 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
285 -Wdeclaration-after-statement -Wpointer-sign}
287 @item Debugging Options
288 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
289 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
290 -fsanitize=@var{style} @gol
291 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
292 -fdisable-ipa-@var{pass_name} @gol
293 -fdisable-rtl-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
295 -fdisable-tree-@var{pass_name} @gol
296 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
297 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
298 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
299 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
300 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
301 -fdump-passes @gol
302 -fdump-statistics @gol
303 -fdump-tree-all @gol
304 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
305 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-cfg -fdump-tree-alias @gol
307 -fdump-tree-ch @gol
308 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-gimple@r{[}-raw@r{]} @gol
311 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-nrv -fdump-tree-vect @gol
318 -fdump-tree-sink @gol
319 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-vtable-verify @gol
323 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
324 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
325 -fdump-final-insns=@var{file} @gol
326 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
327 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
328 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
329 -fenable-@var{kind}-@var{pass} @gol
330 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
331 -fdebug-types-section -fmem-report-wpa @gol
332 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
333 -fopt-info @gol
334 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
335 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
336 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
337 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
338 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
339 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
340 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
341 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
342 -gvms  -gxcoff  -gxcoff+ @gol
343 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
344 -fdebug-prefix-map=@var{old}=@var{new} @gol
345 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
346 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
347 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
348 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
349 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
350 -print-sysroot -print-sysroot-headers-suffix @gol
351 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
353 @item Optimization Options
354 @xref{Optimize Options,,Options that Control Optimization}.
355 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
356 -falign-jumps[=@var{n}] @gol
357 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
358 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
359 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
360 -fbtr-bb-exclusive -fcaller-saves @gol
361 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
362 -fcompare-elim -fcprop-registers -fcrossjumping @gol
363 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
364 -fcx-limited-range @gol
365 -fdata-sections -fdce -fdelayed-branch @gol
366 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively -fdse @gol
367 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
368 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
369 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
370 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
371 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
372 -fif-conversion2 -findirect-inlining @gol
373 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
374 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
375 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
376 -fira-algorithm=@var{algorithm} @gol
377 -fira-region=@var{region} -fira-hoist-pressure @gol
378 -fira-loop-pressure -fno-ira-share-save-slots @gol
379 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
380 -fisolate-erroneous-paths
381 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
382 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
383 -floop-parallelize-all -flto -flto-compression-level @gol
384 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
385 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
386 -fmove-loop-invariants -fno-branch-count-reg @gol
387 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
388 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
389 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
390 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
391 -fomit-frame-pointer -foptimize-sibling-calls @gol
392 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
393 -fprefetch-loop-arrays -fprofile-report @gol
394 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
395 -fprofile-generate=@var{path} @gol
396 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
397 -freciprocal-math -free -frename-registers -freorder-blocks @gol
398 -freorder-blocks-and-partition -freorder-functions @gol
399 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
400 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
401 -fsched-spec-load -fsched-spec-load-dangerous @gol
402 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
403 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
404 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
405 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
406 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
407 -fselective-scheduling -fselective-scheduling2 @gol
408 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
409 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
410 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
411 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
412 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
413 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
414 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
415 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
416 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
417 -ftree-loop-if-convert-stores -ftree-loop-im @gol
418 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
419 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
420 -ftree-loop-vectorize @gol
421 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
422 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
423 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
424 -ftree-vectorize -ftree-vrp @gol
425 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
426 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
427 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
428 -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
429 --param @var{name}=@var{value}
430 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
432 @item Preprocessor Options
433 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
434 @gccoptlist{-A@var{question}=@var{answer} @gol
435 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
436 -C  -dD  -dI  -dM  -dN @gol
437 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
438 -idirafter @var{dir} @gol
439 -include @var{file}  -imacros @var{file} @gol
440 -iprefix @var{file}  -iwithprefix @var{dir} @gol
441 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
442 -imultilib @var{dir} -isysroot @var{dir} @gol
443 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
444 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
445 -remap -trigraphs  -undef  -U@var{macro}  @gol
446 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
448 @item Assembler Option
449 @xref{Assembler Options,,Passing Options to the Assembler}.
450 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
452 @item Linker Options
453 @xref{Link Options,,Options for Linking}.
454 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
455 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
456 -s  -static -static-libgcc -static-libstdc++ @gol
457 -static-libasan -static-libtsan -static-libubsan @gol
458 -shared -shared-libgcc  -symbolic @gol
459 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
460 -u @var{symbol}}
462 @item Directory Options
463 @xref{Directory Options,,Options for Directory Search}.
464 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
465 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
466 --sysroot=@var{dir} --no-sysroot-suffix}
468 @item Machine Dependent Options
469 @xref{Submodel Options,,Hardware Models and Configurations}.
470 @c This list is ordered alphanumerically by subsection name.
471 @c Try and put the significant identifier (CPU or system) first,
472 @c so users have a clue at guessing where the ones they want will be.
474 @emph{AArch64 Options}
475 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
476 -mgeneral-regs-only @gol
477 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
478 -mstrict-align @gol
479 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
480 -mtls-dialect=desc  -mtls-dialect=traditional @gol
481 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
483 @emph{Adapteva Epiphany Options}
484 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
485 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
486 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
487 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
488 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
489 -msplit-vecmove-early -m1reg-@var{reg}}
491 @emph{ARC Options}
492 @gccoptlist{-mbarrel-shifter @gol
493 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
494 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
495 -mea -mno-mpy -mmul32x16 -mmul64 @gol
496 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
497 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
498 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
499 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
500 -mucb-mcount -mvolatile-cache @gol
501 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
502 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
503 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
504 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
505 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
506 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
508 @emph{ARM Options}
509 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
510 -mabi=@var{name} @gol
511 -mapcs-stack-check  -mno-apcs-stack-check @gol
512 -mapcs-float  -mno-apcs-float @gol
513 -mapcs-reentrant  -mno-apcs-reentrant @gol
514 -msched-prolog  -mno-sched-prolog @gol
515 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
516 -mfloat-abi=@var{name} @gol
517 -mfp16-format=@var{name}
518 -mthumb-interwork  -mno-thumb-interwork @gol
519 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
520 -mstructure-size-boundary=@var{n} @gol
521 -mabort-on-noreturn @gol
522 -mlong-calls  -mno-long-calls @gol
523 -msingle-pic-base  -mno-single-pic-base @gol
524 -mpic-register=@var{reg} @gol
525 -mnop-fun-dllimport @gol
526 -mpoke-function-name @gol
527 -mthumb  -marm @gol
528 -mtpcs-frame  -mtpcs-leaf-frame @gol
529 -mcaller-super-interworking  -mcallee-super-interworking @gol
530 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
531 -mword-relocations @gol
532 -mfix-cortex-m3-ldrd @gol
533 -munaligned-access @gol
534 -mneon-for-64bits @gol
535 -mrestrict-it}
537 @emph{AVR Options}
538 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
539 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
540 -mstrict-X -mtiny-stack -Waddr-space-convert}
542 @emph{Blackfin Options}
543 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
544 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
545 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
546 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
547 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
548 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
549 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
550 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
551 -micplb}
553 @emph{C6X Options}
554 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
555 -msim -msdata=@var{sdata-type}}
557 @emph{CRIS Options}
558 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
559 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
560 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
561 -mstack-align  -mdata-align  -mconst-align @gol
562 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
563 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
564 -mmul-bug-workaround  -mno-mul-bug-workaround}
566 @emph{CR16 Options}
567 @gccoptlist{-mmac @gol
568 -mcr16cplus -mcr16c @gol
569 -msim -mint32 -mbit-ops
570 -mdata-model=@var{model}}
572 @emph{Darwin Options}
573 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
574 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
575 -client_name  -compatibility_version  -current_version @gol
576 -dead_strip @gol
577 -dependency-file  -dylib_file  -dylinker_install_name @gol
578 -dynamic  -dynamiclib  -exported_symbols_list @gol
579 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
580 -force_flat_namespace  -headerpad_max_install_names @gol
581 -iframework @gol
582 -image_base  -init  -install_name  -keep_private_externs @gol
583 -multi_module  -multiply_defined  -multiply_defined_unused @gol
584 -noall_load   -no_dead_strip_inits_and_terms @gol
585 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
586 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
587 -private_bundle  -read_only_relocs  -sectalign @gol
588 -sectobjectsymbols  -whyload  -seg1addr @gol
589 -sectcreate  -sectobjectsymbols  -sectorder @gol
590 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
591 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
592 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
593 -single_module  -static  -sub_library  -sub_umbrella @gol
594 -twolevel_namespace  -umbrella  -undefined @gol
595 -unexported_symbols_list  -weak_reference_mismatches @gol
596 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
597 -mkernel -mone-byte-bool}
599 @emph{DEC Alpha Options}
600 @gccoptlist{-mno-fp-regs  -msoft-float @gol
601 -mieee  -mieee-with-inexact  -mieee-conformant @gol
602 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
603 -mtrap-precision=@var{mode}  -mbuild-constants @gol
604 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
605 -mbwx  -mmax  -mfix  -mcix @gol
606 -mfloat-vax  -mfloat-ieee @gol
607 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
608 -msmall-text  -mlarge-text @gol
609 -mmemory-latency=@var{time}}
611 @emph{FR30 Options}
612 @gccoptlist{-msmall-model -mno-lsim}
614 @emph{FRV Options}
615 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
616 -mhard-float  -msoft-float @gol
617 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
618 -mdouble  -mno-double @gol
619 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
620 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
621 -mlinked-fp  -mlong-calls  -malign-labels @gol
622 -mlibrary-pic  -macc-4  -macc-8 @gol
623 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
624 -moptimize-membar -mno-optimize-membar @gol
625 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
626 -mvliw-branch  -mno-vliw-branch @gol
627 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
628 -mno-nested-cond-exec  -mtomcat-stats @gol
629 -mTLS -mtls @gol
630 -mcpu=@var{cpu}}
632 @emph{GNU/Linux Options}
633 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
634 -tno-android-cc -tno-android-ld}
636 @emph{H8/300 Options}
637 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
639 @emph{HPPA Options}
640 @gccoptlist{-march=@var{architecture-type} @gol
641 -mdisable-fpregs  -mdisable-indexing @gol
642 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
643 -mfixed-range=@var{register-range} @gol
644 -mjump-in-delay -mlinker-opt -mlong-calls @gol
645 -mlong-load-store  -mno-disable-fpregs @gol
646 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
647 -mno-jump-in-delay  -mno-long-load-store @gol
648 -mno-portable-runtime  -mno-soft-float @gol
649 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
650 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
651 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
652 -munix=@var{unix-std}  -nolibdld  -static  -threads}
654 @emph{i386 and x86-64 Options}
655 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
656 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
657 -mfpmath=@var{unit} @gol
658 -masm=@var{dialect}  -mno-fancy-math-387 @gol
659 -mno-fp-ret-in-387  -msoft-float @gol
660 -mno-wide-multiply  -mrtd  -malign-double @gol
661 -mpreferred-stack-boundary=@var{num} @gol
662 -mincoming-stack-boundary=@var{num} @gol
663 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
664 -mrecip -mrecip=@var{opt} @gol
665 -mvzeroupper -mprefer-avx128 @gol
666 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
667 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd @gol
668 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
669 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
670 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mthreads @gol
671 -mno-align-stringops  -minline-all-stringops @gol
672 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
673 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
674 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
675 -m96bit-long-double -mlong-double-64 -mlong-double-80 @gol
676 -mregparm=@var{num}  -msseregparm @gol
677 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
678 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
679 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
680 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
681 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
682 -msse2avx -mfentry -m8bit-idiv @gol
683 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
684 -mstack-protector-guard=@var{guard}}
686 @emph{i386 and x86-64 Windows Options}
687 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
688 -mnop-fun-dllimport -mthread @gol
689 -municode -mwin32 -mwindows -fno-set-stack-executable}
691 @emph{IA-64 Options}
692 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
693 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
694 -mconstant-gp  -mauto-pic  -mfused-madd @gol
695 -minline-float-divide-min-latency @gol
696 -minline-float-divide-max-throughput @gol
697 -mno-inline-float-divide @gol
698 -minline-int-divide-min-latency @gol
699 -minline-int-divide-max-throughput  @gol
700 -mno-inline-int-divide @gol
701 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
702 -mno-inline-sqrt @gol
703 -mdwarf2-asm -mearly-stop-bits @gol
704 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
705 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
706 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
707 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
708 -msched-spec-ldc -msched-spec-control-ldc @gol
709 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
710 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
711 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
712 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
714 @emph{LM32 Options}
715 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
716 -msign-extend-enabled -muser-enabled}
718 @emph{M32R/D Options}
719 @gccoptlist{-m32r2 -m32rx -m32r @gol
720 -mdebug @gol
721 -malign-loops -mno-align-loops @gol
722 -missue-rate=@var{number} @gol
723 -mbranch-cost=@var{number} @gol
724 -mmodel=@var{code-size-model-type} @gol
725 -msdata=@var{sdata-type} @gol
726 -mno-flush-func -mflush-func=@var{name} @gol
727 -mno-flush-trap -mflush-trap=@var{number} @gol
728 -G @var{num}}
730 @emph{M32C Options}
731 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
733 @emph{M680x0 Options}
734 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
735 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
736 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
737 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
738 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
739 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
740 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
741 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
742 -mxgot -mno-xgot}
744 @emph{MCore Options}
745 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
746 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
747 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
748 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
749 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
751 @emph{MeP Options}
752 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
753 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
754 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
755 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
756 -mtiny=@var{n}}
758 @emph{MicroBlaze Options}
759 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
760 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
761 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
762 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
763 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
765 @emph{MIPS Options}
766 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
767 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
768 -mips64  -mips64r2 @gol
769 -mips16  -mno-mips16  -mflip-mips16 @gol
770 -minterlink-compressed -mno-interlink-compressed @gol
771 -minterlink-mips16  -mno-interlink-mips16 @gol
772 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
773 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
774 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
775 -mno-float  -msingle-float  -mdouble-float @gol
776 -mabs=@var{mode}  -mnan=@var{encoding} @gol
777 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
778 -mmcu -mmno-mcu @gol
779 -meva -mno-eva @gol
780 -mmicromips -mno-micromips @gol
781 -mfpu=@var{fpu-type} @gol
782 -msmartmips  -mno-smartmips @gol
783 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
784 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
785 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
786 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
787 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
788 -membedded-data  -mno-embedded-data @gol
789 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
790 -mcode-readable=@var{setting} @gol
791 -msplit-addresses  -mno-split-addresses @gol
792 -mexplicit-relocs  -mno-explicit-relocs @gol
793 -mcheck-zero-division  -mno-check-zero-division @gol
794 -mdivide-traps  -mdivide-breaks @gol
795 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
796 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
797 -mfix-24k -mno-fix-24k @gol
798 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
799 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
800 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
801 -mflush-func=@var{func}  -mno-flush-func @gol
802 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
803 -mfp-exceptions -mno-fp-exceptions @gol
804 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
805 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
807 @emph{MMIX Options}
808 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
809 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
810 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
811 -mno-base-addresses  -msingle-exit  -mno-single-exit}
813 @emph{MN10300 Options}
814 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
815 -mno-am33 -mam33 -mam33-2 -mam34 @gol
816 -mtune=@var{cpu-type} @gol
817 -mreturn-pointer-on-d0 @gol
818 -mno-crt0  -mrelax -mliw -msetlb}
820 @emph{Moxie Options}
821 @gccoptlist{-meb -mel -mno-crt0}
823 @emph{MSP430 Options}
824 @gccoptlist{-msim -masm-hex -mmcu= -mlarge -msmall -mrelax}
826 @emph{NDS32 Options}
827 @gccoptlist{-mbig-endian -mlittle-endian @gol
828 -mreduced-regs -mfull-regs @gol
829 -mcmov -mno-cmov @gol
830 -mperf-ext -mno-perf-ext @gol
831 -mv3push -mno-v3push @gol
832 -m16bit -mno-16bit @gol
833 -mgp-direct -mno-gp-direct @gol
834 -misr-vector-size=@var{num} @gol
835 -mcache-block-size=@var{num} @gol
836 -march=@var{arch} @gol
837 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
838 -mex9 -mctor-dtor -mrelax}
840 @emph{PDP-11 Options}
841 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
842 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
843 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
844 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
845 -mbranch-expensive  -mbranch-cheap @gol
846 -munix-asm  -mdec-asm}
848 @emph{picoChip Options}
849 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
850 -msymbol-as-address -mno-inefficient-warnings}
852 @emph{PowerPC Options}
853 See RS/6000 and PowerPC Options.
855 @emph{RL78 Options}
856 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
858 @emph{RS/6000 and PowerPC Options}
859 @gccoptlist{-mcpu=@var{cpu-type} @gol
860 -mtune=@var{cpu-type} @gol
861 -mcmodel=@var{code-model} @gol
862 -mpowerpc64 @gol
863 -maltivec  -mno-altivec @gol
864 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
865 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
866 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
867 -mfprnd  -mno-fprnd @gol
868 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
869 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
870 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
871 -malign-power  -malign-natural @gol
872 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
873 -msingle-float -mdouble-float -msimple-fpu @gol
874 -mstring  -mno-string  -mupdate  -mno-update @gol
875 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
876 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
877 -mstrict-align  -mno-strict-align  -mrelocatable @gol
878 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
879 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
880 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
881 -mprioritize-restricted-insns=@var{priority} @gol
882 -msched-costly-dep=@var{dependence_type} @gol
883 -minsert-sched-nops=@var{scheme} @gol
884 -mcall-sysv  -mcall-netbsd @gol
885 -maix-struct-return  -msvr4-struct-return @gol
886 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
887 -mblock-move-inline-limit=@var{num} @gol
888 -misel -mno-isel @gol
889 -misel=yes  -misel=no @gol
890 -mspe -mno-spe @gol
891 -mspe=yes  -mspe=no @gol
892 -mpaired @gol
893 -mgen-cell-microcode -mwarn-cell-microcode @gol
894 -mvrsave -mno-vrsave @gol
895 -mmulhw -mno-mulhw @gol
896 -mdlmzb -mno-dlmzb @gol
897 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
898 -mprototype  -mno-prototype @gol
899 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
900 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
901 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
902 -mno-recip-precision @gol
903 -mveclibabi=@var{type} -mfriz -mno-friz @gol
904 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
905 -msave-toc-indirect -mno-save-toc-indirect @gol
906 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
907 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
908 -mquad-memory -mno-quad-memory @gol
909 -mcompat-align-parm -mno-compat-align-parm}
911 @emph{RX Options}
912 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
913 -mcpu=@gol
914 -mbig-endian-data -mlittle-endian-data @gol
915 -msmall-data @gol
916 -msim  -mno-sim@gol
917 -mas100-syntax -mno-as100-syntax@gol
918 -mrelax@gol
919 -mmax-constant-size=@gol
920 -mint-register=@gol
921 -mpid@gol
922 -mno-warn-multiple-fast-interrupts@gol
923 -msave-acc-in-interrupts}
925 @emph{S/390 and zSeries Options}
926 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
927 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
928 -mlong-double-64 -mlong-double-128 @gol
929 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
930 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
931 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
932 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
933 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
935 @emph{Score Options}
936 @gccoptlist{-meb -mel @gol
937 -mnhwloop @gol
938 -muls @gol
939 -mmac @gol
940 -mscore5 -mscore5u -mscore7 -mscore7d}
942 @emph{SH Options}
943 @gccoptlist{-m1  -m2  -m2e @gol
944 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
945 -m3  -m3e @gol
946 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
947 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
948 -m5-64media  -m5-64media-nofpu @gol
949 -m5-32media  -m5-32media-nofpu @gol
950 -m5-compact  -m5-compact-nofpu @gol
951 -mb  -ml  -mdalign  -mrelax @gol
952 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
953 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
954 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
955 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
956 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
957 -maccumulate-outgoing-args -minvalid-symbols @gol
958 -matomic-model=@var{atomic-model} @gol
959 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
960 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
961 -mpretend-cmove -mtas}
963 @emph{Solaris 2 Options}
964 @gccoptlist{-mimpure-text  -mno-impure-text @gol
965 -pthreads -pthread}
967 @emph{SPARC Options}
968 @gccoptlist{-mcpu=@var{cpu-type} @gol
969 -mtune=@var{cpu-type} @gol
970 -mcmodel=@var{code-model} @gol
971 -mmemory-model=@var{mem-model} @gol
972 -m32  -m64  -mapp-regs  -mno-app-regs @gol
973 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
974 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
975 -mhard-quad-float  -msoft-quad-float @gol
976 -mstack-bias  -mno-stack-bias @gol
977 -munaligned-doubles  -mno-unaligned-doubles @gol
978 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
979 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
980 -mcbcond -mno-cbcond @gol
981 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
982 -mfix-at697f -mfix-ut699}
984 @emph{SPU Options}
985 @gccoptlist{-mwarn-reloc -merror-reloc @gol
986 -msafe-dma -munsafe-dma @gol
987 -mbranch-hints @gol
988 -msmall-mem -mlarge-mem -mstdmain @gol
989 -mfixed-range=@var{register-range} @gol
990 -mea32 -mea64 @gol
991 -maddress-space-conversion -mno-address-space-conversion @gol
992 -mcache-size=@var{cache-size} @gol
993 -matomic-updates -mno-atomic-updates}
995 @emph{System V Options}
996 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
998 @emph{TILE-Gx Options}
999 @gccoptlist{-mcpu=@var{cpu} -m32 -m64 -mcmodel=@var{code-model}}
1001 @emph{TILEPro Options}
1002 @gccoptlist{-mcpu=@var{cpu} -m32}
1004 @emph{V850 Options}
1005 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1006 -mprolog-function  -mno-prolog-function  -mspace @gol
1007 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1008 -mapp-regs  -mno-app-regs @gol
1009 -mdisable-callt  -mno-disable-callt @gol
1010 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1011 -mv850e -mv850 -mv850e3v5 @gol
1012 -mloop @gol
1013 -mrelax @gol
1014 -mlong-jumps @gol
1015 -msoft-float @gol
1016 -mhard-float @gol
1017 -mgcc-abi @gol
1018 -mrh850-abi @gol
1019 -mbig-switch}
1021 @emph{VAX Options}
1022 @gccoptlist{-mg  -mgnu  -munix}
1024 @emph{VMS Options}
1025 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1026 -mpointer-size=@var{size}}
1028 @emph{VxWorks Options}
1029 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1030 -Xbind-lazy  -Xbind-now}
1032 @emph{x86-64 Options}
1033 See i386 and x86-64 Options.
1035 @emph{Xstormy16 Options}
1036 @gccoptlist{-msim}
1038 @emph{Xtensa Options}
1039 @gccoptlist{-mconst16 -mno-const16 @gol
1040 -mfused-madd  -mno-fused-madd @gol
1041 -mforce-no-pic @gol
1042 -mserialize-volatile  -mno-serialize-volatile @gol
1043 -mtext-section-literals  -mno-text-section-literals @gol
1044 -mtarget-align  -mno-target-align @gol
1045 -mlongcalls  -mno-longcalls}
1047 @emph{zSeries Options}
1048 See S/390 and zSeries Options.
1050 @item Code Generation Options
1051 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1052 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1053 -ffixed-@var{reg}  -fexceptions @gol
1054 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1055 -fasynchronous-unwind-tables @gol
1056 -finhibit-size-directive  -finstrument-functions @gol
1057 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1058 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1059 -fno-common  -fno-ident @gol
1060 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1061 -fno-jump-tables @gol
1062 -frecord-gcc-switches @gol
1063 -freg-struct-return  -fshort-enums @gol
1064 -fshort-double  -fshort-wchar @gol
1065 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1066 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1067 -fno-stack-limit -fsplit-stack @gol
1068 -fleading-underscore  -ftls-model=@var{model} @gol
1069 -fstack-reuse=@var{reuse_level} @gol
1070 -ftrapv  -fwrapv  -fbounds-check @gol
1071 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1072 @end table
1074 @menu
1075 * Overall Options::     Controlling the kind of output:
1076                         an executable, object files, assembler files,
1077                         or preprocessed source.
1078 * C Dialect Options::   Controlling the variant of C language compiled.
1079 * C++ Dialect Options:: Variations on C++.
1080 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1081                         and Objective-C++.
1082 * Language Independent Options:: Controlling how diagnostics should be
1083                         formatted.
1084 * Warning Options::     How picky should the compiler be?
1085 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1086 * Optimize Options::    How much optimization?
1087 * Preprocessor Options:: Controlling header files and macro definitions.
1088                          Also, getting dependency information for Make.
1089 * Assembler Options::   Passing options to the assembler.
1090 * Link Options::        Specifying libraries and so on.
1091 * Directory Options::   Where to find header files and libraries.
1092                         Where to find the compiler executable files.
1093 * Spec Files::          How to pass switches to sub-processes.
1094 * Target Options::      Running a cross-compiler, or an old version of GCC.
1095 @end menu
1097 @node Overall Options
1098 @section Options Controlling the Kind of Output
1100 Compilation can involve up to four stages: preprocessing, compilation
1101 proper, assembly and linking, always in that order.  GCC is capable of
1102 preprocessing and compiling several files either into several
1103 assembler input files, or into one assembler input file; then each
1104 assembler input file produces an object file, and linking combines all
1105 the object files (those newly compiled, and those specified as input)
1106 into an executable file.
1108 @cindex file name suffix
1109 For any given input file, the file name suffix determines what kind of
1110 compilation is done:
1112 @table @gcctabopt
1113 @item @var{file}.c
1114 C source code that must be preprocessed.
1116 @item @var{file}.i
1117 C source code that should not be preprocessed.
1119 @item @var{file}.ii
1120 C++ source code that should not be preprocessed.
1122 @item @var{file}.m
1123 Objective-C source code.  Note that you must link with the @file{libobjc}
1124 library to make an Objective-C program work.
1126 @item @var{file}.mi
1127 Objective-C source code that should not be preprocessed.
1129 @item @var{file}.mm
1130 @itemx @var{file}.M
1131 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1132 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1133 to a literal capital M@.
1135 @item @var{file}.mii
1136 Objective-C++ source code that should not be preprocessed.
1138 @item @var{file}.h
1139 C, C++, Objective-C or Objective-C++ header file to be turned into a
1140 precompiled header (default), or C, C++ header file to be turned into an
1141 Ada spec (via the @option{-fdump-ada-spec} switch).
1143 @item @var{file}.cc
1144 @itemx @var{file}.cp
1145 @itemx @var{file}.cxx
1146 @itemx @var{file}.cpp
1147 @itemx @var{file}.CPP
1148 @itemx @var{file}.c++
1149 @itemx @var{file}.C
1150 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1151 the last two letters must both be literally @samp{x}.  Likewise,
1152 @samp{.C} refers to a literal capital C@.
1154 @item @var{file}.mm
1155 @itemx @var{file}.M
1156 Objective-C++ source code that must be preprocessed.
1158 @item @var{file}.mii
1159 Objective-C++ source code that should not be preprocessed.
1161 @item @var{file}.hh
1162 @itemx @var{file}.H
1163 @itemx @var{file}.hp
1164 @itemx @var{file}.hxx
1165 @itemx @var{file}.hpp
1166 @itemx @var{file}.HPP
1167 @itemx @var{file}.h++
1168 @itemx @var{file}.tcc
1169 C++ header file to be turned into a precompiled header or Ada spec.
1171 @item @var{file}.f
1172 @itemx @var{file}.for
1173 @itemx @var{file}.ftn
1174 Fixed form Fortran source code that should not be preprocessed.
1176 @item @var{file}.F
1177 @itemx @var{file}.FOR
1178 @itemx @var{file}.fpp
1179 @itemx @var{file}.FPP
1180 @itemx @var{file}.FTN
1181 Fixed form Fortran source code that must be preprocessed (with the traditional
1182 preprocessor).
1184 @item @var{file}.f90
1185 @itemx @var{file}.f95
1186 @itemx @var{file}.f03
1187 @itemx @var{file}.f08
1188 Free form Fortran source code that should not be preprocessed.
1190 @item @var{file}.F90
1191 @itemx @var{file}.F95
1192 @itemx @var{file}.F03
1193 @itemx @var{file}.F08
1194 Free form Fortran source code that must be preprocessed (with the
1195 traditional preprocessor).
1197 @item @var{file}.go
1198 Go source code.
1200 @c FIXME: Descriptions of Java file types.
1201 @c @var{file}.java
1202 @c @var{file}.class
1203 @c @var{file}.zip
1204 @c @var{file}.jar
1206 @item @var{file}.ads
1207 Ada source code file that contains a library unit declaration (a
1208 declaration of a package, subprogram, or generic, or a generic
1209 instantiation), or a library unit renaming declaration (a package,
1210 generic, or subprogram renaming declaration).  Such files are also
1211 called @dfn{specs}.
1213 @item @var{file}.adb
1214 Ada source code file containing a library unit body (a subprogram or
1215 package body).  Such files are also called @dfn{bodies}.
1217 @c GCC also knows about some suffixes for languages not yet included:
1218 @c Pascal:
1219 @c @var{file}.p
1220 @c @var{file}.pas
1221 @c Ratfor:
1222 @c @var{file}.r
1224 @item @var{file}.s
1225 Assembler code.
1227 @item @var{file}.S
1228 @itemx @var{file}.sx
1229 Assembler code that must be preprocessed.
1231 @item @var{other}
1232 An object file to be fed straight into linking.
1233 Any file name with no recognized suffix is treated this way.
1234 @end table
1236 @opindex x
1237 You can specify the input language explicitly with the @option{-x} option:
1239 @table @gcctabopt
1240 @item -x @var{language}
1241 Specify explicitly the @var{language} for the following input files
1242 (rather than letting the compiler choose a default based on the file
1243 name suffix).  This option applies to all following input files until
1244 the next @option{-x} option.  Possible values for @var{language} are:
1245 @smallexample
1246 c  c-header  cpp-output
1247 c++  c++-header  c++-cpp-output
1248 objective-c  objective-c-header  objective-c-cpp-output
1249 objective-c++ objective-c++-header objective-c++-cpp-output
1250 assembler  assembler-with-cpp
1252 f77  f77-cpp-input f95  f95-cpp-input
1254 java
1255 @end smallexample
1257 @item -x none
1258 Turn off any specification of a language, so that subsequent files are
1259 handled according to their file name suffixes (as they are if @option{-x}
1260 has not been used at all).
1262 @item -pass-exit-codes
1263 @opindex pass-exit-codes
1264 Normally the @command{gcc} program exits with the code of 1 if any
1265 phase of the compiler returns a non-success return code.  If you specify
1266 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1267 the numerically highest error produced by any phase returning an error
1268 indication.  The C, C++, and Fortran front ends return 4 if an internal
1269 compiler error is encountered.
1270 @end table
1272 If you only want some of the stages of compilation, you can use
1273 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1274 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1275 @command{gcc} is to stop.  Note that some combinations (for example,
1276 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1278 @table @gcctabopt
1279 @item -c
1280 @opindex c
1281 Compile or assemble the source files, but do not link.  The linking
1282 stage simply is not done.  The ultimate output is in the form of an
1283 object file for each source file.
1285 By default, the object file name for a source file is made by replacing
1286 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1288 Unrecognized input files, not requiring compilation or assembly, are
1289 ignored.
1291 @item -S
1292 @opindex S
1293 Stop after the stage of compilation proper; do not assemble.  The output
1294 is in the form of an assembler code file for each non-assembler input
1295 file specified.
1297 By default, the assembler file name for a source file is made by
1298 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1300 Input files that don't require compilation are ignored.
1302 @item -E
1303 @opindex E
1304 Stop after the preprocessing stage; do not run the compiler proper.  The
1305 output is in the form of preprocessed source code, which is sent to the
1306 standard output.
1308 Input files that don't require preprocessing are ignored.
1310 @cindex output file option
1311 @item -o @var{file}
1312 @opindex o
1313 Place output in file @var{file}.  This applies to whatever
1314 sort of output is being produced, whether it be an executable file,
1315 an object file, an assembler file or preprocessed C code.
1317 If @option{-o} is not specified, the default is to put an executable
1318 file in @file{a.out}, the object file for
1319 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1320 assembler file in @file{@var{source}.s}, a precompiled header file in
1321 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1322 standard output.
1324 @item -v
1325 @opindex v
1326 Print (on standard error output) the commands executed to run the stages
1327 of compilation.  Also print the version number of the compiler driver
1328 program and of the preprocessor and the compiler proper.
1330 @item -###
1331 @opindex ###
1332 Like @option{-v} except the commands are not executed and arguments
1333 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1334 This is useful for shell scripts to capture the driver-generated command lines.
1336 @item -pipe
1337 @opindex pipe
1338 Use pipes rather than temporary files for communication between the
1339 various stages of compilation.  This fails to work on some systems where
1340 the assembler is unable to read from a pipe; but the GNU assembler has
1341 no trouble.
1343 @item --help
1344 @opindex help
1345 Print (on the standard output) a description of the command-line options
1346 understood by @command{gcc}.  If the @option{-v} option is also specified
1347 then @option{--help} is also passed on to the various processes
1348 invoked by @command{gcc}, so that they can display the command-line options
1349 they accept.  If the @option{-Wextra} option has also been specified
1350 (prior to the @option{--help} option), then command-line options that
1351 have no documentation associated with them are also displayed.
1353 @item --target-help
1354 @opindex target-help
1355 Print (on the standard output) a description of target-specific command-line
1356 options for each tool.  For some targets extra target-specific
1357 information may also be printed.
1359 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1360 Print (on the standard output) a description of the command-line
1361 options understood by the compiler that fit into all specified classes
1362 and qualifiers.  These are the supported classes:
1364 @table @asis
1365 @item @samp{optimizers}
1366 Display all of the optimization options supported by the
1367 compiler.
1369 @item @samp{warnings}
1370 Display all of the options controlling warning messages
1371 produced by the compiler.
1373 @item @samp{target}
1374 Display target-specific options.  Unlike the
1375 @option{--target-help} option however, target-specific options of the
1376 linker and assembler are not displayed.  This is because those
1377 tools do not currently support the extended @option{--help=} syntax.
1379 @item @samp{params}
1380 Display the values recognized by the @option{--param}
1381 option.
1383 @item @var{language}
1384 Display the options supported for @var{language}, where
1385 @var{language} is the name of one of the languages supported in this
1386 version of GCC@.
1388 @item @samp{common}
1389 Display the options that are common to all languages.
1390 @end table
1392 These are the supported qualifiers:
1394 @table @asis
1395 @item @samp{undocumented}
1396 Display only those options that are undocumented.
1398 @item @samp{joined}
1399 Display options taking an argument that appears after an equal
1400 sign in the same continuous piece of text, such as:
1401 @samp{--help=target}.
1403 @item @samp{separate}
1404 Display options taking an argument that appears as a separate word
1405 following the original option, such as: @samp{-o output-file}.
1406 @end table
1408 Thus for example to display all the undocumented target-specific
1409 switches supported by the compiler, use:
1411 @smallexample
1412 --help=target,undocumented
1413 @end smallexample
1415 The sense of a qualifier can be inverted by prefixing it with the
1416 @samp{^} character, so for example to display all binary warning
1417 options (i.e., ones that are either on or off and that do not take an
1418 argument) that have a description, use:
1420 @smallexample
1421 --help=warnings,^joined,^undocumented
1422 @end smallexample
1424 The argument to @option{--help=} should not consist solely of inverted
1425 qualifiers.
1427 Combining several classes is possible, although this usually
1428 restricts the output so much that there is nothing to display.  One
1429 case where it does work, however, is when one of the classes is
1430 @var{target}.  For example, to display all the target-specific
1431 optimization options, use:
1433 @smallexample
1434 --help=target,optimizers
1435 @end smallexample
1437 The @option{--help=} option can be repeated on the command line.  Each
1438 successive use displays its requested class of options, skipping
1439 those that have already been displayed.
1441 If the @option{-Q} option appears on the command line before the
1442 @option{--help=} option, then the descriptive text displayed by
1443 @option{--help=} is changed.  Instead of describing the displayed
1444 options, an indication is given as to whether the option is enabled,
1445 disabled or set to a specific value (assuming that the compiler
1446 knows this at the point where the @option{--help=} option is used).
1448 Here is a truncated example from the ARM port of @command{gcc}:
1450 @smallexample
1451   % gcc -Q -mabi=2 --help=target -c
1452   The following options are target specific:
1453   -mabi=                                2
1454   -mabort-on-noreturn                   [disabled]
1455   -mapcs                                [disabled]
1456 @end smallexample
1458 The output is sensitive to the effects of previous command-line
1459 options, so for example it is possible to find out which optimizations
1460 are enabled at @option{-O2} by using:
1462 @smallexample
1463 -Q -O2 --help=optimizers
1464 @end smallexample
1466 Alternatively you can discover which binary optimizations are enabled
1467 by @option{-O3} by using:
1469 @smallexample
1470 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1471 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1472 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1473 @end smallexample
1475 @item -no-canonical-prefixes
1476 @opindex no-canonical-prefixes
1477 Do not expand any symbolic links, resolve references to @samp{/../}
1478 or @samp{/./}, or make the path absolute when generating a relative
1479 prefix.
1481 @item --version
1482 @opindex version
1483 Display the version number and copyrights of the invoked GCC@.
1485 @item -wrapper
1486 @opindex wrapper
1487 Invoke all subcommands under a wrapper program.  The name of the
1488 wrapper program and its parameters are passed as a comma separated
1489 list.
1491 @smallexample
1492 gcc -c t.c -wrapper gdb,--args
1493 @end smallexample
1495 @noindent
1496 This invokes all subprograms of @command{gcc} under
1497 @samp{gdb --args}, thus the invocation of @command{cc1} is
1498 @samp{gdb --args cc1 @dots{}}.
1500 @item -fplugin=@var{name}.so
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 Define an argument called @var{key} with a value of @var{value}
1511 for the plugin called @var{name}.
1513 @item -fdump-ada-spec@r{[}-slim@r{]}
1514 For C and C++ source and include files, generate corresponding Ada
1515 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1516 GNAT User's Guide}, which provides detailed documentation on this feature.
1518 @item -fdump-go-spec=@var{file}
1519 For input files in any language, generate corresponding Go
1520 declarations in @var{file}.  This generates Go @code{const},
1521 @code{type}, @code{var}, and @code{func} declarations which may be a
1522 useful way to start writing a Go interface to code written in some
1523 other language.
1525 @include @value{srcdir}/../libiberty/at-file.texi
1526 @end table
1528 @node Invoking G++
1529 @section Compiling C++ Programs
1531 @cindex suffixes for C++ source
1532 @cindex C++ source file suffixes
1533 C++ source files conventionally use one of the suffixes @samp{.C},
1534 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1535 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1536 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1537 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1538 files with these names and compiles them as C++ programs even if you
1539 call the compiler the same way as for compiling C programs (usually
1540 with the name @command{gcc}).
1542 @findex g++
1543 @findex c++
1544 However, the use of @command{gcc} does not add the C++ library.
1545 @command{g++} is a program that calls GCC and automatically specifies linking
1546 against the C++ library.  It treats @samp{.c},
1547 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1548 files unless @option{-x} is used.  This program is also useful when
1549 precompiling a C header file with a @samp{.h} extension for use in C++
1550 compilations.  On many systems, @command{g++} is also installed with
1551 the name @command{c++}.
1553 @cindex invoking @command{g++}
1554 When you compile C++ programs, you may specify many of the same
1555 command-line options that you use for compiling programs in any
1556 language; or command-line options meaningful for C and related
1557 languages; or options that are meaningful only for C++ programs.
1558 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1559 explanations of options for languages related to C@.
1560 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1561 explanations of options that are meaningful only for C++ programs.
1563 @node C Dialect Options
1564 @section Options Controlling C Dialect
1565 @cindex dialect options
1566 @cindex language dialect options
1567 @cindex options, dialect
1569 The following options control the dialect of C (or languages derived
1570 from C, such as C++, Objective-C and Objective-C++) that the compiler
1571 accepts:
1573 @table @gcctabopt
1574 @cindex ANSI support
1575 @cindex ISO support
1576 @item -ansi
1577 @opindex ansi
1578 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1579 equivalent to @option{-std=c++98}.
1581 This turns off certain features of GCC that are incompatible with ISO
1582 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1583 such as the @code{asm} and @code{typeof} keywords, and
1584 predefined macros such as @code{unix} and @code{vax} that identify the
1585 type of system you are using.  It also enables the undesirable and
1586 rarely used ISO trigraph feature.  For the C compiler,
1587 it disables recognition of C++ style @samp{//} comments as well as
1588 the @code{inline} keyword.
1590 The alternate keywords @code{__asm__}, @code{__extension__},
1591 @code{__inline__} and @code{__typeof__} continue to work despite
1592 @option{-ansi}.  You would not want to use them in an ISO C program, of
1593 course, but it is useful to put them in header files that might be included
1594 in compilations done with @option{-ansi}.  Alternate predefined macros
1595 such as @code{__unix__} and @code{__vax__} are also available, with or
1596 without @option{-ansi}.
1598 The @option{-ansi} option does not cause non-ISO programs to be
1599 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1600 addition to @option{-ansi}.  @xref{Warning Options}.
1602 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1603 option is used.  Some header files may notice this macro and refrain
1604 from declaring certain functions or defining certain macros that the
1605 ISO standard doesn't call for; this is to avoid interfering with any
1606 programs that might use these names for other things.
1608 Functions that are normally built in but do not have semantics
1609 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1610 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1611 built-in functions provided by GCC}, for details of the functions
1612 affected.
1614 @item -std=
1615 @opindex std
1616 Determine the language standard. @xref{Standards,,Language Standards
1617 Supported by GCC}, for details of these standard versions.  This option
1618 is currently only supported when compiling C or C++.
1620 The compiler can accept several base standards, such as @samp{c90} or
1621 @samp{c++98}, and GNU dialects of those standards, such as
1622 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1623 compiler accepts all programs following that standard plus those
1624 using GNU extensions that do not contradict it.  For example,
1625 @option{-std=c90} turns off certain features of GCC that are
1626 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1627 keywords, but not other GNU extensions that do not have a meaning in
1628 ISO C90, such as omitting the middle term of a @code{?:}
1629 expression. On the other hand, when a GNU dialect of a standard is
1630 specified, all features supported by the compiler are enabled, even when
1631 those features change the meaning of the base standard.  As a result, some
1632 strict-conforming programs may be rejected.  The particular standard
1633 is used by @option{-Wpedantic} to identify which features are GNU
1634 extensions given that version of the standard. For example
1635 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1636 comments, while @option{-std=gnu99 -Wpedantic} does not.
1638 A value for this option must be provided; possible values are
1640 @table @samp
1641 @item c90
1642 @itemx c89
1643 @itemx iso9899:1990
1644 Support all ISO C90 programs (certain GNU extensions that conflict
1645 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1647 @item iso9899:199409
1648 ISO C90 as modified in amendment 1.
1650 @item c99
1651 @itemx c9x
1652 @itemx iso9899:1999
1653 @itemx iso9899:199x
1654 ISO C99.  Note that this standard is not yet fully supported; see
1655 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1656 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1658 @item c11
1659 @itemx c1x
1660 @itemx iso9899:2011
1661 ISO C11, the 2011 revision of the ISO C standard.
1662 Support is incomplete and experimental.  The name @samp{c1x} is
1663 deprecated.
1665 @item gnu90
1666 @itemx gnu89
1667 GNU dialect of ISO C90 (including some C99 features). This
1668 is the default for C code.
1670 @item gnu99
1671 @itemx gnu9x
1672 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1673 this will become the default.  The name @samp{gnu9x} is deprecated.
1675 @item gnu11
1676 @itemx gnu1x
1677 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1678 name @samp{gnu1x} is deprecated.
1680 @item c++98
1681 @itemx c++03
1682 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1683 additional defect reports. Same as @option{-ansi} for C++ code.
1685 @item gnu++98
1686 @itemx gnu++03
1687 GNU dialect of @option{-std=c++98}.  This is the default for
1688 C++ code.
1690 @item c++11
1691 @itemx c++0x
1692 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1693 experimental, and may change in incompatible ways in future releases.
1694 The name @samp{c++0x} is deprecated.
1696 @item gnu++11
1697 @itemx gnu++0x
1698 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1699 experimental, and may change in incompatible ways in future releases.
1700 The name @samp{gnu++0x} is deprecated.
1702 @item c++1y
1703 The next revision of the ISO C++ standard, tentatively planned for
1704 2014.  Support is highly experimental, and will almost certainly
1705 change in incompatible ways in future releases.
1707 @item gnu++1y
1708 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1709 and will almost certainly change in incompatible ways in future
1710 releases.
1711 @end table
1713 @item -fgnu89-inline
1714 @opindex fgnu89-inline
1715 The option @option{-fgnu89-inline} tells GCC to use the traditional
1716 GNU semantics for @code{inline} functions when in C99 mode.
1717 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1718 is accepted and ignored by GCC versions 4.1.3 up to but not including
1719 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1720 C99 mode.  Using this option is roughly equivalent to adding the
1721 @code{gnu_inline} function attribute to all inline functions
1722 (@pxref{Function Attributes}).
1724 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1725 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1726 specifies the default behavior).  This option was first supported in
1727 GCC 4.3.  This option is not supported in @option{-std=c90} or
1728 @option{-std=gnu90} mode.
1730 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1731 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1732 in effect for @code{inline} functions.  @xref{Common Predefined
1733 Macros,,,cpp,The C Preprocessor}.
1735 @item -aux-info @var{filename}
1736 @opindex aux-info
1737 Output to the given filename prototyped declarations for all functions
1738 declared and/or defined in a translation unit, including those in header
1739 files.  This option is silently ignored in any language other than C@.
1741 Besides declarations, the file indicates, in comments, the origin of
1742 each declaration (source file and line), whether the declaration was
1743 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1744 @samp{O} for old, respectively, in the first character after the line
1745 number and the colon), and whether it came from a declaration or a
1746 definition (@samp{C} or @samp{F}, respectively, in the following
1747 character).  In the case of function definitions, a K&R-style list of
1748 arguments followed by their declarations is also provided, inside
1749 comments, after the declaration.
1751 @item -fallow-parameterless-variadic-functions
1752 Accept variadic functions without named parameters.
1754 Although it is possible to define such a function, this is not very
1755 useful as it is not possible to read the arguments.  This is only
1756 supported for C as this construct is allowed by C++.
1758 @item -fno-asm
1759 @opindex fno-asm
1760 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1761 keyword, so that code can use these words as identifiers.  You can use
1762 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1763 instead.  @option{-ansi} implies @option{-fno-asm}.
1765 In C++, this switch only affects the @code{typeof} keyword, since
1766 @code{asm} and @code{inline} are standard keywords.  You may want to
1767 use the @option{-fno-gnu-keywords} flag instead, which has the same
1768 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1769 switch only affects the @code{asm} and @code{typeof} keywords, since
1770 @code{inline} is a standard keyword in ISO C99.
1772 @item -fno-builtin
1773 @itemx -fno-builtin-@var{function}
1774 @opindex fno-builtin
1775 @cindex built-in functions
1776 Don't recognize built-in functions that do not begin with
1777 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1778 functions provided by GCC}, for details of the functions affected,
1779 including those which are not built-in functions when @option{-ansi} or
1780 @option{-std} options for strict ISO C conformance are used because they
1781 do not have an ISO standard meaning.
1783 GCC normally generates special code to handle certain built-in functions
1784 more efficiently; for instance, calls to @code{alloca} may become single
1785 instructions which adjust the stack directly, and calls to @code{memcpy}
1786 may become inline copy loops.  The resulting code is often both smaller
1787 and faster, but since the function calls no longer appear as such, you
1788 cannot set a breakpoint on those calls, nor can you change the behavior
1789 of the functions by linking with a different library.  In addition,
1790 when a function is recognized as a built-in function, GCC may use
1791 information about that function to warn about problems with calls to
1792 that function, or to generate more efficient code, even if the
1793 resulting code still contains calls to that function.  For example,
1794 warnings are given with @option{-Wformat} for bad calls to
1795 @code{printf} when @code{printf} is built in and @code{strlen} is
1796 known not to modify global memory.
1798 With the @option{-fno-builtin-@var{function}} option
1799 only the built-in function @var{function} is
1800 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1801 function is named that is not built-in in this version of GCC, this
1802 option is ignored.  There is no corresponding
1803 @option{-fbuiltin-@var{function}} option; if you wish to enable
1804 built-in functions selectively when using @option{-fno-builtin} or
1805 @option{-ffreestanding}, you may define macros such as:
1807 @smallexample
1808 #define abs(n)          __builtin_abs ((n))
1809 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1810 @end smallexample
1812 @item -fhosted
1813 @opindex fhosted
1814 @cindex hosted environment
1816 Assert that compilation targets a hosted environment.  This implies
1817 @option{-fbuiltin}.  A hosted environment is one in which the
1818 entire standard library is available, and in which @code{main} has a return
1819 type of @code{int}.  Examples are nearly everything except a kernel.
1820 This is equivalent to @option{-fno-freestanding}.
1822 @item -ffreestanding
1823 @opindex ffreestanding
1824 @cindex hosted environment
1826 Assert that compilation targets a freestanding environment.  This
1827 implies @option{-fno-builtin}.  A freestanding environment
1828 is one in which the standard library may not exist, and program startup may
1829 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1830 This is equivalent to @option{-fno-hosted}.
1832 @xref{Standards,,Language Standards Supported by GCC}, for details of
1833 freestanding and hosted environments.
1835 @item -fopenmp
1836 @opindex fopenmp
1837 @cindex OpenMP parallel
1838 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1839 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1840 compiler generates parallel code according to the OpenMP Application
1841 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1842 implies @option{-pthread}, and thus is only supported on targets that
1843 have support for @option{-pthread}. @option{-fopenmp} implies
1844 @option{-fopenmp-simd}.
1846 @item -fopenmp-simd
1847 @opindex fopenmp-simd
1848 @cindex OpenMP SIMD
1849 @cindex SIMD
1850 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1851 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1852 are ignored.
1854 @item -fcilkplus
1855 @opindex fcilkplus
1856 @cindex Enable Cilk Plus
1857 Enable the usage of Cilk Plus language extension features for C/C++.
1858 When the option @option{-fcilkplus} is specified, enable the usage of
1859 the Cilk Plus Language extension features for C/C++.  The present
1860 implementation follows ABI version 0.9.  This is an experimental
1861 feature that is only partially complete, and whose interface may
1862 change in future versions of GCC as the official specification
1863 changes.  Currently only the array notation feature of the language
1864 specification has been implemented.  More features will be implemented
1865 in subsequent release cycles.
1867 @item -fgnu-tm
1868 @opindex fgnu-tm
1869 When the option @option{-fgnu-tm} is specified, the compiler
1870 generates code for the Linux variant of Intel's current Transactional
1871 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1872 an experimental feature whose interface may change in future versions
1873 of GCC, as the official specification changes.  Please note that not
1874 all architectures are supported for this feature.
1876 For more information on GCC's support for transactional memory,
1877 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1878 Transactional Memory Library}.
1880 Note that the transactional memory feature is not supported with
1881 non-call exceptions (@option{-fnon-call-exceptions}).
1883 @item -fms-extensions
1884 @opindex fms-extensions
1885 Accept some non-standard constructs used in Microsoft header files.
1887 In C++ code, this allows member names in structures to be similar
1888 to previous types declarations.
1890 @smallexample
1891 typedef int UOW;
1892 struct ABC @{
1893   UOW UOW;
1895 @end smallexample
1897 Some cases of unnamed fields in structures and unions are only
1898 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1899 fields within structs/unions}, for details.
1901 Note that this option is off for all targets but i?86 and x86_64
1902 targets using ms-abi.
1903 @item -fplan9-extensions
1904 Accept some non-standard constructs used in Plan 9 code.
1906 This enables @option{-fms-extensions}, permits passing pointers to
1907 structures with anonymous fields to functions that expect pointers to
1908 elements of the type of the field, and permits referring to anonymous
1909 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1910 struct/union fields within structs/unions}, for details.  This is only
1911 supported for C, not C++.
1913 @item -trigraphs
1914 @opindex trigraphs
1915 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1916 options for strict ISO C conformance) implies @option{-trigraphs}.
1918 @cindex traditional C language
1919 @cindex C language, traditional
1920 @item -traditional
1921 @itemx -traditional-cpp
1922 @opindex traditional-cpp
1923 @opindex traditional
1924 Formerly, these options caused GCC to attempt to emulate a pre-standard
1925 C compiler.  They are now only supported with the @option{-E} switch.
1926 The preprocessor continues to support a pre-standard mode.  See the GNU
1927 CPP manual for details.
1929 @item -fcond-mismatch
1930 @opindex fcond-mismatch
1931 Allow conditional expressions with mismatched types in the second and
1932 third arguments.  The value of such an expression is void.  This option
1933 is not supported for C++.
1935 @item -flax-vector-conversions
1936 @opindex flax-vector-conversions
1937 Allow implicit conversions between vectors with differing numbers of
1938 elements and/or incompatible element types.  This option should not be
1939 used for new code.
1941 @item -funsigned-char
1942 @opindex funsigned-char
1943 Let the type @code{char} be unsigned, like @code{unsigned char}.
1945 Each kind of machine has a default for what @code{char} should
1946 be.  It is either like @code{unsigned char} by default or like
1947 @code{signed char} by default.
1949 Ideally, a portable program should always use @code{signed char} or
1950 @code{unsigned char} when it depends on the signedness of an object.
1951 But many programs have been written to use plain @code{char} and
1952 expect it to be signed, or expect it to be unsigned, depending on the
1953 machines they were written for.  This option, and its inverse, let you
1954 make such a program work with the opposite default.
1956 The type @code{char} is always a distinct type from each of
1957 @code{signed char} or @code{unsigned char}, even though its behavior
1958 is always just like one of those two.
1960 @item -fsigned-char
1961 @opindex fsigned-char
1962 Let the type @code{char} be signed, like @code{signed char}.
1964 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1965 the negative form of @option{-funsigned-char}.  Likewise, the option
1966 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1968 @item -fsigned-bitfields
1969 @itemx -funsigned-bitfields
1970 @itemx -fno-signed-bitfields
1971 @itemx -fno-unsigned-bitfields
1972 @opindex fsigned-bitfields
1973 @opindex funsigned-bitfields
1974 @opindex fno-signed-bitfields
1975 @opindex fno-unsigned-bitfields
1976 These options control whether a bit-field is signed or unsigned, when the
1977 declaration does not use either @code{signed} or @code{unsigned}.  By
1978 default, such a bit-field is signed, because this is consistent: the
1979 basic integer types such as @code{int} are signed types.
1980 @end table
1982 @node C++ Dialect Options
1983 @section Options Controlling C++ Dialect
1985 @cindex compiler options, C++
1986 @cindex C++ options, command-line
1987 @cindex options, C++
1988 This section describes the command-line options that are only meaningful
1989 for C++ programs.  You can also use most of the GNU compiler options
1990 regardless of what language your program is in.  For example, you
1991 might compile a file @code{firstClass.C} like this:
1993 @smallexample
1994 g++ -g -frepo -O -c firstClass.C
1995 @end smallexample
1997 @noindent
1998 In this example, only @option{-frepo} is an option meant
1999 only for C++ programs; you can use the other options with any
2000 language supported by GCC@.
2002 Here is a list of options that are @emph{only} for compiling C++ programs:
2004 @table @gcctabopt
2006 @item -fabi-version=@var{n}
2007 @opindex fabi-version
2008 Use version @var{n} of the C++ ABI@.  The default is version 2.
2010 Version 0 refers to the version conforming most closely to
2011 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2012 will change in different versions of G++ as ABI bugs are fixed.
2014 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2016 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.  
2018 Version 3 corrects an error in mangling a constant address as a
2019 template argument.
2021 Version 4, which first appeared in G++ 4.5, implements a standard
2022 mangling for vector types.
2024 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2025 attribute const/volatile on function pointer types, decltype of a
2026 plain decl, and use of a function parameter in the declaration of
2027 another parameter.
2029 Version 6, which first appeared in G++ 4.7, corrects the promotion
2030 behavior of C++11 scoped enums and the mangling of template argument
2031 packs, const/static_cast, prefix ++ and --, and a class scope function
2032 used as a template argument.
2034 See also @option{-Wabi}.
2036 @item -fno-access-control
2037 @opindex fno-access-control
2038 Turn off all access checking.  This switch is mainly useful for working
2039 around bugs in the access control code.
2041 @item -fcheck-new
2042 @opindex fcheck-new
2043 Check that the pointer returned by @code{operator new} is non-null
2044 before attempting to modify the storage allocated.  This check is
2045 normally unnecessary because the C++ standard specifies that
2046 @code{operator new} only returns @code{0} if it is declared
2047 @samp{throw()}, in which case the compiler always checks the
2048 return value even without this option.  In all other cases, when
2049 @code{operator new} has a non-empty exception specification, memory
2050 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2051 @samp{new (nothrow)}.
2053 @item -fconstexpr-depth=@var{n}
2054 @opindex fconstexpr-depth
2055 Set the maximum nested evaluation depth for C++11 constexpr functions
2056 to @var{n}.  A limit is needed to detect endless recursion during
2057 constant expression evaluation.  The minimum specified by the standard
2058 is 512.
2060 @item -fdeduce-init-list
2061 @opindex fdeduce-init-list
2062 Enable deduction of a template type parameter as
2063 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2065 @smallexample
2066 template <class T> auto forward(T t) -> decltype (realfn (t))
2068   return realfn (t);
2071 void f()
2073   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2075 @end smallexample
2077 This deduction was implemented as a possible extension to the
2078 originally proposed semantics for the C++11 standard, but was not part
2079 of the final standard, so it is disabled by default.  This option is
2080 deprecated, and may be removed in a future version of G++.
2082 @item -ffriend-injection
2083 @opindex ffriend-injection
2084 Inject friend functions into the enclosing namespace, so that they are
2085 visible outside the scope of the class in which they are declared.
2086 Friend functions were documented to work this way in the old Annotated
2087 C++ Reference Manual, and versions of G++ before 4.1 always worked
2088 that way.  However, in ISO C++ a friend function that is not declared
2089 in an enclosing scope can only be found using argument dependent
2090 lookup.  This option causes friends to be injected as they were in
2091 earlier releases.
2093 This option is for compatibility, and may be removed in a future
2094 release of G++.
2096 @item -fno-elide-constructors
2097 @opindex fno-elide-constructors
2098 The C++ standard allows an implementation to omit creating a temporary
2099 that is only used to initialize another object of the same type.
2100 Specifying this option disables that optimization, and forces G++ to
2101 call the copy constructor in all cases.
2103 @item -fno-enforce-eh-specs
2104 @opindex fno-enforce-eh-specs
2105 Don't generate code to check for violation of exception specifications
2106 at run time.  This option violates the C++ standard, but may be useful
2107 for reducing code size in production builds, much like defining
2108 @samp{NDEBUG}.  This does not give user code permission to throw
2109 exceptions in violation of the exception specifications; the compiler
2110 still optimizes based on the specifications, so throwing an
2111 unexpected exception results in undefined behavior at run time.
2113 @item -fextern-tls-init
2114 @itemx -fno-extern-tls-init
2115 @opindex fextern-tls-init
2116 @opindex fno-extern-tls-init
2117 The C++11 and OpenMP standards allow @samp{thread_local} and
2118 @samp{threadprivate} variables to have dynamic (runtime)
2119 initialization.  To support this, any use of such a variable goes
2120 through a wrapper function that performs any necessary initialization.
2121 When the use and definition of the variable are in the same
2122 translation unit, this overhead can be optimized away, but when the
2123 use is in a different translation unit there is significant overhead
2124 even if the variable doesn't actually need dynamic initialization.  If
2125 the programmer can be sure that no use of the variable in a
2126 non-defining TU needs to trigger dynamic initialization (either
2127 because the variable is statically initialized, or a use of the
2128 variable in the defining TU will be executed before any uses in
2129 another TU), they can avoid this overhead with the
2130 @option{-fno-extern-tls-init} option.
2132 On targets that support symbol aliases, the default is
2133 @option{-fextern-tls-init}.  On targets that do not support symbol
2134 aliases, the default is @option{-fno-extern-tls-init}.
2136 @item -ffor-scope
2137 @itemx -fno-for-scope
2138 @opindex ffor-scope
2139 @opindex fno-for-scope
2140 If @option{-ffor-scope} is specified, the scope of variables declared in
2141 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2142 as specified by the C++ standard.
2143 If @option{-fno-for-scope} is specified, the scope of variables declared in
2144 a @i{for-init-statement} extends to the end of the enclosing scope,
2145 as was the case in old versions of G++, and other (traditional)
2146 implementations of C++.
2148 If neither flag is given, the default is to follow the standard,
2149 but to allow and give a warning for old-style code that would
2150 otherwise be invalid, or have different behavior.
2152 @item -fno-gnu-keywords
2153 @opindex fno-gnu-keywords
2154 Do not recognize @code{typeof} as a keyword, so that code can use this
2155 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2156 @option{-ansi} implies @option{-fno-gnu-keywords}.
2158 @item -fno-implicit-templates
2159 @opindex fno-implicit-templates
2160 Never emit code for non-inline templates that are instantiated
2161 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2162 @xref{Template Instantiation}, for more information.
2164 @item -fno-implicit-inline-templates
2165 @opindex fno-implicit-inline-templates
2166 Don't emit code for implicit instantiations of inline templates, either.
2167 The default is to handle inlines differently so that compiles with and
2168 without optimization need the same set of explicit instantiations.
2170 @item -fno-implement-inlines
2171 @opindex fno-implement-inlines
2172 To save space, do not emit out-of-line copies of inline functions
2173 controlled by @samp{#pragma implementation}.  This causes linker
2174 errors if these functions are not inlined everywhere they are called.
2176 @item -fms-extensions
2177 @opindex fms-extensions
2178 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2179 int and getting a pointer to member function via non-standard syntax.
2181 @item -fno-nonansi-builtins
2182 @opindex fno-nonansi-builtins
2183 Disable built-in declarations of functions that are not mandated by
2184 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2185 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2187 @item -fnothrow-opt
2188 @opindex fnothrow-opt
2189 Treat a @code{throw()} exception specification as if it were a
2190 @code{noexcept} specification to reduce or eliminate the text size
2191 overhead relative to a function with no exception specification.  If
2192 the function has local variables of types with non-trivial
2193 destructors, the exception specification actually makes the
2194 function smaller because the EH cleanups for those variables can be
2195 optimized away.  The semantic effect is that an exception thrown out of
2196 a function with such an exception specification results in a call
2197 to @code{terminate} rather than @code{unexpected}.
2199 @item -fno-operator-names
2200 @opindex fno-operator-names
2201 Do not treat the operator name keywords @code{and}, @code{bitand},
2202 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2203 synonyms as keywords.
2205 @item -fno-optional-diags
2206 @opindex fno-optional-diags
2207 Disable diagnostics that the standard says a compiler does not need to
2208 issue.  Currently, the only such diagnostic issued by G++ is the one for
2209 a name having multiple meanings within a class.
2211 @item -fpermissive
2212 @opindex fpermissive
2213 Downgrade some diagnostics about nonconformant code from errors to
2214 warnings.  Thus, using @option{-fpermissive} allows some
2215 nonconforming code to compile.
2217 @item -fno-pretty-templates
2218 @opindex fno-pretty-templates
2219 When an error message refers to a specialization of a function
2220 template, the compiler normally prints the signature of the
2221 template followed by the template arguments and any typedefs or
2222 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2223 rather than @code{void f(int)}) so that it's clear which template is
2224 involved.  When an error message refers to a specialization of a class
2225 template, the compiler omits any template arguments that match
2226 the default template arguments for that template.  If either of these
2227 behaviors make it harder to understand the error message rather than
2228 easier, you can use @option{-fno-pretty-templates} to disable them.
2230 @item -frepo
2231 @opindex frepo
2232 Enable automatic template instantiation at link time.  This option also
2233 implies @option{-fno-implicit-templates}.  @xref{Template
2234 Instantiation}, for more information.
2236 @item -fno-rtti
2237 @opindex fno-rtti
2238 Disable generation of information about every class with virtual
2239 functions for use by the C++ run-time type identification features
2240 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2241 of the language, you can save some space by using this flag.  Note that
2242 exception handling uses the same information, but G++ generates it as
2243 needed. The @samp{dynamic_cast} operator can still be used for casts that
2244 do not require run-time type information, i.e.@: casts to @code{void *} or to
2245 unambiguous base classes.
2247 @item -fstats
2248 @opindex fstats
2249 Emit statistics about front-end processing at the end of the compilation.
2250 This information is generally only useful to the G++ development team.
2252 @item -fstrict-enums
2253 @opindex fstrict-enums
2254 Allow the compiler to optimize using the assumption that a value of
2255 enumerated type can only be one of the values of the enumeration (as
2256 defined in the C++ standard; basically, a value that can be
2257 represented in the minimum number of bits needed to represent all the
2258 enumerators).  This assumption may not be valid if the program uses a
2259 cast to convert an arbitrary integer value to the enumerated type.
2261 @item -ftemplate-backtrace-limit=@var{n}
2262 @opindex ftemplate-backtrace-limit
2263 Set the maximum number of template instantiation notes for a single
2264 warning or error to @var{n}.  The default value is 10.
2266 @item -ftemplate-depth=@var{n}
2267 @opindex ftemplate-depth
2268 Set the maximum instantiation depth for template classes to @var{n}.
2269 A limit on the template instantiation depth is needed to detect
2270 endless recursions during template class instantiation.  ANSI/ISO C++
2271 conforming programs must not rely on a maximum depth greater than 17
2272 (changed to 1024 in C++11).  The default value is 900, as the compiler
2273 can run out of stack space before hitting 1024 in some situations.
2275 @item -fno-threadsafe-statics
2276 @opindex fno-threadsafe-statics
2277 Do not emit the extra code to use the routines specified in the C++
2278 ABI for thread-safe initialization of local statics.  You can use this
2279 option to reduce code size slightly in code that doesn't need to be
2280 thread-safe.
2282 @item -fuse-cxa-atexit
2283 @opindex fuse-cxa-atexit
2284 Register destructors for objects with static storage duration with the
2285 @code{__cxa_atexit} function rather than the @code{atexit} function.
2286 This option is required for fully standards-compliant handling of static
2287 destructors, but only works if your C library supports
2288 @code{__cxa_atexit}.
2290 @item -fno-use-cxa-get-exception-ptr
2291 @opindex fno-use-cxa-get-exception-ptr
2292 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2293 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2294 if the runtime routine is not available.
2296 @item -fvisibility-inlines-hidden
2297 @opindex fvisibility-inlines-hidden
2298 This switch declares that the user does not attempt to compare
2299 pointers to inline functions or methods where the addresses of the two functions
2300 are taken in different shared objects.
2302 The effect of this is that GCC may, effectively, mark inline methods with
2303 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2304 appear in the export table of a DSO and do not require a PLT indirection
2305 when used within the DSO@.  Enabling this option can have a dramatic effect
2306 on load and link times of a DSO as it massively reduces the size of the
2307 dynamic export table when the library makes heavy use of templates.
2309 The behavior of this switch is not quite the same as marking the
2310 methods as hidden directly, because it does not affect static variables
2311 local to the function or cause the compiler to deduce that
2312 the function is defined in only one shared object.
2314 You may mark a method as having a visibility explicitly to negate the
2315 effect of the switch for that method.  For example, if you do want to
2316 compare pointers to a particular inline method, you might mark it as
2317 having default visibility.  Marking the enclosing class with explicit
2318 visibility has no effect.
2320 Explicitly instantiated inline methods are unaffected by this option
2321 as their linkage might otherwise cross a shared library boundary.
2322 @xref{Template Instantiation}.
2324 @item -fvisibility-ms-compat
2325 @opindex fvisibility-ms-compat
2326 This flag attempts to use visibility settings to make GCC's C++
2327 linkage model compatible with that of Microsoft Visual Studio.
2329 The flag makes these changes to GCC's linkage model:
2331 @enumerate
2332 @item
2333 It sets the default visibility to @code{hidden}, like
2334 @option{-fvisibility=hidden}.
2336 @item
2337 Types, but not their members, are not hidden by default.
2339 @item
2340 The One Definition Rule is relaxed for types without explicit
2341 visibility specifications that are defined in more than one
2342 shared object: those declarations are permitted if they are
2343 permitted when this option is not used.
2344 @end enumerate
2346 In new code it is better to use @option{-fvisibility=hidden} and
2347 export those classes that are intended to be externally visible.
2348 Unfortunately it is possible for code to rely, perhaps accidentally,
2349 on the Visual Studio behavior.
2351 Among the consequences of these changes are that static data members
2352 of the same type with the same name but defined in different shared
2353 objects are different, so changing one does not change the other;
2354 and that pointers to function members defined in different shared
2355 objects may not compare equal.  When this flag is given, it is a
2356 violation of the ODR to define types with the same name differently.
2358 @item -fvtable-verify=@var{std|preinit|none}
2359 @opindex fvtable-verify
2360 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2361 feature that verifies at runtime, for every virtual call that is made, that
2362 the vtable pointer through which the call is made is valid for the type of
2363 the object, and has not been corrupted or overwritten.  If an invalid vtable
2364 pointer is detected (at runtime), an error is reported and execution of the
2365 program is immediately halted.
2367 This option causes runtime data structures to be built, at program start up,
2368 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2369 control the timing of when these data structures are built.  In both cases the
2370 data structures are built before execution reaches 'main'.  The
2371 @option{-fvtable-verify=std} causes these data structure to be built after the
2372 shared libraries have been loaded and initialized.
2373 @option{-fvtable-verify=preinit} causes them to be built before the shared
2374 libraries have been loaded and initialized.
2376 If this option appears multiple times in the compiler line, with different
2377 values specified, 'none' will take highest priority over both 'std' and
2378 'preinit'; 'preinit' will take priority over 'std'.
2380 @item -fvtv-debug
2381 @opindex (fvtv-debug)
2382 Causes debug versions of the runtime functions for the vtable verification 
2383 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2384 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2385 compiler to keep track of which vtable pointers it found for each class, and
2386 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2387 file directory on the user's machine.
2389 Note:  This feature APPENDS data to the log file. If you want a fresh log
2390 file, be sure to delete any existing one.
2392 @item -fvtv-counts
2393 @opindex (fvtv-counts)
2394 This is a debugging flag.  When used in conjunction with
2395 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2396 causes the compiler to keep track of the total number of virtual calls
2397 it encountered and the number of verifications it inserted.  It also
2398 counts the number of calls to certain runtime library functions
2399 that it inserts.  This information, for each compilation unit, is written
2400 to a file named ``vtv_count_data.log'', in the dump_file directory on
2401 the user's machine.   It also counts the size of the vtable pointer sets
2402 for each class, and writes this information to ``vtv_class_set_sizes.log''
2403 in the same directory.
2405 Note:  This feature APPENDS data to the log files.  To get a fresh log
2406 files, be sure to delete any existing ones.
2408 @item -fno-weak
2409 @opindex fno-weak
2410 Do not use weak symbol support, even if it is provided by the linker.
2411 By default, G++ uses weak symbols if they are available.  This
2412 option exists only for testing, and should not be used by end-users;
2413 it results in inferior code and has no benefits.  This option may
2414 be removed in a future release of G++.
2416 @item -nostdinc++
2417 @opindex nostdinc++
2418 Do not search for header files in the standard directories specific to
2419 C++, but do still search the other standard directories.  (This option
2420 is used when building the C++ library.)
2421 @end table
2423 In addition, these optimization, warning, and code generation options
2424 have meanings only for C++ programs:
2426 @table @gcctabopt
2427 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2428 @opindex Wabi
2429 @opindex Wno-abi
2430 Warn when G++ generates code that is probably not compatible with the
2431 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2432 all such cases, there are probably some cases that are not warned about,
2433 even though G++ is generating incompatible code.  There may also be
2434 cases where warnings are emitted even though the code that is generated
2435 is compatible.
2437 You should rewrite your code to avoid these warnings if you are
2438 concerned about the fact that code generated by G++ may not be binary
2439 compatible with code generated by other compilers.
2441 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2443 @itemize @bullet
2445 @item
2446 A template with a non-type template parameter of reference type is
2447 mangled incorrectly:
2448 @smallexample
2449 extern int N;
2450 template <int &> struct S @{@};
2451 void n (S<N>) @{2@}
2452 @end smallexample
2454 This is fixed in @option{-fabi-version=3}.
2456 @item
2457 SIMD vector types declared using @code{__attribute ((vector_size))} are
2458 mangled in a non-standard way that does not allow for overloading of
2459 functions taking vectors of different sizes.
2461 The mangling is changed in @option{-fabi-version=4}.
2462 @end itemize
2464 The known incompatibilities in @option{-fabi-version=1} include:
2466 @itemize @bullet
2468 @item
2469 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2470 pack data into the same byte as a base class.  For example:
2472 @smallexample
2473 struct A @{ virtual void f(); int f1 : 1; @};
2474 struct B : public A @{ int f2 : 1; @};
2475 @end smallexample
2477 @noindent
2478 In this case, G++ places @code{B::f2} into the same byte
2479 as @code{A::f1}; other compilers do not.  You can avoid this problem
2480 by explicitly padding @code{A} so that its size is a multiple of the
2481 byte size on your platform; that causes G++ and other compilers to
2482 lay out @code{B} identically.
2484 @item
2485 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2486 tail padding when laying out virtual bases.  For example:
2488 @smallexample
2489 struct A @{ virtual void f(); char c1; @};
2490 struct B @{ B(); char c2; @};
2491 struct C : public A, public virtual B @{@};
2492 @end smallexample
2494 @noindent
2495 In this case, G++ does not place @code{B} into the tail-padding for
2496 @code{A}; other compilers do.  You can avoid this problem by
2497 explicitly padding @code{A} so that its size is a multiple of its
2498 alignment (ignoring virtual base classes); that causes G++ and other
2499 compilers to lay out @code{C} identically.
2501 @item
2502 Incorrect handling of bit-fields with declared widths greater than that
2503 of their underlying types, when the bit-fields appear in a union.  For
2504 example:
2506 @smallexample
2507 union U @{ int i : 4096; @};
2508 @end smallexample
2510 @noindent
2511 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2512 union too small by the number of bits in an @code{int}.
2514 @item
2515 Empty classes can be placed at incorrect offsets.  For example:
2517 @smallexample
2518 struct A @{@};
2520 struct B @{
2521   A a;
2522   virtual void f ();
2525 struct C : public B, public A @{@};
2526 @end smallexample
2528 @noindent
2529 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2530 it should be placed at offset zero.  G++ mistakenly believes that the
2531 @code{A} data member of @code{B} is already at offset zero.
2533 @item
2534 Names of template functions whose types involve @code{typename} or
2535 template template parameters can be mangled incorrectly.
2537 @smallexample
2538 template <typename Q>
2539 void f(typename Q::X) @{@}
2541 template <template <typename> class Q>
2542 void f(typename Q<int>::X) @{@}
2543 @end smallexample
2545 @noindent
2546 Instantiations of these templates may be mangled incorrectly.
2548 @end itemize
2550 It also warns about psABI-related changes.  The known psABI changes at this
2551 point include:
2553 @itemize @bullet
2555 @item
2556 For SysV/x86-64, unions with @code{long double} members are 
2557 passed in memory as specified in psABI.  For example:
2559 @smallexample
2560 union U @{
2561   long double ld;
2562   int i;
2564 @end smallexample
2566 @noindent
2567 @code{union U} is always passed in memory.
2569 @end itemize
2571 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2572 @opindex Wctor-dtor-privacy
2573 @opindex Wno-ctor-dtor-privacy
2574 Warn when a class seems unusable because all the constructors or
2575 destructors in that class are private, and it has neither friends nor
2576 public static member functions.  Also warn if there are no non-private
2577 methods, and there's at least one private member function that isn't
2578 a constructor or destructor.
2580 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2581 @opindex Wdelete-non-virtual-dtor
2582 @opindex Wno-delete-non-virtual-dtor
2583 Warn when @samp{delete} is used to destroy an instance of a class that
2584 has virtual functions and non-virtual destructor. It is unsafe to delete
2585 an instance of a derived class through a pointer to a base class if the
2586 base class does not have a virtual destructor.  This warning is enabled
2587 by @option{-Wall}.
2589 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2590 @opindex Wliteral-suffix
2591 @opindex Wno-literal-suffix
2592 Warn when a string or character literal is followed by a ud-suffix which does
2593 not begin with an underscore.  As a conforming extension, GCC treats such
2594 suffixes as separate preprocessing tokens in order to maintain backwards
2595 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2596 For example:
2598 @smallexample
2599 #define __STDC_FORMAT_MACROS
2600 #include <inttypes.h>
2601 #include <stdio.h>
2603 int main() @{
2604   int64_t i64 = 123;
2605   printf("My int64: %"PRId64"\n", i64);
2607 @end smallexample
2609 In this case, @code{PRId64} is treated as a separate preprocessing token.
2611 This warning is enabled by default.
2613 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2614 @opindex Wnarrowing
2615 @opindex Wno-narrowing
2616 Warn when a narrowing conversion prohibited by C++11 occurs within
2617 @samp{@{ @}}, e.g.
2619 @smallexample
2620 int i = @{ 2.2 @}; // error: narrowing from double to int
2621 @end smallexample
2623 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2625 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2626 required by the standard.  Note that this does not affect the meaning
2627 of well-formed code; narrowing conversions are still considered
2628 ill-formed in SFINAE context.
2630 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2631 @opindex Wnoexcept
2632 @opindex Wno-noexcept
2633 Warn when a noexcept-expression evaluates to false because of a call
2634 to a function that does not have a non-throwing exception
2635 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2636 the compiler to never throw an exception.
2638 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2639 @opindex Wnon-virtual-dtor
2640 @opindex Wno-non-virtual-dtor
2641 Warn when a class has virtual functions and an accessible non-virtual
2642 destructor, in which case it is possible but unsafe to delete
2643 an instance of a derived class through a pointer to the base class.
2644 This warning is also enabled if @option{-Weffc++} is specified.
2646 @item -Wreorder @r{(C++ and Objective-C++ only)}
2647 @opindex Wreorder
2648 @opindex Wno-reorder
2649 @cindex reordering, warning
2650 @cindex warning for reordering of member initializers
2651 Warn when the order of member initializers given in the code does not
2652 match the order in which they must be executed.  For instance:
2654 @smallexample
2655 struct A @{
2656   int i;
2657   int j;
2658   A(): j (0), i (1) @{ @}
2660 @end smallexample
2662 @noindent
2663 The compiler rearranges the member initializers for @samp{i}
2664 and @samp{j} to match the declaration order of the members, emitting
2665 a warning to that effect.  This warning is enabled by @option{-Wall}.
2667 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2668 @opindex fext-numeric-literals
2669 @opindex fno-ext-numeric-literals
2670 Accept imaginary, fixed-point, or machine-defined
2671 literal number suffixes as GNU extensions.
2672 When this option is turned off these suffixes are treated
2673 as C++11 user-defined literal numeric suffixes.
2674 This is on by default for all pre-C++11 dialects and all GNU dialects:
2675 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2676 @option{-std=gnu++1y}.
2677 This option is off by default
2678 for ISO C++11 onwards (@option{-std=c++11}, ...).
2679 @end table
2681 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2683 @table @gcctabopt
2684 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2685 @opindex Weffc++
2686 @opindex Wno-effc++
2687 Warn about violations of the following style guidelines from Scott Meyers'
2688 @cite{Effective C++, Second Edition} book:
2690 @itemize @bullet
2691 @item
2692 Item 11:  Define a copy constructor and an assignment operator for classes
2693 with dynamically-allocated memory.
2695 @item
2696 Item 12:  Prefer initialization to assignment in constructors.
2698 @item
2699 Item 14:  Make destructors virtual in base classes.
2701 @item
2702 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2704 @item
2705 Item 23:  Don't try to return a reference when you must return an object.
2707 @end itemize
2709 Also warn about violations of the following style guidelines from
2710 Scott Meyers' @cite{More Effective C++} book:
2712 @itemize @bullet
2713 @item
2714 Item 6:  Distinguish between prefix and postfix forms of increment and
2715 decrement operators.
2717 @item
2718 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2720 @end itemize
2722 When selecting this option, be aware that the standard library
2723 headers do not obey all of these guidelines; use @samp{grep -v}
2724 to filter out those warnings.
2726 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2727 @opindex Wstrict-null-sentinel
2728 @opindex Wno-strict-null-sentinel
2729 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2730 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2731 to @code{__null}.  Although it is a null pointer constant rather than a
2732 null pointer, it is guaranteed to be of the same size as a pointer.
2733 But this use is not portable across different compilers.
2735 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2736 @opindex Wno-non-template-friend
2737 @opindex Wnon-template-friend
2738 Disable warnings when non-templatized friend functions are declared
2739 within a template.  Since the advent of explicit template specification
2740 support in G++, if the name of the friend is an unqualified-id (i.e.,
2741 @samp{friend foo(int)}), the C++ language specification demands that the
2742 friend declare or define an ordinary, nontemplate function.  (Section
2743 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2744 could be interpreted as a particular specialization of a templatized
2745 function.  Because this non-conforming behavior is no longer the default
2746 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2747 check existing code for potential trouble spots and is on by default.
2748 This new compiler behavior can be turned off with
2749 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2750 but disables the helpful warning.
2752 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2753 @opindex Wold-style-cast
2754 @opindex Wno-old-style-cast
2755 Warn if an old-style (C-style) cast to a non-void type is used within
2756 a C++ program.  The new-style casts (@samp{dynamic_cast},
2757 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2758 less vulnerable to unintended effects and much easier to search for.
2760 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2761 @opindex Woverloaded-virtual
2762 @opindex Wno-overloaded-virtual
2763 @cindex overloaded virtual function, warning
2764 @cindex warning for overloaded virtual function
2765 Warn when a function declaration hides virtual functions from a
2766 base class.  For example, in:
2768 @smallexample
2769 struct A @{
2770   virtual void f();
2773 struct B: public A @{
2774   void f(int);
2776 @end smallexample
2778 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2779 like:
2781 @smallexample
2782 B* b;
2783 b->f();
2784 @end smallexample
2786 @noindent
2787 fails to compile.
2789 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2790 @opindex Wno-pmf-conversions
2791 @opindex Wpmf-conversions
2792 Disable the diagnostic for converting a bound pointer to member function
2793 to a plain pointer.
2795 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2796 @opindex Wsign-promo
2797 @opindex Wno-sign-promo
2798 Warn when overload resolution chooses a promotion from unsigned or
2799 enumerated type to a signed type, over a conversion to an unsigned type of
2800 the same size.  Previous versions of G++ tried to preserve
2801 unsignedness, but the standard mandates the current behavior.
2802 @end table
2804 @node Objective-C and Objective-C++ Dialect Options
2805 @section Options Controlling Objective-C and Objective-C++ Dialects
2807 @cindex compiler options, Objective-C and Objective-C++
2808 @cindex Objective-C and Objective-C++ options, command-line
2809 @cindex options, Objective-C and Objective-C++
2810 (NOTE: This manual does not describe the Objective-C and Objective-C++
2811 languages themselves.  @xref{Standards,,Language Standards
2812 Supported by GCC}, for references.)
2814 This section describes the command-line options that are only meaningful
2815 for Objective-C and Objective-C++ programs.  You can also use most of
2816 the language-independent GNU compiler options.
2817 For example, you might compile a file @code{some_class.m} like this:
2819 @smallexample
2820 gcc -g -fgnu-runtime -O -c some_class.m
2821 @end smallexample
2823 @noindent
2824 In this example, @option{-fgnu-runtime} is an option meant only for
2825 Objective-C and Objective-C++ programs; you can use the other options with
2826 any language supported by GCC@.
2828 Note that since Objective-C is an extension of the C language, Objective-C
2829 compilations may also use options specific to the C front-end (e.g.,
2830 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2831 C++-specific options (e.g., @option{-Wabi}).
2833 Here is a list of options that are @emph{only} for compiling Objective-C
2834 and Objective-C++ programs:
2836 @table @gcctabopt
2837 @item -fconstant-string-class=@var{class-name}
2838 @opindex fconstant-string-class
2839 Use @var{class-name} as the name of the class to instantiate for each
2840 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2841 class name is @code{NXConstantString} if the GNU runtime is being used, and
2842 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2843 @option{-fconstant-cfstrings} option, if also present, overrides the
2844 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2845 to be laid out as constant CoreFoundation strings.
2847 @item -fgnu-runtime
2848 @opindex fgnu-runtime
2849 Generate object code compatible with the standard GNU Objective-C
2850 runtime.  This is the default for most types of systems.
2852 @item -fnext-runtime
2853 @opindex fnext-runtime
2854 Generate output compatible with the NeXT runtime.  This is the default
2855 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2856 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2857 used.
2859 @item -fno-nil-receivers
2860 @opindex fno-nil-receivers
2861 Assume that all Objective-C message dispatches (@code{[receiver
2862 message:arg]}) in this translation unit ensure that the receiver is
2863 not @code{nil}.  This allows for more efficient entry points in the
2864 runtime to be used.  This option is only available in conjunction with
2865 the NeXT runtime and ABI version 0 or 1.
2867 @item -fobjc-abi-version=@var{n}
2868 @opindex fobjc-abi-version
2869 Use version @var{n} of the Objective-C ABI for the selected runtime.
2870 This option is currently supported only for the NeXT runtime.  In that
2871 case, Version 0 is the traditional (32-bit) ABI without support for
2872 properties and other Objective-C 2.0 additions.  Version 1 is the
2873 traditional (32-bit) ABI with support for properties and other
2874 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2875 nothing is specified, the default is Version 0 on 32-bit target
2876 machines, and Version 2 on 64-bit target machines.
2878 @item -fobjc-call-cxx-cdtors
2879 @opindex fobjc-call-cxx-cdtors
2880 For each Objective-C class, check if any of its instance variables is a
2881 C++ object with a non-trivial default constructor.  If so, synthesize a
2882 special @code{- (id) .cxx_construct} instance method which runs
2883 non-trivial default constructors on any such instance variables, in order,
2884 and then return @code{self}.  Similarly, check if any instance variable
2885 is a C++ object with a non-trivial destructor, and if so, synthesize a
2886 special @code{- (void) .cxx_destruct} method which runs
2887 all such default destructors, in reverse order.
2889 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2890 methods thusly generated only operate on instance variables
2891 declared in the current Objective-C class, and not those inherited
2892 from superclasses.  It is the responsibility of the Objective-C
2893 runtime to invoke all such methods in an object's inheritance
2894 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2895 by the runtime immediately after a new object instance is allocated;
2896 the @code{- (void) .cxx_destruct} methods are invoked immediately
2897 before the runtime deallocates an object instance.
2899 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2900 support for invoking the @code{- (id) .cxx_construct} and
2901 @code{- (void) .cxx_destruct} methods.
2903 @item -fobjc-direct-dispatch
2904 @opindex fobjc-direct-dispatch
2905 Allow fast jumps to the message dispatcher.  On Darwin this is
2906 accomplished via the comm page.
2908 @item -fobjc-exceptions
2909 @opindex fobjc-exceptions
2910 Enable syntactic support for structured exception handling in
2911 Objective-C, similar to what is offered by C++ and Java.  This option
2912 is required to use the Objective-C keywords @code{@@try},
2913 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2914 @code{@@synchronized}.  This option is available with both the GNU
2915 runtime and the NeXT runtime (but not available in conjunction with
2916 the NeXT runtime on Mac OS X 10.2 and earlier).
2918 @item -fobjc-gc
2919 @opindex fobjc-gc
2920 Enable garbage collection (GC) in Objective-C and Objective-C++
2921 programs.  This option is only available with the NeXT runtime; the
2922 GNU runtime has a different garbage collection implementation that
2923 does not require special compiler flags.
2925 @item -fobjc-nilcheck
2926 @opindex fobjc-nilcheck
2927 For the NeXT runtime with version 2 of the ABI, check for a nil
2928 receiver in method invocations before doing the actual method call.
2929 This is the default and can be disabled using
2930 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2931 checked for nil in this way no matter what this flag is set to.
2932 Currently this flag does nothing when the GNU runtime, or an older
2933 version of the NeXT runtime ABI, is used.
2935 @item -fobjc-std=objc1
2936 @opindex fobjc-std
2937 Conform to the language syntax of Objective-C 1.0, the language
2938 recognized by GCC 4.0.  This only affects the Objective-C additions to
2939 the C/C++ language; it does not affect conformance to C/C++ standards,
2940 which is controlled by the separate C/C++ dialect option flags.  When
2941 this option is used with the Objective-C or Objective-C++ compiler,
2942 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2943 This is useful if you need to make sure that your Objective-C code can
2944 be compiled with older versions of GCC@.
2946 @item -freplace-objc-classes
2947 @opindex freplace-objc-classes
2948 Emit a special marker instructing @command{ld(1)} not to statically link in
2949 the resulting object file, and allow @command{dyld(1)} to load it in at
2950 run time instead.  This is used in conjunction with the Fix-and-Continue
2951 debugging mode, where the object file in question may be recompiled and
2952 dynamically reloaded in the course of program execution, without the need
2953 to restart the program itself.  Currently, Fix-and-Continue functionality
2954 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2955 and later.
2957 @item -fzero-link
2958 @opindex fzero-link
2959 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2960 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2961 compile time) with static class references that get initialized at load time,
2962 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2963 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2964 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2965 for individual class implementations to be modified during program execution.
2966 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2967 regardless of command-line options.
2969 @item -gen-decls
2970 @opindex gen-decls
2971 Dump interface declarations for all classes seen in the source file to a
2972 file named @file{@var{sourcename}.decl}.
2974 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2975 @opindex Wassign-intercept
2976 @opindex Wno-assign-intercept
2977 Warn whenever an Objective-C assignment is being intercepted by the
2978 garbage collector.
2980 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2981 @opindex Wno-protocol
2982 @opindex Wprotocol
2983 If a class is declared to implement a protocol, a warning is issued for
2984 every method in the protocol that is not implemented by the class.  The
2985 default behavior is to issue a warning for every method not explicitly
2986 implemented in the class, even if a method implementation is inherited
2987 from the superclass.  If you use the @option{-Wno-protocol} option, then
2988 methods inherited from the superclass are considered to be implemented,
2989 and no warning is issued for them.
2991 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2992 @opindex Wselector
2993 @opindex Wno-selector
2994 Warn if multiple methods of different types for the same selector are
2995 found during compilation.  The check is performed on the list of methods
2996 in the final stage of compilation.  Additionally, a check is performed
2997 for each selector appearing in a @code{@@selector(@dots{})}
2998 expression, and a corresponding method for that selector has been found
2999 during compilation.  Because these checks scan the method table only at
3000 the end of compilation, these warnings are not produced if the final
3001 stage of compilation is not reached, for example because an error is
3002 found during compilation, or because the @option{-fsyntax-only} option is
3003 being used.
3005 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3006 @opindex Wstrict-selector-match
3007 @opindex Wno-strict-selector-match
3008 Warn if multiple methods with differing argument and/or return types are
3009 found for a given selector when attempting to send a message using this
3010 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3011 is off (which is the default behavior), the compiler omits such warnings
3012 if any differences found are confined to types that share the same size
3013 and alignment.
3015 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3016 @opindex Wundeclared-selector
3017 @opindex Wno-undeclared-selector
3018 Warn if a @code{@@selector(@dots{})} expression referring to an
3019 undeclared selector is found.  A selector is considered undeclared if no
3020 method with that name has been declared before the
3021 @code{@@selector(@dots{})} expression, either explicitly in an
3022 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3023 an @code{@@implementation} section.  This option always performs its
3024 checks as soon as a @code{@@selector(@dots{})} expression is found,
3025 while @option{-Wselector} only performs its checks in the final stage of
3026 compilation.  This also enforces the coding style convention
3027 that methods and selectors must be declared before being used.
3029 @item -print-objc-runtime-info
3030 @opindex print-objc-runtime-info
3031 Generate C header describing the largest structure that is passed by
3032 value, if any.
3034 @end table
3036 @node Language Independent Options
3037 @section Options to Control Diagnostic Messages Formatting
3038 @cindex options to control diagnostics formatting
3039 @cindex diagnostic messages
3040 @cindex message formatting
3042 Traditionally, diagnostic messages have been formatted irrespective of
3043 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3044 options described below
3045 to control the formatting algorithm for diagnostic messages, 
3046 e.g.@: how many characters per line, how often source location
3047 information should be reported.  Note that some language front ends may not
3048 honor these options.
3050 @table @gcctabopt
3051 @item -fmessage-length=@var{n}
3052 @opindex fmessage-length
3053 Try to format error messages so that they fit on lines of about @var{n}
3054 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
3055 the front ends supported by GCC@.  If @var{n} is zero, then no
3056 line-wrapping is done; each error message appears on a single
3057 line.
3059 @item -fdiagnostics-show-location=once
3060 @opindex fdiagnostics-show-location
3061 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3062 reporter to emit source location information @emph{once}; that is, in
3063 case the message is too long to fit on a single physical line and has to
3064 be wrapped, the source location won't be emitted (as prefix) again,
3065 over and over, in subsequent continuation lines.  This is the default
3066 behavior.
3068 @item -fdiagnostics-show-location=every-line
3069 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3070 messages reporter to emit the same source location information (as
3071 prefix) for physical lines that result from the process of breaking
3072 a message which is too long to fit on a single line.
3074 @item -fdiagnostics-color[=@var{WHEN}]
3075 @itemx -fno-diagnostics-color
3076 @opindex fdiagnostics-color
3077 @cindex highlight, color, colour
3078 @vindex GCC_COLORS @r{environment variable}
3079 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3080 or @samp{auto}.  The default is @samp{never} if @env{GCC_COLORS} environment
3081 variable isn't present in the environment, and @samp{auto} otherwise.
3082 @samp{auto} means to use color only when the standard error is a terminal.
3083 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3084 aliases for @option{-fdiagnostics-color=always} and
3085 @option{-fdiagnostics-color=never}, respectively.
3087 The colors are defined by the environment variable @env{GCC_COLORS}.
3088 Its value is a colon-separated list of capabilities and Select Graphic
3089 Rendition (SGR) substrings. SGR commands are interpreted by the
3090 terminal or terminal emulator.  (See the section in the documentation
3091 of your text terminal for permitted values and their meanings as
3092 character attributes.)  These substring values are integers in decimal
3093 representation and can be concatenated with semicolons.
3094 Common values to concatenate include
3095 @samp{1} for bold,
3096 @samp{4} for underline,
3097 @samp{5} for blink,
3098 @samp{7} for inverse,
3099 @samp{39} for default foreground color,
3100 @samp{30} to @samp{37} for foreground colors,
3101 @samp{90} to @samp{97} for 16-color mode foreground colors,
3102 @samp{38;5;0} to @samp{38;5;255}
3103 for 88-color and 256-color modes foreground colors,
3104 @samp{49} for default background color,
3105 @samp{40} to @samp{47} for background colors,
3106 @samp{100} to @samp{107} for 16-color mode background colors,
3107 and @samp{48;5;0} to @samp{48;5;255}
3108 for 88-color and 256-color modes background colors.
3110 The default @env{GCC_COLORS} is
3111 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3112 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3113 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3114 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3115 string disables colors.
3116 Supported capabilities are as follows.
3118 @table @code
3119 @item error=
3120 @vindex error GCC_COLORS @r{capability}
3121 SGR substring for error: markers.
3123 @item warning=
3124 @vindex warning GCC_COLORS @r{capability}
3125 SGR substring for warning: markers.
3127 @item note=
3128 @vindex note GCC_COLORS @r{capability}
3129 SGR substring for note: markers.
3131 @item caret=
3132 @vindex caret GCC_COLORS @r{capability}
3133 SGR substring for caret line.
3135 @item locus=
3136 @vindex locus GCC_COLORS @r{capability}
3137 SGR substring for location information, @samp{file:line} or
3138 @samp{file:line:column} etc.
3140 @item quote=
3141 @vindex quote GCC_COLORS @r{capability}
3142 SGR substring for information printed within quotes.
3143 @end table
3145 @item -fno-diagnostics-show-option
3146 @opindex fno-diagnostics-show-option
3147 @opindex fdiagnostics-show-option
3148 By default, each diagnostic emitted includes text indicating the
3149 command-line option that directly controls the diagnostic (if such an
3150 option is known to the diagnostic machinery).  Specifying the
3151 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3153 @item -fno-diagnostics-show-caret
3154 @opindex fno-diagnostics-show-caret
3155 @opindex fdiagnostics-show-caret
3156 By default, each diagnostic emitted includes the original source line
3157 and a caret '^' indicating the column.  This option suppresses this
3158 information.
3160 @end table
3162 @node Warning Options
3163 @section Options to Request or Suppress Warnings
3164 @cindex options to control warnings
3165 @cindex warning messages
3166 @cindex messages, warning
3167 @cindex suppressing warnings
3169 Warnings are diagnostic messages that report constructions that
3170 are not inherently erroneous but that are risky or suggest there
3171 may have been an error.
3173 The following language-independent options do not enable specific
3174 warnings but control the kinds of diagnostics produced by GCC@.
3176 @table @gcctabopt
3177 @cindex syntax checking
3178 @item -fsyntax-only
3179 @opindex fsyntax-only
3180 Check the code for syntax errors, but don't do anything beyond that.
3182 @item -fmax-errors=@var{n}
3183 @opindex fmax-errors
3184 Limits the maximum number of error messages to @var{n}, at which point
3185 GCC bails out rather than attempting to continue processing the source
3186 code.  If @var{n} is 0 (the default), there is no limit on the number
3187 of error messages produced.  If @option{-Wfatal-errors} is also
3188 specified, then @option{-Wfatal-errors} takes precedence over this
3189 option.
3191 @item -w
3192 @opindex w
3193 Inhibit all warning messages.
3195 @item -Werror
3196 @opindex Werror
3197 @opindex Wno-error
3198 Make all warnings into errors.
3200 @item -Werror=
3201 @opindex Werror=
3202 @opindex Wno-error=
3203 Make the specified warning into an error.  The specifier for a warning
3204 is appended; for example @option{-Werror=switch} turns the warnings
3205 controlled by @option{-Wswitch} into errors.  This switch takes a
3206 negative form, to be used to negate @option{-Werror} for specific
3207 warnings; for example @option{-Wno-error=switch} makes
3208 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3209 is in effect.
3211 The warning message for each controllable warning includes the
3212 option that controls the warning.  That option can then be used with
3213 @option{-Werror=} and @option{-Wno-error=} as described above.
3214 (Printing of the option in the warning message can be disabled using the
3215 @option{-fno-diagnostics-show-option} flag.)
3217 Note that specifying @option{-Werror=}@var{foo} automatically implies
3218 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3219 imply anything.
3221 @item -Wfatal-errors
3222 @opindex Wfatal-errors
3223 @opindex Wno-fatal-errors
3224 This option causes the compiler to abort compilation on the first error
3225 occurred rather than trying to keep going and printing further error
3226 messages.
3228 @end table
3230 You can request many specific warnings with options beginning with
3231 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3232 implicit declarations.  Each of these specific warning options also
3233 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3234 example, @option{-Wno-implicit}.  This manual lists only one of the
3235 two forms, whichever is not the default.  For further
3236 language-specific options also refer to @ref{C++ Dialect Options} and
3237 @ref{Objective-C and Objective-C++ Dialect Options}.
3239 When an unrecognized warning option is requested (e.g.,
3240 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3241 that the option is not recognized.  However, if the @option{-Wno-} form
3242 is used, the behavior is slightly different: no diagnostic is
3243 produced for @option{-Wno-unknown-warning} unless other diagnostics
3244 are being produced.  This allows the use of new @option{-Wno-} options
3245 with old compilers, but if something goes wrong, the compiler
3246 warns that an unrecognized option is present.
3248 @table @gcctabopt
3249 @item -Wpedantic
3250 @itemx -pedantic
3251 @opindex pedantic
3252 @opindex Wpedantic
3253 Issue all the warnings demanded by strict ISO C and ISO C++;
3254 reject all programs that use forbidden extensions, and some other
3255 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3256 version of the ISO C standard specified by any @option{-std} option used.
3258 Valid ISO C and ISO C++ programs should compile properly with or without
3259 this option (though a rare few require @option{-ansi} or a
3260 @option{-std} option specifying the required version of ISO C)@.  However,
3261 without this option, certain GNU extensions and traditional C and C++
3262 features are supported as well.  With this option, they are rejected.
3264 @option{-Wpedantic} does not cause warning messages for use of the
3265 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3266 warnings are also disabled in the expression that follows
3267 @code{__extension__}.  However, only system header files should use
3268 these escape routes; application programs should avoid them.
3269 @xref{Alternate Keywords}.
3271 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3272 C conformance.  They soon find that it does not do quite what they want:
3273 it finds some non-ISO practices, but not all---only those for which
3274 ISO C @emph{requires} a diagnostic, and some others for which
3275 diagnostics have been added.
3277 A feature to report any failure to conform to ISO C might be useful in
3278 some instances, but would require considerable additional work and would
3279 be quite different from @option{-Wpedantic}.  We don't have plans to
3280 support such a feature in the near future.
3282 Where the standard specified with @option{-std} represents a GNU
3283 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3284 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3285 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3286 where they are required by the base standard.  (It does not make sense
3287 for such warnings to be given only for features not in the specified GNU
3288 C dialect, since by definition the GNU dialects of C include all
3289 features the compiler supports with the given option, and there would be
3290 nothing to warn about.)
3292 @item -pedantic-errors
3293 @opindex pedantic-errors
3294 Like @option{-Wpedantic}, except that errors are produced rather than
3295 warnings.
3297 @item -Wall
3298 @opindex Wall
3299 @opindex Wno-all
3300 This enables all the warnings about constructions that some users
3301 consider questionable, and that are easy to avoid (or modify to
3302 prevent the warning), even in conjunction with macros.  This also
3303 enables some language-specific warnings described in @ref{C++ Dialect
3304 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3306 @option{-Wall} turns on the following warning flags:
3308 @gccoptlist{-Waddress   @gol
3309 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3310 -Wc++11-compat  @gol
3311 -Wchar-subscripts  @gol
3312 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3313 -Wimplicit-int @r{(C and Objective-C only)} @gol
3314 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3315 -Wcomment  @gol
3316 -Wformat   @gol
3317 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3318 -Wmaybe-uninitialized @gol
3319 -Wmissing-braces @r{(only for C/ObjC)} @gol
3320 -Wnonnull  @gol
3321 -Wparentheses  @gol
3322 -Wpointer-sign  @gol
3323 -Wreorder   @gol
3324 -Wreturn-type  @gol
3325 -Wsequence-point  @gol
3326 -Wsign-compare @r{(only in C++)}  @gol
3327 -Wstrict-aliasing  @gol
3328 -Wstrict-overflow=1  @gol
3329 -Wswitch  @gol
3330 -Wtrigraphs  @gol
3331 -Wuninitialized  @gol
3332 -Wunknown-pragmas  @gol
3333 -Wunused-function  @gol
3334 -Wunused-label     @gol
3335 -Wunused-value     @gol
3336 -Wunused-variable  @gol
3337 -Wvolatile-register-var @gol
3340 Note that some warning flags are not implied by @option{-Wall}.  Some of
3341 them warn about constructions that users generally do not consider
3342 questionable, but which occasionally you might wish to check for;
3343 others warn about constructions that are necessary or hard to avoid in
3344 some cases, and there is no simple way to modify the code to suppress
3345 the warning. Some of them are enabled by @option{-Wextra} but many of
3346 them must be enabled individually.
3348 @item -Wextra
3349 @opindex W
3350 @opindex Wextra
3351 @opindex Wno-extra
3352 This enables some extra warning flags that are not enabled by
3353 @option{-Wall}. (This option used to be called @option{-W}.  The older
3354 name is still supported, but the newer name is more descriptive.)
3356 @gccoptlist{-Wclobbered  @gol
3357 -Wempty-body  @gol
3358 -Wignored-qualifiers @gol
3359 -Wmissing-field-initializers  @gol
3360 -Wmissing-parameter-type @r{(C only)}  @gol
3361 -Wold-style-declaration @r{(C only)}  @gol
3362 -Woverride-init  @gol
3363 -Wsign-compare  @gol
3364 -Wtype-limits  @gol
3365 -Wuninitialized  @gol
3366 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3367 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3370 The option @option{-Wextra} also prints warning messages for the
3371 following cases:
3373 @itemize @bullet
3375 @item
3376 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3377 @samp{>}, or @samp{>=}.
3379 @item
3380 (C++ only) An enumerator and a non-enumerator both appear in a
3381 conditional expression.
3383 @item
3384 (C++ only) Ambiguous virtual bases.
3386 @item
3387 (C++ only) Subscripting an array that has been declared @samp{register}.
3389 @item
3390 (C++ only) Taking the address of a variable that has been declared
3391 @samp{register}.
3393 @item
3394 (C++ only) A base class is not initialized in a derived class's copy
3395 constructor.
3397 @end itemize
3399 @item -Wchar-subscripts
3400 @opindex Wchar-subscripts
3401 @opindex Wno-char-subscripts
3402 Warn if an array subscript has type @code{char}.  This is a common cause
3403 of error, as programmers often forget that this type is signed on some
3404 machines.
3405 This warning is enabled by @option{-Wall}.
3407 @item -Wcomment
3408 @opindex Wcomment
3409 @opindex Wno-comment
3410 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3411 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3412 This warning is enabled by @option{-Wall}.
3414 @item -Wno-coverage-mismatch
3415 @opindex Wno-coverage-mismatch
3416 Warn if feedback profiles do not match when using the
3417 @option{-fprofile-use} option.
3418 If a source file is changed between compiling with @option{-fprofile-gen} and
3419 with @option{-fprofile-use}, the files with the profile feedback can fail
3420 to match the source file and GCC cannot use the profile feedback
3421 information.  By default, this warning is enabled and is treated as an
3422 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3423 warning or @option{-Wno-error=coverage-mismatch} can be used to
3424 disable the error.  Disabling the error for this warning can result in
3425 poorly optimized code and is useful only in the
3426 case of very minor changes such as bug fixes to an existing code-base.
3427 Completely disabling the warning is not recommended.
3429 @item -Wno-cpp
3430 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3432 Suppress warning messages emitted by @code{#warning} directives.
3434 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3435 @opindex Wdouble-promotion
3436 @opindex Wno-double-promotion
3437 Give a warning when a value of type @code{float} is implicitly
3438 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3439 floating-point unit implement @code{float} in hardware, but emulate
3440 @code{double} in software.  On such a machine, doing computations
3441 using @code{double} values is much more expensive because of the
3442 overhead required for software emulation.
3444 It is easy to accidentally do computations with @code{double} because
3445 floating-point literals are implicitly of type @code{double}.  For
3446 example, in:
3447 @smallexample
3448 @group
3449 float area(float radius)
3451    return 3.14159 * radius * radius;
3453 @end group
3454 @end smallexample
3455 the compiler performs the entire computation with @code{double}
3456 because the floating-point literal is a @code{double}.
3458 @item -Wformat
3459 @itemx -Wformat=@var{n}
3460 @opindex Wformat
3461 @opindex Wno-format
3462 @opindex ffreestanding
3463 @opindex fno-builtin
3464 @opindex Wformat=
3465 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3466 the arguments supplied have types appropriate to the format string
3467 specified, and that the conversions specified in the format string make
3468 sense.  This includes standard functions, and others specified by format
3469 attributes (@pxref{Function Attributes}), in the @code{printf},
3470 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3471 not in the C standard) families (or other target-specific families).
3472 Which functions are checked without format attributes having been
3473 specified depends on the standard version selected, and such checks of
3474 functions without the attribute specified are disabled by
3475 @option{-ffreestanding} or @option{-fno-builtin}.
3477 The formats are checked against the format features supported by GNU
3478 libc version 2.2.  These include all ISO C90 and C99 features, as well
3479 as features from the Single Unix Specification and some BSD and GNU
3480 extensions.  Other library implementations may not support all these
3481 features; GCC does not support warning about features that go beyond a
3482 particular library's limitations.  However, if @option{-Wpedantic} is used
3483 with @option{-Wformat}, warnings are given about format features not
3484 in the selected standard version (but not for @code{strfmon} formats,
3485 since those are not in any version of the C standard).  @xref{C Dialect
3486 Options,,Options Controlling C Dialect}.
3488 @table @gcctabopt
3489 @item -Wformat=1
3490 @itemx -Wformat
3491 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3492 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3493 @option{-Wformat} also checks for null format arguments for several
3494 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3495 aspects of this level of format checking can be disabled by the
3496 options: @option{-Wno-format-contains-nul},
3497 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3498 @option{-Wformat} is enabled by @option{-Wall}.
3500 @item -Wno-format-contains-nul
3501 @opindex Wno-format-contains-nul
3502 @opindex Wformat-contains-nul
3503 If @option{-Wformat} is specified, do not warn about format strings that
3504 contain NUL bytes.
3506 @item -Wno-format-extra-args
3507 @opindex Wno-format-extra-args
3508 @opindex Wformat-extra-args
3509 If @option{-Wformat} is specified, do not warn about excess arguments to a
3510 @code{printf} or @code{scanf} format function.  The C standard specifies
3511 that such arguments are ignored.
3513 Where the unused arguments lie between used arguments that are
3514 specified with @samp{$} operand number specifications, normally
3515 warnings are still given, since the implementation could not know what
3516 type to pass to @code{va_arg} to skip the unused arguments.  However,
3517 in the case of @code{scanf} formats, this option suppresses the
3518 warning if the unused arguments are all pointers, since the Single
3519 Unix Specification says that such unused arguments are allowed.
3521 @item -Wno-format-zero-length
3522 @opindex Wno-format-zero-length
3523 @opindex Wformat-zero-length
3524 If @option{-Wformat} is specified, do not warn about zero-length formats.
3525 The C standard specifies that zero-length formats are allowed.
3528 @item -Wformat=2
3529 Enable @option{-Wformat} plus additional format checks.  Currently
3530 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3531 -Wformat-y2k}.
3533 @item -Wformat-nonliteral
3534 @opindex Wformat-nonliteral
3535 @opindex Wno-format-nonliteral
3536 If @option{-Wformat} is specified, also warn if the format string is not a
3537 string literal and so cannot be checked, unless the format function
3538 takes its format arguments as a @code{va_list}.
3540 @item -Wformat-security
3541 @opindex Wformat-security
3542 @opindex Wno-format-security
3543 If @option{-Wformat} is specified, also warn about uses of format
3544 functions that represent possible security problems.  At present, this
3545 warns about calls to @code{printf} and @code{scanf} functions where the
3546 format string is not a string literal and there are no format arguments,
3547 as in @code{printf (foo);}.  This may be a security hole if the format
3548 string came from untrusted input and contains @samp{%n}.  (This is
3549 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3550 in future warnings may be added to @option{-Wformat-security} that are not
3551 included in @option{-Wformat-nonliteral}.)
3553 @item -Wformat-y2k
3554 @opindex Wformat-y2k
3555 @opindex Wno-format-y2k
3556 If @option{-Wformat} is specified, also warn about @code{strftime}
3557 formats that may yield only a two-digit year.
3558 @end table
3560 @item -Wnonnull
3561 @opindex Wnonnull
3562 @opindex Wno-nonnull
3563 Warn about passing a null pointer for arguments marked as
3564 requiring a non-null value by the @code{nonnull} function attribute.
3566 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3567 can be disabled with the @option{-Wno-nonnull} option.
3569 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3570 @opindex Winit-self
3571 @opindex Wno-init-self
3572 Warn about uninitialized variables that are initialized with themselves.
3573 Note this option can only be used with the @option{-Wuninitialized} option.
3575 For example, GCC warns about @code{i} being uninitialized in the
3576 following snippet only when @option{-Winit-self} has been specified:
3577 @smallexample
3578 @group
3579 int f()
3581   int i = i;
3582   return i;
3584 @end group
3585 @end smallexample
3587 This warning is enabled by @option{-Wall} in C++.
3589 @item -Wimplicit-int @r{(C and Objective-C only)}
3590 @opindex Wimplicit-int
3591 @opindex Wno-implicit-int
3592 Warn when a declaration does not specify a type.
3593 This warning is enabled by @option{-Wall}.
3595 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3596 @opindex Wimplicit-function-declaration
3597 @opindex Wno-implicit-function-declaration
3598 Give a warning whenever a function is used before being declared. In
3599 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3600 enabled by default and it is made into an error by
3601 @option{-pedantic-errors}. This warning is also enabled by
3602 @option{-Wall}.
3604 @item -Wimplicit @r{(C and Objective-C only)}
3605 @opindex Wimplicit
3606 @opindex Wno-implicit
3607 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3608 This warning is enabled by @option{-Wall}.
3610 @item -Wignored-qualifiers @r{(C and C++ only)}
3611 @opindex Wignored-qualifiers
3612 @opindex Wno-ignored-qualifiers
3613 Warn if the return type of a function has a type qualifier
3614 such as @code{const}.  For ISO C such a type qualifier has no effect,
3615 since the value returned by a function is not an lvalue.
3616 For C++, the warning is only emitted for scalar types or @code{void}.
3617 ISO C prohibits qualified @code{void} return types on function
3618 definitions, so such return types always receive a warning
3619 even without this option.
3621 This warning is also enabled by @option{-Wextra}.
3623 @item -Wmain
3624 @opindex Wmain
3625 @opindex Wno-main
3626 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3627 a function with external linkage, returning int, taking either zero
3628 arguments, two, or three arguments of appropriate types.  This warning
3629 is enabled by default in C++ and is enabled by either @option{-Wall}
3630 or @option{-Wpedantic}.
3632 @item -Wmissing-braces
3633 @opindex Wmissing-braces
3634 @opindex Wno-missing-braces
3635 Warn if an aggregate or union initializer is not fully bracketed.  In
3636 the following example, the initializer for @samp{a} is not fully
3637 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3638 enabled by @option{-Wall} in C.
3640 @smallexample
3641 int a[2][2] = @{ 0, 1, 2, 3 @};
3642 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3643 @end smallexample
3645 This warning is enabled by @option{-Wall}.
3647 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3648 @opindex Wmissing-include-dirs
3649 @opindex Wno-missing-include-dirs
3650 Warn if a user-supplied include directory does not exist.
3652 @item -Wparentheses
3653 @opindex Wparentheses
3654 @opindex Wno-parentheses
3655 Warn if parentheses are omitted in certain contexts, such
3656 as when there is an assignment in a context where a truth value
3657 is expected, or when operators are nested whose precedence people
3658 often get confused about.
3660 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3661 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3662 interpretation from that of ordinary mathematical notation.
3664 Also warn about constructions where there may be confusion to which
3665 @code{if} statement an @code{else} branch belongs.  Here is an example of
3666 such a case:
3668 @smallexample
3669 @group
3671   if (a)
3672     if (b)
3673       foo ();
3674   else
3675     bar ();
3677 @end group
3678 @end smallexample
3680 In C/C++, every @code{else} branch belongs to the innermost possible
3681 @code{if} statement, which in this example is @code{if (b)}.  This is
3682 often not what the programmer expected, as illustrated in the above
3683 example by indentation the programmer chose.  When there is the
3684 potential for this confusion, GCC issues a warning when this flag
3685 is specified.  To eliminate the warning, add explicit braces around
3686 the innermost @code{if} statement so there is no way the @code{else}
3687 can belong to the enclosing @code{if}.  The resulting code
3688 looks like this:
3690 @smallexample
3691 @group
3693   if (a)
3694     @{
3695       if (b)
3696         foo ();
3697       else
3698         bar ();
3699     @}
3701 @end group
3702 @end smallexample
3704 Also warn for dangerous uses of the GNU extension to
3705 @code{?:} with omitted middle operand. When the condition
3706 in the @code{?}: operator is a boolean expression, the omitted value is
3707 always 1.  Often programmers expect it to be a value computed
3708 inside the conditional expression instead.
3710 This warning is enabled by @option{-Wall}.
3712 @item -Wsequence-point
3713 @opindex Wsequence-point
3714 @opindex Wno-sequence-point
3715 Warn about code that may have undefined semantics because of violations
3716 of sequence point rules in the C and C++ standards.
3718 The C and C++ standards define the order in which expressions in a C/C++
3719 program are evaluated in terms of @dfn{sequence points}, which represent
3720 a partial ordering between the execution of parts of the program: those
3721 executed before the sequence point, and those executed after it.  These
3722 occur after the evaluation of a full expression (one which is not part
3723 of a larger expression), after the evaluation of the first operand of a
3724 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3725 function is called (but after the evaluation of its arguments and the
3726 expression denoting the called function), and in certain other places.
3727 Other than as expressed by the sequence point rules, the order of
3728 evaluation of subexpressions of an expression is not specified.  All
3729 these rules describe only a partial order rather than a total order,
3730 since, for example, if two functions are called within one expression
3731 with no sequence point between them, the order in which the functions
3732 are called is not specified.  However, the standards committee have
3733 ruled that function calls do not overlap.
3735 It is not specified when between sequence points modifications to the
3736 values of objects take effect.  Programs whose behavior depends on this
3737 have undefined behavior; the C and C++ standards specify that ``Between
3738 the previous and next sequence point an object shall have its stored
3739 value modified at most once by the evaluation of an expression.
3740 Furthermore, the prior value shall be read only to determine the value
3741 to be stored.''.  If a program breaks these rules, the results on any
3742 particular implementation are entirely unpredictable.
3744 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3745 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3746 diagnosed by this option, and it may give an occasional false positive
3747 result, but in general it has been found fairly effective at detecting
3748 this sort of problem in programs.
3750 The standard is worded confusingly, therefore there is some debate
3751 over the precise meaning of the sequence point rules in subtle cases.
3752 Links to discussions of the problem, including proposed formal
3753 definitions, may be found on the GCC readings page, at
3754 @uref{http://gcc.gnu.org/@/readings.html}.
3756 This warning is enabled by @option{-Wall} for C and C++.
3758 @item -Wno-return-local-addr
3759 @opindex Wno-return-local-addr
3760 @opindex Wreturn-local-addr
3761 Do not warn about returning a pointer (or in C++, a reference) to a
3762 variable that goes out of scope after the function returns.
3764 @item -Wreturn-type
3765 @opindex Wreturn-type
3766 @opindex Wno-return-type
3767 Warn whenever a function is defined with a return type that defaults
3768 to @code{int}.  Also warn about any @code{return} statement with no
3769 return value in a function whose return type is not @code{void}
3770 (falling off the end of the function body is considered returning
3771 without a value), and about a @code{return} statement with an
3772 expression in a function whose return type is @code{void}.
3774 For C++, a function without return type always produces a diagnostic
3775 message, even when @option{-Wno-return-type} is specified.  The only
3776 exceptions are @samp{main} and functions defined in system headers.
3778 This warning is enabled by @option{-Wall}.
3780 @item -Wswitch
3781 @opindex Wswitch
3782 @opindex Wno-switch
3783 Warn whenever a @code{switch} statement has an index of enumerated type
3784 and lacks a @code{case} for one or more of the named codes of that
3785 enumeration.  (The presence of a @code{default} label prevents this
3786 warning.)  @code{case} labels outside the enumeration range also
3787 provoke warnings when this option is used (even if there is a
3788 @code{default} label).
3789 This warning is enabled by @option{-Wall}.
3791 @item -Wswitch-default
3792 @opindex Wswitch-default
3793 @opindex Wno-switch-default
3794 Warn whenever a @code{switch} statement does not have a @code{default}
3795 case.
3797 @item -Wswitch-enum
3798 @opindex Wswitch-enum
3799 @opindex Wno-switch-enum
3800 Warn whenever a @code{switch} statement has an index of enumerated type
3801 and lacks a @code{case} for one or more of the named codes of that
3802 enumeration.  @code{case} labels outside the enumeration range also
3803 provoke warnings when this option is used.  The only difference
3804 between @option{-Wswitch} and this option is that this option gives a
3805 warning about an omitted enumeration code even if there is a
3806 @code{default} label.
3808 @item -Wsync-nand @r{(C and C++ only)}
3809 @opindex Wsync-nand
3810 @opindex Wno-sync-nand
3811 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3812 built-in functions are used.  These functions changed semantics in GCC 4.4.
3814 @item -Wtrigraphs
3815 @opindex Wtrigraphs
3816 @opindex Wno-trigraphs
3817 Warn if any trigraphs are encountered that might change the meaning of
3818 the program (trigraphs within comments are not warned about).
3819 This warning is enabled by @option{-Wall}.
3821 @item -Wunused-but-set-parameter
3822 @opindex Wunused-but-set-parameter
3823 @opindex Wno-unused-but-set-parameter
3824 Warn whenever a function parameter is assigned to, but otherwise unused
3825 (aside from its declaration).
3827 To suppress this warning use the @samp{unused} attribute
3828 (@pxref{Variable Attributes}).
3830 This warning is also enabled by @option{-Wunused} together with
3831 @option{-Wextra}.
3833 @item -Wunused-but-set-variable
3834 @opindex Wunused-but-set-variable
3835 @opindex Wno-unused-but-set-variable
3836 Warn whenever a local variable is assigned to, but otherwise unused
3837 (aside from its declaration).
3838 This warning is enabled by @option{-Wall}.
3840 To suppress this warning use the @samp{unused} attribute
3841 (@pxref{Variable Attributes}).
3843 This warning is also enabled by @option{-Wunused}, which is enabled
3844 by @option{-Wall}.
3846 @item -Wunused-function
3847 @opindex Wunused-function
3848 @opindex Wno-unused-function
3849 Warn whenever a static function is declared but not defined or a
3850 non-inline static function is unused.
3851 This warning is enabled by @option{-Wall}.
3853 @item -Wunused-label
3854 @opindex Wunused-label
3855 @opindex Wno-unused-label
3856 Warn whenever a label is declared but not used.
3857 This warning is enabled by @option{-Wall}.
3859 To suppress this warning use the @samp{unused} attribute
3860 (@pxref{Variable Attributes}).
3862 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3863 @opindex Wunused-local-typedefs
3864 Warn when a typedef locally defined in a function is not used.
3865 This warning is enabled by @option{-Wall}.
3867 @item -Wunused-parameter
3868 @opindex Wunused-parameter
3869 @opindex Wno-unused-parameter
3870 Warn whenever a function parameter is unused aside from its declaration.
3872 To suppress this warning use the @samp{unused} attribute
3873 (@pxref{Variable Attributes}).
3875 @item -Wno-unused-result
3876 @opindex Wunused-result
3877 @opindex Wno-unused-result
3878 Do not warn if a caller of a function marked with attribute
3879 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3880 its return value. The default is @option{-Wunused-result}.
3882 @item -Wunused-variable
3883 @opindex Wunused-variable
3884 @opindex Wno-unused-variable
3885 Warn whenever a local variable or non-constant static variable is unused
3886 aside from its declaration.
3887 This warning is enabled by @option{-Wall}.
3889 To suppress this warning use the @samp{unused} attribute
3890 (@pxref{Variable Attributes}).
3892 @item -Wunused-value
3893 @opindex Wunused-value
3894 @opindex Wno-unused-value
3895 Warn whenever a statement computes a result that is explicitly not
3896 used. To suppress this warning cast the unused expression to
3897 @samp{void}. This includes an expression-statement or the left-hand
3898 side of a comma expression that contains no side effects. For example,
3899 an expression such as @samp{x[i,j]} causes a warning, while
3900 @samp{x[(void)i,j]} does not.
3902 This warning is enabled by @option{-Wall}.
3904 @item -Wunused
3905 @opindex Wunused
3906 @opindex Wno-unused
3907 All the above @option{-Wunused} options combined.
3909 In order to get a warning about an unused function parameter, you must
3910 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3911 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3913 @item -Wuninitialized
3914 @opindex Wuninitialized
3915 @opindex Wno-uninitialized
3916 Warn if an automatic variable is used without first being initialized
3917 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3918 warn if a non-static reference or non-static @samp{const} member
3919 appears in a class without constructors.
3921 If you want to warn about code that uses the uninitialized value of the
3922 variable in its own initializer, use the @option{-Winit-self} option.
3924 These warnings occur for individual uninitialized or clobbered
3925 elements of structure, union or array variables as well as for
3926 variables that are uninitialized or clobbered as a whole.  They do
3927 not occur for variables or elements declared @code{volatile}.  Because
3928 these warnings depend on optimization, the exact variables or elements
3929 for which there are warnings depends on the precise optimization
3930 options and version of GCC used.
3932 Note that there may be no warning about a variable that is used only
3933 to compute a value that itself is never used, because such
3934 computations may be deleted by data flow analysis before the warnings
3935 are printed.
3937 @item -Wmaybe-uninitialized
3938 @opindex Wmaybe-uninitialized
3939 @opindex Wno-maybe-uninitialized
3940 For an automatic variable, if there exists a path from the function
3941 entry to a use of the variable that is initialized, but there exist
3942 some other paths for which the variable is not initialized, the compiler
3943 emits a warning if it cannot prove the uninitialized paths are not
3944 executed at run time. These warnings are made optional because GCC is
3945 not smart enough to see all the reasons why the code might be correct
3946 in spite of appearing to have an error.  Here is one example of how
3947 this can happen:
3949 @smallexample
3950 @group
3952   int x;
3953   switch (y)
3954     @{
3955     case 1: x = 1;
3956       break;
3957     case 2: x = 4;
3958       break;
3959     case 3: x = 5;
3960     @}
3961   foo (x);
3963 @end group
3964 @end smallexample
3966 @noindent
3967 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3968 always initialized, but GCC doesn't know this. To suppress the
3969 warning, you need to provide a default case with assert(0) or
3970 similar code.
3972 @cindex @code{longjmp} warnings
3973 This option also warns when a non-volatile automatic variable might be
3974 changed by a call to @code{longjmp}.  These warnings as well are possible
3975 only in optimizing compilation.
3977 The compiler sees only the calls to @code{setjmp}.  It cannot know
3978 where @code{longjmp} will be called; in fact, a signal handler could
3979 call it at any point in the code.  As a result, you may get a warning
3980 even when there is in fact no problem because @code{longjmp} cannot
3981 in fact be called at the place that would cause a problem.
3983 Some spurious warnings can be avoided if you declare all the functions
3984 you use that never return as @code{noreturn}.  @xref{Function
3985 Attributes}.
3987 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3989 @item -Wunknown-pragmas
3990 @opindex Wunknown-pragmas
3991 @opindex Wno-unknown-pragmas
3992 @cindex warning for unknown pragmas
3993 @cindex unknown pragmas, warning
3994 @cindex pragmas, warning of unknown
3995 Warn when a @code{#pragma} directive is encountered that is not understood by 
3996 GCC@.  If this command-line option is used, warnings are even issued
3997 for unknown pragmas in system header files.  This is not the case if
3998 the warnings are only enabled by the @option{-Wall} command-line option.
4000 @item -Wno-pragmas
4001 @opindex Wno-pragmas
4002 @opindex Wpragmas
4003 Do not warn about misuses of pragmas, such as incorrect parameters,
4004 invalid syntax, or conflicts between pragmas.  See also
4005 @option{-Wunknown-pragmas}.
4007 @item -Wstrict-aliasing
4008 @opindex Wstrict-aliasing
4009 @opindex Wno-strict-aliasing
4010 This option is only active when @option{-fstrict-aliasing} is active.
4011 It warns about code that might break the strict aliasing rules that the
4012 compiler is using for optimization.  The warning does not catch all
4013 cases, but does attempt to catch the more common pitfalls.  It is
4014 included in @option{-Wall}.
4015 It is equivalent to @option{-Wstrict-aliasing=3}
4017 @item -Wstrict-aliasing=n
4018 @opindex Wstrict-aliasing=n
4019 This option is only active when @option{-fstrict-aliasing} is active.
4020 It warns about code that might break the strict aliasing rules that the
4021 compiler is using for optimization.
4022 Higher levels correspond to higher accuracy (fewer false positives).
4023 Higher levels also correspond to more effort, similar to the way @option{-O} 
4024 works.
4025 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4027 Level 1: Most aggressive, quick, least accurate.
4028 Possibly useful when higher levels
4029 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4030 false negatives.  However, it has many false positives.
4031 Warns for all pointer conversions between possibly incompatible types,
4032 even if never dereferenced.  Runs in the front end only.
4034 Level 2: Aggressive, quick, not too precise.
4035 May still have many false positives (not as many as level 1 though),
4036 and few false negatives (but possibly more than level 1).
4037 Unlike level 1, it only warns when an address is taken.  Warns about
4038 incomplete types.  Runs in the front end only.
4040 Level 3 (default for @option{-Wstrict-aliasing}):
4041 Should have very few false positives and few false
4042 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4043 Takes care of the common pun+dereference pattern in the front end:
4044 @code{*(int*)&some_float}.
4045 If optimization is enabled, it also runs in the back end, where it deals
4046 with multiple statement cases using flow-sensitive points-to information.
4047 Only warns when the converted pointer is dereferenced.
4048 Does not warn about incomplete types.
4050 @item -Wstrict-overflow
4051 @itemx -Wstrict-overflow=@var{n}
4052 @opindex Wstrict-overflow
4053 @opindex Wno-strict-overflow
4054 This option is only active when @option{-fstrict-overflow} is active.
4055 It warns about cases where the compiler optimizes based on the
4056 assumption that signed overflow does not occur.  Note that it does not
4057 warn about all cases where the code might overflow: it only warns
4058 about cases where the compiler implements some optimization.  Thus
4059 this warning depends on the optimization level.
4061 An optimization that assumes that signed overflow does not occur is
4062 perfectly safe if the values of the variables involved are such that
4063 overflow never does, in fact, occur.  Therefore this warning can
4064 easily give a false positive: a warning about code that is not
4065 actually a problem.  To help focus on important issues, several
4066 warning levels are defined.  No warnings are issued for the use of
4067 undefined signed overflow when estimating how many iterations a loop
4068 requires, in particular when determining whether a loop will be
4069 executed at all.
4071 @table @gcctabopt
4072 @item -Wstrict-overflow=1
4073 Warn about cases that are both questionable and easy to avoid.  For
4074 example,  with @option{-fstrict-overflow}, the compiler simplifies
4075 @code{x + 1 > x} to @code{1}.  This level of
4076 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4077 are not, and must be explicitly requested.
4079 @item -Wstrict-overflow=2
4080 Also warn about other cases where a comparison is simplified to a
4081 constant.  For example: @code{abs (x) >= 0}.  This can only be
4082 simplified when @option{-fstrict-overflow} is in effect, because
4083 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4084 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4085 @option{-Wstrict-overflow=2}.
4087 @item -Wstrict-overflow=3
4088 Also warn about other cases where a comparison is simplified.  For
4089 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4091 @item -Wstrict-overflow=4
4092 Also warn about other simplifications not covered by the above cases.
4093 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4095 @item -Wstrict-overflow=5
4096 Also warn about cases where the compiler reduces the magnitude of a
4097 constant involved in a comparison.  For example: @code{x + 2 > y} is
4098 simplified to @code{x + 1 >= y}.  This is reported only at the
4099 highest warning level because this simplification applies to many
4100 comparisons, so this warning level gives a very large number of
4101 false positives.
4102 @end table
4104 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4105 @opindex Wsuggest-attribute=
4106 @opindex Wno-suggest-attribute=
4107 Warn for cases where adding an attribute may be beneficial. The
4108 attributes currently supported are listed below.
4110 @table @gcctabopt
4111 @item -Wsuggest-attribute=pure
4112 @itemx -Wsuggest-attribute=const
4113 @itemx -Wsuggest-attribute=noreturn
4114 @opindex Wsuggest-attribute=pure
4115 @opindex Wno-suggest-attribute=pure
4116 @opindex Wsuggest-attribute=const
4117 @opindex Wno-suggest-attribute=const
4118 @opindex Wsuggest-attribute=noreturn
4119 @opindex Wno-suggest-attribute=noreturn
4121 Warn about functions that might be candidates for attributes
4122 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4123 functions visible in other compilation units or (in the case of @code{pure} and
4124 @code{const}) if it cannot prove that the function returns normally. A function
4125 returns normally if it doesn't contain an infinite loop or return abnormally
4126 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4127 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4128 higher.  Higher optimization levels improve the accuracy of the analysis.
4130 @item -Wsuggest-attribute=format
4131 @itemx -Wmissing-format-attribute
4132 @opindex Wsuggest-attribute=format
4133 @opindex Wmissing-format-attribute
4134 @opindex Wno-suggest-attribute=format
4135 @opindex Wno-missing-format-attribute
4136 @opindex Wformat
4137 @opindex Wno-format
4139 Warn about function pointers that might be candidates for @code{format}
4140 attributes.  Note these are only possible candidates, not absolute ones.
4141 GCC guesses that function pointers with @code{format} attributes that
4142 are used in assignment, initialization, parameter passing or return
4143 statements should have a corresponding @code{format} attribute in the
4144 resulting type.  I.e.@: the left-hand side of the assignment or
4145 initialization, the type of the parameter variable, or the return type
4146 of the containing function respectively should also have a @code{format}
4147 attribute to avoid the warning.
4149 GCC also warns about function definitions that might be
4150 candidates for @code{format} attributes.  Again, these are only
4151 possible candidates.  GCC guesses that @code{format} attributes
4152 might be appropriate for any function that calls a function like
4153 @code{vprintf} or @code{vscanf}, but this might not always be the
4154 case, and some functions for which @code{format} attributes are
4155 appropriate may not be detected.
4156 @end table
4158 @item -Warray-bounds
4159 @opindex Wno-array-bounds
4160 @opindex Warray-bounds
4161 This option is only active when @option{-ftree-vrp} is active
4162 (default for @option{-O2} and above). It warns about subscripts to arrays
4163 that are always out of bounds. This warning is enabled by @option{-Wall}.
4165 @item -Wno-div-by-zero
4166 @opindex Wno-div-by-zero
4167 @opindex Wdiv-by-zero
4168 Do not warn about compile-time integer division by zero.  Floating-point
4169 division by zero is not warned about, as it can be a legitimate way of
4170 obtaining infinities and NaNs.
4172 @item -Wsystem-headers
4173 @opindex Wsystem-headers
4174 @opindex Wno-system-headers
4175 @cindex warnings from system headers
4176 @cindex system headers, warnings from
4177 Print warning messages for constructs found in system header files.
4178 Warnings from system headers are normally suppressed, on the assumption
4179 that they usually do not indicate real problems and would only make the
4180 compiler output harder to read.  Using this command-line option tells
4181 GCC to emit warnings from system headers as if they occurred in user
4182 code.  However, note that using @option{-Wall} in conjunction with this
4183 option does @emph{not} warn about unknown pragmas in system
4184 headers---for that, @option{-Wunknown-pragmas} must also be used.
4186 @item -Wtrampolines
4187 @opindex Wtrampolines
4188 @opindex Wno-trampolines
4189  Warn about trampolines generated for pointers to nested functions.
4191  A trampoline is a small piece of data or code that is created at run
4192  time on the stack when the address of a nested function is taken, and
4193  is used to call the nested function indirectly.  For some targets, it
4194  is made up of data only and thus requires no special treatment.  But,
4195  for most targets, it is made up of code and thus requires the stack
4196  to be made executable in order for the program to work properly.
4198 @item -Wfloat-equal
4199 @opindex Wfloat-equal
4200 @opindex Wno-float-equal
4201 Warn if floating-point values are used in equality comparisons.
4203 The idea behind this is that sometimes it is convenient (for the
4204 programmer) to consider floating-point values as approximations to
4205 infinitely precise real numbers.  If you are doing this, then you need
4206 to compute (by analyzing the code, or in some other way) the maximum or
4207 likely maximum error that the computation introduces, and allow for it
4208 when performing comparisons (and when producing output, but that's a
4209 different problem).  In particular, instead of testing for equality, you
4210 should check to see whether the two values have ranges that overlap; and
4211 this is done with the relational operators, so equality comparisons are
4212 probably mistaken.
4214 @item -Wtraditional @r{(C and Objective-C only)}
4215 @opindex Wtraditional
4216 @opindex Wno-traditional
4217 Warn about certain constructs that behave differently in traditional and
4218 ISO C@.  Also warn about ISO C constructs that have no traditional C
4219 equivalent, and/or problematic constructs that should be avoided.
4221 @itemize @bullet
4222 @item
4223 Macro parameters that appear within string literals in the macro body.
4224 In traditional C macro replacement takes place within string literals,
4225 but in ISO C it does not.
4227 @item
4228 In traditional C, some preprocessor directives did not exist.
4229 Traditional preprocessors only considered a line to be a directive
4230 if the @samp{#} appeared in column 1 on the line.  Therefore
4231 @option{-Wtraditional} warns about directives that traditional C
4232 understands but ignores because the @samp{#} does not appear as the
4233 first character on the line.  It also suggests you hide directives like
4234 @samp{#pragma} not understood by traditional C by indenting them.  Some
4235 traditional implementations do not recognize @samp{#elif}, so this option
4236 suggests avoiding it altogether.
4238 @item
4239 A function-like macro that appears without arguments.
4241 @item
4242 The unary plus operator.
4244 @item
4245 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4246 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4247 constants.)  Note, these suffixes appear in macros defined in the system
4248 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4249 Use of these macros in user code might normally lead to spurious
4250 warnings, however GCC's integrated preprocessor has enough context to
4251 avoid warning in these cases.
4253 @item
4254 A function declared external in one block and then used after the end of
4255 the block.
4257 @item
4258 A @code{switch} statement has an operand of type @code{long}.
4260 @item
4261 A non-@code{static} function declaration follows a @code{static} one.
4262 This construct is not accepted by some traditional C compilers.
4264 @item
4265 The ISO type of an integer constant has a different width or
4266 signedness from its traditional type.  This warning is only issued if
4267 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4268 typically represent bit patterns, are not warned about.
4270 @item
4271 Usage of ISO string concatenation is detected.
4273 @item
4274 Initialization of automatic aggregates.
4276 @item
4277 Identifier conflicts with labels.  Traditional C lacks a separate
4278 namespace for labels.
4280 @item
4281 Initialization of unions.  If the initializer is zero, the warning is
4282 omitted.  This is done under the assumption that the zero initializer in
4283 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4284 initializer warnings and relies on default initialization to zero in the
4285 traditional C case.
4287 @item
4288 Conversions by prototypes between fixed/floating-point values and vice
4289 versa.  The absence of these prototypes when compiling with traditional
4290 C causes serious problems.  This is a subset of the possible
4291 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4293 @item
4294 Use of ISO C style function definitions.  This warning intentionally is
4295 @emph{not} issued for prototype declarations or variadic functions
4296 because these ISO C features appear in your code when using
4297 libiberty's traditional C compatibility macros, @code{PARAMS} and
4298 @code{VPARAMS}.  This warning is also bypassed for nested functions
4299 because that feature is already a GCC extension and thus not relevant to
4300 traditional C compatibility.
4301 @end itemize
4303 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4304 @opindex Wtraditional-conversion
4305 @opindex Wno-traditional-conversion
4306 Warn if a prototype causes a type conversion that is different from what
4307 would happen to the same argument in the absence of a prototype.  This
4308 includes conversions of fixed point to floating and vice versa, and
4309 conversions changing the width or signedness of a fixed-point argument
4310 except when the same as the default promotion.
4312 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4313 @opindex Wdeclaration-after-statement
4314 @opindex Wno-declaration-after-statement
4315 Warn when a declaration is found after a statement in a block.  This
4316 construct, known from C++, was introduced with ISO C99 and is by default
4317 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4318 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4320 @item -Wundef
4321 @opindex Wundef
4322 @opindex Wno-undef
4323 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4325 @item -Wno-endif-labels
4326 @opindex Wno-endif-labels
4327 @opindex Wendif-labels
4328 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4330 @item -Wshadow
4331 @opindex Wshadow
4332 @opindex Wno-shadow
4333 Warn whenever a local variable or type declaration shadows another variable,
4334 parameter, type, or class member (in C++), or whenever a built-in function
4335 is shadowed. Note that in C++, the compiler warns if a local variable
4336 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4338 @item -Wlarger-than=@var{len}
4339 @opindex Wlarger-than=@var{len}
4340 @opindex Wlarger-than-@var{len}
4341 Warn whenever an object of larger than @var{len} bytes is defined.
4343 @item -Wframe-larger-than=@var{len}
4344 @opindex Wframe-larger-than
4345 Warn if the size of a function frame is larger than @var{len} bytes.
4346 The computation done to determine the stack frame size is approximate
4347 and not conservative.
4348 The actual requirements may be somewhat greater than @var{len}
4349 even if you do not get a warning.  In addition, any space allocated
4350 via @code{alloca}, variable-length arrays, or related constructs
4351 is not included by the compiler when determining
4352 whether or not to issue a warning.
4354 @item -Wno-free-nonheap-object
4355 @opindex Wno-free-nonheap-object
4356 @opindex Wfree-nonheap-object
4357 Do not warn when attempting to free an object that was not allocated
4358 on the heap.
4360 @item -Wstack-usage=@var{len}
4361 @opindex Wstack-usage
4362 Warn if the stack usage of a function might be larger than @var{len} bytes.
4363 The computation done to determine the stack usage is conservative.
4364 Any space allocated via @code{alloca}, variable-length arrays, or related
4365 constructs is included by the compiler when determining whether or not to
4366 issue a warning.
4368 The message is in keeping with the output of @option{-fstack-usage}.
4370 @itemize
4371 @item
4372 If the stack usage is fully static but exceeds the specified amount, it's:
4374 @smallexample
4375   warning: stack usage is 1120 bytes
4376 @end smallexample
4377 @item
4378 If the stack usage is (partly) dynamic but bounded, it's:
4380 @smallexample
4381   warning: stack usage might be 1648 bytes
4382 @end smallexample
4383 @item
4384 If the stack usage is (partly) dynamic and not bounded, it's:
4386 @smallexample
4387   warning: stack usage might be unbounded
4388 @end smallexample
4389 @end itemize
4391 @item -Wunsafe-loop-optimizations
4392 @opindex Wunsafe-loop-optimizations
4393 @opindex Wno-unsafe-loop-optimizations
4394 Warn if the loop cannot be optimized because the compiler cannot
4395 assume anything on the bounds of the loop indices.  With
4396 @option{-funsafe-loop-optimizations} warn if the compiler makes
4397 such assumptions.
4399 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4400 @opindex Wno-pedantic-ms-format
4401 @opindex Wpedantic-ms-format
4402 When used in combination with @option{-Wformat}
4403 and @option{-pedantic} without GNU extensions, this option
4404 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4405 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4406 which depend on the MS runtime.
4408 @item -Wpointer-arith
4409 @opindex Wpointer-arith
4410 @opindex Wno-pointer-arith
4411 Warn about anything that depends on the ``size of'' a function type or
4412 of @code{void}.  GNU C assigns these types a size of 1, for
4413 convenience in calculations with @code{void *} pointers and pointers
4414 to functions.  In C++, warn also when an arithmetic operation involves
4415 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4417 @item -Wtype-limits
4418 @opindex Wtype-limits
4419 @opindex Wno-type-limits
4420 Warn if a comparison is always true or always false due to the limited
4421 range of the data type, but do not warn for constant expressions.  For
4422 example, warn if an unsigned variable is compared against zero with
4423 @samp{<} or @samp{>=}.  This warning is also enabled by
4424 @option{-Wextra}.
4426 @item -Wbad-function-cast @r{(C and Objective-C only)}
4427 @opindex Wbad-function-cast
4428 @opindex Wno-bad-function-cast
4429 Warn whenever a function call is cast to a non-matching type.
4430 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4432 @item -Wc++-compat @r{(C and Objective-C only)}
4433 Warn about ISO C constructs that are outside of the common subset of
4434 ISO C and ISO C++, e.g.@: request for implicit conversion from
4435 @code{void *} to a pointer to non-@code{void} type.
4437 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4438 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4439 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4440 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4441 enabled by @option{-Wall}.
4443 @item -Wcast-qual
4444 @opindex Wcast-qual
4445 @opindex Wno-cast-qual
4446 Warn whenever a pointer is cast so as to remove a type qualifier from
4447 the target type.  For example, warn if a @code{const char *} is cast
4448 to an ordinary @code{char *}.
4450 Also warn when making a cast that introduces a type qualifier in an
4451 unsafe way.  For example, casting @code{char **} to @code{const char **}
4452 is unsafe, as in this example:
4454 @smallexample
4455   /* p is char ** value.  */
4456   const char **q = (const char **) p;
4457   /* Assignment of readonly string to const char * is OK.  */
4458   *q = "string";
4459   /* Now char** pointer points to read-only memory.  */
4460   **p = 'b';
4461 @end smallexample
4463 @item -Wcast-align
4464 @opindex Wcast-align
4465 @opindex Wno-cast-align
4466 Warn whenever a pointer is cast such that the required alignment of the
4467 target is increased.  For example, warn if a @code{char *} is cast to
4468 an @code{int *} on machines where integers can only be accessed at
4469 two- or four-byte boundaries.
4471 @item -Wwrite-strings
4472 @opindex Wwrite-strings
4473 @opindex Wno-write-strings
4474 When compiling C, give string constants the type @code{const
4475 char[@var{length}]} so that copying the address of one into a
4476 non-@code{const} @code{char *} pointer produces a warning.  These
4477 warnings help you find at compile time code that can try to write
4478 into a string constant, but only if you have been very careful about
4479 using @code{const} in declarations and prototypes.  Otherwise, it is
4480 just a nuisance. This is why we did not make @option{-Wall} request
4481 these warnings.
4483 When compiling C++, warn about the deprecated conversion from string
4484 literals to @code{char *}.  This warning is enabled by default for C++
4485 programs.
4487 @item -Wclobbered
4488 @opindex Wclobbered
4489 @opindex Wno-clobbered
4490 Warn for variables that might be changed by @samp{longjmp} or
4491 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4493 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4494 @opindex Wconditionally-supported
4495 @opindex Wno-conditionally-supported
4496 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4498 @item -Wconversion
4499 @opindex Wconversion
4500 @opindex Wno-conversion
4501 Warn for implicit conversions that may alter a value. This includes
4502 conversions between real and integer, like @code{abs (x)} when
4503 @code{x} is @code{double}; conversions between signed and unsigned,
4504 like @code{unsigned ui = -1}; and conversions to smaller types, like
4505 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4506 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4507 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4508 conversions between signed and unsigned integers can be disabled by
4509 using @option{-Wno-sign-conversion}.
4511 For C++, also warn for confusing overload resolution for user-defined
4512 conversions; and conversions that never use a type conversion
4513 operator: conversions to @code{void}, the same type, a base class or a
4514 reference to them. Warnings about conversions between signed and
4515 unsigned integers are disabled by default in C++ unless
4516 @option{-Wsign-conversion} is explicitly enabled.
4518 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4519 @opindex Wconversion-null
4520 @opindex Wno-conversion-null
4521 Do not warn for conversions between @code{NULL} and non-pointer
4522 types. @option{-Wconversion-null} is enabled by default.
4524 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4525 @opindex Wzero-as-null-pointer-constant
4526 @opindex Wno-zero-as-null-pointer-constant
4527 Warn when a literal '0' is used as null pointer constant.  This can
4528 be useful to facilitate the conversion to @code{nullptr} in C++11.
4530 @item -Wdate-time
4531 @opindex Wdate-time
4532 @opindex Wno-date-time
4533 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4534 are encountered as they might prevent bit-wise-identical reproducible
4535 compilations.
4537 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4538 @opindex Wdelete-incomplete
4539 @opindex Wno-delete-incomplete
4540 Warn when deleting a pointer to incomplete type, which may cause
4541 undefined behavior at runtime.  This warning is enabled by default.
4543 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4544 @opindex Wuseless-cast
4545 @opindex Wno-useless-cast
4546 Warn when an expression is casted to its own type.
4548 @item -Wempty-body
4549 @opindex Wempty-body
4550 @opindex Wno-empty-body
4551 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4552 while} statement.  This warning is also enabled by @option{-Wextra}.
4554 @item -Wenum-compare
4555 @opindex Wenum-compare
4556 @opindex Wno-enum-compare
4557 Warn about a comparison between values of different enumerated types.
4558 In C++ enumeral mismatches in conditional expressions are also
4559 diagnosed and the warning is enabled by default.  In C this warning is 
4560 enabled by @option{-Wall}.
4562 @item -Wjump-misses-init @r{(C, Objective-C only)}
4563 @opindex Wjump-misses-init
4564 @opindex Wno-jump-misses-init
4565 Warn if a @code{goto} statement or a @code{switch} statement jumps
4566 forward across the initialization of a variable, or jumps backward to a
4567 label after the variable has been initialized.  This only warns about
4568 variables that are initialized when they are declared.  This warning is
4569 only supported for C and Objective-C; in C++ this sort of branch is an
4570 error in any case.
4572 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4573 can be disabled with the @option{-Wno-jump-misses-init} option.
4575 @item -Wsign-compare
4576 @opindex Wsign-compare
4577 @opindex Wno-sign-compare
4578 @cindex warning for comparison of signed and unsigned values
4579 @cindex comparison of signed and unsigned values, warning
4580 @cindex signed and unsigned values, comparison warning
4581 Warn when a comparison between signed and unsigned values could produce
4582 an incorrect result when the signed value is converted to unsigned.
4583 This warning is also enabled by @option{-Wextra}; to get the other warnings
4584 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4586 @item -Wsign-conversion
4587 @opindex Wsign-conversion
4588 @opindex Wno-sign-conversion
4589 Warn for implicit conversions that may change the sign of an integer
4590 value, like assigning a signed integer expression to an unsigned
4591 integer variable. An explicit cast silences the warning. In C, this
4592 option is enabled also by @option{-Wconversion}.
4594 @item -Wsizeof-pointer-memaccess
4595 @opindex Wsizeof-pointer-memaccess
4596 @opindex Wno-sizeof-pointer-memaccess
4597 Warn for suspicious length parameters to certain string and memory built-in
4598 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4599 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4600 but a pointer, and suggests a possible fix, or about
4601 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4602 @option{-Wall}.
4604 @item -Waddress
4605 @opindex Waddress
4606 @opindex Wno-address
4607 Warn about suspicious uses of memory addresses. These include using
4608 the address of a function in a conditional expression, such as
4609 @code{void func(void); if (func)}, and comparisons against the memory
4610 address of a string literal, such as @code{if (x == "abc")}.  Such
4611 uses typically indicate a programmer error: the address of a function
4612 always evaluates to true, so their use in a conditional usually
4613 indicate that the programmer forgot the parentheses in a function
4614 call; and comparisons against string literals result in unspecified
4615 behavior and are not portable in C, so they usually indicate that the
4616 programmer intended to use @code{strcmp}.  This warning is enabled by
4617 @option{-Wall}.
4619 @item -Wlogical-op
4620 @opindex Wlogical-op
4621 @opindex Wno-logical-op
4622 Warn about suspicious uses of logical operators in expressions.
4623 This includes using logical operators in contexts where a
4624 bit-wise operator is likely to be expected.
4626 @item -Waggregate-return
4627 @opindex Waggregate-return
4628 @opindex Wno-aggregate-return
4629 Warn if any functions that return structures or unions are defined or
4630 called.  (In languages where you can return an array, this also elicits
4631 a warning.)
4633 @item -Wno-aggressive-loop-optimizations
4634 @opindex Wno-aggressive-loop-optimizations
4635 @opindex Waggressive-loop-optimizations
4636 Warn if in a loop with constant number of iterations the compiler detects
4637 undefined behavior in some statement during one or more of the iterations.
4639 @item -Wno-attributes
4640 @opindex Wno-attributes
4641 @opindex Wattributes
4642 Do not warn if an unexpected @code{__attribute__} is used, such as
4643 unrecognized attributes, function attributes applied to variables,
4644 etc.  This does not stop errors for incorrect use of supported
4645 attributes.
4647 @item -Wno-builtin-macro-redefined
4648 @opindex Wno-builtin-macro-redefined
4649 @opindex Wbuiltin-macro-redefined
4650 Do not warn if certain built-in macros are redefined.  This suppresses
4651 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4652 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4654 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4655 @opindex Wstrict-prototypes
4656 @opindex Wno-strict-prototypes
4657 Warn if a function is declared or defined without specifying the
4658 argument types.  (An old-style function definition is permitted without
4659 a warning if preceded by a declaration that specifies the argument
4660 types.)
4662 @item -Wold-style-declaration @r{(C and Objective-C only)}
4663 @opindex Wold-style-declaration
4664 @opindex Wno-old-style-declaration
4665 Warn for obsolescent usages, according to the C Standard, in a
4666 declaration. For example, warn if storage-class specifiers like
4667 @code{static} are not the first things in a declaration.  This warning
4668 is also enabled by @option{-Wextra}.
4670 @item -Wold-style-definition @r{(C and Objective-C only)}
4671 @opindex Wold-style-definition
4672 @opindex Wno-old-style-definition
4673 Warn if an old-style function definition is used.  A warning is given
4674 even if there is a previous prototype.
4676 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4677 @opindex Wmissing-parameter-type
4678 @opindex Wno-missing-parameter-type
4679 A function parameter is declared without a type specifier in K&R-style
4680 functions:
4682 @smallexample
4683 void foo(bar) @{ @}
4684 @end smallexample
4686 This warning is also enabled by @option{-Wextra}.
4688 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4689 @opindex Wmissing-prototypes
4690 @opindex Wno-missing-prototypes
4691 Warn if a global function is defined without a previous prototype
4692 declaration.  This warning is issued even if the definition itself
4693 provides a prototype.  Use this option to detect global functions
4694 that do not have a matching prototype declaration in a header file.
4695 This option is not valid for C++ because all function declarations
4696 provide prototypes and a non-matching declaration will declare an
4697 overload rather than conflict with an earlier declaration.
4698 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4700 @item -Wmissing-declarations
4701 @opindex Wmissing-declarations
4702 @opindex Wno-missing-declarations
4703 Warn if a global function is defined without a previous declaration.
4704 Do so even if the definition itself provides a prototype.
4705 Use this option to detect global functions that are not declared in
4706 header files.  In C, no warnings are issued for functions with previous
4707 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4708 missing prototypes.  In C++, no warnings are issued for function templates,
4709 or for inline functions, or for functions in anonymous namespaces.
4711 @item -Wmissing-field-initializers
4712 @opindex Wmissing-field-initializers
4713 @opindex Wno-missing-field-initializers
4714 @opindex W
4715 @opindex Wextra
4716 @opindex Wno-extra
4717 Warn if a structure's initializer has some fields missing.  For
4718 example, the following code causes such a warning, because
4719 @code{x.h} is implicitly zero:
4721 @smallexample
4722 struct s @{ int f, g, h; @};
4723 struct s x = @{ 3, 4 @};
4724 @end smallexample
4726 This option does not warn about designated initializers, so the following
4727 modification does not trigger a warning:
4729 @smallexample
4730 struct s @{ int f, g, h; @};
4731 struct s x = @{ .f = 3, .g = 4 @};
4732 @end smallexample
4734 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4735 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4737 @item -Wno-multichar
4738 @opindex Wno-multichar
4739 @opindex Wmultichar
4740 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4741 Usually they indicate a typo in the user's code, as they have
4742 implementation-defined values, and should not be used in portable code.
4744 @item -Wnormalized=<none|id|nfc|nfkc>
4745 @opindex Wnormalized=
4746 @cindex NFC
4747 @cindex NFKC
4748 @cindex character set, input normalization
4749 In ISO C and ISO C++, two identifiers are different if they are
4750 different sequences of characters.  However, sometimes when characters
4751 outside the basic ASCII character set are used, you can have two
4752 different character sequences that look the same.  To avoid confusion,
4753 the ISO 10646 standard sets out some @dfn{normalization rules} which
4754 when applied ensure that two sequences that look the same are turned into
4755 the same sequence.  GCC can warn you if you are using identifiers that
4756 have not been normalized; this option controls that warning.
4758 There are four levels of warning supported by GCC@.  The default is
4759 @option{-Wnormalized=nfc}, which warns about any identifier that is
4760 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4761 recommended form for most uses.
4763 Unfortunately, there are some characters allowed in identifiers by
4764 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4765 identifiers.  That is, there's no way to use these symbols in portable
4766 ISO C or C++ and have all your identifiers in NFC@.
4767 @option{-Wnormalized=id} suppresses the warning for these characters.
4768 It is hoped that future versions of the standards involved will correct
4769 this, which is why this option is not the default.
4771 You can switch the warning off for all characters by writing
4772 @option{-Wnormalized=none}.  You should only do this if you
4773 are using some other normalization scheme (like ``D''), because
4774 otherwise you can easily create bugs that are literally impossible to see.
4776 Some characters in ISO 10646 have distinct meanings but look identical
4777 in some fonts or display methodologies, especially once formatting has
4778 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4779 LETTER N'', displays just like a regular @code{n} that has been
4780 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4781 normalization scheme to convert all these into a standard form as
4782 well, and GCC warns if your code is not in NFKC if you use
4783 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4784 about every identifier that contains the letter O because it might be
4785 confused with the digit 0, and so is not the default, but may be
4786 useful as a local coding convention if the programming environment 
4787 cannot be fixed to display these characters distinctly.
4789 @item -Wno-deprecated
4790 @opindex Wno-deprecated
4791 @opindex Wdeprecated
4792 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4794 @item -Wno-deprecated-declarations
4795 @opindex Wno-deprecated-declarations
4796 @opindex Wdeprecated-declarations
4797 Do not warn about uses of functions (@pxref{Function Attributes}),
4798 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4799 Attributes}) marked as deprecated by using the @code{deprecated}
4800 attribute.
4802 @item -Wno-overflow
4803 @opindex Wno-overflow
4804 @opindex Woverflow
4805 Do not warn about compile-time overflow in constant expressions.
4807 @item -Woverride-init @r{(C and Objective-C only)}
4808 @opindex Woverride-init
4809 @opindex Wno-override-init
4810 @opindex W
4811 @opindex Wextra
4812 @opindex Wno-extra
4813 Warn if an initialized field without side effects is overridden when
4814 using designated initializers (@pxref{Designated Inits, , Designated
4815 Initializers}).
4817 This warning is included in @option{-Wextra}.  To get other
4818 @option{-Wextra} warnings without this one, use @option{-Wextra
4819 -Wno-override-init}.
4821 @item -Wpacked
4822 @opindex Wpacked
4823 @opindex Wno-packed
4824 Warn if a structure is given the packed attribute, but the packed
4825 attribute has no effect on the layout or size of the structure.
4826 Such structures may be mis-aligned for little benefit.  For
4827 instance, in this code, the variable @code{f.x} in @code{struct bar}
4828 is misaligned even though @code{struct bar} does not itself
4829 have the packed attribute:
4831 @smallexample
4832 @group
4833 struct foo @{
4834   int x;
4835   char a, b, c, d;
4836 @} __attribute__((packed));
4837 struct bar @{
4838   char z;
4839   struct foo f;
4841 @end group
4842 @end smallexample
4844 @item -Wpacked-bitfield-compat
4845 @opindex Wpacked-bitfield-compat
4846 @opindex Wno-packed-bitfield-compat
4847 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4848 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4849 the change can lead to differences in the structure layout.  GCC
4850 informs you when the offset of such a field has changed in GCC 4.4.
4851 For example there is no longer a 4-bit padding between field @code{a}
4852 and @code{b} in this structure:
4854 @smallexample
4855 struct foo
4857   char a:4;
4858   char b:8;
4859 @} __attribute__ ((packed));
4860 @end smallexample
4862 This warning is enabled by default.  Use
4863 @option{-Wno-packed-bitfield-compat} to disable this warning.
4865 @item -Wpadded
4866 @opindex Wpadded
4867 @opindex Wno-padded
4868 Warn if padding is included in a structure, either to align an element
4869 of the structure or to align the whole structure.  Sometimes when this
4870 happens it is possible to rearrange the fields of the structure to
4871 reduce the padding and so make the structure smaller.
4873 @item -Wredundant-decls
4874 @opindex Wredundant-decls
4875 @opindex Wno-redundant-decls
4876 Warn if anything is declared more than once in the same scope, even in
4877 cases where multiple declaration is valid and changes nothing.
4879 @item -Wnested-externs @r{(C and Objective-C only)}
4880 @opindex Wnested-externs
4881 @opindex Wno-nested-externs
4882 Warn if an @code{extern} declaration is encountered within a function.
4884 @item -Wno-inherited-variadic-ctor
4885 @opindex Winherited-variadic-ctor
4886 @opindex Wno-inherited-variadic-ctor
4887 Suppress warnings about use of C++11 inheriting constructors when the
4888 base class inherited from has a C variadic constructor; the warning is
4889 on by default because the ellipsis is not inherited.
4891 @item -Winline
4892 @opindex Winline
4893 @opindex Wno-inline
4894 Warn if a function that is declared as inline cannot be inlined.
4895 Even with this option, the compiler does not warn about failures to
4896 inline functions declared in system headers.
4898 The compiler uses a variety of heuristics to determine whether or not
4899 to inline a function.  For example, the compiler takes into account
4900 the size of the function being inlined and the amount of inlining
4901 that has already been done in the current function.  Therefore,
4902 seemingly insignificant changes in the source program can cause the
4903 warnings produced by @option{-Winline} to appear or disappear.
4905 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4906 @opindex Wno-invalid-offsetof
4907 @opindex Winvalid-offsetof
4908 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4909 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4910 to a non-POD type is undefined.  In existing C++ implementations,
4911 however, @samp{offsetof} typically gives meaningful results even when
4912 applied to certain kinds of non-POD types (such as a simple
4913 @samp{struct} that fails to be a POD type only by virtue of having a
4914 constructor).  This flag is for users who are aware that they are
4915 writing nonportable code and who have deliberately chosen to ignore the
4916 warning about it.
4918 The restrictions on @samp{offsetof} may be relaxed in a future version
4919 of the C++ standard.
4921 @item -Wno-int-to-pointer-cast
4922 @opindex Wno-int-to-pointer-cast
4923 @opindex Wint-to-pointer-cast
4924 Suppress warnings from casts to pointer type of an integer of a
4925 different size. In C++, casting to a pointer type of smaller size is
4926 an error. @option{Wint-to-pointer-cast} is enabled by default.
4929 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4930 @opindex Wno-pointer-to-int-cast
4931 @opindex Wpointer-to-int-cast
4932 Suppress warnings from casts from a pointer to an integer type of a
4933 different size.
4935 @item -Winvalid-pch
4936 @opindex Winvalid-pch
4937 @opindex Wno-invalid-pch
4938 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4939 the search path but can't be used.
4941 @item -Wlong-long
4942 @opindex Wlong-long
4943 @opindex Wno-long-long
4944 Warn if @samp{long long} type is used.  This is enabled by either
4945 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4946 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4948 @item -Wvariadic-macros
4949 @opindex Wvariadic-macros
4950 @opindex Wno-variadic-macros
4951 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4952 alternate syntax when in pedantic ISO C99 mode.  This is default.
4953 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4955 @item -Wvarargs
4956 @opindex Wvarargs
4957 @opindex Wno-varargs
4958 Warn upon questionable usage of the macros used to handle variable
4959 arguments like @samp{va_start}.  This is default.  To inhibit the
4960 warning messages, use @option{-Wno-varargs}.
4962 @item -Wvector-operation-performance
4963 @opindex Wvector-operation-performance
4964 @opindex Wno-vector-operation-performance
4965 Warn if vector operation is not implemented via SIMD capabilities of the
4966 architecture.  Mainly useful for the performance tuning.
4967 Vector operation can be implemented @code{piecewise}, which means that the
4968 scalar operation is performed on every vector element; 
4969 @code{in parallel}, which means that the vector operation is implemented
4970 using scalars of wider type, which normally is more performance efficient;
4971 and @code{as a single scalar}, which means that vector fits into a
4972 scalar type.
4974 @item -Wno-virtual-move-assign
4975 @opindex Wvirtual-move-assign
4976 @opindex Wno-virtual-move-assign
4977 Suppress warnings about inheriting from a virtual base with a
4978 non-trivial C++11 move assignment operator.  This is dangerous because
4979 if the virtual base is reachable along more than one path, it will be
4980 moved multiple times, which can mean both objects end up in the
4981 moved-from state.  If the move assignment operator is written to avoid
4982 moving from a moved-from object, this warning can be disabled.
4984 @item -Wvla
4985 @opindex Wvla
4986 @opindex Wno-vla
4987 Warn if variable length array is used in the code.
4988 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4989 the variable length array.
4991 @item -Wvolatile-register-var
4992 @opindex Wvolatile-register-var
4993 @opindex Wno-volatile-register-var
4994 Warn if a register variable is declared volatile.  The volatile
4995 modifier does not inhibit all optimizations that may eliminate reads
4996 and/or writes to register variables.  This warning is enabled by
4997 @option{-Wall}.
4999 @item -Wdisabled-optimization
5000 @opindex Wdisabled-optimization
5001 @opindex Wno-disabled-optimization
5002 Warn if a requested optimization pass is disabled.  This warning does
5003 not generally indicate that there is anything wrong with your code; it
5004 merely indicates that GCC's optimizers are unable to handle the code
5005 effectively.  Often, the problem is that your code is too big or too
5006 complex; GCC refuses to optimize programs when the optimization
5007 itself is likely to take inordinate amounts of time.
5009 @item -Wpointer-sign @r{(C and Objective-C only)}
5010 @opindex Wpointer-sign
5011 @opindex Wno-pointer-sign
5012 Warn for pointer argument passing or assignment with different signedness.
5013 This option is only supported for C and Objective-C@.  It is implied by
5014 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5015 @option{-Wno-pointer-sign}.
5017 @item -Wstack-protector
5018 @opindex Wstack-protector
5019 @opindex Wno-stack-protector
5020 This option is only active when @option{-fstack-protector} is active.  It
5021 warns about functions that are not protected against stack smashing.
5023 @item -Woverlength-strings
5024 @opindex Woverlength-strings
5025 @opindex Wno-overlength-strings
5026 Warn about string constants that are longer than the ``minimum
5027 maximum'' length specified in the C standard.  Modern compilers
5028 generally allow string constants that are much longer than the
5029 standard's minimum limit, but very portable programs should avoid
5030 using longer strings.
5032 The limit applies @emph{after} string constant concatenation, and does
5033 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5034 C99, it was raised to 4095.  C++98 does not specify a normative
5035 minimum maximum, so we do not diagnose overlength strings in C++@.
5037 This option is implied by @option{-Wpedantic}, and can be disabled with
5038 @option{-Wno-overlength-strings}.
5040 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5041 @opindex Wunsuffixed-float-constants
5043 Issue a warning for any floating constant that does not have
5044 a suffix.  When used together with @option{-Wsystem-headers} it
5045 warns about such constants in system header files.  This can be useful
5046 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5047 from the decimal floating-point extension to C99.
5048 @end table
5050 @node Debugging Options
5051 @section Options for Debugging Your Program or GCC
5052 @cindex options, debugging
5053 @cindex debugging information options
5055 GCC has various special options that are used for debugging
5056 either your program or GCC:
5058 @table @gcctabopt
5059 @item -g
5060 @opindex g
5061 Produce debugging information in the operating system's native format
5062 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5063 information.
5065 On most systems that use stabs format, @option{-g} enables use of extra
5066 debugging information that only GDB can use; this extra information
5067 makes debugging work better in GDB but probably makes other debuggers
5068 crash or
5069 refuse to read the program.  If you want to control for certain whether
5070 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5071 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5073 GCC allows you to use @option{-g} with
5074 @option{-O}.  The shortcuts taken by optimized code may occasionally
5075 produce surprising results: some variables you declared may not exist
5076 at all; flow of control may briefly move where you did not expect it;
5077 some statements may not be executed because they compute constant
5078 results or their values are already at hand; some statements may
5079 execute in different places because they have been moved out of loops.
5081 Nevertheless it proves possible to debug optimized output.  This makes
5082 it reasonable to use the optimizer for programs that might have bugs.
5084 The following options are useful when GCC is generated with the
5085 capability for more than one debugging format.
5087 @item -gsplit-dwarf
5088 @opindex gsplit-dwarf
5089 Separate as much dwarf debugging information as possible into a
5090 separate output file with the extension .dwo.  This option allows
5091 the build system to avoid linking files with debug information.  To
5092 be useful, this option requires a debugger capable of reading .dwo
5093 files.
5095 @item -ggdb
5096 @opindex ggdb
5097 Produce debugging information for use by GDB@.  This means to use the
5098 most expressive format available (DWARF 2, stabs, or the native format
5099 if neither of those are supported), including GDB extensions if at all
5100 possible.
5102 @item -gpubnames
5103 @opindex gpubnames
5104 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5106 @item -ggnu-pubnames
5107 @opindex ggnu-pubnames
5108 Generate .debug_pubnames and .debug_pubtypes sections in a format
5109 suitable for conversion into a GDB@ index.  This option is only useful
5110 with a linker that can produce GDB@ index version 7.
5112 @item -gstabs
5113 @opindex gstabs
5114 Produce debugging information in stabs format (if that is supported),
5115 without GDB extensions.  This is the format used by DBX on most BSD
5116 systems.  On MIPS, Alpha and System V Release 4 systems this option
5117 produces stabs debugging output that is not understood by DBX or SDB@.
5118 On System V Release 4 systems this option requires the GNU assembler.
5120 @item -feliminate-unused-debug-symbols
5121 @opindex feliminate-unused-debug-symbols
5122 Produce debugging information in stabs format (if that is supported),
5123 for only symbols that are actually used.
5125 @item -femit-class-debug-always
5126 Instead of emitting debugging information for a C++ class in only one
5127 object file, emit it in all object files using the class.  This option
5128 should be used only with debuggers that are unable to handle the way GCC
5129 normally emits debugging information for classes because using this
5130 option increases the size of debugging information by as much as a
5131 factor of two.
5133 @item -fdebug-types-section
5134 @opindex fdebug-types-section
5135 @opindex fno-debug-types-section
5136 When using DWARF Version 4 or higher, type DIEs can be put into
5137 their own @code{.debug_types} section instead of making them part of the
5138 @code{.debug_info} section.  It is more efficient to put them in a separate
5139 comdat sections since the linker can then remove duplicates.
5140 But not all DWARF consumers support @code{.debug_types} sections yet
5141 and on some objects @code{.debug_types} produces larger instead of smaller
5142 debugging information.
5144 @item -gstabs+
5145 @opindex gstabs+
5146 Produce debugging information in stabs format (if that is supported),
5147 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5148 use of these extensions is likely to make other debuggers crash or
5149 refuse to read the program.
5151 @item -gcoff
5152 @opindex gcoff
5153 Produce debugging information in COFF format (if that is supported).
5154 This is the format used by SDB on most System V systems prior to
5155 System V Release 4.
5157 @item -gxcoff
5158 @opindex gxcoff
5159 Produce debugging information in XCOFF format (if that is supported).
5160 This is the format used by the DBX debugger on IBM RS/6000 systems.
5162 @item -gxcoff+
5163 @opindex gxcoff+
5164 Produce debugging information in XCOFF format (if that is supported),
5165 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5166 use of these extensions is likely to make other debuggers crash or
5167 refuse to read the program, and may cause assemblers other than the GNU
5168 assembler (GAS) to fail with an error.
5170 @item -gdwarf-@var{version}
5171 @opindex gdwarf-@var{version}
5172 Produce debugging information in DWARF format (if that is supported).
5173 The value of @var{version} may be either 2, 3 or 4; the default version
5174 for most targets is 4.
5176 Note that with DWARF Version 2, some ports require and always
5177 use some non-conflicting DWARF 3 extensions in the unwind tables.
5179 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5180 for maximum benefit.
5182 @item -grecord-gcc-switches
5183 @opindex grecord-gcc-switches
5184 This switch causes the command-line options used to invoke the
5185 compiler that may affect code generation to be appended to the
5186 DW_AT_producer attribute in DWARF debugging information.  The options
5187 are concatenated with spaces separating them from each other and from
5188 the compiler version.  See also @option{-frecord-gcc-switches} for another
5189 way of storing compiler options into the object file.  This is the default.
5191 @item -gno-record-gcc-switches
5192 @opindex gno-record-gcc-switches
5193 Disallow appending command-line options to the DW_AT_producer attribute
5194 in DWARF debugging information.
5196 @item -gstrict-dwarf
5197 @opindex gstrict-dwarf
5198 Disallow using extensions of later DWARF standard version than selected
5199 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5200 DWARF extensions from later standard versions is allowed.
5202 @item -gno-strict-dwarf
5203 @opindex gno-strict-dwarf
5204 Allow using extensions of later DWARF standard version than selected with
5205 @option{-gdwarf-@var{version}}.
5207 @item -gvms
5208 @opindex gvms
5209 Produce debugging information in Alpha/VMS debug format (if that is
5210 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5212 @item -g@var{level}
5213 @itemx -ggdb@var{level}
5214 @itemx -gstabs@var{level}
5215 @itemx -gcoff@var{level}
5216 @itemx -gxcoff@var{level}
5217 @itemx -gvms@var{level}
5218 Request debugging information and also use @var{level} to specify how
5219 much information.  The default level is 2.
5221 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5222 @option{-g}.
5224 Level 1 produces minimal information, enough for making backtraces in
5225 parts of the program that you don't plan to debug.  This includes
5226 descriptions of functions and external variables, but no information
5227 about local variables and no line numbers.
5229 Level 3 includes extra information, such as all the macro definitions
5230 present in the program.  Some debuggers support macro expansion when
5231 you use @option{-g3}.
5233 @option{-gdwarf-2} does not accept a concatenated debug level, because
5234 GCC used to support an option @option{-gdwarf} that meant to generate
5235 debug information in version 1 of the DWARF format (which is very
5236 different from version 2), and it would have been too confusing.  That
5237 debug format is long obsolete, but the option cannot be changed now.
5238 Instead use an additional @option{-g@var{level}} option to change the
5239 debug level for DWARF.
5241 @item -gtoggle
5242 @opindex gtoggle
5243 Turn off generation of debug info, if leaving out this option
5244 generates it, or turn it on at level 2 otherwise.  The position of this
5245 argument in the command line does not matter; it takes effect after all
5246 other options are processed, and it does so only once, no matter how
5247 many times it is given.  This is mainly intended to be used with
5248 @option{-fcompare-debug}.
5250 @item -fsanitize=address
5251 Enable AddressSanitizer, a fast memory error detector.
5252 Memory access instructions will be instrumented to detect
5253 out-of-bounds and use-after-free bugs.
5254 See @uref{http://code.google.com/p/address-sanitizer/} for more details.
5256 @item -fsanitize=thread
5257 Enable ThreadSanitizer, a fast data race detector.
5258 Memory access instructions will be instrumented to detect
5259 data race bugs.
5260 See @uref{http://code.google.com/p/data-race-test/wiki/ThreadSanitizer} for more details.
5262 @item -fsanitize=undefined
5263 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector
5264 Various computations will be instrumented to detect undefined behavior
5265 at runtime, e.g.@: division by zero or various overflows.
5266 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5267 @option{-fsanitize=undefined} gives a diagnostic message.
5268 This currently works only for the C family of languages.
5270 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5271 @opindex fdump-final-insns
5272 Dump the final internal representation (RTL) to @var{file}.  If the
5273 optional argument is omitted (or if @var{file} is @code{.}), the name
5274 of the dump file is determined by appending @code{.gkd} to the
5275 compilation output file name.
5277 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5278 @opindex fcompare-debug
5279 @opindex fno-compare-debug
5280 If no error occurs during compilation, run the compiler a second time,
5281 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5282 passed to the second compilation.  Dump the final internal
5283 representation in both compilations, and print an error if they differ.
5285 If the equal sign is omitted, the default @option{-gtoggle} is used.
5287 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5288 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5289 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5290 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5291 is used.
5293 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5294 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5295 of the final representation and the second compilation, preventing even
5296 @env{GCC_COMPARE_DEBUG} from taking effect.
5298 To verify full coverage during @option{-fcompare-debug} testing, set
5299 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5300 which GCC rejects as an invalid option in any actual compilation
5301 (rather than preprocessing, assembly or linking).  To get just a
5302 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5303 not overridden} will do.
5305 @item -fcompare-debug-second
5306 @opindex fcompare-debug-second
5307 This option is implicitly passed to the compiler for the second
5308 compilation requested by @option{-fcompare-debug}, along with options to
5309 silence warnings, and omitting other options that would cause
5310 side-effect compiler outputs to files or to the standard output.  Dump
5311 files and preserved temporary files are renamed so as to contain the
5312 @code{.gk} additional extension during the second compilation, to avoid
5313 overwriting those generated by the first.
5315 When this option is passed to the compiler driver, it causes the
5316 @emph{first} compilation to be skipped, which makes it useful for little
5317 other than debugging the compiler proper.
5319 @item -feliminate-dwarf2-dups
5320 @opindex feliminate-dwarf2-dups
5321 Compress DWARF 2 debugging information by eliminating duplicated
5322 information about each symbol.  This option only makes sense when
5323 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5325 @item -femit-struct-debug-baseonly
5326 Emit debug information for struct-like types
5327 only when the base name of the compilation source file
5328 matches the base name of file in which the struct is defined.
5330 This option substantially reduces the size of debugging information,
5331 but at significant potential loss in type information to the debugger.
5332 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5333 See @option{-femit-struct-debug-detailed} for more detailed control.
5335 This option works only with DWARF 2.
5337 @item -femit-struct-debug-reduced
5338 Emit debug information for struct-like types
5339 only when the base name of the compilation source file
5340 matches the base name of file in which the type is defined,
5341 unless the struct is a template or defined in a system header.
5343 This option significantly reduces the size of debugging information,
5344 with some potential loss in type information to the debugger.
5345 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5346 See @option{-femit-struct-debug-detailed} for more detailed control.
5348 This option works only with DWARF 2.
5350 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5351 Specify the struct-like types
5352 for which the compiler generates debug information.
5353 The intent is to reduce duplicate struct debug information
5354 between different object files within the same program.
5356 This option is a detailed version of
5357 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5358 which serves for most needs.
5360 A specification has the syntax@*
5361 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5363 The optional first word limits the specification to
5364 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5365 A struct type is used directly when it is the type of a variable, member.
5366 Indirect uses arise through pointers to structs.
5367 That is, when use of an incomplete struct is valid, the use is indirect.
5368 An example is
5369 @samp{struct one direct; struct two * indirect;}.
5371 The optional second word limits the specification to
5372 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5373 Generic structs are a bit complicated to explain.
5374 For C++, these are non-explicit specializations of template classes,
5375 or non-template classes within the above.
5376 Other programming languages have generics,
5377 but @option{-femit-struct-debug-detailed} does not yet implement them.
5379 The third word specifies the source files for those
5380 structs for which the compiler should emit debug information.
5381 The values @samp{none} and @samp{any} have the normal meaning.
5382 The value @samp{base} means that
5383 the base of name of the file in which the type declaration appears
5384 must match the base of the name of the main compilation file.
5385 In practice, this means that when compiling @file{foo.c}, debug information
5386 is generated for types declared in that file and @file{foo.h},
5387 but not other header files.
5388 The value @samp{sys} means those types satisfying @samp{base}
5389 or declared in system or compiler headers.
5391 You may need to experiment to determine the best settings for your application.
5393 The default is @option{-femit-struct-debug-detailed=all}.
5395 This option works only with DWARF 2.
5397 @item -fno-merge-debug-strings
5398 @opindex fmerge-debug-strings
5399 @opindex fno-merge-debug-strings
5400 Direct the linker to not merge together strings in the debugging
5401 information that are identical in different object files.  Merging is
5402 not supported by all assemblers or linkers.  Merging decreases the size
5403 of the debug information in the output file at the cost of increasing
5404 link processing time.  Merging is enabled by default.
5406 @item -fdebug-prefix-map=@var{old}=@var{new}
5407 @opindex fdebug-prefix-map
5408 When compiling files in directory @file{@var{old}}, record debugging
5409 information describing them as in @file{@var{new}} instead.
5411 @item -fno-dwarf2-cfi-asm
5412 @opindex fdwarf2-cfi-asm
5413 @opindex fno-dwarf2-cfi-asm
5414 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5415 instead of using GAS @code{.cfi_*} directives.
5417 @cindex @command{prof}
5418 @item -p
5419 @opindex p
5420 Generate extra code to write profile information suitable for the
5421 analysis program @command{prof}.  You must use this option when compiling
5422 the source files you want data about, and you must also use it when
5423 linking.
5425 @cindex @command{gprof}
5426 @item -pg
5427 @opindex pg
5428 Generate extra code to write profile information suitable for the
5429 analysis program @command{gprof}.  You must use this option when compiling
5430 the source files you want data about, and you must also use it when
5431 linking.
5433 @item -Q
5434 @opindex Q
5435 Makes the compiler print out each function name as it is compiled, and
5436 print some statistics about each pass when it finishes.
5438 @item -ftime-report
5439 @opindex ftime-report
5440 Makes the compiler print some statistics about the time consumed by each
5441 pass when it finishes.
5443 @item -fmem-report
5444 @opindex fmem-report
5445 Makes the compiler print some statistics about permanent memory
5446 allocation when it finishes.
5448 @item -fmem-report-wpa
5449 @opindex fmem-report-wpa
5450 Makes the compiler print some statistics about permanent memory
5451 allocation for the WPA phase only.
5453 @item -fpre-ipa-mem-report
5454 @opindex fpre-ipa-mem-report
5455 @item -fpost-ipa-mem-report
5456 @opindex fpost-ipa-mem-report
5457 Makes the compiler print some statistics about permanent memory
5458 allocation before or after interprocedural optimization.
5460 @item -fprofile-report
5461 @opindex fprofile-report
5462 Makes the compiler print some statistics about consistency of the
5463 (estimated) profile and effect of individual passes.
5465 @item -fstack-usage
5466 @opindex fstack-usage
5467 Makes the compiler output stack usage information for the program, on a
5468 per-function basis.  The filename for the dump is made by appending
5469 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5470 the output file, if explicitly specified and it is not an executable,
5471 otherwise it is the basename of the source file.  An entry is made up
5472 of three fields:
5474 @itemize
5475 @item
5476 The name of the function.
5477 @item
5478 A number of bytes.
5479 @item
5480 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5481 @end itemize
5483 The qualifier @code{static} means that the function manipulates the stack
5484 statically: a fixed number of bytes are allocated for the frame on function
5485 entry and released on function exit; no stack adjustments are otherwise made
5486 in the function.  The second field is this fixed number of bytes.
5488 The qualifier @code{dynamic} means that the function manipulates the stack
5489 dynamically: in addition to the static allocation described above, stack
5490 adjustments are made in the body of the function, for example to push/pop
5491 arguments around function calls.  If the qualifier @code{bounded} is also
5492 present, the amount of these adjustments is bounded at compile time and
5493 the second field is an upper bound of the total amount of stack used by
5494 the function.  If it is not present, the amount of these adjustments is
5495 not bounded at compile time and the second field only represents the
5496 bounded part.
5498 @item -fprofile-arcs
5499 @opindex fprofile-arcs
5500 Add code so that program flow @dfn{arcs} are instrumented.  During
5501 execution the program records how many times each branch and call is
5502 executed and how many times it is taken or returns.  When the compiled
5503 program exits it saves this data to a file called
5504 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5505 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5506 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5507 @var{auxname} is generated from the name of the output file, if
5508 explicitly specified and it is not the final executable, otherwise it is
5509 the basename of the source file.  In both cases any suffix is removed
5510 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5511 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5512 @xref{Cross-profiling}.
5514 @cindex @command{gcov}
5515 @item --coverage
5516 @opindex coverage
5518 This option is used to compile and link code instrumented for coverage
5519 analysis.  The option is a synonym for @option{-fprofile-arcs}
5520 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5521 linking).  See the documentation for those options for more details.
5523 @itemize
5525 @item
5526 Compile the source files with @option{-fprofile-arcs} plus optimization
5527 and code generation options.  For test coverage analysis, use the
5528 additional @option{-ftest-coverage} option.  You do not need to profile
5529 every source file in a program.
5531 @item
5532 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5533 (the latter implies the former).
5535 @item
5536 Run the program on a representative workload to generate the arc profile
5537 information.  This may be repeated any number of times.  You can run
5538 concurrent instances of your program, and provided that the file system
5539 supports locking, the data files will be correctly updated.  Also
5540 @code{fork} calls are detected and correctly handled (double counting
5541 will not happen).
5543 @item
5544 For profile-directed optimizations, compile the source files again with
5545 the same optimization and code generation options plus
5546 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5547 Control Optimization}).
5549 @item
5550 For test coverage analysis, use @command{gcov} to produce human readable
5551 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5552 @command{gcov} documentation for further information.
5554 @end itemize
5556 With @option{-fprofile-arcs}, for each function of your program GCC
5557 creates a program flow graph, then finds a spanning tree for the graph.
5558 Only arcs that are not on the spanning tree have to be instrumented: the
5559 compiler adds code to count the number of times that these arcs are
5560 executed.  When an arc is the only exit or only entrance to a block, the
5561 instrumentation code can be added to the block; otherwise, a new basic
5562 block must be created to hold the instrumentation code.
5564 @need 2000
5565 @item -ftest-coverage
5566 @opindex ftest-coverage
5567 Produce a notes file that the @command{gcov} code-coverage utility
5568 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5569 show program coverage.  Each source file's note file is called
5570 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5571 above for a description of @var{auxname} and instructions on how to
5572 generate test coverage data.  Coverage data matches the source files
5573 more closely if you do not optimize.
5575 @item -fdbg-cnt-list
5576 @opindex fdbg-cnt-list
5577 Print the name and the counter upper bound for all debug counters.
5580 @item -fdbg-cnt=@var{counter-value-list}
5581 @opindex fdbg-cnt
5582 Set the internal debug counter upper bound.  @var{counter-value-list}
5583 is a comma-separated list of @var{name}:@var{value} pairs
5584 which sets the upper bound of each debug counter @var{name} to @var{value}.
5585 All debug counters have the initial upper bound of @code{UINT_MAX};
5586 thus @code{dbg_cnt()} returns true always unless the upper bound
5587 is set by this option.
5588 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5589 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5591 @item -fenable-@var{kind}-@var{pass}
5592 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5593 @opindex fdisable-
5594 @opindex fenable-
5596 This is a set of options that are used to explicitly disable/enable
5597 optimization passes.  These options are intended for use for debugging GCC.
5598 Compiler users should use regular options for enabling/disabling
5599 passes instead.
5601 @table @gcctabopt
5603 @item -fdisable-ipa-@var{pass}
5604 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5605 statically invoked in the compiler multiple times, the pass name should be
5606 appended with a sequential number starting from 1.
5608 @item -fdisable-rtl-@var{pass}
5609 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5610 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5611 statically invoked in the compiler multiple times, the pass name should be
5612 appended with a sequential number starting from 1.  @var{range-list} is a 
5613 comma-separated list of function ranges or assembler names.  Each range is a number
5614 pair separated by a colon.  The range is inclusive in both ends.  If the range
5615 is trivial, the number pair can be simplified as a single number.  If the
5616 function's call graph node's @var{uid} falls within one of the specified ranges,
5617 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5618 function header of a dump file, and the pass names can be dumped by using
5619 option @option{-fdump-passes}.
5621 @item -fdisable-tree-@var{pass}
5622 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5623 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5624 option arguments.
5626 @item -fenable-ipa-@var{pass}
5627 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5628 statically invoked in the compiler multiple times, the pass name should be
5629 appended with a sequential number starting from 1.
5631 @item -fenable-rtl-@var{pass}
5632 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5633 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5634 description and examples.
5636 @item -fenable-tree-@var{pass}
5637 @itemx -fenable-tree-@var{pass}=@var{range-list}
5638 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5639 of option arguments.
5641 @end table
5643 Here are some examples showing uses of these options.
5645 @smallexample
5647 # disable ccp1 for all functions
5648    -fdisable-tree-ccp1
5649 # disable complete unroll for function whose cgraph node uid is 1
5650    -fenable-tree-cunroll=1
5651 # disable gcse2 for functions at the following ranges [1,1],
5652 # [300,400], and [400,1000]
5653 # disable gcse2 for functions foo and foo2
5654    -fdisable-rtl-gcse2=foo,foo2
5655 # disable early inlining
5656    -fdisable-tree-einline
5657 # disable ipa inlining
5658    -fdisable-ipa-inline
5659 # enable tree full unroll
5660    -fenable-tree-unroll
5662 @end smallexample
5664 @item -d@var{letters}
5665 @itemx -fdump-rtl-@var{pass}
5666 @itemx -fdump-rtl-@var{pass}=@var{filename}
5667 @opindex d
5668 Says to make debugging dumps during compilation at times specified by
5669 @var{letters}.  This is used for debugging the RTL-based passes of the
5670 compiler.  The file names for most of the dumps are made by appending
5671 a pass number and a word to the @var{dumpname}, and the files are
5672 created in the directory of the output file. In case of
5673 @option{=@var{filename}} option, the dump is output on the given file
5674 instead of the pass numbered dump files. Note that the pass number is
5675 computed statically as passes get registered into the pass manager.
5676 Thus the numbering is not related to the dynamic order of execution of
5677 passes.  In particular, a pass installed by a plugin could have a
5678 number over 200 even if it executed quite early.  @var{dumpname} is
5679 generated from the name of the output file, if explicitly specified
5680 and it is not an executable, otherwise it is the basename of the
5681 source file. These switches may have different effects when
5682 @option{-E} is used for preprocessing.
5684 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5685 @option{-d} option @var{letters}.  Here are the possible
5686 letters for use in @var{pass} and @var{letters}, and their meanings:
5688 @table @gcctabopt
5690 @item -fdump-rtl-alignments
5691 @opindex fdump-rtl-alignments
5692 Dump after branch alignments have been computed.
5694 @item -fdump-rtl-asmcons
5695 @opindex fdump-rtl-asmcons
5696 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5698 @item -fdump-rtl-auto_inc_dec
5699 @opindex fdump-rtl-auto_inc_dec
5700 Dump after auto-inc-dec discovery.  This pass is only run on
5701 architectures that have auto inc or auto dec instructions.
5703 @item -fdump-rtl-barriers
5704 @opindex fdump-rtl-barriers
5705 Dump after cleaning up the barrier instructions.
5707 @item -fdump-rtl-bbpart
5708 @opindex fdump-rtl-bbpart
5709 Dump after partitioning hot and cold basic blocks.
5711 @item -fdump-rtl-bbro
5712 @opindex fdump-rtl-bbro
5713 Dump after block reordering.
5715 @item -fdump-rtl-btl1
5716 @itemx -fdump-rtl-btl2
5717 @opindex fdump-rtl-btl2
5718 @opindex fdump-rtl-btl2
5719 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5720 after the two branch
5721 target load optimization passes.
5723 @item -fdump-rtl-bypass
5724 @opindex fdump-rtl-bypass
5725 Dump after jump bypassing and control flow optimizations.
5727 @item -fdump-rtl-combine
5728 @opindex fdump-rtl-combine
5729 Dump after the RTL instruction combination pass.
5731 @item -fdump-rtl-compgotos
5732 @opindex fdump-rtl-compgotos
5733 Dump after duplicating the computed gotos.
5735 @item -fdump-rtl-ce1
5736 @itemx -fdump-rtl-ce2
5737 @itemx -fdump-rtl-ce3
5738 @opindex fdump-rtl-ce1
5739 @opindex fdump-rtl-ce2
5740 @opindex fdump-rtl-ce3
5741 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5742 @option{-fdump-rtl-ce3} enable dumping after the three
5743 if conversion passes.
5745 @item -fdump-rtl-cprop_hardreg
5746 @opindex fdump-rtl-cprop_hardreg
5747 Dump after hard register copy propagation.
5749 @item -fdump-rtl-csa
5750 @opindex fdump-rtl-csa
5751 Dump after combining stack adjustments.
5753 @item -fdump-rtl-cse1
5754 @itemx -fdump-rtl-cse2
5755 @opindex fdump-rtl-cse1
5756 @opindex fdump-rtl-cse2
5757 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5758 the two common subexpression elimination passes.
5760 @item -fdump-rtl-dce
5761 @opindex fdump-rtl-dce
5762 Dump after the standalone dead code elimination passes.
5764 @item -fdump-rtl-dbr
5765 @opindex fdump-rtl-dbr
5766 Dump after delayed branch scheduling.
5768 @item -fdump-rtl-dce1
5769 @itemx -fdump-rtl-dce2
5770 @opindex fdump-rtl-dce1
5771 @opindex fdump-rtl-dce2
5772 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5773 the two dead store elimination passes.
5775 @item -fdump-rtl-eh
5776 @opindex fdump-rtl-eh
5777 Dump after finalization of EH handling code.
5779 @item -fdump-rtl-eh_ranges
5780 @opindex fdump-rtl-eh_ranges
5781 Dump after conversion of EH handling range regions.
5783 @item -fdump-rtl-expand
5784 @opindex fdump-rtl-expand
5785 Dump after RTL generation.
5787 @item -fdump-rtl-fwprop1
5788 @itemx -fdump-rtl-fwprop2
5789 @opindex fdump-rtl-fwprop1
5790 @opindex fdump-rtl-fwprop2
5791 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5792 dumping after the two forward propagation passes.
5794 @item -fdump-rtl-gcse1
5795 @itemx -fdump-rtl-gcse2
5796 @opindex fdump-rtl-gcse1
5797 @opindex fdump-rtl-gcse2
5798 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5799 after global common subexpression elimination.
5801 @item -fdump-rtl-init-regs
5802 @opindex fdump-rtl-init-regs
5803 Dump after the initialization of the registers.
5805 @item -fdump-rtl-initvals
5806 @opindex fdump-rtl-initvals
5807 Dump after the computation of the initial value sets.
5809 @item -fdump-rtl-into_cfglayout
5810 @opindex fdump-rtl-into_cfglayout
5811 Dump after converting to cfglayout mode.
5813 @item -fdump-rtl-ira
5814 @opindex fdump-rtl-ira
5815 Dump after iterated register allocation.
5817 @item -fdump-rtl-jump
5818 @opindex fdump-rtl-jump
5819 Dump after the second jump optimization.
5821 @item -fdump-rtl-loop2
5822 @opindex fdump-rtl-loop2
5823 @option{-fdump-rtl-loop2} enables dumping after the rtl
5824 loop optimization passes.
5826 @item -fdump-rtl-mach
5827 @opindex fdump-rtl-mach
5828 Dump after performing the machine dependent reorganization pass, if that
5829 pass exists.
5831 @item -fdump-rtl-mode_sw
5832 @opindex fdump-rtl-mode_sw
5833 Dump after removing redundant mode switches.
5835 @item -fdump-rtl-rnreg
5836 @opindex fdump-rtl-rnreg
5837 Dump after register renumbering.
5839 @item -fdump-rtl-outof_cfglayout
5840 @opindex fdump-rtl-outof_cfglayout
5841 Dump after converting from cfglayout mode.
5843 @item -fdump-rtl-peephole2
5844 @opindex fdump-rtl-peephole2
5845 Dump after the peephole pass.
5847 @item -fdump-rtl-postreload
5848 @opindex fdump-rtl-postreload
5849 Dump after post-reload optimizations.
5851 @item -fdump-rtl-pro_and_epilogue
5852 @opindex fdump-rtl-pro_and_epilogue
5853 Dump after generating the function prologues and epilogues.
5855 @item -fdump-rtl-sched1
5856 @itemx -fdump-rtl-sched2
5857 @opindex fdump-rtl-sched1
5858 @opindex fdump-rtl-sched2
5859 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5860 after the basic block scheduling passes.
5862 @item -fdump-rtl-see
5863 @opindex fdump-rtl-see
5864 Dump after sign extension elimination.
5866 @item -fdump-rtl-seqabstr
5867 @opindex fdump-rtl-seqabstr
5868 Dump after common sequence discovery.
5870 @item -fdump-rtl-shorten
5871 @opindex fdump-rtl-shorten
5872 Dump after shortening branches.
5874 @item -fdump-rtl-sibling
5875 @opindex fdump-rtl-sibling
5876 Dump after sibling call optimizations.
5878 @item -fdump-rtl-split1
5879 @itemx -fdump-rtl-split2
5880 @itemx -fdump-rtl-split3
5881 @itemx -fdump-rtl-split4
5882 @itemx -fdump-rtl-split5
5883 @opindex fdump-rtl-split1
5884 @opindex fdump-rtl-split2
5885 @opindex fdump-rtl-split3
5886 @opindex fdump-rtl-split4
5887 @opindex fdump-rtl-split5
5888 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5889 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5890 @option{-fdump-rtl-split5} enable dumping after five rounds of
5891 instruction splitting.
5893 @item -fdump-rtl-sms
5894 @opindex fdump-rtl-sms
5895 Dump after modulo scheduling.  This pass is only run on some
5896 architectures.
5898 @item -fdump-rtl-stack
5899 @opindex fdump-rtl-stack
5900 Dump after conversion from GCC's ``flat register file'' registers to the
5901 x87's stack-like registers.  This pass is only run on x86 variants.
5903 @item -fdump-rtl-subreg1
5904 @itemx -fdump-rtl-subreg2
5905 @opindex fdump-rtl-subreg1
5906 @opindex fdump-rtl-subreg2
5907 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5908 the two subreg expansion passes.
5910 @item -fdump-rtl-unshare
5911 @opindex fdump-rtl-unshare
5912 Dump after all rtl has been unshared.
5914 @item -fdump-rtl-vartrack
5915 @opindex fdump-rtl-vartrack
5916 Dump after variable tracking.
5918 @item -fdump-rtl-vregs
5919 @opindex fdump-rtl-vregs
5920 Dump after converting virtual registers to hard registers.
5922 @item -fdump-rtl-web
5923 @opindex fdump-rtl-web
5924 Dump after live range splitting.
5926 @item -fdump-rtl-regclass
5927 @itemx -fdump-rtl-subregs_of_mode_init
5928 @itemx -fdump-rtl-subregs_of_mode_finish
5929 @itemx -fdump-rtl-dfinit
5930 @itemx -fdump-rtl-dfinish
5931 @opindex fdump-rtl-regclass
5932 @opindex fdump-rtl-subregs_of_mode_init
5933 @opindex fdump-rtl-subregs_of_mode_finish
5934 @opindex fdump-rtl-dfinit
5935 @opindex fdump-rtl-dfinish
5936 These dumps are defined but always produce empty files.
5938 @item -da
5939 @itemx -fdump-rtl-all
5940 @opindex da
5941 @opindex fdump-rtl-all
5942 Produce all the dumps listed above.
5944 @item -dA
5945 @opindex dA
5946 Annotate the assembler output with miscellaneous debugging information.
5948 @item -dD
5949 @opindex dD
5950 Dump all macro definitions, at the end of preprocessing, in addition to
5951 normal output.
5953 @item -dH
5954 @opindex dH
5955 Produce a core dump whenever an error occurs.
5957 @item -dp
5958 @opindex dp
5959 Annotate the assembler output with a comment indicating which
5960 pattern and alternative is used.  The length of each instruction is
5961 also printed.
5963 @item -dP
5964 @opindex dP
5965 Dump the RTL in the assembler output as a comment before each instruction.
5966 Also turns on @option{-dp} annotation.
5968 @item -dx
5969 @opindex dx
5970 Just generate RTL for a function instead of compiling it.  Usually used
5971 with @option{-fdump-rtl-expand}.
5972 @end table
5974 @item -fdump-noaddr
5975 @opindex fdump-noaddr
5976 When doing debugging dumps, suppress address output.  This makes it more
5977 feasible to use diff on debugging dumps for compiler invocations with
5978 different compiler binaries and/or different
5979 text / bss / data / heap / stack / dso start locations.
5981 @item -fdump-unnumbered
5982 @opindex fdump-unnumbered
5983 When doing debugging dumps, suppress instruction numbers and address output.
5984 This makes it more feasible to use diff on debugging dumps for compiler
5985 invocations with different options, in particular with and without
5986 @option{-g}.
5988 @item -fdump-unnumbered-links
5989 @opindex fdump-unnumbered-links
5990 When doing debugging dumps (see @option{-d} option above), suppress
5991 instruction numbers for the links to the previous and next instructions
5992 in a sequence.
5994 @item -fdump-translation-unit @r{(C++ only)}
5995 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5996 @opindex fdump-translation-unit
5997 Dump a representation of the tree structure for the entire translation
5998 unit to a file.  The file name is made by appending @file{.tu} to the
5999 source file name, and the file is created in the same directory as the
6000 output file.  If the @samp{-@var{options}} form is used, @var{options}
6001 controls the details of the dump as described for the
6002 @option{-fdump-tree} options.
6004 @item -fdump-class-hierarchy @r{(C++ only)}
6005 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6006 @opindex fdump-class-hierarchy
6007 Dump a representation of each class's hierarchy and virtual function
6008 table layout to a file.  The file name is made by appending
6009 @file{.class} to the source file name, and the file is created in the
6010 same directory as the output file.  If the @samp{-@var{options}} form
6011 is used, @var{options} controls the details of the dump as described
6012 for the @option{-fdump-tree} options.
6014 @item -fdump-ipa-@var{switch}
6015 @opindex fdump-ipa
6016 Control the dumping at various stages of inter-procedural analysis
6017 language tree to a file.  The file name is generated by appending a
6018 switch specific suffix to the source file name, and the file is created
6019 in the same directory as the output file.  The following dumps are
6020 possible:
6022 @table @samp
6023 @item all
6024 Enables all inter-procedural analysis dumps.
6026 @item cgraph
6027 Dumps information about call-graph optimization, unused function removal,
6028 and inlining decisions.
6030 @item inline
6031 Dump after function inlining.
6033 @end table
6035 @item -fdump-passes
6036 @opindex fdump-passes
6037 Dump the list of optimization passes that are turned on and off by
6038 the current command-line options.
6040 @item -fdump-statistics-@var{option}
6041 @opindex fdump-statistics
6042 Enable and control dumping of pass statistics in a separate file.  The
6043 file name is generated by appending a suffix ending in
6044 @samp{.statistics} to the source file name, and the file is created in
6045 the same directory as the output file.  If the @samp{-@var{option}}
6046 form is used, @samp{-stats} causes counters to be summed over the
6047 whole compilation unit while @samp{-details} dumps every event as
6048 the passes generate them.  The default with no option is to sum
6049 counters for each function compiled.
6051 @item -fdump-tree-@var{switch}
6052 @itemx -fdump-tree-@var{switch}-@var{options}
6053 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6054 @opindex fdump-tree
6055 Control the dumping at various stages of processing the intermediate
6056 language tree to a file.  The file name is generated by appending a
6057 switch-specific suffix to the source file name, and the file is
6058 created in the same directory as the output file. In case of
6059 @option{=@var{filename}} option, the dump is output on the given file
6060 instead of the auto named dump files.  If the @samp{-@var{options}}
6061 form is used, @var{options} is a list of @samp{-} separated options
6062 which control the details of the dump.  Not all options are applicable
6063 to all dumps; those that are not meaningful are ignored.  The
6064 following options are available
6066 @table @samp
6067 @item address
6068 Print the address of each node.  Usually this is not meaningful as it
6069 changes according to the environment and source file.  Its primary use
6070 is for tying up a dump file with a debug environment.
6071 @item asmname
6072 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6073 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6074 use working backward from mangled names in the assembly file.
6075 @item slim
6076 When dumping front-end intermediate representations, inhibit dumping
6077 of members of a scope or body of a function merely because that scope
6078 has been reached.  Only dump such items when they are directly reachable
6079 by some other path.
6081 When dumping pretty-printed trees, this option inhibits dumping the
6082 bodies of control structures.
6084 When dumping RTL, print the RTL in slim (condensed) form instead of
6085 the default LISP-like representation.
6086 @item raw
6087 Print a raw representation of the tree.  By default, trees are
6088 pretty-printed into a C-like representation.
6089 @item details
6090 Enable more detailed dumps (not honored by every dump option). Also
6091 include information from the optimization passes.
6092 @item stats
6093 Enable dumping various statistics about the pass (not honored by every dump
6094 option).
6095 @item blocks
6096 Enable showing basic block boundaries (disabled in raw dumps).
6097 @item graph
6098 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6099 dump a representation of the control flow graph suitable for viewing with
6100 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6101 the file is pretty-printed as a subgraph, so that GraphViz can render them
6102 all in a single plot.
6104 This option currently only works for RTL dumps, and the RTL is always
6105 dumped in slim form.
6106 @item vops
6107 Enable showing virtual operands for every statement.
6108 @item lineno
6109 Enable showing line numbers for statements.
6110 @item uid
6111 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6112 @item verbose
6113 Enable showing the tree dump for each statement.
6114 @item eh
6115 Enable showing the EH region number holding each statement.
6116 @item scev
6117 Enable showing scalar evolution analysis details.
6118 @item optimized
6119 Enable showing optimization information (only available in certain
6120 passes).
6121 @item missed
6122 Enable showing missed optimization information (only available in certain
6123 passes).
6124 @item notes
6125 Enable other detailed optimization information (only available in
6126 certain passes).
6127 @item =@var{filename}
6128 Instead of an auto named dump file, output into the given file
6129 name. The file names @file{stdout} and @file{stderr} are treated
6130 specially and are considered already open standard streams. For
6131 example,
6133 @smallexample
6134 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6135      -fdump-tree-pre=stderr file.c
6136 @end smallexample
6138 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6139 output on to @file{stderr}. If two conflicting dump filenames are
6140 given for the same pass, then the latter option overrides the earlier
6141 one.
6143 @item all
6144 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6145 and @option{lineno}.
6147 @item optall
6148 Turn on all optimization options, i.e., @option{optimized},
6149 @option{missed}, and @option{note}.
6150 @end table
6152 The following tree dumps are possible:
6153 @table @samp
6155 @item original
6156 @opindex fdump-tree-original
6157 Dump before any tree based optimization, to @file{@var{file}.original}.
6159 @item optimized
6160 @opindex fdump-tree-optimized
6161 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6163 @item gimple
6164 @opindex fdump-tree-gimple
6165 Dump each function before and after the gimplification pass to a file.  The
6166 file name is made by appending @file{.gimple} to the source file name.
6168 @item cfg
6169 @opindex fdump-tree-cfg
6170 Dump the control flow graph of each function to a file.  The file name is
6171 made by appending @file{.cfg} to the source file name.
6173 @item ch
6174 @opindex fdump-tree-ch
6175 Dump each function after copying loop headers.  The file name is made by
6176 appending @file{.ch} to the source file name.
6178 @item ssa
6179 @opindex fdump-tree-ssa
6180 Dump SSA related information to a file.  The file name is made by appending
6181 @file{.ssa} to the source file name.
6183 @item alias
6184 @opindex fdump-tree-alias
6185 Dump aliasing information for each function.  The file name is made by
6186 appending @file{.alias} to the source file name.
6188 @item ccp
6189 @opindex fdump-tree-ccp
6190 Dump each function after CCP@.  The file name is made by appending
6191 @file{.ccp} to the source file name.
6193 @item storeccp
6194 @opindex fdump-tree-storeccp
6195 Dump each function after STORE-CCP@.  The file name is made by appending
6196 @file{.storeccp} to the source file name.
6198 @item pre
6199 @opindex fdump-tree-pre
6200 Dump trees after partial redundancy elimination.  The file name is made
6201 by appending @file{.pre} to the source file name.
6203 @item fre
6204 @opindex fdump-tree-fre
6205 Dump trees after full redundancy elimination.  The file name is made
6206 by appending @file{.fre} to the source file name.
6208 @item copyprop
6209 @opindex fdump-tree-copyprop
6210 Dump trees after copy propagation.  The file name is made
6211 by appending @file{.copyprop} to the source file name.
6213 @item store_copyprop
6214 @opindex fdump-tree-store_copyprop
6215 Dump trees after store copy-propagation.  The file name is made
6216 by appending @file{.store_copyprop} to the source file name.
6218 @item dce
6219 @opindex fdump-tree-dce
6220 Dump each function after dead code elimination.  The file name is made by
6221 appending @file{.dce} to the source file name.
6223 @item sra
6224 @opindex fdump-tree-sra
6225 Dump each function after performing scalar replacement of aggregates.  The
6226 file name is made by appending @file{.sra} to the source file name.
6228 @item sink
6229 @opindex fdump-tree-sink
6230 Dump each function after performing code sinking.  The file name is made
6231 by appending @file{.sink} to the source file name.
6233 @item dom
6234 @opindex fdump-tree-dom
6235 Dump each function after applying dominator tree optimizations.  The file
6236 name is made by appending @file{.dom} to the source file name.
6238 @item dse
6239 @opindex fdump-tree-dse
6240 Dump each function after applying dead store elimination.  The file
6241 name is made by appending @file{.dse} to the source file name.
6243 @item phiopt
6244 @opindex fdump-tree-phiopt
6245 Dump each function after optimizing PHI nodes into straightline code.  The file
6246 name is made by appending @file{.phiopt} to the source file name.
6248 @item forwprop
6249 @opindex fdump-tree-forwprop
6250 Dump each function after forward propagating single use variables.  The file
6251 name is made by appending @file{.forwprop} to the source file name.
6253 @item copyrename
6254 @opindex fdump-tree-copyrename
6255 Dump each function after applying the copy rename optimization.  The file
6256 name is made by appending @file{.copyrename} to the source file name.
6258 @item nrv
6259 @opindex fdump-tree-nrv
6260 Dump each function after applying the named return value optimization on
6261 generic trees.  The file name is made by appending @file{.nrv} to the source
6262 file name.
6264 @item vect
6265 @opindex fdump-tree-vect
6266 Dump each function after applying vectorization of loops.  The file name is
6267 made by appending @file{.vect} to the source file name.
6269 @item slp
6270 @opindex fdump-tree-slp
6271 Dump each function after applying vectorization of basic blocks.  The file name
6272 is made by appending @file{.slp} to the source file name.
6274 @item vrp
6275 @opindex fdump-tree-vrp
6276 Dump each function after Value Range Propagation (VRP).  The file name
6277 is made by appending @file{.vrp} to the source file name.
6279 @item all
6280 @opindex fdump-tree-all
6281 Enable all the available tree dumps with the flags provided in this option.
6282 @end table
6284 @item -fopt-info
6285 @itemx -fopt-info-@var{options}
6286 @itemx -fopt-info-@var{options}=@var{filename}
6287 @opindex fopt-info
6288 Controls optimization dumps from various optimization passes. If the
6289 @samp{-@var{options}} form is used, @var{options} is a list of
6290 @samp{-} separated options to select the dump details and
6291 optimizations.  If @var{options} is not specified, it defaults to
6292 @option{optimized} for details and @option{optall} for optimization
6293 groups. If the @var{filename} is not specified, it defaults to
6294 @file{stderr}. Note that the output @var{filename} will be overwritten
6295 in case of multiple translation units. If a combined output from
6296 multiple translation units is desired, @file{stderr} should be used
6297 instead.
6299 The options can be divided into two groups, 1) options describing the
6300 verbosity of the dump, and 2) options describing which optimizations
6301 should be included. The options from both the groups can be freely
6302 mixed as they are non-overlapping. However, in case of any conflicts,
6303 the latter options override the earlier options on the command
6304 line. Though multiple -fopt-info options are accepted, only one of
6305 them can have @option{=filename}. If other filenames are provided then
6306 all but the first one are ignored.
6308 The dump verbosity has the following options
6310 @table @samp
6311 @item optimized
6312 Print information when an optimization is successfully applied. It is
6313 up to a pass to decide which information is relevant. For example, the
6314 vectorizer passes print the source location of loops which got
6315 successfully vectorized.
6316 @item missed
6317 Print information about missed optimizations. Individual passes
6318 control which information to include in the output. For example,
6320 @smallexample
6321 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6322 @end smallexample
6324 will print information about missed optimization opportunities from
6325 vectorization passes on stderr.
6326 @item note
6327 Print verbose information about optimizations, such as certain
6328 transformations, more detailed messages about decisions etc.
6329 @item all
6330 Print detailed optimization information. This includes
6331 @var{optimized}, @var{missed}, and @var{note}.
6332 @end table
6334 The second set of options describes a group of optimizations and may
6335 include one or more of the following.
6337 @table @samp
6338 @item ipa
6339 Enable dumps from all interprocedural optimizations.
6340 @item loop
6341 Enable dumps from all loop optimizations.
6342 @item inline
6343 Enable dumps from all inlining optimizations.
6344 @item vec
6345 Enable dumps from all vectorization optimizations.
6346 @item optall
6347 Enable dumps from all optimizations. This is a superset of
6348 the optimization groups listed above.
6349 @end table
6351 For example,
6352 @smallexample
6353 gcc -O3 -fopt-info-missed=missed.all
6354 @end smallexample
6356 outputs missed optimization report from all the passes into
6357 @file{missed.all}.
6359 As another example,
6360 @smallexample
6361 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6362 @end smallexample
6364 will output information about missed optimizations as well as
6365 optimized locations from all the inlining passes into
6366 @file{inline.txt}.
6368 If the @var{filename} is provided, then the dumps from all the
6369 applicable optimizations are concatenated into the @file{filename}.
6370 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6371 omitted, it defaults to @option{all-optall}, which means dump all
6372 available optimization info from all the passes. In the following
6373 example, all optimization info is output on to @file{stderr}.
6375 @smallexample
6376 gcc -O3 -fopt-info
6377 @end smallexample
6379 Note that @option{-fopt-info-vec-missed} behaves the same as
6380 @option{-fopt-info-missed-vec}.
6382 As another example, consider
6384 @smallexample
6385 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6386 @end smallexample
6388 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6389 in conflict since only one output file is allowed. In this case, only
6390 the first option takes effect and the subsequent options are
6391 ignored. Thus only the @file{vec.miss} is produced which cotaints
6392 dumps from the vectorizer about missed opportunities.
6394 @item -frandom-seed=@var{string}
6395 @opindex frandom-seed
6396 This option provides a seed that GCC uses in place of
6397 random numbers in generating certain symbol names
6398 that have to be different in every compiled file.  It is also used to
6399 place unique stamps in coverage data files and the object files that
6400 produce them.  You can use the @option{-frandom-seed} option to produce
6401 reproducibly identical object files.
6403 The @var{string} should be different for every file you compile.
6405 @item -fsched-verbose=@var{n}
6406 @opindex fsched-verbose
6407 On targets that use instruction scheduling, this option controls the
6408 amount of debugging output the scheduler prints.  This information is
6409 written to standard error, unless @option{-fdump-rtl-sched1} or
6410 @option{-fdump-rtl-sched2} is specified, in which case it is output
6411 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6412 respectively.  However for @var{n} greater than nine, the output is
6413 always printed to standard error.
6415 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6416 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6417 For @var{n} greater than one, it also output basic block probabilities,
6418 detailed ready list information and unit/insn info.  For @var{n} greater
6419 than two, it includes RTL at abort point, control-flow and regions info.
6420 And for @var{n} over four, @option{-fsched-verbose} also includes
6421 dependence info.
6423 @item -save-temps
6424 @itemx -save-temps=cwd
6425 @opindex save-temps
6426 Store the usual ``temporary'' intermediate files permanently; place them
6427 in the current directory and name them based on the source file.  Thus,
6428 compiling @file{foo.c} with @option{-c -save-temps} produces files
6429 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6430 preprocessed @file{foo.i} output file even though the compiler now
6431 normally uses an integrated preprocessor.
6433 When used in combination with the @option{-x} command-line option,
6434 @option{-save-temps} is sensible enough to avoid over writing an
6435 input source file with the same extension as an intermediate file.
6436 The corresponding intermediate file may be obtained by renaming the
6437 source file before using @option{-save-temps}.
6439 If you invoke GCC in parallel, compiling several different source
6440 files that share a common base name in different subdirectories or the
6441 same source file compiled for multiple output destinations, it is
6442 likely that the different parallel compilers will interfere with each
6443 other, and overwrite the temporary files.  For instance:
6445 @smallexample
6446 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6447 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6448 @end smallexample
6450 may result in @file{foo.i} and @file{foo.o} being written to
6451 simultaneously by both compilers.
6453 @item -save-temps=obj
6454 @opindex save-temps=obj
6455 Store the usual ``temporary'' intermediate files permanently.  If the
6456 @option{-o} option is used, the temporary files are based on the
6457 object file.  If the @option{-o} option is not used, the
6458 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6460 For example:
6462 @smallexample
6463 gcc -save-temps=obj -c foo.c
6464 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6465 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6466 @end smallexample
6468 @noindent
6469 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6470 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6471 @file{dir2/yfoobar.o}.
6473 @item -time@r{[}=@var{file}@r{]}
6474 @opindex time
6475 Report the CPU time taken by each subprocess in the compilation
6476 sequence.  For C source files, this is the compiler proper and assembler
6477 (plus the linker if linking is done).
6479 Without the specification of an output file, the output looks like this:
6481 @smallexample
6482 # cc1 0.12 0.01
6483 # as 0.00 0.01
6484 @end smallexample
6486 The first number on each line is the ``user time'', that is time spent
6487 executing the program itself.  The second number is ``system time'',
6488 time spent executing operating system routines on behalf of the program.
6489 Both numbers are in seconds.
6491 With the specification of an output file, the output is appended to the
6492 named file, and it looks like this:
6494 @smallexample
6495 0.12 0.01 cc1 @var{options}
6496 0.00 0.01 as @var{options}
6497 @end smallexample
6499 The ``user time'' and the ``system time'' are moved before the program
6500 name, and the options passed to the program are displayed, so that one
6501 can later tell what file was being compiled, and with which options.
6503 @item -fvar-tracking
6504 @opindex fvar-tracking
6505 Run variable tracking pass.  It computes where variables are stored at each
6506 position in code.  Better debugging information is then generated
6507 (if the debugging information format supports this information).
6509 It is enabled by default when compiling with optimization (@option{-Os},
6510 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6511 the debug info format supports it.
6513 @item -fvar-tracking-assignments
6514 @opindex fvar-tracking-assignments
6515 @opindex fno-var-tracking-assignments
6516 Annotate assignments to user variables early in the compilation and
6517 attempt to carry the annotations over throughout the compilation all the
6518 way to the end, in an attempt to improve debug information while
6519 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6521 It can be enabled even if var-tracking is disabled, in which case
6522 annotations are created and maintained, but discarded at the end.
6524 @item -fvar-tracking-assignments-toggle
6525 @opindex fvar-tracking-assignments-toggle
6526 @opindex fno-var-tracking-assignments-toggle
6527 Toggle @option{-fvar-tracking-assignments}, in the same way that
6528 @option{-gtoggle} toggles @option{-g}.
6530 @item -print-file-name=@var{library}
6531 @opindex print-file-name
6532 Print the full absolute name of the library file @var{library} that
6533 would be used when linking---and don't do anything else.  With this
6534 option, GCC does not compile or link anything; it just prints the
6535 file name.
6537 @item -print-multi-directory
6538 @opindex print-multi-directory
6539 Print the directory name corresponding to the multilib selected by any
6540 other switches present in the command line.  This directory is supposed
6541 to exist in @env{GCC_EXEC_PREFIX}.
6543 @item -print-multi-lib
6544 @opindex print-multi-lib
6545 Print the mapping from multilib directory names to compiler switches
6546 that enable them.  The directory name is separated from the switches by
6547 @samp{;}, and each switch starts with an @samp{@@} instead of the
6548 @samp{-}, without spaces between multiple switches.  This is supposed to
6549 ease shell processing.
6551 @item -print-multi-os-directory
6552 @opindex print-multi-os-directory
6553 Print the path to OS libraries for the selected
6554 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6555 present in the @file{lib} subdirectory and no multilibs are used, this is
6556 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6557 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6558 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6559 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6561 @item -print-multiarch
6562 @opindex print-multiarch
6563 Print the path to OS libraries for the selected multiarch,
6564 relative to some @file{lib} subdirectory.
6566 @item -print-prog-name=@var{program}
6567 @opindex print-prog-name
6568 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6570 @item -print-libgcc-file-name
6571 @opindex print-libgcc-file-name
6572 Same as @option{-print-file-name=libgcc.a}.
6574 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6575 but you do want to link with @file{libgcc.a}.  You can do:
6577 @smallexample
6578 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6579 @end smallexample
6581 @item -print-search-dirs
6582 @opindex print-search-dirs
6583 Print the name of the configured installation directory and a list of
6584 program and library directories @command{gcc} searches---and don't do anything else.
6586 This is useful when @command{gcc} prints the error message
6587 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6588 To resolve this you either need to put @file{cpp0} and the other compiler
6589 components where @command{gcc} expects to find them, or you can set the environment
6590 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6591 Don't forget the trailing @samp{/}.
6592 @xref{Environment Variables}.
6594 @item -print-sysroot
6595 @opindex print-sysroot
6596 Print the target sysroot directory that is used during
6597 compilation.  This is the target sysroot specified either at configure
6598 time or using the @option{--sysroot} option, possibly with an extra
6599 suffix that depends on compilation options.  If no target sysroot is
6600 specified, the option prints nothing.
6602 @item -print-sysroot-headers-suffix
6603 @opindex print-sysroot-headers-suffix
6604 Print the suffix added to the target sysroot when searching for
6605 headers, or give an error if the compiler is not configured with such
6606 a suffix---and don't do anything else.
6608 @item -dumpmachine
6609 @opindex dumpmachine
6610 Print the compiler's target machine (for example,
6611 @samp{i686-pc-linux-gnu})---and don't do anything else.
6613 @item -dumpversion
6614 @opindex dumpversion
6615 Print the compiler version (for example, @samp{3.0})---and don't do
6616 anything else.
6618 @item -dumpspecs
6619 @opindex dumpspecs
6620 Print the compiler's built-in specs---and don't do anything else.  (This
6621 is used when GCC itself is being built.)  @xref{Spec Files}.
6623 @item -fno-eliminate-unused-debug-types
6624 @opindex feliminate-unused-debug-types
6625 @opindex fno-eliminate-unused-debug-types
6626 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6627 output for types that are nowhere used in the source file being compiled.
6628 Sometimes it is useful to have GCC emit debugging
6629 information for all types declared in a compilation
6630 unit, regardless of whether or not they are actually used
6631 in that compilation unit, for example 
6632 if, in the debugger, you want to cast a value to a type that is
6633 not actually used in your program (but is declared).  More often,
6634 however, this results in a significant amount of wasted space.
6635 @end table
6637 @node Optimize Options
6638 @section Options That Control Optimization
6639 @cindex optimize options
6640 @cindex options, optimization
6642 These options control various sorts of optimizations.
6644 Without any optimization option, the compiler's goal is to reduce the
6645 cost of compilation and to make debugging produce the expected
6646 results.  Statements are independent: if you stop the program with a
6647 breakpoint between statements, you can then assign a new value to any
6648 variable or change the program counter to any other statement in the
6649 function and get exactly the results you expect from the source
6650 code.
6652 Turning on optimization flags makes the compiler attempt to improve
6653 the performance and/or code size at the expense of compilation time
6654 and possibly the ability to debug the program.
6656 The compiler performs optimization based on the knowledge it has of the
6657 program.  Compiling multiple files at once to a single output file mode allows
6658 the compiler to use information gained from all of the files when compiling
6659 each of them.
6661 Not all optimizations are controlled directly by a flag.  Only
6662 optimizations that have a flag are listed in this section.
6664 Most optimizations are only enabled if an @option{-O} level is set on
6665 the command line.  Otherwise they are disabled, even if individual
6666 optimization flags are specified.
6668 Depending on the target and how GCC was configured, a slightly different
6669 set of optimizations may be enabled at each @option{-O} level than
6670 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6671 to find out the exact set of optimizations that are enabled at each level.
6672 @xref{Overall Options}, for examples.
6674 @table @gcctabopt
6675 @item -O
6676 @itemx -O1
6677 @opindex O
6678 @opindex O1
6679 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6680 more memory for a large function.
6682 With @option{-O}, the compiler tries to reduce code size and execution
6683 time, without performing any optimizations that take a great deal of
6684 compilation time.
6686 @option{-O} turns on the following optimization flags:
6687 @gccoptlist{
6688 -fauto-inc-dec @gol
6689 -fcompare-elim @gol
6690 -fcprop-registers @gol
6691 -fdce @gol
6692 -fdefer-pop @gol
6693 -fdelayed-branch @gol
6694 -fdse @gol
6695 -fguess-branch-probability @gol
6696 -fif-conversion2 @gol
6697 -fif-conversion @gol
6698 -fipa-pure-const @gol
6699 -fipa-profile @gol
6700 -fipa-reference @gol
6701 -fmerge-constants
6702 -fsplit-wide-types @gol
6703 -ftree-bit-ccp @gol
6704 -ftree-builtin-call-dce @gol
6705 -ftree-ccp @gol
6706 -ftree-ch @gol
6707 -ftree-copyrename @gol
6708 -ftree-dce @gol
6709 -ftree-dominator-opts @gol
6710 -ftree-dse @gol
6711 -ftree-forwprop @gol
6712 -ftree-fre @gol
6713 -ftree-phiprop @gol
6714 -ftree-slsr @gol
6715 -ftree-sra @gol
6716 -ftree-pta @gol
6717 -ftree-ter @gol
6718 -funit-at-a-time}
6720 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6721 where doing so does not interfere with debugging.
6723 @item -O2
6724 @opindex O2
6725 Optimize even more.  GCC performs nearly all supported optimizations
6726 that do not involve a space-speed tradeoff.
6727 As compared to @option{-O}, this option increases both compilation time
6728 and the performance of the generated code.
6730 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6731 also turns on the following optimization flags:
6732 @gccoptlist{-fthread-jumps @gol
6733 -falign-functions  -falign-jumps @gol
6734 -falign-loops  -falign-labels @gol
6735 -fcaller-saves @gol
6736 -fcrossjumping @gol
6737 -fcse-follow-jumps  -fcse-skip-blocks @gol
6738 -fdelete-null-pointer-checks @gol
6739 -fdevirtualize -fdevirtualize-speculatively @gol
6740 -fexpensive-optimizations @gol
6741 -fgcse  -fgcse-lm  @gol
6742 -fhoist-adjacent-loads @gol
6743 -finline-small-functions @gol
6744 -findirect-inlining @gol
6745 -fipa-sra @gol
6746 -fisolate-erroneous-paths @gol
6747 -foptimize-sibling-calls @gol
6748 -fpartial-inlining @gol
6749 -fpeephole2 @gol
6750 -freorder-blocks  -freorder-functions @gol
6751 -frerun-cse-after-loop  @gol
6752 -fsched-interblock  -fsched-spec @gol
6753 -fschedule-insns  -fschedule-insns2 @gol
6754 -fstrict-aliasing -fstrict-overflow @gol
6755 -ftree-switch-conversion -ftree-tail-merge @gol
6756 -ftree-pre @gol
6757 -ftree-vrp}
6759 Please note the warning under @option{-fgcse} about
6760 invoking @option{-O2} on programs that use computed gotos.
6762 @item -O3
6763 @opindex O3
6764 Optimize yet more.  @option{-O3} turns on all optimizations specified
6765 by @option{-O2} and also turns on the @option{-finline-functions},
6766 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6767 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
6768 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
6769 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6771 @item -O0
6772 @opindex O0
6773 Reduce compilation time and make debugging produce the expected
6774 results.  This is the default.
6776 @item -Os
6777 @opindex Os
6778 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6779 do not typically increase code size.  It also performs further
6780 optimizations designed to reduce code size.
6782 @option{-Os} disables the following optimization flags:
6783 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6784 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6785 -fprefetch-loop-arrays}
6787 @item -Ofast
6788 @opindex Ofast
6789 Disregard strict standards compliance.  @option{-Ofast} enables all
6790 @option{-O3} optimizations.  It also enables optimizations that are not
6791 valid for all standard-compliant programs.
6792 It turns on @option{-ffast-math} and the Fortran-specific
6793 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6795 @item -Og
6796 @opindex Og
6797 Optimize debugging experience.  @option{-Og} enables optimizations
6798 that do not interfere with debugging. It should be the optimization
6799 level of choice for the standard edit-compile-debug cycle, offering
6800 a reasonable level of optimization while maintaining fast compilation
6801 and a good debugging experience.
6803 If you use multiple @option{-O} options, with or without level numbers,
6804 the last such option is the one that is effective.
6805 @end table
6807 Options of the form @option{-f@var{flag}} specify machine-independent
6808 flags.  Most flags have both positive and negative forms; the negative
6809 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6810 below, only one of the forms is listed---the one you typically 
6811 use.  You can figure out the other form by either removing @samp{no-}
6812 or adding it.
6814 The following options control specific optimizations.  They are either
6815 activated by @option{-O} options or are related to ones that are.  You
6816 can use the following flags in the rare cases when ``fine-tuning'' of
6817 optimizations to be performed is desired.
6819 @table @gcctabopt
6820 @item -fno-defer-pop
6821 @opindex fno-defer-pop
6822 Always pop the arguments to each function call as soon as that function
6823 returns.  For machines that must pop arguments after a function call,
6824 the compiler normally lets arguments accumulate on the stack for several
6825 function calls and pops them all at once.
6827 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6829 @item -fforward-propagate
6830 @opindex fforward-propagate
6831 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6832 instructions and checks if the result can be simplified.  If loop unrolling
6833 is active, two passes are performed and the second is scheduled after
6834 loop unrolling.
6836 This option is enabled by default at optimization levels @option{-O},
6837 @option{-O2}, @option{-O3}, @option{-Os}.
6839 @item -ffp-contract=@var{style}
6840 @opindex ffp-contract
6841 @option{-ffp-contract=off} disables floating-point expression contraction.
6842 @option{-ffp-contract=fast} enables floating-point expression contraction
6843 such as forming of fused multiply-add operations if the target has
6844 native support for them.
6845 @option{-ffp-contract=on} enables floating-point expression contraction
6846 if allowed by the language standard.  This is currently not implemented
6847 and treated equal to @option{-ffp-contract=off}.
6849 The default is @option{-ffp-contract=fast}.
6851 @item -fomit-frame-pointer
6852 @opindex fomit-frame-pointer
6853 Don't keep the frame pointer in a register for functions that
6854 don't need one.  This avoids the instructions to save, set up and
6855 restore frame pointers; it also makes an extra register available
6856 in many functions.  @strong{It also makes debugging impossible on
6857 some machines.}
6859 On some machines, such as the VAX, this flag has no effect, because
6860 the standard calling sequence automatically handles the frame pointer
6861 and nothing is saved by pretending it doesn't exist.  The
6862 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6863 whether a target machine supports this flag.  @xref{Registers,,Register
6864 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6866 Starting with GCC version 4.6, the default setting (when not optimizing for
6867 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6868 @option{-fomit-frame-pointer}.  The default can be reverted to
6869 @option{-fno-omit-frame-pointer} by configuring GCC with the
6870 @option{--enable-frame-pointer} configure option.
6872 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6874 @item -foptimize-sibling-calls
6875 @opindex foptimize-sibling-calls
6876 Optimize sibling and tail recursive calls.
6878 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6880 @item -fno-inline
6881 @opindex fno-inline
6882 Do not expand any functions inline apart from those marked with
6883 the @code{always_inline} attribute.  This is the default when not
6884 optimizing.
6886 Single functions can be exempted from inlining by marking them
6887 with the @code{noinline} attribute.
6889 @item -finline-small-functions
6890 @opindex finline-small-functions
6891 Integrate functions into their callers when their body is smaller than expected
6892 function call code (so overall size of program gets smaller).  The compiler
6893 heuristically decides which functions are simple enough to be worth integrating
6894 in this way.  This inlining applies to all functions, even those not declared
6895 inline.
6897 Enabled at level @option{-O2}.
6899 @item -findirect-inlining
6900 @opindex findirect-inlining
6901 Inline also indirect calls that are discovered to be known at compile
6902 time thanks to previous inlining.  This option has any effect only
6903 when inlining itself is turned on by the @option{-finline-functions}
6904 or @option{-finline-small-functions} options.
6906 Enabled at level @option{-O2}.
6908 @item -finline-functions
6909 @opindex finline-functions
6910 Consider all functions for inlining, even if they are not declared inline.
6911 The compiler heuristically decides which functions are worth integrating
6912 in this way.
6914 If all calls to a given function are integrated, and the function is
6915 declared @code{static}, then the function is normally not output as
6916 assembler code in its own right.
6918 Enabled at level @option{-O3}.
6920 @item -finline-functions-called-once
6921 @opindex finline-functions-called-once
6922 Consider all @code{static} functions called once for inlining into their
6923 caller even if they are not marked @code{inline}.  If a call to a given
6924 function is integrated, then the function is not output as assembler code
6925 in its own right.
6927 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6929 @item -fearly-inlining
6930 @opindex fearly-inlining
6931 Inline functions marked by @code{always_inline} and functions whose body seems
6932 smaller than the function call overhead early before doing
6933 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6934 makes profiling significantly cheaper and usually inlining faster on programs
6935 having large chains of nested wrapper functions.
6937 Enabled by default.
6939 @item -fipa-sra
6940 @opindex fipa-sra
6941 Perform interprocedural scalar replacement of aggregates, removal of
6942 unused parameters and replacement of parameters passed by reference
6943 by parameters passed by value.
6945 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6947 @item -finline-limit=@var{n}
6948 @opindex finline-limit
6949 By default, GCC limits the size of functions that can be inlined.  This flag
6950 allows coarse control of this limit.  @var{n} is the size of functions that
6951 can be inlined in number of pseudo instructions.
6953 Inlining is actually controlled by a number of parameters, which may be
6954 specified individually by using @option{--param @var{name}=@var{value}}.
6955 The @option{-finline-limit=@var{n}} option sets some of these parameters
6956 as follows:
6958 @table @gcctabopt
6959 @item max-inline-insns-single
6960 is set to @var{n}/2.
6961 @item max-inline-insns-auto
6962 is set to @var{n}/2.
6963 @end table
6965 See below for a documentation of the individual
6966 parameters controlling inlining and for the defaults of these parameters.
6968 @emph{Note:} there may be no value to @option{-finline-limit} that results
6969 in default behavior.
6971 @emph{Note:} pseudo instruction represents, in this particular context, an
6972 abstract measurement of function's size.  In no way does it represent a count
6973 of assembly instructions and as such its exact meaning might change from one
6974 release to an another.
6976 @item -fno-keep-inline-dllexport
6977 @opindex -fno-keep-inline-dllexport
6978 This is a more fine-grained version of @option{-fkeep-inline-functions},
6979 which applies only to functions that are declared using the @code{dllexport}
6980 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6981 Functions}.)
6983 @item -fkeep-inline-functions
6984 @opindex fkeep-inline-functions
6985 In C, emit @code{static} functions that are declared @code{inline}
6986 into the object file, even if the function has been inlined into all
6987 of its callers.  This switch does not affect functions using the
6988 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6989 inline functions into the object file.
6991 @item -fkeep-static-consts
6992 @opindex fkeep-static-consts
6993 Emit variables declared @code{static const} when optimization isn't turned
6994 on, even if the variables aren't referenced.
6996 GCC enables this option by default.  If you want to force the compiler to
6997 check if a variable is referenced, regardless of whether or not
6998 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7000 @item -fmerge-constants
7001 @opindex fmerge-constants
7002 Attempt to merge identical constants (string constants and floating-point
7003 constants) across compilation units.
7005 This option is the default for optimized compilation if the assembler and
7006 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7007 behavior.
7009 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7011 @item -fmerge-all-constants
7012 @opindex fmerge-all-constants
7013 Attempt to merge identical constants and identical variables.
7015 This option implies @option{-fmerge-constants}.  In addition to
7016 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7017 arrays or initialized constant variables with integral or floating-point
7018 types.  Languages like C or C++ require each variable, including multiple
7019 instances of the same variable in recursive calls, to have distinct locations,
7020 so using this option results in non-conforming
7021 behavior.
7023 @item -fmodulo-sched
7024 @opindex fmodulo-sched
7025 Perform swing modulo scheduling immediately before the first scheduling
7026 pass.  This pass looks at innermost loops and reorders their
7027 instructions by overlapping different iterations.
7029 @item -fmodulo-sched-allow-regmoves
7030 @opindex fmodulo-sched-allow-regmoves
7031 Perform more aggressive SMS-based modulo scheduling with register moves
7032 allowed.  By setting this flag certain anti-dependences edges are
7033 deleted, which triggers the generation of reg-moves based on the
7034 life-range analysis.  This option is effective only with
7035 @option{-fmodulo-sched} enabled.
7037 @item -fno-branch-count-reg
7038 @opindex fno-branch-count-reg
7039 Do not use ``decrement and branch'' instructions on a count register,
7040 but instead generate a sequence of instructions that decrement a
7041 register, compare it against zero, then branch based upon the result.
7042 This option is only meaningful on architectures that support such
7043 instructions, which include x86, PowerPC, IA-64 and S/390.
7045 The default is @option{-fbranch-count-reg}.
7047 @item -fno-function-cse
7048 @opindex fno-function-cse
7049 Do not put function addresses in registers; make each instruction that
7050 calls a constant function contain the function's address explicitly.
7052 This option results in less efficient code, but some strange hacks
7053 that alter the assembler output may be confused by the optimizations
7054 performed when this option is not used.
7056 The default is @option{-ffunction-cse}
7058 @item -fno-zero-initialized-in-bss
7059 @opindex fno-zero-initialized-in-bss
7060 If the target supports a BSS section, GCC by default puts variables that
7061 are initialized to zero into BSS@.  This can save space in the resulting
7062 code.
7064 This option turns off this behavior because some programs explicitly
7065 rely on variables going to the data section---e.g., so that the
7066 resulting executable can find the beginning of that section and/or make
7067 assumptions based on that.
7069 The default is @option{-fzero-initialized-in-bss}.
7071 @item -fthread-jumps
7072 @opindex fthread-jumps
7073 Perform optimizations that check to see if a jump branches to a
7074 location where another comparison subsumed by the first is found.  If
7075 so, the first branch is redirected to either the destination of the
7076 second branch or a point immediately following it, depending on whether
7077 the condition is known to be true or false.
7079 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7081 @item -fsplit-wide-types
7082 @opindex fsplit-wide-types
7083 When using a type that occupies multiple registers, such as @code{long
7084 long} on a 32-bit system, split the registers apart and allocate them
7085 independently.  This normally generates better code for those types,
7086 but may make debugging more difficult.
7088 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7089 @option{-Os}.
7091 @item -fcse-follow-jumps
7092 @opindex fcse-follow-jumps
7093 In common subexpression elimination (CSE), scan through jump instructions
7094 when the target of the jump is not reached by any other path.  For
7095 example, when CSE encounters an @code{if} statement with an
7096 @code{else} clause, CSE follows the jump when the condition
7097 tested is false.
7099 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7101 @item -fcse-skip-blocks
7102 @opindex fcse-skip-blocks
7103 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7104 follow jumps that conditionally skip over blocks.  When CSE
7105 encounters a simple @code{if} statement with no else clause,
7106 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7107 body of the @code{if}.
7109 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7111 @item -frerun-cse-after-loop
7112 @opindex frerun-cse-after-loop
7113 Re-run common subexpression elimination after loop optimizations are
7114 performed.
7116 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7118 @item -fgcse
7119 @opindex fgcse
7120 Perform a global common subexpression elimination pass.
7121 This pass also performs global constant and copy propagation.
7123 @emph{Note:} When compiling a program using computed gotos, a GCC
7124 extension, you may get better run-time performance if you disable
7125 the global common subexpression elimination pass by adding
7126 @option{-fno-gcse} to the command line.
7128 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7130 @item -fgcse-lm
7131 @opindex fgcse-lm
7132 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7133 attempts to move loads that are only killed by stores into themselves.  This
7134 allows a loop containing a load/store sequence to be changed to a load outside
7135 the loop, and a copy/store within the loop.
7137 Enabled by default when @option{-fgcse} is enabled.
7139 @item -fgcse-sm
7140 @opindex fgcse-sm
7141 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7142 global common subexpression elimination.  This pass attempts to move
7143 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7144 loops containing a load/store sequence can be changed to a load before
7145 the loop and a store after the loop.
7147 Not enabled at any optimization level.
7149 @item -fgcse-las
7150 @opindex fgcse-las
7151 When @option{-fgcse-las} is enabled, the global common subexpression
7152 elimination pass eliminates redundant loads that come after stores to the
7153 same memory location (both partial and full redundancies).
7155 Not enabled at any optimization level.
7157 @item -fgcse-after-reload
7158 @opindex fgcse-after-reload
7159 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7160 pass is performed after reload.  The purpose of this pass is to clean up
7161 redundant spilling.
7163 @item -faggressive-loop-optimizations
7164 @opindex faggressive-loop-optimizations
7165 This option tells the loop optimizer to use language constraints to
7166 derive bounds for the number of iterations of a loop.  This assumes that
7167 loop code does not invoke undefined behavior by for example causing signed
7168 integer overflows or out-of-bound array accesses.  The bounds for the
7169 number of iterations of a loop are used to guide loop unrolling and peeling
7170 and loop exit test optimizations.
7171 This option is enabled by default.
7173 @item -funsafe-loop-optimizations
7174 @opindex funsafe-loop-optimizations
7175 This option tells the loop optimizer to assume that loop indices do not
7176 overflow, and that loops with nontrivial exit condition are not
7177 infinite.  This enables a wider range of loop optimizations even if
7178 the loop optimizer itself cannot prove that these assumptions are valid.
7179 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7180 if it finds this kind of loop.
7182 @item -fcrossjumping
7183 @opindex fcrossjumping
7184 Perform cross-jumping transformation.
7185 This transformation unifies equivalent code and saves code size.  The
7186 resulting code may or may not perform better than without cross-jumping.
7188 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7190 @item -fauto-inc-dec
7191 @opindex fauto-inc-dec
7192 Combine increments or decrements of addresses with memory accesses.
7193 This pass is always skipped on architectures that do not have
7194 instructions to support this.  Enabled by default at @option{-O} and
7195 higher on architectures that support this.
7197 @item -fdce
7198 @opindex fdce
7199 Perform dead code elimination (DCE) on RTL@.
7200 Enabled by default at @option{-O} and higher.
7202 @item -fdse
7203 @opindex fdse
7204 Perform dead store elimination (DSE) on RTL@.
7205 Enabled by default at @option{-O} and higher.
7207 @item -fif-conversion
7208 @opindex fif-conversion
7209 Attempt to transform conditional jumps into branch-less equivalents.  This
7210 includes use of conditional moves, min, max, set flags and abs instructions, and
7211 some tricks doable by standard arithmetics.  The use of conditional execution
7212 on chips where it is available is controlled by @code{if-conversion2}.
7214 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7216 @item -fif-conversion2
7217 @opindex fif-conversion2
7218 Use conditional execution (where available) to transform conditional jumps into
7219 branch-less equivalents.
7221 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7223 @item -fdelete-null-pointer-checks
7224 @opindex fdelete-null-pointer-checks
7225 Assume that programs cannot safely dereference null pointers, and that
7226 no code or data element resides there.  This enables simple constant
7227 folding optimizations at all optimization levels.  In addition, other
7228 optimization passes in GCC use this flag to control global dataflow
7229 analyses that eliminate useless checks for null pointers; these assume
7230 that if a pointer is checked after it has already been dereferenced,
7231 it cannot be null.
7233 Note however that in some environments this assumption is not true.
7234 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7235 for programs that depend on that behavior.
7237 Some targets, especially embedded ones, disable this option at all levels.
7238 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7239 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7240 are enabled independently at different optimization levels.
7242 @item -fdevirtualize
7243 @opindex fdevirtualize
7244 Attempt to convert calls to virtual functions to direct calls.  This
7245 is done both within a procedure and interprocedurally as part of
7246 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7247 propagation (@option{-fipa-cp}).
7248 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7250 @item -fdevirtualize-speculatively
7251 @opindex fdevirtualize-speculatively
7252 Attempt to convert calls to virtual functions to speculative direct calls.
7253 Based on the analysis of the type inheritance graph, determine for a given call
7254 the set of likely targets. If the set is small, preferably of size 1, change
7255 the call into an conditional deciding on direct and indirect call.  The
7256 speculative calls enable more optimizations, such as inlining.  When they seem
7257 useless after further optimization, they are converted back into original form.
7259 @item -fexpensive-optimizations
7260 @opindex fexpensive-optimizations
7261 Perform a number of minor optimizations that are relatively expensive.
7263 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7265 @item -free
7266 @opindex free
7267 Attempt to remove redundant extension instructions.  This is especially
7268 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7269 registers after writing to their lower 32-bit half.
7271 Enabled for x86 at levels @option{-O2}, @option{-O3}.
7273 @item -flive-range-shrinkage
7274 @opindex flive-range-shrinkage
7275 Attempt to decrease register pressure through register live range
7276 shrinkage.  This is helpful for fast processors with small or moderate
7277 size register sets.
7279 @item -fira-algorithm=@var{algorithm}
7280 Use the specified coloring algorithm for the integrated register
7281 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7282 specifies Chow's priority coloring, or @samp{CB}, which specifies
7283 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7284 for all architectures, but for those targets that do support it, it is
7285 the default because it generates better code.
7287 @item -fira-region=@var{region}
7288 Use specified regions for the integrated register allocator.  The
7289 @var{region} argument should be one of the following:
7291 @table @samp
7293 @item all
7294 Use all loops as register allocation regions.
7295 This can give the best results for machines with a small and/or
7296 irregular register set.
7298 @item mixed
7299 Use all loops except for loops with small register pressure 
7300 as the regions.  This value usually gives
7301 the best results in most cases and for most architectures,
7302 and is enabled by default when compiling with optimization for speed
7303 (@option{-O}, @option{-O2}, @dots{}).
7305 @item one
7306 Use all functions as a single region.  
7307 This typically results in the smallest code size, and is enabled by default for
7308 @option{-Os} or @option{-O0}.
7310 @end table
7312 @item -fira-hoist-pressure
7313 @opindex fira-hoist-pressure
7314 Use IRA to evaluate register pressure in the code hoisting pass for
7315 decisions to hoist expressions.  This option usually results in smaller
7316 code, but it can slow the compiler down.
7318 This option is enabled at level @option{-Os} for all targets.
7320 @item -fira-loop-pressure
7321 @opindex fira-loop-pressure
7322 Use IRA to evaluate register pressure in loops for decisions to move
7323 loop invariants.  This option usually results in generation
7324 of faster and smaller code on machines with large register files (>= 32
7325 registers), but it can slow the compiler down.
7327 This option is enabled at level @option{-O3} for some targets.
7329 @item -fno-ira-share-save-slots
7330 @opindex fno-ira-share-save-slots
7331 Disable sharing of stack slots used for saving call-used hard
7332 registers living through a call.  Each hard register gets a
7333 separate stack slot, and as a result function stack frames are
7334 larger.
7336 @item -fno-ira-share-spill-slots
7337 @opindex fno-ira-share-spill-slots
7338 Disable sharing of stack slots allocated for pseudo-registers.  Each
7339 pseudo-register that does not get a hard register gets a separate
7340 stack slot, and as a result function stack frames are larger.
7342 @item -fira-verbose=@var{n}
7343 @opindex fira-verbose
7344 Control the verbosity of the dump file for the integrated register allocator.
7345 The default value is 5.  If the value @var{n} is greater or equal to 10,
7346 the dump output is sent to stderr using the same format as @var{n} minus 10.
7348 @item -fdelayed-branch
7349 @opindex fdelayed-branch
7350 If supported for the target machine, attempt to reorder instructions
7351 to exploit instruction slots available after delayed branch
7352 instructions.
7354 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7356 @item -fschedule-insns
7357 @opindex fschedule-insns
7358 If supported for the target machine, attempt to reorder instructions to
7359 eliminate execution stalls due to required data being unavailable.  This
7360 helps machines that have slow floating point or memory load instructions
7361 by allowing other instructions to be issued until the result of the load
7362 or floating-point instruction is required.
7364 Enabled at levels @option{-O2}, @option{-O3}.
7366 @item -fschedule-insns2
7367 @opindex fschedule-insns2
7368 Similar to @option{-fschedule-insns}, but requests an additional pass of
7369 instruction scheduling after register allocation has been done.  This is
7370 especially useful on machines with a relatively small number of
7371 registers and where memory load instructions take more than one cycle.
7373 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7375 @item -fno-sched-interblock
7376 @opindex fno-sched-interblock
7377 Don't schedule instructions across basic blocks.  This is normally
7378 enabled by default when scheduling before register allocation, i.e.@:
7379 with @option{-fschedule-insns} or at @option{-O2} or higher.
7381 @item -fno-sched-spec
7382 @opindex fno-sched-spec
7383 Don't allow speculative motion of non-load instructions.  This is normally
7384 enabled by default when scheduling before register allocation, i.e.@:
7385 with @option{-fschedule-insns} or at @option{-O2} or higher.
7387 @item -fsched-pressure
7388 @opindex fsched-pressure
7389 Enable register pressure sensitive insn scheduling before register
7390 allocation.  This only makes sense when scheduling before register
7391 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7392 @option{-O2} or higher.  Usage of this option can improve the
7393 generated code and decrease its size by preventing register pressure
7394 increase above the number of available hard registers and subsequent
7395 spills in register allocation.
7397 @item -fsched-spec-load
7398 @opindex fsched-spec-load
7399 Allow speculative motion of some load instructions.  This only makes
7400 sense when scheduling before register allocation, i.e.@: with
7401 @option{-fschedule-insns} or at @option{-O2} or higher.
7403 @item -fsched-spec-load-dangerous
7404 @opindex fsched-spec-load-dangerous
7405 Allow speculative motion of more load instructions.  This only makes
7406 sense when scheduling before register allocation, i.e.@: with
7407 @option{-fschedule-insns} or at @option{-O2} or higher.
7409 @item -fsched-stalled-insns
7410 @itemx -fsched-stalled-insns=@var{n}
7411 @opindex fsched-stalled-insns
7412 Define how many insns (if any) can be moved prematurely from the queue
7413 of stalled insns into the ready list during the second scheduling pass.
7414 @option{-fno-sched-stalled-insns} means that no insns are moved
7415 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7416 on how many queued insns can be moved prematurely.
7417 @option{-fsched-stalled-insns} without a value is equivalent to
7418 @option{-fsched-stalled-insns=1}.
7420 @item -fsched-stalled-insns-dep
7421 @itemx -fsched-stalled-insns-dep=@var{n}
7422 @opindex fsched-stalled-insns-dep
7423 Define how many insn groups (cycles) are examined for a dependency
7424 on a stalled insn that is a candidate for premature removal from the queue
7425 of stalled insns.  This has an effect only during the second scheduling pass,
7426 and only if @option{-fsched-stalled-insns} is used.
7427 @option{-fno-sched-stalled-insns-dep} is equivalent to
7428 @option{-fsched-stalled-insns-dep=0}.
7429 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7430 @option{-fsched-stalled-insns-dep=1}.
7432 @item -fsched2-use-superblocks
7433 @opindex fsched2-use-superblocks
7434 When scheduling after register allocation, use superblock scheduling.
7435 This allows motion across basic block boundaries,
7436 resulting in faster schedules.  This option is experimental, as not all machine
7437 descriptions used by GCC model the CPU closely enough to avoid unreliable
7438 results from the algorithm.
7440 This only makes sense when scheduling after register allocation, i.e.@: with
7441 @option{-fschedule-insns2} or at @option{-O2} or higher.
7443 @item -fsched-group-heuristic
7444 @opindex fsched-group-heuristic
7445 Enable the group heuristic in the scheduler.  This heuristic favors
7446 the instruction that belongs to a schedule group.  This is enabled
7447 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7448 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7450 @item -fsched-critical-path-heuristic
7451 @opindex fsched-critical-path-heuristic
7452 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7453 instructions on the critical path.  This is enabled by default when
7454 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7455 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7457 @item -fsched-spec-insn-heuristic
7458 @opindex fsched-spec-insn-heuristic
7459 Enable the speculative instruction heuristic in the scheduler.  This
7460 heuristic favors speculative instructions with greater dependency weakness.
7461 This is enabled by default when scheduling is enabled, i.e.@:
7462 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7463 or at @option{-O2} or higher.
7465 @item -fsched-rank-heuristic
7466 @opindex fsched-rank-heuristic
7467 Enable the rank heuristic in the scheduler.  This heuristic favors
7468 the instruction belonging to a basic block with greater size or frequency.
7469 This is enabled by default when scheduling is enabled, i.e.@:
7470 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7471 at @option{-O2} or higher.
7473 @item -fsched-last-insn-heuristic
7474 @opindex fsched-last-insn-heuristic
7475 Enable the last-instruction heuristic in the scheduler.  This heuristic
7476 favors the instruction that is less dependent on the last instruction
7477 scheduled.  This is enabled by default when scheduling is enabled,
7478 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7479 at @option{-O2} or higher.
7481 @item -fsched-dep-count-heuristic
7482 @opindex fsched-dep-count-heuristic
7483 Enable the dependent-count heuristic in the scheduler.  This heuristic
7484 favors the instruction that has more instructions depending on it.
7485 This is enabled by default when scheduling is enabled, i.e.@:
7486 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7487 at @option{-O2} or higher.
7489 @item -freschedule-modulo-scheduled-loops
7490 @opindex freschedule-modulo-scheduled-loops
7491 Modulo scheduling is performed before traditional scheduling.  If a loop
7492 is modulo scheduled, later scheduling passes may change its schedule.  
7493 Use this option to control that behavior.
7495 @item -fselective-scheduling
7496 @opindex fselective-scheduling
7497 Schedule instructions using selective scheduling algorithm.  Selective
7498 scheduling runs instead of the first scheduler pass.
7500 @item -fselective-scheduling2
7501 @opindex fselective-scheduling2
7502 Schedule instructions using selective scheduling algorithm.  Selective
7503 scheduling runs instead of the second scheduler pass.
7505 @item -fsel-sched-pipelining
7506 @opindex fsel-sched-pipelining
7507 Enable software pipelining of innermost loops during selective scheduling.
7508 This option has no effect unless one of @option{-fselective-scheduling} or
7509 @option{-fselective-scheduling2} is turned on.
7511 @item -fsel-sched-pipelining-outer-loops
7512 @opindex fsel-sched-pipelining-outer-loops
7513 When pipelining loops during selective scheduling, also pipeline outer loops.
7514 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7516 @item -fshrink-wrap
7517 @opindex fshrink-wrap
7518 Emit function prologues only before parts of the function that need it,
7519 rather than at the top of the function.  This flag is enabled by default at
7520 @option{-O} and higher.
7522 @item -fcaller-saves
7523 @opindex fcaller-saves
7524 Enable allocation of values to registers that are clobbered by
7525 function calls, by emitting extra instructions to save and restore the
7526 registers around such calls.  Such allocation is done only when it
7527 seems to result in better code.
7529 This option is always enabled by default on certain machines, usually
7530 those which have no call-preserved registers to use instead.
7532 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7534 @item -fcombine-stack-adjustments
7535 @opindex fcombine-stack-adjustments
7536 Tracks stack adjustments (pushes and pops) and stack memory references
7537 and then tries to find ways to combine them.
7539 Enabled by default at @option{-O1} and higher.
7541 @item -fconserve-stack
7542 @opindex fconserve-stack
7543 Attempt to minimize stack usage.  The compiler attempts to use less
7544 stack space, even if that makes the program slower.  This option
7545 implies setting the @option{large-stack-frame} parameter to 100
7546 and the @option{large-stack-frame-growth} parameter to 400.
7548 @item -ftree-reassoc
7549 @opindex ftree-reassoc
7550 Perform reassociation on trees.  This flag is enabled by default
7551 at @option{-O} and higher.
7553 @item -ftree-pre
7554 @opindex ftree-pre
7555 Perform partial redundancy elimination (PRE) on trees.  This flag is
7556 enabled by default at @option{-O2} and @option{-O3}.
7558 @item -ftree-partial-pre
7559 @opindex ftree-partial-pre
7560 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7561 enabled by default at @option{-O3}.
7563 @item -ftree-forwprop
7564 @opindex ftree-forwprop
7565 Perform forward propagation on trees.  This flag is enabled by default
7566 at @option{-O} and higher.
7568 @item -ftree-fre
7569 @opindex ftree-fre
7570 Perform full redundancy elimination (FRE) on trees.  The difference
7571 between FRE and PRE is that FRE only considers expressions
7572 that are computed on all paths leading to the redundant computation.
7573 This analysis is faster than PRE, though it exposes fewer redundancies.
7574 This flag is enabled by default at @option{-O} and higher.
7576 @item -ftree-phiprop
7577 @opindex ftree-phiprop
7578 Perform hoisting of loads from conditional pointers on trees.  This
7579 pass is enabled by default at @option{-O} and higher.
7581 @item -fhoist-adjacent-loads
7582 @opindex hoist-adjacent-loads
7583 Speculatively hoist loads from both branches of an if-then-else if the
7584 loads are from adjacent locations in the same structure and the target
7585 architecture has a conditional move instruction.  This flag is enabled
7586 by default at @option{-O2} and higher.
7588 @item -ftree-copy-prop
7589 @opindex ftree-copy-prop
7590 Perform copy propagation on trees.  This pass eliminates unnecessary
7591 copy operations.  This flag is enabled by default at @option{-O} and
7592 higher.
7594 @item -fipa-pure-const
7595 @opindex fipa-pure-const
7596 Discover which functions are pure or constant.
7597 Enabled by default at @option{-O} and higher.
7599 @item -fipa-reference
7600 @opindex fipa-reference
7601 Discover which static variables do not escape the
7602 compilation unit.
7603 Enabled by default at @option{-O} and higher.
7605 @item -fipa-pta
7606 @opindex fipa-pta
7607 Perform interprocedural pointer analysis and interprocedural modification
7608 and reference analysis.  This option can cause excessive memory and
7609 compile-time usage on large compilation units.  It is not enabled by
7610 default at any optimization level.
7612 @item -fipa-profile
7613 @opindex fipa-profile
7614 Perform interprocedural profile propagation.  The functions called only from
7615 cold functions are marked as cold. Also functions executed once (such as
7616 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7617 functions and loop less parts of functions executed once are then optimized for
7618 size.
7619 Enabled by default at @option{-O} and higher.
7621 @item -fipa-cp
7622 @opindex fipa-cp
7623 Perform interprocedural constant propagation.
7624 This optimization analyzes the program to determine when values passed
7625 to functions are constants and then optimizes accordingly.
7626 This optimization can substantially increase performance
7627 if the application has constants passed to functions.
7628 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7630 @item -fipa-cp-clone
7631 @opindex fipa-cp-clone
7632 Perform function cloning to make interprocedural constant propagation stronger.
7633 When enabled, interprocedural constant propagation performs function cloning
7634 when externally visible function can be called with constant arguments.
7635 Because this optimization can create multiple copies of functions,
7636 it may significantly increase code size
7637 (see @option{--param ipcp-unit-growth=@var{value}}).
7638 This flag is enabled by default at @option{-O3}.
7640 @item -fisolate-erroneous-paths
7641 Detect paths which trigger erroneous or undefined behaviour.  Isolate those
7642 paths from the main control flow and turn the statement with erroneous or
7643 undefined behaviour into a trap.
7645 @item -ftree-sink
7646 @opindex ftree-sink
7647 Perform forward store motion  on trees.  This flag is
7648 enabled by default at @option{-O} and higher.
7650 @item -ftree-bit-ccp
7651 @opindex ftree-bit-ccp
7652 Perform sparse conditional bit constant propagation on trees and propagate
7653 pointer alignment information.
7654 This pass only operates on local scalar variables and is enabled by default
7655 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7657 @item -ftree-ccp
7658 @opindex ftree-ccp
7659 Perform sparse conditional constant propagation (CCP) on trees.  This
7660 pass only operates on local scalar variables and is enabled by default
7661 at @option{-O} and higher.
7663 @item -ftree-switch-conversion
7664 Perform conversion of simple initializations in a switch to
7665 initializations from a scalar array.  This flag is enabled by default
7666 at @option{-O2} and higher.
7668 @item -ftree-tail-merge
7669 Look for identical code sequences.  When found, replace one with a jump to the
7670 other.  This optimization is known as tail merging or cross jumping.  This flag
7671 is enabled by default at @option{-O2} and higher.  The compilation time
7672 in this pass can
7673 be limited using @option{max-tail-merge-comparisons} parameter and
7674 @option{max-tail-merge-iterations} parameter.
7676 @item -ftree-dce
7677 @opindex ftree-dce
7678 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7679 default at @option{-O} and higher.
7681 @item -ftree-builtin-call-dce
7682 @opindex ftree-builtin-call-dce
7683 Perform conditional dead code elimination (DCE) for calls to built-in functions
7684 that may set @code{errno} but are otherwise side-effect free.  This flag is
7685 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7686 specified.
7688 @item -ftree-dominator-opts
7689 @opindex ftree-dominator-opts
7690 Perform a variety of simple scalar cleanups (constant/copy
7691 propagation, redundancy elimination, range propagation and expression
7692 simplification) based on a dominator tree traversal.  This also
7693 performs jump threading (to reduce jumps to jumps). This flag is
7694 enabled by default at @option{-O} and higher.
7696 @item -ftree-dse
7697 @opindex ftree-dse
7698 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7699 a memory location that is later overwritten by another store without
7700 any intervening loads.  In this case the earlier store can be deleted.  This
7701 flag is enabled by default at @option{-O} and higher.
7703 @item -ftree-ch
7704 @opindex ftree-ch
7705 Perform loop header copying on trees.  This is beneficial since it increases
7706 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7707 is enabled by default at @option{-O} and higher.  It is not enabled
7708 for @option{-Os}, since it usually increases code size.
7710 @item -ftree-loop-optimize
7711 @opindex ftree-loop-optimize
7712 Perform loop optimizations on trees.  This flag is enabled by default
7713 at @option{-O} and higher.
7715 @item -ftree-loop-linear
7716 @opindex ftree-loop-linear
7717 Perform loop interchange transformations on tree.  Same as
7718 @option{-floop-interchange}.  To use this code transformation, GCC has
7719 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7720 enable the Graphite loop transformation infrastructure.
7722 @item -floop-interchange
7723 @opindex floop-interchange
7724 Perform loop interchange transformations on loops.  Interchanging two
7725 nested loops switches the inner and outer loops.  For example, given a
7726 loop like:
7727 @smallexample
7728 DO J = 1, M
7729   DO I = 1, N
7730     A(J, I) = A(J, I) * C
7731   ENDDO
7732 ENDDO
7733 @end smallexample
7734 loop interchange transforms the loop as if it were written:
7735 @smallexample
7736 DO I = 1, N
7737   DO J = 1, M
7738     A(J, I) = A(J, I) * C
7739   ENDDO
7740 ENDDO
7741 @end smallexample
7742 which can be beneficial when @code{N} is larger than the caches,
7743 because in Fortran, the elements of an array are stored in memory
7744 contiguously by column, and the original loop iterates over rows,
7745 potentially creating at each access a cache miss.  This optimization
7746 applies to all the languages supported by GCC and is not limited to
7747 Fortran.  To use this code transformation, GCC has to be configured
7748 with @option{--with-ppl} and @option{--with-cloog} to enable the
7749 Graphite loop transformation infrastructure.
7751 @item -floop-strip-mine
7752 @opindex floop-strip-mine
7753 Perform loop strip mining transformations on loops.  Strip mining
7754 splits a loop into two nested loops.  The outer loop has strides
7755 equal to the strip size and the inner loop has strides of the
7756 original loop within a strip.  The strip length can be changed
7757 using the @option{loop-block-tile-size} parameter.  For example,
7758 given a loop like:
7759 @smallexample
7760 DO I = 1, N
7761   A(I) = A(I) + C
7762 ENDDO
7763 @end smallexample
7764 loop strip mining transforms the loop as if it were written:
7765 @smallexample
7766 DO II = 1, N, 51
7767   DO I = II, min (II + 50, N)
7768     A(I) = A(I) + C
7769   ENDDO
7770 ENDDO
7771 @end smallexample
7772 This optimization applies to all the languages supported by GCC and is
7773 not limited to Fortran.  To use this code transformation, GCC has to
7774 be configured with @option{--with-ppl} and @option{--with-cloog} to
7775 enable the Graphite loop transformation infrastructure.
7777 @item -floop-block
7778 @opindex floop-block
7779 Perform loop blocking transformations on loops.  Blocking strip mines
7780 each loop in the loop nest such that the memory accesses of the
7781 element loops fit inside caches.  The strip length can be changed
7782 using the @option{loop-block-tile-size} parameter.  For example, given
7783 a loop like:
7784 @smallexample
7785 DO I = 1, N
7786   DO J = 1, M
7787     A(J, I) = B(I) + C(J)
7788   ENDDO
7789 ENDDO
7790 @end smallexample
7791 loop blocking transforms the loop as if it were written:
7792 @smallexample
7793 DO II = 1, N, 51
7794   DO JJ = 1, M, 51
7795     DO I = II, min (II + 50, N)
7796       DO J = JJ, min (JJ + 50, M)
7797         A(J, I) = B(I) + C(J)
7798       ENDDO
7799     ENDDO
7800   ENDDO
7801 ENDDO
7802 @end smallexample
7803 which can be beneficial when @code{M} is larger than the caches,
7804 because the innermost loop iterates over a smaller amount of data
7805 which can be kept in the caches.  This optimization applies to all the
7806 languages supported by GCC and is not limited to Fortran.  To use this
7807 code transformation, GCC has to be configured with @option{--with-ppl}
7808 and @option{--with-cloog} to enable the Graphite loop transformation
7809 infrastructure.
7811 @item -fgraphite-identity
7812 @opindex fgraphite-identity
7813 Enable the identity transformation for graphite.  For every SCoP we generate
7814 the polyhedral representation and transform it back to gimple.  Using
7815 @option{-fgraphite-identity} we can check the costs or benefits of the
7816 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7817 are also performed by the code generator CLooG, like index splitting and
7818 dead code elimination in loops.
7820 @item -floop-nest-optimize
7821 @opindex floop-nest-optimize
7822 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7823 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7824 structure optimized for data-locality and parallelism.  This option
7825 is experimental.
7827 @item -floop-parallelize-all
7828 @opindex floop-parallelize-all
7829 Use the Graphite data dependence analysis to identify loops that can
7830 be parallelized.  Parallelize all the loops that can be analyzed to
7831 not contain loop carried dependences without checking that it is
7832 profitable to parallelize the loops.
7834 @item -fcheck-data-deps
7835 @opindex fcheck-data-deps
7836 Compare the results of several data dependence analyzers.  This option
7837 is used for debugging the data dependence analyzers.
7839 @item -ftree-loop-if-convert
7840 Attempt to transform conditional jumps in the innermost loops to
7841 branch-less equivalents.  The intent is to remove control-flow from
7842 the innermost loops in order to improve the ability of the
7843 vectorization pass to handle these loops.  This is enabled by default
7844 if vectorization is enabled.
7846 @item -ftree-loop-if-convert-stores
7847 Attempt to also if-convert conditional jumps containing memory writes.
7848 This transformation can be unsafe for multi-threaded programs as it
7849 transforms conditional memory writes into unconditional memory writes.
7850 For example,
7851 @smallexample
7852 for (i = 0; i < N; i++)
7853   if (cond)
7854     A[i] = expr;
7855 @end smallexample
7856 is transformed to
7857 @smallexample
7858 for (i = 0; i < N; i++)
7859   A[i] = cond ? expr : A[i];
7860 @end smallexample
7861 potentially producing data races.
7863 @item -ftree-loop-distribution
7864 Perform loop distribution.  This flag can improve cache performance on
7865 big loop bodies and allow further loop optimizations, like
7866 parallelization or vectorization, to take place.  For example, the loop
7867 @smallexample
7868 DO I = 1, N
7869   A(I) = B(I) + C
7870   D(I) = E(I) * F
7871 ENDDO
7872 @end smallexample
7873 is transformed to
7874 @smallexample
7875 DO I = 1, N
7876    A(I) = B(I) + C
7877 ENDDO
7878 DO I = 1, N
7879    D(I) = E(I) * F
7880 ENDDO
7881 @end smallexample
7883 @item -ftree-loop-distribute-patterns
7884 Perform loop distribution of patterns that can be code generated with
7885 calls to a library.  This flag is enabled by default at @option{-O3}.
7887 This pass distributes the initialization loops and generates a call to
7888 memset zero.  For example, the loop
7889 @smallexample
7890 DO I = 1, N
7891   A(I) = 0
7892   B(I) = A(I) + I
7893 ENDDO
7894 @end smallexample
7895 is transformed to
7896 @smallexample
7897 DO I = 1, N
7898    A(I) = 0
7899 ENDDO
7900 DO I = 1, N
7901    B(I) = A(I) + I
7902 ENDDO
7903 @end smallexample
7904 and the initialization loop is transformed into a call to memset zero.
7906 @item -ftree-loop-im
7907 @opindex ftree-loop-im
7908 Perform loop invariant motion on trees.  This pass moves only invariants that
7909 are hard to handle at RTL level (function calls, operations that expand to
7910 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7911 operands of conditions that are invariant out of the loop, so that we can use
7912 just trivial invariantness analysis in loop unswitching.  The pass also includes
7913 store motion.
7915 @item -ftree-loop-ivcanon
7916 @opindex ftree-loop-ivcanon
7917 Create a canonical counter for number of iterations in loops for which
7918 determining number of iterations requires complicated analysis.  Later
7919 optimizations then may determine the number easily.  Useful especially
7920 in connection with unrolling.
7922 @item -fivopts
7923 @opindex fivopts
7924 Perform induction variable optimizations (strength reduction, induction
7925 variable merging and induction variable elimination) on trees.
7927 @item -ftree-parallelize-loops=n
7928 @opindex ftree-parallelize-loops
7929 Parallelize loops, i.e., split their iteration space to run in n threads.
7930 This is only possible for loops whose iterations are independent
7931 and can be arbitrarily reordered.  The optimization is only
7932 profitable on multiprocessor machines, for loops that are CPU-intensive,
7933 rather than constrained e.g.@: by memory bandwidth.  This option
7934 implies @option{-pthread}, and thus is only supported on targets
7935 that have support for @option{-pthread}.
7937 @item -ftree-pta
7938 @opindex ftree-pta
7939 Perform function-local points-to analysis on trees.  This flag is
7940 enabled by default at @option{-O} and higher.
7942 @item -ftree-sra
7943 @opindex ftree-sra
7944 Perform scalar replacement of aggregates.  This pass replaces structure
7945 references with scalars to prevent committing structures to memory too
7946 early.  This flag is enabled by default at @option{-O} and higher.
7948 @item -ftree-copyrename
7949 @opindex ftree-copyrename
7950 Perform copy renaming on trees.  This pass attempts to rename compiler
7951 temporaries to other variables at copy locations, usually resulting in
7952 variable names which more closely resemble the original variables.  This flag
7953 is enabled by default at @option{-O} and higher.
7955 @item -ftree-coalesce-inlined-vars
7956 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7957 combine small user-defined variables too, but only if they were inlined
7958 from other functions.  It is a more limited form of
7959 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7960 inlined variables, but it will keep variables of the inlined-into
7961 function apart from each other, such that they are more likely to
7962 contain the expected values in a debugging session.  This was the
7963 default in GCC versions older than 4.7.
7965 @item -ftree-coalesce-vars
7966 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7967 combine small user-defined variables too, instead of just compiler
7968 temporaries.  This may severely limit the ability to debug an optimized
7969 program compiled with @option{-fno-var-tracking-assignments}.  In the
7970 negated form, this flag prevents SSA coalescing of user variables,
7971 including inlined ones.  This option is enabled by default.
7973 @item -ftree-ter
7974 @opindex ftree-ter
7975 Perform temporary expression replacement during the SSA->normal phase.  Single
7976 use/single def temporaries are replaced at their use location with their
7977 defining expression.  This results in non-GIMPLE code, but gives the expanders
7978 much more complex trees to work on resulting in better RTL generation.  This is
7979 enabled by default at @option{-O} and higher.
7981 @item -ftree-slsr
7982 @opindex ftree-slsr
7983 Perform straight-line strength reduction on trees.  This recognizes related
7984 expressions involving multiplications and replaces them by less expensive
7985 calculations when possible.  This is enabled by default at @option{-O} and
7986 higher.
7988 @item -ftree-vectorize
7989 @opindex ftree-vectorize
7990 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
7991 and @option{-ftree-slp-vectorize} if not explicitly specified.
7993 @item -ftree-loop-vectorize
7994 @opindex ftree-loop-vectorize
7995 Perform loop vectorization on trees. This flag is enabled by default at
7996 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7998 @item -ftree-slp-vectorize
7999 @opindex ftree-slp-vectorize
8000 Perform basic block vectorization on trees. This flag is enabled by default at
8001 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8003 @item -fvect-cost-model=@var{model}
8004 @opindex fvect-cost-model
8005 Alter the cost model used for vectorization.  The @var{model} argument
8006 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8007 With the @code{unlimited} model the vectorized code-path is assumed
8008 to be profitable while with the @code{dynamic} model a runtime check
8009 will guard the vectorized code-path to enable it only for iteration
8010 counts that will likely execute faster than when executing the original
8011 scalar loop.  The @code{cheap} model will disable vectorization of
8012 loops where doing so would be cost prohibitive for example due to
8013 required runtime checks for data dependence or alignment but otherwise
8014 is equal to the @code{dynamic} model.
8015 The default cost model depends on other optimization flags and is
8016 either @code{dynamic} or @code{cheap}.
8018 @item -ftree-vrp
8019 @opindex ftree-vrp
8020 Perform Value Range Propagation on trees.  This is similar to the
8021 constant propagation pass, but instead of values, ranges of values are
8022 propagated.  This allows the optimizers to remove unnecessary range
8023 checks like array bound checks and null pointer checks.  This is
8024 enabled by default at @option{-O2} and higher.  Null pointer check
8025 elimination is only done if @option{-fdelete-null-pointer-checks} is
8026 enabled.
8028 @item -ftracer
8029 @opindex ftracer
8030 Perform tail duplication to enlarge superblock size.  This transformation
8031 simplifies the control flow of the function allowing other optimizations to do
8032 a better job.
8034 @item -funroll-loops
8035 @opindex funroll-loops
8036 Unroll loops whose number of iterations can be determined at compile
8037 time or upon entry to the loop.  @option{-funroll-loops} implies
8038 @option{-frerun-cse-after-loop}.  This option makes code larger,
8039 and may or may not make it run faster.
8041 @item -funroll-all-loops
8042 @opindex funroll-all-loops
8043 Unroll all loops, even if their number of iterations is uncertain when
8044 the loop is entered.  This usually makes programs run more slowly.
8045 @option{-funroll-all-loops} implies the same options as
8046 @option{-funroll-loops},
8048 @item -fsplit-ivs-in-unroller
8049 @opindex fsplit-ivs-in-unroller
8050 Enables expression of values of induction variables in later iterations
8051 of the unrolled loop using the value in the first iteration.  This breaks
8052 long dependency chains, thus improving efficiency of the scheduling passes.
8054 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8055 same effect.  However, that is not reliable in cases where the loop body
8056 is more complicated than a single basic block.  It also does not work at all
8057 on some architectures due to restrictions in the CSE pass.
8059 This optimization is enabled by default.
8061 @item -fvariable-expansion-in-unroller
8062 @opindex fvariable-expansion-in-unroller
8063 With this option, the compiler creates multiple copies of some
8064 local variables when unrolling a loop, which can result in superior code.
8066 @item -fpartial-inlining
8067 @opindex fpartial-inlining
8068 Inline parts of functions.  This option has any effect only
8069 when inlining itself is turned on by the @option{-finline-functions}
8070 or @option{-finline-small-functions} options.
8072 Enabled at level @option{-O2}.
8074 @item -fpredictive-commoning
8075 @opindex fpredictive-commoning
8076 Perform predictive commoning optimization, i.e., reusing computations
8077 (especially memory loads and stores) performed in previous
8078 iterations of loops.
8080 This option is enabled at level @option{-O3}.
8082 @item -fprefetch-loop-arrays
8083 @opindex fprefetch-loop-arrays
8084 If supported by the target machine, generate instructions to prefetch
8085 memory to improve the performance of loops that access large arrays.
8087 This option may generate better or worse code; results are highly
8088 dependent on the structure of loops within the source code.
8090 Disabled at level @option{-Os}.
8092 @item -fno-peephole
8093 @itemx -fno-peephole2
8094 @opindex fno-peephole
8095 @opindex fno-peephole2
8096 Disable any machine-specific peephole optimizations.  The difference
8097 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8098 are implemented in the compiler; some targets use one, some use the
8099 other, a few use both.
8101 @option{-fpeephole} is enabled by default.
8102 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8104 @item -fno-guess-branch-probability
8105 @opindex fno-guess-branch-probability
8106 Do not guess branch probabilities using heuristics.
8108 GCC uses heuristics to guess branch probabilities if they are
8109 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8110 heuristics are based on the control flow graph.  If some branch probabilities
8111 are specified by @samp{__builtin_expect}, then the heuristics are
8112 used to guess branch probabilities for the rest of the control flow graph,
8113 taking the @samp{__builtin_expect} info into account.  The interactions
8114 between the heuristics and @samp{__builtin_expect} can be complex, and in
8115 some cases, it may be useful to disable the heuristics so that the effects
8116 of @samp{__builtin_expect} are easier to understand.
8118 The default is @option{-fguess-branch-probability} at levels
8119 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8121 @item -freorder-blocks
8122 @opindex freorder-blocks
8123 Reorder basic blocks in the compiled function in order to reduce number of
8124 taken branches and improve code locality.
8126 Enabled at levels @option{-O2}, @option{-O3}.
8128 @item -freorder-blocks-and-partition
8129 @opindex freorder-blocks-and-partition
8130 In addition to reordering basic blocks in the compiled function, in order
8131 to reduce number of taken branches, partitions hot and cold basic blocks
8132 into separate sections of the assembly and .o files, to improve
8133 paging and cache locality performance.
8135 This optimization is automatically turned off in the presence of
8136 exception handling, for linkonce sections, for functions with a user-defined
8137 section attribute and on any architecture that does not support named
8138 sections.
8140 @item -freorder-functions
8141 @opindex freorder-functions
8142 Reorder functions in the object file in order to
8143 improve code locality.  This is implemented by using special
8144 subsections @code{.text.hot} for most frequently executed functions and
8145 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8146 the linker so object file format must support named sections and linker must
8147 place them in a reasonable way.
8149 Also profile feedback must be available to make this option effective.  See
8150 @option{-fprofile-arcs} for details.
8152 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8154 @item -fstrict-aliasing
8155 @opindex fstrict-aliasing
8156 Allow the compiler to assume the strictest aliasing rules applicable to
8157 the language being compiled.  For C (and C++), this activates
8158 optimizations based on the type of expressions.  In particular, an
8159 object of one type is assumed never to reside at the same address as an
8160 object of a different type, unless the types are almost the same.  For
8161 example, an @code{unsigned int} can alias an @code{int}, but not a
8162 @code{void*} or a @code{double}.  A character type may alias any other
8163 type.
8165 @anchor{Type-punning}Pay special attention to code like this:
8166 @smallexample
8167 union a_union @{
8168   int i;
8169   double d;
8172 int f() @{
8173   union a_union t;
8174   t.d = 3.0;
8175   return t.i;
8177 @end smallexample
8178 The practice of reading from a different union member than the one most
8179 recently written to (called ``type-punning'') is common.  Even with
8180 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8181 is accessed through the union type.  So, the code above works as
8182 expected.  @xref{Structures unions enumerations and bit-fields
8183 implementation}.  However, this code might not:
8184 @smallexample
8185 int f() @{
8186   union a_union t;
8187   int* ip;
8188   t.d = 3.0;
8189   ip = &t.i;
8190   return *ip;
8192 @end smallexample
8194 Similarly, access by taking the address, casting the resulting pointer
8195 and dereferencing the result has undefined behavior, even if the cast
8196 uses a union type, e.g.:
8197 @smallexample
8198 int f() @{
8199   double d = 3.0;
8200   return ((union a_union *) &d)->i;
8202 @end smallexample
8204 The @option{-fstrict-aliasing} option is enabled at levels
8205 @option{-O2}, @option{-O3}, @option{-Os}.
8207 @item -fstrict-overflow
8208 @opindex fstrict-overflow
8209 Allow the compiler to assume strict signed overflow rules, depending
8210 on the language being compiled.  For C (and C++) this means that
8211 overflow when doing arithmetic with signed numbers is undefined, which
8212 means that the compiler may assume that it does not happen.  This
8213 permits various optimizations.  For example, the compiler assumes
8214 that an expression like @code{i + 10 > i} is always true for
8215 signed @code{i}.  This assumption is only valid if signed overflow is
8216 undefined, as the expression is false if @code{i + 10} overflows when
8217 using twos complement arithmetic.  When this option is in effect any
8218 attempt to determine whether an operation on signed numbers 
8219 overflows must be written carefully to not actually involve overflow.
8221 This option also allows the compiler to assume strict pointer
8222 semantics: given a pointer to an object, if adding an offset to that
8223 pointer does not produce a pointer to the same object, the addition is
8224 undefined.  This permits the compiler to conclude that @code{p + u >
8225 p} is always true for a pointer @code{p} and unsigned integer
8226 @code{u}.  This assumption is only valid because pointer wraparound is
8227 undefined, as the expression is false if @code{p + u} overflows using
8228 twos complement arithmetic.
8230 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8231 that integer signed overflow is fully defined: it wraps.  When
8232 @option{-fwrapv} is used, there is no difference between
8233 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8234 integers.  With @option{-fwrapv} certain types of overflow are
8235 permitted.  For example, if the compiler gets an overflow when doing
8236 arithmetic on constants, the overflowed value can still be used with
8237 @option{-fwrapv}, but not otherwise.
8239 The @option{-fstrict-overflow} option is enabled at levels
8240 @option{-O2}, @option{-O3}, @option{-Os}.
8242 @item -falign-functions
8243 @itemx -falign-functions=@var{n}
8244 @opindex falign-functions
8245 Align the start of functions to the next power-of-two greater than
8246 @var{n}, skipping up to @var{n} bytes.  For instance,
8247 @option{-falign-functions=32} aligns functions to the next 32-byte
8248 boundary, but @option{-falign-functions=24} aligns to the next
8249 32-byte boundary only if this can be done by skipping 23 bytes or less.
8251 @option{-fno-align-functions} and @option{-falign-functions=1} are
8252 equivalent and mean that functions are not aligned.
8254 Some assemblers only support this flag when @var{n} is a power of two;
8255 in that case, it is rounded up.
8257 If @var{n} is not specified or is zero, use a machine-dependent default.
8259 Enabled at levels @option{-O2}, @option{-O3}.
8261 @item -falign-labels
8262 @itemx -falign-labels=@var{n}
8263 @opindex falign-labels
8264 Align all branch targets to a power-of-two boundary, skipping up to
8265 @var{n} bytes like @option{-falign-functions}.  This option can easily
8266 make code slower, because it must insert dummy operations for when the
8267 branch target is reached in the usual flow of the code.
8269 @option{-fno-align-labels} and @option{-falign-labels=1} are
8270 equivalent and mean that labels are not aligned.
8272 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8273 are greater than this value, then their values are used instead.
8275 If @var{n} is not specified or is zero, use a machine-dependent default
8276 which is very likely to be @samp{1}, meaning no alignment.
8278 Enabled at levels @option{-O2}, @option{-O3}.
8280 @item -falign-loops
8281 @itemx -falign-loops=@var{n}
8282 @opindex falign-loops
8283 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8284 like @option{-falign-functions}.  If the loops are
8285 executed many times, this makes up for any execution of the dummy
8286 operations.
8288 @option{-fno-align-loops} and @option{-falign-loops=1} are
8289 equivalent and mean that loops are not aligned.
8291 If @var{n} is not specified or is zero, use a machine-dependent default.
8293 Enabled at levels @option{-O2}, @option{-O3}.
8295 @item -falign-jumps
8296 @itemx -falign-jumps=@var{n}
8297 @opindex falign-jumps
8298 Align branch targets to a power-of-two boundary, for branch targets
8299 where the targets can only be reached by jumping, skipping up to @var{n}
8300 bytes like @option{-falign-functions}.  In this case, no dummy operations
8301 need be executed.
8303 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8304 equivalent and mean that loops are not aligned.
8306 If @var{n} is not specified or is zero, use a machine-dependent default.
8308 Enabled at levels @option{-O2}, @option{-O3}.
8310 @item -funit-at-a-time
8311 @opindex funit-at-a-time
8312 This option is left for compatibility reasons. @option{-funit-at-a-time}
8313 has no effect, while @option{-fno-unit-at-a-time} implies
8314 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8316 Enabled by default.
8318 @item -fno-toplevel-reorder
8319 @opindex fno-toplevel-reorder
8320 Do not reorder top-level functions, variables, and @code{asm}
8321 statements.  Output them in the same order that they appear in the
8322 input file.  When this option is used, unreferenced static variables
8323 are not removed.  This option is intended to support existing code
8324 that relies on a particular ordering.  For new code, it is better to
8325 use attributes when possible.
8327 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8328 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8329 targets.
8331 @item -fweb
8332 @opindex fweb
8333 Constructs webs as commonly used for register allocation purposes and assign
8334 each web individual pseudo register.  This allows the register allocation pass
8335 to operate on pseudos directly, but also strengthens several other optimization
8336 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8337 however, make debugging impossible, since variables no longer stay in a
8338 ``home register''.
8340 Enabled by default with @option{-funroll-loops}.
8342 @item -fwhole-program
8343 @opindex fwhole-program
8344 Assume that the current compilation unit represents the whole program being
8345 compiled.  All public functions and variables with the exception of @code{main}
8346 and those merged by attribute @code{externally_visible} become static functions
8347 and in effect are optimized more aggressively by interprocedural optimizers.
8349 This option should not be used in combination with @code{-flto}.
8350 Instead relying on a linker plugin should provide safer and more precise
8351 information.
8353 @item -flto[=@var{n}]
8354 @opindex flto
8355 This option runs the standard link-time optimizer.  When invoked
8356 with source code, it generates GIMPLE (one of GCC's internal
8357 representations) and writes it to special ELF sections in the object
8358 file.  When the object files are linked together, all the function
8359 bodies are read from these ELF sections and instantiated as if they
8360 had been part of the same translation unit.
8362 To use the link-time optimizer, @option{-flto} needs to be specified at
8363 compile time and during the final link.  For example:
8365 @smallexample
8366 gcc -c -O2 -flto foo.c
8367 gcc -c -O2 -flto bar.c
8368 gcc -o myprog -flto -O2 foo.o bar.o
8369 @end smallexample
8371 The first two invocations to GCC save a bytecode representation
8372 of GIMPLE into special ELF sections inside @file{foo.o} and
8373 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8374 @file{foo.o} and @file{bar.o}, merges the two files into a single
8375 internal image, and compiles the result as usual.  Since both
8376 @file{foo.o} and @file{bar.o} are merged into a single image, this
8377 causes all the interprocedural analyses and optimizations in GCC to
8378 work across the two files as if they were a single one.  This means,
8379 for example, that the inliner is able to inline functions in
8380 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8382 Another (simpler) way to enable link-time optimization is:
8384 @smallexample
8385 gcc -o myprog -flto -O2 foo.c bar.c
8386 @end smallexample
8388 The above generates bytecode for @file{foo.c} and @file{bar.c},
8389 merges them together into a single GIMPLE representation and optimizes
8390 them as usual to produce @file{myprog}.
8392 The only important thing to keep in mind is that to enable link-time
8393 optimizations the @option{-flto} flag needs to be passed to both the
8394 compile and the link commands.
8396 To make whole program optimization effective, it is necessary to make
8397 certain whole program assumptions.  The compiler needs to know
8398 what functions and variables can be accessed by libraries and runtime
8399 outside of the link-time optimized unit.  When supported by the linker,
8400 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8401 to the compiler about used and externally visible symbols.  When
8402 the linker plugin is not available, @option{-fwhole-program} should be
8403 used to allow the compiler to make these assumptions, which leads
8404 to more aggressive optimization decisions.
8406 Note that when a file is compiled with @option{-flto}, the generated
8407 object file is larger than a regular object file because it 
8408 contains GIMPLE bytecodes and the usual final code.  This means that
8409 object files with LTO information can be linked as normal object
8410 files; if @option{-flto} is not passed to the linker, no
8411 interprocedural optimizations are applied.
8413 Additionally, the optimization flags used to compile individual files
8414 are not necessarily related to those used at link time.  For instance,
8416 @smallexample
8417 gcc -c -O0 -flto foo.c
8418 gcc -c -O0 -flto bar.c
8419 gcc -o myprog -flto -O3 foo.o bar.o
8420 @end smallexample
8422 This produces individual object files with unoptimized assembler
8423 code, but the resulting binary @file{myprog} is optimized at
8424 @option{-O3}.  If, instead, the final binary is generated without
8425 @option{-flto}, then @file{myprog} is not optimized.
8427 When producing the final binary with @option{-flto}, GCC only
8428 applies link-time optimizations to those files that contain bytecode.
8429 Therefore, you can mix and match object files and libraries with
8430 GIMPLE bytecodes and final object code.  GCC automatically selects
8431 which files to optimize in LTO mode and which files to link without
8432 further processing.
8434 There are some code generation flags preserved by GCC when
8435 generating bytecodes, as they need to be used during the final link
8436 stage.  Currently, the following options are saved into the GIMPLE
8437 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
8438 @option{-m} target flags.
8440 At link time, these options are read in and reapplied.  Note that the
8441 current implementation makes no attempt to recognize conflicting
8442 values for these options.  If different files have conflicting option
8443 values (e.g., one file is compiled with @option{-fPIC} and another
8444 isn't), the compiler simply uses the last value read from the
8445 bytecode files.  It is recommended, then, that you compile all the files
8446 participating in the same link with the same options.
8448 If LTO encounters objects with C linkage declared with incompatible
8449 types in separate translation units to be linked together (undefined
8450 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8451 issued.  The behavior is still undefined at run time.
8453 Another feature of LTO is that it is possible to apply interprocedural
8454 optimizations on files written in different languages.  This requires
8455 support in the language front end.  Currently, the C, C++ and
8456 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8457 something like this should work:
8459 @smallexample
8460 gcc -c -flto foo.c
8461 g++ -c -flto bar.cc
8462 gfortran -c -flto baz.f90
8463 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8464 @end smallexample
8466 Notice that the final link is done with @command{g++} to get the C++
8467 runtime libraries and @option{-lgfortran} is added to get the Fortran
8468 runtime libraries.  In general, when mixing languages in LTO mode, you
8469 should use the same link command options as when mixing languages in a
8470 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8471 all the compile and link commands.
8473 If object files containing GIMPLE bytecode are stored in a library archive, say
8474 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8475 are using a linker with plugin support.  To enable this feature, use
8476 the flag @option{-fuse-linker-plugin} at link time:
8478 @smallexample
8479 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8480 @end smallexample
8482 With the linker plugin enabled, the linker extracts the needed
8483 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8484 to make them part of the aggregated GIMPLE image to be optimized.
8486 If you are not using a linker with plugin support and/or do not
8487 enable the linker plugin, then the objects inside @file{libfoo.a}
8488 are extracted and linked as usual, but they do not participate
8489 in the LTO optimization process.
8491 Link-time optimizations do not require the presence of the whole program to
8492 operate.  If the program does not require any symbols to be exported, it is
8493 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8494 the interprocedural optimizers to use more aggressive assumptions which may
8495 lead to improved optimization opportunities.
8496 Use of @option{-fwhole-program} is not needed when linker plugin is
8497 active (see @option{-fuse-linker-plugin}).
8499 The current implementation of LTO makes no
8500 attempt to generate bytecode that is portable between different
8501 types of hosts.  The bytecode files are versioned and there is a
8502 strict version check, so bytecode files generated in one version of
8503 GCC will not work with an older/newer version of GCC@.
8505 Link-time optimization does not work well with generation of debugging
8506 information.  Combining @option{-flto} with
8507 @option{-g} is currently experimental and expected to produce wrong
8508 results.
8510 If you specify the optional @var{n}, the optimization and code
8511 generation done at link time is executed in parallel using @var{n}
8512 parallel jobs by utilizing an installed @command{make} program.  The
8513 environment variable @env{MAKE} may be used to override the program
8514 used.  The default value for @var{n} is 1.
8516 You can also specify @option{-flto=jobserver} to use GNU make's
8517 job server mode to determine the number of parallel jobs. This
8518 is useful when the Makefile calling GCC is already executing in parallel.
8519 You must prepend a @samp{+} to the command recipe in the parent Makefile
8520 for this to work.  This option likely only works if @env{MAKE} is
8521 GNU make.
8523 This option is disabled by default.
8525 @item -flto-partition=@var{alg}
8526 @opindex flto-partition
8527 Specify the partitioning algorithm used by the link-time optimizer.
8528 The value is either @code{1to1} to specify a partitioning mirroring
8529 the original source files or @code{balanced} to specify partitioning
8530 into equally sized chunks (whenever possible) or @code{max} to create
8531 new partition for every symbol where possible.  Specifying @code{none}
8532 as an algorithm disables partitioning and streaming completely. 
8533 The default value is @code{balanced}. While @code{1to1} can be used
8534 as an workaround for various code ordering issues, the @code{max}
8535 partitioning is intended for internal testing only.
8537 @item -flto-compression-level=@var{n}
8538 This option specifies the level of compression used for intermediate
8539 language written to LTO object files, and is only meaningful in
8540 conjunction with LTO mode (@option{-flto}).  Valid
8541 values are 0 (no compression) to 9 (maximum compression).  Values
8542 outside this range are clamped to either 0 or 9.  If the option is not
8543 given, a default balanced compression setting is used.
8545 @item -flto-report
8546 Prints a report with internal details on the workings of the link-time
8547 optimizer.  The contents of this report vary from version to version.
8548 It is meant to be useful to GCC developers when processing object
8549 files in LTO mode (via @option{-flto}).
8551 Disabled by default.
8553 @item -flto-report-wpa
8554 Like @option{-flto-report}, but only print for the WPA phase of Link
8555 Time Optimization.
8557 @item -fuse-linker-plugin
8558 Enables the use of a linker plugin during link-time optimization.  This
8559 option relies on plugin support in the linker, which is available in gold
8560 or in GNU ld 2.21 or newer.
8562 This option enables the extraction of object files with GIMPLE bytecode out
8563 of library archives. This improves the quality of optimization by exposing
8564 more code to the link-time optimizer.  This information specifies what
8565 symbols can be accessed externally (by non-LTO object or during dynamic
8566 linking).  Resulting code quality improvements on binaries (and shared
8567 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8568 See @option{-flto} for a description of the effect of this flag and how to
8569 use it.
8571 This option is enabled by default when LTO support in GCC is enabled
8572 and GCC was configured for use with
8573 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8575 @item -ffat-lto-objects
8576 @opindex ffat-lto-objects
8577 Fat LTO objects are object files that contain both the intermediate language
8578 and the object code. This makes them usable for both LTO linking and normal
8579 linking. This option is effective only when compiling with @option{-flto}
8580 and is ignored at link time.
8582 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8583 requires the complete toolchain to be aware of LTO. It requires a linker with
8584 linker plugin support for basic functionality.  Additionally,
8585 @command{nm}, @command{ar} and @command{ranlib}
8586 need to support linker plugins to allow a full-featured build environment
8587 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8588 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8589 to these tools. With non fat LTO makefiles need to be modified to use them.
8591 The default is @option{-ffat-lto-objects} but this default is intended to
8592 change in future releases when linker plugin enabled environments become more
8593 common.
8595 @item -fcompare-elim
8596 @opindex fcompare-elim
8597 After register allocation and post-register allocation instruction splitting,
8598 identify arithmetic instructions that compute processor flags similar to a
8599 comparison operation based on that arithmetic.  If possible, eliminate the
8600 explicit comparison operation.
8602 This pass only applies to certain targets that cannot explicitly represent
8603 the comparison operation before register allocation is complete.
8605 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8607 @item -fuse-ld=bfd
8608 Use the @command{bfd} linker instead of the default linker.
8610 @item -fuse-ld=gold
8611 Use the @command{gold} linker instead of the default linker.
8613 @item -fcprop-registers
8614 @opindex fcprop-registers
8615 After register allocation and post-register allocation instruction splitting,
8616 perform a copy-propagation pass to try to reduce scheduling dependencies
8617 and occasionally eliminate the copy.
8619 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8621 @item -fprofile-correction
8622 @opindex fprofile-correction
8623 Profiles collected using an instrumented binary for multi-threaded programs may
8624 be inconsistent due to missed counter updates. When this option is specified,
8625 GCC uses heuristics to correct or smooth out such inconsistencies. By
8626 default, GCC emits an error message when an inconsistent profile is detected.
8628 @item -fprofile-dir=@var{path}
8629 @opindex fprofile-dir
8631 Set the directory to search for the profile data files in to @var{path}.
8632 This option affects only the profile data generated by
8633 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8634 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8635 and its related options.  Both absolute and relative paths can be used.
8636 By default, GCC uses the current directory as @var{path}, thus the
8637 profile data file appears in the same directory as the object file.
8639 @item -fprofile-generate
8640 @itemx -fprofile-generate=@var{path}
8641 @opindex fprofile-generate
8643 Enable options usually used for instrumenting application to produce
8644 profile useful for later recompilation with profile feedback based
8645 optimization.  You must use @option{-fprofile-generate} both when
8646 compiling and when linking your program.
8648 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8650 If @var{path} is specified, GCC looks at the @var{path} to find
8651 the profile feedback data files. See @option{-fprofile-dir}.
8653 @item -fprofile-use
8654 @itemx -fprofile-use=@var{path}
8655 @opindex fprofile-use
8656 Enable profile feedback directed optimizations, and optimizations
8657 generally profitable only with profile feedback available.
8659 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8660 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8661 @code{ftree-loop-distribute-patterns}
8663 By default, GCC emits an error message if the feedback profiles do not
8664 match the source code.  This error can be turned into a warning by using
8665 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8666 code.
8668 If @var{path} is specified, GCC looks at the @var{path} to find
8669 the profile feedback data files. See @option{-fprofile-dir}.
8670 @end table
8672 The following options control compiler behavior regarding floating-point 
8673 arithmetic.  These options trade off between speed and
8674 correctness.  All must be specifically enabled.
8676 @table @gcctabopt
8677 @item -ffloat-store
8678 @opindex ffloat-store
8679 Do not store floating-point variables in registers, and inhibit other
8680 options that might change whether a floating-point value is taken from a
8681 register or memory.
8683 @cindex floating-point precision
8684 This option prevents undesirable excess precision on machines such as
8685 the 68000 where the floating registers (of the 68881) keep more
8686 precision than a @code{double} is supposed to have.  Similarly for the
8687 x86 architecture.  For most programs, the excess precision does only
8688 good, but a few programs rely on the precise definition of IEEE floating
8689 point.  Use @option{-ffloat-store} for such programs, after modifying
8690 them to store all pertinent intermediate computations into variables.
8692 @item -fexcess-precision=@var{style}
8693 @opindex fexcess-precision
8694 This option allows further control over excess precision on machines
8695 where floating-point registers have more precision than the IEEE
8696 @code{float} and @code{double} types and the processor does not
8697 support operations rounding to those types.  By default,
8698 @option{-fexcess-precision=fast} is in effect; this means that
8699 operations are carried out in the precision of the registers and that
8700 it is unpredictable when rounding to the types specified in the source
8701 code takes place.  When compiling C, if
8702 @option{-fexcess-precision=standard} is specified then excess
8703 precision follows the rules specified in ISO C99; in particular,
8704 both casts and assignments cause values to be rounded to their
8705 semantic types (whereas @option{-ffloat-store} only affects
8706 assignments).  This option is enabled by default for C if a strict
8707 conformance option such as @option{-std=c99} is used.
8709 @opindex mfpmath
8710 @option{-fexcess-precision=standard} is not implemented for languages
8711 other than C, and has no effect if
8712 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8713 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8714 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8715 semantics apply without excess precision, and in the latter, rounding
8716 is unpredictable.
8718 @item -ffast-math
8719 @opindex ffast-math
8720 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8721 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8722 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8724 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8726 This option is not turned on by any @option{-O} option besides
8727 @option{-Ofast} since it can result in incorrect output for programs
8728 that depend on an exact implementation of IEEE or ISO rules/specifications
8729 for math functions. It may, however, yield faster code for programs
8730 that do not require the guarantees of these specifications.
8732 @item -fno-math-errno
8733 @opindex fno-math-errno
8734 Do not set @code{errno} after calling math functions that are executed
8735 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8736 IEEE exceptions for math error handling may want to use this flag
8737 for speed while maintaining IEEE arithmetic compatibility.
8739 This option is not turned on by any @option{-O} option since
8740 it can result in incorrect output for programs that depend on
8741 an exact implementation of IEEE or ISO rules/specifications for
8742 math functions. It may, however, yield faster code for programs
8743 that do not require the guarantees of these specifications.
8745 The default is @option{-fmath-errno}.
8747 On Darwin systems, the math library never sets @code{errno}.  There is
8748 therefore no reason for the compiler to consider the possibility that
8749 it might, and @option{-fno-math-errno} is the default.
8751 @item -funsafe-math-optimizations
8752 @opindex funsafe-math-optimizations
8754 Allow optimizations for floating-point arithmetic that (a) assume
8755 that arguments and results are valid and (b) may violate IEEE or
8756 ANSI standards.  When used at link-time, it may include libraries
8757 or startup files that change the default FPU control word or other
8758 similar optimizations.
8760 This option is not turned on by any @option{-O} option since
8761 it can result in incorrect output for programs that depend on
8762 an exact implementation of IEEE or ISO rules/specifications for
8763 math functions. It may, however, yield faster code for programs
8764 that do not require the guarantees of these specifications.
8765 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8766 @option{-fassociative-math} and @option{-freciprocal-math}.
8768 The default is @option{-fno-unsafe-math-optimizations}.
8770 @item -fassociative-math
8771 @opindex fassociative-math
8773 Allow re-association of operands in series of floating-point operations.
8774 This violates the ISO C and C++ language standard by possibly changing
8775 computation result.  NOTE: re-ordering may change the sign of zero as
8776 well as ignore NaNs and inhibit or create underflow or overflow (and
8777 thus cannot be used on code that relies on rounding behavior like
8778 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8779 and thus may not be used when ordered comparisons are required.
8780 This option requires that both @option{-fno-signed-zeros} and
8781 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8782 much sense with @option{-frounding-math}. For Fortran the option
8783 is automatically enabled when both @option{-fno-signed-zeros} and
8784 @option{-fno-trapping-math} are in effect.
8786 The default is @option{-fno-associative-math}.
8788 @item -freciprocal-math
8789 @opindex freciprocal-math
8791 Allow the reciprocal of a value to be used instead of dividing by
8792 the value if this enables optimizations.  For example @code{x / y}
8793 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8794 is subject to common subexpression elimination.  Note that this loses
8795 precision and increases the number of flops operating on the value.
8797 The default is @option{-fno-reciprocal-math}.
8799 @item -ffinite-math-only
8800 @opindex ffinite-math-only
8801 Allow optimizations for floating-point arithmetic that assume
8802 that arguments and results are not NaNs or +-Infs.
8804 This option is not turned on by any @option{-O} option since
8805 it can result in incorrect output for programs that depend on
8806 an exact implementation of IEEE or ISO rules/specifications for
8807 math functions. It may, however, yield faster code for programs
8808 that do not require the guarantees of these specifications.
8810 The default is @option{-fno-finite-math-only}.
8812 @item -fno-signed-zeros
8813 @opindex fno-signed-zeros
8814 Allow optimizations for floating-point arithmetic that ignore the
8815 signedness of zero.  IEEE arithmetic specifies the behavior of
8816 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8817 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8818 This option implies that the sign of a zero result isn't significant.
8820 The default is @option{-fsigned-zeros}.
8822 @item -fno-trapping-math
8823 @opindex fno-trapping-math
8824 Compile code assuming that floating-point operations cannot generate
8825 user-visible traps.  These traps include division by zero, overflow,
8826 underflow, inexact result and invalid operation.  This option requires
8827 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8828 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8830 This option should never be turned on by any @option{-O} option since
8831 it can result in incorrect output for programs that depend on
8832 an exact implementation of IEEE or ISO rules/specifications for
8833 math functions.
8835 The default is @option{-ftrapping-math}.
8837 @item -frounding-math
8838 @opindex frounding-math
8839 Disable transformations and optimizations that assume default floating-point
8840 rounding behavior.  This is round-to-zero for all floating point
8841 to integer conversions, and round-to-nearest for all other arithmetic
8842 truncations.  This option should be specified for programs that change
8843 the FP rounding mode dynamically, or that may be executed with a
8844 non-default rounding mode.  This option disables constant folding of
8845 floating-point expressions at compile time (which may be affected by
8846 rounding mode) and arithmetic transformations that are unsafe in the
8847 presence of sign-dependent rounding modes.
8849 The default is @option{-fno-rounding-math}.
8851 This option is experimental and does not currently guarantee to
8852 disable all GCC optimizations that are affected by rounding mode.
8853 Future versions of GCC may provide finer control of this setting
8854 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8855 will be used to specify the default state for @code{FENV_ACCESS}.
8857 @item -fsignaling-nans
8858 @opindex fsignaling-nans
8859 Compile code assuming that IEEE signaling NaNs may generate user-visible
8860 traps during floating-point operations.  Setting this option disables
8861 optimizations that may change the number of exceptions visible with
8862 signaling NaNs.  This option implies @option{-ftrapping-math}.
8864 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8865 be defined.
8867 The default is @option{-fno-signaling-nans}.
8869 This option is experimental and does not currently guarantee to
8870 disable all GCC optimizations that affect signaling NaN behavior.
8872 @item -fsingle-precision-constant
8873 @opindex fsingle-precision-constant
8874 Treat floating-point constants as single precision instead of
8875 implicitly converting them to double-precision constants.
8877 @item -fcx-limited-range
8878 @opindex fcx-limited-range
8879 When enabled, this option states that a range reduction step is not
8880 needed when performing complex division.  Also, there is no checking
8881 whether the result of a complex multiplication or division is @code{NaN
8882 + I*NaN}, with an attempt to rescue the situation in that case.  The
8883 default is @option{-fno-cx-limited-range}, but is enabled by
8884 @option{-ffast-math}.
8886 This option controls the default setting of the ISO C99
8887 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8888 all languages.
8890 @item -fcx-fortran-rules
8891 @opindex fcx-fortran-rules
8892 Complex multiplication and division follow Fortran rules.  Range
8893 reduction is done as part of complex division, but there is no checking
8894 whether the result of a complex multiplication or division is @code{NaN
8895 + I*NaN}, with an attempt to rescue the situation in that case.
8897 The default is @option{-fno-cx-fortran-rules}.
8899 @end table
8901 The following options control optimizations that may improve
8902 performance, but are not enabled by any @option{-O} options.  This
8903 section includes experimental options that may produce broken code.
8905 @table @gcctabopt
8906 @item -fbranch-probabilities
8907 @opindex fbranch-probabilities
8908 After running a program compiled with @option{-fprofile-arcs}
8909 (@pxref{Debugging Options,, Options for Debugging Your Program or
8910 @command{gcc}}), you can compile it a second time using
8911 @option{-fbranch-probabilities}, to improve optimizations based on
8912 the number of times each branch was taken.  When a program
8913 compiled with @option{-fprofile-arcs} exits, it saves arc execution
8914 counts to a file called @file{@var{sourcename}.gcda} for each source
8915 file.  The information in this data file is very dependent on the
8916 structure of the generated code, so you must use the same source code
8917 and the same optimization options for both compilations.
8919 With @option{-fbranch-probabilities}, GCC puts a
8920 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8921 These can be used to improve optimization.  Currently, they are only
8922 used in one place: in @file{reorg.c}, instead of guessing which path a
8923 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8924 exactly determine which path is taken more often.
8926 @item -fprofile-values
8927 @opindex fprofile-values
8928 If combined with @option{-fprofile-arcs}, it adds code so that some
8929 data about values of expressions in the program is gathered.
8931 With @option{-fbranch-probabilities}, it reads back the data gathered
8932 from profiling values of expressions for usage in optimizations.
8934 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8936 @item -fvpt
8937 @opindex fvpt
8938 If combined with @option{-fprofile-arcs}, this option instructs the compiler
8939 to add code to gather information about values of expressions.
8941 With @option{-fbranch-probabilities}, it reads back the data gathered
8942 and actually performs the optimizations based on them.
8943 Currently the optimizations include specialization of division operations
8944 using the knowledge about the value of the denominator.
8946 @item -frename-registers
8947 @opindex frename-registers
8948 Attempt to avoid false dependencies in scheduled code by making use
8949 of registers left over after register allocation.  This optimization
8950 most benefits processors with lots of registers.  Depending on the
8951 debug information format adopted by the target, however, it can
8952 make debugging impossible, since variables no longer stay in
8953 a ``home register''.
8955 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8957 @item -ftracer
8958 @opindex ftracer
8959 Perform tail duplication to enlarge superblock size.  This transformation
8960 simplifies the control flow of the function allowing other optimizations to do
8961 a better job.
8963 Enabled with @option{-fprofile-use}.
8965 @item -funroll-loops
8966 @opindex funroll-loops
8967 Unroll loops whose number of iterations can be determined at compile time or
8968 upon entry to the loop.  @option{-funroll-loops} implies
8969 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8970 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8971 a small constant number of iterations).  This option makes code larger, and may
8972 or may not make it run faster.
8974 Enabled with @option{-fprofile-use}.
8976 @item -funroll-all-loops
8977 @opindex funroll-all-loops
8978 Unroll all loops, even if their number of iterations is uncertain when
8979 the loop is entered.  This usually makes programs run more slowly.
8980 @option{-funroll-all-loops} implies the same options as
8981 @option{-funroll-loops}.
8983 @item -fpeel-loops
8984 @opindex fpeel-loops
8985 Peels loops for which there is enough information that they do not
8986 roll much (from profile feedback).  It also turns on complete loop peeling
8987 (i.e.@: complete removal of loops with small constant number of iterations).
8989 Enabled with @option{-fprofile-use}.
8991 @item -fmove-loop-invariants
8992 @opindex fmove-loop-invariants
8993 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8994 at level @option{-O1}
8996 @item -funswitch-loops
8997 @opindex funswitch-loops
8998 Move branches with loop invariant conditions out of the loop, with duplicates
8999 of the loop on both branches (modified according to result of the condition).
9001 @item -ffunction-sections
9002 @itemx -fdata-sections
9003 @opindex ffunction-sections
9004 @opindex fdata-sections
9005 Place each function or data item into its own section in the output
9006 file if the target supports arbitrary sections.  The name of the
9007 function or the name of the data item determines the section's name
9008 in the output file.
9010 Use these options on systems where the linker can perform optimizations
9011 to improve locality of reference in the instruction space.  Most systems
9012 using the ELF object format and SPARC processors running Solaris 2 have
9013 linkers with such optimizations.  AIX may have these optimizations in
9014 the future.
9016 Only use these options when there are significant benefits from doing
9017 so.  When you specify these options, the assembler and linker
9018 create larger object and executable files and are also slower.
9019 You cannot use @code{gprof} on all systems if you
9020 specify this option, and you may have problems with debugging if
9021 you specify both this option and @option{-g}.
9023 @item -fbranch-target-load-optimize
9024 @opindex fbranch-target-load-optimize
9025 Perform branch target register load optimization before prologue / epilogue
9026 threading.
9027 The use of target registers can typically be exposed only during reload,
9028 thus hoisting loads out of loops and doing inter-block scheduling needs
9029 a separate optimization pass.
9031 @item -fbranch-target-load-optimize2
9032 @opindex fbranch-target-load-optimize2
9033 Perform branch target register load optimization after prologue / epilogue
9034 threading.
9036 @item -fbtr-bb-exclusive
9037 @opindex fbtr-bb-exclusive
9038 When performing branch target register load optimization, don't reuse
9039 branch target registers within any basic block.
9041 @item -fstack-protector
9042 @opindex fstack-protector
9043 Emit extra code to check for buffer overflows, such as stack smashing
9044 attacks.  This is done by adding a guard variable to functions with
9045 vulnerable objects.  This includes functions that call @code{alloca}, and
9046 functions with buffers larger than 8 bytes.  The guards are initialized
9047 when a function is entered and then checked when the function exits.
9048 If a guard check fails, an error message is printed and the program exits.
9050 @item -fstack-protector-all
9051 @opindex fstack-protector-all
9052 Like @option{-fstack-protector} except that all functions are protected.
9054 @item -fstack-protector-strong
9055 @opindex fstack-protector-strong
9056 Like @option{-fstack-protector} but includes additional functions to
9057 be protected --- those that have local array definitions, or have
9058 references to local frame addresses.
9060 @item -fsection-anchors
9061 @opindex fsection-anchors
9062 Try to reduce the number of symbolic address calculations by using
9063 shared ``anchor'' symbols to address nearby objects.  This transformation
9064 can help to reduce the number of GOT entries and GOT accesses on some
9065 targets.
9067 For example, the implementation of the following function @code{foo}:
9069 @smallexample
9070 static int a, b, c;
9071 int foo (void) @{ return a + b + c; @}
9072 @end smallexample
9074 @noindent
9075 usually calculates the addresses of all three variables, but if you
9076 compile it with @option{-fsection-anchors}, it accesses the variables
9077 from a common anchor point instead.  The effect is similar to the
9078 following pseudocode (which isn't valid C):
9080 @smallexample
9081 int foo (void)
9083   register int *xr = &x;
9084   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9086 @end smallexample
9088 Not all targets support this option.
9090 @item --param @var{name}=@var{value}
9091 @opindex param
9092 In some places, GCC uses various constants to control the amount of
9093 optimization that is done.  For example, GCC does not inline functions
9094 that contain more than a certain number of instructions.  You can
9095 control some of these constants on the command line using the
9096 @option{--param} option.
9098 The names of specific parameters, and the meaning of the values, are
9099 tied to the internals of the compiler, and are subject to change
9100 without notice in future releases.
9102 In each case, the @var{value} is an integer.  The allowable choices for
9103 @var{name} are:
9105 @table @gcctabopt
9106 @item predictable-branch-outcome
9107 When branch is predicted to be taken with probability lower than this threshold
9108 (in percent), then it is considered well predictable. The default is 10.
9110 @item max-crossjump-edges
9111 The maximum number of incoming edges to consider for cross-jumping.
9112 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9113 the number of edges incoming to each block.  Increasing values mean
9114 more aggressive optimization, making the compilation time increase with
9115 probably small improvement in executable size.
9117 @item min-crossjump-insns
9118 The minimum number of instructions that must be matched at the end
9119 of two blocks before cross-jumping is performed on them.  This
9120 value is ignored in the case where all instructions in the block being
9121 cross-jumped from are matched.  The default value is 5.
9123 @item max-grow-copy-bb-insns
9124 The maximum code size expansion factor when copying basic blocks
9125 instead of jumping.  The expansion is relative to a jump instruction.
9126 The default value is 8.
9128 @item max-goto-duplication-insns
9129 The maximum number of instructions to duplicate to a block that jumps
9130 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9131 passes, GCC factors computed gotos early in the compilation process,
9132 and unfactors them as late as possible.  Only computed jumps at the
9133 end of a basic blocks with no more than max-goto-duplication-insns are
9134 unfactored.  The default value is 8.
9136 @item max-delay-slot-insn-search
9137 The maximum number of instructions to consider when looking for an
9138 instruction to fill a delay slot.  If more than this arbitrary number of
9139 instructions are searched, the time savings from filling the delay slot
9140 are minimal, so stop searching.  Increasing values mean more
9141 aggressive optimization, making the compilation time increase with probably
9142 small improvement in execution time.
9144 @item max-delay-slot-live-search
9145 When trying to fill delay slots, the maximum number of instructions to
9146 consider when searching for a block with valid live register
9147 information.  Increasing this arbitrarily chosen value means more
9148 aggressive optimization, increasing the compilation time.  This parameter
9149 should be removed when the delay slot code is rewritten to maintain the
9150 control-flow graph.
9152 @item max-gcse-memory
9153 The approximate maximum amount of memory that can be allocated in
9154 order to perform the global common subexpression elimination
9155 optimization.  If more memory than specified is required, the
9156 optimization is not done.
9158 @item max-gcse-insertion-ratio
9159 If the ratio of expression insertions to deletions is larger than this value
9160 for any expression, then RTL PRE inserts or removes the expression and thus
9161 leaves partially redundant computations in the instruction stream.  The default value is 20.
9163 @item max-pending-list-length
9164 The maximum number of pending dependencies scheduling allows
9165 before flushing the current state and starting over.  Large functions
9166 with few branches or calls can create excessively large lists which
9167 needlessly consume memory and resources.
9169 @item max-modulo-backtrack-attempts
9170 The maximum number of backtrack attempts the scheduler should make
9171 when modulo scheduling a loop.  Larger values can exponentially increase
9172 compilation time.
9174 @item max-inline-insns-single
9175 Several parameters control the tree inliner used in GCC@.
9176 This number sets the maximum number of instructions (counted in GCC's
9177 internal representation) in a single function that the tree inliner
9178 considers for inlining.  This only affects functions declared
9179 inline and methods implemented in a class declaration (C++).
9180 The default value is 400.
9182 @item max-inline-insns-auto
9183 When you use @option{-finline-functions} (included in @option{-O3}),
9184 a lot of functions that would otherwise not be considered for inlining
9185 by the compiler are investigated.  To those functions, a different
9186 (more restrictive) limit compared to functions declared inline can
9187 be applied.
9188 The default value is 40.
9190 @item inline-min-speedup
9191 When estimated performance improvement of caller + callee runtime exceeds this
9192 threshold (in precent), the function can be inlined regardless the limit on
9193 @option{--param max-inline-insns-single} and @option{--param
9194 max-inline-insns-auto}.
9196 @item large-function-insns
9197 The limit specifying really large functions.  For functions larger than this
9198 limit after inlining, inlining is constrained by
9199 @option{--param large-function-growth}.  This parameter is useful primarily
9200 to avoid extreme compilation time caused by non-linear algorithms used by the
9201 back end.
9202 The default value is 2700.
9204 @item large-function-growth
9205 Specifies maximal growth of large function caused by inlining in percents.
9206 The default value is 100 which limits large function growth to 2.0 times
9207 the original size.
9209 @item large-unit-insns
9210 The limit specifying large translation unit.  Growth caused by inlining of
9211 units larger than this limit is limited by @option{--param inline-unit-growth}.
9212 For small units this might be too tight.
9213 For example, consider a unit consisting of function A
9214 that is inline and B that just calls A three times.  If B is small relative to
9215 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9216 large units consisting of small inlineable functions, however, the overall unit
9217 growth limit is needed to avoid exponential explosion of code size.  Thus for
9218 smaller units, the size is increased to @option{--param large-unit-insns}
9219 before applying @option{--param inline-unit-growth}.  The default is 10000.
9221 @item inline-unit-growth
9222 Specifies maximal overall growth of the compilation unit caused by inlining.
9223 The default value is 30 which limits unit growth to 1.3 times the original
9224 size.
9226 @item ipcp-unit-growth
9227 Specifies maximal overall growth of the compilation unit caused by
9228 interprocedural constant propagation.  The default value is 10 which limits
9229 unit growth to 1.1 times the original size.
9231 @item large-stack-frame
9232 The limit specifying large stack frames.  While inlining the algorithm is trying
9233 to not grow past this limit too much.  The default value is 256 bytes.
9235 @item large-stack-frame-growth
9236 Specifies maximal growth of large stack frames caused by inlining in percents.
9237 The default value is 1000 which limits large stack frame growth to 11 times
9238 the original size.
9240 @item max-inline-insns-recursive
9241 @itemx max-inline-insns-recursive-auto
9242 Specifies the maximum number of instructions an out-of-line copy of a
9243 self-recursive inline
9244 function can grow into by performing recursive inlining.
9246 For functions declared inline, @option{--param max-inline-insns-recursive} is
9247 taken into account.  For functions not declared inline, recursive inlining
9248 happens only when @option{-finline-functions} (included in @option{-O3}) is
9249 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9250 default value is 450.
9252 @item max-inline-recursive-depth
9253 @itemx max-inline-recursive-depth-auto
9254 Specifies the maximum recursion depth used for recursive inlining.
9256 For functions declared inline, @option{--param max-inline-recursive-depth} is
9257 taken into account.  For functions not declared inline, recursive inlining
9258 happens only when @option{-finline-functions} (included in @option{-O3}) is
9259 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9260 default value is 8.
9262 @item min-inline-recursive-probability
9263 Recursive inlining is profitable only for function having deep recursion
9264 in average and can hurt for function having little recursion depth by
9265 increasing the prologue size or complexity of function body to other
9266 optimizers.
9268 When profile feedback is available (see @option{-fprofile-generate}) the actual
9269 recursion depth can be guessed from probability that function recurses via a
9270 given call expression.  This parameter limits inlining only to call expressions
9271 whose probability exceeds the given threshold (in percents).
9272 The default value is 10.
9274 @item early-inlining-insns
9275 Specify growth that the early inliner can make.  In effect it increases
9276 the amount of inlining for code having a large abstraction penalty.
9277 The default value is 10.
9279 @item max-early-inliner-iterations
9280 @itemx max-early-inliner-iterations
9281 Limit of iterations of the early inliner.  This basically bounds
9282 the number of nested indirect calls the early inliner can resolve.
9283 Deeper chains are still handled by late inlining.
9285 @item comdat-sharing-probability
9286 @itemx comdat-sharing-probability
9287 Probability (in percent) that C++ inline function with comdat visibility
9288 are shared across multiple compilation units.  The default value is 20.
9290 @item min-vect-loop-bound
9291 The minimum number of iterations under which loops are not vectorized
9292 when @option{-ftree-vectorize} is used.  The number of iterations after
9293 vectorization needs to be greater than the value specified by this option
9294 to allow vectorization.  The default value is 0.
9296 @item gcse-cost-distance-ratio
9297 Scaling factor in calculation of maximum distance an expression
9298 can be moved by GCSE optimizations.  This is currently supported only in the
9299 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9300 is with simple expressions, i.e., the expressions that have cost
9301 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9302 hoisting of simple expressions.  The default value is 10.
9304 @item gcse-unrestricted-cost
9305 Cost, roughly measured as the cost of a single typical machine
9306 instruction, at which GCSE optimizations do not constrain
9307 the distance an expression can travel.  This is currently
9308 supported only in the code hoisting pass.  The lesser the cost,
9309 the more aggressive code hoisting is.  Specifying 0 
9310 allows all expressions to travel unrestricted distances.
9311 The default value is 3.
9313 @item max-hoist-depth
9314 The depth of search in the dominator tree for expressions to hoist.
9315 This is used to avoid quadratic behavior in hoisting algorithm.
9316 The value of 0 does not limit on the search, but may slow down compilation
9317 of huge functions.  The default value is 30.
9319 @item max-tail-merge-comparisons
9320 The maximum amount of similar bbs to compare a bb with.  This is used to
9321 avoid quadratic behavior in tree tail merging.  The default value is 10.
9323 @item max-tail-merge-iterations
9324 The maximum amount of iterations of the pass over the function.  This is used to
9325 limit compilation time in tree tail merging.  The default value is 2.
9327 @item max-unrolled-insns
9328 The maximum number of instructions that a loop may have to be unrolled.
9329 If a loop is unrolled, this parameter also determines how many times
9330 the loop code is unrolled.
9332 @item max-average-unrolled-insns
9333 The maximum number of instructions biased by probabilities of their execution
9334 that a loop may have to be unrolled.  If a loop is unrolled,
9335 this parameter also determines how many times the loop code is unrolled.
9337 @item max-unroll-times
9338 The maximum number of unrollings of a single loop.
9340 @item max-peeled-insns
9341 The maximum number of instructions that a loop may have to be peeled.
9342 If a loop is peeled, this parameter also determines how many times
9343 the loop code is peeled.
9345 @item max-peel-times
9346 The maximum number of peelings of a single loop.
9348 @item max-peel-branches
9349 The maximum number of branches on the hot path through the peeled sequence.
9351 @item max-completely-peeled-insns
9352 The maximum number of insns of a completely peeled loop.
9354 @item max-completely-peel-times
9355 The maximum number of iterations of a loop to be suitable for complete peeling.
9357 @item max-completely-peel-loop-nest-depth
9358 The maximum depth of a loop nest suitable for complete peeling.
9360 @item max-unswitch-insns
9361 The maximum number of insns of an unswitched loop.
9363 @item max-unswitch-level
9364 The maximum number of branches unswitched in a single loop.
9366 @item lim-expensive
9367 The minimum cost of an expensive expression in the loop invariant motion.
9369 @item iv-consider-all-candidates-bound
9370 Bound on number of candidates for induction variables, below which
9371 all candidates are considered for each use in induction variable
9372 optimizations.  If there are more candidates than this,
9373 only the most relevant ones are considered to avoid quadratic time complexity.
9375 @item iv-max-considered-uses
9376 The induction variable optimizations give up on loops that contain more
9377 induction variable uses.
9379 @item iv-always-prune-cand-set-bound
9380 If the number of candidates in the set is smaller than this value,
9381 always try to remove unnecessary ivs from the set
9382 when adding a new one.
9384 @item scev-max-expr-size
9385 Bound on size of expressions used in the scalar evolutions analyzer.
9386 Large expressions slow the analyzer.
9388 @item scev-max-expr-complexity
9389 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9390 Complex expressions slow the analyzer.
9392 @item omega-max-vars
9393 The maximum number of variables in an Omega constraint system.
9394 The default value is 128.
9396 @item omega-max-geqs
9397 The maximum number of inequalities in an Omega constraint system.
9398 The default value is 256.
9400 @item omega-max-eqs
9401 The maximum number of equalities in an Omega constraint system.
9402 The default value is 128.
9404 @item omega-max-wild-cards
9405 The maximum number of wildcard variables that the Omega solver is
9406 able to insert.  The default value is 18.
9408 @item omega-hash-table-size
9409 The size of the hash table in the Omega solver.  The default value is
9410 550.
9412 @item omega-max-keys
9413 The maximal number of keys used by the Omega solver.  The default
9414 value is 500.
9416 @item omega-eliminate-redundant-constraints
9417 When set to 1, use expensive methods to eliminate all redundant
9418 constraints.  The default value is 0.
9420 @item vect-max-version-for-alignment-checks
9421 The maximum number of run-time checks that can be performed when
9422 doing loop versioning for alignment in the vectorizer. 
9424 @item vect-max-version-for-alias-checks
9425 The maximum number of run-time checks that can be performed when
9426 doing loop versioning for alias in the vectorizer. 
9428 @item vect-max-peeling-for-alignment
9429 The maximum number of loop peels to enhance access alignment
9430 for vectorizer. Value -1 means 'no limit'.
9432 @item max-iterations-to-track
9433 The maximum number of iterations of a loop the brute-force algorithm
9434 for analysis of the number of iterations of the loop tries to evaluate.
9436 @item hot-bb-count-ws-permille
9437 A basic block profile count is considered hot if it contributes to 
9438 the given permillage (i.e. 0...1000) of the entire profiled execution.
9440 @item hot-bb-frequency-fraction
9441 Select fraction of the entry block frequency of executions of basic block in
9442 function given basic block needs to have to be considered hot.
9444 @item max-predicted-iterations
9445 The maximum number of loop iterations we predict statically.  This is useful
9446 in cases where a function contains a single loop with known bound and
9447 another loop with unknown bound.
9448 The known number of iterations is predicted correctly, while
9449 the unknown number of iterations average to roughly 10.  This means that the
9450 loop without bounds appears artificially cold relative to the other one.
9452 @item builtin-expect-probability
9453 Control the probability of the expression having the specified value. This
9454 parameter takes a percentage (i.e. 0 ... 100) as input.
9455 The default probability of 90 is obtained empirically.
9457 @item align-threshold
9459 Select fraction of the maximal frequency of executions of a basic block in
9460 a function to align the basic block.
9462 @item align-loop-iterations
9464 A loop expected to iterate at least the selected number of iterations is
9465 aligned.
9467 @item tracer-dynamic-coverage
9468 @itemx tracer-dynamic-coverage-feedback
9470 This value is used to limit superblock formation once the given percentage of
9471 executed instructions is covered.  This limits unnecessary code size
9472 expansion.
9474 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9475 feedback is available.  The real profiles (as opposed to statically estimated
9476 ones) are much less balanced allowing the threshold to be larger value.
9478 @item tracer-max-code-growth
9479 Stop tail duplication once code growth has reached given percentage.  This is
9480 a rather artificial limit, as most of the duplicates are eliminated later in
9481 cross jumping, so it may be set to much higher values than is the desired code
9482 growth.
9484 @item tracer-min-branch-ratio
9486 Stop reverse growth when the reverse probability of best edge is less than this
9487 threshold (in percent).
9489 @item tracer-min-branch-ratio
9490 @itemx tracer-min-branch-ratio-feedback
9492 Stop forward growth if the best edge has probability lower than this
9493 threshold.
9495 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9496 compilation for profile feedback and one for compilation without.  The value
9497 for compilation with profile feedback needs to be more conservative (higher) in
9498 order to make tracer effective.
9500 @item max-cse-path-length
9502 The maximum number of basic blocks on path that CSE considers.
9503 The default is 10.
9505 @item max-cse-insns
9506 The maximum number of instructions CSE processes before flushing.
9507 The default is 1000.
9509 @item ggc-min-expand
9511 GCC uses a garbage collector to manage its own memory allocation.  This
9512 parameter specifies the minimum percentage by which the garbage
9513 collector's heap should be allowed to expand between collections.
9514 Tuning this may improve compilation speed; it has no effect on code
9515 generation.
9517 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9518 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9519 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9520 GCC is not able to calculate RAM on a particular platform, the lower
9521 bound of 30% is used.  Setting this parameter and
9522 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9523 every opportunity.  This is extremely slow, but can be useful for
9524 debugging.
9526 @item ggc-min-heapsize
9528 Minimum size of the garbage collector's heap before it begins bothering
9529 to collect garbage.  The first collection occurs after the heap expands
9530 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9531 tuning this may improve compilation speed, and has no effect on code
9532 generation.
9534 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9535 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9536 with a lower bound of 4096 (four megabytes) and an upper bound of
9537 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9538 particular platform, the lower bound is used.  Setting this parameter
9539 very large effectively disables garbage collection.  Setting this
9540 parameter and @option{ggc-min-expand} to zero causes a full collection
9541 to occur at every opportunity.
9543 @item max-reload-search-insns
9544 The maximum number of instruction reload should look backward for equivalent
9545 register.  Increasing values mean more aggressive optimization, making the
9546 compilation time increase with probably slightly better performance.
9547 The default value is 100.
9549 @item max-cselib-memory-locations
9550 The maximum number of memory locations cselib should take into account.
9551 Increasing values mean more aggressive optimization, making the compilation time
9552 increase with probably slightly better performance.  The default value is 500.
9554 @item reorder-blocks-duplicate
9555 @itemx reorder-blocks-duplicate-feedback
9557 Used by the basic block reordering pass to decide whether to use unconditional
9558 branch or duplicate the code on its destination.  Code is duplicated when its
9559 estimated size is smaller than this value multiplied by the estimated size of
9560 unconditional jump in the hot spots of the program.
9562 The @option{reorder-block-duplicate-feedback} is used only when profile
9563 feedback is available.  It may be set to higher values than
9564 @option{reorder-block-duplicate} since information about the hot spots is more
9565 accurate.
9567 @item max-sched-ready-insns
9568 The maximum number of instructions ready to be issued the scheduler should
9569 consider at any given time during the first scheduling pass.  Increasing
9570 values mean more thorough searches, making the compilation time increase
9571 with probably little benefit.  The default value is 100.
9573 @item max-sched-region-blocks
9574 The maximum number of blocks in a region to be considered for
9575 interblock scheduling.  The default value is 10.
9577 @item max-pipeline-region-blocks
9578 The maximum number of blocks in a region to be considered for
9579 pipelining in the selective scheduler.  The default value is 15.
9581 @item max-sched-region-insns
9582 The maximum number of insns in a region to be considered for
9583 interblock scheduling.  The default value is 100.
9585 @item max-pipeline-region-insns
9586 The maximum number of insns in a region to be considered for
9587 pipelining in the selective scheduler.  The default value is 200.
9589 @item min-spec-prob
9590 The minimum probability (in percents) of reaching a source block
9591 for interblock speculative scheduling.  The default value is 40.
9593 @item max-sched-extend-regions-iters
9594 The maximum number of iterations through CFG to extend regions.
9595 A value of 0 (the default) disables region extensions.
9597 @item max-sched-insn-conflict-delay
9598 The maximum conflict delay for an insn to be considered for speculative motion.
9599 The default value is 3.
9601 @item sched-spec-prob-cutoff
9602 The minimal probability of speculation success (in percents), so that
9603 speculative insns are scheduled.
9604 The default value is 40.
9606 @item sched-spec-state-edge-prob-cutoff
9607 The minimum probability an edge must have for the scheduler to save its
9608 state across it.
9609 The default value is 10.
9611 @item sched-mem-true-dep-cost
9612 Minimal distance (in CPU cycles) between store and load targeting same
9613 memory locations.  The default value is 1.
9615 @item selsched-max-lookahead
9616 The maximum size of the lookahead window of selective scheduling.  It is a
9617 depth of search for available instructions.
9618 The default value is 50.
9620 @item selsched-max-sched-times
9621 The maximum number of times that an instruction is scheduled during
9622 selective scheduling.  This is the limit on the number of iterations
9623 through which the instruction may be pipelined.  The default value is 2.
9625 @item selsched-max-insns-to-rename
9626 The maximum number of best instructions in the ready list that are considered
9627 for renaming in the selective scheduler.  The default value is 2.
9629 @item sms-min-sc
9630 The minimum value of stage count that swing modulo scheduler
9631 generates.  The default value is 2.
9633 @item max-last-value-rtl
9634 The maximum size measured as number of RTLs that can be recorded in an expression
9635 in combiner for a pseudo register as last known value of that register.  The default
9636 is 10000.
9638 @item integer-share-limit
9639 Small integer constants can use a shared data structure, reducing the
9640 compiler's memory usage and increasing its speed.  This sets the maximum
9641 value of a shared integer constant.  The default value is 256.
9643 @item ssp-buffer-size
9644 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9645 protection when @option{-fstack-protection} is used.
9647 @item min-size-for-stack-sharing
9648 The minimum size of variables taking part in stack slot sharing when not
9649 optimizing. The default value is 32.
9651 @item max-jump-thread-duplication-stmts
9652 Maximum number of statements allowed in a block that needs to be
9653 duplicated when threading jumps.
9655 @item max-fields-for-field-sensitive
9656 Maximum number of fields in a structure treated in
9657 a field sensitive manner during pointer analysis.  The default is zero
9658 for @option{-O0} and @option{-O1},
9659 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9661 @item prefetch-latency
9662 Estimate on average number of instructions that are executed before
9663 prefetch finishes.  The distance prefetched ahead is proportional
9664 to this constant.  Increasing this number may also lead to less
9665 streams being prefetched (see @option{simultaneous-prefetches}).
9667 @item simultaneous-prefetches
9668 Maximum number of prefetches that can run at the same time.
9670 @item l1-cache-line-size
9671 The size of cache line in L1 cache, in bytes.
9673 @item l1-cache-size
9674 The size of L1 cache, in kilobytes.
9676 @item l2-cache-size
9677 The size of L2 cache, in kilobytes.
9679 @item min-insn-to-prefetch-ratio
9680 The minimum ratio between the number of instructions and the
9681 number of prefetches to enable prefetching in a loop.
9683 @item prefetch-min-insn-to-mem-ratio
9684 The minimum ratio between the number of instructions and the
9685 number of memory references to enable prefetching in a loop.
9687 @item use-canonical-types
9688 Whether the compiler should use the ``canonical'' type system.  By
9689 default, this should always be 1, which uses a more efficient internal
9690 mechanism for comparing types in C++ and Objective-C++.  However, if
9691 bugs in the canonical type system are causing compilation failures,
9692 set this value to 0 to disable canonical types.
9694 @item switch-conversion-max-branch-ratio
9695 Switch initialization conversion refuses to create arrays that are
9696 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9697 branches in the switch.
9699 @item max-partial-antic-length
9700 Maximum length of the partial antic set computed during the tree
9701 partial redundancy elimination optimization (@option{-ftree-pre}) when
9702 optimizing at @option{-O3} and above.  For some sorts of source code
9703 the enhanced partial redundancy elimination optimization can run away,
9704 consuming all of the memory available on the host machine.  This
9705 parameter sets a limit on the length of the sets that are computed,
9706 which prevents the runaway behavior.  Setting a value of 0 for
9707 this parameter allows an unlimited set length.
9709 @item sccvn-max-scc-size
9710 Maximum size of a strongly connected component (SCC) during SCCVN
9711 processing.  If this limit is hit, SCCVN processing for the whole
9712 function is not done and optimizations depending on it are
9713 disabled.  The default maximum SCC size is 10000.
9715 @item sccvn-max-alias-queries-per-access
9716 Maximum number of alias-oracle queries we perform when looking for
9717 redundancies for loads and stores.  If this limit is hit the search
9718 is aborted and the load or store is not considered redundant.  The
9719 number of queries is algorithmically limited to the number of
9720 stores on all paths from the load to the function entry.
9721 The default maxmimum number of queries is 1000.
9723 @item ira-max-loops-num
9724 IRA uses regional register allocation by default.  If a function
9725 contains more loops than the number given by this parameter, only at most
9726 the given number of the most frequently-executed loops form regions
9727 for regional register allocation.  The default value of the
9728 parameter is 100.
9730 @item ira-max-conflict-table-size 
9731 Although IRA uses a sophisticated algorithm to compress the conflict
9732 table, the table can still require excessive amounts of memory for
9733 huge functions.  If the conflict table for a function could be more
9734 than the size in MB given by this parameter, the register allocator
9735 instead uses a faster, simpler, and lower-quality
9736 algorithm that does not require building a pseudo-register conflict table.  
9737 The default value of the parameter is 2000.
9739 @item ira-loop-reserved-regs
9740 IRA can be used to evaluate more accurate register pressure in loops
9741 for decisions to move loop invariants (see @option{-O3}).  The number
9742 of available registers reserved for some other purposes is given
9743 by this parameter.  The default value of the parameter is 2, which is
9744 the minimal number of registers needed by typical instructions.
9745 This value is the best found from numerous experiments.
9747 @item loop-invariant-max-bbs-in-loop
9748 Loop invariant motion can be very expensive, both in compilation time and
9749 in amount of needed compile-time memory, with very large loops.  Loops
9750 with more basic blocks than this parameter won't have loop invariant
9751 motion optimization performed on them.  The default value of the
9752 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9754 @item loop-max-datarefs-for-datadeps
9755 Building data dapendencies is expensive for very large loops.  This
9756 parameter limits the number of data references in loops that are
9757 considered for data dependence analysis.  These large loops are no
9758 handled by the optimizations using loop data dependencies.
9759 The default value is 1000.
9761 @item max-vartrack-size
9762 Sets a maximum number of hash table slots to use during variable
9763 tracking dataflow analysis of any function.  If this limit is exceeded
9764 with variable tracking at assignments enabled, analysis for that
9765 function is retried without it, after removing all debug insns from
9766 the function.  If the limit is exceeded even without debug insns, var
9767 tracking analysis is completely disabled for the function.  Setting
9768 the parameter to zero makes it unlimited.
9770 @item max-vartrack-expr-depth
9771 Sets a maximum number of recursion levels when attempting to map
9772 variable names or debug temporaries to value expressions.  This trades
9773 compilation time for more complete debug information.  If this is set too
9774 low, value expressions that are available and could be represented in
9775 debug information may end up not being used; setting this higher may
9776 enable the compiler to find more complex debug expressions, but compile
9777 time and memory use may grow.  The default is 12.
9779 @item min-nondebug-insn-uid
9780 Use uids starting at this parameter for nondebug insns.  The range below
9781 the parameter is reserved exclusively for debug insns created by
9782 @option{-fvar-tracking-assignments}, but debug insns may get
9783 (non-overlapping) uids above it if the reserved range is exhausted.
9785 @item ipa-sra-ptr-growth-factor
9786 IPA-SRA replaces a pointer to an aggregate with one or more new
9787 parameters only when their cumulative size is less or equal to
9788 @option{ipa-sra-ptr-growth-factor} times the size of the original
9789 pointer parameter.
9791 @item tm-max-aggregate-size
9792 When making copies of thread-local variables in a transaction, this
9793 parameter specifies the size in bytes after which variables are
9794 saved with the logging functions as opposed to save/restore code
9795 sequence pairs.  This option only applies when using
9796 @option{-fgnu-tm}.
9798 @item graphite-max-nb-scop-params
9799 To avoid exponential effects in the Graphite loop transforms, the
9800 number of parameters in a Static Control Part (SCoP) is bounded.  The
9801 default value is 10 parameters.  A variable whose value is unknown at
9802 compilation time and defined outside a SCoP is a parameter of the SCoP.
9804 @item graphite-max-bbs-per-function
9805 To avoid exponential effects in the detection of SCoPs, the size of
9806 the functions analyzed by Graphite is bounded.  The default value is
9807 100 basic blocks.
9809 @item loop-block-tile-size
9810 Loop blocking or strip mining transforms, enabled with
9811 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9812 loop in the loop nest by a given number of iterations.  The strip
9813 length can be changed using the @option{loop-block-tile-size}
9814 parameter.  The default value is 51 iterations.
9816 @item ipa-cp-value-list-size
9817 IPA-CP attempts to track all possible values and types passed to a function's
9818 parameter in order to propagate them and perform devirtualization.
9819 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9820 stores per one formal parameter of a function.
9822 @item lto-partitions
9823 Specify desired number of partitions produced during WHOPR compilation.
9824 The number of partitions should exceed the number of CPUs used for compilation.
9825 The default value is 32.
9827 @item lto-minpartition
9828 Size of minimal partition for WHOPR (in estimated instructions).
9829 This prevents expenses of splitting very small programs into too many
9830 partitions.
9832 @item cxx-max-namespaces-for-diagnostic-help
9833 The maximum number of namespaces to consult for suggestions when C++
9834 name lookup fails for an identifier.  The default is 1000.
9836 @item sink-frequency-threshold
9837 The maximum relative execution frequency (in percents) of the target block
9838 relative to a statement's original block to allow statement sinking of a
9839 statement.  Larger numbers result in more aggressive statement sinking.
9840 The default value is 75.  A small positive adjustment is applied for
9841 statements with memory operands as those are even more profitable so sink.
9843 @item max-stores-to-sink
9844 The maximum number of conditional stores paires that can be sunk.  Set to 0
9845 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9846 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9848 @item allow-load-data-races
9849 Allow optimizers to introduce new data races on loads.
9850 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9851 unless implicitly set by the @option{-fmemory-model=} option.
9853 @item allow-store-data-races
9854 Allow optimizers to introduce new data races on stores.
9855 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9856 unless implicitly set by the @option{-fmemory-model=} option.
9858 @item allow-packed-load-data-races
9859 Allow optimizers to introduce new data races on packed data loads.
9860 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9861 unless implicitly set by the @option{-fmemory-model=} option.
9863 @item allow-packed-store-data-races
9864 Allow optimizers to introduce new data races on packed data stores.
9865 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9866 unless implicitly set by the @option{-fmemory-model=} option.
9868 @item case-values-threshold
9869 The smallest number of different values for which it is best to use a
9870 jump-table instead of a tree of conditional branches.  If the value is
9871 0, use the default for the machine.  The default is 0.
9873 @item tree-reassoc-width
9874 Set the maximum number of instructions executed in parallel in
9875 reassociated tree. This parameter overrides target dependent
9876 heuristics used by default if has non zero value.
9878 @item sched-pressure-algorithm
9879 Choose between the two available implementations of
9880 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9881 and is the more likely to prevent instructions from being reordered.
9882 Algorithm 2 was designed to be a compromise between the relatively
9883 conservative approach taken by algorithm 1 and the rather aggressive
9884 approach taken by the default scheduler.  It relies more heavily on
9885 having a regular register file and accurate register pressure classes.
9886 See @file{haifa-sched.c} in the GCC sources for more details.
9888 The default choice depends on the target.
9890 @item max-slsr-cand-scan
9891 Set the maximum number of existing candidates that will be considered when
9892 seeking a basis for a new straight-line strength reduction candidate.
9894 @end table
9895 @end table
9897 @node Preprocessor Options
9898 @section Options Controlling the Preprocessor
9899 @cindex preprocessor options
9900 @cindex options, preprocessor
9902 These options control the C preprocessor, which is run on each C source
9903 file before actual compilation.
9905 If you use the @option{-E} option, nothing is done except preprocessing.
9906 Some of these options make sense only together with @option{-E} because
9907 they cause the preprocessor output to be unsuitable for actual
9908 compilation.
9910 @table @gcctabopt
9911 @item -Wp,@var{option}
9912 @opindex Wp
9913 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9914 and pass @var{option} directly through to the preprocessor.  If
9915 @var{option} contains commas, it is split into multiple options at the
9916 commas.  However, many options are modified, translated or interpreted
9917 by the compiler driver before being passed to the preprocessor, and
9918 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9919 interface is undocumented and subject to change, so whenever possible
9920 you should avoid using @option{-Wp} and let the driver handle the
9921 options instead.
9923 @item -Xpreprocessor @var{option}
9924 @opindex Xpreprocessor
9925 Pass @var{option} as an option to the preprocessor.  You can use this to
9926 supply system-specific preprocessor options that GCC does not 
9927 recognize.
9929 If you want to pass an option that takes an argument, you must use
9930 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9932 @item -no-integrated-cpp
9933 @opindex no-integrated-cpp
9934 Perform preprocessing as a separate pass before compilation.
9935 By default, GCC performs preprocessing as an integrated part of
9936 input tokenization and parsing.
9937 If this option is provided, the appropriate language front end
9938 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9939 and Objective-C, respectively) is instead invoked twice,
9940 once for preprocessing only and once for actual compilation
9941 of the preprocessed input.
9942 This option may be useful in conjunction with the @option{-B} or
9943 @option{-wrapper} options to specify an alternate preprocessor or
9944 perform additional processing of the program source between
9945 normal preprocessing and compilation.
9946 @end table
9948 @include cppopts.texi
9950 @node Assembler Options
9951 @section Passing Options to the Assembler
9953 @c prevent bad page break with this line
9954 You can pass options to the assembler.
9956 @table @gcctabopt
9957 @item -Wa,@var{option}
9958 @opindex Wa
9959 Pass @var{option} as an option to the assembler.  If @var{option}
9960 contains commas, it is split into multiple options at the commas.
9962 @item -Xassembler @var{option}
9963 @opindex Xassembler
9964 Pass @var{option} as an option to the assembler.  You can use this to
9965 supply system-specific assembler options that GCC does not
9966 recognize.
9968 If you want to pass an option that takes an argument, you must use
9969 @option{-Xassembler} twice, once for the option and once for the argument.
9971 @end table
9973 @node Link Options
9974 @section Options for Linking
9975 @cindex link options
9976 @cindex options, linking
9978 These options come into play when the compiler links object files into
9979 an executable output file.  They are meaningless if the compiler is
9980 not doing a link step.
9982 @table @gcctabopt
9983 @cindex file names
9984 @item @var{object-file-name}
9985 A file name that does not end in a special recognized suffix is
9986 considered to name an object file or library.  (Object files are
9987 distinguished from libraries by the linker according to the file
9988 contents.)  If linking is done, these object files are used as input
9989 to the linker.
9991 @item -c
9992 @itemx -S
9993 @itemx -E
9994 @opindex c
9995 @opindex S
9996 @opindex E
9997 If any of these options is used, then the linker is not run, and
9998 object file names should not be used as arguments.  @xref{Overall
9999 Options}.
10001 @cindex Libraries
10002 @item -l@var{library}
10003 @itemx -l @var{library}
10004 @opindex l
10005 Search the library named @var{library} when linking.  (The second
10006 alternative with the library as a separate argument is only for
10007 POSIX compliance and is not recommended.)
10009 It makes a difference where in the command you write this option; the
10010 linker searches and processes libraries and object files in the order they
10011 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10012 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10013 to functions in @samp{z}, those functions may not be loaded.
10015 The linker searches a standard list of directories for the library,
10016 which is actually a file named @file{lib@var{library}.a}.  The linker
10017 then uses this file as if it had been specified precisely by name.
10019 The directories searched include several standard system directories
10020 plus any that you specify with @option{-L}.
10022 Normally the files found this way are library files---archive files
10023 whose members are object files.  The linker handles an archive file by
10024 scanning through it for members which define symbols that have so far
10025 been referenced but not defined.  But if the file that is found is an
10026 ordinary object file, it is linked in the usual fashion.  The only
10027 difference between using an @option{-l} option and specifying a file name
10028 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10029 and searches several directories.
10031 @item -lobjc
10032 @opindex lobjc
10033 You need this special case of the @option{-l} option in order to
10034 link an Objective-C or Objective-C++ program.
10036 @item -nostartfiles
10037 @opindex nostartfiles
10038 Do not use the standard system startup files when linking.
10039 The standard system libraries are used normally, unless @option{-nostdlib}
10040 or @option{-nodefaultlibs} is used.
10042 @item -nodefaultlibs
10043 @opindex nodefaultlibs
10044 Do not use the standard system libraries when linking.
10045 Only the libraries you specify are passed to the linker, and options
10046 specifying linkage of the system libraries, such as @code{-static-libgcc}
10047 or @code{-shared-libgcc}, are ignored.  
10048 The standard startup files are used normally, unless @option{-nostartfiles}
10049 is used.  
10051 The compiler may generate calls to @code{memcmp},
10052 @code{memset}, @code{memcpy} and @code{memmove}.
10053 These entries are usually resolved by entries in
10054 libc.  These entry points should be supplied through some other
10055 mechanism when this option is specified.
10057 @item -nostdlib
10058 @opindex nostdlib
10059 Do not use the standard system startup files or libraries when linking.
10060 No startup files and only the libraries you specify are passed to
10061 the linker, and options specifying linkage of the system libraries, such as
10062 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10064 The compiler may generate calls to @code{memcmp}, @code{memset},
10065 @code{memcpy} and @code{memmove}.
10066 These entries are usually resolved by entries in
10067 libc.  These entry points should be supplied through some other
10068 mechanism when this option is specified.
10070 @cindex @option{-lgcc}, use with @option{-nostdlib}
10071 @cindex @option{-nostdlib} and unresolved references
10072 @cindex unresolved references and @option{-nostdlib}
10073 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10074 @cindex @option{-nodefaultlibs} and unresolved references
10075 @cindex unresolved references and @option{-nodefaultlibs}
10076 One of the standard libraries bypassed by @option{-nostdlib} and
10077 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10078 which GCC uses to overcome shortcomings of particular machines, or special
10079 needs for some languages.
10080 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10081 Collection (GCC) Internals},
10082 for more discussion of @file{libgcc.a}.)
10083 In most cases, you need @file{libgcc.a} even when you want to avoid
10084 other standard libraries.  In other words, when you specify @option{-nostdlib}
10085 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10086 This ensures that you have no unresolved references to internal GCC
10087 library subroutines.
10088 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10089 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10090 GNU Compiler Collection (GCC) Internals}.)
10092 @item -pie
10093 @opindex pie
10094 Produce a position independent executable on targets that support it.
10095 For predictable results, you must also specify the same set of options
10096 used for compilation (@option{-fpie}, @option{-fPIE},
10097 or model suboptions) when you specify this linker option.
10099 @item -rdynamic
10100 @opindex rdynamic
10101 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10102 that support it. This instructs the linker to add all symbols, not
10103 only used ones, to the dynamic symbol table. This option is needed
10104 for some uses of @code{dlopen} or to allow obtaining backtraces
10105 from within a program.
10107 @item -s
10108 @opindex s
10109 Remove all symbol table and relocation information from the executable.
10111 @item -static
10112 @opindex static
10113 On systems that support dynamic linking, this prevents linking with the shared
10114 libraries.  On other systems, this option has no effect.
10116 @item -shared
10117 @opindex shared
10118 Produce a shared object which can then be linked with other objects to
10119 form an executable.  Not all systems support this option.  For predictable
10120 results, you must also specify the same set of options used for compilation
10121 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10122 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10123 needs to build supplementary stub code for constructors to work.  On
10124 multi-libbed systems, @samp{gcc -shared} must select the correct support
10125 libraries to link against.  Failing to supply the correct flags may lead
10126 to subtle defects.  Supplying them in cases where they are not necessary
10127 is innocuous.}
10129 @item -shared-libgcc
10130 @itemx -static-libgcc
10131 @opindex shared-libgcc
10132 @opindex static-libgcc
10133 On systems that provide @file{libgcc} as a shared library, these options
10134 force the use of either the shared or static version, respectively.
10135 If no shared version of @file{libgcc} was built when the compiler was
10136 configured, these options have no effect.
10138 There are several situations in which an application should use the
10139 shared @file{libgcc} instead of the static version.  The most common
10140 of these is when the application wishes to throw and catch exceptions
10141 across different shared libraries.  In that case, each of the libraries
10142 as well as the application itself should use the shared @file{libgcc}.
10144 Therefore, the G++ and GCJ drivers automatically add
10145 @option{-shared-libgcc} whenever you build a shared library or a main
10146 executable, because C++ and Java programs typically use exceptions, so
10147 this is the right thing to do.
10149 If, instead, you use the GCC driver to create shared libraries, you may
10150 find that they are not always linked with the shared @file{libgcc}.
10151 If GCC finds, at its configuration time, that you have a non-GNU linker
10152 or a GNU linker that does not support option @option{--eh-frame-hdr},
10153 it links the shared version of @file{libgcc} into shared libraries
10154 by default.  Otherwise, it takes advantage of the linker and optimizes
10155 away the linking with the shared version of @file{libgcc}, linking with
10156 the static version of libgcc by default.  This allows exceptions to
10157 propagate through such shared libraries, without incurring relocation
10158 costs at library load time.
10160 However, if a library or main executable is supposed to throw or catch
10161 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10162 for the languages used in the program, or using the option
10163 @option{-shared-libgcc}, such that it is linked with the shared
10164 @file{libgcc}.
10166 @item -static-libasan
10167 When the @option{-fsanitize=address} option is used to link a program,
10168 the GCC driver automatically links against @option{libasan}.  If
10169 @file{libasan} is available as a shared library, and the @option{-static}
10170 option is not used, then this links against the shared version of
10171 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10172 driver to link @file{libasan} statically, without necessarily linking
10173 other libraries statically.
10175 @item -static-libtsan
10176 When the @option{-fsanitize=thread} option is used to link a program,
10177 the GCC driver automatically links against @option{libtsan}.  If
10178 @file{libtsan} is available as a shared library, and the @option{-static}
10179 option is not used, then this links against the shared version of
10180 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10181 driver to link @file{libtsan} statically, without necessarily linking
10182 other libraries statically.
10184 @item -static-libubsan
10185 When the @option{-fsanitize=undefined} option is used to link a program,
10186 the GCC driver automatically links against @option{libubsan}.  If
10187 @file{libubsan} is available as a shared library, and the @option{-static}
10188 option is not used, then this links against the shared version of
10189 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10190 driver to link @file{libubsan} statically, without necessarily linking
10191 other libraries statically.
10193 @item -static-libstdc++
10194 When the @command{g++} program is used to link a C++ program, it
10195 normally automatically links against @option{libstdc++}.  If
10196 @file{libstdc++} is available as a shared library, and the
10197 @option{-static} option is not used, then this links against the
10198 shared version of @file{libstdc++}.  That is normally fine.  However, it
10199 is sometimes useful to freeze the version of @file{libstdc++} used by
10200 the program without going all the way to a fully static link.  The
10201 @option{-static-libstdc++} option directs the @command{g++} driver to
10202 link @file{libstdc++} statically, without necessarily linking other
10203 libraries statically.
10205 @item -symbolic
10206 @opindex symbolic
10207 Bind references to global symbols when building a shared object.  Warn
10208 about any unresolved references (unless overridden by the link editor
10209 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10210 this option.
10212 @item -T @var{script}
10213 @opindex T
10214 @cindex linker script
10215 Use @var{script} as the linker script.  This option is supported by most
10216 systems using the GNU linker.  On some targets, such as bare-board
10217 targets without an operating system, the @option{-T} option may be required
10218 when linking to avoid references to undefined symbols.
10220 @item -Xlinker @var{option}
10221 @opindex Xlinker
10222 Pass @var{option} as an option to the linker.  You can use this to
10223 supply system-specific linker options that GCC does not recognize.
10225 If you want to pass an option that takes a separate argument, you must use
10226 @option{-Xlinker} twice, once for the option and once for the argument.
10227 For example, to pass @option{-assert definitions}, you must write
10228 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10229 @option{-Xlinker "-assert definitions"}, because this passes the entire
10230 string as a single argument, which is not what the linker expects.
10232 When using the GNU linker, it is usually more convenient to pass
10233 arguments to linker options using the @option{@var{option}=@var{value}}
10234 syntax than as separate arguments.  For example, you can specify
10235 @option{-Xlinker -Map=output.map} rather than
10236 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10237 this syntax for command-line options.
10239 @item -Wl,@var{option}
10240 @opindex Wl
10241 Pass @var{option} as an option to the linker.  If @var{option} contains
10242 commas, it is split into multiple options at the commas.  You can use this
10243 syntax to pass an argument to the option.
10244 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10245 linker.  When using the GNU linker, you can also get the same effect with
10246 @option{-Wl,-Map=output.map}.
10248 @item -u @var{symbol}
10249 @opindex u
10250 Pretend the symbol @var{symbol} is undefined, to force linking of
10251 library modules to define it.  You can use @option{-u} multiple times with
10252 different symbols to force loading of additional library modules.
10253 @end table
10255 @node Directory Options
10256 @section Options for Directory Search
10257 @cindex directory options
10258 @cindex options, directory search
10259 @cindex search path
10261 These options specify directories to search for header files, for
10262 libraries and for parts of the compiler:
10264 @table @gcctabopt
10265 @item -I@var{dir}
10266 @opindex I
10267 Add the directory @var{dir} to the head of the list of directories to be
10268 searched for header files.  This can be used to override a system header
10269 file, substituting your own version, since these directories are
10270 searched before the system header file directories.  However, you should
10271 not use this option to add directories that contain vendor-supplied
10272 system header files (use @option{-isystem} for that).  If you use more than
10273 one @option{-I} option, the directories are scanned in left-to-right
10274 order; the standard system directories come after.
10276 If a standard system include directory, or a directory specified with
10277 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10278 option is ignored.  The directory is still searched but as a
10279 system directory at its normal position in the system include chain.
10280 This is to ensure that GCC's procedure to fix buggy system headers and
10281 the ordering for the @code{include_next} directive are not inadvertently changed.
10282 If you really need to change the search order for system directories,
10283 use the @option{-nostdinc} and/or @option{-isystem} options.
10285 @item -iplugindir=@var{dir}
10286 Set the directory to search for plugins that are passed
10287 by @option{-fplugin=@var{name}} instead of
10288 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10289 to be used by the user, but only passed by the driver.
10291 @item -iquote@var{dir}
10292 @opindex iquote
10293 Add the directory @var{dir} to the head of the list of directories to
10294 be searched for header files only for the case of @samp{#include
10295 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10296 otherwise just like @option{-I}.
10298 @item -L@var{dir}
10299 @opindex L
10300 Add directory @var{dir} to the list of directories to be searched
10301 for @option{-l}.
10303 @item -B@var{prefix}
10304 @opindex B
10305 This option specifies where to find the executables, libraries,
10306 include files, and data files of the compiler itself.
10308 The compiler driver program runs one or more of the subprograms
10309 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10310 @var{prefix} as a prefix for each program it tries to run, both with and
10311 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10313 For each subprogram to be run, the compiler driver first tries the
10314 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10315 is not specified, the driver tries two standard prefixes, 
10316 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10317 those results in a file name that is found, the unmodified program
10318 name is searched for using the directories specified in your
10319 @env{PATH} environment variable.
10321 The compiler checks to see if the path provided by the @option{-B}
10322 refers to a directory, and if necessary it adds a directory
10323 separator character at the end of the path.
10325 @option{-B} prefixes that effectively specify directory names also apply
10326 to libraries in the linker, because the compiler translates these
10327 options into @option{-L} options for the linker.  They also apply to
10328 include files in the preprocessor, because the compiler translates these
10329 options into @option{-isystem} options for the preprocessor.  In this case,
10330 the compiler appends @samp{include} to the prefix.
10332 The runtime support file @file{libgcc.a} can also be searched for using
10333 the @option{-B} prefix, if needed.  If it is not found there, the two
10334 standard prefixes above are tried, and that is all.  The file is left
10335 out of the link if it is not found by those means.
10337 Another way to specify a prefix much like the @option{-B} prefix is to use
10338 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10339 Variables}.
10341 As a special kludge, if the path provided by @option{-B} is
10342 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10343 9, then it is replaced by @file{[dir/]include}.  This is to help
10344 with boot-strapping the compiler.
10346 @item -specs=@var{file}
10347 @opindex specs
10348 Process @var{file} after the compiler reads in the standard @file{specs}
10349 file, in order to override the defaults which the @command{gcc} driver
10350 program uses when determining what switches to pass to @command{cc1},
10351 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10352 @option{-specs=@var{file}} can be specified on the command line, and they
10353 are processed in order, from left to right.
10355 @item --sysroot=@var{dir}
10356 @opindex sysroot
10357 Use @var{dir} as the logical root directory for headers and libraries.
10358 For example, if the compiler normally searches for headers in
10359 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10360 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10362 If you use both this option and the @option{-isysroot} option, then
10363 the @option{--sysroot} option applies to libraries, but the
10364 @option{-isysroot} option applies to header files.
10366 The GNU linker (beginning with version 2.16) has the necessary support
10367 for this option.  If your linker does not support this option, the
10368 header file aspect of @option{--sysroot} still works, but the
10369 library aspect does not.
10371 @item --no-sysroot-suffix
10372 @opindex no-sysroot-suffix
10373 For some targets, a suffix is added to the root directory specified
10374 with @option{--sysroot}, depending on the other options used, so that
10375 headers may for example be found in
10376 @file{@var{dir}/@var{suffix}/usr/include} instead of
10377 @file{@var{dir}/usr/include}.  This option disables the addition of
10378 such a suffix.
10380 @item -I-
10381 @opindex I-
10382 This option has been deprecated.  Please use @option{-iquote} instead for
10383 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10384 Any directories you specify with @option{-I} options before the @option{-I-}
10385 option are searched only for the case of @samp{#include "@var{file}"};
10386 they are not searched for @samp{#include <@var{file}>}.
10388 If additional directories are specified with @option{-I} options after
10389 the @option{-I-}, these directories are searched for all @samp{#include}
10390 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10391 this way.)
10393 In addition, the @option{-I-} option inhibits the use of the current
10394 directory (where the current input file came from) as the first search
10395 directory for @samp{#include "@var{file}"}.  There is no way to
10396 override this effect of @option{-I-}.  With @option{-I.} you can specify
10397 searching the directory that is current when the compiler is
10398 invoked.  That is not exactly the same as what the preprocessor does
10399 by default, but it is often satisfactory.
10401 @option{-I-} does not inhibit the use of the standard system directories
10402 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10403 independent.
10404 @end table
10406 @c man end
10408 @node Spec Files
10409 @section Specifying subprocesses and the switches to pass to them
10410 @cindex Spec Files
10412 @command{gcc} is a driver program.  It performs its job by invoking a
10413 sequence of other programs to do the work of compiling, assembling and
10414 linking.  GCC interprets its command-line parameters and uses these to
10415 deduce which programs it should invoke, and which command-line options
10416 it ought to place on their command lines.  This behavior is controlled
10417 by @dfn{spec strings}.  In most cases there is one spec string for each
10418 program that GCC can invoke, but a few programs have multiple spec
10419 strings to control their behavior.  The spec strings built into GCC can
10420 be overridden by using the @option{-specs=} command-line switch to specify
10421 a spec file.
10423 @dfn{Spec files} are plaintext files that are used to construct spec
10424 strings.  They consist of a sequence of directives separated by blank
10425 lines.  The type of directive is determined by the first non-whitespace
10426 character on the line, which can be one of the following:
10428 @table @code
10429 @item %@var{command}
10430 Issues a @var{command} to the spec file processor.  The commands that can
10431 appear here are:
10433 @table @code
10434 @item %include <@var{file}>
10435 @cindex @code{%include}
10436 Search for @var{file} and insert its text at the current point in the
10437 specs file.
10439 @item %include_noerr <@var{file}>
10440 @cindex @code{%include_noerr}
10441 Just like @samp{%include}, but do not generate an error message if the include
10442 file cannot be found.
10444 @item %rename @var{old_name} @var{new_name}
10445 @cindex @code{%rename}
10446 Rename the spec string @var{old_name} to @var{new_name}.
10448 @end table
10450 @item *[@var{spec_name}]:
10451 This tells the compiler to create, override or delete the named spec
10452 string.  All lines after this directive up to the next directive or
10453 blank line are considered to be the text for the spec string.  If this
10454 results in an empty string then the spec is deleted.  (Or, if the
10455 spec did not exist, then nothing happens.)  Otherwise, if the spec
10456 does not currently exist a new spec is created.  If the spec does
10457 exist then its contents are overridden by the text of this
10458 directive, unless the first character of that text is the @samp{+}
10459 character, in which case the text is appended to the spec.
10461 @item [@var{suffix}]:
10462 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10463 and up to the next directive or blank line are considered to make up the
10464 spec string for the indicated suffix.  When the compiler encounters an
10465 input file with the named suffix, it processes the spec string in
10466 order to work out how to compile that file.  For example:
10468 @smallexample
10469 .ZZ:
10470 z-compile -input %i
10471 @end smallexample
10473 This says that any input file whose name ends in @samp{.ZZ} should be
10474 passed to the program @samp{z-compile}, which should be invoked with the
10475 command-line switch @option{-input} and with the result of performing the
10476 @samp{%i} substitution.  (See below.)
10478 As an alternative to providing a spec string, the text following a
10479 suffix directive can be one of the following:
10481 @table @code
10482 @item @@@var{language}
10483 This says that the suffix is an alias for a known @var{language}.  This is
10484 similar to using the @option{-x} command-line switch to GCC to specify a
10485 language explicitly.  For example:
10487 @smallexample
10488 .ZZ:
10489 @@c++
10490 @end smallexample
10492 Says that .ZZ files are, in fact, C++ source files.
10494 @item #@var{name}
10495 This causes an error messages saying:
10497 @smallexample
10498 @var{name} compiler not installed on this system.
10499 @end smallexample
10500 @end table
10502 GCC already has an extensive list of suffixes built into it.
10503 This directive adds an entry to the end of the list of suffixes, but
10504 since the list is searched from the end backwards, it is effectively
10505 possible to override earlier entries using this technique.
10507 @end table
10509 GCC has the following spec strings built into it.  Spec files can
10510 override these strings or create their own.  Note that individual
10511 targets can also add their own spec strings to this list.
10513 @smallexample
10514 asm          Options to pass to the assembler
10515 asm_final    Options to pass to the assembler post-processor
10516 cpp          Options to pass to the C preprocessor
10517 cc1          Options to pass to the C compiler
10518 cc1plus      Options to pass to the C++ compiler
10519 endfile      Object files to include at the end of the link
10520 link         Options to pass to the linker
10521 lib          Libraries to include on the command line to the linker
10522 libgcc       Decides which GCC support library to pass to the linker
10523 linker       Sets the name of the linker
10524 predefines   Defines to be passed to the C preprocessor
10525 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10526              by default
10527 startfile    Object files to include at the start of the link
10528 @end smallexample
10530 Here is a small example of a spec file:
10532 @smallexample
10533 %rename lib                 old_lib
10535 *lib:
10536 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10537 @end smallexample
10539 This example renames the spec called @samp{lib} to @samp{old_lib} and
10540 then overrides the previous definition of @samp{lib} with a new one.
10541 The new definition adds in some extra command-line options before
10542 including the text of the old definition.
10544 @dfn{Spec strings} are a list of command-line options to be passed to their
10545 corresponding program.  In addition, the spec strings can contain
10546 @samp{%}-prefixed sequences to substitute variable text or to
10547 conditionally insert text into the command line.  Using these constructs
10548 it is possible to generate quite complex command lines.
10550 Here is a table of all defined @samp{%}-sequences for spec
10551 strings.  Note that spaces are not generated automatically around the
10552 results of expanding these sequences.  Therefore you can concatenate them
10553 together or combine them with constant text in a single argument.
10555 @table @code
10556 @item %%
10557 Substitute one @samp{%} into the program name or argument.
10559 @item %i
10560 Substitute the name of the input file being processed.
10562 @item %b
10563 Substitute the basename of the input file being processed.
10564 This is the substring up to (and not including) the last period
10565 and not including the directory.
10567 @item %B
10568 This is the same as @samp{%b}, but include the file suffix (text after
10569 the last period).
10571 @item %d
10572 Marks the argument containing or following the @samp{%d} as a
10573 temporary file name, so that that file is deleted if GCC exits
10574 successfully.  Unlike @samp{%g}, this contributes no text to the
10575 argument.
10577 @item %g@var{suffix}
10578 Substitute a file name that has suffix @var{suffix} and is chosen
10579 once per compilation, and mark the argument in the same way as
10580 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10581 name is now chosen in a way that is hard to predict even when previously
10582 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10583 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10584 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10585 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10586 was simply substituted with a file name chosen once per compilation,
10587 without regard to any appended suffix (which was therefore treated
10588 just like ordinary text), making such attacks more likely to succeed.
10590 @item %u@var{suffix}
10591 Like @samp{%g}, but generates a new temporary file name
10592 each time it appears instead of once per compilation.
10594 @item %U@var{suffix}
10595 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10596 new one if there is no such last file name.  In the absence of any
10597 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10598 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10599 involves the generation of two distinct file names, one
10600 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10601 simply substituted with a file name chosen for the previous @samp{%u},
10602 without regard to any appended suffix.
10604 @item %j@var{suffix}
10605 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10606 writable, and if @option{-save-temps} is not used; 
10607 otherwise, substitute the name
10608 of a temporary file, just like @samp{%u}.  This temporary file is not
10609 meant for communication between processes, but rather as a junk
10610 disposal mechanism.
10612 @item %|@var{suffix}
10613 @itemx %m@var{suffix}
10614 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10615 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10616 all.  These are the two most common ways to instruct a program that it
10617 should read from standard input or write to standard output.  If you
10618 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10619 construct: see for example @file{f/lang-specs.h}.
10621 @item %.@var{SUFFIX}
10622 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10623 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10624 terminated by the next space or %.
10626 @item %w
10627 Marks the argument containing or following the @samp{%w} as the
10628 designated output file of this compilation.  This puts the argument
10629 into the sequence of arguments that @samp{%o} substitutes.
10631 @item %o
10632 Substitutes the names of all the output files, with spaces
10633 automatically placed around them.  You should write spaces
10634 around the @samp{%o} as well or the results are undefined.
10635 @samp{%o} is for use in the specs for running the linker.
10636 Input files whose names have no recognized suffix are not compiled
10637 at all, but they are included among the output files, so they are
10638 linked.
10640 @item %O
10641 Substitutes the suffix for object files.  Note that this is
10642 handled specially when it immediately follows @samp{%g, %u, or %U},
10643 because of the need for those to form complete file names.  The
10644 handling is such that @samp{%O} is treated exactly as if it had already
10645 been substituted, except that @samp{%g, %u, and %U} do not currently
10646 support additional @var{suffix} characters following @samp{%O} as they do
10647 following, for example, @samp{.o}.
10649 @item %p
10650 Substitutes the standard macro predefinitions for the
10651 current target machine.  Use this when running @code{cpp}.
10653 @item %P
10654 Like @samp{%p}, but puts @samp{__} before and after the name of each
10655 predefined macro, except for macros that start with @samp{__} or with
10656 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10659 @item %I
10660 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10661 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10662 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10663 and @option{-imultilib} as necessary.
10665 @item %s
10666 Current argument is the name of a library or startup file of some sort.
10667 Search for that file in a standard list of directories and substitute
10668 the full name found.  The current working directory is included in the
10669 list of directories scanned.
10671 @item %T
10672 Current argument is the name of a linker script.  Search for that file
10673 in the current list of directories to scan for libraries. If the file
10674 is located insert a @option{--script} option into the command line
10675 followed by the full path name found.  If the file is not found then
10676 generate an error message.  Note: the current working directory is not
10677 searched.
10679 @item %e@var{str}
10680 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10681 Use this when inconsistent options are detected.
10683 @item %(@var{name})
10684 Substitute the contents of spec string @var{name} at this point.
10686 @item %x@{@var{option}@}
10687 Accumulate an option for @samp{%X}.
10689 @item %X
10690 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10691 spec string.
10693 @item %Y
10694 Output the accumulated assembler options specified by @option{-Wa}.
10696 @item %Z
10697 Output the accumulated preprocessor options specified by @option{-Wp}.
10699 @item %a
10700 Process the @code{asm} spec.  This is used to compute the
10701 switches to be passed to the assembler.
10703 @item %A
10704 Process the @code{asm_final} spec.  This is a spec string for
10705 passing switches to an assembler post-processor, if such a program is
10706 needed.
10708 @item %l
10709 Process the @code{link} spec.  This is the spec for computing the
10710 command line passed to the linker.  Typically it makes use of the
10711 @samp{%L %G %S %D and %E} sequences.
10713 @item %D
10714 Dump out a @option{-L} option for each directory that GCC believes might
10715 contain startup files.  If the target supports multilibs then the
10716 current multilib directory is prepended to each of these paths.
10718 @item %L
10719 Process the @code{lib} spec.  This is a spec string for deciding which
10720 libraries are included on the command line to the linker.
10722 @item %G
10723 Process the @code{libgcc} spec.  This is a spec string for deciding
10724 which GCC support library is included on the command line to the linker.
10726 @item %S
10727 Process the @code{startfile} spec.  This is a spec for deciding which
10728 object files are the first ones passed to the linker.  Typically
10729 this might be a file named @file{crt0.o}.
10731 @item %E
10732 Process the @code{endfile} spec.  This is a spec string that specifies
10733 the last object files that are passed to the linker.
10735 @item %C
10736 Process the @code{cpp} spec.  This is used to construct the arguments
10737 to be passed to the C preprocessor.
10739 @item %1
10740 Process the @code{cc1} spec.  This is used to construct the options to be
10741 passed to the actual C compiler (@samp{cc1}).
10743 @item %2
10744 Process the @code{cc1plus} spec.  This is used to construct the options to be
10745 passed to the actual C++ compiler (@samp{cc1plus}).
10747 @item %*
10748 Substitute the variable part of a matched option.  See below.
10749 Note that each comma in the substituted string is replaced by
10750 a single space.
10752 @item %<@code{S}
10753 Remove all occurrences of @code{-S} from the command line.  Note---this
10754 command is position dependent.  @samp{%} commands in the spec string
10755 before this one see @code{-S}, @samp{%} commands in the spec string
10756 after this one do not.
10758 @item %:@var{function}(@var{args})
10759 Call the named function @var{function}, passing it @var{args}.
10760 @var{args} is first processed as a nested spec string, then split
10761 into an argument vector in the usual fashion.  The function returns
10762 a string which is processed as if it had appeared literally as part
10763 of the current spec.
10765 The following built-in spec functions are provided:
10767 @table @code
10768 @item @code{getenv}
10769 The @code{getenv} spec function takes two arguments: an environment
10770 variable name and a string.  If the environment variable is not
10771 defined, a fatal error is issued.  Otherwise, the return value is the
10772 value of the environment variable concatenated with the string.  For
10773 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10775 @smallexample
10776 %:getenv(TOPDIR /include)
10777 @end smallexample
10779 expands to @file{/path/to/top/include}.
10781 @item @code{if-exists}
10782 The @code{if-exists} spec function takes one argument, an absolute
10783 pathname to a file.  If the file exists, @code{if-exists} returns the
10784 pathname.  Here is a small example of its usage:
10786 @smallexample
10787 *startfile:
10788 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10789 @end smallexample
10791 @item @code{if-exists-else}
10792 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10793 spec function, except that it takes two arguments.  The first argument is
10794 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10795 returns the pathname.  If it does not exist, it returns the second argument.
10796 This way, @code{if-exists-else} can be used to select one file or another,
10797 based on the existence of the first.  Here is a small example of its usage:
10799 @smallexample
10800 *startfile:
10801 crt0%O%s %:if-exists(crti%O%s) \
10802 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10803 @end smallexample
10805 @item @code{replace-outfile}
10806 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10807 first argument in the outfiles array and replaces it with the second argument.  Here
10808 is a small example of its usage:
10810 @smallexample
10811 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10812 @end smallexample
10814 @item @code{remove-outfile}
10815 The @code{remove-outfile} spec function takes one argument.  It looks for the
10816 first argument in the outfiles array and removes it.  Here is a small example
10817 its usage:
10819 @smallexample
10820 %:remove-outfile(-lm)
10821 @end smallexample
10823 @item @code{pass-through-libs}
10824 The @code{pass-through-libs} spec function takes any number of arguments.  It
10825 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10826 assumes are the names of linker input library archive files) and returns a
10827 result containing all the found arguments each prepended by
10828 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10829 intended to be passed to the LTO linker plugin.
10831 @smallexample
10832 %:pass-through-libs(%G %L %G)
10833 @end smallexample
10835 @item @code{print-asm-header}
10836 The @code{print-asm-header} function takes no arguments and simply
10837 prints a banner like:
10839 @smallexample
10840 Assembler options
10841 =================
10843 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10844 @end smallexample
10846 It is used to separate compiler options from assembler options
10847 in the @option{--target-help} output.
10848 @end table
10850 @item %@{@code{S}@}
10851 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10852 If that switch is not specified, this substitutes nothing.  Note that
10853 the leading dash is omitted when specifying this option, and it is
10854 automatically inserted if the substitution is performed.  Thus the spec
10855 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10856 and outputs the command-line option @option{-foo}.
10858 @item %W@{@code{S}@}
10859 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10860 deleted on failure.
10862 @item %@{@code{S}*@}
10863 Substitutes all the switches specified to GCC whose names start
10864 with @code{-S}, but which also take an argument.  This is used for
10865 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10866 GCC considers @option{-o foo} as being
10867 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10868 text, including the space.  Thus two arguments are generated.
10870 @item %@{@code{S}*&@code{T}*@}
10871 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10872 (the order of @code{S} and @code{T} in the spec is not significant).
10873 There can be any number of ampersand-separated variables; for each the
10874 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10876 @item %@{@code{S}:@code{X}@}
10877 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10879 @item %@{!@code{S}:@code{X}@}
10880 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10882 @item %@{@code{S}*:@code{X}@}
10883 Substitutes @code{X} if one or more switches whose names start with
10884 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10885 once, no matter how many such switches appeared.  However, if @code{%*}
10886 appears somewhere in @code{X}, then @code{X} is substituted once
10887 for each matching switch, with the @code{%*} replaced by the part of
10888 that switch matching the @code{*}.
10890 If @code{%*} appears as the last part of a spec sequence then a space
10891 will be added after the end of the last substitution.  If there is more
10892 text in the sequence however then a space will not be generated.  This
10893 allows the @code{%*} substitution to be used as part of a larger
10894 string.  For example, a spec string like this:
10896 @smallexample
10897 %@{mcu=*:--script=%*/memory.ld@}
10898 @end smallexample
10900 when matching an option like @code{-mcu=newchip} will produce:
10902 @smallexample
10903 --script=newchip/memory.ld
10904 @end smallexample
10906 @item %@{.@code{S}:@code{X}@}
10907 Substitutes @code{X}, if processing a file with suffix @code{S}.
10909 @item %@{!.@code{S}:@code{X}@}
10910 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10912 @item %@{,@code{S}:@code{X}@}
10913 Substitutes @code{X}, if processing a file for language @code{S}.
10915 @item %@{!,@code{S}:@code{X}@}
10916 Substitutes @code{X}, if not processing a file for language @code{S}.
10918 @item %@{@code{S}|@code{P}:@code{X}@}
10919 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10920 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10921 @code{*} sequences as well, although they have a stronger binding than
10922 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10923 alternatives must be starred, and only the first matching alternative
10924 is substituted.
10926 For example, a spec string like this:
10928 @smallexample
10929 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10930 @end smallexample
10932 @noindent
10933 outputs the following command-line options from the following input
10934 command-line options:
10936 @smallexample
10937 fred.c        -foo -baz
10938 jim.d         -bar -boggle
10939 -d fred.c     -foo -baz -boggle
10940 -d jim.d      -bar -baz -boggle
10941 @end smallexample
10943 @item %@{S:X; T:Y; :D@}
10945 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10946 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10947 be as many clauses as you need.  This may be combined with @code{.},
10948 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10951 @end table
10953 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10954 construct may contain other nested @samp{%} constructs or spaces, or
10955 even newlines.  They are processed as usual, as described above.
10956 Trailing white space in @code{X} is ignored.  White space may also
10957 appear anywhere on the left side of the colon in these constructs,
10958 except between @code{.} or @code{*} and the corresponding word.
10960 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10961 handled specifically in these constructs.  If another value of
10962 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10963 @option{-W} switch is found later in the command line, the earlier
10964 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10965 just one letter, which passes all matching options.
10967 The character @samp{|} at the beginning of the predicate text is used to
10968 indicate that a command should be piped to the following command, but
10969 only if @option{-pipe} is specified.
10971 It is built into GCC which switches take arguments and which do not.
10972 (You might think it would be useful to generalize this to allow each
10973 compiler's spec to say which switches take arguments.  But this cannot
10974 be done in a consistent fashion.  GCC cannot even decide which input
10975 files have been specified without knowing which switches take arguments,
10976 and it must know which input files to compile in order to tell which
10977 compilers to run).
10979 GCC also knows implicitly that arguments starting in @option{-l} are to be
10980 treated as compiler output files, and passed to the linker in their
10981 proper position among the other output files.
10983 @c man begin OPTIONS
10985 @node Target Options
10986 @section Specifying Target Machine and Compiler Version
10987 @cindex target options
10988 @cindex cross compiling
10989 @cindex specifying machine version
10990 @cindex specifying compiler version and target machine
10991 @cindex compiler version, specifying
10992 @cindex target machine, specifying
10994 The usual way to run GCC is to run the executable called @command{gcc}, or
10995 @command{@var{machine}-gcc} when cross-compiling, or
10996 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10997 one that was installed last.
10999 @node Submodel Options
11000 @section Hardware Models and Configurations
11001 @cindex submodel options
11002 @cindex specifying hardware config
11003 @cindex hardware models and configurations, specifying
11004 @cindex machine dependent options
11006 Each target machine types can have its own
11007 special options, starting with @samp{-m}, to choose among various
11008 hardware models or configurations---for example, 68010 vs 68020,
11009 floating coprocessor or none.  A single installed version of the
11010 compiler can compile for any model or configuration, according to the
11011 options specified.
11013 Some configurations of the compiler also support additional special
11014 options, usually for compatibility with other compilers on the same
11015 platform.
11017 @c This list is ordered alphanumerically by subsection name.
11018 @c It should be the same order and spelling as these options are listed
11019 @c in Machine Dependent Options
11021 @menu
11022 * AArch64 Options::
11023 * Adapteva Epiphany Options::
11024 * ARC Options::
11025 * ARM Options::
11026 * AVR Options::
11027 * Blackfin Options::
11028 * C6X Options::
11029 * CRIS Options::
11030 * CR16 Options::
11031 * Darwin Options::
11032 * DEC Alpha Options::
11033 * FR30 Options::
11034 * FRV Options::
11035 * GNU/Linux Options::
11036 * H8/300 Options::
11037 * HPPA Options::
11038 * i386 and x86-64 Options::
11039 * i386 and x86-64 Windows Options::
11040 * IA-64 Options::
11041 * LM32 Options::
11042 * M32C Options::
11043 * M32R/D Options::
11044 * M680x0 Options::
11045 * MCore Options::
11046 * MeP Options::
11047 * MicroBlaze Options::
11048 * MIPS Options::
11049 * MMIX Options::
11050 * MN10300 Options::
11051 * Moxie Options::
11052 * MSP430 Options::
11053 * NDS32 Options::
11054 * PDP-11 Options::
11055 * picoChip Options::
11056 * PowerPC Options::
11057 * RL78 Options::
11058 * RS/6000 and PowerPC Options::
11059 * RX Options::
11060 * S/390 and zSeries Options::
11061 * Score Options::
11062 * SH Options::
11063 * Solaris 2 Options::
11064 * SPARC Options::
11065 * SPU Options::
11066 * System V Options::
11067 * TILE-Gx Options::
11068 * TILEPro Options::
11069 * V850 Options::
11070 * VAX Options::
11071 * VMS Options::
11072 * VxWorks Options::
11073 * x86-64 Options::
11074 * Xstormy16 Options::
11075 * Xtensa Options::
11076 * zSeries Options::
11077 @end menu
11079 @node AArch64 Options
11080 @subsection AArch64 Options
11081 @cindex AArch64 Options
11083 These options are defined for AArch64 implementations:
11085 @table @gcctabopt
11087 @item -mabi=@var{name}
11088 @opindex mabi
11089 Generate code for the specified data model.  Permissible values
11090 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11091 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11092 but long int and pointer are 64-bit.
11094 The default depends on the specific target configuration.  Note that
11095 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11096 entire program with the same ABI, and link with a compatible set of libraries.
11098 @item -mbig-endian
11099 @opindex mbig-endian
11100 Generate big-endian code.  This is the default when GCC is configured for an
11101 @samp{aarch64_be-*-*} target.
11103 @item -mgeneral-regs-only
11104 @opindex mgeneral-regs-only
11105 Generate code which uses only the general registers.
11107 @item -mlittle-endian
11108 @opindex mlittle-endian
11109 Generate little-endian code.  This is the default when GCC is configured for an
11110 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11112 @item -mcmodel=tiny
11113 @opindex mcmodel=tiny
11114 Generate code for the tiny code model.  The program and its statically defined
11115 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11116 be statically or dynamically linked.  This model is not fully implemented and
11117 mostly treated as @samp{small}.
11119 @item -mcmodel=small
11120 @opindex mcmodel=small
11121 Generate code for the small code model.  The program and its statically defined
11122 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11123 be statically or dynamically linked.  This is the default code model.
11125 @item -mcmodel=large
11126 @opindex mcmodel=large
11127 Generate code for the large code model.  This makes no assumptions about
11128 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11129 statically linked only.
11131 @item -mstrict-align
11132 @opindex mstrict-align
11133 Do not assume that unaligned memory references will be handled by the system.
11135 @item -momit-leaf-frame-pointer
11136 @itemx -mno-omit-leaf-frame-pointer
11137 @opindex momit-leaf-frame-pointer
11138 @opindex mno-omit-leaf-frame-pointer
11139 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11140 default.
11142 @item -mtls-dialect=desc
11143 @opindex mtls-dialect=desc
11144 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11145 of TLS variables.  This is the default.
11147 @item -mtls-dialect=traditional
11148 @opindex mtls-dialect=traditional
11149 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11150 of TLS variables.
11152 @item -march=@var{name}
11153 @opindex march
11154 Specify the name of the target architecture, optionally suffixed by one or
11155 more feature modifiers.  This option has the form
11156 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11157 only value for @var{arch} is @samp{armv8-a}.  The possible values for
11158 @var{feature} are documented in the sub-section below.
11160 Where conflicting feature modifiers are specified, the right-most feature is
11161 used.
11163 GCC uses this name to determine what kind of instructions it can emit when
11164 generating assembly code.  This option can be used in conjunction with or
11165 instead of the @option{-mcpu=} option.
11167 @item -mcpu=@var{name}
11168 @opindex mcpu
11169 Specify the name of the target processor, optionally suffixed by one or more
11170 feature modifiers.  This option has the form
11171 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11172 possible values for @var{cpu} are @samp{generic}, @samp{cortex-a53},
11173 @samp{cortex-a57}.  The possible values for @var{feature} are documented
11174 in the sub-section below.
11176 Where conflicting feature modifiers are specified, the right-most feature is
11177 used.
11179 GCC uses this name to determine what kind of instructions it can emit when
11180 generating assembly code.
11182 @item -mtune=@var{name}
11183 @opindex mtune
11184 Specify the name of the processor to tune the performance for.  The code will
11185 be tuned as if the target processor were of the type specified in this option,
11186 but still using instructions compatible with the target processor specified
11187 by a @option{-mcpu=} option.  Where no @option{-mtune=} option is
11188 specified, the code will be tuned to perform well on the target processor
11189 given by @option{-mcpu=} or @option{-march=}.  Where none of
11190 @option{-mtune=}, @option{-mcpu=} or @option{-march=} are specified,
11191 the code will be tuned to perform well across a range of target
11192 processors.  This option cannot be suffixed by feature modifiers.
11194 @end table
11196 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11197 @cindex @option{-march} feature modifiers
11198 @cindex @option{-mcpu} feature modifiers
11199 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11200 the following:
11202 @table @samp
11203 @item crc
11204 Enable CRC extension.
11205 @item crypto
11206 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11207 @item fp
11208 Enable floating-point instructions.
11209 @item simd
11210 Enable Advanced SIMD instructions.  This implies floating-point instructions
11211 are enabled.  This is the default for all current possible values for options
11212 @option{-march} and @option{-mcpu=}.
11213 @end table
11215 @node Adapteva Epiphany Options
11216 @subsection Adapteva Epiphany Options
11218 These @samp{-m} options are defined for Adapteva Epiphany:
11220 @table @gcctabopt
11221 @item -mhalf-reg-file
11222 @opindex mhalf-reg-file
11223 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11224 That allows code to run on hardware variants that lack these registers.
11226 @item -mprefer-short-insn-regs
11227 @opindex mprefer-short-insn-regs
11228 Preferrentially allocate registers that allow short instruction generation.
11229 This can result in increased instruction count, so this may either reduce or
11230 increase overall code size.
11232 @item -mbranch-cost=@var{num}
11233 @opindex mbranch-cost
11234 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11235 This cost is only a heuristic and is not guaranteed to produce
11236 consistent results across releases.
11238 @item -mcmove
11239 @opindex mcmove
11240 Enable the generation of conditional moves.
11242 @item -mnops=@var{num}
11243 @opindex mnops
11244 Emit @var{num} NOPs before every other generated instruction.
11246 @item -mno-soft-cmpsf
11247 @opindex mno-soft-cmpsf
11248 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11249 and test the flags.  This is faster than a software comparison, but can
11250 get incorrect results in the presence of NaNs, or when two different small
11251 numbers are compared such that their difference is calculated as zero.
11252 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11253 software comparisons.
11255 @item -mstack-offset=@var{num}
11256 @opindex mstack-offset
11257 Set the offset between the top of the stack and the stack pointer.
11258 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11259 can be used by leaf functions without stack allocation.
11260 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11261 Note also that this option changes the ABI; compiling a program with a
11262 different stack offset than the libraries have been compiled with
11263 generally does not work.
11264 This option can be useful if you want to evaluate if a different stack
11265 offset would give you better code, but to actually use a different stack
11266 offset to build working programs, it is recommended to configure the
11267 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11269 @item -mno-round-nearest
11270 @opindex mno-round-nearest
11271 Make the scheduler assume that the rounding mode has been set to
11272 truncating.  The default is @option{-mround-nearest}.
11274 @item -mlong-calls
11275 @opindex mlong-calls
11276 If not otherwise specified by an attribute, assume all calls might be beyond
11277 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11278 function address into a register before performing a (otherwise direct) call.
11279 This is the default.
11281 @item -mshort-calls
11282 @opindex short-calls
11283 If not otherwise specified by an attribute, assume all direct calls are
11284 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11285 for direct calls.  The default is @option{-mlong-calls}.
11287 @item -msmall16
11288 @opindex msmall16
11289 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11290 apply to function addresses for which @option{-mlong-calls} semantics
11291 are in effect.
11293 @item -mfp-mode=@var{mode}
11294 @opindex mfp-mode
11295 Set the prevailing mode of the floating-point unit.
11296 This determines the floating-point mode that is provided and expected
11297 at function call and return time.  Making this mode match the mode you
11298 predominantly need at function start can make your programs smaller and
11299 faster by avoiding unnecessary mode switches.
11301 @var{mode} can be set to one the following values:
11303 @table @samp
11304 @item caller
11305 Any mode at function entry is valid, and retained or restored when
11306 the function returns, and when it calls other functions.
11307 This mode is useful for compiling libraries or other compilation units
11308 you might want to incorporate into different programs with different
11309 prevailing FPU modes, and the convenience of being able to use a single
11310 object file outweighs the size and speed overhead for any extra
11311 mode switching that might be needed, compared with what would be needed
11312 with a more specific choice of prevailing FPU mode.
11314 @item truncate
11315 This is the mode used for floating-point calculations with
11316 truncating (i.e.@: round towards zero) rounding mode.  That includes
11317 conversion from floating point to integer.
11319 @item round-nearest
11320 This is the mode used for floating-point calculations with
11321 round-to-nearest-or-even rounding mode.
11323 @item int
11324 This is the mode used to perform integer calculations in the FPU, e.g.@:
11325 integer multiply, or integer multiply-and-accumulate.
11326 @end table
11328 The default is @option{-mfp-mode=caller}
11330 @item -mnosplit-lohi
11331 @itemx -mno-postinc
11332 @itemx -mno-postmodify
11333 @opindex mnosplit-lohi
11334 @opindex mno-postinc
11335 @opindex mno-postmodify
11336 Code generation tweaks that disable, respectively, splitting of 32-bit
11337 loads, generation of post-increment addresses, and generation of
11338 post-modify addresses.  The defaults are @option{msplit-lohi},
11339 @option{-mpost-inc}, and @option{-mpost-modify}.
11341 @item -mnovect-double
11342 @opindex mno-vect-double
11343 Change the preferred SIMD mode to SImode.  The default is
11344 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11346 @item -max-vect-align=@var{num}
11347 @opindex max-vect-align
11348 The maximum alignment for SIMD vector mode types.
11349 @var{num} may be 4 or 8.  The default is 8.
11350 Note that this is an ABI change, even though many library function
11351 interfaces are unaffected if they don't use SIMD vector modes
11352 in places that affect size and/or alignment of relevant types.
11354 @item -msplit-vecmove-early
11355 @opindex msplit-vecmove-early
11356 Split vector moves into single word moves before reload.  In theory this
11357 can give better register allocation, but so far the reverse seems to be
11358 generally the case.
11360 @item -m1reg-@var{reg}
11361 @opindex m1reg-
11362 Specify a register to hold the constant @minus{}1, which makes loading small negative
11363 constants and certain bitmasks faster.
11364 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11365 which specify use of that register as a fixed register,
11366 and @samp{none}, which means that no register is used for this
11367 purpose.  The default is @option{-m1reg-none}.
11369 @end table
11371 @node ARC Options
11372 @subsection ARC Options
11373 @cindex ARC options
11375 The following options control the architecture variant for which code
11376 is being compiled:
11378 @c architecture variants
11379 @table @gcctabopt
11381 @item -mbarrel-shifter
11382 @opindex mbarrel-shifter
11383 Generate instructions supported by barrel shifter.  This is the default
11384 unless @samp{-mcpu=ARC601} is in effect.
11386 @item -mcpu=@var{cpu}
11387 @opindex mcpu
11388 Set architecture type, register usage, and instruction scheduling
11389 parameters for @var{cpu}.  There are also shortcut alias options
11390 available for backward compatibility and convenience.  Supported
11391 values for @var{cpu} are
11393 @table @samp
11394 @opindex mA6
11395 @opindex mARC600
11396 @item ARC600
11397 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
11399 @item ARC601
11400 @opindex mARC601
11401 Compile for ARC601.  Alias: @option{-mARC601}.
11403 @item ARC700
11404 @opindex mA7
11405 @opindex mARC700
11406 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
11407 This is the default when configured with @samp{--with-cpu=arc700}@.
11408 @end table
11410 @item -mdpfp
11411 @opindex mdpfp
11412 @itemx -mdpfp-compact
11413 @opindex mdpfp-compact
11414 FPX: Generate Double Precision FPX instructions, tuned for the compact
11415 implementation.
11417 @item -mdpfp-fast
11418 @opindex mdpfp-fast
11419 FPX: Generate Double Precision FPX instructions, tuned for the fast
11420 implementation.
11422 @item -mno-dpfp-lrsr
11423 @opindex mno-dpfp-lrsr
11424 Disable LR and SR instructions from using FPX extension aux registers.
11426 @item -mea
11427 @opindex mea
11428 Generate Extended arithmetic instructions.  Currently only
11429 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
11430 supported.  This is always enabled for @samp{-mcpu=ARC700}.
11432 @item -mno-mpy
11433 @opindex mno-mpy
11434 Do not generate mpy instructions for ARC700.
11436 @item -mmul32x16
11437 @opindex mmul32x16
11438 Generate 32x16 bit multiply and mac instructions.
11440 @item -mmul64
11441 @opindex mmul64
11442 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
11444 @item -mnorm
11445 @opindex mnorm
11446 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
11447 is in effect.
11449 @item -mspfp
11450 @opindex mspfp
11451 @itemx -mspfp-compact
11452 @opindex mspfp-compact
11453 FPX: Generate Single Precision FPX instructions, tuned for the compact
11454 implementation.
11456 @item -mspfp-fast
11457 @opindex mspfp-fast
11458 FPX: Generate Single Precision FPX instructions, tuned for the fast
11459 implementation.
11461 @item -msimd
11462 @opindex msimd
11463 Enable generation of ARC SIMD instructions via target-specific
11464 builtins.  Only valid for @samp{-mcpu=ARC700}.
11466 @item -msoft-float
11467 @opindex msoft-float
11468 This option ignored; it is provided for compatibility purposes only.
11469 Software floating point code is emitted by default, and this default
11470 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
11471 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
11472 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
11474 @item -mswap
11475 @opindex mswap
11476 Generate swap instructions.
11478 @end table
11480 The following options are passed through to the assembler, and also
11481 define preprocessor macro symbols.
11483 @c Flags used by the assembler, but for which we define preprocessor
11484 @c macro symbols as well.
11485 @table @gcctabopt
11486 @item -mdsp-packa
11487 @opindex mdsp-packa
11488 Passed down to the assembler to enable the DSP Pack A extensions.
11489 Also sets the preprocessor symbol @code{__Xdsp_packa}.
11491 @item -mdvbf
11492 @opindex mdvbf
11493 Passed down to the assembler to enable the dual viterbi butterfly
11494 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
11496 @c ARC700 4.10 extension instruction
11497 @item -mlock
11498 @opindex mlock
11499 Passed down to the assembler to enable the Locked Load/Store
11500 Conditional extension.  Also sets the preprocessor symbol
11501 @code{__Xlock}.
11503 @item -mmac-d16
11504 @opindex mmac-d16
11505 Passed down to the assembler.  Also sets the preprocessor symbol
11506 @code{__Xxmac_d16}.
11508 @item -mmac-24
11509 @opindex mmac-24
11510 Passed down to the assembler.  Also sets the preprocessor symbol
11511 @code{__Xxmac_24}.
11513 @c ARC700 4.10 extension instruction
11514 @item -mrtsc
11515 @opindex mrtsc
11516 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
11517 extension instruction.  Also sets the preprocessor symbol
11518 @code{__Xrtsc}.
11520 @c ARC700 4.10 extension instruction
11521 @item -mswape
11522 @opindex mswape
11523 Passed down to the assembler to enable the swap byte ordering
11524 extension instruction.  Also sets the preprocessor symbol
11525 @code{__Xswape}.
11527 @item -mtelephony
11528 @opindex mtelephony
11529 Passed down to the assembler to enable dual and single operand
11530 instructions for telephony.  Also sets the preprocessor symbol
11531 @code{__Xtelephony}.
11533 @item -mxy
11534 @opindex mxy
11535 Passed down to the assembler to enable the XY Memory extension.  Also
11536 sets the preprocessor symbol @code{__Xxy}.
11538 @end table
11540 The following options control how the assembly code is annotated:
11542 @c Assembly annotation options
11543 @table @gcctabopt
11544 @item -misize
11545 @opindex misize
11546 Annotate assembler instructions with estimated addresses.
11548 @item -mannotate-align
11549 @opindex mannotate-align
11550 Explain what alignment considerations lead to the decision to make an
11551 instruction short or long.
11553 @end table
11555 The following options are passed through to the linker:
11557 @c options passed through to the linker
11558 @table @gcctabopt
11559 @item -marclinux
11560 @opindex marclinux
11561 Passed through to the linker, to specify use of the @code{arclinux} emulation.
11562 This option is enabled by default in tool chains built for
11563 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
11564 when profiling is not requested.
11566 @item -marclinux_prof
11567 @opindex marclinux_prof
11568 Passed through to the linker, to specify use of the
11569 @code{arclinux_prof} emulation.  This option is enabled by default in
11570 tool chains built for @w{@code{arc-linux-uclibc}} and
11571 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
11573 @end table
11575 The following options control the semantics of generated code:
11577 @c semantically relevant code generation options
11578 @table @gcctabopt
11579 @item -mepilogue-cfi
11580 @opindex mepilogue-cfi
11581 Enable generation of call frame information for epilogues.
11583 @item -mno-epilogue-cfi
11584 @opindex mno-epilogue-cfi
11585 Disable generation of call frame information for epilogues.
11587 @item -mlong-calls
11588 @opindex mlong-calls
11589 Generate call insns as register indirect calls, thus providing access
11590 to the full 32-bit address range.
11592 @item -mmedium-calls
11593 @opindex mmedium-calls
11594 Don't use less than 25 bit addressing range for calls, which is the
11595 offset available for an unconditional branch-and-link
11596 instruction.  Conditional execution of function calls is suppressed, to
11597 allow use of the 25-bit range, rather than the 21-bit range with
11598 conditional branch-and-link.  This is the default for tool chains built
11599 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
11601 @item -mno-sdata
11602 @opindex mno-sdata
11603 Do not generate sdata references.  This is the default for tool chains
11604 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
11605 targets.
11607 @item -mucb-mcount
11608 @opindex mucb-mcount
11609 Instrument with mcount calls as used in UCB code.  I.e. do the
11610 counting in the callee, not the caller.  By default ARC instrumentation
11611 counts in the caller.
11613 @item -mvolatile-cache
11614 @opindex mvolatile-cache
11615 Use ordinarily cached memory accesses for volatile references.  This is the
11616 default.
11618 @item -mno-volatile-cache
11619 @opindex mno-volatile-cache
11620 Enable cache bypass for volatile references.
11622 @end table
11624 The following options fine tune code generation:
11625 @c code generation tuning options
11626 @table @gcctabopt
11627 @item -malign-call
11628 @opindex malign-call
11629 Do alignment optimizations for call instructions.
11631 @item -mauto-modify-reg
11632 @opindex mauto-modify-reg
11633 Enable the use of pre/post modify with register displacement.
11635 @item -mbbit-peephole
11636 @opindex mbbit-peephole
11637 Enable bbit peephole2.
11639 @item -mno-brcc
11640 @opindex mno-brcc
11641 This option disables a target-specific pass in @file{arc_reorg} to
11642 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
11643 generation driven by the combiner pass.
11645 @item -mcase-vector-pcrel
11646 @opindex mcase-vector-pcrel
11647 Use pc-relative switch case tables - this enables case table shortening.
11648 This is the default for @option{-Os}.
11650 @item -mcompact-casesi
11651 @opindex mcompact-casesi
11652 Enable compact casesi pattern.
11653 This is the default for @option{-Os}.
11655 @item -mno-cond-exec
11656 @opindex mno-cond-exec
11657 Disable ARCompact specific pass to generate conditional execution instructions.
11658 Due to delay slot scheduling and interactions between operand numbers,
11659 literal sizes, instruction lengths, and the support for conditional execution,
11660 the target-independent pass to generate conditional execution is often lacking,
11661 so the ARC port has kept a special pass around that tries to find more
11662 conditional execution generating opportunities after register allocation,
11663 branch shortening, and delay slot scheduling have been done.  This pass
11664 generally, but not always, improves performance and code size, at the cost of
11665 extra compilation time, which is why there is an option to switch it off.
11666 If you have a problem with call instructions exceeding their allowable
11667 offset range because they are conditionalized, you should consider using
11668 @option{-mmedium-calls} instead.
11670 @item -mearly-cbranchsi
11671 @opindex mearly-cbranchsi
11672 Enable pre-reload use of the cbranchsi pattern.
11674 @item -mexpand-adddi
11675 @opindex mexpand-adddi
11676 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
11677 @code{add.f}, @code{adc} etc.
11679 @item -mindexed-loads
11680 @opindex mindexed-loads
11681 Enable the use of indexed loads.  This can be problematic because some
11682 optimizers will then assume the that indexed stores exist, which is not
11683 the case.
11685 @item -mlra
11686 @opindex mlra
11687 Enable Local Register Allocation.  This is still experimental for ARC,
11688 so by default the compiler uses standard reload
11689 (i.e. @samp{-mno-lra}).
11691 @item -mlra-priority-none
11692 @opindex mlra-priority-none
11693 Don't indicate any priority for target registers.
11695 @item -mlra-priority-compact
11696 @opindex mlra-priority-compact
11697 Indicate target register priority for r0..r3 / r12..r15.
11699 @item -mlra-priority-noncompact
11700 @opindex mlra-priority-noncompact
11701 Reduce target regsiter priority for r0..r3 / r12..r15.
11703 @item -mno-millicode
11704 @opindex mno-millicode
11705 When optimizing for size (using @option{-Os}), prologues and epilogues
11706 that have to save or restore a large number of registers are often
11707 shortened by using call to a special function in libgcc; this is
11708 referred to as a @emph{millicode} call.  As these calls can pose
11709 performance issues, and/or cause linking issues when linking in a
11710 nonstandard way, this option is provided to turn off millicode call
11711 generation.
11713 @item -mmixed-code
11714 @opindex mmixed-code
11715 Tweak register allocation to help 16-bit instruction generation.
11716 This generally has the effect of decreasing the average instruction size
11717 while increasing the instruction count.
11719 @item -mq-class
11720 @opindex mq-class
11721 Enable 'q' instruction alternatives.
11722 This is the default for @option{-Os}.
11724 @item -mRcq
11725 @opindex mRcq
11726 Enable Rcq constraint handling - most short code generation depends on this.
11727 This is the default.
11729 @item -mRcw
11730 @opindex mRcw
11731 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
11732 This is the default.
11734 @item -msize-level=@var{level}
11735 @ opindex msize-level
11736 Fine-tune size optimization with regards to instruction lengths and alignment.
11737 The recognized values for @var{level} are:
11738 @table @samp
11739 @item 0
11740 No size optimization.  This level is deprecated and treated like @samp{1}.
11742 @item 1
11743 Short instructions are used opportunistically.
11745 @item 2
11746 In addition, alignment of loops and of code after barriers are dropped.
11748 @item 3
11749 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
11751 @end table
11753 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
11754 the behavior when this is not set is equivalent to level @samp{1}.
11756 @item -mtune=@var{cpu}
11757 @opindex mtune
11758 Set instruction scheduling parameters for @var{cpu}, overriding any implied
11759 by @option{-mcpu=}.
11761 Supported values for @var{cpu} are
11763 @table @samp
11764 @item ARC600
11765 Tune for ARC600 cpu.
11767 @item ARC601
11768 Tune for ARC601 cpu.
11770 @item ARC700
11771 Tune for ARC700 cpu with standard multiplier block.
11773 @item ARC700-xmac
11774 Tune for ARC700 cpu with XMAC block.
11776 @item ARC725D
11777 Tune for ARC725D cpu.
11779 @item ARC750D
11780 Tune for ARC750D cpu.
11782 @end table
11784 @item -mmultcost=@var{num}
11785 @opindex mmultcost
11786 Cost to assume for a multiply instruction, with @samp{4} being equal to a
11787 normal instruction.
11789 @item -munalign-prob-threshold=@var{probability}
11790 @opindex munalign-prob-threshold
11791 Set probability threshold for unaligning branches.
11792 When tuning for @samp{ARC700} and optimizing for speed, branches without
11793 filled delay slot are preferably emitted unaligned and long, unless
11794 profiling indicates that the probability for the branch to be taken
11795 is below @var{probability}.  @xref{Cross-profiling}.
11796 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
11798 @end table
11800 The following options are maintained for backward compatibility, but
11801 are now deprecated and will be removed in a future release:
11803 @c Deprecated options
11804 @table @gcctabopt
11806 @item -margonaut
11807 @opindex margonaut
11808 Obsolete FPX.
11810 @item -mbig-endian
11811 @opindex mbig-endian
11812 @itemx -EB
11813 @opindex EB
11814 Compile code for big endian targets.  Use of these options is now
11815 deprecated.  Users wanting big-endian code, should use the
11816 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
11817 building the tool chain, for which big-endian is the default.
11819 @item -mlittle-endian
11820 @opindex mlittle-endian
11821 @itemx -EL
11822 @opindex EL
11823 Compile code for little endian targets.  Use of these options is now
11824 deprecated.  Users wanting little-endian code should use the
11825 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
11826 building the tool chain, for which little-endian is the default.
11828 @item -mbarrel_shifter
11829 @opindex mbarrel_shifter
11830 Replaced by @samp{-mbarrel-shifter}
11832 @item -mdpfp_compact
11833 @opindex mdpfp_compact
11834 Replaced by @samp{-mdpfp-compact}
11836 @item -mdpfp_fast
11837 @opindex mdpfp_fast
11838 Replaced by @samp{-mdpfp-fast}
11840 @item -mdsp_packa
11841 @opindex mdsp_packa
11842 Replaced by @samp{-mdsp-packa}
11844 @item -mEA
11845 @opindex mEA
11846 Replaced by @samp{-mea}
11848 @item -mmac_24
11849 @opindex mmac_24
11850 Replaced by @samp{-mmac-24}
11852 @item -mmac_d16
11853 @opindex mmac_d16
11854 Replaced by @samp{-mmac-d16}
11856 @item -mspfp_compact
11857 @opindex mspfp_compact
11858 Replaced by @samp{-mspfp-compact}
11860 @item -mspfp_fast
11861 @opindex mspfp_fast
11862 Replaced by @samp{-mspfp-fast}
11864 @item -mtune=@var{cpu}
11865 @opindex mtune
11866 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
11867 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
11868 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
11870 @item -multcost=@var{num}
11871 @opindex multcost
11872 Replaced by @samp{-mmultcost}.
11874 @end table
11876 @node ARM Options
11877 @subsection ARM Options
11878 @cindex ARM options
11880 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
11881 architectures:
11883 @table @gcctabopt
11884 @item -mabi=@var{name}
11885 @opindex mabi
11886 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
11887 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
11889 @item -mapcs-frame
11890 @opindex mapcs-frame
11891 Generate a stack frame that is compliant with the ARM Procedure Call
11892 Standard for all functions, even if this is not strictly necessary for
11893 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
11894 with this option causes the stack frames not to be generated for
11895 leaf functions.  The default is @option{-mno-apcs-frame}.
11897 @item -mapcs
11898 @opindex mapcs
11899 This is a synonym for @option{-mapcs-frame}.
11901 @ignore
11902 @c not currently implemented
11903 @item -mapcs-stack-check
11904 @opindex mapcs-stack-check
11905 Generate code to check the amount of stack space available upon entry to
11906 every function (that actually uses some stack space).  If there is
11907 insufficient space available then either the function
11908 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
11909 called, depending upon the amount of stack space required.  The runtime
11910 system is required to provide these functions.  The default is
11911 @option{-mno-apcs-stack-check}, since this produces smaller code.
11913 @c not currently implemented
11914 @item -mapcs-float
11915 @opindex mapcs-float
11916 Pass floating-point arguments using the floating-point registers.  This is
11917 one of the variants of the APCS@.  This option is recommended if the
11918 target hardware has a floating-point unit or if a lot of floating-point
11919 arithmetic is going to be performed by the code.  The default is
11920 @option{-mno-apcs-float}, since the size of integer-only code is 
11921 slightly increased if @option{-mapcs-float} is used.
11923 @c not currently implemented
11924 @item -mapcs-reentrant
11925 @opindex mapcs-reentrant
11926 Generate reentrant, position-independent code.  The default is
11927 @option{-mno-apcs-reentrant}.
11928 @end ignore
11930 @item -mthumb-interwork
11931 @opindex mthumb-interwork
11932 Generate code that supports calling between the ARM and Thumb
11933 instruction sets.  Without this option, on pre-v5 architectures, the
11934 two instruction sets cannot be reliably used inside one program.  The
11935 default is @option{-mno-thumb-interwork}, since slightly larger code
11936 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
11937 configurations this option is meaningless.
11939 @item -mno-sched-prolog
11940 @opindex mno-sched-prolog
11941 Prevent the reordering of instructions in the function prologue, or the
11942 merging of those instruction with the instructions in the function's
11943 body.  This means that all functions start with a recognizable set
11944 of instructions (or in fact one of a choice from a small set of
11945 different function prologues), and this information can be used to
11946 locate the start of functions inside an executable piece of code.  The
11947 default is @option{-msched-prolog}.
11949 @item -mfloat-abi=@var{name}
11950 @opindex mfloat-abi
11951 Specifies which floating-point ABI to use.  Permissible values
11952 are: @samp{soft}, @samp{softfp} and @samp{hard}.
11954 Specifying @samp{soft} causes GCC to generate output containing
11955 library calls for floating-point operations.
11956 @samp{softfp} allows the generation of code using hardware floating-point
11957 instructions, but still uses the soft-float calling conventions.
11958 @samp{hard} allows generation of floating-point instructions
11959 and uses FPU-specific calling conventions.
11961 The default depends on the specific target configuration.  Note that
11962 the hard-float and soft-float ABIs are not link-compatible; you must
11963 compile your entire program with the same ABI, and link with a
11964 compatible set of libraries.
11966 @item -mlittle-endian
11967 @opindex mlittle-endian
11968 Generate code for a processor running in little-endian mode.  This is
11969 the default for all standard configurations.
11971 @item -mbig-endian
11972 @opindex mbig-endian
11973 Generate code for a processor running in big-endian mode; the default is
11974 to compile code for a little-endian processor.
11976 @item -mwords-little-endian
11977 @opindex mwords-little-endian
11978 This option only applies when generating code for big-endian processors.
11979 Generate code for a little-endian word order but a big-endian byte
11980 order.  That is, a byte order of the form @samp{32107654}.  Note: this
11981 option should only be used if you require compatibility with code for
11982 big-endian ARM processors generated by versions of the compiler prior to
11983 2.8.  This option is now deprecated.
11985 @item -mcpu=@var{name}
11986 @opindex mcpu
11987 This specifies the name of the target ARM processor.  GCC uses this name
11988 to determine what kind of instructions it can emit when generating
11989 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
11990 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
11991 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
11992 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
11993 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
11994 @samp{arm720},
11995 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
11996 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
11997 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
11998 @samp{strongarm1110},
11999 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12000 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12001 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12002 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12003 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12004 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12005 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12006 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
12007 @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-r4}, @samp{cortex-r4f},
12008 @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m4}, @samp{cortex-m3},
12009 @samp{cortex-m1},
12010 @samp{cortex-m0},
12011 @samp{cortex-m0plus},
12012 @samp{marvell-pj4},
12013 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12014 @samp{fa526}, @samp{fa626},
12015 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12018 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12019 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12020 See @option{-mtune} for more information.
12022 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12023 of the build computer.  At present, this feature is only supported on
12024 Linux, and not all architectures are recognized.  If the auto-detect is
12025 unsuccessful the option has no effect.
12027 @item -mtune=@var{name}
12028 @opindex mtune
12029 This option is very similar to the @option{-mcpu=} option, except that
12030 instead of specifying the actual target processor type, and hence
12031 restricting which instructions can be used, it specifies that GCC should
12032 tune the performance of the code as if the target were of the type
12033 specified in this option, but still choosing the instructions it
12034 generates based on the CPU specified by a @option{-mcpu=} option.
12035 For some ARM implementations better performance can be obtained by using
12036 this option.
12038 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12039 performance for a blend of processors within architecture @var{arch}.
12040 The aim is to generate code that run well on the current most popular
12041 processors, balancing between optimizations that benefit some CPUs in the
12042 range, and avoiding performance pitfalls of other CPUs.  The effects of
12043 this option may change in future GCC versions as CPU models come and go.
12045 @option{-mtune=native} causes the compiler to auto-detect the CPU
12046 of the build computer.  At present, this feature is only supported on
12047 Linux, and not all architectures are recognized.  If the auto-detect is
12048 unsuccessful the option has no effect.
12050 @item -march=@var{name}
12051 @opindex march
12052 This specifies the name of the target ARM architecture.  GCC uses this
12053 name to determine what kind of instructions it can emit when generating
12054 assembly code.  This option can be used in conjunction with or instead
12055 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12056 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12057 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12058 @samp{armv6}, @samp{armv6j},
12059 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12060 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
12061 @samp{armv8-a},
12062 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12064 @option{-march=native} causes the compiler to auto-detect the architecture
12065 of the build computer.  At present, this feature is only supported on
12066 Linux, and not all architectures are recognized.  If the auto-detect is
12067 unsuccessful the option has no effect.
12069 @item -mfpu=@var{name}
12070 @opindex mfpu
12071 This specifies what floating-point hardware (or hardware emulation) is
12072 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12073 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12074 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12075 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12076 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12078 If @option{-msoft-float} is specified this specifies the format of
12079 floating-point values.
12081 If the selected floating-point hardware includes the NEON extension
12082 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12083 operations are not generated by GCC's auto-vectorization pass unless
12084 @option{-funsafe-math-optimizations} is also specified.  This is
12085 because NEON hardware does not fully implement the IEEE 754 standard for
12086 floating-point arithmetic (in particular denormal values are treated as
12087 zero), so the use of NEON instructions may lead to a loss of precision.
12089 @item -mfp16-format=@var{name}
12090 @opindex mfp16-format
12091 Specify the format of the @code{__fp16} half-precision floating-point type.
12092 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12093 the default is @samp{none}, in which case the @code{__fp16} type is not
12094 defined.  @xref{Half-Precision}, for more information.
12096 @item -mstructure-size-boundary=@var{n}
12097 @opindex mstructure-size-boundary
12098 The sizes of all structures and unions are rounded up to a multiple
12099 of the number of bits set by this option.  Permissible values are 8, 32
12100 and 64.  The default value varies for different toolchains.  For the COFF
12101 targeted toolchain the default value is 8.  A value of 64 is only allowed
12102 if the underlying ABI supports it.
12104 Specifying a larger number can produce faster, more efficient code, but
12105 can also increase the size of the program.  Different values are potentially
12106 incompatible.  Code compiled with one value cannot necessarily expect to
12107 work with code or libraries compiled with another value, if they exchange
12108 information using structures or unions.
12110 @item -mabort-on-noreturn
12111 @opindex mabort-on-noreturn
12112 Generate a call to the function @code{abort} at the end of a
12113 @code{noreturn} function.  It is executed if the function tries to
12114 return.
12116 @item -mlong-calls
12117 @itemx -mno-long-calls
12118 @opindex mlong-calls
12119 @opindex mno-long-calls
12120 Tells the compiler to perform function calls by first loading the
12121 address of the function into a register and then performing a subroutine
12122 call on this register.  This switch is needed if the target function
12123 lies outside of the 64-megabyte addressing range of the offset-based
12124 version of subroutine call instruction.
12126 Even if this switch is enabled, not all function calls are turned
12127 into long calls.  The heuristic is that static functions, functions
12128 that have the @samp{short-call} attribute, functions that are inside
12129 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12130 definitions have already been compiled within the current compilation
12131 unit are not turned into long calls.  The exceptions to this rule are
12132 that weak function definitions, functions with the @samp{long-call}
12133 attribute or the @samp{section} attribute, and functions that are within
12134 the scope of a @samp{#pragma long_calls} directive are always
12135 turned into long calls.
12137 This feature is not enabled by default.  Specifying
12138 @option{-mno-long-calls} restores the default behavior, as does
12139 placing the function calls within the scope of a @samp{#pragma
12140 long_calls_off} directive.  Note these switches have no effect on how
12141 the compiler generates code to handle function calls via function
12142 pointers.
12144 @item -msingle-pic-base
12145 @opindex msingle-pic-base
12146 Treat the register used for PIC addressing as read-only, rather than
12147 loading it in the prologue for each function.  The runtime system is
12148 responsible for initializing this register with an appropriate value
12149 before execution begins.
12151 @item -mpic-register=@var{reg}
12152 @opindex mpic-register
12153 Specify the register to be used for PIC addressing.  The default is R10
12154 unless stack-checking is enabled, when R9 is used.
12156 @item -mpoke-function-name
12157 @opindex mpoke-function-name
12158 Write the name of each function into the text section, directly
12159 preceding the function prologue.  The generated code is similar to this:
12161 @smallexample
12162      t0
12163          .ascii "arm_poke_function_name", 0
12164          .align
12165      t1
12166          .word 0xff000000 + (t1 - t0)
12167      arm_poke_function_name
12168          mov     ip, sp
12169          stmfd   sp!, @{fp, ip, lr, pc@}
12170          sub     fp, ip, #4
12171 @end smallexample
12173 When performing a stack backtrace, code can inspect the value of
12174 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
12175 location @code{pc - 12} and the top 8 bits are set, then we know that
12176 there is a function name embedded immediately preceding this location
12177 and has length @code{((pc[-3]) & 0xff000000)}.
12179 @item -mthumb
12180 @itemx -marm
12181 @opindex marm
12182 @opindex mthumb
12184 Select between generating code that executes in ARM and Thumb
12185 states.  The default for most configurations is to generate code
12186 that executes in ARM state, but the default can be changed by
12187 configuring GCC with the @option{--with-mode=}@var{state}
12188 configure option.
12190 @item -mtpcs-frame
12191 @opindex mtpcs-frame
12192 Generate a stack frame that is compliant with the Thumb Procedure Call
12193 Standard for all non-leaf functions.  (A leaf function is one that does
12194 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
12196 @item -mtpcs-leaf-frame
12197 @opindex mtpcs-leaf-frame
12198 Generate a stack frame that is compliant with the Thumb Procedure Call
12199 Standard for all leaf functions.  (A leaf function is one that does
12200 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
12202 @item -mcallee-super-interworking
12203 @opindex mcallee-super-interworking
12204 Gives all externally visible functions in the file being compiled an ARM
12205 instruction set header which switches to Thumb mode before executing the
12206 rest of the function.  This allows these functions to be called from
12207 non-interworking code.  This option is not valid in AAPCS configurations
12208 because interworking is enabled by default.
12210 @item -mcaller-super-interworking
12211 @opindex mcaller-super-interworking
12212 Allows calls via function pointers (including virtual functions) to
12213 execute correctly regardless of whether the target code has been
12214 compiled for interworking or not.  There is a small overhead in the cost
12215 of executing a function pointer if this option is enabled.  This option
12216 is not valid in AAPCS configurations because interworking is enabled
12217 by default.
12219 @item -mtp=@var{name}
12220 @opindex mtp
12221 Specify the access model for the thread local storage pointer.  The valid
12222 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
12223 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
12224 (supported in the arm6k architecture), and @option{auto}, which uses the
12225 best available method for the selected processor.  The default setting is
12226 @option{auto}.
12228 @item -mtls-dialect=@var{dialect}
12229 @opindex mtls-dialect
12230 Specify the dialect to use for accessing thread local storage.  Two
12231 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
12232 @samp{gnu} dialect selects the original GNU scheme for supporting
12233 local and global dynamic TLS models.  The @samp{gnu2} dialect
12234 selects the GNU descriptor scheme, which provides better performance
12235 for shared libraries.  The GNU descriptor scheme is compatible with
12236 the original scheme, but does require new assembler, linker and
12237 library support.  Initial and local exec TLS models are unaffected by
12238 this option and always use the original scheme.
12240 @item -mword-relocations
12241 @opindex mword-relocations
12242 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
12243 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
12244 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
12245 is specified.
12247 @item -mfix-cortex-m3-ldrd
12248 @opindex mfix-cortex-m3-ldrd
12249 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
12250 with overlapping destination and base registers are used.  This option avoids
12251 generating these instructions.  This option is enabled by default when
12252 @option{-mcpu=cortex-m3} is specified.
12254 @item -munaligned-access
12255 @itemx -mno-unaligned-access
12256 @opindex munaligned-access
12257 @opindex mno-unaligned-access
12258 Enables (or disables) reading and writing of 16- and 32- bit values
12259 from addresses that are not 16- or 32- bit aligned.  By default
12260 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
12261 architectures, and enabled for all other architectures.  If unaligned
12262 access is not enabled then words in packed data structures will be
12263 accessed a byte at a time.
12265 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
12266 generated object file to either true or false, depending upon the
12267 setting of this option.  If unaligned access is enabled then the
12268 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
12269 defined.
12271 @item -mneon-for-64bits
12272 @opindex mneon-for-64bits
12273 Enables using Neon to handle scalar 64-bits operations. This is
12274 disabled by default since the cost of moving data from core registers
12275 to Neon is high.
12277 @item -mrestrict-it
12278 @opindex mrestrict-it
12279 Restricts generation of IT blocks to conform to the rules of ARMv8.
12280 IT blocks can only contain a single 16-bit instruction from a select
12281 set of instructions. This option is on by default for ARMv8 Thumb mode.
12282 @end table
12284 @node AVR Options
12285 @subsection AVR Options
12286 @cindex AVR Options
12288 These options are defined for AVR implementations:
12290 @table @gcctabopt
12291 @item -mmcu=@var{mcu}
12292 @opindex mmcu
12293 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
12295 The default for this option is@tie{}@code{avr2}.
12297 GCC supports the following AVR devices and ISAs:
12299 @include avr-mmcu.texi
12301 @item -maccumulate-args
12302 @opindex maccumulate-args
12303 Accumulate outgoing function arguments and acquire/release the needed
12304 stack space for outgoing function arguments once in function
12305 prologue/epilogue.  Without this option, outgoing arguments are pushed
12306 before calling a function and popped afterwards.
12308 Popping the arguments after the function call can be expensive on
12309 AVR so that accumulating the stack space might lead to smaller
12310 executables because arguments need not to be removed from the
12311 stack after such a function call.
12313 This option can lead to reduced code size for functions that perform
12314 several calls to functions that get their arguments on the stack like
12315 calls to printf-like functions.
12317 @item -mbranch-cost=@var{cost}
12318 @opindex mbranch-cost
12319 Set the branch costs for conditional branch instructions to
12320 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
12321 integers. The default branch cost is 0.
12323 @item -mcall-prologues
12324 @opindex mcall-prologues
12325 Functions prologues/epilogues are expanded as calls to appropriate
12326 subroutines.  Code size is smaller.
12328 @item -mint8
12329 @opindex mint8
12330 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
12331 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
12332 and @code{long long} is 4 bytes.  Please note that this option does not
12333 conform to the C standards, but it results in smaller code
12334 size.
12336 @item -mno-interrupts
12337 @opindex mno-interrupts
12338 Generated code is not compatible with hardware interrupts.
12339 Code size is smaller.
12341 @item -mrelax
12342 @opindex mrelax
12343 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
12344 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
12345 Setting @code{-mrelax} just adds the @code{--relax} option to the
12346 linker command line when the linker is called.
12348 Jump relaxing is performed by the linker because jump offsets are not
12349 known before code is located. Therefore, the assembler code generated by the
12350 compiler is the same, but the instructions in the executable may
12351 differ from instructions in the assembler code.
12353 Relaxing must be turned on if linker stubs are needed, see the
12354 section on @code{EIND} and linker stubs below.
12356 @item -msp8
12357 @opindex msp8
12358 Treat the stack pointer register as an 8-bit register,
12359 i.e.@: assume the high byte of the stack pointer is zero.
12360 In general, you don't need to set this option by hand.
12362 This option is used internally by the compiler to select and
12363 build multilibs for architectures @code{avr2} and @code{avr25}.
12364 These architectures mix devices with and without @code{SPH}.
12365 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
12366 the compiler driver will add or remove this option from the compiler
12367 proper's command line, because the compiler then knows if the device
12368 or architecture has an 8-bit stack pointer and thus no @code{SPH}
12369 register or not.
12371 @item -mstrict-X
12372 @opindex mstrict-X
12373 Use address register @code{X} in a way proposed by the hardware.  This means
12374 that @code{X} is only used in indirect, post-increment or
12375 pre-decrement addressing.
12377 Without this option, the @code{X} register may be used in the same way
12378 as @code{Y} or @code{Z} which then is emulated by additional
12379 instructions.  
12380 For example, loading a value with @code{X+const} addressing with a
12381 small non-negative @code{const < 64} to a register @var{Rn} is
12382 performed as
12384 @example
12385 adiw r26, const   ; X += const
12386 ld   @var{Rn}, X        ; @var{Rn} = *X
12387 sbiw r26, const   ; X -= const
12388 @end example
12390 @item -mtiny-stack
12391 @opindex mtiny-stack
12392 Only change the lower 8@tie{}bits of the stack pointer.
12394 @item -Waddr-space-convert
12395 @opindex Waddr-space-convert
12396 Warn about conversions between address spaces in the case where the
12397 resulting address space is not contained in the incoming address space.
12398 @end table
12400 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
12401 @cindex @code{EIND}
12402 Pointers in the implementation are 16@tie{}bits wide.
12403 The address of a function or label is represented as word address so
12404 that indirect jumps and calls can target any code address in the
12405 range of 64@tie{}Ki words.
12407 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
12408 bytes of program memory space, there is a special function register called
12409 @code{EIND} that serves as most significant part of the target address
12410 when @code{EICALL} or @code{EIJMP} instructions are used.
12412 Indirect jumps and calls on these devices are handled as follows by
12413 the compiler and are subject to some limitations:
12415 @itemize @bullet
12417 @item
12418 The compiler never sets @code{EIND}.
12420 @item
12421 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
12422 instructions or might read @code{EIND} directly in order to emulate an
12423 indirect call/jump by means of a @code{RET} instruction.
12425 @item
12426 The compiler assumes that @code{EIND} never changes during the startup
12427 code or during the application. In particular, @code{EIND} is not
12428 saved/restored in function or interrupt service routine
12429 prologue/epilogue.
12431 @item
12432 For indirect calls to functions and computed goto, the linker
12433 generates @emph{stubs}. Stubs are jump pads sometimes also called
12434 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
12435 The stub contains a direct jump to the desired address.
12437 @item
12438 Linker relaxation must be turned on so that the linker will generate
12439 the stubs correctly an all situaltion. See the compiler option
12440 @code{-mrelax} and the linler option @code{--relax}.
12441 There are corner cases where the linker is supposed to generate stubs
12442 but aborts without relaxation and without a helpful error message.
12444 @item
12445 The default linker script is arranged for code with @code{EIND = 0}.
12446 If code is supposed to work for a setup with @code{EIND != 0}, a custom
12447 linker script has to be used in order to place the sections whose
12448 name start with @code{.trampolines} into the segment where @code{EIND}
12449 points to.
12451 @item
12452 The startup code from libgcc never sets @code{EIND}.
12453 Notice that startup code is a blend of code from libgcc and AVR-LibC.
12454 For the impact of AVR-LibC on @code{EIND}, see the
12455 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
12457 @item
12458 It is legitimate for user-specific startup code to set up @code{EIND}
12459 early, for example by means of initialization code located in
12460 section @code{.init3}. Such code runs prior to general startup code
12461 that initializes RAM and calls constructors, but after the bit
12462 of startup code from AVR-LibC that sets @code{EIND} to the segment
12463 where the vector table is located.
12464 @example
12465 #include <avr/io.h>
12467 static void
12468 __attribute__((section(".init3"),naked,used,no_instrument_function))
12469 init3_set_eind (void)
12471   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
12472                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
12474 @end example
12476 @noindent
12477 The @code{__trampolines_start} symbol is defined in the linker script.
12479 @item
12480 Stubs are generated automatically by the linker if
12481 the following two conditions are met:
12482 @itemize @minus
12484 @item The address of a label is taken by means of the @code{gs} modifier
12485 (short for @emph{generate stubs}) like so:
12486 @example
12487 LDI r24, lo8(gs(@var{func}))
12488 LDI r25, hi8(gs(@var{func}))
12489 @end example
12490 @item The final location of that label is in a code segment
12491 @emph{outside} the segment where the stubs are located.
12492 @end itemize
12494 @item
12495 The compiler emits such @code{gs} modifiers for code labels in the
12496 following situations:
12497 @itemize @minus
12498 @item Taking address of a function or code label.
12499 @item Computed goto.
12500 @item If prologue-save function is used, see @option{-mcall-prologues}
12501 command-line option.
12502 @item Switch/case dispatch tables. If you do not want such dispatch
12503 tables you can specify the @option{-fno-jump-tables} command-line option.
12504 @item C and C++ constructors/destructors called during startup/shutdown.
12505 @item If the tools hit a @code{gs()} modifier explained above.
12506 @end itemize
12508 @item
12509 Jumping to non-symbolic addresses like so is @emph{not} supported:
12511 @example
12512 int main (void)
12514     /* Call function at word address 0x2 */
12515     return ((int(*)(void)) 0x2)();
12517 @end example
12519 Instead, a stub has to be set up, i.e.@: the function has to be called
12520 through a symbol (@code{func_4} in the example):
12522 @example
12523 int main (void)
12525     extern int func_4 (void);
12527     /* Call function at byte address 0x4 */
12528     return func_4();
12530 @end example
12532 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
12533 Alternatively, @code{func_4} can be defined in the linker script.
12534 @end itemize
12536 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
12537 @cindex @code{RAMPD}
12538 @cindex @code{RAMPX}
12539 @cindex @code{RAMPY}
12540 @cindex @code{RAMPZ}
12541 Some AVR devices support memories larger than the 64@tie{}KiB range
12542 that can be accessed with 16-bit pointers.  To access memory locations
12543 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
12544 register is used as high part of the address:
12545 The @code{X}, @code{Y}, @code{Z} address register is concatenated
12546 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
12547 register, respectively, to get a wide address. Similarly,
12548 @code{RAMPD} is used together with direct addressing.
12550 @itemize
12551 @item
12552 The startup code initializes the @code{RAMP} special function
12553 registers with zero.
12555 @item
12556 If a @ref{AVR Named Address Spaces,named address space} other than
12557 generic or @code{__flash} is used, then @code{RAMPZ} is set
12558 as needed before the operation.
12560 @item
12561 If the device supports RAM larger than 64@tie{}KiB and the compiler
12562 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
12563 is reset to zero after the operation.
12565 @item
12566 If the device comes with a specific @code{RAMP} register, the ISR
12567 prologue/epilogue saves/restores that SFR and initializes it with
12568 zero in case the ISR code might (implicitly) use it.
12570 @item
12571 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
12572 If you use inline assembler to read from locations outside the
12573 16-bit address range and change one of the @code{RAMP} registers,
12574 you must reset it to zero after the access.
12576 @end itemize
12578 @subsubsection AVR Built-in Macros
12580 GCC defines several built-in macros so that the user code can test
12581 for the presence or absence of features.  Almost any of the following
12582 built-in macros are deduced from device capabilities and thus
12583 triggered by the @code{-mmcu=} command-line option.
12585 For even more AVR-specific built-in macros see
12586 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
12588 @table @code
12590 @item __AVR_ARCH__
12591 Build-in macro that resolves to a decimal number that identifies the
12592 architecture and depends on the @code{-mmcu=@var{mcu}} option.
12593 Possible values are:
12595 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
12596 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
12597 @code{105}, @code{106}, @code{107}
12599 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
12600 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
12601 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
12602 @code{avrxmega6}, @code{avrxmega7}, respectively.
12603 If @var{mcu} specifies a device, this built-in macro is set
12604 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
12605 defined to @code{4}.
12607 @item __AVR_@var{Device}__
12608 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
12609 the device's name. For example, @code{-mmcu=atmega8} defines the
12610 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
12611 @code{__AVR_ATtiny261A__}, etc.
12613 The built-in macros' names follow
12614 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
12615 the device name as from the AVR user manual. The difference between
12616 @var{Device} in the built-in macro and @var{device} in
12617 @code{-mmcu=@var{device}} is that the latter is always lowercase.
12619 If @var{device} is not a device but only a core architecture like
12620 @code{avr51}, this macro will not be defined.
12622 @item __AVR_XMEGA__
12623 The device / architecture belongs to the XMEGA family of devices.
12625 @item __AVR_HAVE_ELPM__
12626 The device has the the @code{ELPM} instruction.
12628 @item __AVR_HAVE_ELPMX__
12629 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
12630 R@var{n},Z+} instructions.
12632 @item __AVR_HAVE_MOVW__
12633 The device has the @code{MOVW} instruction to perform 16-bit
12634 register-register moves.
12636 @item __AVR_HAVE_LPMX__
12637 The device has the @code{LPM R@var{n},Z} and
12638 @code{LPM R@var{n},Z+} instructions.
12640 @item __AVR_HAVE_MUL__
12641 The device has a hardware multiplier. 
12643 @item __AVR_HAVE_JMP_CALL__
12644 The device has the @code{JMP} and @code{CALL} instructions.
12645 This is the case for devices with at least 16@tie{}KiB of program
12646 memory.
12648 @item __AVR_HAVE_EIJMP_EICALL__
12649 @itemx __AVR_3_BYTE_PC__
12650 The device has the @code{EIJMP} and @code{EICALL} instructions.
12651 This is the case for devices with more than 128@tie{}KiB of program memory.
12652 This also means that the program counter
12653 (PC) is 3@tie{}bytes wide.
12655 @item __AVR_2_BYTE_PC__
12656 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
12657 with up to 128@tie{}KiB of program memory.
12659 @item __AVR_HAVE_8BIT_SP__
12660 @itemx __AVR_HAVE_16BIT_SP__
12661 The stack pointer (SP) register is treated as 8-bit respectively
12662 16-bit register by the compiler.
12663 The definition of these macros is affected by @code{-mtiny-stack}.
12665 @item __AVR_HAVE_SPH__
12666 @itemx __AVR_SP8__
12667 The device has the SPH (high part of stack pointer) special function
12668 register or has an 8-bit stack pointer, respectively.
12669 The definition of these macros is affected by @code{-mmcu=} and
12670 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
12671 by @code{-msp8}.
12673 @item __AVR_HAVE_RAMPD__
12674 @itemx __AVR_HAVE_RAMPX__
12675 @itemx __AVR_HAVE_RAMPY__
12676 @itemx __AVR_HAVE_RAMPZ__
12677 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
12678 @code{RAMPZ} special function register, respectively.
12680 @item __NO_INTERRUPTS__
12681 This macro reflects the @code{-mno-interrupts} command line option.
12683 @item __AVR_ERRATA_SKIP__
12684 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
12685 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
12686 instructions because of a hardware erratum.  Skip instructions are
12687 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
12688 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
12689 set.
12691 @item __AVR_SFR_OFFSET__=@var{offset}
12692 Instructions that can address I/O special function registers directly
12693 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
12694 address as if addressed by an instruction to access RAM like @code{LD}
12695 or @code{STS}. This offset depends on the device architecture and has
12696 to be subtracted from the RAM address in order to get the
12697 respective I/O@tie{}address.
12699 @item __WITH_AVRLIBC__
12700 The compiler is configured to be used together with AVR-Libc.
12701 See the @code{--with-avrlibc} configure option.
12703 @end table
12705 @node Blackfin Options
12706 @subsection Blackfin Options
12707 @cindex Blackfin Options
12709 @table @gcctabopt
12710 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
12711 @opindex mcpu=
12712 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
12713 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
12714 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
12715 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
12716 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
12717 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
12718 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
12719 @samp{bf561}, @samp{bf592}.
12721 The optional @var{sirevision} specifies the silicon revision of the target
12722 Blackfin processor.  Any workarounds available for the targeted silicon revision
12723 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
12724 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
12725 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
12726 hexadecimal digits representing the major and minor numbers in the silicon
12727 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
12728 is not defined.  If @var{sirevision} is @samp{any}, the
12729 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
12730 If this optional @var{sirevision} is not used, GCC assumes the latest known
12731 silicon revision of the targeted Blackfin processor.
12733 GCC defines a preprocessor macro for the specified @var{cpu}.
12734 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
12735 provided by libgloss to be linked in if @option{-msim} is not given.
12737 Without this option, @samp{bf532} is used as the processor by default.
12739 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
12740 only the preprocessor macro is defined.
12742 @item -msim
12743 @opindex msim
12744 Specifies that the program will be run on the simulator.  This causes
12745 the simulator BSP provided by libgloss to be linked in.  This option
12746 has effect only for @samp{bfin-elf} toolchain.
12747 Certain other options, such as @option{-mid-shared-library} and
12748 @option{-mfdpic}, imply @option{-msim}.
12750 @item -momit-leaf-frame-pointer
12751 @opindex momit-leaf-frame-pointer
12752 Don't keep the frame pointer in a register for leaf functions.  This
12753 avoids the instructions to save, set up and restore frame pointers and
12754 makes an extra register available in leaf functions.  The option
12755 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
12756 which might make debugging harder.
12758 @item -mspecld-anomaly
12759 @opindex mspecld-anomaly
12760 When enabled, the compiler ensures that the generated code does not
12761 contain speculative loads after jump instructions. If this option is used,
12762 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
12764 @item -mno-specld-anomaly
12765 @opindex mno-specld-anomaly
12766 Don't generate extra code to prevent speculative loads from occurring.
12768 @item -mcsync-anomaly
12769 @opindex mcsync-anomaly
12770 When enabled, the compiler ensures that the generated code does not
12771 contain CSYNC or SSYNC instructions too soon after conditional branches.
12772 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
12774 @item -mno-csync-anomaly
12775 @opindex mno-csync-anomaly
12776 Don't generate extra code to prevent CSYNC or SSYNC instructions from
12777 occurring too soon after a conditional branch.
12779 @item -mlow-64k
12780 @opindex mlow-64k
12781 When enabled, the compiler is free to take advantage of the knowledge that
12782 the entire program fits into the low 64k of memory.
12784 @item -mno-low-64k
12785 @opindex mno-low-64k
12786 Assume that the program is arbitrarily large.  This is the default.
12788 @item -mstack-check-l1
12789 @opindex mstack-check-l1
12790 Do stack checking using information placed into L1 scratchpad memory by the
12791 uClinux kernel.
12793 @item -mid-shared-library
12794 @opindex mid-shared-library
12795 Generate code that supports shared libraries via the library ID method.
12796 This allows for execute in place and shared libraries in an environment
12797 without virtual memory management.  This option implies @option{-fPIC}.
12798 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12800 @item -mno-id-shared-library
12801 @opindex mno-id-shared-library
12802 Generate code that doesn't assume ID-based shared libraries are being used.
12803 This is the default.
12805 @item -mleaf-id-shared-library
12806 @opindex mleaf-id-shared-library
12807 Generate code that supports shared libraries via the library ID method,
12808 but assumes that this library or executable won't link against any other
12809 ID shared libraries.  That allows the compiler to use faster code for jumps
12810 and calls.
12812 @item -mno-leaf-id-shared-library
12813 @opindex mno-leaf-id-shared-library
12814 Do not assume that the code being compiled won't link against any ID shared
12815 libraries.  Slower code is generated for jump and call insns.
12817 @item -mshared-library-id=n
12818 @opindex mshared-library-id
12819 Specifies the identification number of the ID-based shared library being
12820 compiled.  Specifying a value of 0 generates more compact code; specifying
12821 other values forces the allocation of that number to the current
12822 library but is no more space- or time-efficient than omitting this option.
12824 @item -msep-data
12825 @opindex msep-data
12826 Generate code that allows the data segment to be located in a different
12827 area of memory from the text segment.  This allows for execute in place in
12828 an environment without virtual memory management by eliminating relocations
12829 against the text section.
12831 @item -mno-sep-data
12832 @opindex mno-sep-data
12833 Generate code that assumes that the data segment follows the text segment.
12834 This is the default.
12836 @item -mlong-calls
12837 @itemx -mno-long-calls
12838 @opindex mlong-calls
12839 @opindex mno-long-calls
12840 Tells the compiler to perform function calls by first loading the
12841 address of the function into a register and then performing a subroutine
12842 call on this register.  This switch is needed if the target function
12843 lies outside of the 24-bit addressing range of the offset-based
12844 version of subroutine call instruction.
12846 This feature is not enabled by default.  Specifying
12847 @option{-mno-long-calls} restores the default behavior.  Note these
12848 switches have no effect on how the compiler generates code to handle
12849 function calls via function pointers.
12851 @item -mfast-fp
12852 @opindex mfast-fp
12853 Link with the fast floating-point library. This library relaxes some of
12854 the IEEE floating-point standard's rules for checking inputs against
12855 Not-a-Number (NAN), in the interest of performance.
12857 @item -minline-plt
12858 @opindex minline-plt
12859 Enable inlining of PLT entries in function calls to functions that are
12860 not known to bind locally.  It has no effect without @option{-mfdpic}.
12862 @item -mmulticore
12863 @opindex mmulticore
12864 Build a standalone application for multicore Blackfin processors. 
12865 This option causes proper start files and link scripts supporting 
12866 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
12867 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
12869 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
12870 selects the one-application-per-core programming model.  Without
12871 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
12872 programming model is used. In this model, the main function of Core B
12873 should be named as @code{coreb_main}.
12875 If this option is not used, the single-core application programming
12876 model is used.
12878 @item -mcorea
12879 @opindex mcorea
12880 Build a standalone application for Core A of BF561 when using
12881 the one-application-per-core programming model. Proper start files
12882 and link scripts are used to support Core A, and the macro
12883 @code{__BFIN_COREA} is defined.
12884 This option can only be used in conjunction with @option{-mmulticore}.
12886 @item -mcoreb
12887 @opindex mcoreb
12888 Build a standalone application for Core B of BF561 when using
12889 the one-application-per-core programming model. Proper start files
12890 and link scripts are used to support Core B, and the macro
12891 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
12892 should be used instead of @code{main}. 
12893 This option can only be used in conjunction with @option{-mmulticore}.
12895 @item -msdram
12896 @opindex msdram
12897 Build a standalone application for SDRAM. Proper start files and
12898 link scripts are used to put the application into SDRAM, and the macro
12899 @code{__BFIN_SDRAM} is defined.
12900 The loader should initialize SDRAM before loading the application.
12902 @item -micplb
12903 @opindex micplb
12904 Assume that ICPLBs are enabled at run time.  This has an effect on certain
12905 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
12906 are enabled; for standalone applications the default is off.
12907 @end table
12909 @node C6X Options
12910 @subsection C6X Options
12911 @cindex C6X Options
12913 @table @gcctabopt
12914 @item -march=@var{name}
12915 @opindex march
12916 This specifies the name of the target architecture.  GCC uses this
12917 name to determine what kind of instructions it can emit when generating
12918 assembly code.  Permissible names are: @samp{c62x},
12919 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
12921 @item -mbig-endian
12922 @opindex mbig-endian
12923 Generate code for a big-endian target.
12925 @item -mlittle-endian
12926 @opindex mlittle-endian
12927 Generate code for a little-endian target.  This is the default.
12929 @item -msim
12930 @opindex msim
12931 Choose startup files and linker script suitable for the simulator.
12933 @item -msdata=default
12934 @opindex msdata=default
12935 Put small global and static data in the @samp{.neardata} section,
12936 which is pointed to by register @code{B14}.  Put small uninitialized
12937 global and static data in the @samp{.bss} section, which is adjacent
12938 to the @samp{.neardata} section.  Put small read-only data into the
12939 @samp{.rodata} section.  The corresponding sections used for large
12940 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
12942 @item -msdata=all
12943 @opindex msdata=all
12944 Put all data, not just small objects, into the sections reserved for
12945 small data, and use addressing relative to the @code{B14} register to
12946 access them.
12948 @item -msdata=none
12949 @opindex msdata=none
12950 Make no use of the sections reserved for small data, and use absolute
12951 addresses to access all data.  Put all initialized global and static
12952 data in the @samp{.fardata} section, and all uninitialized data in the
12953 @samp{.far} section.  Put all constant data into the @samp{.const}
12954 section.
12955 @end table
12957 @node CRIS Options
12958 @subsection CRIS Options
12959 @cindex CRIS Options
12961 These options are defined specifically for the CRIS ports.
12963 @table @gcctabopt
12964 @item -march=@var{architecture-type}
12965 @itemx -mcpu=@var{architecture-type}
12966 @opindex march
12967 @opindex mcpu
12968 Generate code for the specified architecture.  The choices for
12969 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
12970 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
12971 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
12972 @samp{v10}.
12974 @item -mtune=@var{architecture-type}
12975 @opindex mtune
12976 Tune to @var{architecture-type} everything applicable about the generated
12977 code, except for the ABI and the set of available instructions.  The
12978 choices for @var{architecture-type} are the same as for
12979 @option{-march=@var{architecture-type}}.
12981 @item -mmax-stack-frame=@var{n}
12982 @opindex mmax-stack-frame
12983 Warn when the stack frame of a function exceeds @var{n} bytes.
12985 @item -metrax4
12986 @itemx -metrax100
12987 @opindex metrax4
12988 @opindex metrax100
12989 The options @option{-metrax4} and @option{-metrax100} are synonyms for
12990 @option{-march=v3} and @option{-march=v8} respectively.
12992 @item -mmul-bug-workaround
12993 @itemx -mno-mul-bug-workaround
12994 @opindex mmul-bug-workaround
12995 @opindex mno-mul-bug-workaround
12996 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
12997 models where it applies.  This option is active by default.
12999 @item -mpdebug
13000 @opindex mpdebug
13001 Enable CRIS-specific verbose debug-related information in the assembly
13002 code.  This option also has the effect of turning off the @samp{#NO_APP}
13003 formatted-code indicator to the assembler at the beginning of the
13004 assembly file.
13006 @item -mcc-init
13007 @opindex mcc-init
13008 Do not use condition-code results from previous instruction; always emit
13009 compare and test instructions before use of condition codes.
13011 @item -mno-side-effects
13012 @opindex mno-side-effects
13013 Do not emit instructions with side effects in addressing modes other than
13014 post-increment.
13016 @item -mstack-align
13017 @itemx -mno-stack-align
13018 @itemx -mdata-align
13019 @itemx -mno-data-align
13020 @itemx -mconst-align
13021 @itemx -mno-const-align
13022 @opindex mstack-align
13023 @opindex mno-stack-align
13024 @opindex mdata-align
13025 @opindex mno-data-align
13026 @opindex mconst-align
13027 @opindex mno-const-align
13028 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13029 stack frame, individual data and constants to be aligned for the maximum
13030 single data access size for the chosen CPU model.  The default is to
13031 arrange for 32-bit alignment.  ABI details such as structure layout are
13032 not affected by these options.
13034 @item -m32-bit
13035 @itemx -m16-bit
13036 @itemx -m8-bit
13037 @opindex m32-bit
13038 @opindex m16-bit
13039 @opindex m8-bit
13040 Similar to the stack- data- and const-align options above, these options
13041 arrange for stack frame, writable data and constants to all be 32-bit,
13042 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13044 @item -mno-prologue-epilogue
13045 @itemx -mprologue-epilogue
13046 @opindex mno-prologue-epilogue
13047 @opindex mprologue-epilogue
13048 With @option{-mno-prologue-epilogue}, the normal function prologue and
13049 epilogue which set up the stack frame are omitted and no return
13050 instructions or return sequences are generated in the code.  Use this
13051 option only together with visual inspection of the compiled code: no
13052 warnings or errors are generated when call-saved registers must be saved,
13053 or storage for local variables needs to be allocated.
13055 @item -mno-gotplt
13056 @itemx -mgotplt
13057 @opindex mno-gotplt
13058 @opindex mgotplt
13059 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13060 instruction sequences that load addresses for functions from the PLT part
13061 of the GOT rather than (traditional on other architectures) calls to the
13062 PLT@.  The default is @option{-mgotplt}.
13064 @item -melf
13065 @opindex melf
13066 Legacy no-op option only recognized with the cris-axis-elf and
13067 cris-axis-linux-gnu targets.
13069 @item -mlinux
13070 @opindex mlinux
13071 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13073 @item -sim
13074 @opindex sim
13075 This option, recognized for the cris-axis-elf, arranges
13076 to link with input-output functions from a simulator library.  Code,
13077 initialized data and zero-initialized data are allocated consecutively.
13079 @item -sim2
13080 @opindex sim2
13081 Like @option{-sim}, but pass linker options to locate initialized data at
13082 0x40000000 and zero-initialized data at 0x80000000.
13083 @end table
13085 @node CR16 Options
13086 @subsection CR16 Options
13087 @cindex CR16 Options
13089 These options are defined specifically for the CR16 ports.
13091 @table @gcctabopt
13093 @item -mmac
13094 @opindex mmac
13095 Enable the use of multiply-accumulate instructions. Disabled by default.
13097 @item -mcr16cplus
13098 @itemx -mcr16c
13099 @opindex mcr16cplus
13100 @opindex mcr16c
13101 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13102 is default.
13104 @item -msim
13105 @opindex msim
13106 Links the library libsim.a which is in compatible with simulator. Applicable
13107 to ELF compiler only.
13109 @item -mint32
13110 @opindex mint32
13111 Choose integer type as 32-bit wide.
13113 @item -mbit-ops
13114 @opindex mbit-ops
13115 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13117 @item -mdata-model=@var{model}
13118 @opindex mdata-model
13119 Choose a data model. The choices for @var{model} are @samp{near},
13120 @samp{far} or @samp{medium}. @samp{medium} is default.
13121 However, @samp{far} is not valid with @option{-mcr16c}, as the
13122 CR16C architecture does not support the far data model.
13123 @end table
13125 @node Darwin Options
13126 @subsection Darwin Options
13127 @cindex Darwin options
13129 These options are defined for all architectures running the Darwin operating
13130 system.
13132 FSF GCC on Darwin does not create ``fat'' object files; it creates
13133 an object file for the single architecture that GCC was built to
13134 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13135 @option{-arch} options are used; it does so by running the compiler or
13136 linker multiple times and joining the results together with
13137 @file{lipo}.
13139 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13140 @samp{i686}) is determined by the flags that specify the ISA
13141 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13142 @option{-force_cpusubtype_ALL} option can be used to override this.
13144 The Darwin tools vary in their behavior when presented with an ISA
13145 mismatch.  The assembler, @file{as}, only permits instructions to
13146 be used that are valid for the subtype of the file it is generating,
13147 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
13148 The linker for shared libraries, @file{/usr/bin/libtool}, fails
13149 and prints an error if asked to create a shared library with a less
13150 restrictive subtype than its input files (for instance, trying to put
13151 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
13152 for executables, @command{ld}, quietly gives the executable the most
13153 restrictive subtype of any of its input files.
13155 @table @gcctabopt
13156 @item -F@var{dir}
13157 @opindex F
13158 Add the framework directory @var{dir} to the head of the list of
13159 directories to be searched for header files.  These directories are
13160 interleaved with those specified by @option{-I} options and are
13161 scanned in a left-to-right order.
13163 A framework directory is a directory with frameworks in it.  A
13164 framework is a directory with a @file{Headers} and/or
13165 @file{PrivateHeaders} directory contained directly in it that ends
13166 in @file{.framework}.  The name of a framework is the name of this
13167 directory excluding the @file{.framework}.  Headers associated with
13168 the framework are found in one of those two directories, with
13169 @file{Headers} being searched first.  A subframework is a framework
13170 directory that is in a framework's @file{Frameworks} directory.
13171 Includes of subframework headers can only appear in a header of a
13172 framework that contains the subframework, or in a sibling subframework
13173 header.  Two subframeworks are siblings if they occur in the same
13174 framework.  A subframework should not have the same name as a
13175 framework; a warning is issued if this is violated.  Currently a
13176 subframework cannot have subframeworks; in the future, the mechanism
13177 may be extended to support this.  The standard frameworks can be found
13178 in @file{/System/Library/Frameworks} and
13179 @file{/Library/Frameworks}.  An example include looks like
13180 @code{#include <Framework/header.h>}, where @file{Framework} denotes
13181 the name of the framework and @file{header.h} is found in the
13182 @file{PrivateHeaders} or @file{Headers} directory.
13184 @item -iframework@var{dir}
13185 @opindex iframework
13186 Like @option{-F} except the directory is a treated as a system
13187 directory.  The main difference between this @option{-iframework} and
13188 @option{-F} is that with @option{-iframework} the compiler does not
13189 warn about constructs contained within header files found via
13190 @var{dir}.  This option is valid only for the C family of languages.
13192 @item -gused
13193 @opindex gused
13194 Emit debugging information for symbols that are used.  For stabs
13195 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
13196 This is by default ON@.
13198 @item -gfull
13199 @opindex gfull
13200 Emit debugging information for all symbols and types.
13202 @item -mmacosx-version-min=@var{version}
13203 The earliest version of MacOS X that this executable will run on
13204 is @var{version}.  Typical values of @var{version} include @code{10.1},
13205 @code{10.2}, and @code{10.3.9}.
13207 If the compiler was built to use the system's headers by default,
13208 then the default for this option is the system version on which the
13209 compiler is running, otherwise the default is to make choices that
13210 are compatible with as many systems and code bases as possible.
13212 @item -mkernel
13213 @opindex mkernel
13214 Enable kernel development mode.  The @option{-mkernel} option sets
13215 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
13216 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
13217 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
13218 applicable.  This mode also sets @option{-mno-altivec},
13219 @option{-msoft-float}, @option{-fno-builtin} and
13220 @option{-mlong-branch} for PowerPC targets.
13222 @item -mone-byte-bool
13223 @opindex mone-byte-bool
13224 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
13225 By default @samp{sizeof(bool)} is @samp{4} when compiling for
13226 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
13227 option has no effect on x86.
13229 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
13230 to generate code that is not binary compatible with code generated
13231 without that switch.  Using this switch may require recompiling all
13232 other modules in a program, including system libraries.  Use this
13233 switch to conform to a non-default data model.
13235 @item -mfix-and-continue
13236 @itemx -ffix-and-continue
13237 @itemx -findirect-data
13238 @opindex mfix-and-continue
13239 @opindex ffix-and-continue
13240 @opindex findirect-data
13241 Generate code suitable for fast turnaround development, such as to
13242 allow GDB to dynamically load @code{.o} files into already-running
13243 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
13244 are provided for backwards compatibility.
13246 @item -all_load
13247 @opindex all_load
13248 Loads all members of static archive libraries.
13249 See man ld(1) for more information.
13251 @item -arch_errors_fatal
13252 @opindex arch_errors_fatal
13253 Cause the errors having to do with files that have the wrong architecture
13254 to be fatal.
13256 @item -bind_at_load
13257 @opindex bind_at_load
13258 Causes the output file to be marked such that the dynamic linker will
13259 bind all undefined references when the file is loaded or launched.
13261 @item -bundle
13262 @opindex bundle
13263 Produce a Mach-o bundle format file.
13264 See man ld(1) for more information.
13266 @item -bundle_loader @var{executable}
13267 @opindex bundle_loader
13268 This option specifies the @var{executable} that will load the build
13269 output file being linked.  See man ld(1) for more information.
13271 @item -dynamiclib
13272 @opindex dynamiclib
13273 When passed this option, GCC produces a dynamic library instead of
13274 an executable when linking, using the Darwin @file{libtool} command.
13276 @item -force_cpusubtype_ALL
13277 @opindex force_cpusubtype_ALL
13278 This causes GCC's output file to have the @var{ALL} subtype, instead of
13279 one controlled by the @option{-mcpu} or @option{-march} option.
13281 @item -allowable_client  @var{client_name}
13282 @itemx -client_name
13283 @itemx -compatibility_version
13284 @itemx -current_version
13285 @itemx -dead_strip
13286 @itemx -dependency-file
13287 @itemx -dylib_file
13288 @itemx -dylinker_install_name
13289 @itemx -dynamic
13290 @itemx -exported_symbols_list
13291 @itemx -filelist
13292 @need 800
13293 @itemx -flat_namespace
13294 @itemx -force_flat_namespace
13295 @itemx -headerpad_max_install_names
13296 @itemx -image_base
13297 @itemx -init
13298 @itemx -install_name
13299 @itemx -keep_private_externs
13300 @itemx -multi_module
13301 @itemx -multiply_defined
13302 @itemx -multiply_defined_unused
13303 @need 800
13304 @itemx -noall_load
13305 @itemx -no_dead_strip_inits_and_terms
13306 @itemx -nofixprebinding
13307 @itemx -nomultidefs
13308 @itemx -noprebind
13309 @itemx -noseglinkedit
13310 @itemx -pagezero_size
13311 @itemx -prebind
13312 @itemx -prebind_all_twolevel_modules
13313 @itemx -private_bundle
13314 @need 800
13315 @itemx -read_only_relocs
13316 @itemx -sectalign
13317 @itemx -sectobjectsymbols
13318 @itemx -whyload
13319 @itemx -seg1addr
13320 @itemx -sectcreate
13321 @itemx -sectobjectsymbols
13322 @itemx -sectorder
13323 @itemx -segaddr
13324 @itemx -segs_read_only_addr
13325 @need 800
13326 @itemx -segs_read_write_addr
13327 @itemx -seg_addr_table
13328 @itemx -seg_addr_table_filename
13329 @itemx -seglinkedit
13330 @itemx -segprot
13331 @itemx -segs_read_only_addr
13332 @itemx -segs_read_write_addr
13333 @itemx -single_module
13334 @itemx -static
13335 @itemx -sub_library
13336 @need 800
13337 @itemx -sub_umbrella
13338 @itemx -twolevel_namespace
13339 @itemx -umbrella
13340 @itemx -undefined
13341 @itemx -unexported_symbols_list
13342 @itemx -weak_reference_mismatches
13343 @itemx -whatsloaded
13344 @opindex allowable_client
13345 @opindex client_name
13346 @opindex compatibility_version
13347 @opindex current_version
13348 @opindex dead_strip
13349 @opindex dependency-file
13350 @opindex dylib_file
13351 @opindex dylinker_install_name
13352 @opindex dynamic
13353 @opindex exported_symbols_list
13354 @opindex filelist
13355 @opindex flat_namespace
13356 @opindex force_flat_namespace
13357 @opindex headerpad_max_install_names
13358 @opindex image_base
13359 @opindex init
13360 @opindex install_name
13361 @opindex keep_private_externs
13362 @opindex multi_module
13363 @opindex multiply_defined
13364 @opindex multiply_defined_unused
13365 @opindex noall_load
13366 @opindex no_dead_strip_inits_and_terms
13367 @opindex nofixprebinding
13368 @opindex nomultidefs
13369 @opindex noprebind
13370 @opindex noseglinkedit
13371 @opindex pagezero_size
13372 @opindex prebind
13373 @opindex prebind_all_twolevel_modules
13374 @opindex private_bundle
13375 @opindex read_only_relocs
13376 @opindex sectalign
13377 @opindex sectobjectsymbols
13378 @opindex whyload
13379 @opindex seg1addr
13380 @opindex sectcreate
13381 @opindex sectobjectsymbols
13382 @opindex sectorder
13383 @opindex segaddr
13384 @opindex segs_read_only_addr
13385 @opindex segs_read_write_addr
13386 @opindex seg_addr_table
13387 @opindex seg_addr_table_filename
13388 @opindex seglinkedit
13389 @opindex segprot
13390 @opindex segs_read_only_addr
13391 @opindex segs_read_write_addr
13392 @opindex single_module
13393 @opindex static
13394 @opindex sub_library
13395 @opindex sub_umbrella
13396 @opindex twolevel_namespace
13397 @opindex umbrella
13398 @opindex undefined
13399 @opindex unexported_symbols_list
13400 @opindex weak_reference_mismatches
13401 @opindex whatsloaded
13402 These options are passed to the Darwin linker.  The Darwin linker man page
13403 describes them in detail.
13404 @end table
13406 @node DEC Alpha Options
13407 @subsection DEC Alpha Options
13409 These @samp{-m} options are defined for the DEC Alpha implementations:
13411 @table @gcctabopt
13412 @item -mno-soft-float
13413 @itemx -msoft-float
13414 @opindex mno-soft-float
13415 @opindex msoft-float
13416 Use (do not use) the hardware floating-point instructions for
13417 floating-point operations.  When @option{-msoft-float} is specified,
13418 functions in @file{libgcc.a} are used to perform floating-point
13419 operations.  Unless they are replaced by routines that emulate the
13420 floating-point operations, or compiled in such a way as to call such
13421 emulations routines, these routines issue floating-point
13422 operations.   If you are compiling for an Alpha without floating-point
13423 operations, you must ensure that the library is built so as not to call
13424 them.
13426 Note that Alpha implementations without floating-point operations are
13427 required to have floating-point registers.
13429 @item -mfp-reg
13430 @itemx -mno-fp-regs
13431 @opindex mfp-reg
13432 @opindex mno-fp-regs
13433 Generate code that uses (does not use) the floating-point register set.
13434 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
13435 register set is not used, floating-point operands are passed in integer
13436 registers as if they were integers and floating-point results are passed
13437 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
13438 so any function with a floating-point argument or return value called by code
13439 compiled with @option{-mno-fp-regs} must also be compiled with that
13440 option.
13442 A typical use of this option is building a kernel that does not use,
13443 and hence need not save and restore, any floating-point registers.
13445 @item -mieee
13446 @opindex mieee
13447 The Alpha architecture implements floating-point hardware optimized for
13448 maximum performance.  It is mostly compliant with the IEEE floating-point
13449 standard.  However, for full compliance, software assistance is
13450 required.  This option generates code fully IEEE-compliant code
13451 @emph{except} that the @var{inexact-flag} is not maintained (see below).
13452 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
13453 defined during compilation.  The resulting code is less efficient but is
13454 able to correctly support denormalized numbers and exceptional IEEE
13455 values such as not-a-number and plus/minus infinity.  Other Alpha
13456 compilers call this option @option{-ieee_with_no_inexact}.
13458 @item -mieee-with-inexact
13459 @opindex mieee-with-inexact
13460 This is like @option{-mieee} except the generated code also maintains
13461 the IEEE @var{inexact-flag}.  Turning on this option causes the
13462 generated code to implement fully-compliant IEEE math.  In addition to
13463 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
13464 macro.  On some Alpha implementations the resulting code may execute
13465 significantly slower than the code generated by default.  Since there is
13466 very little code that depends on the @var{inexact-flag}, you should
13467 normally not specify this option.  Other Alpha compilers call this
13468 option @option{-ieee_with_inexact}.
13470 @item -mfp-trap-mode=@var{trap-mode}
13471 @opindex mfp-trap-mode
13472 This option controls what floating-point related traps are enabled.
13473 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
13474 The trap mode can be set to one of four values:
13476 @table @samp
13477 @item n
13478 This is the default (normal) setting.  The only traps that are enabled
13479 are the ones that cannot be disabled in software (e.g., division by zero
13480 trap).
13482 @item u
13483 In addition to the traps enabled by @samp{n}, underflow traps are enabled
13484 as well.
13486 @item su
13487 Like @samp{u}, but the instructions are marked to be safe for software
13488 completion (see Alpha architecture manual for details).
13490 @item sui
13491 Like @samp{su}, but inexact traps are enabled as well.
13492 @end table
13494 @item -mfp-rounding-mode=@var{rounding-mode}
13495 @opindex mfp-rounding-mode
13496 Selects the IEEE rounding mode.  Other Alpha compilers call this option
13497 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
13500 @table @samp
13501 @item n
13502 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
13503 the nearest machine number or towards the even machine number in case
13504 of a tie.
13506 @item m
13507 Round towards minus infinity.
13509 @item c
13510 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
13512 @item d
13513 Dynamic rounding mode.  A field in the floating-point control register
13514 (@var{fpcr}, see Alpha architecture reference manual) controls the
13515 rounding mode in effect.  The C library initializes this register for
13516 rounding towards plus infinity.  Thus, unless your program modifies the
13517 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
13518 @end table
13520 @item -mtrap-precision=@var{trap-precision}
13521 @opindex mtrap-precision
13522 In the Alpha architecture, floating-point traps are imprecise.  This
13523 means without software assistance it is impossible to recover from a
13524 floating trap and program execution normally needs to be terminated.
13525 GCC can generate code that can assist operating system trap handlers
13526 in determining the exact location that caused a floating-point trap.
13527 Depending on the requirements of an application, different levels of
13528 precisions can be selected:
13530 @table @samp
13531 @item p
13532 Program precision.  This option is the default and means a trap handler
13533 can only identify which program caused a floating-point exception.
13535 @item f
13536 Function precision.  The trap handler can determine the function that
13537 caused a floating-point exception.
13539 @item i
13540 Instruction precision.  The trap handler can determine the exact
13541 instruction that caused a floating-point exception.
13542 @end table
13544 Other Alpha compilers provide the equivalent options called
13545 @option{-scope_safe} and @option{-resumption_safe}.
13547 @item -mieee-conformant
13548 @opindex mieee-conformant
13549 This option marks the generated code as IEEE conformant.  You must not
13550 use this option unless you also specify @option{-mtrap-precision=i} and either
13551 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
13552 is to emit the line @samp{.eflag 48} in the function prologue of the
13553 generated assembly file.
13555 @item -mbuild-constants
13556 @opindex mbuild-constants
13557 Normally GCC examines a 32- or 64-bit integer constant to
13558 see if it can construct it from smaller constants in two or three
13559 instructions.  If it cannot, it outputs the constant as a literal and
13560 generates code to load it from the data segment at run time.
13562 Use this option to require GCC to construct @emph{all} integer constants
13563 using code, even if it takes more instructions (the maximum is six).
13565 You typically use this option to build a shared library dynamic
13566 loader.  Itself a shared library, it must relocate itself in memory
13567 before it can find the variables and constants in its own data segment.
13569 @item -mbwx
13570 @itemx -mno-bwx
13571 @itemx -mcix
13572 @itemx -mno-cix
13573 @itemx -mfix
13574 @itemx -mno-fix
13575 @itemx -mmax
13576 @itemx -mno-max
13577 @opindex mbwx
13578 @opindex mno-bwx
13579 @opindex mcix
13580 @opindex mno-cix
13581 @opindex mfix
13582 @opindex mno-fix
13583 @opindex mmax
13584 @opindex mno-max
13585 Indicate whether GCC should generate code to use the optional BWX,
13586 CIX, FIX and MAX instruction sets.  The default is to use the instruction
13587 sets supported by the CPU type specified via @option{-mcpu=} option or that
13588 of the CPU on which GCC was built if none is specified.
13590 @item -mfloat-vax
13591 @itemx -mfloat-ieee
13592 @opindex mfloat-vax
13593 @opindex mfloat-ieee
13594 Generate code that uses (does not use) VAX F and G floating-point
13595 arithmetic instead of IEEE single and double precision.
13597 @item -mexplicit-relocs
13598 @itemx -mno-explicit-relocs
13599 @opindex mexplicit-relocs
13600 @opindex mno-explicit-relocs
13601 Older Alpha assemblers provided no way to generate symbol relocations
13602 except via assembler macros.  Use of these macros does not allow
13603 optimal instruction scheduling.  GNU binutils as of version 2.12
13604 supports a new syntax that allows the compiler to explicitly mark
13605 which relocations should apply to which instructions.  This option
13606 is mostly useful for debugging, as GCC detects the capabilities of
13607 the assembler when it is built and sets the default accordingly.
13609 @item -msmall-data
13610 @itemx -mlarge-data
13611 @opindex msmall-data
13612 @opindex mlarge-data
13613 When @option{-mexplicit-relocs} is in effect, static data is
13614 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
13615 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
13616 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
13617 16-bit relocations off of the @code{$gp} register.  This limits the
13618 size of the small data area to 64KB, but allows the variables to be
13619 directly accessed via a single instruction.
13621 The default is @option{-mlarge-data}.  With this option the data area
13622 is limited to just below 2GB@.  Programs that require more than 2GB of
13623 data must use @code{malloc} or @code{mmap} to allocate the data in the
13624 heap instead of in the program's data segment.
13626 When generating code for shared libraries, @option{-fpic} implies
13627 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
13629 @item -msmall-text
13630 @itemx -mlarge-text
13631 @opindex msmall-text
13632 @opindex mlarge-text
13633 When @option{-msmall-text} is used, the compiler assumes that the
13634 code of the entire program (or shared library) fits in 4MB, and is
13635 thus reachable with a branch instruction.  When @option{-msmall-data}
13636 is used, the compiler can assume that all local symbols share the
13637 same @code{$gp} value, and thus reduce the number of instructions
13638 required for a function call from 4 to 1.
13640 The default is @option{-mlarge-text}.
13642 @item -mcpu=@var{cpu_type}
13643 @opindex mcpu
13644 Set the instruction set and instruction scheduling parameters for
13645 machine type @var{cpu_type}.  You can specify either the @samp{EV}
13646 style name or the corresponding chip number.  GCC supports scheduling
13647 parameters for the EV4, EV5 and EV6 family of processors and
13648 chooses the default values for the instruction set from the processor
13649 you specify.  If you do not specify a processor type, GCC defaults
13650 to the processor on which the compiler was built.
13652 Supported values for @var{cpu_type} are
13654 @table @samp
13655 @item ev4
13656 @itemx ev45
13657 @itemx 21064
13658 Schedules as an EV4 and has no instruction set extensions.
13660 @item ev5
13661 @itemx 21164
13662 Schedules as an EV5 and has no instruction set extensions.
13664 @item ev56
13665 @itemx 21164a
13666 Schedules as an EV5 and supports the BWX extension.
13668 @item pca56
13669 @itemx 21164pc
13670 @itemx 21164PC
13671 Schedules as an EV5 and supports the BWX and MAX extensions.
13673 @item ev6
13674 @itemx 21264
13675 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
13677 @item ev67
13678 @itemx 21264a
13679 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
13680 @end table
13682 Native toolchains also support the value @samp{native},
13683 which selects the best architecture option for the host processor.
13684 @option{-mcpu=native} has no effect if GCC does not recognize
13685 the processor.
13687 @item -mtune=@var{cpu_type}
13688 @opindex mtune
13689 Set only the instruction scheduling parameters for machine type
13690 @var{cpu_type}.  The instruction set is not changed.
13692 Native toolchains also support the value @samp{native},
13693 which selects the best architecture option for the host processor.
13694 @option{-mtune=native} has no effect if GCC does not recognize
13695 the processor.
13697 @item -mmemory-latency=@var{time}
13698 @opindex mmemory-latency
13699 Sets the latency the scheduler should assume for typical memory
13700 references as seen by the application.  This number is highly
13701 dependent on the memory access patterns used by the application
13702 and the size of the external cache on the machine.
13704 Valid options for @var{time} are
13706 @table @samp
13707 @item @var{number}
13708 A decimal number representing clock cycles.
13710 @item L1
13711 @itemx L2
13712 @itemx L3
13713 @itemx main
13714 The compiler contains estimates of the number of clock cycles for
13715 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
13716 (also called Dcache, Scache, and Bcache), as well as to main memory.
13717 Note that L3 is only valid for EV5.
13719 @end table
13720 @end table
13722 @node FR30 Options
13723 @subsection FR30 Options
13724 @cindex FR30 Options
13726 These options are defined specifically for the FR30 port.
13728 @table @gcctabopt
13730 @item -msmall-model
13731 @opindex msmall-model
13732 Use the small address space model.  This can produce smaller code, but
13733 it does assume that all symbolic values and addresses fit into a
13734 20-bit range.
13736 @item -mno-lsim
13737 @opindex mno-lsim
13738 Assume that runtime support has been provided and so there is no need
13739 to include the simulator library (@file{libsim.a}) on the linker
13740 command line.
13742 @end table
13744 @node FRV Options
13745 @subsection FRV Options
13746 @cindex FRV Options
13748 @table @gcctabopt
13749 @item -mgpr-32
13750 @opindex mgpr-32
13752 Only use the first 32 general-purpose registers.
13754 @item -mgpr-64
13755 @opindex mgpr-64
13757 Use all 64 general-purpose registers.
13759 @item -mfpr-32
13760 @opindex mfpr-32
13762 Use only the first 32 floating-point registers.
13764 @item -mfpr-64
13765 @opindex mfpr-64
13767 Use all 64 floating-point registers.
13769 @item -mhard-float
13770 @opindex mhard-float
13772 Use hardware instructions for floating-point operations.
13774 @item -msoft-float
13775 @opindex msoft-float
13777 Use library routines for floating-point operations.
13779 @item -malloc-cc
13780 @opindex malloc-cc
13782 Dynamically allocate condition code registers.
13784 @item -mfixed-cc
13785 @opindex mfixed-cc
13787 Do not try to dynamically allocate condition code registers, only
13788 use @code{icc0} and @code{fcc0}.
13790 @item -mdword
13791 @opindex mdword
13793 Change ABI to use double word insns.
13795 @item -mno-dword
13796 @opindex mno-dword
13798 Do not use double word instructions.
13800 @item -mdouble
13801 @opindex mdouble
13803 Use floating-point double instructions.
13805 @item -mno-double
13806 @opindex mno-double
13808 Do not use floating-point double instructions.
13810 @item -mmedia
13811 @opindex mmedia
13813 Use media instructions.
13815 @item -mno-media
13816 @opindex mno-media
13818 Do not use media instructions.
13820 @item -mmuladd
13821 @opindex mmuladd
13823 Use multiply and add/subtract instructions.
13825 @item -mno-muladd
13826 @opindex mno-muladd
13828 Do not use multiply and add/subtract instructions.
13830 @item -mfdpic
13831 @opindex mfdpic
13833 Select the FDPIC ABI, which uses function descriptors to represent
13834 pointers to functions.  Without any PIC/PIE-related options, it
13835 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
13836 assumes GOT entries and small data are within a 12-bit range from the
13837 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
13838 are computed with 32 bits.
13839 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13841 @item -minline-plt
13842 @opindex minline-plt
13844 Enable inlining of PLT entries in function calls to functions that are
13845 not known to bind locally.  It has no effect without @option{-mfdpic}.
13846 It's enabled by default if optimizing for speed and compiling for
13847 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
13848 optimization option such as @option{-O3} or above is present in the
13849 command line.
13851 @item -mTLS
13852 @opindex mTLS
13854 Assume a large TLS segment when generating thread-local code.
13856 @item -mtls
13857 @opindex mtls
13859 Do not assume a large TLS segment when generating thread-local code.
13861 @item -mgprel-ro
13862 @opindex mgprel-ro
13864 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
13865 that is known to be in read-only sections.  It's enabled by default,
13866 except for @option{-fpic} or @option{-fpie}: even though it may help
13867 make the global offset table smaller, it trades 1 instruction for 4.
13868 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
13869 one of which may be shared by multiple symbols, and it avoids the need
13870 for a GOT entry for the referenced symbol, so it's more likely to be a
13871 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
13873 @item -multilib-library-pic
13874 @opindex multilib-library-pic
13876 Link with the (library, not FD) pic libraries.  It's implied by
13877 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
13878 @option{-fpic} without @option{-mfdpic}.  You should never have to use
13879 it explicitly.
13881 @item -mlinked-fp
13882 @opindex mlinked-fp
13884 Follow the EABI requirement of always creating a frame pointer whenever
13885 a stack frame is allocated.  This option is enabled by default and can
13886 be disabled with @option{-mno-linked-fp}.
13888 @item -mlong-calls
13889 @opindex mlong-calls
13891 Use indirect addressing to call functions outside the current
13892 compilation unit.  This allows the functions to be placed anywhere
13893 within the 32-bit address space.
13895 @item -malign-labels
13896 @opindex malign-labels
13898 Try to align labels to an 8-byte boundary by inserting NOPs into the
13899 previous packet.  This option only has an effect when VLIW packing
13900 is enabled.  It doesn't create new packets; it merely adds NOPs to
13901 existing ones.
13903 @item -mlibrary-pic
13904 @opindex mlibrary-pic
13906 Generate position-independent EABI code.
13908 @item -macc-4
13909 @opindex macc-4
13911 Use only the first four media accumulator registers.
13913 @item -macc-8
13914 @opindex macc-8
13916 Use all eight media accumulator registers.
13918 @item -mpack
13919 @opindex mpack
13921 Pack VLIW instructions.
13923 @item -mno-pack
13924 @opindex mno-pack
13926 Do not pack VLIW instructions.
13928 @item -mno-eflags
13929 @opindex mno-eflags
13931 Do not mark ABI switches in e_flags.
13933 @item -mcond-move
13934 @opindex mcond-move
13936 Enable the use of conditional-move instructions (default).
13938 This switch is mainly for debugging the compiler and will likely be removed
13939 in a future version.
13941 @item -mno-cond-move
13942 @opindex mno-cond-move
13944 Disable the use of conditional-move instructions.
13946 This switch is mainly for debugging the compiler and will likely be removed
13947 in a future version.
13949 @item -mscc
13950 @opindex mscc
13952 Enable the use of conditional set instructions (default).
13954 This switch is mainly for debugging the compiler and will likely be removed
13955 in a future version.
13957 @item -mno-scc
13958 @opindex mno-scc
13960 Disable the use of conditional set instructions.
13962 This switch is mainly for debugging the compiler and will likely be removed
13963 in a future version.
13965 @item -mcond-exec
13966 @opindex mcond-exec
13968 Enable the use of conditional execution (default).
13970 This switch is mainly for debugging the compiler and will likely be removed
13971 in a future version.
13973 @item -mno-cond-exec
13974 @opindex mno-cond-exec
13976 Disable the use of conditional execution.
13978 This switch is mainly for debugging the compiler and will likely be removed
13979 in a future version.
13981 @item -mvliw-branch
13982 @opindex mvliw-branch
13984 Run a pass to pack branches into VLIW instructions (default).
13986 This switch is mainly for debugging the compiler and will likely be removed
13987 in a future version.
13989 @item -mno-vliw-branch
13990 @opindex mno-vliw-branch
13992 Do not run a pass to pack branches into VLIW instructions.
13994 This switch is mainly for debugging the compiler and will likely be removed
13995 in a future version.
13997 @item -mmulti-cond-exec
13998 @opindex mmulti-cond-exec
14000 Enable optimization of @code{&&} and @code{||} in conditional execution
14001 (default).
14003 This switch is mainly for debugging the compiler and will likely be removed
14004 in a future version.
14006 @item -mno-multi-cond-exec
14007 @opindex mno-multi-cond-exec
14009 Disable optimization of @code{&&} and @code{||} in conditional execution.
14011 This switch is mainly for debugging the compiler and will likely be removed
14012 in a future version.
14014 @item -mnested-cond-exec
14015 @opindex mnested-cond-exec
14017 Enable nested conditional execution optimizations (default).
14019 This switch is mainly for debugging the compiler and will likely be removed
14020 in a future version.
14022 @item -mno-nested-cond-exec
14023 @opindex mno-nested-cond-exec
14025 Disable nested conditional execution optimizations.
14027 This switch is mainly for debugging the compiler and will likely be removed
14028 in a future version.
14030 @item -moptimize-membar
14031 @opindex moptimize-membar
14033 This switch removes redundant @code{membar} instructions from the
14034 compiler-generated code.  It is enabled by default.
14036 @item -mno-optimize-membar
14037 @opindex mno-optimize-membar
14039 This switch disables the automatic removal of redundant @code{membar}
14040 instructions from the generated code.
14042 @item -mtomcat-stats
14043 @opindex mtomcat-stats
14045 Cause gas to print out tomcat statistics.
14047 @item -mcpu=@var{cpu}
14048 @opindex mcpu
14050 Select the processor type for which to generate code.  Possible values are
14051 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14052 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14054 @end table
14056 @node GNU/Linux Options
14057 @subsection GNU/Linux Options
14059 These @samp{-m} options are defined for GNU/Linux targets:
14061 @table @gcctabopt
14062 @item -mglibc
14063 @opindex mglibc
14064 Use the GNU C library.  This is the default except
14065 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14067 @item -muclibc
14068 @opindex muclibc
14069 Use uClibc C library.  This is the default on
14070 @samp{*-*-linux-*uclibc*} targets.
14072 @item -mbionic
14073 @opindex mbionic
14074 Use Bionic C library.  This is the default on
14075 @samp{*-*-linux-*android*} targets.
14077 @item -mandroid
14078 @opindex mandroid
14079 Compile code compatible with Android platform.  This is the default on
14080 @samp{*-*-linux-*android*} targets.
14082 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14083 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14084 this option makes the GCC driver pass Android-specific options to the linker.
14085 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14086 to be defined.
14088 @item -tno-android-cc
14089 @opindex tno-android-cc
14090 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14091 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14092 @option{-fno-rtti} by default.
14094 @item -tno-android-ld
14095 @opindex tno-android-ld
14096 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14097 linking options to the linker.
14099 @end table
14101 @node H8/300 Options
14102 @subsection H8/300 Options
14104 These @samp{-m} options are defined for the H8/300 implementations:
14106 @table @gcctabopt
14107 @item -mrelax
14108 @opindex mrelax
14109 Shorten some address references at link time, when possible; uses the
14110 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14111 ld, Using ld}, for a fuller description.
14113 @item -mh
14114 @opindex mh
14115 Generate code for the H8/300H@.
14117 @item -ms
14118 @opindex ms
14119 Generate code for the H8S@.
14121 @item -mn
14122 @opindex mn
14123 Generate code for the H8S and H8/300H in the normal mode.  This switch
14124 must be used either with @option{-mh} or @option{-ms}.
14126 @item -ms2600
14127 @opindex ms2600
14128 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14130 @item -mexr
14131 @opindex mexr
14132 Extended registers are stored on stack before execution of function
14133 with monitor attribute. Default option is @option{-mexr}.
14134 This option is valid only for H8S targets.
14136 @item -mno-exr
14137 @opindex mno-exr
14138 Extended registers are not stored on stack before execution of function 
14139 with monitor attribute. Default option is @option{-mno-exr}. 
14140 This option is valid only for H8S targets.
14142 @item -mint32
14143 @opindex mint32
14144 Make @code{int} data 32 bits by default.
14146 @item -malign-300
14147 @opindex malign-300
14148 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
14149 The default for the H8/300H and H8S is to align longs and floats on
14150 4-byte boundaries.
14151 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
14152 This option has no effect on the H8/300.
14153 @end table
14155 @node HPPA Options
14156 @subsection HPPA Options
14157 @cindex HPPA Options
14159 These @samp{-m} options are defined for the HPPA family of computers:
14161 @table @gcctabopt
14162 @item -march=@var{architecture-type}
14163 @opindex march
14164 Generate code for the specified architecture.  The choices for
14165 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
14166 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
14167 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
14168 architecture option for your machine.  Code compiled for lower numbered
14169 architectures runs on higher numbered architectures, but not the
14170 other way around.
14172 @item -mpa-risc-1-0
14173 @itemx -mpa-risc-1-1
14174 @itemx -mpa-risc-2-0
14175 @opindex mpa-risc-1-0
14176 @opindex mpa-risc-1-1
14177 @opindex mpa-risc-2-0
14178 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
14180 @item -mjump-in-delay
14181 @opindex mjump-in-delay
14182 Fill delay slots of function calls with unconditional jump instructions
14183 by modifying the return pointer for the function call to be the target
14184 of the conditional jump.
14186 @item -mdisable-fpregs
14187 @opindex mdisable-fpregs
14188 Prevent floating-point registers from being used in any manner.  This is
14189 necessary for compiling kernels that perform lazy context switching of
14190 floating-point registers.  If you use this option and attempt to perform
14191 floating-point operations, the compiler aborts.
14193 @item -mdisable-indexing
14194 @opindex mdisable-indexing
14195 Prevent the compiler from using indexing address modes.  This avoids some
14196 rather obscure problems when compiling MIG generated code under MACH@.
14198 @item -mno-space-regs
14199 @opindex mno-space-regs
14200 Generate code that assumes the target has no space registers.  This allows
14201 GCC to generate faster indirect calls and use unscaled index address modes.
14203 Such code is suitable for level 0 PA systems and kernels.
14205 @item -mfast-indirect-calls
14206 @opindex mfast-indirect-calls
14207 Generate code that assumes calls never cross space boundaries.  This
14208 allows GCC to emit code that performs faster indirect calls.
14210 This option does not work in the presence of shared libraries or nested
14211 functions.
14213 @item -mfixed-range=@var{register-range}
14214 @opindex mfixed-range
14215 Generate code treating the given register range as fixed registers.
14216 A fixed register is one that the register allocator cannot use.  This is
14217 useful when compiling kernel code.  A register range is specified as
14218 two registers separated by a dash.  Multiple register ranges can be
14219 specified separated by a comma.
14221 @item -mlong-load-store
14222 @opindex mlong-load-store
14223 Generate 3-instruction load and store sequences as sometimes required by
14224 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
14225 the HP compilers.
14227 @item -mportable-runtime
14228 @opindex mportable-runtime
14229 Use the portable calling conventions proposed by HP for ELF systems.
14231 @item -mgas
14232 @opindex mgas
14233 Enable the use of assembler directives only GAS understands.
14235 @item -mschedule=@var{cpu-type}
14236 @opindex mschedule
14237 Schedule code according to the constraints for the machine type
14238 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
14239 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
14240 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
14241 proper scheduling option for your machine.  The default scheduling is
14242 @samp{8000}.
14244 @item -mlinker-opt
14245 @opindex mlinker-opt
14246 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
14247 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
14248 linkers in which they give bogus error messages when linking some programs.
14250 @item -msoft-float
14251 @opindex msoft-float
14252 Generate output containing library calls for floating point.
14253 @strong{Warning:} the requisite libraries are not available for all HPPA
14254 targets.  Normally the facilities of the machine's usual C compiler are
14255 used, but this cannot be done directly in cross-compilation.  You must make
14256 your own arrangements to provide suitable library functions for
14257 cross-compilation.
14259 @option{-msoft-float} changes the calling convention in the output file;
14260 therefore, it is only useful if you compile @emph{all} of a program with
14261 this option.  In particular, you need to compile @file{libgcc.a}, the
14262 library that comes with GCC, with @option{-msoft-float} in order for
14263 this to work.
14265 @item -msio
14266 @opindex msio
14267 Generate the predefine, @code{_SIO}, for server IO@.  The default is
14268 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
14269 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
14270 options are available under HP-UX and HI-UX@.
14272 @item -mgnu-ld
14273 @opindex mgnu-ld
14274 Use options specific to GNU @command{ld}.
14275 This passes @option{-shared} to @command{ld} when
14276 building a shared library.  It is the default when GCC is configured,
14277 explicitly or implicitly, with the GNU linker.  This option does not
14278 affect which @command{ld} is called; it only changes what parameters
14279 are passed to that @command{ld}.
14280 The @command{ld} that is called is determined by the
14281 @option{--with-ld} configure option, GCC's program search path, and
14282 finally by the user's @env{PATH}.  The linker used by GCC can be printed
14283 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
14284 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14286 @item -mhp-ld
14287 @opindex mhp-ld
14288 Use options specific to HP @command{ld}.
14289 This passes @option{-b} to @command{ld} when building
14290 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
14291 links.  It is the default when GCC is configured, explicitly or
14292 implicitly, with the HP linker.  This option does not affect
14293 which @command{ld} is called; it only changes what parameters are passed to that
14294 @command{ld}.
14295 The @command{ld} that is called is determined by the @option{--with-ld}
14296 configure option, GCC's program search path, and finally by the user's
14297 @env{PATH}.  The linker used by GCC can be printed using @samp{which
14298 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
14299 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14301 @item -mlong-calls
14302 @opindex mno-long-calls
14303 Generate code that uses long call sequences.  This ensures that a call
14304 is always able to reach linker generated stubs.  The default is to generate
14305 long calls only when the distance from the call site to the beginning
14306 of the function or translation unit, as the case may be, exceeds a
14307 predefined limit set by the branch type being used.  The limits for
14308 normal calls are 7,600,000 and 240,000 bytes, respectively for the
14309 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
14310 240,000 bytes.
14312 Distances are measured from the beginning of functions when using the
14313 @option{-ffunction-sections} option, or when using the @option{-mgas}
14314 and @option{-mno-portable-runtime} options together under HP-UX with
14315 the SOM linker.
14317 It is normally not desirable to use this option as it degrades
14318 performance.  However, it may be useful in large applications,
14319 particularly when partial linking is used to build the application.
14321 The types of long calls used depends on the capabilities of the
14322 assembler and linker, and the type of code being generated.  The
14323 impact on systems that support long absolute calls, and long pic
14324 symbol-difference or pc-relative calls should be relatively small.
14325 However, an indirect call is used on 32-bit ELF systems in pic code
14326 and it is quite long.
14328 @item -munix=@var{unix-std}
14329 @opindex march
14330 Generate compiler predefines and select a startfile for the specified
14331 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
14332 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
14333 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
14334 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
14335 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
14336 and later.
14338 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
14339 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
14340 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
14341 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
14342 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
14343 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
14345 It is @emph{important} to note that this option changes the interfaces
14346 for various library routines.  It also affects the operational behavior
14347 of the C library.  Thus, @emph{extreme} care is needed in using this
14348 option.
14350 Library code that is intended to operate with more than one UNIX
14351 standard must test, set and restore the variable @var{__xpg4_extended_mask}
14352 as appropriate.  Most GNU software doesn't provide this capability.
14354 @item -nolibdld
14355 @opindex nolibdld
14356 Suppress the generation of link options to search libdld.sl when the
14357 @option{-static} option is specified on HP-UX 10 and later.
14359 @item -static
14360 @opindex static
14361 The HP-UX implementation of setlocale in libc has a dependency on
14362 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
14363 when the @option{-static} option is specified, special link options
14364 are needed to resolve this dependency.
14366 On HP-UX 10 and later, the GCC driver adds the necessary options to
14367 link with libdld.sl when the @option{-static} option is specified.
14368 This causes the resulting binary to be dynamic.  On the 64-bit port,
14369 the linkers generate dynamic binaries by default in any case.  The
14370 @option{-nolibdld} option can be used to prevent the GCC driver from
14371 adding these link options.
14373 @item -threads
14374 @opindex threads
14375 Add support for multithreading with the @dfn{dce thread} library
14376 under HP-UX@.  This option sets flags for both the preprocessor and
14377 linker.
14378 @end table
14380 @node i386 and x86-64 Options
14381 @subsection Intel 386 and AMD x86-64 Options
14382 @cindex i386 Options
14383 @cindex x86-64 Options
14384 @cindex Intel 386 Options
14385 @cindex AMD x86-64 Options
14387 These @samp{-m} options are defined for the i386 and x86-64 family of
14388 computers:
14390 @table @gcctabopt
14392 @item -march=@var{cpu-type}
14393 @opindex march
14394 Generate instructions for the machine type @var{cpu-type}.  In contrast to
14395 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
14396 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
14397 to generate code that may not run at all on processors other than the one
14398 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
14399 @option{-mtune=@var{cpu-type}}.
14401 The choices for @var{cpu-type} are:
14403 @table @samp
14404 @item native
14405 This selects the CPU to generate code for at compilation time by determining
14406 the processor type of the compiling machine.  Using @option{-march=native}
14407 enables all instruction subsets supported by the local machine (hence
14408 the result might not run on different machines).  Using @option{-mtune=native}
14409 produces code optimized for the local machine under the constraints
14410 of the selected instruction set.  
14412 @item i386
14413 Original Intel i386 CPU@.
14415 @item i486
14416 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
14418 @item i586
14419 @itemx pentium
14420 Intel Pentium CPU with no MMX support.
14422 @item pentium-mmx
14423 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
14425 @item pentiumpro
14426 Intel Pentium Pro CPU@.
14428 @item i686
14429 When used with @option{-march}, the Pentium Pro
14430 instruction set is used, so the code runs on all i686 family chips.
14431 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
14433 @item pentium2
14434 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
14435 support.
14437 @item pentium3
14438 @itemx pentium3m
14439 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
14440 set support.
14442 @item pentium-m
14443 Intel Pentium M; low-power version of Intel Pentium III CPU
14444 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
14446 @item pentium4
14447 @itemx pentium4m
14448 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
14450 @item prescott
14451 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
14452 set support.
14454 @item nocona
14455 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
14456 SSE2 and SSE3 instruction set support.
14458 @item core2
14459 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
14460 instruction set support.
14462 @item corei7
14463 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
14464 and SSE4.2 instruction set support.
14466 @item corei7-avx
14467 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14468 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
14470 @item core-avx-i
14471 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14472 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
14473 set support.
14475 @item core-avx2
14476 Intel Core CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14477 SSE4.1, SSE4.2, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI, BMI2
14478 and F16C instruction set support.
14480 @item atom
14481 Intel Atom CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
14482 instruction set support.
14484 @item slm
14485 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14486 SSE4.1 and SSE4.2 instruction set support.
14488 @item k6
14489 AMD K6 CPU with MMX instruction set support.
14491 @item k6-2
14492 @itemx k6-3
14493 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
14495 @item athlon
14496 @itemx athlon-tbird
14497 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
14498 support.
14500 @item athlon-4
14501 @itemx athlon-xp
14502 @itemx athlon-mp
14503 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
14504 instruction set support.
14506 @item k8
14507 @itemx opteron
14508 @itemx athlon64
14509 @itemx athlon-fx
14510 Processors based on the AMD K8 core with x86-64 instruction set support,
14511 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
14512 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
14513 instruction set extensions.)
14515 @item k8-sse3
14516 @itemx opteron-sse3
14517 @itemx athlon64-sse3
14518 Improved versions of AMD K8 cores with SSE3 instruction set support.
14520 @item amdfam10
14521 @itemx barcelona
14522 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
14523 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
14524 instruction set extensions.)
14526 @item bdver1
14527 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
14528 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
14529 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
14530 @item bdver2
14531 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14532 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
14533 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
14534 extensions.)
14535 @item bdver3
14536 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14537 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
14538 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
14539 64-bit instruction set extensions.
14540 @item bdver4
14541 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14542 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
14543 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
14544 SSE4.2, ABM and 64-bit instruction set extensions.
14546 @item btver1
14547 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
14548 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
14549 instruction set extensions.)
14551 @item btver2
14552 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
14553 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
14554 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
14556 @item winchip-c6
14557 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
14558 set support.
14560 @item winchip2
14561 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
14562 instruction set support.
14564 @item c3
14565 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
14566 implemented for this chip.)
14568 @item c3-2
14569 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
14570 (No scheduling is
14571 implemented for this chip.)
14573 @item geode
14574 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
14575 @end table
14577 @item -mtune=@var{cpu-type}
14578 @opindex mtune
14579 Tune to @var{cpu-type} everything applicable about the generated code, except
14580 for the ABI and the set of available instructions.  
14581 While picking a specific @var{cpu-type} schedules things appropriately
14582 for that particular chip, the compiler does not generate any code that
14583 cannot run on the default machine type unless you use a
14584 @option{-march=@var{cpu-type}} option.
14585 For example, if GCC is configured for i686-pc-linux-gnu
14586 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
14587 but still runs on i686 machines.
14589 The choices for @var{cpu-type} are the same as for @option{-march}.
14590 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
14592 @table @samp
14593 @item generic
14594 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
14595 If you know the CPU on which your code will run, then you should use
14596 the corresponding @option{-mtune} or @option{-march} option instead of
14597 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
14598 of your application will have, then you should use this option.
14600 As new processors are deployed in the marketplace, the behavior of this
14601 option will change.  Therefore, if you upgrade to a newer version of
14602 GCC, code generation controlled by this option will change to reflect
14603 the processors
14604 that are most common at the time that version of GCC is released.
14606 There is no @option{-march=generic} option because @option{-march}
14607 indicates the instruction set the compiler can use, and there is no
14608 generic instruction set applicable to all processors.  In contrast,
14609 @option{-mtune} indicates the processor (or, in this case, collection of
14610 processors) for which the code is optimized.
14611 @end table
14613 @item -mcpu=@var{cpu-type}
14614 @opindex mcpu
14615 A deprecated synonym for @option{-mtune}.
14617 @item -mfpmath=@var{unit}
14618 @opindex mfpmath
14619 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
14620 for @var{unit} are:
14622 @table @samp
14623 @item 387
14624 Use the standard 387 floating-point coprocessor present on the majority of chips and
14625 emulated otherwise.  Code compiled with this option runs almost everywhere.
14626 The temporary results are computed in 80-bit precision instead of the precision
14627 specified by the type, resulting in slightly different results compared to most
14628 of other chips.  See @option{-ffloat-store} for more detailed description.
14630 This is the default choice for i386 compiler.
14632 @item sse
14633 Use scalar floating-point instructions present in the SSE instruction set.
14634 This instruction set is supported by Pentium III and newer chips,
14635 and in the AMD line
14636 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
14637 instruction set supports only single-precision arithmetic, thus the double and
14638 extended-precision arithmetic are still done using 387.  A later version, present
14639 only in Pentium 4 and AMD x86-64 chips, supports double-precision
14640 arithmetic too.
14642 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
14643 or @option{-msse2} switches to enable SSE extensions and make this option
14644 effective.  For the x86-64 compiler, these extensions are enabled by default.
14646 The resulting code should be considerably faster in the majority of cases and avoid
14647 the numerical instability problems of 387 code, but may break some existing
14648 code that expects temporaries to be 80 bits.
14650 This is the default choice for the x86-64 compiler.
14652 @item sse,387
14653 @itemx sse+387
14654 @itemx both
14655 Attempt to utilize both instruction sets at once.  This effectively doubles the
14656 amount of available registers, and on chips with separate execution units for
14657 387 and SSE the execution resources too.  Use this option with care, as it is
14658 still experimental, because the GCC register allocator does not model separate
14659 functional units well, resulting in unstable performance.
14660 @end table
14662 @item -masm=@var{dialect}
14663 @opindex masm=@var{dialect}
14664 Output assembly instructions using selected @var{dialect}.  Supported
14665 choices are @samp{intel} or @samp{att} (the default).  Darwin does
14666 not support @samp{intel}.
14668 @item -mieee-fp
14669 @itemx -mno-ieee-fp
14670 @opindex mieee-fp
14671 @opindex mno-ieee-fp
14672 Control whether or not the compiler uses IEEE floating-point
14673 comparisons.  These correctly handle the case where the result of a
14674 comparison is unordered.
14676 @item -msoft-float
14677 @opindex msoft-float
14678 Generate output containing library calls for floating point.
14680 @strong{Warning:} the requisite libraries are not part of GCC@.
14681 Normally the facilities of the machine's usual C compiler are used, but
14682 this can't be done directly in cross-compilation.  You must make your
14683 own arrangements to provide suitable library functions for
14684 cross-compilation.
14686 On machines where a function returns floating-point results in the 80387
14687 register stack, some floating-point opcodes may be emitted even if
14688 @option{-msoft-float} is used.
14690 @item -mno-fp-ret-in-387
14691 @opindex mno-fp-ret-in-387
14692 Do not use the FPU registers for return values of functions.
14694 The usual calling convention has functions return values of types
14695 @code{float} and @code{double} in an FPU register, even if there
14696 is no FPU@.  The idea is that the operating system should emulate
14697 an FPU@.
14699 The option @option{-mno-fp-ret-in-387} causes such values to be returned
14700 in ordinary CPU registers instead.
14702 @item -mno-fancy-math-387
14703 @opindex mno-fancy-math-387
14704 Some 387 emulators do not support the @code{sin}, @code{cos} and
14705 @code{sqrt} instructions for the 387.  Specify this option to avoid
14706 generating those instructions.  This option is the default on FreeBSD,
14707 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
14708 indicates that the target CPU always has an FPU and so the
14709 instruction does not need emulation.  These
14710 instructions are not generated unless you also use the
14711 @option{-funsafe-math-optimizations} switch.
14713 @item -malign-double
14714 @itemx -mno-align-double
14715 @opindex malign-double
14716 @opindex mno-align-double
14717 Control whether GCC aligns @code{double}, @code{long double}, and
14718 @code{long long} variables on a two-word boundary or a one-word
14719 boundary.  Aligning @code{double} variables on a two-word boundary
14720 produces code that runs somewhat faster on a Pentium at the
14721 expense of more memory.
14723 On x86-64, @option{-malign-double} is enabled by default.
14725 @strong{Warning:} if you use the @option{-malign-double} switch,
14726 structures containing the above types are aligned differently than
14727 the published application binary interface specifications for the 386
14728 and are not binary compatible with structures in code compiled
14729 without that switch.
14731 @item -m96bit-long-double
14732 @itemx -m128bit-long-double
14733 @opindex m96bit-long-double
14734 @opindex m128bit-long-double
14735 These switches control the size of @code{long double} type.  The i386
14736 application binary interface specifies the size to be 96 bits,
14737 so @option{-m96bit-long-double} is the default in 32-bit mode.
14739 Modern architectures (Pentium and newer) prefer @code{long double}
14740 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
14741 conforming to the ABI, this is not possible.  So specifying
14742 @option{-m128bit-long-double} aligns @code{long double}
14743 to a 16-byte boundary by padding the @code{long double} with an additional
14744 32-bit zero.
14746 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
14747 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
14749 Notice that neither of these options enable any extra precision over the x87
14750 standard of 80 bits for a @code{long double}.
14752 @strong{Warning:} if you override the default value for your target ABI, this
14753 changes the size of 
14754 structures and arrays containing @code{long double} variables,
14755 as well as modifying the function calling convention for functions taking
14756 @code{long double}.  Hence they are not binary-compatible
14757 with code compiled without that switch.
14759 @item -mlong-double-64
14760 @itemx -mlong-double-80
14761 @opindex mlong-double-64
14762 @opindex mlong-double-80
14763 These switches control the size of @code{long double} type. A size
14764 of 64 bits makes the @code{long double} type equivalent to the @code{double}
14765 type. This is the default for Bionic C library.
14767 @strong{Warning:} if you override the default value for your target ABI, this
14768 changes the size of
14769 structures and arrays containing @code{long double} variables,
14770 as well as modifying the function calling convention for functions taking
14771 @code{long double}.  Hence they are not binary-compatible
14772 with code compiled without that switch.
14774 @item -mlarge-data-threshold=@var{threshold}
14775 @opindex mlarge-data-threshold
14776 When @option{-mcmodel=medium} is specified, data objects larger than
14777 @var{threshold} are placed in the large data section.  This value must be the
14778 same across all objects linked into the binary, and defaults to 65535.
14780 @item -mrtd
14781 @opindex mrtd
14782 Use a different function-calling convention, in which functions that
14783 take a fixed number of arguments return with the @code{ret @var{num}}
14784 instruction, which pops their arguments while returning.  This saves one
14785 instruction in the caller since there is no need to pop the arguments
14786 there.
14788 You can specify that an individual function is called with this calling
14789 sequence with the function attribute @samp{stdcall}.  You can also
14790 override the @option{-mrtd} option by using the function attribute
14791 @samp{cdecl}.  @xref{Function Attributes}.
14793 @strong{Warning:} this calling convention is incompatible with the one
14794 normally used on Unix, so you cannot use it if you need to call
14795 libraries compiled with the Unix compiler.
14797 Also, you must provide function prototypes for all functions that
14798 take variable numbers of arguments (including @code{printf});
14799 otherwise incorrect code is generated for calls to those
14800 functions.
14802 In addition, seriously incorrect code results if you call a
14803 function with too many arguments.  (Normally, extra arguments are
14804 harmlessly ignored.)
14806 @item -mregparm=@var{num}
14807 @opindex mregparm
14808 Control how many registers are used to pass integer arguments.  By
14809 default, no registers are used to pass arguments, and at most 3
14810 registers can be used.  You can control this behavior for a specific
14811 function by using the function attribute @samp{regparm}.
14812 @xref{Function Attributes}.
14814 @strong{Warning:} if you use this switch, and
14815 @var{num} is nonzero, then you must build all modules with the same
14816 value, including any libraries.  This includes the system libraries and
14817 startup modules.
14819 @item -msseregparm
14820 @opindex msseregparm
14821 Use SSE register passing conventions for float and double arguments
14822 and return values.  You can control this behavior for a specific
14823 function by using the function attribute @samp{sseregparm}.
14824 @xref{Function Attributes}.
14826 @strong{Warning:} if you use this switch then you must build all
14827 modules with the same value, including any libraries.  This includes
14828 the system libraries and startup modules.
14830 @item -mvect8-ret-in-mem
14831 @opindex mvect8-ret-in-mem
14832 Return 8-byte vectors in memory instead of MMX registers.  This is the
14833 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
14834 Studio compilers until version 12.  Later compiler versions (starting
14835 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
14836 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
14837 you need to remain compatible with existing code produced by those
14838 previous compiler versions or older versions of GCC@.
14840 @item -mpc32
14841 @itemx -mpc64
14842 @itemx -mpc80
14843 @opindex mpc32
14844 @opindex mpc64
14845 @opindex mpc80
14847 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
14848 is specified, the significands of results of floating-point operations are
14849 rounded to 24 bits (single precision); @option{-mpc64} rounds the
14850 significands of results of floating-point operations to 53 bits (double
14851 precision) and @option{-mpc80} rounds the significands of results of
14852 floating-point operations to 64 bits (extended double precision), which is
14853 the default.  When this option is used, floating-point operations in higher
14854 precisions are not available to the programmer without setting the FPU
14855 control word explicitly.
14857 Setting the rounding of floating-point operations to less than the default
14858 80 bits can speed some programs by 2% or more.  Note that some mathematical
14859 libraries assume that extended-precision (80-bit) floating-point operations
14860 are enabled by default; routines in such libraries could suffer significant
14861 loss of accuracy, typically through so-called ``catastrophic cancellation'',
14862 when this option is used to set the precision to less than extended precision.
14864 @item -mstackrealign
14865 @opindex mstackrealign
14866 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
14867 option generates an alternate prologue and epilogue that realigns the
14868 run-time stack if necessary.  This supports mixing legacy codes that keep
14869 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
14870 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
14871 applicable to individual functions.
14873 @item -mpreferred-stack-boundary=@var{num}
14874 @opindex mpreferred-stack-boundary
14875 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
14876 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
14877 the default is 4 (16 bytes or 128 bits).
14879 @strong{Warning:} When generating code for the x86-64 architecture with
14880 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
14881 used to keep the stack boundary aligned to 8 byte boundary.  Since
14882 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
14883 intended to be used in controlled environment where stack space is
14884 important limitation.  This option will lead to wrong code when functions
14885 compiled with 16 byte stack alignment (such as functions from a standard
14886 library) are called with misaligned stack.  In this case, SSE
14887 instructions may lead to misaligned memory access traps.  In addition,
14888 variable arguments will be handled incorrectly for 16 byte aligned
14889 objects (including x87 long double and __int128), leading to wrong
14890 results.  You must build all modules with
14891 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
14892 includes the system libraries and startup modules.
14894 @item -mincoming-stack-boundary=@var{num}
14895 @opindex mincoming-stack-boundary
14896 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
14897 boundary.  If @option{-mincoming-stack-boundary} is not specified,
14898 the one specified by @option{-mpreferred-stack-boundary} is used.
14900 On Pentium and Pentium Pro, @code{double} and @code{long double} values
14901 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
14902 suffer significant run time performance penalties.  On Pentium III, the
14903 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
14904 properly if it is not 16-byte aligned.
14906 To ensure proper alignment of this values on the stack, the stack boundary
14907 must be as aligned as that required by any value stored on the stack.
14908 Further, every function must be generated such that it keeps the stack
14909 aligned.  Thus calling a function compiled with a higher preferred
14910 stack boundary from a function compiled with a lower preferred stack
14911 boundary most likely misaligns the stack.  It is recommended that
14912 libraries that use callbacks always use the default setting.
14914 This extra alignment does consume extra stack space, and generally
14915 increases code size.  Code that is sensitive to stack space usage, such
14916 as embedded systems and operating system kernels, may want to reduce the
14917 preferred alignment to @option{-mpreferred-stack-boundary=2}.
14919 @item -mmmx
14920 @itemx -mno-mmx
14921 @itemx -msse
14922 @itemx -mno-sse
14923 @itemx -msse2
14924 @itemx -mno-sse2
14925 @itemx -msse3
14926 @itemx -mno-sse3
14927 @itemx -mssse3
14928 @itemx -mno-ssse3
14929 @itemx -msse4.1
14930 @need 800
14931 @itemx -mno-sse4.1
14932 @itemx -msse4.2
14933 @itemx -mno-sse4.2
14934 @itemx -msse4
14935 @itemx -mno-sse4
14936 @itemx -mavx
14937 @itemx -mno-avx
14938 @itemx -mavx2
14939 @itemx -mno-avx2
14940 @itemx -mavx512f
14941 @itemx -mno-avx512f
14942 @need 800
14943 @itemx -mavx512pf
14944 @itemx -mno-avx512pf
14945 @itemx -mavx512er
14946 @itemx -mno-avx512er
14947 @itemx -mavx512cd
14948 @itemx -mno-avx512cd
14949 @itemx -maes
14950 @itemx -mno-aes
14951 @itemx -mpclmul
14952 @itemx -mno-pclmul
14953 @need 800
14954 @itemx -mfsgsbase
14955 @itemx -mno-fsgsbase
14956 @itemx -mrdrnd
14957 @itemx -mno-rdrnd
14958 @itemx -mf16c
14959 @itemx -mno-f16c
14960 @itemx -mfma
14961 @itemx -mno-fma
14962 @itemx -msse4a
14963 @itemx -mno-sse4a
14964 @itemx -mfma4
14965 @itemx -mno-fma4
14966 @need 800
14967 @itemx -mxop
14968 @itemx -mno-xop
14969 @itemx -mlwp
14970 @itemx -mno-lwp
14971 @itemx -m3dnow
14972 @itemx -mno-3dnow
14973 @itemx -mpopcnt
14974 @itemx -mno-popcnt
14975 @itemx -mabm
14976 @itemx -mno-abm
14977 @itemx -mbmi
14978 @itemx -mbmi2
14979 @itemx -mno-bmi
14980 @itemx -mno-bmi2
14981 @itemx -mlzcnt
14982 @itemx -mno-lzcnt
14983 @itemx -mfxsr
14984 @itemx -mxsave
14985 @itemx -mxsaveopt
14986 @itemx -mrtm
14987 @itemx -mtbm
14988 @itemx -mno-tbm
14989 @itemx -mmpx
14990 @itemx -mno-mpx
14991 @opindex mmmx
14992 @opindex mno-mmx
14993 @opindex msse
14994 @opindex mno-sse
14995 @opindex m3dnow
14996 @opindex mno-3dnow
14997 These switches enable or disable the use of instructions in the MMX, SSE,
14998 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
14999 AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2,
15000 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
15001 extended instruction sets.
15002 These extensions are also available as built-in functions: see
15003 @ref{X86 Built-in Functions}, for details of the functions enabled and
15004 disabled by these switches.
15006 To generate SSE/SSE2 instructions automatically from floating-point
15007 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15009 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15010 generates new AVX instructions or AVX equivalence for all SSEx instructions
15011 when needed.
15013 These options enable GCC to use these extended instructions in
15014 generated code, even without @option{-mfpmath=sse}.  Applications that
15015 perform run-time CPU detection must compile separate files for each
15016 supported architecture, using the appropriate flags.  In particular,
15017 the file containing the CPU detection code should be compiled without
15018 these options.
15020 @item -mdump-tune-features
15021 @opindex mdump-tune-features
15022 This option instructs GCC to dump the names of the x86 performance 
15023 tuning features and default settings. The names can be used in 
15024 @option{-mtune-ctrl=@var{feature-list}}.
15026 @item -mtune-ctrl=@var{feature-list}
15027 @opindex mtune-ctrl=@var{feature-list}
15028 This option is used to do fine grain control of x86 code generation features.
15029 @var{feature-list} is a comma separated list of @var{feature} names. See also
15030 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15031 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15032 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15033 developers. Using it may lead to code paths not covered by testing and can
15034 potentially result in compiler ICEs or runtime errors.
15036 @item -mno-default
15037 @opindex mno-default
15038 This option instructs GCC to turn off all tunable features. See also 
15039 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15041 @item -mcld
15042 @opindex mcld
15043 This option instructs GCC to emit a @code{cld} instruction in the prologue
15044 of functions that use string instructions.  String instructions depend on
15045 the DF flag to select between autoincrement or autodecrement mode.  While the
15046 ABI specifies the DF flag to be cleared on function entry, some operating
15047 systems violate this specification by not clearing the DF flag in their
15048 exception dispatchers.  The exception handler can be invoked with the DF flag
15049 set, which leads to wrong direction mode when string instructions are used.
15050 This option can be enabled by default on 32-bit x86 targets by configuring
15051 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15052 instructions can be suppressed with the @option{-mno-cld} compiler option
15053 in this case.
15055 @item -mvzeroupper
15056 @opindex mvzeroupper
15057 This option instructs GCC to emit a @code{vzeroupper} instruction
15058 before a transfer of control flow out of the function to minimize
15059 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15060 intrinsics.
15062 @item -mprefer-avx128
15063 @opindex mprefer-avx128
15064 This option instructs GCC to use 128-bit AVX instructions instead of
15065 256-bit AVX instructions in the auto-vectorizer.
15067 @item -mcx16
15068 @opindex mcx16
15069 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15070 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15071 (or oword) data types.  
15072 This is useful for high-resolution counters that can be updated
15073 by multiple processors (or cores).  This instruction is generated as part of
15074 atomic built-in functions: see @ref{__sync Builtins} or
15075 @ref{__atomic Builtins} for details.
15077 @item -msahf
15078 @opindex msahf
15079 This option enables generation of @code{SAHF} instructions in 64-bit code.
15080 Early Intel Pentium 4 CPUs with Intel 64 support,
15081 prior to the introduction of Pentium 4 G1 step in December 2005,
15082 lacked the @code{LAHF} and @code{SAHF} instructions
15083 which were supported by AMD64.
15084 These are load and store instructions, respectively, for certain status flags.
15085 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15086 @code{drem}, and @code{remainder} built-in functions;
15087 see @ref{Other Builtins} for details.
15089 @item -mmovbe
15090 @opindex mmovbe
15091 This option enables use of the @code{movbe} instruction to implement
15092 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15094 @item -mcrc32
15095 @opindex mcrc32
15096 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15097 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15098 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15100 @item -mrecip
15101 @opindex mrecip
15102 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
15103 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
15104 with an additional Newton-Raphson step
15105 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
15106 (and their vectorized
15107 variants) for single-precision floating-point arguments.  These instructions
15108 are generated only when @option{-funsafe-math-optimizations} is enabled
15109 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
15110 Note that while the throughput of the sequence is higher than the throughput
15111 of the non-reciprocal instruction, the precision of the sequence can be
15112 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
15114 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
15115 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
15116 combination), and doesn't need @option{-mrecip}.
15118 Also note that GCC emits the above sequence with additional Newton-Raphson step
15119 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
15120 already with @option{-ffast-math} (or the above option combination), and
15121 doesn't need @option{-mrecip}.
15123 @item -mrecip=@var{opt}
15124 @opindex mrecip=opt
15125 This option controls which reciprocal estimate instructions
15126 may be used.  @var{opt} is a comma-separated list of options, which may
15127 be preceded by a @samp{!} to invert the option:
15129 @table @samp
15130 @item all
15131 Enable all estimate instructions.
15133 @item default
15134 Enable the default instructions, equivalent to @option{-mrecip}.
15136 @item none
15137 Disable all estimate instructions, equivalent to @option{-mno-recip}.
15139 @item div
15140 Enable the approximation for scalar division.
15142 @item vec-div
15143 Enable the approximation for vectorized division.
15145 @item sqrt
15146 Enable the approximation for scalar square root.
15148 @item vec-sqrt
15149 Enable the approximation for vectorized square root.
15150 @end table
15152 So, for example, @option{-mrecip=all,!sqrt} enables
15153 all of the reciprocal approximations, except for square root.
15155 @item -mveclibabi=@var{type}
15156 @opindex mveclibabi
15157 Specifies the ABI type to use for vectorizing intrinsics using an
15158 external library.  Supported values for @var{type} are @samp{svml} 
15159 for the Intel short
15160 vector math library and @samp{acml} for the AMD math core library.
15161 To use this option, both @option{-ftree-vectorize} and
15162 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
15163 ABI-compatible library must be specified at link time.
15165 GCC currently emits calls to @code{vmldExp2},
15166 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
15167 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
15168 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
15169 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
15170 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
15171 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
15172 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
15173 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
15174 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
15175 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
15176 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
15177 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
15178 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
15179 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
15180 when @option{-mveclibabi=acml} is used.  
15182 @item -mabi=@var{name}
15183 @opindex mabi
15184 Generate code for the specified calling convention.  Permissible values
15185 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
15186 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
15187 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
15188 You can control this behavior for a specific function by
15189 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
15190 @xref{Function Attributes}.
15192 @item -mtls-dialect=@var{type}
15193 @opindex mtls-dialect
15194 Generate code to access thread-local storage using the @samp{gnu} or
15195 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
15196 @samp{gnu2} is more efficient, but it may add compile- and run-time
15197 requirements that cannot be satisfied on all systems.
15199 @item -mpush-args
15200 @itemx -mno-push-args
15201 @opindex mpush-args
15202 @opindex mno-push-args
15203 Use PUSH operations to store outgoing parameters.  This method is shorter
15204 and usually equally fast as method using SUB/MOV operations and is enabled
15205 by default.  In some cases disabling it may improve performance because of
15206 improved scheduling and reduced dependencies.
15208 @item -maccumulate-outgoing-args
15209 @opindex maccumulate-outgoing-args
15210 If enabled, the maximum amount of space required for outgoing arguments is
15211 computed in the function prologue.  This is faster on most modern CPUs
15212 because of reduced dependencies, improved scheduling and reduced stack usage
15213 when the preferred stack boundary is not equal to 2.  The drawback is a notable
15214 increase in code size.  This switch implies @option{-mno-push-args}.
15216 @item -mthreads
15217 @opindex mthreads
15218 Support thread-safe exception handling on MinGW.  Programs that rely
15219 on thread-safe exception handling must compile and link all code with the
15220 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
15221 @code{-D_MT}; when linking, it links in a special thread helper library
15222 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
15224 @item -mno-align-stringops
15225 @opindex mno-align-stringops
15226 Do not align the destination of inlined string operations.  This switch reduces
15227 code size and improves performance in case the destination is already aligned,
15228 but GCC doesn't know about it.
15230 @item -minline-all-stringops
15231 @opindex minline-all-stringops
15232 By default GCC inlines string operations only when the destination is 
15233 known to be aligned to least a 4-byte boundary.  
15234 This enables more inlining and increases code
15235 size, but may improve performance of code that depends on fast
15236 @code{memcpy}, @code{strlen},
15237 and @code{memset} for short lengths.
15239 @item -minline-stringops-dynamically
15240 @opindex minline-stringops-dynamically
15241 For string operations of unknown size, use run-time checks with
15242 inline code for small blocks and a library call for large blocks.
15244 @item -mstringop-strategy=@var{alg}
15245 @opindex mstringop-strategy=@var{alg}
15246 Override the internal decision heuristic for the particular algorithm to use
15247 for inlining string operations.  The allowed values for @var{alg} are:
15249 @table @samp
15250 @item rep_byte
15251 @itemx rep_4byte
15252 @itemx rep_8byte
15253 Expand using i386 @code{rep} prefix of the specified size.
15255 @item byte_loop
15256 @itemx loop
15257 @itemx unrolled_loop
15258 Expand into an inline loop.
15260 @item libcall
15261 Always use a library call.
15262 @end table
15264 @item -mmemcpy-strategy=@var{strategy}
15265 @opindex mmemcpy-strategy=@var{strategy}
15266 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
15267 should be inlined and what inline algorithm to use when the expected size
15268 of the copy operation is known. @var{strategy} 
15269 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
15270 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
15271 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
15272 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
15273 in the list must be specified in increasing order.  The minimal byte size for 
15274 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
15275 preceding range.
15277 @item -mmemset-strategy=@var{strategy}
15278 @opindex mmemset-strategy=@var{strategy}
15279 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
15280 @code{__builtin_memset} expansion.
15282 @item -momit-leaf-frame-pointer
15283 @opindex momit-leaf-frame-pointer
15284 Don't keep the frame pointer in a register for leaf functions.  This
15285 avoids the instructions to save, set up, and restore frame pointers and
15286 makes an extra register available in leaf functions.  The option
15287 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
15288 which might make debugging harder.
15290 @item -mtls-direct-seg-refs
15291 @itemx -mno-tls-direct-seg-refs
15292 @opindex mtls-direct-seg-refs
15293 Controls whether TLS variables may be accessed with offsets from the
15294 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
15295 or whether the thread base pointer must be added.  Whether or not this
15296 is valid depends on the operating system, and whether it maps the
15297 segment to cover the entire TLS area.
15299 For systems that use the GNU C Library, the default is on.
15301 @item -msse2avx
15302 @itemx -mno-sse2avx
15303 @opindex msse2avx
15304 Specify that the assembler should encode SSE instructions with VEX
15305 prefix.  The option @option{-mavx} turns this on by default.
15307 @item -mfentry
15308 @itemx -mno-fentry
15309 @opindex mfentry
15310 If profiling is active (@option{-pg}), put the profiling
15311 counter call before the prologue.
15312 Note: On x86 architectures the attribute @code{ms_hook_prologue}
15313 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
15315 @item -m8bit-idiv
15316 @itemx -mno-8bit-idiv
15317 @opindex 8bit-idiv
15318 On some processors, like Intel Atom, 8-bit unsigned integer divide is
15319 much faster than 32-bit/64-bit integer divide.  This option generates a
15320 run-time check.  If both dividend and divisor are within range of 0
15321 to 255, 8-bit unsigned integer divide is used instead of
15322 32-bit/64-bit integer divide.
15324 @item -mavx256-split-unaligned-load
15325 @itemx -mavx256-split-unaligned-store
15326 @opindex avx256-split-unaligned-load
15327 @opindex avx256-split-unaligned-store
15328 Split 32-byte AVX unaligned load and store.
15330 @item -mstack-protector-guard=@var{guard}
15331 @opindex mstack-protector-guard=@var{guard}
15332 Generate stack protection code using canary at @var{guard}.  Supported
15333 locations are @samp{global} for global canary or @samp{tls} for per-thread
15334 canary in the TLS block (the default).  This option has effect only when
15335 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
15337 @end table
15339 These @samp{-m} switches are supported in addition to the above
15340 on x86-64 processors in 64-bit environments.
15342 @table @gcctabopt
15343 @item -m32
15344 @itemx -m64
15345 @itemx -mx32
15346 @opindex m32
15347 @opindex m64
15348 @opindex mx32
15349 Generate code for a 32-bit or 64-bit environment.
15350 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
15351 to 32 bits, and
15352 generates code that runs on any i386 system.
15354 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
15355 types to 64 bits, and generates code for the x86-64 architecture.
15356 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
15357 and @option{-mdynamic-no-pic} options.
15359 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
15360 to 32 bits, and
15361 generates code for the x86-64 architecture.
15363 @item -mno-red-zone
15364 @opindex mno-red-zone
15365 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
15366 by the x86-64 ABI; it is a 128-byte area beyond the location of the
15367 stack pointer that is not modified by signal or interrupt handlers
15368 and therefore can be used for temporary data without adjusting the stack
15369 pointer.  The flag @option{-mno-red-zone} disables this red zone.
15371 @item -mcmodel=small
15372 @opindex mcmodel=small
15373 Generate code for the small code model: the program and its symbols must
15374 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
15375 Programs can be statically or dynamically linked.  This is the default
15376 code model.
15378 @item -mcmodel=kernel
15379 @opindex mcmodel=kernel
15380 Generate code for the kernel code model.  The kernel runs in the
15381 negative 2 GB of the address space.
15382 This model has to be used for Linux kernel code.
15384 @item -mcmodel=medium
15385 @opindex mcmodel=medium
15386 Generate code for the medium model: the program is linked in the lower 2
15387 GB of the address space.  Small symbols are also placed there.  Symbols
15388 with sizes larger than @option{-mlarge-data-threshold} are put into
15389 large data or BSS sections and can be located above 2GB.  Programs can
15390 be statically or dynamically linked.
15392 @item -mcmodel=large
15393 @opindex mcmodel=large
15394 Generate code for the large model.  This model makes no assumptions
15395 about addresses and sizes of sections.
15397 @item -maddress-mode=long
15398 @opindex maddress-mode=long
15399 Generate code for long address mode.  This is only supported for 64-bit
15400 and x32 environments.  It is the default address mode for 64-bit
15401 environments.
15403 @item -maddress-mode=short
15404 @opindex maddress-mode=short
15405 Generate code for short address mode.  This is only supported for 32-bit
15406 and x32 environments.  It is the default address mode for 32-bit and
15407 x32 environments.
15408 @end table
15410 @node i386 and x86-64 Windows Options
15411 @subsection i386 and x86-64 Windows Options
15412 @cindex i386 and x86-64 Windows Options
15414 These additional options are available for Microsoft Windows targets:
15416 @table @gcctabopt
15417 @item -mconsole
15418 @opindex mconsole
15419 This option
15420 specifies that a console application is to be generated, by
15421 instructing the linker to set the PE header subsystem type
15422 required for console applications.
15423 This option is available for Cygwin and MinGW targets and is
15424 enabled by default on those targets.
15426 @item -mdll
15427 @opindex mdll
15428 This option is available for Cygwin and MinGW targets.  It
15429 specifies that a DLL---a dynamic link library---is to be
15430 generated, enabling the selection of the required runtime
15431 startup object and entry point.
15433 @item -mnop-fun-dllimport
15434 @opindex mnop-fun-dllimport
15435 This option is available for Cygwin and MinGW targets.  It
15436 specifies that the @code{dllimport} attribute should be ignored.
15438 @item -mthread
15439 @opindex mthread
15440 This option is available for MinGW targets. It specifies
15441 that MinGW-specific thread support is to be used.
15443 @item -municode
15444 @opindex municode
15445 This option is available for MinGW-w64 targets.  It causes
15446 the @code{UNICODE} preprocessor macro to be predefined, and
15447 chooses Unicode-capable runtime startup code.
15449 @item -mwin32
15450 @opindex mwin32
15451 This option is available for Cygwin and MinGW targets.  It
15452 specifies that the typical Microsoft Windows predefined macros are to
15453 be set in the pre-processor, but does not influence the choice
15454 of runtime library/startup code.
15456 @item -mwindows
15457 @opindex mwindows
15458 This option is available for Cygwin and MinGW targets.  It
15459 specifies that a GUI application is to be generated by
15460 instructing the linker to set the PE header subsystem type
15461 appropriately.
15463 @item -fno-set-stack-executable
15464 @opindex fno-set-stack-executable
15465 This option is available for MinGW targets. It specifies that
15466 the executable flag for the stack used by nested functions isn't
15467 set. This is necessary for binaries running in kernel mode of
15468 Microsoft Windows, as there the User32 API, which is used to set executable
15469 privileges, isn't available.
15471 @item -fwritable-relocated-rdata
15472 @opindex fno-writable-relocated-rdata
15473 This option is available for MinGW and Cygwin targets.  It specifies
15474 that relocated-data in read-only section is put into .data
15475 section.  This is a necessary for older runtimes not supporting
15476 modification of .rdata sections for pseudo-relocation.
15478 @item -mpe-aligned-commons
15479 @opindex mpe-aligned-commons
15480 This option is available for Cygwin and MinGW targets.  It
15481 specifies that the GNU extension to the PE file format that
15482 permits the correct alignment of COMMON variables should be
15483 used when generating code.  It is enabled by default if
15484 GCC detects that the target assembler found during configuration
15485 supports the feature.
15486 @end table
15488 See also under @ref{i386 and x86-64 Options} for standard options.
15490 @node IA-64 Options
15491 @subsection IA-64 Options
15492 @cindex IA-64 Options
15494 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15496 @table @gcctabopt
15497 @item -mbig-endian
15498 @opindex mbig-endian
15499 Generate code for a big-endian target.  This is the default for HP-UX@.
15501 @item -mlittle-endian
15502 @opindex mlittle-endian
15503 Generate code for a little-endian target.  This is the default for AIX5
15504 and GNU/Linux.
15506 @item -mgnu-as
15507 @itemx -mno-gnu-as
15508 @opindex mgnu-as
15509 @opindex mno-gnu-as
15510 Generate (or don't) code for the GNU assembler.  This is the default.
15511 @c Also, this is the default if the configure option @option{--with-gnu-as}
15512 @c is used.
15514 @item -mgnu-ld
15515 @itemx -mno-gnu-ld
15516 @opindex mgnu-ld
15517 @opindex mno-gnu-ld
15518 Generate (or don't) code for the GNU linker.  This is the default.
15519 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15520 @c is used.
15522 @item -mno-pic
15523 @opindex mno-pic
15524 Generate code that does not use a global pointer register.  The result
15525 is not position independent code, and violates the IA-64 ABI@.
15527 @item -mvolatile-asm-stop
15528 @itemx -mno-volatile-asm-stop
15529 @opindex mvolatile-asm-stop
15530 @opindex mno-volatile-asm-stop
15531 Generate (or don't) a stop bit immediately before and after volatile asm
15532 statements.
15534 @item -mregister-names
15535 @itemx -mno-register-names
15536 @opindex mregister-names
15537 @opindex mno-register-names
15538 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15539 the stacked registers.  This may make assembler output more readable.
15541 @item -mno-sdata
15542 @itemx -msdata
15543 @opindex mno-sdata
15544 @opindex msdata
15545 Disable (or enable) optimizations that use the small data section.  This may
15546 be useful for working around optimizer bugs.
15548 @item -mconstant-gp
15549 @opindex mconstant-gp
15550 Generate code that uses a single constant global pointer value.  This is
15551 useful when compiling kernel code.
15553 @item -mauto-pic
15554 @opindex mauto-pic
15555 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15556 This is useful when compiling firmware code.
15558 @item -minline-float-divide-min-latency
15559 @opindex minline-float-divide-min-latency
15560 Generate code for inline divides of floating-point values
15561 using the minimum latency algorithm.
15563 @item -minline-float-divide-max-throughput
15564 @opindex minline-float-divide-max-throughput
15565 Generate code for inline divides of floating-point values
15566 using the maximum throughput algorithm.
15568 @item -mno-inline-float-divide
15569 @opindex mno-inline-float-divide
15570 Do not generate inline code for divides of floating-point values.
15572 @item -minline-int-divide-min-latency
15573 @opindex minline-int-divide-min-latency
15574 Generate code for inline divides of integer values
15575 using the minimum latency algorithm.
15577 @item -minline-int-divide-max-throughput
15578 @opindex minline-int-divide-max-throughput
15579 Generate code for inline divides of integer values
15580 using the maximum throughput algorithm.
15582 @item -mno-inline-int-divide
15583 @opindex mno-inline-int-divide
15584 Do not generate inline code for divides of integer values.
15586 @item -minline-sqrt-min-latency
15587 @opindex minline-sqrt-min-latency
15588 Generate code for inline square roots
15589 using the minimum latency algorithm.
15591 @item -minline-sqrt-max-throughput
15592 @opindex minline-sqrt-max-throughput
15593 Generate code for inline square roots
15594 using the maximum throughput algorithm.
15596 @item -mno-inline-sqrt
15597 @opindex mno-inline-sqrt
15598 Do not generate inline code for @code{sqrt}.
15600 @item -mfused-madd
15601 @itemx -mno-fused-madd
15602 @opindex mfused-madd
15603 @opindex mno-fused-madd
15604 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
15605 instructions.  The default is to use these instructions.
15607 @item -mno-dwarf2-asm
15608 @itemx -mdwarf2-asm
15609 @opindex mno-dwarf2-asm
15610 @opindex mdwarf2-asm
15611 Don't (or do) generate assembler code for the DWARF 2 line number debugging
15612 info.  This may be useful when not using the GNU assembler.
15614 @item -mearly-stop-bits
15615 @itemx -mno-early-stop-bits
15616 @opindex mearly-stop-bits
15617 @opindex mno-early-stop-bits
15618 Allow stop bits to be placed earlier than immediately preceding the
15619 instruction that triggered the stop bit.  This can improve instruction
15620 scheduling, but does not always do so.
15622 @item -mfixed-range=@var{register-range}
15623 @opindex mfixed-range
15624 Generate code treating the given register range as fixed registers.
15625 A fixed register is one that the register allocator cannot use.  This is
15626 useful when compiling kernel code.  A register range is specified as
15627 two registers separated by a dash.  Multiple register ranges can be
15628 specified separated by a comma.
15630 @item -mtls-size=@var{tls-size}
15631 @opindex mtls-size
15632 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
15635 @item -mtune=@var{cpu-type}
15636 @opindex mtune
15637 Tune the instruction scheduling for a particular CPU, Valid values are
15638 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15639 and @samp{mckinley}.
15641 @item -milp32
15642 @itemx -mlp64
15643 @opindex milp32
15644 @opindex mlp64
15645 Generate code for a 32-bit or 64-bit environment.
15646 The 32-bit environment sets int, long and pointer to 32 bits.
15647 The 64-bit environment sets int to 32 bits and long and pointer
15648 to 64 bits.  These are HP-UX specific flags.
15650 @item -mno-sched-br-data-spec
15651 @itemx -msched-br-data-spec
15652 @opindex mno-sched-br-data-spec
15653 @opindex msched-br-data-spec
15654 (Dis/En)able data speculative scheduling before reload.
15655 This results in generation of @code{ld.a} instructions and
15656 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15657 The default is 'disable'.
15659 @item -msched-ar-data-spec
15660 @itemx -mno-sched-ar-data-spec
15661 @opindex msched-ar-data-spec
15662 @opindex mno-sched-ar-data-spec
15663 (En/Dis)able data speculative scheduling after reload.
15664 This results in generation of @code{ld.a} instructions and
15665 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
15666 The default is 'enable'.
15668 @item -mno-sched-control-spec
15669 @itemx -msched-control-spec
15670 @opindex mno-sched-control-spec
15671 @opindex msched-control-spec
15672 (Dis/En)able control speculative scheduling.  This feature is
15673 available only during region scheduling (i.e.@: before reload).
15674 This results in generation of the @code{ld.s} instructions and
15675 the corresponding check instructions @code{chk.s}.
15676 The default is 'disable'.
15678 @item -msched-br-in-data-spec
15679 @itemx -mno-sched-br-in-data-spec
15680 @opindex msched-br-in-data-spec
15681 @opindex mno-sched-br-in-data-spec
15682 (En/Dis)able speculative scheduling of the instructions that
15683 are dependent on the data speculative loads before reload.
15684 This is effective only with @option{-msched-br-data-spec} enabled.
15685 The default is 'enable'.
15687 @item -msched-ar-in-data-spec
15688 @itemx -mno-sched-ar-in-data-spec
15689 @opindex msched-ar-in-data-spec
15690 @opindex mno-sched-ar-in-data-spec
15691 (En/Dis)able speculative scheduling of the instructions that
15692 are dependent on the data speculative loads after reload.
15693 This is effective only with @option{-msched-ar-data-spec} enabled.
15694 The default is 'enable'.
15696 @item -msched-in-control-spec
15697 @itemx -mno-sched-in-control-spec
15698 @opindex msched-in-control-spec
15699 @opindex mno-sched-in-control-spec
15700 (En/Dis)able speculative scheduling of the instructions that
15701 are dependent on the control speculative loads.
15702 This is effective only with @option{-msched-control-spec} enabled.
15703 The default is 'enable'.
15705 @item -mno-sched-prefer-non-data-spec-insns
15706 @itemx -msched-prefer-non-data-spec-insns
15707 @opindex mno-sched-prefer-non-data-spec-insns
15708 @opindex msched-prefer-non-data-spec-insns
15709 If enabled, data-speculative instructions are chosen for schedule
15710 only if there are no other choices at the moment.  This makes
15711 the use of the data speculation much more conservative.
15712 The default is 'disable'.
15714 @item -mno-sched-prefer-non-control-spec-insns
15715 @itemx -msched-prefer-non-control-spec-insns
15716 @opindex mno-sched-prefer-non-control-spec-insns
15717 @opindex msched-prefer-non-control-spec-insns
15718 If enabled, control-speculative instructions are chosen for schedule
15719 only if there are no other choices at the moment.  This makes
15720 the use of the control speculation much more conservative.
15721 The default is 'disable'.
15723 @item -mno-sched-count-spec-in-critical-path
15724 @itemx -msched-count-spec-in-critical-path
15725 @opindex mno-sched-count-spec-in-critical-path
15726 @opindex msched-count-spec-in-critical-path
15727 If enabled, speculative dependencies are considered during
15728 computation of the instructions priorities.  This makes the use of the
15729 speculation a bit more conservative.
15730 The default is 'disable'.
15732 @item -msched-spec-ldc
15733 @opindex msched-spec-ldc
15734 Use a simple data speculation check.  This option is on by default.
15736 @item -msched-control-spec-ldc
15737 @opindex msched-spec-ldc
15738 Use a simple check for control speculation.  This option is on by default.
15740 @item -msched-stop-bits-after-every-cycle
15741 @opindex msched-stop-bits-after-every-cycle
15742 Place a stop bit after every cycle when scheduling.  This option is on
15743 by default.
15745 @item -msched-fp-mem-deps-zero-cost
15746 @opindex msched-fp-mem-deps-zero-cost
15747 Assume that floating-point stores and loads are not likely to cause a conflict
15748 when placed into the same instruction group.  This option is disabled by
15749 default.
15751 @item -msel-sched-dont-check-control-spec
15752 @opindex msel-sched-dont-check-control-spec
15753 Generate checks for control speculation in selective scheduling.
15754 This flag is disabled by default.
15756 @item -msched-max-memory-insns=@var{max-insns}
15757 @opindex msched-max-memory-insns
15758 Limit on the number of memory insns per instruction group, giving lower
15759 priority to subsequent memory insns attempting to schedule in the same
15760 instruction group. Frequently useful to prevent cache bank conflicts.
15761 The default value is 1.
15763 @item -msched-max-memory-insns-hard-limit
15764 @opindex msched-max-memory-insns-hard-limit
15765 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
15766 disallowing more than that number in an instruction group.
15767 Otherwise, the limit is ``soft'', meaning that non-memory operations
15768 are preferred when the limit is reached, but memory operations may still
15769 be scheduled.
15771 @end table
15773 @node LM32 Options
15774 @subsection LM32 Options
15775 @cindex LM32 options
15777 These @option{-m} options are defined for the LatticeMico32 architecture:
15779 @table @gcctabopt
15780 @item -mbarrel-shift-enabled
15781 @opindex mbarrel-shift-enabled
15782 Enable barrel-shift instructions.
15784 @item -mdivide-enabled
15785 @opindex mdivide-enabled
15786 Enable divide and modulus instructions.
15788 @item -mmultiply-enabled
15789 @opindex multiply-enabled
15790 Enable multiply instructions.
15792 @item -msign-extend-enabled
15793 @opindex msign-extend-enabled
15794 Enable sign extend instructions.
15796 @item -muser-enabled
15797 @opindex muser-enabled
15798 Enable user-defined instructions.
15800 @end table
15802 @node M32C Options
15803 @subsection M32C Options
15804 @cindex M32C options
15806 @table @gcctabopt
15807 @item -mcpu=@var{name}
15808 @opindex mcpu=
15809 Select the CPU for which code is generated.  @var{name} may be one of
15810 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
15811 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
15812 the M32C/80 series.
15814 @item -msim
15815 @opindex msim
15816 Specifies that the program will be run on the simulator.  This causes
15817 an alternate runtime library to be linked in which supports, for
15818 example, file I/O@.  You must not use this option when generating
15819 programs that will run on real hardware; you must provide your own
15820 runtime library for whatever I/O functions are needed.
15822 @item -memregs=@var{number}
15823 @opindex memregs=
15824 Specifies the number of memory-based pseudo-registers GCC uses
15825 during code generation.  These pseudo-registers are used like real
15826 registers, so there is a tradeoff between GCC's ability to fit the
15827 code into available registers, and the performance penalty of using
15828 memory instead of registers.  Note that all modules in a program must
15829 be compiled with the same value for this option.  Because of that, you
15830 must not use this option with GCC's default runtime libraries.
15832 @end table
15834 @node M32R/D Options
15835 @subsection M32R/D Options
15836 @cindex M32R/D options
15838 These @option{-m} options are defined for Renesas M32R/D architectures:
15840 @table @gcctabopt
15841 @item -m32r2
15842 @opindex m32r2
15843 Generate code for the M32R/2@.
15845 @item -m32rx
15846 @opindex m32rx
15847 Generate code for the M32R/X@.
15849 @item -m32r
15850 @opindex m32r
15851 Generate code for the M32R@.  This is the default.
15853 @item -mmodel=small
15854 @opindex mmodel=small
15855 Assume all objects live in the lower 16MB of memory (so that their addresses
15856 can be loaded with the @code{ld24} instruction), and assume all subroutines
15857 are reachable with the @code{bl} instruction.
15858 This is the default.
15860 The addressability of a particular object can be set with the
15861 @code{model} attribute.
15863 @item -mmodel=medium
15864 @opindex mmodel=medium
15865 Assume objects may be anywhere in the 32-bit address space (the compiler
15866 generates @code{seth/add3} instructions to load their addresses), and
15867 assume all subroutines are reachable with the @code{bl} instruction.
15869 @item -mmodel=large
15870 @opindex mmodel=large
15871 Assume objects may be anywhere in the 32-bit address space (the compiler
15872 generates @code{seth/add3} instructions to load their addresses), and
15873 assume subroutines may not be reachable with the @code{bl} instruction
15874 (the compiler generates the much slower @code{seth/add3/jl}
15875 instruction sequence).
15877 @item -msdata=none
15878 @opindex msdata=none
15879 Disable use of the small data area.  Variables are put into
15880 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
15881 @code{section} attribute has been specified).
15882 This is the default.
15884 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
15885 Objects may be explicitly put in the small data area with the
15886 @code{section} attribute using one of these sections.
15888 @item -msdata=sdata
15889 @opindex msdata=sdata
15890 Put small global and static data in the small data area, but do not
15891 generate special code to reference them.
15893 @item -msdata=use
15894 @opindex msdata=use
15895 Put small global and static data in the small data area, and generate
15896 special instructions to reference them.
15898 @item -G @var{num}
15899 @opindex G
15900 @cindex smaller data references
15901 Put global and static objects less than or equal to @var{num} bytes
15902 into the small data or BSS sections instead of the normal data or BSS
15903 sections.  The default value of @var{num} is 8.
15904 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
15905 for this option to have any effect.
15907 All modules should be compiled with the same @option{-G @var{num}} value.
15908 Compiling with different values of @var{num} may or may not work; if it
15909 doesn't the linker gives an error message---incorrect code is not
15910 generated.
15912 @item -mdebug
15913 @opindex mdebug
15914 Makes the M32R-specific code in the compiler display some statistics
15915 that might help in debugging programs.
15917 @item -malign-loops
15918 @opindex malign-loops
15919 Align all loops to a 32-byte boundary.
15921 @item -mno-align-loops
15922 @opindex mno-align-loops
15923 Do not enforce a 32-byte alignment for loops.  This is the default.
15925 @item -missue-rate=@var{number}
15926 @opindex missue-rate=@var{number}
15927 Issue @var{number} instructions per cycle.  @var{number} can only be 1
15928 or 2.
15930 @item -mbranch-cost=@var{number}
15931 @opindex mbranch-cost=@var{number}
15932 @var{number} can only be 1 or 2.  If it is 1 then branches are
15933 preferred over conditional code, if it is 2, then the opposite applies.
15935 @item -mflush-trap=@var{number}
15936 @opindex mflush-trap=@var{number}
15937 Specifies the trap number to use to flush the cache.  The default is
15938 12.  Valid numbers are between 0 and 15 inclusive.
15940 @item -mno-flush-trap
15941 @opindex mno-flush-trap
15942 Specifies that the cache cannot be flushed by using a trap.
15944 @item -mflush-func=@var{name}
15945 @opindex mflush-func=@var{name}
15946 Specifies the name of the operating system function to call to flush
15947 the cache.  The default is @emph{_flush_cache}, but a function call
15948 is only used if a trap is not available.
15950 @item -mno-flush-func
15951 @opindex mno-flush-func
15952 Indicates that there is no OS function for flushing the cache.
15954 @end table
15956 @node M680x0 Options
15957 @subsection M680x0 Options
15958 @cindex M680x0 options
15960 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
15961 The default settings depend on which architecture was selected when
15962 the compiler was configured; the defaults for the most common choices
15963 are given below.
15965 @table @gcctabopt
15966 @item -march=@var{arch}
15967 @opindex march
15968 Generate code for a specific M680x0 or ColdFire instruction set
15969 architecture.  Permissible values of @var{arch} for M680x0
15970 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
15971 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
15972 architectures are selected according to Freescale's ISA classification
15973 and the permissible values are: @samp{isaa}, @samp{isaaplus},
15974 @samp{isab} and @samp{isac}.
15976 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
15977 code for a ColdFire target.  The @var{arch} in this macro is one of the
15978 @option{-march} arguments given above.
15980 When used together, @option{-march} and @option{-mtune} select code
15981 that runs on a family of similar processors but that is optimized
15982 for a particular microarchitecture.
15984 @item -mcpu=@var{cpu}
15985 @opindex mcpu
15986 Generate code for a specific M680x0 or ColdFire processor.
15987 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
15988 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
15989 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
15990 below, which also classifies the CPUs into families:
15992 @multitable @columnfractions 0.20 0.80
15993 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
15994 @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}
15995 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
15996 @item @samp{5206e} @tab @samp{5206e}
15997 @item @samp{5208} @tab @samp{5207} @samp{5208}
15998 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
15999 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16000 @item @samp{5216} @tab @samp{5214} @samp{5216}
16001 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16002 @item @samp{5225} @tab @samp{5224} @samp{5225}
16003 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16004 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16005 @item @samp{5249} @tab @samp{5249}
16006 @item @samp{5250} @tab @samp{5250}
16007 @item @samp{5271} @tab @samp{5270} @samp{5271}
16008 @item @samp{5272} @tab @samp{5272}
16009 @item @samp{5275} @tab @samp{5274} @samp{5275}
16010 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16011 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16012 @item @samp{5307} @tab @samp{5307}
16013 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16014 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16015 @item @samp{5407} @tab @samp{5407}
16016 @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}
16017 @end multitable
16019 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16020 @var{arch} is compatible with @var{cpu}.  Other combinations of
16021 @option{-mcpu} and @option{-march} are rejected.
16023 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16024 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16025 where the value of @var{family} is given by the table above.
16027 @item -mtune=@var{tune}
16028 @opindex mtune
16029 Tune the code for a particular microarchitecture within the
16030 constraints set by @option{-march} and @option{-mcpu}.
16031 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16032 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16033 and @samp{cpu32}.  The ColdFire microarchitectures
16034 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16036 You can also use @option{-mtune=68020-40} for code that needs
16037 to run relatively well on 68020, 68030 and 68040 targets.
16038 @option{-mtune=68020-60} is similar but includes 68060 targets
16039 as well.  These two options select the same tuning decisions as
16040 @option{-m68020-40} and @option{-m68020-60} respectively.
16042 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16043 when tuning for 680x0 architecture @var{arch}.  It also defines
16044 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16045 option is used.  If GCC is tuning for a range of architectures,
16046 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16047 it defines the macros for every architecture in the range.
16049 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16050 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16051 of the arguments given above.
16053 @item -m68000
16054 @itemx -mc68000
16055 @opindex m68000
16056 @opindex mc68000
16057 Generate output for a 68000.  This is the default
16058 when the compiler is configured for 68000-based systems.
16059 It is equivalent to @option{-march=68000}.
16061 Use this option for microcontrollers with a 68000 or EC000 core,
16062 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16064 @item -m68010
16065 @opindex m68010
16066 Generate output for a 68010.  This is the default
16067 when the compiler is configured for 68010-based systems.
16068 It is equivalent to @option{-march=68010}.
16070 @item -m68020
16071 @itemx -mc68020
16072 @opindex m68020
16073 @opindex mc68020
16074 Generate output for a 68020.  This is the default
16075 when the compiler is configured for 68020-based systems.
16076 It is equivalent to @option{-march=68020}.
16078 @item -m68030
16079 @opindex m68030
16080 Generate output for a 68030.  This is the default when the compiler is
16081 configured for 68030-based systems.  It is equivalent to
16082 @option{-march=68030}.
16084 @item -m68040
16085 @opindex m68040
16086 Generate output for a 68040.  This is the default when the compiler is
16087 configured for 68040-based systems.  It is equivalent to
16088 @option{-march=68040}.
16090 This option inhibits the use of 68881/68882 instructions that have to be
16091 emulated by software on the 68040.  Use this option if your 68040 does not
16092 have code to emulate those instructions.
16094 @item -m68060
16095 @opindex m68060
16096 Generate output for a 68060.  This is the default when the compiler is
16097 configured for 68060-based systems.  It is equivalent to
16098 @option{-march=68060}.
16100 This option inhibits the use of 68020 and 68881/68882 instructions that
16101 have to be emulated by software on the 68060.  Use this option if your 68060
16102 does not have code to emulate those instructions.
16104 @item -mcpu32
16105 @opindex mcpu32
16106 Generate output for a CPU32.  This is the default
16107 when the compiler is configured for CPU32-based systems.
16108 It is equivalent to @option{-march=cpu32}.
16110 Use this option for microcontrollers with a
16111 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16112 68336, 68340, 68341, 68349 and 68360.
16114 @item -m5200
16115 @opindex m5200
16116 Generate output for a 520X ColdFire CPU@.  This is the default
16117 when the compiler is configured for 520X-based systems.
16118 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16119 in favor of that option.
16121 Use this option for microcontroller with a 5200 core, including
16122 the MCF5202, MCF5203, MCF5204 and MCF5206.
16124 @item -m5206e
16125 @opindex m5206e
16126 Generate output for a 5206e ColdFire CPU@.  The option is now
16127 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16129 @item -m528x
16130 @opindex m528x
16131 Generate output for a member of the ColdFire 528X family.
16132 The option is now deprecated in favor of the equivalent
16133 @option{-mcpu=528x}.
16135 @item -m5307
16136 @opindex m5307
16137 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16138 in favor of the equivalent @option{-mcpu=5307}.
16140 @item -m5407
16141 @opindex m5407
16142 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16143 in favor of the equivalent @option{-mcpu=5407}.
16145 @item -mcfv4e
16146 @opindex mcfv4e
16147 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16148 This includes use of hardware floating-point instructions.
16149 The option is equivalent to @option{-mcpu=547x}, and is now
16150 deprecated in favor of that option.
16152 @item -m68020-40
16153 @opindex m68020-40
16154 Generate output for a 68040, without using any of the new instructions.
16155 This results in code that can run relatively efficiently on either a
16156 68020/68881 or a 68030 or a 68040.  The generated code does use the
16157 68881 instructions that are emulated on the 68040.
16159 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16161 @item -m68020-60
16162 @opindex m68020-60
16163 Generate output for a 68060, without using any of the new instructions.
16164 This results in code that can run relatively efficiently on either a
16165 68020/68881 or a 68030 or a 68040.  The generated code does use the
16166 68881 instructions that are emulated on the 68060.
16168 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16170 @item -mhard-float
16171 @itemx -m68881
16172 @opindex mhard-float
16173 @opindex m68881
16174 Generate floating-point instructions.  This is the default for 68020
16175 and above, and for ColdFire devices that have an FPU@.  It defines the
16176 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
16177 on ColdFire targets.
16179 @item -msoft-float
16180 @opindex msoft-float
16181 Do not generate floating-point instructions; use library calls instead.
16182 This is the default for 68000, 68010, and 68832 targets.  It is also
16183 the default for ColdFire devices that have no FPU.
16185 @item -mdiv
16186 @itemx -mno-div
16187 @opindex mdiv
16188 @opindex mno-div
16189 Generate (do not generate) ColdFire hardware divide and remainder
16190 instructions.  If @option{-march} is used without @option{-mcpu},
16191 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16192 architectures.  Otherwise, the default is taken from the target CPU
16193 (either the default CPU, or the one specified by @option{-mcpu}).  For
16194 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16195 @option{-mcpu=5206e}.
16197 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
16199 @item -mshort
16200 @opindex mshort
16201 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16202 Additionally, parameters passed on the stack are also aligned to a
16203 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16205 @item -mno-short
16206 @opindex mno-short
16207 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16209 @item -mnobitfield
16210 @itemx -mno-bitfield
16211 @opindex mnobitfield
16212 @opindex mno-bitfield
16213 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16214 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16216 @item -mbitfield
16217 @opindex mbitfield
16218 Do use the bit-field instructions.  The @option{-m68020} option implies
16219 @option{-mbitfield}.  This is the default if you use a configuration
16220 designed for a 68020.
16222 @item -mrtd
16223 @opindex mrtd
16224 Use a different function-calling convention, in which functions
16225 that take a fixed number of arguments return with the @code{rtd}
16226 instruction, which pops their arguments while returning.  This
16227 saves one instruction in the caller since there is no need to pop
16228 the arguments there.
16230 This calling convention is incompatible with the one normally
16231 used on Unix, so you cannot use it if you need to call libraries
16232 compiled with the Unix compiler.
16234 Also, you must provide function prototypes for all functions that
16235 take variable numbers of arguments (including @code{printf});
16236 otherwise incorrect code is generated for calls to those
16237 functions.
16239 In addition, seriously incorrect code results if you call a
16240 function with too many arguments.  (Normally, extra arguments are
16241 harmlessly ignored.)
16243 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16244 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16246 @item -mno-rtd
16247 @opindex mno-rtd
16248 Do not use the calling conventions selected by @option{-mrtd}.
16249 This is the default.
16251 @item -malign-int
16252 @itemx -mno-align-int
16253 @opindex malign-int
16254 @opindex mno-align-int
16255 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16256 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16257 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16258 Aligning variables on 32-bit boundaries produces code that runs somewhat
16259 faster on processors with 32-bit busses at the expense of more memory.
16261 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16262 aligns structures containing the above types differently than
16263 most published application binary interface specifications for the m68k.
16265 @item -mpcrel
16266 @opindex mpcrel
16267 Use the pc-relative addressing mode of the 68000 directly, instead of
16268 using a global offset table.  At present, this option implies @option{-fpic},
16269 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16270 not presently supported with @option{-mpcrel}, though this could be supported for
16271 68020 and higher processors.
16273 @item -mno-strict-align
16274 @itemx -mstrict-align
16275 @opindex mno-strict-align
16276 @opindex mstrict-align
16277 Do not (do) assume that unaligned memory references are handled by
16278 the system.
16280 @item -msep-data
16281 Generate code that allows the data segment to be located in a different
16282 area of memory from the text segment.  This allows for execute-in-place in
16283 an environment without virtual memory management.  This option implies
16284 @option{-fPIC}.
16286 @item -mno-sep-data
16287 Generate code that assumes that the data segment follows the text segment.
16288 This is the default.
16290 @item -mid-shared-library
16291 Generate code that supports shared libraries via the library ID method.
16292 This allows for execute-in-place and shared libraries in an environment
16293 without virtual memory management.  This option implies @option{-fPIC}.
16295 @item -mno-id-shared-library
16296 Generate code that doesn't assume ID-based shared libraries are being used.
16297 This is the default.
16299 @item -mshared-library-id=n
16300 Specifies the identification number of the ID-based shared library being
16301 compiled.  Specifying a value of 0 generates more compact code; specifying
16302 other values forces the allocation of that number to the current
16303 library, but is no more space- or time-efficient than omitting this option.
16305 @item -mxgot
16306 @itemx -mno-xgot
16307 @opindex mxgot
16308 @opindex mno-xgot
16309 When generating position-independent code for ColdFire, generate code
16310 that works if the GOT has more than 8192 entries.  This code is
16311 larger and slower than code generated without this option.  On M680x0
16312 processors, this option is not needed; @option{-fPIC} suffices.
16314 GCC normally uses a single instruction to load values from the GOT@.
16315 While this is relatively efficient, it only works if the GOT
16316 is smaller than about 64k.  Anything larger causes the linker
16317 to report an error such as:
16319 @cindex relocation truncated to fit (ColdFire)
16320 @smallexample
16321 relocation truncated to fit: R_68K_GOT16O foobar
16322 @end smallexample
16324 If this happens, you should recompile your code with @option{-mxgot}.
16325 It should then work with very large GOTs.  However, code generated with
16326 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16327 the value of a global symbol.
16329 Note that some linkers, including newer versions of the GNU linker,
16330 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16331 you should only need to use @option{-mxgot} when compiling a single
16332 object file that accesses more than 8192 GOT entries.  Very few do.
16334 These options have no effect unless GCC is generating
16335 position-independent code.
16337 @end table
16339 @node MCore Options
16340 @subsection MCore Options
16341 @cindex MCore options
16343 These are the @samp{-m} options defined for the Motorola M*Core
16344 processors.
16346 @table @gcctabopt
16348 @item -mhardlit
16349 @itemx -mno-hardlit
16350 @opindex mhardlit
16351 @opindex mno-hardlit
16352 Inline constants into the code stream if it can be done in two
16353 instructions or less.
16355 @item -mdiv
16356 @itemx -mno-div
16357 @opindex mdiv
16358 @opindex mno-div
16359 Use the divide instruction.  (Enabled by default).
16361 @item -mrelax-immediate
16362 @itemx -mno-relax-immediate
16363 @opindex mrelax-immediate
16364 @opindex mno-relax-immediate
16365 Allow arbitrary-sized immediates in bit operations.
16367 @item -mwide-bitfields
16368 @itemx -mno-wide-bitfields
16369 @opindex mwide-bitfields
16370 @opindex mno-wide-bitfields
16371 Always treat bit-fields as @code{int}-sized.
16373 @item -m4byte-functions
16374 @itemx -mno-4byte-functions
16375 @opindex m4byte-functions
16376 @opindex mno-4byte-functions
16377 Force all functions to be aligned to a 4-byte boundary.
16379 @item -mcallgraph-data
16380 @itemx -mno-callgraph-data
16381 @opindex mcallgraph-data
16382 @opindex mno-callgraph-data
16383 Emit callgraph information.
16385 @item -mslow-bytes
16386 @itemx -mno-slow-bytes
16387 @opindex mslow-bytes
16388 @opindex mno-slow-bytes
16389 Prefer word access when reading byte quantities.
16391 @item -mlittle-endian
16392 @itemx -mbig-endian
16393 @opindex mlittle-endian
16394 @opindex mbig-endian
16395 Generate code for a little-endian target.
16397 @item -m210
16398 @itemx -m340
16399 @opindex m210
16400 @opindex m340
16401 Generate code for the 210 processor.
16403 @item -mno-lsim
16404 @opindex mno-lsim
16405 Assume that runtime support has been provided and so omit the
16406 simulator library (@file{libsim.a)} from the linker command line.
16408 @item -mstack-increment=@var{size}
16409 @opindex mstack-increment
16410 Set the maximum amount for a single stack increment operation.  Large
16411 values can increase the speed of programs that contain functions
16412 that need a large amount of stack space, but they can also trigger a
16413 segmentation fault if the stack is extended too much.  The default
16414 value is 0x1000.
16416 @end table
16418 @node MeP Options
16419 @subsection MeP Options
16420 @cindex MeP options
16422 @table @gcctabopt
16424 @item -mabsdiff
16425 @opindex mabsdiff
16426 Enables the @code{abs} instruction, which is the absolute difference
16427 between two registers.
16429 @item -mall-opts
16430 @opindex mall-opts
16431 Enables all the optional instructions---average, multiply, divide, bit
16432 operations, leading zero, absolute difference, min/max, clip, and
16433 saturation.
16436 @item -maverage
16437 @opindex maverage
16438 Enables the @code{ave} instruction, which computes the average of two
16439 registers.
16441 @item -mbased=@var{n}
16442 @opindex mbased=
16443 Variables of size @var{n} bytes or smaller are placed in the
16444 @code{.based} section by default.  Based variables use the @code{$tp}
16445 register as a base register, and there is a 128-byte limit to the
16446 @code{.based} section.
16448 @item -mbitops
16449 @opindex mbitops
16450 Enables the bit operation instructions---bit test (@code{btstm}), set
16451 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16452 test-and-set (@code{tas}).
16454 @item -mc=@var{name}
16455 @opindex mc=
16456 Selects which section constant data is placed in.  @var{name} may
16457 be @code{tiny}, @code{near}, or @code{far}.
16459 @item -mclip
16460 @opindex mclip
16461 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
16462 useful unless you also provide @code{-mminmax}.
16464 @item -mconfig=@var{name}
16465 @opindex mconfig=
16466 Selects one of the built-in core configurations.  Each MeP chip has
16467 one or more modules in it; each module has a core CPU and a variety of
16468 coprocessors, optional instructions, and peripherals.  The
16469 @code{MeP-Integrator} tool, not part of GCC, provides these
16470 configurations through this option; using this option is the same as
16471 using all the corresponding command-line options.  The default
16472 configuration is @code{default}.
16474 @item -mcop
16475 @opindex mcop
16476 Enables the coprocessor instructions.  By default, this is a 32-bit
16477 coprocessor.  Note that the coprocessor is normally enabled via the
16478 @code{-mconfig=} option.
16480 @item -mcop32
16481 @opindex mcop32
16482 Enables the 32-bit coprocessor's instructions.
16484 @item -mcop64
16485 @opindex mcop64
16486 Enables the 64-bit coprocessor's instructions.
16488 @item -mivc2
16489 @opindex mivc2
16490 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16492 @item -mdc
16493 @opindex mdc
16494 Causes constant variables to be placed in the @code{.near} section.
16496 @item -mdiv
16497 @opindex mdiv
16498 Enables the @code{div} and @code{divu} instructions.
16500 @item -meb
16501 @opindex meb
16502 Generate big-endian code.
16504 @item -mel
16505 @opindex mel
16506 Generate little-endian code.
16508 @item -mio-volatile
16509 @opindex mio-volatile
16510 Tells the compiler that any variable marked with the @code{io}
16511 attribute is to be considered volatile.
16513 @item -ml
16514 @opindex ml
16515 Causes variables to be assigned to the @code{.far} section by default.
16517 @item -mleadz
16518 @opindex mleadz
16519 Enables the @code{leadz} (leading zero) instruction.
16521 @item -mm
16522 @opindex mm
16523 Causes variables to be assigned to the @code{.near} section by default.
16525 @item -mminmax
16526 @opindex mminmax
16527 Enables the @code{min} and @code{max} instructions.
16529 @item -mmult
16530 @opindex mmult
16531 Enables the multiplication and multiply-accumulate instructions.
16533 @item -mno-opts
16534 @opindex mno-opts
16535 Disables all the optional instructions enabled by @code{-mall-opts}.
16537 @item -mrepeat
16538 @opindex mrepeat
16539 Enables the @code{repeat} and @code{erepeat} instructions, used for
16540 low-overhead looping.
16542 @item -ms
16543 @opindex ms
16544 Causes all variables to default to the @code{.tiny} section.  Note
16545 that there is a 65536-byte limit to this section.  Accesses to these
16546 variables use the @code{%gp} base register.
16548 @item -msatur
16549 @opindex msatur
16550 Enables the saturation instructions.  Note that the compiler does not
16551 currently generate these itself, but this option is included for
16552 compatibility with other tools, like @code{as}.
16554 @item -msdram
16555 @opindex msdram
16556 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16558 @item -msim
16559 @opindex msim
16560 Link the simulator run-time libraries.
16562 @item -msimnovec
16563 @opindex msimnovec
16564 Link the simulator runtime libraries, excluding built-in support
16565 for reset and exception vectors and tables.
16567 @item -mtf
16568 @opindex mtf
16569 Causes all functions to default to the @code{.far} section.  Without
16570 this option, functions default to the @code{.near} section.
16572 @item -mtiny=@var{n}
16573 @opindex mtiny=
16574 Variables that are @var{n} bytes or smaller are allocated to the
16575 @code{.tiny} section.  These variables use the @code{$gp} base
16576 register.  The default for this option is 4, but note that there's a
16577 65536-byte limit to the @code{.tiny} section.
16579 @end table
16581 @node MicroBlaze Options
16582 @subsection MicroBlaze Options
16583 @cindex MicroBlaze Options
16585 @table @gcctabopt
16587 @item -msoft-float
16588 @opindex msoft-float
16589 Use software emulation for floating point (default).
16591 @item -mhard-float
16592 @opindex mhard-float
16593 Use hardware floating-point instructions.
16595 @item -mmemcpy
16596 @opindex mmemcpy
16597 Do not optimize block moves, use @code{memcpy}.
16599 @item -mno-clearbss
16600 @opindex mno-clearbss
16601 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
16603 @item -mcpu=@var{cpu-type}
16604 @opindex mcpu=
16605 Use features of, and schedule code for, the given CPU.
16606 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
16607 where @var{X} is a major version, @var{YY} is the minor version, and
16608 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
16609 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
16611 @item -mxl-soft-mul
16612 @opindex mxl-soft-mul
16613 Use software multiply emulation (default).
16615 @item -mxl-soft-div
16616 @opindex mxl-soft-div
16617 Use software emulation for divides (default).
16619 @item -mxl-barrel-shift
16620 @opindex mxl-barrel-shift
16621 Use the hardware barrel shifter.
16623 @item -mxl-pattern-compare
16624 @opindex mxl-pattern-compare
16625 Use pattern compare instructions.
16627 @item -msmall-divides
16628 @opindex msmall-divides
16629 Use table lookup optimization for small signed integer divisions.
16631 @item -mxl-stack-check
16632 @opindex mxl-stack-check
16633 This option is deprecated.  Use @option{-fstack-check} instead.
16635 @item -mxl-gp-opt
16636 @opindex mxl-gp-opt
16637 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16639 @item -mxl-multiply-high
16640 @opindex mxl-multiply-high
16641 Use multiply high instructions for high part of 32x32 multiply.
16643 @item -mxl-float-convert
16644 @opindex mxl-float-convert
16645 Use hardware floating-point conversion instructions.
16647 @item -mxl-float-sqrt
16648 @opindex mxl-float-sqrt
16649 Use hardware floating-point square root instruction.
16651 @item -mbig-endian
16652 @opindex mbig-endian
16653 Generate code for a big-endian target.
16655 @item -mlittle-endian
16656 @opindex mlittle-endian
16657 Generate code for a little-endian target.
16659 @item -mxl-reorder
16660 @opindex mxl-reorder
16661 Use reorder instructions (swap and byte reversed load/store).
16663 @item -mxl-mode-@var{app-model}
16664 Select application model @var{app-model}.  Valid models are
16665 @table @samp
16666 @item executable
16667 normal executable (default), uses startup code @file{crt0.o}.
16669 @item xmdstub
16670 for use with Xilinx Microprocessor Debugger (XMD) based
16671 software intrusive debug agent called xmdstub. This uses startup file
16672 @file{crt1.o} and sets the start address of the program to 0x800.
16674 @item bootstrap
16675 for applications that are loaded using a bootloader.
16676 This model uses startup file @file{crt2.o} which does not contain a processor
16677 reset vector handler. This is suitable for transferring control on a
16678 processor reset to the bootloader rather than the application.
16680 @item novectors
16681 for applications that do not require any of the
16682 MicroBlaze vectors. This option may be useful for applications running
16683 within a monitoring application. This model uses @file{crt3.o} as a startup file.
16684 @end table
16686 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
16687 @option{-mxl-mode-@var{app-model}}.
16689 @end table
16691 @node MIPS Options
16692 @subsection MIPS Options
16693 @cindex MIPS options
16695 @table @gcctabopt
16697 @item -EB
16698 @opindex EB
16699 Generate big-endian code.
16701 @item -EL
16702 @opindex EL
16703 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
16704 configurations.
16706 @item -march=@var{arch}
16707 @opindex march
16708 Generate code that runs on @var{arch}, which can be the name of a
16709 generic MIPS ISA, or the name of a particular processor.
16710 The ISA names are:
16711 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
16712 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
16713 The processor names are:
16714 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
16715 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
16716 @samp{5kc}, @samp{5kf},
16717 @samp{20kc},
16718 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
16719 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
16720 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
16721 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
16722 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
16723 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
16724 @samp{m4k},
16725 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
16726 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
16727 @samp{orion},
16728 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
16729 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
16730 @samp{rm7000}, @samp{rm9000},
16731 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
16732 @samp{sb1},
16733 @samp{sr71000},
16734 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
16735 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
16736 @samp{xlr} and @samp{xlp}.
16737 The special value @samp{from-abi} selects the
16738 most compatible architecture for the selected ABI (that is,
16739 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
16741 The native Linux/GNU toolchain also supports the value @samp{native},
16742 which selects the best architecture option for the host processor.
16743 @option{-march=native} has no effect if GCC does not recognize
16744 the processor.
16746 In processor names, a final @samp{000} can be abbreviated as @samp{k}
16747 (for example, @option{-march=r2k}).  Prefixes are optional, and
16748 @samp{vr} may be written @samp{r}.
16750 Names of the form @samp{@var{n}f2_1} refer to processors with
16751 FPUs clocked at half the rate of the core, names of the form
16752 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
16753 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
16754 processors with FPUs clocked a ratio of 3:2 with respect to the core.
16755 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
16756 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
16757 accepted as synonyms for @samp{@var{n}f1_1}.
16759 GCC defines two macros based on the value of this option.  The first
16760 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
16761 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
16762 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
16763 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
16764 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
16766 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
16767 above.  In other words, it has the full prefix and does not
16768 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
16769 the macro names the resolved architecture (either @samp{"mips1"} or
16770 @samp{"mips3"}).  It names the default architecture when no
16771 @option{-march} option is given.
16773 @item -mtune=@var{arch}
16774 @opindex mtune
16775 Optimize for @var{arch}.  Among other things, this option controls
16776 the way instructions are scheduled, and the perceived cost of arithmetic
16777 operations.  The list of @var{arch} values is the same as for
16778 @option{-march}.
16780 When this option is not used, GCC optimizes for the processor
16781 specified by @option{-march}.  By using @option{-march} and
16782 @option{-mtune} together, it is possible to generate code that
16783 runs on a family of processors, but optimize the code for one
16784 particular member of that family.
16786 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
16787 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
16788 @option{-march} ones described above.
16790 @item -mips1
16791 @opindex mips1
16792 Equivalent to @option{-march=mips1}.
16794 @item -mips2
16795 @opindex mips2
16796 Equivalent to @option{-march=mips2}.
16798 @item -mips3
16799 @opindex mips3
16800 Equivalent to @option{-march=mips3}.
16802 @item -mips4
16803 @opindex mips4
16804 Equivalent to @option{-march=mips4}.
16806 @item -mips32
16807 @opindex mips32
16808 Equivalent to @option{-march=mips32}.
16810 @item -mips32r2
16811 @opindex mips32r2
16812 Equivalent to @option{-march=mips32r2}.
16814 @item -mips64
16815 @opindex mips64
16816 Equivalent to @option{-march=mips64}.
16818 @item -mips64r2
16819 @opindex mips64r2
16820 Equivalent to @option{-march=mips64r2}.
16822 @item -mips16
16823 @itemx -mno-mips16
16824 @opindex mips16
16825 @opindex mno-mips16
16826 Generate (do not generate) MIPS16 code.  If GCC is targeting a
16827 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
16829 MIPS16 code generation can also be controlled on a per-function basis
16830 by means of @code{mips16} and @code{nomips16} attributes.
16831 @xref{Function Attributes}, for more information.
16833 @item -mflip-mips16
16834 @opindex mflip-mips16
16835 Generate MIPS16 code on alternating functions.  This option is provided
16836 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
16837 not intended for ordinary use in compiling user code.
16839 @item -minterlink-compressed
16840 @item -mno-interlink-compressed
16841 @opindex minterlink-compressed
16842 @opindex mno-interlink-compressed
16843 Require (do not require) that code using the standard (uncompressed) MIPS ISA
16844 be link-compatible with MIPS16 and microMIPS code, and vice versa.
16846 For example, code using the standard ISA encoding cannot jump directly
16847 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
16848 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
16849 knows that the target of the jump is not compressed.
16851 @item -minterlink-mips16
16852 @itemx -mno-interlink-mips16
16853 @opindex minterlink-mips16
16854 @opindex mno-interlink-mips16
16855 Aliases of @option{-minterlink-compressed} and
16856 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
16857 and are retained for backwards compatibility.
16859 @item -mabi=32
16860 @itemx -mabi=o64
16861 @itemx -mabi=n32
16862 @itemx -mabi=64
16863 @itemx -mabi=eabi
16864 @opindex mabi=32
16865 @opindex mabi=o64
16866 @opindex mabi=n32
16867 @opindex mabi=64
16868 @opindex mabi=eabi
16869 Generate code for the given ABI@.
16871 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
16872 generates 64-bit code when you select a 64-bit architecture, but you
16873 can use @option{-mgp32} to get 32-bit code instead.
16875 For information about the O64 ABI, see
16876 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
16878 GCC supports a variant of the o32 ABI in which floating-point registers
16879 are 64 rather than 32 bits wide.  You can select this combination with
16880 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
16881 and @code{mfhc1} instructions and is therefore only supported for
16882 MIPS32R2 processors.
16884 The register assignments for arguments and return values remain the
16885 same, but each scalar value is passed in a single 64-bit register
16886 rather than a pair of 32-bit registers.  For example, scalar
16887 floating-point values are returned in @samp{$f0} only, not a
16888 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
16889 remains the same, but all 64 bits are saved.
16891 @item -mabicalls
16892 @itemx -mno-abicalls
16893 @opindex mabicalls
16894 @opindex mno-abicalls
16895 Generate (do not generate) code that is suitable for SVR4-style
16896 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
16897 systems.
16899 @item -mshared
16900 @itemx -mno-shared
16901 Generate (do not generate) code that is fully position-independent,
16902 and that can therefore be linked into shared libraries.  This option
16903 only affects @option{-mabicalls}.
16905 All @option{-mabicalls} code has traditionally been position-independent,
16906 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
16907 as an extension, the GNU toolchain allows executables to use absolute
16908 accesses for locally-binding symbols.  It can also use shorter GP
16909 initialization sequences and generate direct calls to locally-defined
16910 functions.  This mode is selected by @option{-mno-shared}.
16912 @option{-mno-shared} depends on binutils 2.16 or higher and generates
16913 objects that can only be linked by the GNU linker.  However, the option
16914 does not affect the ABI of the final executable; it only affects the ABI
16915 of relocatable objects.  Using @option{-mno-shared} generally makes
16916 executables both smaller and quicker.
16918 @option{-mshared} is the default.
16920 @item -mplt
16921 @itemx -mno-plt
16922 @opindex mplt
16923 @opindex mno-plt
16924 Assume (do not assume) that the static and dynamic linkers
16925 support PLTs and copy relocations.  This option only affects
16926 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
16927 has no effect without @option{-msym32}.
16929 You can make @option{-mplt} the default by configuring
16930 GCC with @option{--with-mips-plt}.  The default is
16931 @option{-mno-plt} otherwise.
16933 @item -mxgot
16934 @itemx -mno-xgot
16935 @opindex mxgot
16936 @opindex mno-xgot
16937 Lift (do not lift) the usual restrictions on the size of the global
16938 offset table.
16940 GCC normally uses a single instruction to load values from the GOT@.
16941 While this is relatively efficient, it only works if the GOT
16942 is smaller than about 64k.  Anything larger causes the linker
16943 to report an error such as:
16945 @cindex relocation truncated to fit (MIPS)
16946 @smallexample
16947 relocation truncated to fit: R_MIPS_GOT16 foobar
16948 @end smallexample
16950 If this happens, you should recompile your code with @option{-mxgot}.
16951 This works with very large GOTs, although the code is also
16952 less efficient, since it takes three instructions to fetch the
16953 value of a global symbol.
16955 Note that some linkers can create multiple GOTs.  If you have such a
16956 linker, you should only need to use @option{-mxgot} when a single object
16957 file accesses more than 64k's worth of GOT entries.  Very few do.
16959 These options have no effect unless GCC is generating position
16960 independent code.
16962 @item -mgp32
16963 @opindex mgp32
16964 Assume that general-purpose registers are 32 bits wide.
16966 @item -mgp64
16967 @opindex mgp64
16968 Assume that general-purpose registers are 64 bits wide.
16970 @item -mfp32
16971 @opindex mfp32
16972 Assume that floating-point registers are 32 bits wide.
16974 @item -mfp64
16975 @opindex mfp64
16976 Assume that floating-point registers are 64 bits wide.
16978 @item -mhard-float
16979 @opindex mhard-float
16980 Use floating-point coprocessor instructions.
16982 @item -msoft-float
16983 @opindex msoft-float
16984 Do not use floating-point coprocessor instructions.  Implement
16985 floating-point calculations using library calls instead.
16987 @item -mno-float
16988 @opindex mno-float
16989 Equivalent to @option{-msoft-float}, but additionally asserts that the
16990 program being compiled does not perform any floating-point operations.
16991 This option is presently supported only by some bare-metal MIPS
16992 configurations, where it may select a special set of libraries
16993 that lack all floating-point support (including, for example, the
16994 floating-point @code{printf} formats).  
16995 If code compiled with @code{-mno-float} accidentally contains
16996 floating-point operations, it is likely to suffer a link-time
16997 or run-time failure.
16999 @item -msingle-float
17000 @opindex msingle-float
17001 Assume that the floating-point coprocessor only supports single-precision
17002 operations.
17004 @item -mdouble-float
17005 @opindex mdouble-float
17006 Assume that the floating-point coprocessor supports double-precision
17007 operations.  This is the default.
17009 @item -mabs=2008
17010 @itemx -mabs=legacy
17011 @opindex mabs=2008
17012 @opindex mabs=legacy
17013 These options control the treatment of the special not-a-number (NaN)
17014 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17015 @code{neg.@i{fmt}} machine instructions.
17017 By default or when the @option{-mabs=legacy} is used the legacy
17018 treatment is selected.  In this case these instructions are considered
17019 arithmetic and avoided where correct operation is required and the
17020 input operand might be a NaN.  A longer sequence of instructions that
17021 manipulate the sign bit of floating-point datum manually is used
17022 instead unless the @option{-ffinite-math-only} option has also been
17023 specified.
17025 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17026 this case these instructions are considered non-arithmetic and therefore
17027 operating correctly in all cases, including in particular where the
17028 input operand is a NaN.  These instructions are therefore always used
17029 for the respective operations.
17031 @item -mnan=2008
17032 @itemx -mnan=legacy
17033 @opindex mnan=2008
17034 @opindex mnan=legacy
17035 These options control the encoding of the special not-a-number (NaN)
17036 IEEE 754 floating-point data.
17038 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17039 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17040 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17041 by the first bit of their trailing significand field being 1.
17043 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17044 this case qNaNs are denoted by the first bit of their trailing
17045 significand field being 1, whereas sNaNs are denoted by the first bit of
17046 their trailing significand field being 0.
17048 The default is @option{-mnan=legacy} unless GCC has been configured with
17049 @option{--with-nan=2008}.
17051 @item -mllsc
17052 @itemx -mno-llsc
17053 @opindex mllsc
17054 @opindex mno-llsc
17055 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17056 implement atomic memory built-in functions.  When neither option is
17057 specified, GCC uses the instructions if the target architecture
17058 supports them.
17060 @option{-mllsc} is useful if the runtime environment can emulate the
17061 instructions and @option{-mno-llsc} can be useful when compiling for
17062 nonstandard ISAs.  You can make either option the default by
17063 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17064 respectively.  @option{--with-llsc} is the default for some
17065 configurations; see the installation documentation for details.
17067 @item -mdsp
17068 @itemx -mno-dsp
17069 @opindex mdsp
17070 @opindex mno-dsp
17071 Use (do not use) revision 1 of the MIPS DSP ASE@.
17072 @xref{MIPS DSP Built-in Functions}.  This option defines the
17073 preprocessor macro @samp{__mips_dsp}.  It also defines
17074 @samp{__mips_dsp_rev} to 1.
17076 @item -mdspr2
17077 @itemx -mno-dspr2
17078 @opindex mdspr2
17079 @opindex mno-dspr2
17080 Use (do not use) revision 2 of the MIPS DSP ASE@.
17081 @xref{MIPS DSP Built-in Functions}.  This option defines the
17082 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
17083 It also defines @samp{__mips_dsp_rev} to 2.
17085 @item -msmartmips
17086 @itemx -mno-smartmips
17087 @opindex msmartmips
17088 @opindex mno-smartmips
17089 Use (do not use) the MIPS SmartMIPS ASE.
17091 @item -mpaired-single
17092 @itemx -mno-paired-single
17093 @opindex mpaired-single
17094 @opindex mno-paired-single
17095 Use (do not use) paired-single floating-point instructions.
17096 @xref{MIPS Paired-Single Support}.  This option requires
17097 hardware floating-point support to be enabled.
17099 @item -mdmx
17100 @itemx -mno-mdmx
17101 @opindex mdmx
17102 @opindex mno-mdmx
17103 Use (do not use) MIPS Digital Media Extension instructions.
17104 This option can only be used when generating 64-bit code and requires
17105 hardware floating-point support to be enabled.
17107 @item -mips3d
17108 @itemx -mno-mips3d
17109 @opindex mips3d
17110 @opindex mno-mips3d
17111 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17112 The option @option{-mips3d} implies @option{-mpaired-single}.
17114 @item -mmicromips
17115 @itemx -mno-micromips
17116 @opindex mmicromips
17117 @opindex mno-mmicromips
17118 Generate (do not generate) microMIPS code.
17120 MicroMIPS code generation can also be controlled on a per-function basis
17121 by means of @code{micromips} and @code{nomicromips} attributes.
17122 @xref{Function Attributes}, for more information.
17124 @item -mmt
17125 @itemx -mno-mt
17126 @opindex mmt
17127 @opindex mno-mt
17128 Use (do not use) MT Multithreading instructions.
17130 @item -mmcu
17131 @itemx -mno-mcu
17132 @opindex mmcu
17133 @opindex mno-mcu
17134 Use (do not use) the MIPS MCU ASE instructions.
17136 @item -meva
17137 @itemx -mno-eva
17138 @opindex meva
17139 @opindex mno-eva
17140 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17142 @item -mlong64
17143 @opindex mlong64
17144 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17145 an explanation of the default and the way that the pointer size is
17146 determined.
17148 @item -mlong32
17149 @opindex mlong32
17150 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17152 The default size of @code{int}s, @code{long}s and pointers depends on
17153 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17154 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17155 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17156 or the same size as integer registers, whichever is smaller.
17158 @item -msym32
17159 @itemx -mno-sym32
17160 @opindex msym32
17161 @opindex mno-sym32
17162 Assume (do not assume) that all symbols have 32-bit values, regardless
17163 of the selected ABI@.  This option is useful in combination with
17164 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17165 to generate shorter and faster references to symbolic addresses.
17167 @item -G @var{num}
17168 @opindex G
17169 Put definitions of externally-visible data in a small data section
17170 if that data is no bigger than @var{num} bytes.  GCC can then generate
17171 more efficient accesses to the data; see @option{-mgpopt} for details.
17173 The default @option{-G} option depends on the configuration.
17175 @item -mlocal-sdata
17176 @itemx -mno-local-sdata
17177 @opindex mlocal-sdata
17178 @opindex mno-local-sdata
17179 Extend (do not extend) the @option{-G} behavior to local data too,
17180 such as to static variables in C@.  @option{-mlocal-sdata} is the
17181 default for all configurations.
17183 If the linker complains that an application is using too much small data,
17184 you might want to try rebuilding the less performance-critical parts with
17185 @option{-mno-local-sdata}.  You might also want to build large
17186 libraries with @option{-mno-local-sdata}, so that the libraries leave
17187 more room for the main program.
17189 @item -mextern-sdata
17190 @itemx -mno-extern-sdata
17191 @opindex mextern-sdata
17192 @opindex mno-extern-sdata
17193 Assume (do not assume) that externally-defined data is in
17194 a small data section if the size of that data is within the @option{-G} limit.
17195 @option{-mextern-sdata} is the default for all configurations.
17197 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17198 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17199 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17200 is placed in a small data section.  If @var{Var} is defined by another
17201 module, you must either compile that module with a high-enough
17202 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17203 definition.  If @var{Var} is common, you must link the application
17204 with a high-enough @option{-G} setting.
17206 The easiest way of satisfying these restrictions is to compile
17207 and link every module with the same @option{-G} option.  However,
17208 you may wish to build a library that supports several different
17209 small data limits.  You can do this by compiling the library with
17210 the highest supported @option{-G} setting and additionally using
17211 @option{-mno-extern-sdata} to stop the library from making assumptions
17212 about externally-defined data.
17214 @item -mgpopt
17215 @itemx -mno-gpopt
17216 @opindex mgpopt
17217 @opindex mno-gpopt
17218 Use (do not use) GP-relative accesses for symbols that are known to be
17219 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17220 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17221 configurations.
17223 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17224 might not hold the value of @code{_gp}.  For example, if the code is
17225 part of a library that might be used in a boot monitor, programs that
17226 call boot monitor routines pass an unknown value in @code{$gp}.
17227 (In such situations, the boot monitor itself is usually compiled
17228 with @option{-G0}.)
17230 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17231 @option{-mno-extern-sdata}.
17233 @item -membedded-data
17234 @itemx -mno-embedded-data
17235 @opindex membedded-data
17236 @opindex mno-embedded-data
17237 Allocate variables to the read-only data section first if possible, then
17238 next in the small data section if possible, otherwise in data.  This gives
17239 slightly slower code than the default, but reduces the amount of RAM required
17240 when executing, and thus may be preferred for some embedded systems.
17242 @item -muninit-const-in-rodata
17243 @itemx -mno-uninit-const-in-rodata
17244 @opindex muninit-const-in-rodata
17245 @opindex mno-uninit-const-in-rodata
17246 Put uninitialized @code{const} variables in the read-only data section.
17247 This option is only meaningful in conjunction with @option{-membedded-data}.
17249 @item -mcode-readable=@var{setting}
17250 @opindex mcode-readable
17251 Specify whether GCC may generate code that reads from executable sections.
17252 There are three possible settings:
17254 @table @gcctabopt
17255 @item -mcode-readable=yes
17256 Instructions may freely access executable sections.  This is the
17257 default setting.
17259 @item -mcode-readable=pcrel
17260 MIPS16 PC-relative load instructions can access executable sections,
17261 but other instructions must not do so.  This option is useful on 4KSc
17262 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17263 It is also useful on processors that can be configured to have a dual
17264 instruction/data SRAM interface and that, like the M4K, automatically
17265 redirect PC-relative loads to the instruction RAM.
17267 @item -mcode-readable=no
17268 Instructions must not access executable sections.  This option can be
17269 useful on targets that are configured to have a dual instruction/data
17270 SRAM interface but that (unlike the M4K) do not automatically redirect
17271 PC-relative loads to the instruction RAM.
17272 @end table
17274 @item -msplit-addresses
17275 @itemx -mno-split-addresses
17276 @opindex msplit-addresses
17277 @opindex mno-split-addresses
17278 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17279 relocation operators.  This option has been superseded by
17280 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17282 @item -mexplicit-relocs
17283 @itemx -mno-explicit-relocs
17284 @opindex mexplicit-relocs
17285 @opindex mno-explicit-relocs
17286 Use (do not use) assembler relocation operators when dealing with symbolic
17287 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17288 is to use assembler macros instead.
17290 @option{-mexplicit-relocs} is the default if GCC was configured
17291 to use an assembler that supports relocation operators.
17293 @item -mcheck-zero-division
17294 @itemx -mno-check-zero-division
17295 @opindex mcheck-zero-division
17296 @opindex mno-check-zero-division
17297 Trap (do not trap) on integer division by zero.
17299 The default is @option{-mcheck-zero-division}.
17301 @item -mdivide-traps
17302 @itemx -mdivide-breaks
17303 @opindex mdivide-traps
17304 @opindex mdivide-breaks
17305 MIPS systems check for division by zero by generating either a
17306 conditional trap or a break instruction.  Using traps results in
17307 smaller code, but is only supported on MIPS II and later.  Also, some
17308 versions of the Linux kernel have a bug that prevents trap from
17309 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17310 allow conditional traps on architectures that support them and
17311 @option{-mdivide-breaks} to force the use of breaks.
17313 The default is usually @option{-mdivide-traps}, but this can be
17314 overridden at configure time using @option{--with-divide=breaks}.
17315 Divide-by-zero checks can be completely disabled using
17316 @option{-mno-check-zero-division}.
17318 @item -mmemcpy
17319 @itemx -mno-memcpy
17320 @opindex mmemcpy
17321 @opindex mno-memcpy
17322 Force (do not force) the use of @code{memcpy()} for non-trivial block
17323 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17324 most constant-sized copies.
17326 @item -mlong-calls
17327 @itemx -mno-long-calls
17328 @opindex mlong-calls
17329 @opindex mno-long-calls
17330 Disable (do not disable) use of the @code{jal} instruction.  Calling
17331 functions using @code{jal} is more efficient but requires the caller
17332 and callee to be in the same 256 megabyte segment.
17334 This option has no effect on abicalls code.  The default is
17335 @option{-mno-long-calls}.
17337 @item -mmad
17338 @itemx -mno-mad
17339 @opindex mmad
17340 @opindex mno-mad
17341 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17342 instructions, as provided by the R4650 ISA@.
17344 @item -mimadd
17345 @itemx -mno-imadd
17346 @opindex mimadd
17347 @opindex mno-imadd
17348 Enable (disable) use of the @code{madd} and @code{msub} integer
17349 instructions.  The default is @option{-mimadd} on architectures
17350 that support @code{madd} and @code{msub} except for the 74k 
17351 architecture where it was found to generate slower code.
17353 @item -mfused-madd
17354 @itemx -mno-fused-madd
17355 @opindex mfused-madd
17356 @opindex mno-fused-madd
17357 Enable (disable) use of the floating-point multiply-accumulate
17358 instructions, when they are available.  The default is
17359 @option{-mfused-madd}.
17361 On the R8000 CPU when multiply-accumulate instructions are used,
17362 the intermediate product is calculated to infinite precision
17363 and is not subject to the FCSR Flush to Zero bit.  This may be
17364 undesirable in some circumstances.  On other processors the result
17365 is numerically identical to the equivalent computation using
17366 separate multiply, add, subtract and negate instructions.
17368 @item -nocpp
17369 @opindex nocpp
17370 Tell the MIPS assembler to not run its preprocessor over user
17371 assembler files (with a @samp{.s} suffix) when assembling them.
17373 @item -mfix-24k
17374 @item -mno-fix-24k
17375 @opindex mfix-24k
17376 @opindex mno-fix-24k
17377 Work around the 24K E48 (lost data on stores during refill) errata.
17378 The workarounds are implemented by the assembler rather than by GCC@.
17380 @item -mfix-r4000
17381 @itemx -mno-fix-r4000
17382 @opindex mfix-r4000
17383 @opindex mno-fix-r4000
17384 Work around certain R4000 CPU errata:
17385 @itemize @minus
17386 @item
17387 A double-word or a variable shift may give an incorrect result if executed
17388 immediately after starting an integer division.
17389 @item
17390 A double-word or a variable shift may give an incorrect result if executed
17391 while an integer multiplication is in progress.
17392 @item
17393 An integer division may give an incorrect result if started in a delay slot
17394 of a taken branch or a jump.
17395 @end itemize
17397 @item -mfix-r4400
17398 @itemx -mno-fix-r4400
17399 @opindex mfix-r4400
17400 @opindex mno-fix-r4400
17401 Work around certain R4400 CPU errata:
17402 @itemize @minus
17403 @item
17404 A double-word or a variable shift may give an incorrect result if executed
17405 immediately after starting an integer division.
17406 @end itemize
17408 @item -mfix-r10000
17409 @itemx -mno-fix-r10000
17410 @opindex mfix-r10000
17411 @opindex mno-fix-r10000
17412 Work around certain R10000 errata:
17413 @itemize @minus
17414 @item
17415 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17416 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17417 @end itemize
17419 This option can only be used if the target architecture supports
17420 branch-likely instructions.  @option{-mfix-r10000} is the default when
17421 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17422 otherwise.
17424 @item -mfix-vr4120
17425 @itemx -mno-fix-vr4120
17426 @opindex mfix-vr4120
17427 Work around certain VR4120 errata:
17428 @itemize @minus
17429 @item
17430 @code{dmultu} does not always produce the correct result.
17431 @item
17432 @code{div} and @code{ddiv} do not always produce the correct result if one
17433 of the operands is negative.
17434 @end itemize
17435 The workarounds for the division errata rely on special functions in
17436 @file{libgcc.a}.  At present, these functions are only provided by
17437 the @code{mips64vr*-elf} configurations.
17439 Other VR4120 errata require a NOP to be inserted between certain pairs of
17440 instructions.  These errata are handled by the assembler, not by GCC itself.
17442 @item -mfix-vr4130
17443 @opindex mfix-vr4130
17444 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17445 workarounds are implemented by the assembler rather than by GCC,
17446 although GCC avoids using @code{mflo} and @code{mfhi} if the
17447 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17448 instructions are available instead.
17450 @item -mfix-sb1
17451 @itemx -mno-fix-sb1
17452 @opindex mfix-sb1
17453 Work around certain SB-1 CPU core errata.
17454 (This flag currently works around the SB-1 revision 2
17455 ``F1'' and ``F2'' floating-point errata.)
17457 @item -mr10k-cache-barrier=@var{setting}
17458 @opindex mr10k-cache-barrier
17459 Specify whether GCC should insert cache barriers to avoid the
17460 side-effects of speculation on R10K processors.
17462 In common with many processors, the R10K tries to predict the outcome
17463 of a conditional branch and speculatively executes instructions from
17464 the ``taken'' branch.  It later aborts these instructions if the
17465 predicted outcome is wrong.  However, on the R10K, even aborted
17466 instructions can have side effects.
17468 This problem only affects kernel stores and, depending on the system,
17469 kernel loads.  As an example, a speculatively-executed store may load
17470 the target memory into cache and mark the cache line as dirty, even if
17471 the store itself is later aborted.  If a DMA operation writes to the
17472 same area of memory before the ``dirty'' line is flushed, the cached
17473 data overwrites the DMA-ed data.  See the R10K processor manual
17474 for a full description, including other potential problems.
17476 One workaround is to insert cache barrier instructions before every memory
17477 access that might be speculatively executed and that might have side
17478 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17479 controls GCC's implementation of this workaround.  It assumes that
17480 aborted accesses to any byte in the following regions does not have
17481 side effects:
17483 @enumerate
17484 @item
17485 the memory occupied by the current function's stack frame;
17487 @item
17488 the memory occupied by an incoming stack argument;
17490 @item
17491 the memory occupied by an object with a link-time-constant address.
17492 @end enumerate
17494 It is the kernel's responsibility to ensure that speculative
17495 accesses to these regions are indeed safe.
17497 If the input program contains a function declaration such as:
17499 @smallexample
17500 void foo (void);
17501 @end smallexample
17503 then the implementation of @code{foo} must allow @code{j foo} and
17504 @code{jal foo} to be executed speculatively.  GCC honors this
17505 restriction for functions it compiles itself.  It expects non-GCC
17506 functions (such as hand-written assembly code) to do the same.
17508 The option has three forms:
17510 @table @gcctabopt
17511 @item -mr10k-cache-barrier=load-store
17512 Insert a cache barrier before a load or store that might be
17513 speculatively executed and that might have side effects even
17514 if aborted.
17516 @item -mr10k-cache-barrier=store
17517 Insert a cache barrier before a store that might be speculatively
17518 executed and that might have side effects even if aborted.
17520 @item -mr10k-cache-barrier=none
17521 Disable the insertion of cache barriers.  This is the default setting.
17522 @end table
17524 @item -mflush-func=@var{func}
17525 @itemx -mno-flush-func
17526 @opindex mflush-func
17527 Specifies the function to call to flush the I and D caches, or to not
17528 call any such function.  If called, the function must take the same
17529 arguments as the common @code{_flush_func()}, that is, the address of the
17530 memory range for which the cache is being flushed, the size of the
17531 memory range, and the number 3 (to flush both caches).  The default
17532 depends on the target GCC was configured for, but commonly is either
17533 @samp{_flush_func} or @samp{__cpu_flush}.
17535 @item mbranch-cost=@var{num}
17536 @opindex mbranch-cost
17537 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17538 This cost is only a heuristic and is not guaranteed to produce
17539 consistent results across releases.  A zero cost redundantly selects
17540 the default, which is based on the @option{-mtune} setting.
17542 @item -mbranch-likely
17543 @itemx -mno-branch-likely
17544 @opindex mbranch-likely
17545 @opindex mno-branch-likely
17546 Enable or disable use of Branch Likely instructions, regardless of the
17547 default for the selected architecture.  By default, Branch Likely
17548 instructions may be generated if they are supported by the selected
17549 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17550 and processors that implement those architectures; for those, Branch
17551 Likely instructions are not be generated by default because the MIPS32
17552 and MIPS64 architectures specifically deprecate their use.
17554 @item -mfp-exceptions
17555 @itemx -mno-fp-exceptions
17556 @opindex mfp-exceptions
17557 Specifies whether FP exceptions are enabled.  This affects how
17558 FP instructions are scheduled for some processors.
17559 The default is that FP exceptions are
17560 enabled.
17562 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17563 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17564 FP pipe.
17566 @item -mvr4130-align
17567 @itemx -mno-vr4130-align
17568 @opindex mvr4130-align
17569 The VR4130 pipeline is two-way superscalar, but can only issue two
17570 instructions together if the first one is 8-byte aligned.  When this
17571 option is enabled, GCC aligns pairs of instructions that it
17572 thinks should execute in parallel.
17574 This option only has an effect when optimizing for the VR4130.
17575 It normally makes code faster, but at the expense of making it bigger.
17576 It is enabled by default at optimization level @option{-O3}.
17578 @item -msynci
17579 @itemx -mno-synci
17580 @opindex msynci
17581 Enable (disable) generation of @code{synci} instructions on
17582 architectures that support it.  The @code{synci} instructions (if
17583 enabled) are generated when @code{__builtin___clear_cache()} is
17584 compiled.
17586 This option defaults to @code{-mno-synci}, but the default can be
17587 overridden by configuring with @code{--with-synci}.
17589 When compiling code for single processor systems, it is generally safe
17590 to use @code{synci}.  However, on many multi-core (SMP) systems, it
17591 does not invalidate the instruction caches on all cores and may lead
17592 to undefined behavior.
17594 @item -mrelax-pic-calls
17595 @itemx -mno-relax-pic-calls
17596 @opindex mrelax-pic-calls
17597 Try to turn PIC calls that are normally dispatched via register
17598 @code{$25} into direct calls.  This is only possible if the linker can
17599 resolve the destination at link-time and if the destination is within
17600 range for a direct call.
17602 @option{-mrelax-pic-calls} is the default if GCC was configured to use
17603 an assembler and a linker that support the @code{.reloc} assembly
17604 directive and @code{-mexplicit-relocs} is in effect.  With
17605 @code{-mno-explicit-relocs}, this optimization can be performed by the
17606 assembler and the linker alone without help from the compiler.
17608 @item -mmcount-ra-address
17609 @itemx -mno-mcount-ra-address
17610 @opindex mmcount-ra-address
17611 @opindex mno-mcount-ra-address
17612 Emit (do not emit) code that allows @code{_mcount} to modify the
17613 calling function's return address.  When enabled, this option extends
17614 the usual @code{_mcount} interface with a new @var{ra-address}
17615 parameter, which has type @code{intptr_t *} and is passed in register
17616 @code{$12}.  @code{_mcount} can then modify the return address by
17617 doing both of the following:
17618 @itemize
17619 @item
17620 Returning the new address in register @code{$31}.
17621 @item
17622 Storing the new address in @code{*@var{ra-address}},
17623 if @var{ra-address} is nonnull.
17624 @end itemize
17626 The default is @option{-mno-mcount-ra-address}.
17628 @end table
17630 @node MMIX Options
17631 @subsection MMIX Options
17632 @cindex MMIX Options
17634 These options are defined for the MMIX:
17636 @table @gcctabopt
17637 @item -mlibfuncs
17638 @itemx -mno-libfuncs
17639 @opindex mlibfuncs
17640 @opindex mno-libfuncs
17641 Specify that intrinsic library functions are being compiled, passing all
17642 values in registers, no matter the size.
17644 @item -mepsilon
17645 @itemx -mno-epsilon
17646 @opindex mepsilon
17647 @opindex mno-epsilon
17648 Generate floating-point comparison instructions that compare with respect
17649 to the @code{rE} epsilon register.
17651 @item -mabi=mmixware
17652 @itemx -mabi=gnu
17653 @opindex mabi=mmixware
17654 @opindex mabi=gnu
17655 Generate code that passes function parameters and return values that (in
17656 the called function) are seen as registers @code{$0} and up, as opposed to
17657 the GNU ABI which uses global registers @code{$231} and up.
17659 @item -mzero-extend
17660 @itemx -mno-zero-extend
17661 @opindex mzero-extend
17662 @opindex mno-zero-extend
17663 When reading data from memory in sizes shorter than 64 bits, use (do not
17664 use) zero-extending load instructions by default, rather than
17665 sign-extending ones.
17667 @item -mknuthdiv
17668 @itemx -mno-knuthdiv
17669 @opindex mknuthdiv
17670 @opindex mno-knuthdiv
17671 Make the result of a division yielding a remainder have the same sign as
17672 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
17673 remainder follows the sign of the dividend.  Both methods are
17674 arithmetically valid, the latter being almost exclusively used.
17676 @item -mtoplevel-symbols
17677 @itemx -mno-toplevel-symbols
17678 @opindex mtoplevel-symbols
17679 @opindex mno-toplevel-symbols
17680 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
17681 code can be used with the @code{PREFIX} assembly directive.
17683 @item -melf
17684 @opindex melf
17685 Generate an executable in the ELF format, rather than the default
17686 @samp{mmo} format used by the @command{mmix} simulator.
17688 @item -mbranch-predict
17689 @itemx -mno-branch-predict
17690 @opindex mbranch-predict
17691 @opindex mno-branch-predict
17692 Use (do not use) the probable-branch instructions, when static branch
17693 prediction indicates a probable branch.
17695 @item -mbase-addresses
17696 @itemx -mno-base-addresses
17697 @opindex mbase-addresses
17698 @opindex mno-base-addresses
17699 Generate (do not generate) code that uses @emph{base addresses}.  Using a
17700 base address automatically generates a request (handled by the assembler
17701 and the linker) for a constant to be set up in a global register.  The
17702 register is used for one or more base address requests within the range 0
17703 to 255 from the value held in the register.  The generally leads to short
17704 and fast code, but the number of different data items that can be
17705 addressed is limited.  This means that a program that uses lots of static
17706 data may require @option{-mno-base-addresses}.
17708 @item -msingle-exit
17709 @itemx -mno-single-exit
17710 @opindex msingle-exit
17711 @opindex mno-single-exit
17712 Force (do not force) generated code to have a single exit point in each
17713 function.
17714 @end table
17716 @node MN10300 Options
17717 @subsection MN10300 Options
17718 @cindex MN10300 options
17720 These @option{-m} options are defined for Matsushita MN10300 architectures:
17722 @table @gcctabopt
17723 @item -mmult-bug
17724 @opindex mmult-bug
17725 Generate code to avoid bugs in the multiply instructions for the MN10300
17726 processors.  This is the default.
17728 @item -mno-mult-bug
17729 @opindex mno-mult-bug
17730 Do not generate code to avoid bugs in the multiply instructions for the
17731 MN10300 processors.
17733 @item -mam33
17734 @opindex mam33
17735 Generate code using features specific to the AM33 processor.
17737 @item -mno-am33
17738 @opindex mno-am33
17739 Do not generate code using features specific to the AM33 processor.  This
17740 is the default.
17742 @item -mam33-2
17743 @opindex mam33-2
17744 Generate code using features specific to the AM33/2.0 processor.
17746 @item -mam34
17747 @opindex mam34
17748 Generate code using features specific to the AM34 processor.
17750 @item -mtune=@var{cpu-type}
17751 @opindex mtune
17752 Use the timing characteristics of the indicated CPU type when
17753 scheduling instructions.  This does not change the targeted processor
17754 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
17755 @samp{am33-2} or @samp{am34}.
17757 @item -mreturn-pointer-on-d0
17758 @opindex mreturn-pointer-on-d0
17759 When generating a function that returns a pointer, return the pointer
17760 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
17761 only in @code{a0}, and attempts to call such functions without a prototype
17762 result in errors.  Note that this option is on by default; use
17763 @option{-mno-return-pointer-on-d0} to disable it.
17765 @item -mno-crt0
17766 @opindex mno-crt0
17767 Do not link in the C run-time initialization object file.
17769 @item -mrelax
17770 @opindex mrelax
17771 Indicate to the linker that it should perform a relaxation optimization pass
17772 to shorten branches, calls and absolute memory addresses.  This option only
17773 has an effect when used on the command line for the final link step.
17775 This option makes symbolic debugging impossible.
17777 @item -mliw
17778 @opindex mliw
17779 Allow the compiler to generate @emph{Long Instruction Word}
17780 instructions if the target is the @samp{AM33} or later.  This is the
17781 default.  This option defines the preprocessor macro @samp{__LIW__}.
17783 @item -mnoliw
17784 @opindex mnoliw
17785 Do not allow the compiler to generate @emph{Long Instruction Word}
17786 instructions.  This option defines the preprocessor macro
17787 @samp{__NO_LIW__}.
17789 @item -msetlb
17790 @opindex msetlb
17791 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
17792 instructions if the target is the @samp{AM33} or later.  This is the
17793 default.  This option defines the preprocessor macro @samp{__SETLB__}.
17795 @item -mnosetlb
17796 @opindex mnosetlb
17797 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
17798 instructions.  This option defines the preprocessor macro
17799 @samp{__NO_SETLB__}.
17801 @end table
17803 @node Moxie Options
17804 @subsection Moxie Options
17805 @cindex Moxie Options
17807 @table @gcctabopt
17809 @item -meb
17810 @opindex meb
17811 Generate big-endian code.  This is the default for @samp{moxie-*-*}
17812 configurations.
17814 @item -mel
17815 @opindex mel
17816 Generate little-endian code.
17818 @item -mno-crt0
17819 @opindex mno-crt0
17820 Do not link in the C run-time initialization object file.
17822 @end table
17824 @node MSP430 Options
17825 @subsection MSP430 Options
17826 @cindex MSP430 Options
17828 These options are defined for the MSP430:
17830 @table @gcctabopt
17832 @item -masm-hex
17833 @opindex masm-hex
17834 Force assembly output to always use hex constants.  Normally such
17835 constants are signed decimals, but this option is available for
17836 testsuite and/or aesthetic purposes.
17838 @item -mmcu=
17839 @opindex mmcu=
17840 Select the MCU to target.  If the MCU supports the MSP430X ISA or the
17841 MSP430Xv2 ISA then gcc will make use of the extra instructions.  A C
17842 preprocessor symbol will be defined based upon the MCU name, converted
17843 to upper case and pre- and post- fixed with @code{__}.
17845 In addition two scripts will be added to the linker command line:
17846 @code{memory.ld} and @code{peripherals.ld}, with a search path based
17847 upon the MCU name.
17849 Note that there are three ``generic'' MCUs: @code{msp430},
17850 @code{msp430x} and @code{msp430xv2}, which can be used if a specific
17851 MCU is not being targeted.
17853 This option is also passed on to the assembler.
17855 @item -msim
17856 @opindex msim
17857 Link to the simulator runtime libraries and linker script.  Overrides
17858 any scripts that would be selected by the @option{-mmcu=} option.
17860 @item -mlarge
17861 @opindex mlarge
17862 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
17864 @item -msmall
17865 @opindex msmall
17866 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
17868 @item -mrelax
17869 @opindex mrelax
17870 This option is passed to the assembler and linker, and allows the
17871 linker to perform certain optimizations that cannot be done until
17872 the final link.
17874 @end table
17876 @node NDS32 Options
17877 @subsection NDS32 Options
17878 @cindex NDS32 Options
17880 These options are defined for NDS32 implementations:
17882 @table @gcctabopt
17884 @item -mbig-endian
17885 @opindex mbig-endian
17886 Generate code in big-endian mode.
17888 @item -mlittle-endian
17889 @opindex mlittle-endian
17890 Generate code in little-endian mode.
17892 @item -mreduced-regs
17893 @opindex mreduced-regs
17894 Use reduced-set registers for register allocation.
17896 @item -mfull-regs
17897 @opindex mfull-regs
17898 Use full-set registers for register allocation.
17900 @item -mcmov
17901 @opindex mcmov
17902 Generate conditional move instructions.
17904 @item -mno-cmov
17905 @opindex mno-cmov
17906 Do not generate conditional move instructions.
17908 @item -mperf-ext
17909 @opindex mperf-ext
17910 Generate performance extension instructions.
17912 @item -mno-perf-ext
17913 @opindex mno-perf-ext
17914 Do not generate performance extension instructions.
17916 @item -mv3push
17917 @opindex mv3push
17918 Generate v3 push25/pop25 instructions.
17920 @item -mno-v3push
17921 @opindex mno-v3push
17922 Do not generate v3 push25/pop25 instructions.
17924 @item -m16-bit
17925 @opindex m16-bit
17926 Generate 16-bit instructions.
17928 @item -mno-16-bit
17929 @opindex mno-16-bit
17930 Do not generate 16-bit instructions.
17932 @item -mgp-direct
17933 @opindex mgp-direct
17934 Generate GP base instructions directly.
17936 @item -mno-gp-direct
17937 @opindex mno-gp-direct
17938 Do no generate GP base instructions directly.
17940 @item -misr-vector-size=@var{num}
17941 @opindex misr-vector-size
17942 Specify the size of each interrupt vector, which must be 4 or 16.
17944 @item -mcache-block-size=@var{num}
17945 @opindex mcache-block-size
17946 Specify the size of each cache block,
17947 which must be a power of 2 between 4 and 512.
17949 @item -march=@var{arch}
17950 @opindex march
17951 Specify the name of the target architecture.
17953 @item -mforce-fp-as-gp
17954 @opindex mforce-fp-as-gp
17955 Prevent $fp being allocated during register allocation so that compiler
17956 is able to force performing fp-as-gp optimization.
17958 @item -mforbid-fp-as-gp
17959 @opindex mforbid-fp-as-gp
17960 Forbid using $fp to access static and global variables.
17961 This option strictly forbids fp-as-gp optimization
17962 regardless of @option{-mforce-fp-as-gp}.
17964 @item -mex9
17965 @opindex mex9
17966 Use special directives to guide linker doing ex9 optimization.
17968 @item -mctor-dtor
17969 @opindex mctor-dtor
17970 Enable constructor/destructor feature.
17972 @item -mrelax
17973 @opindex mrelax
17974 Guide linker to relax instructions.
17976 @end table
17978 @node PDP-11 Options
17979 @subsection PDP-11 Options
17980 @cindex PDP-11 Options
17982 These options are defined for the PDP-11:
17984 @table @gcctabopt
17985 @item -mfpu
17986 @opindex mfpu
17987 Use hardware FPP floating point.  This is the default.  (FIS floating
17988 point on the PDP-11/40 is not supported.)
17990 @item -msoft-float
17991 @opindex msoft-float
17992 Do not use hardware floating point.
17994 @item -mac0
17995 @opindex mac0
17996 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
17998 @item -mno-ac0
17999 @opindex mno-ac0
18000 Return floating-point results in memory.  This is the default.
18002 @item -m40
18003 @opindex m40
18004 Generate code for a PDP-11/40.
18006 @item -m45
18007 @opindex m45
18008 Generate code for a PDP-11/45.  This is the default.
18010 @item -m10
18011 @opindex m10
18012 Generate code for a PDP-11/10.
18014 @item -mbcopy-builtin
18015 @opindex mbcopy-builtin
18016 Use inline @code{movmemhi} patterns for copying memory.  This is the
18017 default.
18019 @item -mbcopy
18020 @opindex mbcopy
18021 Do not use inline @code{movmemhi} patterns for copying memory.
18023 @item -mint16
18024 @itemx -mno-int32
18025 @opindex mint16
18026 @opindex mno-int32
18027 Use 16-bit @code{int}.  This is the default.
18029 @item -mint32
18030 @itemx -mno-int16
18031 @opindex mint32
18032 @opindex mno-int16
18033 Use 32-bit @code{int}.
18035 @item -mfloat64
18036 @itemx -mno-float32
18037 @opindex mfloat64
18038 @opindex mno-float32
18039 Use 64-bit @code{float}.  This is the default.
18041 @item -mfloat32
18042 @itemx -mno-float64
18043 @opindex mfloat32
18044 @opindex mno-float64
18045 Use 32-bit @code{float}.
18047 @item -mabshi
18048 @opindex mabshi
18049 Use @code{abshi2} pattern.  This is the default.
18051 @item -mno-abshi
18052 @opindex mno-abshi
18053 Do not use @code{abshi2} pattern.
18055 @item -mbranch-expensive
18056 @opindex mbranch-expensive
18057 Pretend that branches are expensive.  This is for experimenting with
18058 code generation only.
18060 @item -mbranch-cheap
18061 @opindex mbranch-cheap
18062 Do not pretend that branches are expensive.  This is the default.
18064 @item -munix-asm
18065 @opindex munix-asm
18066 Use Unix assembler syntax.  This is the default when configured for
18067 @samp{pdp11-*-bsd}.
18069 @item -mdec-asm
18070 @opindex mdec-asm
18071 Use DEC assembler syntax.  This is the default when configured for any
18072 PDP-11 target other than @samp{pdp11-*-bsd}.
18073 @end table
18075 @node picoChip Options
18076 @subsection picoChip Options
18077 @cindex picoChip options
18079 These @samp{-m} options are defined for picoChip implementations:
18081 @table @gcctabopt
18083 @item -mae=@var{ae_type}
18084 @opindex mcpu
18085 Set the instruction set, register set, and instruction scheduling
18086 parameters for array element type @var{ae_type}.  Supported values
18087 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18089 @option{-mae=ANY} selects a completely generic AE type.  Code
18090 generated with this option runs on any of the other AE types.  The
18091 code is not as efficient as it would be if compiled for a specific
18092 AE type, and some types of operation (e.g., multiplication) do not
18093 work properly on all types of AE.
18095 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18096 for compiled code, and is the default.
18098 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18099 option may suffer from poor performance of byte (char) manipulation,
18100 since the DSP AE does not provide hardware support for byte load/stores.
18102 @item -msymbol-as-address
18103 Enable the compiler to directly use a symbol name as an address in a
18104 load/store instruction, without first loading it into a
18105 register.  Typically, the use of this option generates larger
18106 programs, which run faster than when the option isn't used.  However, the
18107 results vary from program to program, so it is left as a user option,
18108 rather than being permanently enabled.
18110 @item -mno-inefficient-warnings
18111 Disables warnings about the generation of inefficient code.  These
18112 warnings can be generated, for example, when compiling code that
18113 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18114 no hardware support for byte-level memory operations, so all byte
18115 load/stores must be synthesized from word load/store operations.  This is
18116 inefficient and a warning is generated to indicate
18117 that you should rewrite the code to avoid byte operations, or to target
18118 an AE type that has the necessary hardware support.  This option disables
18119 these warnings.
18121 @end table
18123 @node PowerPC Options
18124 @subsection PowerPC Options
18125 @cindex PowerPC options
18127 These are listed under @xref{RS/6000 and PowerPC Options}.
18129 @node RL78 Options
18130 @subsection RL78 Options
18131 @cindex RL78 Options
18133 @table @gcctabopt
18135 @item -msim
18136 @opindex msim
18137 Links in additional target libraries to support operation within a
18138 simulator.
18140 @item -mmul=none
18141 @itemx -mmul=g13
18142 @itemx -mmul=rl78
18143 @opindex mmul
18144 Specifies the type of hardware multiplication support to be used.  The
18145 default is @code{none}, which uses software multiplication functions.
18146 The @code{g13} option is for the hardware multiply/divide peripheral
18147 only on the RL78/G13 targets.  The @code{rl78} option is for the
18148 standard hardware multiplication defined in the RL78 software manual.
18150 @end table
18152 @node RS/6000 and PowerPC Options
18153 @subsection IBM RS/6000 and PowerPC Options
18154 @cindex RS/6000 and PowerPC Options
18155 @cindex IBM RS/6000 and PowerPC Options
18157 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18158 @table @gcctabopt
18159 @item -mpowerpc-gpopt
18160 @itemx -mno-powerpc-gpopt
18161 @itemx -mpowerpc-gfxopt
18162 @itemx -mno-powerpc-gfxopt
18163 @need 800
18164 @itemx -mpowerpc64
18165 @itemx -mno-powerpc64
18166 @itemx -mmfcrf
18167 @itemx -mno-mfcrf
18168 @itemx -mpopcntb
18169 @itemx -mno-popcntb
18170 @itemx -mpopcntd
18171 @itemx -mno-popcntd
18172 @itemx -mfprnd
18173 @itemx -mno-fprnd
18174 @need 800
18175 @itemx -mcmpb
18176 @itemx -mno-cmpb
18177 @itemx -mmfpgpr
18178 @itemx -mno-mfpgpr
18179 @itemx -mhard-dfp
18180 @itemx -mno-hard-dfp
18181 @opindex mpowerpc-gpopt
18182 @opindex mno-powerpc-gpopt
18183 @opindex mpowerpc-gfxopt
18184 @opindex mno-powerpc-gfxopt
18185 @opindex mpowerpc64
18186 @opindex mno-powerpc64
18187 @opindex mmfcrf
18188 @opindex mno-mfcrf
18189 @opindex mpopcntb
18190 @opindex mno-popcntb
18191 @opindex mpopcntd
18192 @opindex mno-popcntd
18193 @opindex mfprnd
18194 @opindex mno-fprnd
18195 @opindex mcmpb
18196 @opindex mno-cmpb
18197 @opindex mmfpgpr
18198 @opindex mno-mfpgpr
18199 @opindex mhard-dfp
18200 @opindex mno-hard-dfp
18201 You use these options to specify which instructions are available on the
18202 processor you are using.  The default value of these options is
18203 determined when configuring GCC@.  Specifying the
18204 @option{-mcpu=@var{cpu_type}} overrides the specification of these
18205 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
18206 rather than the options listed above.
18208 Specifying @option{-mpowerpc-gpopt} allows
18209 GCC to use the optional PowerPC architecture instructions in the
18210 General Purpose group, including floating-point square root.  Specifying
18211 @option{-mpowerpc-gfxopt} allows GCC to
18212 use the optional PowerPC architecture instructions in the Graphics
18213 group, including floating-point select.
18215 The @option{-mmfcrf} option allows GCC to generate the move from
18216 condition register field instruction implemented on the POWER4
18217 processor and other processors that support the PowerPC V2.01
18218 architecture.
18219 The @option{-mpopcntb} option allows GCC to generate the popcount and
18220 double-precision FP reciprocal estimate instruction implemented on the
18221 POWER5 processor and other processors that support the PowerPC V2.02
18222 architecture.
18223 The @option{-mpopcntd} option allows GCC to generate the popcount
18224 instruction implemented on the POWER7 processor and other processors
18225 that support the PowerPC V2.06 architecture.
18226 The @option{-mfprnd} option allows GCC to generate the FP round to
18227 integer instructions implemented on the POWER5+ processor and other
18228 processors that support the PowerPC V2.03 architecture.
18229 The @option{-mcmpb} option allows GCC to generate the compare bytes
18230 instruction implemented on the POWER6 processor and other processors
18231 that support the PowerPC V2.05 architecture.
18232 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
18233 general-purpose register instructions implemented on the POWER6X
18234 processor and other processors that support the extended PowerPC V2.05
18235 architecture.
18236 The @option{-mhard-dfp} option allows GCC to generate the decimal
18237 floating-point instructions implemented on some POWER processors.
18239 The @option{-mpowerpc64} option allows GCC to generate the additional
18240 64-bit instructions that are found in the full PowerPC64 architecture
18241 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
18242 @option{-mno-powerpc64}.
18244 @item -mcpu=@var{cpu_type}
18245 @opindex mcpu
18246 Set architecture type, register usage, and
18247 instruction scheduling parameters for machine type @var{cpu_type}.
18248 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
18249 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
18250 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
18251 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
18252 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
18253 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
18254 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
18255 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
18256 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
18257 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
18258 @samp{powerpc64}, and @samp{rs64}.
18260 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
18261 PowerPC and 64-bit PowerPC architecture machine
18262 types, with an appropriate, generic processor model assumed for
18263 scheduling purposes.
18265 The other options specify a specific processor.  Code generated under
18266 those options runs best on that processor, and may not run at all on
18267 others.
18269 The @option{-mcpu} options automatically enable or disable the
18270 following options:
18272 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
18273 -mpopcntb -mpopcntd  -mpowerpc64 @gol
18274 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
18275 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
18276 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector -mquad-memory}
18278 The particular options set for any particular CPU varies between
18279 compiler versions, depending on what setting seems to produce optimal
18280 code for that CPU; it doesn't necessarily reflect the actual hardware's
18281 capabilities.  If you wish to set an individual option to a particular
18282 value, you may specify it after the @option{-mcpu} option, like
18283 @option{-mcpu=970 -mno-altivec}.
18285 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
18286 not enabled or disabled by the @option{-mcpu} option at present because
18287 AIX does not have full support for these options.  You may still
18288 enable or disable them individually if you're sure it'll work in your
18289 environment.
18291 @item -mtune=@var{cpu_type}
18292 @opindex mtune
18293 Set the instruction scheduling parameters for machine type
18294 @var{cpu_type}, but do not set the architecture type or register usage,
18295 as @option{-mcpu=@var{cpu_type}} does.  The same
18296 values for @var{cpu_type} are used for @option{-mtune} as for
18297 @option{-mcpu}.  If both are specified, the code generated uses the
18298 architecture and registers set by @option{-mcpu}, but the
18299 scheduling parameters set by @option{-mtune}.
18301 @item -mcmodel=small
18302 @opindex mcmodel=small
18303 Generate PowerPC64 code for the small model: The TOC is limited to
18304 64k.
18306 @item -mcmodel=medium
18307 @opindex mcmodel=medium
18308 Generate PowerPC64 code for the medium model: The TOC and other static
18309 data may be up to a total of 4G in size.
18311 @item -mcmodel=large
18312 @opindex mcmodel=large
18313 Generate PowerPC64 code for the large model: The TOC may be up to 4G
18314 in size.  Other data and code is only limited by the 64-bit address
18315 space.
18317 @item -maltivec
18318 @itemx -mno-altivec
18319 @opindex maltivec
18320 @opindex mno-altivec
18321 Generate code that uses (does not use) AltiVec instructions, and also
18322 enable the use of built-in functions that allow more direct access to
18323 the AltiVec instruction set.  You may also need to set
18324 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
18325 enhancements.
18327 @item -mvrsave
18328 @itemx -mno-vrsave
18329 @opindex mvrsave
18330 @opindex mno-vrsave
18331 Generate VRSAVE instructions when generating AltiVec code.
18333 @item -mgen-cell-microcode
18334 @opindex mgen-cell-microcode
18335 Generate Cell microcode instructions.
18337 @item -mwarn-cell-microcode
18338 @opindex mwarn-cell-microcode
18339 Warn when a Cell microcode instruction is emitted.  An example
18340 of a Cell microcode instruction is a variable shift.
18342 @item -msecure-plt
18343 @opindex msecure-plt
18344 Generate code that allows @command{ld} and @command{ld.so}
18345 to build executables and shared
18346 libraries with non-executable @code{.plt} and @code{.got} sections.
18347 This is a PowerPC
18348 32-bit SYSV ABI option.
18350 @item -mbss-plt
18351 @opindex mbss-plt
18352 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
18353 fills in, and
18354 requires @code{.plt} and @code{.got}
18355 sections that are both writable and executable.
18356 This is a PowerPC 32-bit SYSV ABI option.
18358 @item -misel
18359 @itemx -mno-isel
18360 @opindex misel
18361 @opindex mno-isel
18362 This switch enables or disables the generation of ISEL instructions.
18364 @item -misel=@var{yes/no}
18365 This switch has been deprecated.  Use @option{-misel} and
18366 @option{-mno-isel} instead.
18368 @item -mspe
18369 @itemx -mno-spe
18370 @opindex mspe
18371 @opindex mno-spe
18372 This switch enables or disables the generation of SPE simd
18373 instructions.
18375 @item -mpaired
18376 @itemx -mno-paired
18377 @opindex mpaired
18378 @opindex mno-paired
18379 This switch enables or disables the generation of PAIRED simd
18380 instructions.
18382 @item -mspe=@var{yes/no}
18383 This option has been deprecated.  Use @option{-mspe} and
18384 @option{-mno-spe} instead.
18386 @item -mvsx
18387 @itemx -mno-vsx
18388 @opindex mvsx
18389 @opindex mno-vsx
18390 Generate code that uses (does not use) vector/scalar (VSX)
18391 instructions, and also enable the use of built-in functions that allow
18392 more direct access to the VSX instruction set.
18394 @item -mcrypto
18395 @itemx -mno-crypto
18396 @opindex mcrypto
18397 @opindex mno-crypto
18398 Enable the use (disable) of the built-in functions that allow direct
18399 access to the cryptographic instructions that were added in version
18400 2.07 of the PowerPC ISA.
18402 @item -mdirect-move
18403 @itemx -mno-direct-move
18404 @opindex mdirect-move
18405 @opindex mno-direct-move
18406 Generate code that uses (does not use) the instructions to move data
18407 between the general purpose registers and the vector/scalar (VSX)
18408 registers that were added in version 2.07 of the PowerPC ISA.
18410 @item -mpower8-fusion
18411 @itemx -mno-power8-fusion
18412 @opindex mpower8-fusion
18413 @opindex mno-power8-fusion
18414 Generate code that keeps (does not keeps) some integer operations
18415 adjacent so that the instructions can be fused together on power8 and
18416 later processors.
18418 @item -mpower8-vector
18419 @itemx -mno-power8-vector
18420 @opindex mpower8-vector
18421 @opindex mno-power8-vector
18422 Generate code that uses (does not use) the vector and scalar
18423 instructions that were added in version 2.07 of the PowerPC ISA.  Also
18424 enable the use of built-in functions that allow more direct access to
18425 the vector instructions.
18427 @item -mquad-memory
18428 @itemx -mno-quad-memory
18429 @opindex mquad-memory
18430 @opindex mno-quad-memory
18431 Generate code that uses (does not use) the quad word memory
18432 instructions.  The @option{-mquad-memory} option requires use of
18433 64-bit mode.
18435 @item -mfloat-gprs=@var{yes/single/double/no}
18436 @itemx -mfloat-gprs
18437 @opindex mfloat-gprs
18438 This switch enables or disables the generation of floating-point
18439 operations on the general-purpose registers for architectures that
18440 support it.
18442 The argument @var{yes} or @var{single} enables the use of
18443 single-precision floating-point operations.
18445 The argument @var{double} enables the use of single and
18446 double-precision floating-point operations.
18448 The argument @var{no} disables floating-point operations on the
18449 general-purpose registers.
18451 This option is currently only available on the MPC854x.
18453 @item -m32
18454 @itemx -m64
18455 @opindex m32
18456 @opindex m64
18457 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
18458 targets (including GNU/Linux).  The 32-bit environment sets int, long
18459 and pointer to 32 bits and generates code that runs on any PowerPC
18460 variant.  The 64-bit environment sets int to 32 bits and long and
18461 pointer to 64 bits, and generates code for PowerPC64, as for
18462 @option{-mpowerpc64}.
18464 @item -mfull-toc
18465 @itemx -mno-fp-in-toc
18466 @itemx -mno-sum-in-toc
18467 @itemx -mminimal-toc
18468 @opindex mfull-toc
18469 @opindex mno-fp-in-toc
18470 @opindex mno-sum-in-toc
18471 @opindex mminimal-toc
18472 Modify generation of the TOC (Table Of Contents), which is created for
18473 every executable file.  The @option{-mfull-toc} option is selected by
18474 default.  In that case, GCC allocates at least one TOC entry for
18475 each unique non-automatic variable reference in your program.  GCC
18476 also places floating-point constants in the TOC@.  However, only
18477 16,384 entries are available in the TOC@.
18479 If you receive a linker error message that saying you have overflowed
18480 the available TOC space, you can reduce the amount of TOC space used
18481 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
18482 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
18483 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
18484 generate code to calculate the sum of an address and a constant at
18485 run time instead of putting that sum into the TOC@.  You may specify one
18486 or both of these options.  Each causes GCC to produce very slightly
18487 slower and larger code at the expense of conserving TOC space.
18489 If you still run out of space in the TOC even when you specify both of
18490 these options, specify @option{-mminimal-toc} instead.  This option causes
18491 GCC to make only one TOC entry for every file.  When you specify this
18492 option, GCC produces code that is slower and larger but which
18493 uses extremely little TOC space.  You may wish to use this option
18494 only on files that contain less frequently-executed code.
18496 @item -maix64
18497 @itemx -maix32
18498 @opindex maix64
18499 @opindex maix32
18500 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
18501 @code{long} type, and the infrastructure needed to support them.
18502 Specifying @option{-maix64} implies @option{-mpowerpc64},
18503 while @option{-maix32} disables the 64-bit ABI and
18504 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
18506 @item -mxl-compat
18507 @itemx -mno-xl-compat
18508 @opindex mxl-compat
18509 @opindex mno-xl-compat
18510 Produce code that conforms more closely to IBM XL compiler semantics
18511 when using AIX-compatible ABI@.  Pass floating-point arguments to
18512 prototyped functions beyond the register save area (RSA) on the stack
18513 in addition to argument FPRs.  Do not assume that most significant
18514 double in 128-bit long double value is properly rounded when comparing
18515 values and converting to double.  Use XL symbol names for long double
18516 support routines.
18518 The AIX calling convention was extended but not initially documented to
18519 handle an obscure K&R C case of calling a function that takes the
18520 address of its arguments with fewer arguments than declared.  IBM XL
18521 compilers access floating-point arguments that do not fit in the
18522 RSA from the stack when a subroutine is compiled without
18523 optimization.  Because always storing floating-point arguments on the
18524 stack is inefficient and rarely needed, this option is not enabled by
18525 default and only is necessary when calling subroutines compiled by IBM
18526 XL compilers without optimization.
18528 @item -mpe
18529 @opindex mpe
18530 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
18531 application written to use message passing with special startup code to
18532 enable the application to run.  The system must have PE installed in the
18533 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
18534 must be overridden with the @option{-specs=} option to specify the
18535 appropriate directory location.  The Parallel Environment does not
18536 support threads, so the @option{-mpe} option and the @option{-pthread}
18537 option are incompatible.
18539 @item -malign-natural
18540 @itemx -malign-power
18541 @opindex malign-natural
18542 @opindex malign-power
18543 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
18544 @option{-malign-natural} overrides the ABI-defined alignment of larger
18545 types, such as floating-point doubles, on their natural size-based boundary.
18546 The option @option{-malign-power} instructs GCC to follow the ABI-specified
18547 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
18549 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
18550 is not supported.
18552 @item -msoft-float
18553 @itemx -mhard-float
18554 @opindex msoft-float
18555 @opindex mhard-float
18556 Generate code that does not use (uses) the floating-point register set.
18557 Software floating-point emulation is provided if you use the
18558 @option{-msoft-float} option, and pass the option to GCC when linking.
18560 @item -msingle-float
18561 @itemx -mdouble-float
18562 @opindex msingle-float
18563 @opindex mdouble-float
18564 Generate code for single- or double-precision floating-point operations.
18565 @option{-mdouble-float} implies @option{-msingle-float}.
18567 @item -msimple-fpu
18568 @opindex msimple-fpu
18569 Do not generate @code{sqrt} and @code{div} instructions for hardware
18570 floating-point unit.
18572 @item -mfpu=@var{name}
18573 @opindex mfpu
18574 Specify type of floating-point unit.  Valid values for @var{name} are
18575 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
18576 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
18577 @samp{sp_full} (equivalent to @option{-msingle-float}),
18578 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
18580 @item -mxilinx-fpu
18581 @opindex mxilinx-fpu
18582 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
18584 @item -mmultiple
18585 @itemx -mno-multiple
18586 @opindex mmultiple
18587 @opindex mno-multiple
18588 Generate code that uses (does not use) the load multiple word
18589 instructions and the store multiple word instructions.  These
18590 instructions are generated by default on POWER systems, and not
18591 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
18592 PowerPC systems, since those instructions do not work when the
18593 processor is in little-endian mode.  The exceptions are PPC740 and
18594 PPC750 which permit these instructions in little-endian mode.
18596 @item -mstring
18597 @itemx -mno-string
18598 @opindex mstring
18599 @opindex mno-string
18600 Generate code that uses (does not use) the load string instructions
18601 and the store string word instructions to save multiple registers and
18602 do small block moves.  These instructions are generated by default on
18603 POWER systems, and not generated on PowerPC systems.  Do not use
18604 @option{-mstring} on little-endian PowerPC systems, since those
18605 instructions do not work when the processor is in little-endian mode.
18606 The exceptions are PPC740 and PPC750 which permit these instructions
18607 in little-endian mode.
18609 @item -mupdate
18610 @itemx -mno-update
18611 @opindex mupdate
18612 @opindex mno-update
18613 Generate code that uses (does not use) the load or store instructions
18614 that update the base register to the address of the calculated memory
18615 location.  These instructions are generated by default.  If you use
18616 @option{-mno-update}, there is a small window between the time that the
18617 stack pointer is updated and the address of the previous frame is
18618 stored, which means code that walks the stack frame across interrupts or
18619 signals may get corrupted data.
18621 @item -mavoid-indexed-addresses
18622 @itemx -mno-avoid-indexed-addresses
18623 @opindex mavoid-indexed-addresses
18624 @opindex mno-avoid-indexed-addresses
18625 Generate code that tries to avoid (not avoid) the use of indexed load
18626 or store instructions. These instructions can incur a performance
18627 penalty on Power6 processors in certain situations, such as when
18628 stepping through large arrays that cross a 16M boundary.  This option
18629 is enabled by default when targeting Power6 and disabled otherwise.
18631 @item -mfused-madd
18632 @itemx -mno-fused-madd
18633 @opindex mfused-madd
18634 @opindex mno-fused-madd
18635 Generate code that uses (does not use) the floating-point multiply and
18636 accumulate instructions.  These instructions are generated by default
18637 if hardware floating point is used.  The machine-dependent
18638 @option{-mfused-madd} option is now mapped to the machine-independent
18639 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
18640 mapped to @option{-ffp-contract=off}.
18642 @item -mmulhw
18643 @itemx -mno-mulhw
18644 @opindex mmulhw
18645 @opindex mno-mulhw
18646 Generate code that uses (does not use) the half-word multiply and
18647 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
18648 These instructions are generated by default when targeting those
18649 processors.
18651 @item -mdlmzb
18652 @itemx -mno-dlmzb
18653 @opindex mdlmzb
18654 @opindex mno-dlmzb
18655 Generate code that uses (does not use) the string-search @samp{dlmzb}
18656 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
18657 generated by default when targeting those processors.
18659 @item -mno-bit-align
18660 @itemx -mbit-align
18661 @opindex mno-bit-align
18662 @opindex mbit-align
18663 On System V.4 and embedded PowerPC systems do not (do) force structures
18664 and unions that contain bit-fields to be aligned to the base type of the
18665 bit-field.
18667 For example, by default a structure containing nothing but 8
18668 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
18669 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
18670 the structure is aligned to a 1-byte boundary and is 1 byte in
18671 size.
18673 @item -mno-strict-align
18674 @itemx -mstrict-align
18675 @opindex mno-strict-align
18676 @opindex mstrict-align
18677 On System V.4 and embedded PowerPC systems do not (do) assume that
18678 unaligned memory references are handled by the system.
18680 @item -mrelocatable
18681 @itemx -mno-relocatable
18682 @opindex mrelocatable
18683 @opindex mno-relocatable
18684 Generate code that allows (does not allow) a static executable to be
18685 relocated to a different address at run time.  A simple embedded
18686 PowerPC system loader should relocate the entire contents of
18687 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
18688 a table of 32-bit addresses generated by this option.  For this to
18689 work, all objects linked together must be compiled with
18690 @option{-mrelocatable} or @option{-mrelocatable-lib}.
18691 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
18693 @item -mrelocatable-lib
18694 @itemx -mno-relocatable-lib
18695 @opindex mrelocatable-lib
18696 @opindex mno-relocatable-lib
18697 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
18698 @code{.fixup} section to allow static executables to be relocated at
18699 run time, but @option{-mrelocatable-lib} does not use the smaller stack
18700 alignment of @option{-mrelocatable}.  Objects compiled with
18701 @option{-mrelocatable-lib} may be linked with objects compiled with
18702 any combination of the @option{-mrelocatable} options.
18704 @item -mno-toc
18705 @itemx -mtoc
18706 @opindex mno-toc
18707 @opindex mtoc
18708 On System V.4 and embedded PowerPC systems do not (do) assume that
18709 register 2 contains a pointer to a global area pointing to the addresses
18710 used in the program.
18712 @item -mlittle
18713 @itemx -mlittle-endian
18714 @opindex mlittle
18715 @opindex mlittle-endian
18716 On System V.4 and embedded PowerPC systems compile code for the
18717 processor in little-endian mode.  The @option{-mlittle-endian} option is
18718 the same as @option{-mlittle}.
18720 @item -mbig
18721 @itemx -mbig-endian
18722 @opindex mbig
18723 @opindex mbig-endian
18724 On System V.4 and embedded PowerPC systems compile code for the
18725 processor in big-endian mode.  The @option{-mbig-endian} option is
18726 the same as @option{-mbig}.
18728 @item -mdynamic-no-pic
18729 @opindex mdynamic-no-pic
18730 On Darwin and Mac OS X systems, compile code so that it is not
18731 relocatable, but that its external references are relocatable.  The
18732 resulting code is suitable for applications, but not shared
18733 libraries.
18735 @item -msingle-pic-base
18736 @opindex msingle-pic-base
18737 Treat the register used for PIC addressing as read-only, rather than
18738 loading it in the prologue for each function.  The runtime system is
18739 responsible for initializing this register with an appropriate value
18740 before execution begins.
18742 @item -mprioritize-restricted-insns=@var{priority}
18743 @opindex mprioritize-restricted-insns
18744 This option controls the priority that is assigned to
18745 dispatch-slot restricted instructions during the second scheduling
18746 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
18747 or @samp{2} to assign no, highest, or second-highest (respectively) 
18748 priority to dispatch-slot restricted
18749 instructions.
18751 @item -msched-costly-dep=@var{dependence_type}
18752 @opindex msched-costly-dep
18753 This option controls which dependences are considered costly
18754 by the target during instruction scheduling.  The argument
18755 @var{dependence_type} takes one of the following values:
18757 @table @asis
18758 @item @samp{no}
18759 No dependence is costly.
18761 @item @samp{all}
18762 All dependences are costly.
18764 @item @samp{true_store_to_load}
18765 A true dependence from store to load is costly.
18767 @item @samp{store_to_load}
18768 Any dependence from store to load is costly.
18770 @item @var{number}
18771 Any dependence for which the latency is greater than or equal to 
18772 @var{number} is costly.
18773 @end table
18775 @item -minsert-sched-nops=@var{scheme}
18776 @opindex minsert-sched-nops
18777 This option controls which NOP insertion scheme is used during
18778 the second scheduling pass.  The argument @var{scheme} takes one of the
18779 following values:
18781 @table @asis
18782 @item @samp{no}
18783 Don't insert NOPs.
18785 @item @samp{pad}
18786 Pad with NOPs any dispatch group that has vacant issue slots,
18787 according to the scheduler's grouping.
18789 @item @samp{regroup_exact}
18790 Insert NOPs to force costly dependent insns into
18791 separate groups.  Insert exactly as many NOPs as needed to force an insn
18792 to a new group, according to the estimated processor grouping.
18794 @item @var{number}
18795 Insert NOPs to force costly dependent insns into
18796 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
18797 @end table
18799 @item -mcall-sysv
18800 @opindex mcall-sysv
18801 On System V.4 and embedded PowerPC systems compile code using calling
18802 conventions that adhere to the March 1995 draft of the System V
18803 Application Binary Interface, PowerPC processor supplement.  This is the
18804 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
18806 @item -mcall-sysv-eabi
18807 @itemx -mcall-eabi
18808 @opindex mcall-sysv-eabi
18809 @opindex mcall-eabi
18810 Specify both @option{-mcall-sysv} and @option{-meabi} options.
18812 @item -mcall-sysv-noeabi
18813 @opindex mcall-sysv-noeabi
18814 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
18816 @item -mcall-aixdesc
18817 @opindex m
18818 On System V.4 and embedded PowerPC systems compile code for the AIX
18819 operating system.
18821 @item -mcall-linux
18822 @opindex mcall-linux
18823 On System V.4 and embedded PowerPC systems compile code for the
18824 Linux-based GNU system.
18826 @item -mcall-freebsd
18827 @opindex mcall-freebsd
18828 On System V.4 and embedded PowerPC systems compile code for the
18829 FreeBSD operating system.
18831 @item -mcall-netbsd
18832 @opindex mcall-netbsd
18833 On System V.4 and embedded PowerPC systems compile code for the
18834 NetBSD operating system.
18836 @item -mcall-openbsd
18837 @opindex mcall-netbsd
18838 On System V.4 and embedded PowerPC systems compile code for the
18839 OpenBSD operating system.
18841 @item -maix-struct-return
18842 @opindex maix-struct-return
18843 Return all structures in memory (as specified by the AIX ABI)@.
18845 @item -msvr4-struct-return
18846 @opindex msvr4-struct-return
18847 Return structures smaller than 8 bytes in registers (as specified by the
18848 SVR4 ABI)@.
18850 @item -mabi=@var{abi-type}
18851 @opindex mabi
18852 Extend the current ABI with a particular extension, or remove such extension.
18853 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
18854 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
18855 @var{elfv1}, @var{elfv2}@.
18857 @item -mabi=spe
18858 @opindex mabi=spe
18859 Extend the current ABI with SPE ABI extensions.  This does not change
18860 the default ABI, instead it adds the SPE ABI extensions to the current
18861 ABI@.
18863 @item -mabi=no-spe
18864 @opindex mabi=no-spe
18865 Disable Book-E SPE ABI extensions for the current ABI@.
18867 @item -mabi=ibmlongdouble
18868 @opindex mabi=ibmlongdouble
18869 Change the current ABI to use IBM extended-precision long double.
18870 This is a PowerPC 32-bit SYSV ABI option.
18872 @item -mabi=ieeelongdouble
18873 @opindex mabi=ieeelongdouble
18874 Change the current ABI to use IEEE extended-precision long double.
18875 This is a PowerPC 32-bit Linux ABI option.
18877 @item -mabi=elfv1
18878 @opindex mabi=elfv1
18879 Change the current ABI to use the ELFv1 ABI.
18880 This is the default ABI for big-endian PowerPC 64-bit Linux.
18881 Overriding the default ABI requires special system support and is
18882 likely to fail in spectacular ways.
18884 @item -mabi=elfv2
18885 @opindex mabi=elfv2
18886 Change the current ABI to use the ELFv2 ABI.
18887 This is the default ABI for little-endian PowerPC 64-bit Linux.
18888 Overriding the default ABI requires special system support and is
18889 likely to fail in spectacular ways.
18891 @item -mprototype
18892 @itemx -mno-prototype
18893 @opindex mprototype
18894 @opindex mno-prototype
18895 On System V.4 and embedded PowerPC systems assume that all calls to
18896 variable argument functions are properly prototyped.  Otherwise, the
18897 compiler must insert an instruction before every non-prototyped call to
18898 set or clear bit 6 of the condition code register (@var{CR}) to
18899 indicate whether floating-point values are passed in the floating-point
18900 registers in case the function takes variable arguments.  With
18901 @option{-mprototype}, only calls to prototyped variable argument functions
18902 set or clear the bit.
18904 @item -msim
18905 @opindex msim
18906 On embedded PowerPC systems, assume that the startup module is called
18907 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
18908 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
18909 configurations.
18911 @item -mmvme
18912 @opindex mmvme
18913 On embedded PowerPC systems, assume that the startup module is called
18914 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
18915 @file{libc.a}.
18917 @item -mads
18918 @opindex mads
18919 On embedded PowerPC systems, assume that the startup module is called
18920 @file{crt0.o} and the standard C libraries are @file{libads.a} and
18921 @file{libc.a}.
18923 @item -myellowknife
18924 @opindex myellowknife
18925 On embedded PowerPC systems, assume that the startup module is called
18926 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
18927 @file{libc.a}.
18929 @item -mvxworks
18930 @opindex mvxworks
18931 On System V.4 and embedded PowerPC systems, specify that you are
18932 compiling for a VxWorks system.
18934 @item -memb
18935 @opindex memb
18936 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
18937 header to indicate that @samp{eabi} extended relocations are used.
18939 @item -meabi
18940 @itemx -mno-eabi
18941 @opindex meabi
18942 @opindex mno-eabi
18943 On System V.4 and embedded PowerPC systems do (do not) adhere to the
18944 Embedded Applications Binary Interface (EABI), which is a set of
18945 modifications to the System V.4 specifications.  Selecting @option{-meabi}
18946 means that the stack is aligned to an 8-byte boundary, a function
18947 @code{__eabi} is called from @code{main} to set up the EABI
18948 environment, and the @option{-msdata} option can use both @code{r2} and
18949 @code{r13} to point to two separate small data areas.  Selecting
18950 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
18951 no EABI initialization function is called from @code{main}, and the
18952 @option{-msdata} option only uses @code{r13} to point to a single
18953 small data area.  The @option{-meabi} option is on by default if you
18954 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
18956 @item -msdata=eabi
18957 @opindex msdata=eabi
18958 On System V.4 and embedded PowerPC systems, put small initialized
18959 @code{const} global and static data in the @samp{.sdata2} section, which
18960 is pointed to by register @code{r2}.  Put small initialized
18961 non-@code{const} global and static data in the @samp{.sdata} section,
18962 which is pointed to by register @code{r13}.  Put small uninitialized
18963 global and static data in the @samp{.sbss} section, which is adjacent to
18964 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
18965 incompatible with the @option{-mrelocatable} option.  The
18966 @option{-msdata=eabi} option also sets the @option{-memb} option.
18968 @item -msdata=sysv
18969 @opindex msdata=sysv
18970 On System V.4 and embedded PowerPC systems, put small global and static
18971 data in the @samp{.sdata} section, which is pointed to by register
18972 @code{r13}.  Put small uninitialized global and static data in the
18973 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
18974 The @option{-msdata=sysv} option is incompatible with the
18975 @option{-mrelocatable} option.
18977 @item -msdata=default
18978 @itemx -msdata
18979 @opindex msdata=default
18980 @opindex msdata
18981 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
18982 compile code the same as @option{-msdata=eabi}, otherwise compile code the
18983 same as @option{-msdata=sysv}.
18985 @item -msdata=data
18986 @opindex msdata=data
18987 On System V.4 and embedded PowerPC systems, put small global
18988 data in the @samp{.sdata} section.  Put small uninitialized global
18989 data in the @samp{.sbss} section.  Do not use register @code{r13}
18990 to address small data however.  This is the default behavior unless
18991 other @option{-msdata} options are used.
18993 @item -msdata=none
18994 @itemx -mno-sdata
18995 @opindex msdata=none
18996 @opindex mno-sdata
18997 On embedded PowerPC systems, put all initialized global and static data
18998 in the @samp{.data} section, and all uninitialized data in the
18999 @samp{.bss} section.
19001 @item -mblock-move-inline-limit=@var{num}
19002 @opindex mblock-move-inline-limit
19003 Inline all block moves (such as calls to @code{memcpy} or structure
19004 copies) less than or equal to @var{num} bytes.  The minimum value for
19005 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19006 targets.  The default value is target-specific.
19008 @item -G @var{num}
19009 @opindex G
19010 @cindex smaller data references (PowerPC)
19011 @cindex .sdata/.sdata2 references (PowerPC)
19012 On embedded PowerPC systems, put global and static items less than or
19013 equal to @var{num} bytes into the small data or BSS sections instead of
19014 the normal data or BSS section.  By default, @var{num} is 8.  The
19015 @option{-G @var{num}} switch is also passed to the linker.
19016 All modules should be compiled with the same @option{-G @var{num}} value.
19018 @item -mregnames
19019 @itemx -mno-regnames
19020 @opindex mregnames
19021 @opindex mno-regnames
19022 On System V.4 and embedded PowerPC systems do (do not) emit register
19023 names in the assembly language output using symbolic forms.
19025 @item -mlongcall
19026 @itemx -mno-longcall
19027 @opindex mlongcall
19028 @opindex mno-longcall
19029 By default assume that all calls are far away so that a longer and more
19030 expensive calling sequence is required.  This is required for calls
19031 farther than 32 megabytes (33,554,432 bytes) from the current location.
19032 A short call is generated if the compiler knows
19033 the call cannot be that far away.  This setting can be overridden by
19034 the @code{shortcall} function attribute, or by @code{#pragma
19035 longcall(0)}.
19037 Some linkers are capable of detecting out-of-range calls and generating
19038 glue code on the fly.  On these systems, long calls are unnecessary and
19039 generate slower code.  As of this writing, the AIX linker can do this,
19040 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19041 to the GNU linker for 32-bit PowerPC systems as well.
19043 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19044 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19045 addresses represent the callee and the branch island.  The
19046 Darwin/PPC linker prefers the first address and generates a @code{bl
19047 callee} if the PPC @code{bl} instruction reaches the callee directly;
19048 otherwise, the linker generates @code{bl L42} to call the branch
19049 island.  The branch island is appended to the body of the
19050 calling function; it computes the full 32-bit address of the callee
19051 and jumps to it.
19053 On Mach-O (Darwin) systems, this option directs the compiler emit to
19054 the glue for every direct call, and the Darwin linker decides whether
19055 to use or discard it.
19057 In the future, GCC may ignore all longcall specifications
19058 when the linker is known to generate glue.
19060 @item -mtls-markers
19061 @itemx -mno-tls-markers
19062 @opindex mtls-markers
19063 @opindex mno-tls-markers
19064 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19065 specifying the function argument.  The relocation allows the linker to
19066 reliably associate function call with argument setup instructions for
19067 TLS optimization, which in turn allows GCC to better schedule the
19068 sequence.
19070 @item -pthread
19071 @opindex pthread
19072 Adds support for multithreading with the @dfn{pthreads} library.
19073 This option sets flags for both the preprocessor and linker.
19075 @item -mrecip
19076 @itemx -mno-recip
19077 @opindex mrecip
19078 This option enables use of the reciprocal estimate and
19079 reciprocal square root estimate instructions with additional
19080 Newton-Raphson steps to increase precision instead of doing a divide or
19081 square root and divide for floating-point arguments.  You should use
19082 the @option{-ffast-math} option when using @option{-mrecip} (or at
19083 least @option{-funsafe-math-optimizations},
19084 @option{-finite-math-only}, @option{-freciprocal-math} and
19085 @option{-fno-trapping-math}).  Note that while the throughput of the
19086 sequence is generally higher than the throughput of the non-reciprocal
19087 instruction, the precision of the sequence can be decreased by up to 2
19088 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19089 roots.
19091 @item -mrecip=@var{opt}
19092 @opindex mrecip=opt
19093 This option controls which reciprocal estimate instructions
19094 may be used.  @var{opt} is a comma-separated list of options, which may
19095 be preceded by a @code{!} to invert the option:
19096 @code{all}: enable all estimate instructions,
19097 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
19098 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
19099 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
19100 @code{divf}: enable the single-precision reciprocal approximation instructions;
19101 @code{divd}: enable the double-precision reciprocal approximation instructions;
19102 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
19103 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
19104 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
19106 So, for example, @option{-mrecip=all,!rsqrtd} enables
19107 all of the reciprocal estimate instructions, except for the
19108 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
19109 which handle the double-precision reciprocal square root calculations.
19111 @item -mrecip-precision
19112 @itemx -mno-recip-precision
19113 @opindex mrecip-precision
19114 Assume (do not assume) that the reciprocal estimate instructions
19115 provide higher-precision estimates than is mandated by the PowerPC
19116 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
19117 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
19118 The double-precision square root estimate instructions are not generated by
19119 default on low-precision machines, since they do not provide an
19120 estimate that converges after three steps.
19122 @item -mveclibabi=@var{type}
19123 @opindex mveclibabi
19124 Specifies the ABI type to use for vectorizing intrinsics using an
19125 external library.  The only type supported at present is @code{mass},
19126 which specifies to use IBM's Mathematical Acceleration Subsystem
19127 (MASS) libraries for vectorizing intrinsics using external libraries.
19128 GCC currently emits calls to @code{acosd2}, @code{acosf4},
19129 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
19130 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
19131 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
19132 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
19133 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
19134 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
19135 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
19136 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
19137 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
19138 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
19139 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
19140 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
19141 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
19142 for power7.  Both @option{-ftree-vectorize} and
19143 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
19144 libraries must be specified at link time.
19146 @item -mfriz
19147 @itemx -mno-friz
19148 @opindex mfriz
19149 Generate (do not generate) the @code{friz} instruction when the
19150 @option{-funsafe-math-optimizations} option is used to optimize
19151 rounding of floating-point values to 64-bit integer and back to floating
19152 point.  The @code{friz} instruction does not return the same value if
19153 the floating-point number is too large to fit in an integer.
19155 @item -mpointers-to-nested-functions
19156 @itemx -mno-pointers-to-nested-functions
19157 @opindex mpointers-to-nested-functions
19158 Generate (do not generate) code to load up the static chain register
19159 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
19160 systems where a function pointer points to a 3-word descriptor giving
19161 the function address, TOC value to be loaded in register @var{r2}, and
19162 static chain value to be loaded in register @var{r11}.  The
19163 @option{-mpointers-to-nested-functions} is on by default.  You cannot
19164 call through pointers to nested functions or pointers
19165 to functions compiled in other languages that use the static chain if
19166 you use the @option{-mno-pointers-to-nested-functions}.
19168 @item -msave-toc-indirect
19169 @itemx -mno-save-toc-indirect
19170 @opindex msave-toc-indirect
19171 Generate (do not generate) code to save the TOC value in the reserved
19172 stack location in the function prologue if the function calls through
19173 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
19174 saved in the prologue, it is saved just before the call through the
19175 pointer.  The @option{-mno-save-toc-indirect} option is the default.
19177 @item -mcompat-align-parm
19178 @itemx -mno-compat-align-parm
19179 @opindex mcompat-align-parm
19180 Generate (do not generate) code to pass structure parameters with a
19181 maximum alignment of 64 bits, for compatibility with older versions
19182 of GCC.
19184 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
19185 structure parameter on a 128-bit boundary when that structure contained
19186 a member requiring 128-bit alignment.  This is corrected in more
19187 recent versions of GCC.  This option may be used to generate code
19188 that is compatible with functions compiled with older versions of
19189 GCC.
19191 The @option{-mno-compat-align-parm} option is the default.
19192 @end table
19194 @node RX Options
19195 @subsection RX Options
19196 @cindex RX Options
19198 These command-line options are defined for RX targets:
19200 @table @gcctabopt
19201 @item -m64bit-doubles
19202 @itemx -m32bit-doubles
19203 @opindex m64bit-doubles
19204 @opindex m32bit-doubles
19205 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19206 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19207 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
19208 works on 32-bit values, which is why the default is
19209 @option{-m32bit-doubles}.
19211 @item -fpu
19212 @itemx -nofpu
19213 @opindex fpu
19214 @opindex nofpu
19215 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
19216 floating-point hardware.  The default is enabled for the @var{RX600}
19217 series and disabled for the @var{RX200} series.
19219 Floating-point instructions are only generated for 32-bit floating-point 
19220 values, however, so the FPU hardware is not used for doubles if the
19221 @option{-m64bit-doubles} option is used.
19223 @emph{Note} If the @option{-fpu} option is enabled then
19224 @option{-funsafe-math-optimizations} is also enabled automatically.
19225 This is because the RX FPU instructions are themselves unsafe.
19227 @item -mcpu=@var{name}
19228 @opindex -mcpu
19229 Selects the type of RX CPU to be targeted.  Currently three types are
19230 supported, the generic @var{RX600} and @var{RX200} series hardware and
19231 the specific @var{RX610} CPU.  The default is @var{RX600}.
19233 The only difference between @var{RX600} and @var{RX610} is that the
19234 @var{RX610} does not support the @code{MVTIPL} instruction.
19236 The @var{RX200} series does not have a hardware floating-point unit
19237 and so @option{-nofpu} is enabled by default when this type is
19238 selected.
19240 @item -mbig-endian-data
19241 @itemx -mlittle-endian-data
19242 @opindex mbig-endian-data
19243 @opindex mlittle-endian-data
19244 Store data (but not code) in the big-endian format.  The default is
19245 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
19246 format.
19248 @item -msmall-data-limit=@var{N}
19249 @opindex msmall-data-limit
19250 Specifies the maximum size in bytes of global and static variables
19251 which can be placed into the small data area.  Using the small data
19252 area can lead to smaller and faster code, but the size of area is
19253 limited and it is up to the programmer to ensure that the area does
19254 not overflow.  Also when the small data area is used one of the RX's
19255 registers (usually @code{r13}) is reserved for use pointing to this
19256 area, so it is no longer available for use by the compiler.  This
19257 could result in slower and/or larger code if variables are pushed onto
19258 the stack instead of being held in this register.
19260 Note, common variables (variables that have not been initialized) and
19261 constants are not placed into the small data area as they are assigned
19262 to other sections in the output executable.
19264 The default value is zero, which disables this feature.  Note, this
19265 feature is not enabled by default with higher optimization levels
19266 (@option{-O2} etc) because of the potentially detrimental effects of
19267 reserving a register.  It is up to the programmer to experiment and
19268 discover whether this feature is of benefit to their program.  See the
19269 description of the @option{-mpid} option for a description of how the
19270 actual register to hold the small data area pointer is chosen.
19272 @item -msim
19273 @itemx -mno-sim
19274 @opindex msim
19275 @opindex mno-sim
19276 Use the simulator runtime.  The default is to use the libgloss
19277 board-specific runtime.
19279 @item -mas100-syntax
19280 @itemx -mno-as100-syntax
19281 @opindex mas100-syntax
19282 @opindex mno-as100-syntax
19283 When generating assembler output use a syntax that is compatible with
19284 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
19285 assembler, but it has some restrictions so it is not generated by default.
19287 @item -mmax-constant-size=@var{N}
19288 @opindex mmax-constant-size
19289 Specifies the maximum size, in bytes, of a constant that can be used as
19290 an operand in a RX instruction.  Although the RX instruction set does
19291 allow constants of up to 4 bytes in length to be used in instructions,
19292 a longer value equates to a longer instruction.  Thus in some
19293 circumstances it can be beneficial to restrict the size of constants
19294 that are used in instructions.  Constants that are too big are instead
19295 placed into a constant pool and referenced via register indirection.
19297 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
19298 or 4 means that constants of any size are allowed.
19300 @item -mrelax
19301 @opindex mrelax
19302 Enable linker relaxation.  Linker relaxation is a process whereby the
19303 linker attempts to reduce the size of a program by finding shorter
19304 versions of various instructions.  Disabled by default.
19306 @item -mint-register=@var{N}
19307 @opindex mint-register
19308 Specify the number of registers to reserve for fast interrupt handler
19309 functions.  The value @var{N} can be between 0 and 4.  A value of 1
19310 means that register @code{r13} is reserved for the exclusive use
19311 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
19312 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
19313 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
19314 A value of 0, the default, does not reserve any registers.
19316 @item -msave-acc-in-interrupts
19317 @opindex msave-acc-in-interrupts
19318 Specifies that interrupt handler functions should preserve the
19319 accumulator register.  This is only necessary if normal code might use
19320 the accumulator register, for example because it performs 64-bit
19321 multiplications.  The default is to ignore the accumulator as this
19322 makes the interrupt handlers faster.
19324 @item -mpid
19325 @itemx -mno-pid
19326 @opindex mpid
19327 @opindex mno-pid
19328 Enables the generation of position independent data.  When enabled any
19329 access to constant data is done via an offset from a base address
19330 held in a register.  This allows the location of constant data to be
19331 determined at run time without requiring the executable to be
19332 relocated, which is a benefit to embedded applications with tight
19333 memory constraints.  Data that can be modified is not affected by this
19334 option.
19336 Note, using this feature reserves a register, usually @code{r13}, for
19337 the constant data base address.  This can result in slower and/or
19338 larger code, especially in complicated functions.
19340 The actual register chosen to hold the constant data base address
19341 depends upon whether the @option{-msmall-data-limit} and/or the
19342 @option{-mint-register} command-line options are enabled.  Starting
19343 with register @code{r13} and proceeding downwards, registers are
19344 allocated first to satisfy the requirements of @option{-mint-register},
19345 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
19346 is possible for the small data area register to be @code{r8} if both
19347 @option{-mint-register=4} and @option{-mpid} are specified on the
19348 command line.
19350 By default this feature is not enabled.  The default can be restored
19351 via the @option{-mno-pid} command-line option.
19353 @item -mno-warn-multiple-fast-interrupts
19354 @itemx -mwarn-multiple-fast-interrupts
19355 @opindex mno-warn-multiple-fast-interrupts
19356 @opindex mwarn-multiple-fast-interrupts
19357 Prevents GCC from issuing a warning message if it finds more than one
19358 fast interrupt handler when it is compiling a file.  The default is to
19359 issue a warning for each extra fast interrupt handler found, as the RX
19360 only supports one such interrupt.
19362 @end table
19364 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
19365 has special significance to the RX port when used with the
19366 @code{interrupt} function attribute.  This attribute indicates a
19367 function intended to process fast interrupts.  GCC ensures
19368 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
19369 and/or @code{r13} and only provided that the normal use of the
19370 corresponding registers have been restricted via the
19371 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
19372 options.
19374 @node S/390 and zSeries Options
19375 @subsection S/390 and zSeries Options
19376 @cindex S/390 and zSeries Options
19378 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
19380 @table @gcctabopt
19381 @item -mhard-float
19382 @itemx -msoft-float
19383 @opindex mhard-float
19384 @opindex msoft-float
19385 Use (do not use) the hardware floating-point instructions and registers
19386 for floating-point operations.  When @option{-msoft-float} is specified,
19387 functions in @file{libgcc.a} are used to perform floating-point
19388 operations.  When @option{-mhard-float} is specified, the compiler
19389 generates IEEE floating-point instructions.  This is the default.
19391 @item -mhard-dfp
19392 @itemx -mno-hard-dfp
19393 @opindex mhard-dfp
19394 @opindex mno-hard-dfp
19395 Use (do not use) the hardware decimal-floating-point instructions for
19396 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
19397 specified, functions in @file{libgcc.a} are used to perform
19398 decimal-floating-point operations.  When @option{-mhard-dfp} is
19399 specified, the compiler generates decimal-floating-point hardware
19400 instructions.  This is the default for @option{-march=z9-ec} or higher.
19402 @item -mlong-double-64
19403 @itemx -mlong-double-128
19404 @opindex mlong-double-64
19405 @opindex mlong-double-128
19406 These switches control the size of @code{long double} type. A size
19407 of 64 bits makes the @code{long double} type equivalent to the @code{double}
19408 type. This is the default.
19410 @item -mbackchain
19411 @itemx -mno-backchain
19412 @opindex mbackchain
19413 @opindex mno-backchain
19414 Store (do not store) the address of the caller's frame as backchain pointer
19415 into the callee's stack frame.
19416 A backchain may be needed to allow debugging using tools that do not understand
19417 DWARF 2 call frame information.
19418 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
19419 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
19420 the backchain is placed into the topmost word of the 96/160 byte register
19421 save area.
19423 In general, code compiled with @option{-mbackchain} is call-compatible with
19424 code compiled with @option{-mmo-backchain}; however, use of the backchain
19425 for debugging purposes usually requires that the whole binary is built with
19426 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
19427 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
19428 to build a linux kernel use @option{-msoft-float}.
19430 The default is to not maintain the backchain.
19432 @item -mpacked-stack
19433 @itemx -mno-packed-stack
19434 @opindex mpacked-stack
19435 @opindex mno-packed-stack
19436 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
19437 specified, the compiler uses the all fields of the 96/160 byte register save
19438 area only for their default purpose; unused fields still take up stack space.
19439 When @option{-mpacked-stack} is specified, register save slots are densely
19440 packed at the top of the register save area; unused space is reused for other
19441 purposes, allowing for more efficient use of the available stack space.
19442 However, when @option{-mbackchain} is also in effect, the topmost word of
19443 the save area is always used to store the backchain, and the return address
19444 register is always saved two words below the backchain.
19446 As long as the stack frame backchain is not used, code generated with
19447 @option{-mpacked-stack} is call-compatible with code generated with
19448 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
19449 S/390 or zSeries generated code that uses the stack frame backchain at run
19450 time, not just for debugging purposes.  Such code is not call-compatible
19451 with code compiled with @option{-mpacked-stack}.  Also, note that the
19452 combination of @option{-mbackchain},
19453 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
19454 to build a linux kernel use @option{-msoft-float}.
19456 The default is to not use the packed stack layout.
19458 @item -msmall-exec
19459 @itemx -mno-small-exec
19460 @opindex msmall-exec
19461 @opindex mno-small-exec
19462 Generate (or do not generate) code using the @code{bras} instruction
19463 to do subroutine calls.
19464 This only works reliably if the total executable size does not
19465 exceed 64k.  The default is to use the @code{basr} instruction instead,
19466 which does not have this limitation.
19468 @item -m64
19469 @itemx -m31
19470 @opindex m64
19471 @opindex m31
19472 When @option{-m31} is specified, generate code compliant to the
19473 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
19474 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
19475 particular to generate 64-bit instructions.  For the @samp{s390}
19476 targets, the default is @option{-m31}, while the @samp{s390x}
19477 targets default to @option{-m64}.
19479 @item -mzarch
19480 @itemx -mesa
19481 @opindex mzarch
19482 @opindex mesa
19483 When @option{-mzarch} is specified, generate code using the
19484 instructions available on z/Architecture.
19485 When @option{-mesa} is specified, generate code using the
19486 instructions available on ESA/390.  Note that @option{-mesa} is
19487 not possible with @option{-m64}.
19488 When generating code compliant to the GNU/Linux for S/390 ABI,
19489 the default is @option{-mesa}.  When generating code compliant
19490 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
19492 @item -mmvcle
19493 @itemx -mno-mvcle
19494 @opindex mmvcle
19495 @opindex mno-mvcle
19496 Generate (or do not generate) code using the @code{mvcle} instruction
19497 to perform block moves.  When @option{-mno-mvcle} is specified,
19498 use a @code{mvc} loop instead.  This is the default unless optimizing for
19499 size.
19501 @item -mdebug
19502 @itemx -mno-debug
19503 @opindex mdebug
19504 @opindex mno-debug
19505 Print (or do not print) additional debug information when compiling.
19506 The default is to not print debug information.
19508 @item -march=@var{cpu-type}
19509 @opindex march
19510 Generate code that runs on @var{cpu-type}, which is the name of a system
19511 representing a certain processor type.  Possible values for
19512 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
19513 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
19514 When generating code using the instructions available on z/Architecture,
19515 the default is @option{-march=z900}.  Otherwise, the default is
19516 @option{-march=g5}.
19518 @item -mtune=@var{cpu-type}
19519 @opindex mtune
19520 Tune to @var{cpu-type} everything applicable about the generated code,
19521 except for the ABI and the set of available instructions.
19522 The list of @var{cpu-type} values is the same as for @option{-march}.
19523 The default is the value used for @option{-march}.
19525 @item -mtpf-trace
19526 @itemx -mno-tpf-trace
19527 @opindex mtpf-trace
19528 @opindex mno-tpf-trace
19529 Generate code that adds (does not add) in TPF OS specific branches to trace
19530 routines in the operating system.  This option is off by default, even
19531 when compiling for the TPF OS@.
19533 @item -mfused-madd
19534 @itemx -mno-fused-madd
19535 @opindex mfused-madd
19536 @opindex mno-fused-madd
19537 Generate code that uses (does not use) the floating-point multiply and
19538 accumulate instructions.  These instructions are generated by default if
19539 hardware floating point is used.
19541 @item -mwarn-framesize=@var{framesize}
19542 @opindex mwarn-framesize
19543 Emit a warning if the current function exceeds the given frame size.  Because
19544 this is a compile-time check it doesn't need to be a real problem when the program
19545 runs.  It is intended to identify functions that most probably cause
19546 a stack overflow.  It is useful to be used in an environment with limited stack
19547 size e.g.@: the linux kernel.
19549 @item -mwarn-dynamicstack
19550 @opindex mwarn-dynamicstack
19551 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
19552 arrays.  This is generally a bad idea with a limited stack size.
19554 @item -mstack-guard=@var{stack-guard}
19555 @itemx -mstack-size=@var{stack-size}
19556 @opindex mstack-guard
19557 @opindex mstack-size
19558 If these options are provided the S/390 back end emits additional instructions in
19559 the function prologue that trigger a trap if the stack size is @var{stack-guard}
19560 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
19561 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
19562 the frame size of the compiled function is chosen.
19563 These options are intended to be used to help debugging stack overflow problems.
19564 The additionally emitted code causes only little overhead and hence can also be
19565 used in production-like systems without greater performance degradation.  The given
19566 values have to be exact powers of 2 and @var{stack-size} has to be greater than
19567 @var{stack-guard} without exceeding 64k.
19568 In order to be efficient the extra code makes the assumption that the stack starts
19569 at an address aligned to the value given by @var{stack-size}.
19570 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
19571 @end table
19573 @node Score Options
19574 @subsection Score Options
19575 @cindex Score Options
19577 These options are defined for Score implementations:
19579 @table @gcctabopt
19580 @item -meb
19581 @opindex meb
19582 Compile code for big-endian mode.  This is the default.
19584 @item -mel
19585 @opindex mel
19586 Compile code for little-endian mode.
19588 @item -mnhwloop
19589 @opindex mnhwloop
19590 Disable generation of @code{bcnz} instructions.
19592 @item -muls
19593 @opindex muls
19594 Enable generation of unaligned load and store instructions.
19596 @item -mmac
19597 @opindex mmac
19598 Enable the use of multiply-accumulate instructions. Disabled by default.
19600 @item -mscore5
19601 @opindex mscore5
19602 Specify the SCORE5 as the target architecture.
19604 @item -mscore5u
19605 @opindex mscore5u
19606 Specify the SCORE5U of the target architecture.
19608 @item -mscore7
19609 @opindex mscore7
19610 Specify the SCORE7 as the target architecture. This is the default.
19612 @item -mscore7d
19613 @opindex mscore7d
19614 Specify the SCORE7D as the target architecture.
19615 @end table
19617 @node SH Options
19618 @subsection SH Options
19620 These @samp{-m} options are defined for the SH implementations:
19622 @table @gcctabopt
19623 @item -m1
19624 @opindex m1
19625 Generate code for the SH1.
19627 @item -m2
19628 @opindex m2
19629 Generate code for the SH2.
19631 @item -m2e
19632 Generate code for the SH2e.
19634 @item -m2a-nofpu
19635 @opindex m2a-nofpu
19636 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
19637 that the floating-point unit is not used.
19639 @item -m2a-single-only
19640 @opindex m2a-single-only
19641 Generate code for the SH2a-FPU, in such a way that no double-precision
19642 floating-point operations are used.
19644 @item -m2a-single
19645 @opindex m2a-single
19646 Generate code for the SH2a-FPU assuming the floating-point unit is in
19647 single-precision mode by default.
19649 @item -m2a
19650 @opindex m2a
19651 Generate code for the SH2a-FPU assuming the floating-point unit is in
19652 double-precision mode by default.
19654 @item -m3
19655 @opindex m3
19656 Generate code for the SH3.
19658 @item -m3e
19659 @opindex m3e
19660 Generate code for the SH3e.
19662 @item -m4-nofpu
19663 @opindex m4-nofpu
19664 Generate code for the SH4 without a floating-point unit.
19666 @item -m4-single-only
19667 @opindex m4-single-only
19668 Generate code for the SH4 with a floating-point unit that only
19669 supports single-precision arithmetic.
19671 @item -m4-single
19672 @opindex m4-single
19673 Generate code for the SH4 assuming the floating-point unit is in
19674 single-precision mode by default.
19676 @item -m4
19677 @opindex m4
19678 Generate code for the SH4.
19680 @item -m4a-nofpu
19681 @opindex m4a-nofpu
19682 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
19683 floating-point unit is not used.
19685 @item -m4a-single-only
19686 @opindex m4a-single-only
19687 Generate code for the SH4a, in such a way that no double-precision
19688 floating-point operations are used.
19690 @item -m4a-single
19691 @opindex m4a-single
19692 Generate code for the SH4a assuming the floating-point unit is in
19693 single-precision mode by default.
19695 @item -m4a
19696 @opindex m4a
19697 Generate code for the SH4a.
19699 @item -m4al
19700 @opindex m4al
19701 Same as @option{-m4a-nofpu}, except that it implicitly passes
19702 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
19703 instructions at the moment.
19705 @item -mb
19706 @opindex mb
19707 Compile code for the processor in big-endian mode.
19709 @item -ml
19710 @opindex ml
19711 Compile code for the processor in little-endian mode.
19713 @item -mdalign
19714 @opindex mdalign
19715 Align doubles at 64-bit boundaries.  Note that this changes the calling
19716 conventions, and thus some functions from the standard C library do
19717 not work unless you recompile it first with @option{-mdalign}.
19719 @item -mrelax
19720 @opindex mrelax
19721 Shorten some address references at link time, when possible; uses the
19722 linker option @option{-relax}.
19724 @item -mbigtable
19725 @opindex mbigtable
19726 Use 32-bit offsets in @code{switch} tables.  The default is to use
19727 16-bit offsets.
19729 @item -mbitops
19730 @opindex mbitops
19731 Enable the use of bit manipulation instructions on SH2A.
19733 @item -mfmovd
19734 @opindex mfmovd
19735 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
19736 alignment constraints.
19738 @item -mhitachi
19739 @opindex mhitachi
19740 Comply with the calling conventions defined by Renesas.
19742 @item -mrenesas
19743 @opindex mhitachi
19744 Comply with the calling conventions defined by Renesas.
19746 @item -mno-renesas
19747 @opindex mhitachi
19748 Comply with the calling conventions defined for GCC before the Renesas
19749 conventions were available.  This option is the default for all
19750 targets of the SH toolchain.
19752 @item -mnomacsave
19753 @opindex mnomacsave
19754 Mark the @code{MAC} register as call-clobbered, even if
19755 @option{-mhitachi} is given.
19757 @item -mieee
19758 @itemx -mno-ieee
19759 @opindex mieee
19760 @opindex mnoieee
19761 Control the IEEE compliance of floating-point comparisons, which affects the
19762 handling of cases where the result of a comparison is unordered.  By default
19763 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
19764 enabled @option{-mno-ieee} is implicitly set, which results in faster
19765 floating-point greater-equal and less-equal comparisons.  The implcit settings
19766 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
19768 @item -minline-ic_invalidate
19769 @opindex minline-ic_invalidate
19770 Inline code to invalidate instruction cache entries after setting up
19771 nested function trampolines.
19772 This option has no effect if @option{-musermode} is in effect and the selected
19773 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
19774 instruction.
19775 If the selected code generation option does not allow the use of the @code{icbi}
19776 instruction, and @option{-musermode} is not in effect, the inlined code
19777 manipulates the instruction cache address array directly with an associative
19778 write.  This not only requires privileged mode at run time, but it also
19779 fails if the cache line had been mapped via the TLB and has become unmapped.
19781 @item -misize
19782 @opindex misize
19783 Dump instruction size and location in the assembly code.
19785 @item -mpadstruct
19786 @opindex mpadstruct
19787 This option is deprecated.  It pads structures to multiple of 4 bytes,
19788 which is incompatible with the SH ABI@.
19790 @item -matomic-model=@var{model}
19791 @opindex matomic-model=@var{model}
19792 Sets the model of atomic operations and additional parameters as a comma
19793 separated list.  For details on the atomic built-in functions see
19794 @ref{__atomic Builtins}.  The following models and parameters are supported:
19796 @table @samp
19798 @item none
19799 Disable compiler generated atomic sequences and emit library calls for atomic
19800 operations.  This is the default if the target is not @code{sh-*-linux*}.
19802 @item soft-gusa
19803 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
19804 built-in functions.  The generated atomic sequences require additional support
19805 from the interrupt/exception handling code of the system and are only suitable
19806 for SH3* and SH4* single-core systems.  This option is enabled by default when
19807 the target is @code{sh-*-linux*} and SH3* or SH4*.  When the target is SH4A,
19808 this option will also partially utilize the hardware atomic instructions
19809 @code{movli.l} and @code{movco.l} to create more efficient code, unless
19810 @samp{strict} is specified.  
19812 @item soft-tcb
19813 Generate software atomic sequences that use a variable in the thread control
19814 block.  This is a variation of the gUSA sequences which can also be used on
19815 SH1* and SH2* targets.  The generated atomic sequences require additional
19816 support from the interrupt/exception handling code of the system and are only
19817 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
19818 parameter has to be specified as well.
19820 @item soft-imask
19821 Generate software atomic sequences that temporarily disable interrupts by
19822 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
19823 in privileged mode and is only suitable for single-core systems.  Additional
19824 support from the interrupt/exception handling code of the system is not
19825 required.  This model is enabled by default when the target is
19826 @code{sh-*-linux*} and SH1* or SH2*.
19828 @item hard-llcs
19829 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
19830 instructions only.  This is only available on SH4A and is suitable for
19831 multi-core systems.  Since the hardware instructions support only 32 bit atomic
19832 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
19833 Code compiled with this option will also be compatible with other software
19834 atomic model interrupt/exception handling systems if executed on an SH4A
19835 system.  Additional support from the interrupt/exception handling code of the
19836 system is not required for this model.
19838 @item gbr-offset=
19839 This parameter specifies the offset in bytes of the variable in the thread
19840 control block structure that should be used by the generated atomic sequences
19841 when the @samp{soft-tcb} model has been selected.  For other models this
19842 parameter is ignored.  The specified value must be an integer multiple of four
19843 and in the range 0-1020.
19845 @item strict
19846 This parameter prevents mixed usage of multiple atomic models, even though they
19847 would be compatible, and will make the compiler generate atomic sequences of the
19848 specified model only.
19850 @end table
19852 @item -mtas
19853 @opindex mtas
19854 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
19855 Notice that depending on the particular hardware and software configuration
19856 this can degrade overall performance due to the operand cache line flushes
19857 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
19858 processors the @code{tas.b} instruction must be used with caution since it
19859 can result in data corruption for certain cache configurations.
19861 @item -mspace
19862 @opindex mspace
19863 Optimize for space instead of speed.  Implied by @option{-Os}.
19865 @item -mprefergot
19866 @opindex mprefergot
19867 When generating position-independent code, emit function calls using
19868 the Global Offset Table instead of the Procedure Linkage Table.
19870 @item -musermode
19871 @opindex musermode
19872 Don't generate privileged mode only code.  This option
19873 implies @option{-mno-inline-ic_invalidate}
19874 if the inlined code would not work in user mode.
19875 This is the default when the target is @code{sh-*-linux*}.
19877 @item -multcost=@var{number}
19878 @opindex multcost=@var{number}
19879 Set the cost to assume for a multiply insn.
19881 @item -mdiv=@var{strategy}
19882 @opindex mdiv=@var{strategy}
19883 Set the division strategy to be used for integer division operations.
19884 For SHmedia @var{strategy} can be one of: 
19886 @table @samp
19888 @item fp 
19889 Performs the operation in floating point.  This has a very high latency,
19890 but needs only a few instructions, so it might be a good choice if
19891 your code has enough easily-exploitable ILP to allow the compiler to
19892 schedule the floating-point instructions together with other instructions.
19893 Division by zero causes a floating-point exception.
19895 @item inv
19896 Uses integer operations to calculate the inverse of the divisor,
19897 and then multiplies the dividend with the inverse.  This strategy allows
19898 CSE and hoisting of the inverse calculation.  Division by zero calculates
19899 an unspecified result, but does not trap.
19901 @item inv:minlat
19902 A variant of @samp{inv} where, if no CSE or hoisting opportunities
19903 have been found, or if the entire operation has been hoisted to the same
19904 place, the last stages of the inverse calculation are intertwined with the
19905 final multiply to reduce the overall latency, at the expense of using a few
19906 more instructions, and thus offering fewer scheduling opportunities with
19907 other code.
19909 @item call
19910 Calls a library function that usually implements the @samp{inv:minlat}
19911 strategy.
19912 This gives high code density for @code{m5-*media-nofpu} compilations.
19914 @item call2
19915 Uses a different entry point of the same library function, where it
19916 assumes that a pointer to a lookup table has already been set up, which
19917 exposes the pointer load to CSE and code hoisting optimizations.
19919 @item inv:call
19920 @itemx inv:call2
19921 @itemx inv:fp
19922 Use the @samp{inv} algorithm for initial
19923 code generation, but if the code stays unoptimized, revert to the @samp{call},
19924 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
19925 potentially-trapping side effect of division by zero is carried by a
19926 separate instruction, so it is possible that all the integer instructions
19927 are hoisted out, but the marker for the side effect stays where it is.
19928 A recombination to floating-point operations or a call is not possible
19929 in that case.
19931 @item inv20u
19932 @itemx inv20l
19933 Variants of the @samp{inv:minlat} strategy.  In the case
19934 that the inverse calculation is not separated from the multiply, they speed
19935 up division where the dividend fits into 20 bits (plus sign where applicable)
19936 by inserting a test to skip a number of operations in this case; this test
19937 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
19938 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
19940 @end table
19942 For targets other than SHmedia @var{strategy} can be one of:
19944 @table @samp
19946 @item call-div1
19947 Calls a library function that uses the single-step division instruction
19948 @code{div1} to perform the operation.  Division by zero calculates an
19949 unspecified result and does not trap.  This is the default except for SH4,
19950 SH2A and SHcompact.
19952 @item call-fp
19953 Calls a library function that performs the operation in double precision
19954 floating point.  Division by zero causes a floating-point exception.  This is
19955 the default for SHcompact with FPU.  Specifying this for targets that do not
19956 have a double precision FPU will default to @code{call-div1}.
19958 @item call-table
19959 Calls a library function that uses a lookup table for small divisors and
19960 the @code{div1} instruction with case distinction for larger divisors.  Division
19961 by zero calculates an unspecified result and does not trap.  This is the default
19962 for SH4.  Specifying this for targets that do not have dynamic shift
19963 instructions will default to @code{call-div1}.
19965 @end table
19967 When a division strategy has not been specified the default strategy will be
19968 selected based on the current target.  For SH2A the default strategy is to
19969 use the @code{divs} and @code{divu} instructions instead of library function
19970 calls.
19972 @item -maccumulate-outgoing-args
19973 @opindex maccumulate-outgoing-args
19974 Reserve space once for outgoing arguments in the function prologue rather
19975 than around each call.  Generally beneficial for performance and size.  Also
19976 needed for unwinding to avoid changing the stack frame around conditional code.
19978 @item -mdivsi3_libfunc=@var{name}
19979 @opindex mdivsi3_libfunc=@var{name}
19980 Set the name of the library function used for 32-bit signed division to
19981 @var{name}.
19982 This only affects the name used in the @samp{call} and @samp{inv:call}
19983 division strategies, and the compiler still expects the same
19984 sets of input/output/clobbered registers as if this option were not present.
19986 @item -mfixed-range=@var{register-range}
19987 @opindex mfixed-range
19988 Generate code treating the given register range as fixed registers.
19989 A fixed register is one that the register allocator can not use.  This is
19990 useful when compiling kernel code.  A register range is specified as
19991 two registers separated by a dash.  Multiple register ranges can be
19992 specified separated by a comma.
19994 @item -mindexed-addressing
19995 @opindex mindexed-addressing
19996 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
19997 This is only safe if the hardware and/or OS implement 32-bit wrap-around
19998 semantics for the indexed addressing mode.  The architecture allows the
19999 implementation of processors with 64-bit MMU, which the OS could use to
20000 get 32-bit addressing, but since no current hardware implementation supports
20001 this or any other way to make the indexed addressing mode safe to use in
20002 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
20004 @item -mgettrcost=@var{number}
20005 @opindex mgettrcost=@var{number}
20006 Set the cost assumed for the @code{gettr} instruction to @var{number}.
20007 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
20009 @item -mpt-fixed
20010 @opindex mpt-fixed
20011 Assume @code{pt*} instructions won't trap.  This generally generates
20012 better-scheduled code, but is unsafe on current hardware.
20013 The current architecture
20014 definition says that @code{ptabs} and @code{ptrel} trap when the target 
20015 anded with 3 is 3.
20016 This has the unintentional effect of making it unsafe to schedule these
20017 instructions before a branch, or hoist them out of a loop.  For example,
20018 @code{__do_global_ctors}, a part of @file{libgcc}
20019 that runs constructors at program
20020 startup, calls functions in a list which is delimited by @minus{}1.  With the
20021 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
20022 That means that all the constructors run a bit more quickly, but when
20023 the loop comes to the end of the list, the program crashes because @code{ptabs}
20024 loads @minus{}1 into a target register.  
20026 Since this option is unsafe for any
20027 hardware implementing the current architecture specification, the default
20028 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
20029 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
20030 this deters register allocation from using target registers for storing
20031 ordinary integers.
20033 @item -minvalid-symbols
20034 @opindex minvalid-symbols
20035 Assume symbols might be invalid.  Ordinary function symbols generated by
20036 the compiler are always valid to load with
20037 @code{movi}/@code{shori}/@code{ptabs} or
20038 @code{movi}/@code{shori}/@code{ptrel},
20039 but with assembler and/or linker tricks it is possible
20040 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
20041 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
20042 It prevents cross-basic-block CSE, hoisting and most scheduling
20043 of symbol loads.  The default is @option{-mno-invalid-symbols}.
20045 @item -mbranch-cost=@var{num}
20046 @opindex mbranch-cost=@var{num}
20047 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
20048 make the compiler try to generate more branch-free code if possible.  
20049 If not specified the value is selected depending on the processor type that
20050 is being compiled for.
20052 @item -mzdcbranch
20053 @itemx -mno-zdcbranch
20054 @opindex mzdcbranch
20055 @opindex mno-zdcbranch
20056 Assume (do not assume) that zero displacement conditional branch instructions
20057 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
20058 compiler will try to prefer zero displacement branch code sequences.  This is
20059 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
20060 disabled by specifying @option{-mno-zdcbranch}.
20062 @item -mcbranchdi
20063 @opindex mcbranchdi
20064 Enable the @code{cbranchdi4} instruction pattern.
20066 @item -mcmpeqdi
20067 @opindex mcmpeqdi
20068 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
20069 is in effect.
20071 @item -mfused-madd
20072 @itemx -mno-fused-madd
20073 @opindex mfused-madd
20074 @opindex mno-fused-madd
20075 Generate code that uses (does not use) the floating-point multiply and
20076 accumulate instructions.  These instructions are generated by default
20077 if hardware floating point is used.  The machine-dependent
20078 @option{-mfused-madd} option is now mapped to the machine-independent
20079 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20080 mapped to @option{-ffp-contract=off}.
20082 @item -mfsca
20083 @itemx -mno-fsca
20084 @opindex mfsca
20085 @opindex mno-fsca
20086 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
20087 and cosine approximations.  The option @code{-mfsca} must be used in
20088 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
20089 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
20090 approximations even if @code{-funsafe-math-optimizations} is in effect.
20092 @item -mfsrra
20093 @itemx -mno-fsrra
20094 @opindex mfsrra
20095 @opindex mno-fsrra
20096 Allow or disallow the compiler to emit the @code{fsrra} instruction for
20097 reciprocal square root approximations.  The option @code{-mfsrra} must be used
20098 in combination with @code{-funsafe-math-optimizations} and
20099 @code{-ffinite-math-only}.  It is enabled by default when generating code for
20100 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
20101 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
20102 in effect.
20104 @item -mpretend-cmove
20105 @opindex mpretend-cmove
20106 Prefer zero-displacement conditional branches for conditional move instruction
20107 patterns.  This can result in faster code on the SH4 processor.
20109 @end table
20111 @node Solaris 2 Options
20112 @subsection Solaris 2 Options
20113 @cindex Solaris 2 options
20115 These @samp{-m} options are supported on Solaris 2:
20117 @table @gcctabopt
20118 @item -mimpure-text
20119 @opindex mimpure-text
20120 @option{-mimpure-text}, used in addition to @option{-shared}, tells
20121 the compiler to not pass @option{-z text} to the linker when linking a
20122 shared object.  Using this option, you can link position-dependent
20123 code into a shared object.
20125 @option{-mimpure-text} suppresses the ``relocations remain against
20126 allocatable but non-writable sections'' linker error message.
20127 However, the necessary relocations trigger copy-on-write, and the
20128 shared object is not actually shared across processes.  Instead of
20129 using @option{-mimpure-text}, you should compile all source code with
20130 @option{-fpic} or @option{-fPIC}.
20132 @end table
20134 These switches are supported in addition to the above on Solaris 2:
20136 @table @gcctabopt
20137 @item -pthreads
20138 @opindex pthreads
20139 Add support for multithreading using the POSIX threads library.  This
20140 option sets flags for both the preprocessor and linker.  This option does
20141 not affect the thread safety of object code produced  by the compiler or
20142 that of libraries supplied with it.
20144 @item -pthread
20145 @opindex pthread
20146 This is a synonym for @option{-pthreads}.
20147 @end table
20149 @node SPARC Options
20150 @subsection SPARC Options
20151 @cindex SPARC options
20153 These @samp{-m} options are supported on the SPARC:
20155 @table @gcctabopt
20156 @item -mno-app-regs
20157 @itemx -mapp-regs
20158 @opindex mno-app-regs
20159 @opindex mapp-regs
20160 Specify @option{-mapp-regs} to generate output using the global registers
20161 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
20162 is the default.
20164 To be fully SVR4 ABI-compliant at the cost of some performance loss,
20165 specify @option{-mno-app-regs}.  You should compile libraries and system
20166 software with this option.
20168 @item -mflat
20169 @itemx -mno-flat
20170 @opindex mflat
20171 @opindex mno-flat
20172 With @option{-mflat}, the compiler does not generate save/restore instructions
20173 and uses a ``flat'' or single register window model.  This model is compatible
20174 with the regular register window model.  The local registers and the input
20175 registers (0--5) are still treated as ``call-saved'' registers and are
20176 saved on the stack as needed.
20178 With @option{-mno-flat} (the default), the compiler generates save/restore
20179 instructions (except for leaf functions).  This is the normal operating mode.
20181 @item -mfpu
20182 @itemx -mhard-float
20183 @opindex mfpu
20184 @opindex mhard-float
20185 Generate output containing floating-point instructions.  This is the
20186 default.
20188 @item -mno-fpu
20189 @itemx -msoft-float
20190 @opindex mno-fpu
20191 @opindex msoft-float
20192 Generate output containing library calls for floating point.
20193 @strong{Warning:} the requisite libraries are not available for all SPARC
20194 targets.  Normally the facilities of the machine's usual C compiler are
20195 used, but this cannot be done directly in cross-compilation.  You must make
20196 your own arrangements to provide suitable library functions for
20197 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
20198 @samp{sparclite-*-*} do provide software floating-point support.
20200 @option{-msoft-float} changes the calling convention in the output file;
20201 therefore, it is only useful if you compile @emph{all} of a program with
20202 this option.  In particular, you need to compile @file{libgcc.a}, the
20203 library that comes with GCC, with @option{-msoft-float} in order for
20204 this to work.
20206 @item -mhard-quad-float
20207 @opindex mhard-quad-float
20208 Generate output containing quad-word (long double) floating-point
20209 instructions.
20211 @item -msoft-quad-float
20212 @opindex msoft-quad-float
20213 Generate output containing library calls for quad-word (long double)
20214 floating-point instructions.  The functions called are those specified
20215 in the SPARC ABI@.  This is the default.
20217 As of this writing, there are no SPARC implementations that have hardware
20218 support for the quad-word floating-point instructions.  They all invoke
20219 a trap handler for one of these instructions, and then the trap handler
20220 emulates the effect of the instruction.  Because of the trap handler overhead,
20221 this is much slower than calling the ABI library routines.  Thus the
20222 @option{-msoft-quad-float} option is the default.
20224 @item -mno-unaligned-doubles
20225 @itemx -munaligned-doubles
20226 @opindex mno-unaligned-doubles
20227 @opindex munaligned-doubles
20228 Assume that doubles have 8-byte alignment.  This is the default.
20230 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
20231 alignment only if they are contained in another type, or if they have an
20232 absolute address.  Otherwise, it assumes they have 4-byte alignment.
20233 Specifying this option avoids some rare compatibility problems with code
20234 generated by other compilers.  It is not the default because it results
20235 in a performance loss, especially for floating-point code.
20237 @item -mno-faster-structs
20238 @itemx -mfaster-structs
20239 @opindex mno-faster-structs
20240 @opindex mfaster-structs
20241 With @option{-mfaster-structs}, the compiler assumes that structures
20242 should have 8-byte alignment.  This enables the use of pairs of
20243 @code{ldd} and @code{std} instructions for copies in structure
20244 assignment, in place of twice as many @code{ld} and @code{st} pairs.
20245 However, the use of this changed alignment directly violates the SPARC
20246 ABI@.  Thus, it's intended only for use on targets where the developer
20247 acknowledges that their resulting code is not directly in line with
20248 the rules of the ABI@.
20250 @item -mcpu=@var{cpu_type}
20251 @opindex mcpu
20252 Set the instruction set, register set, and instruction scheduling parameters
20253 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
20254 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
20255 @samp{leon}, @samp{leon3}, @samp{sparclite}, @samp{f930}, @samp{f934},
20256 @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
20257 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
20258 @samp{niagara3} and @samp{niagara4}.
20260 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
20261 which selects the best architecture option for the host processor.
20262 @option{-mcpu=native} has no effect if GCC does not recognize
20263 the processor.
20265 Default instruction scheduling parameters are used for values that select
20266 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
20267 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
20269 Here is a list of each supported architecture and their supported
20270 implementations.
20272 @table @asis
20273 @item v7
20274 cypress
20276 @item v8
20277 supersparc, hypersparc, leon, leon3
20279 @item sparclite
20280 f930, f934, sparclite86x
20282 @item sparclet
20283 tsc701
20285 @item v9
20286 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
20287 @end table
20289 By default (unless configured otherwise), GCC generates code for the V7
20290 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
20291 additionally optimizes it for the Cypress CY7C602 chip, as used in the
20292 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
20293 SPARCStation 1, 2, IPX etc.
20295 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
20296 architecture.  The only difference from V7 code is that the compiler emits
20297 the integer multiply and integer divide instructions which exist in SPARC-V8
20298 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
20299 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
20300 2000 series.
20302 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
20303 the SPARC architecture.  This adds the integer multiply, integer divide step
20304 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
20305 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
20306 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
20307 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
20308 MB86934 chip, which is the more recent SPARClite with FPU@.
20310 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
20311 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
20312 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
20313 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
20314 optimizes it for the TEMIC SPARClet chip.
20316 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
20317 architecture.  This adds 64-bit integer and floating-point move instructions,
20318 3 additional floating-point condition code registers and conditional move
20319 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
20320 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
20321 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
20322 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
20323 @option{-mcpu=niagara}, the compiler additionally optimizes it for
20324 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
20325 additionally optimizes it for Sun UltraSPARC T2 chips. With
20326 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
20327 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
20328 additionally optimizes it for Sun UltraSPARC T4 chips.
20330 @item -mtune=@var{cpu_type}
20331 @opindex mtune
20332 Set the instruction scheduling parameters for machine type
20333 @var{cpu_type}, but do not set the instruction set or register set that the
20334 option @option{-mcpu=@var{cpu_type}} does.
20336 The same values for @option{-mcpu=@var{cpu_type}} can be used for
20337 @option{-mtune=@var{cpu_type}}, but the only useful values are those
20338 that select a particular CPU implementation.  Those are @samp{cypress},
20339 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3}, @samp{f930},
20340 @samp{f934}, @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
20341 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3} and
20342 @samp{niagara4}.  With native Solaris and GNU/Linux toolchains, @samp{native}
20343 can also be used.
20345 @item -mv8plus
20346 @itemx -mno-v8plus
20347 @opindex mv8plus
20348 @opindex mno-v8plus
20349 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
20350 difference from the V8 ABI is that the global and out registers are
20351 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
20352 mode for all SPARC-V9 processors.
20354 @item -mvis
20355 @itemx -mno-vis
20356 @opindex mvis
20357 @opindex mno-vis
20358 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
20359 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
20361 @item -mvis2
20362 @itemx -mno-vis2
20363 @opindex mvis2
20364 @opindex mno-vis2
20365 With @option{-mvis2}, GCC generates code that takes advantage of
20366 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
20367 default is @option{-mvis2} when targeting a cpu that supports such
20368 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
20369 also sets @option{-mvis}.
20371 @item -mvis3
20372 @itemx -mno-vis3
20373 @opindex mvis3
20374 @opindex mno-vis3
20375 With @option{-mvis3}, GCC generates code that takes advantage of
20376 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
20377 default is @option{-mvis3} when targeting a cpu that supports such
20378 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
20379 also sets @option{-mvis2} and @option{-mvis}.
20381 @item -mcbcond
20382 @itemx -mno-cbcond
20383 @opindex mcbcond
20384 @opindex mno-cbcond
20385 With @option{-mcbcond}, GCC generates code that takes advantage of
20386 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
20387 The default is @option{-mcbcond} when targeting a cpu that supports such
20388 instructions, such as niagara-4 and later.
20390 @item -mpopc
20391 @itemx -mno-popc
20392 @opindex mpopc
20393 @opindex mno-popc
20394 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
20395 population count instruction.  The default is @option{-mpopc}
20396 when targeting a cpu that supports such instructions, such as Niagara-2 and
20397 later.
20399 @item -mfmaf
20400 @itemx -mno-fmaf
20401 @opindex mfmaf
20402 @opindex mno-fmaf
20403 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
20404 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
20405 when targeting a cpu that supports such instructions, such as Niagara-3 and
20406 later.
20408 @item -mfix-at697f
20409 @opindex mfix-at697f
20410 Enable the documented workaround for the single erratum of the Atmel AT697F
20411 processor (which corresponds to erratum #13 of the AT697E processor).
20413 @item -mfix-ut699
20414 @opindex mfix-ut699
20415 Enable the documented workarounds for the floating-point errata and the data
20416 cache nullify errata of the UT699 processor.
20417 @end table
20419 These @samp{-m} options are supported in addition to the above
20420 on SPARC-V9 processors in 64-bit environments:
20422 @table @gcctabopt
20423 @item -m32
20424 @itemx -m64
20425 @opindex m32
20426 @opindex m64
20427 Generate code for a 32-bit or 64-bit environment.
20428 The 32-bit environment sets int, long and pointer to 32 bits.
20429 The 64-bit environment sets int to 32 bits and long and pointer
20430 to 64 bits.
20432 @item -mcmodel=@var{which}
20433 @opindex mcmodel
20434 Set the code model to one of
20436 @table @samp
20437 @item medlow
20438 The Medium/Low code model: 64-bit addresses, programs
20439 must be linked in the low 32 bits of memory.  Programs can be statically
20440 or dynamically linked.
20442 @item medmid
20443 The Medium/Middle code model: 64-bit addresses, programs
20444 must be linked in the low 44 bits of memory, the text and data segments must
20445 be less than 2GB in size and the data segment must be located within 2GB of
20446 the text segment.
20448 @item medany
20449 The Medium/Anywhere code model: 64-bit addresses, programs
20450 may be linked anywhere in memory, the text and data segments must be less
20451 than 2GB in size and the data segment must be located within 2GB of the
20452 text segment.
20454 @item embmedany
20455 The Medium/Anywhere code model for embedded systems:
20456 64-bit addresses, the text and data segments must be less than 2GB in
20457 size, both starting anywhere in memory (determined at link time).  The
20458 global register %g4 points to the base of the data segment.  Programs
20459 are statically linked and PIC is not supported.
20460 @end table
20462 @item -mmemory-model=@var{mem-model}
20463 @opindex mmemory-model
20464 Set the memory model in force on the processor to one of
20466 @table @samp
20467 @item default
20468 The default memory model for the processor and operating system.
20470 @item rmo
20471 Relaxed Memory Order
20473 @item pso
20474 Partial Store Order
20476 @item tso
20477 Total Store Order
20479 @item sc
20480 Sequential Consistency
20481 @end table
20483 These memory models are formally defined in Appendix D of the Sparc V9
20484 architecture manual, as set in the processor's @code{PSTATE.MM} field.
20486 @item -mstack-bias
20487 @itemx -mno-stack-bias
20488 @opindex mstack-bias
20489 @opindex mno-stack-bias
20490 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
20491 frame pointer if present, are offset by @minus{}2047 which must be added back
20492 when making stack frame references.  This is the default in 64-bit mode.
20493 Otherwise, assume no such offset is present.
20494 @end table
20496 @node SPU Options
20497 @subsection SPU Options
20498 @cindex SPU options
20500 These @samp{-m} options are supported on the SPU:
20502 @table @gcctabopt
20503 @item -mwarn-reloc
20504 @itemx -merror-reloc
20505 @opindex mwarn-reloc
20506 @opindex merror-reloc
20508 The loader for SPU does not handle dynamic relocations.  By default, GCC
20509 gives an error when it generates code that requires a dynamic
20510 relocation.  @option{-mno-error-reloc} disables the error,
20511 @option{-mwarn-reloc} generates a warning instead.
20513 @item -msafe-dma
20514 @itemx -munsafe-dma
20515 @opindex msafe-dma
20516 @opindex munsafe-dma
20518 Instructions that initiate or test completion of DMA must not be
20519 reordered with respect to loads and stores of the memory that is being
20520 accessed.
20521 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
20522 memory accesses, but that can lead to inefficient code in places where the
20523 memory is known to not change.  Rather than mark the memory as volatile,
20524 you can use @option{-msafe-dma} to tell the compiler to treat
20525 the DMA instructions as potentially affecting all memory.  
20527 @item -mbranch-hints
20528 @opindex mbranch-hints
20530 By default, GCC generates a branch hint instruction to avoid
20531 pipeline stalls for always-taken or probably-taken branches.  A hint
20532 is not generated closer than 8 instructions away from its branch.
20533 There is little reason to disable them, except for debugging purposes,
20534 or to make an object a little bit smaller.
20536 @item -msmall-mem
20537 @itemx -mlarge-mem
20538 @opindex msmall-mem
20539 @opindex mlarge-mem
20541 By default, GCC generates code assuming that addresses are never larger
20542 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
20543 a full 32-bit address.
20545 @item -mstdmain
20546 @opindex mstdmain
20548 By default, GCC links against startup code that assumes the SPU-style
20549 main function interface (which has an unconventional parameter list).
20550 With @option{-mstdmain}, GCC links your program against startup
20551 code that assumes a C99-style interface to @code{main}, including a
20552 local copy of @code{argv} strings.
20554 @item -mfixed-range=@var{register-range}
20555 @opindex mfixed-range
20556 Generate code treating the given register range as fixed registers.
20557 A fixed register is one that the register allocator cannot use.  This is
20558 useful when compiling kernel code.  A register range is specified as
20559 two registers separated by a dash.  Multiple register ranges can be
20560 specified separated by a comma.
20562 @item -mea32
20563 @itemx -mea64
20564 @opindex mea32
20565 @opindex mea64
20566 Compile code assuming that pointers to the PPU address space accessed
20567 via the @code{__ea} named address space qualifier are either 32 or 64
20568 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
20569 all object code in an executable must be compiled with the same setting.
20571 @item -maddress-space-conversion
20572 @itemx -mno-address-space-conversion
20573 @opindex maddress-space-conversion
20574 @opindex mno-address-space-conversion
20575 Allow/disallow treating the @code{__ea} address space as superset
20576 of the generic address space.  This enables explicit type casts
20577 between @code{__ea} and generic pointer as well as implicit
20578 conversions of generic pointers to @code{__ea} pointers.  The
20579 default is to allow address space pointer conversions.
20581 @item -mcache-size=@var{cache-size}
20582 @opindex mcache-size
20583 This option controls the version of libgcc that the compiler links to an
20584 executable and selects a software-managed cache for accessing variables
20585 in the @code{__ea} address space with a particular cache size.  Possible
20586 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
20587 and @samp{128}.  The default cache size is 64KB.
20589 @item -matomic-updates
20590 @itemx -mno-atomic-updates
20591 @opindex matomic-updates
20592 @opindex mno-atomic-updates
20593 This option controls the version of libgcc that the compiler links to an
20594 executable and selects whether atomic updates to the software-managed
20595 cache of PPU-side variables are used.  If you use atomic updates, changes
20596 to a PPU variable from SPU code using the @code{__ea} named address space
20597 qualifier do not interfere with changes to other PPU variables residing
20598 in the same cache line from PPU code.  If you do not use atomic updates,
20599 such interference may occur; however, writing back cache lines is
20600 more efficient.  The default behavior is to use atomic updates.
20602 @item -mdual-nops
20603 @itemx -mdual-nops=@var{n}
20604 @opindex mdual-nops
20605 By default, GCC inserts nops to increase dual issue when it expects
20606 it to increase performance.  @var{n} can be a value from 0 to 10.  A
20607 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
20608 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
20610 @item -mhint-max-nops=@var{n}
20611 @opindex mhint-max-nops
20612 Maximum number of nops to insert for a branch hint.  A branch hint must
20613 be at least 8 instructions away from the branch it is affecting.  GCC
20614 inserts up to @var{n} nops to enforce this, otherwise it does not
20615 generate the branch hint.
20617 @item -mhint-max-distance=@var{n}
20618 @opindex mhint-max-distance
20619 The encoding of the branch hint instruction limits the hint to be within
20620 256 instructions of the branch it is affecting.  By default, GCC makes
20621 sure it is within 125.
20623 @item -msafe-hints
20624 @opindex msafe-hints
20625 Work around a hardware bug that causes the SPU to stall indefinitely.
20626 By default, GCC inserts the @code{hbrp} instruction to make sure
20627 this stall won't happen.
20629 @end table
20631 @node System V Options
20632 @subsection Options for System V
20634 These additional options are available on System V Release 4 for
20635 compatibility with other compilers on those systems:
20637 @table @gcctabopt
20638 @item -G
20639 @opindex G
20640 Create a shared object.
20641 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
20643 @item -Qy
20644 @opindex Qy
20645 Identify the versions of each tool used by the compiler, in a
20646 @code{.ident} assembler directive in the output.
20648 @item -Qn
20649 @opindex Qn
20650 Refrain from adding @code{.ident} directives to the output file (this is
20651 the default).
20653 @item -YP,@var{dirs}
20654 @opindex YP
20655 Search the directories @var{dirs}, and no others, for libraries
20656 specified with @option{-l}.
20658 @item -Ym,@var{dir}
20659 @opindex Ym
20660 Look in the directory @var{dir} to find the M4 preprocessor.
20661 The assembler uses this option.
20662 @c This is supposed to go with a -Yd for predefined M4 macro files, but
20663 @c the generic assembler that comes with Solaris takes just -Ym.
20664 @end table
20666 @node TILE-Gx Options
20667 @subsection TILE-Gx Options
20668 @cindex TILE-Gx options
20670 These @samp{-m} options are supported on the TILE-Gx:
20672 @table @gcctabopt
20673 @item -mcmodel=small
20674 @opindex mcmodel=small
20675 Generate code for the small model.  The distance for direct calls is
20676 limited to 500M in either direction.  PC-relative addresses are 32
20677 bits.  Absolute addresses support the full address range.
20679 @item -mcmodel=large
20680 @opindex mcmodel=large
20681 Generate code for the large model.  There is no limitation on call
20682 distance, pc-relative addresses, or absolute addresses.
20684 @item -mcpu=@var{name}
20685 @opindex mcpu
20686 Selects the type of CPU to be targeted.  Currently the only supported
20687 type is @samp{tilegx}.
20689 @item -m32
20690 @itemx -m64
20691 @opindex m32
20692 @opindex m64
20693 Generate code for a 32-bit or 64-bit environment.  The 32-bit
20694 environment sets int, long, and pointer to 32 bits.  The 64-bit
20695 environment sets int to 32 bits and long and pointer to 64 bits.
20696 @end table
20698 @node TILEPro Options
20699 @subsection TILEPro Options
20700 @cindex TILEPro options
20702 These @samp{-m} options are supported on the TILEPro:
20704 @table @gcctabopt
20705 @item -mcpu=@var{name}
20706 @opindex mcpu
20707 Selects the type of CPU to be targeted.  Currently the only supported
20708 type is @samp{tilepro}.
20710 @item -m32
20711 @opindex m32
20712 Generate code for a 32-bit environment, which sets int, long, and
20713 pointer to 32 bits.  This is the only supported behavior so the flag
20714 is essentially ignored.
20715 @end table
20717 @node V850 Options
20718 @subsection V850 Options
20719 @cindex V850 Options
20721 These @samp{-m} options are defined for V850 implementations:
20723 @table @gcctabopt
20724 @item -mlong-calls
20725 @itemx -mno-long-calls
20726 @opindex mlong-calls
20727 @opindex mno-long-calls
20728 Treat all calls as being far away (near).  If calls are assumed to be
20729 far away, the compiler always loads the function's address into a
20730 register, and calls indirect through the pointer.
20732 @item -mno-ep
20733 @itemx -mep
20734 @opindex mno-ep
20735 @opindex mep
20736 Do not optimize (do optimize) basic blocks that use the same index
20737 pointer 4 or more times to copy pointer into the @code{ep} register, and
20738 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
20739 option is on by default if you optimize.
20741 @item -mno-prolog-function
20742 @itemx -mprolog-function
20743 @opindex mno-prolog-function
20744 @opindex mprolog-function
20745 Do not use (do use) external functions to save and restore registers
20746 at the prologue and epilogue of a function.  The external functions
20747 are slower, but use less code space if more than one function saves
20748 the same number of registers.  The @option{-mprolog-function} option
20749 is on by default if you optimize.
20751 @item -mspace
20752 @opindex mspace
20753 Try to make the code as small as possible.  At present, this just turns
20754 on the @option{-mep} and @option{-mprolog-function} options.
20756 @item -mtda=@var{n}
20757 @opindex mtda
20758 Put static or global variables whose size is @var{n} bytes or less into
20759 the tiny data area that register @code{ep} points to.  The tiny data
20760 area can hold up to 256 bytes in total (128 bytes for byte references).
20762 @item -msda=@var{n}
20763 @opindex msda
20764 Put static or global variables whose size is @var{n} bytes or less into
20765 the small data area that register @code{gp} points to.  The small data
20766 area can hold up to 64 kilobytes.
20768 @item -mzda=@var{n}
20769 @opindex mzda
20770 Put static or global variables whose size is @var{n} bytes or less into
20771 the first 32 kilobytes of memory.
20773 @item -mv850
20774 @opindex mv850
20775 Specify that the target processor is the V850.
20777 @item -mv850e3v5
20778 @opindex mv850e3v5
20779 Specify that the target processor is the V850E3V5.  The preprocessor
20780 constant @samp{__v850e3v5__} is defined if this option is used.
20782 @item -mv850e2v4
20783 @opindex mv850e2v4
20784 Specify that the target processor is the V850E3V5.  This is an alias for
20785 the @option{-mv850e3v5} option.
20787 @item -mv850e2v3
20788 @opindex mv850e2v3
20789 Specify that the target processor is the V850E2V3.  The preprocessor
20790 constant @samp{__v850e2v3__} is defined if this option is used.
20792 @item -mv850e2
20793 @opindex mv850e2
20794 Specify that the target processor is the V850E2.  The preprocessor
20795 constant @samp{__v850e2__} is defined if this option is used.
20797 @item -mv850e1
20798 @opindex mv850e1
20799 Specify that the target processor is the V850E1.  The preprocessor
20800 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
20801 this option is used.
20803 @item -mv850es
20804 @opindex mv850es
20805 Specify that the target processor is the V850ES.  This is an alias for
20806 the @option{-mv850e1} option.
20808 @item -mv850e
20809 @opindex mv850e
20810 Specify that the target processor is the V850E@.  The preprocessor
20811 constant @samp{__v850e__} is defined if this option is used.
20813 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
20814 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
20815 are defined then a default target processor is chosen and the
20816 relevant @samp{__v850*__} preprocessor constant is defined.
20818 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
20819 defined, regardless of which processor variant is the target.
20821 @item -mdisable-callt
20822 @itemx -mno-disable-callt
20823 @opindex mdisable-callt
20824 @opindex mno-disable-callt
20825 This option suppresses generation of the @code{CALLT} instruction for the
20826 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
20827 architecture.
20829 This option is enabled by default when the RH850 ABI is
20830 in use (see @option{-mrh850-abi}), and disabled by default when the
20831 GCC ABI is in use.  If @code{CALLT} instructions are being generated
20832 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
20834 @item -mrelax
20835 @itemx -mno-relax
20836 @opindex mrelax
20837 @opindex mno-relax
20838 Pass on (or do not pass on) the @option{-mrelax} command line option
20839 to the assembler.
20841 @item -mlong-jumps
20842 @itemx -mno-long-jumps
20843 @opindex mlong-jumps
20844 @opindex mno-long-jumps
20845 Disable (or re-enable) the generation of PC-relative jump instructions.
20847 @item -msoft-float
20848 @itemx -mhard-float
20849 @opindex msoft-float
20850 @opindex mhard-float
20851 Disable (or re-enable) the generation of hardware floating point
20852 instructions.  This option is only significant when the target
20853 architecture is @samp{V850E2V3} or higher.  If hardware floating point
20854 instructions are being generated then the C preprocessor symbol
20855 @code{__FPU_OK__} will be defined, otherwise the symbol
20856 @code{__NO_FPU__} will be defined.
20858 @item -mloop
20859 @opindex mloop
20860 Enables the use of the e3v5 LOOP instruction.  The use of this
20861 instruction is not enabled by default when the e3v5 architecture is
20862 selected because its use is still experimental.
20864 @item -mrh850-abi
20865 @itemx -mghs
20866 @opindex mrh850-abi
20867 @opindex mghs
20868 Enables support for the RH850 version of the V850 ABI.  This is the
20869 default.  With this version of the ABI the following rules apply:
20871 @itemize
20872 @item
20873 Integer sized structures and unions are returned via a memory pointer
20874 rather than a register.
20876 @item
20877 Large structures and unions (more than 8 bytes in size) are passed by
20878 value.
20880 @item
20881 Functions are aligned to 16-bit boundaries.
20883 @item
20884 The @option{-m8byte-align} command line option is supported.
20886 @item
20887 The @option{-mdisable-callt} command line option is enabled by
20888 default.  The @option{-mno-disable-callt} command line option is not
20889 supported.
20890 @end itemize
20892 When this version of the ABI is enabled the C preprocessor symbol
20893 @code{__V850_RH850_ABI__} is defined.
20895 @item -mgcc-abi
20896 @opindex mgcc-abi
20897 Enables support for the old GCC version of the V850 ABI.  With this
20898 version of the ABI the following rules apply:
20900 @itemize
20901 @item
20902 Integer sized structures and unions are returned in register @code{r10}.
20904 @item
20905 Large structures and unions (more than 8 bytes in size) are passed by
20906 reference.
20908 @item
20909 Functions are aligned to 32-bit boundaries, unless optimizing for
20910 size.
20912 @item
20913 The @option{-m8byte-align} command line option is not supported.
20915 @item
20916 The @option{-mdisable-callt} command line option is supported but not
20917 enabled by default.
20918 @end itemize
20920 When this version of the ABI is enabled the C preprocessor symbol
20921 @code{__V850_GCC_ABI__} is defined.
20923 @item -m8byte-align
20924 @itemx -mno-8byte-align
20925 @opindex m8byte-align
20926 @opindex mno-8byte-align
20927 Enables support for @code{doubles} and @code{long long} types to be
20928 aligned on 8-byte boundaries.  The default is to restrict the
20929 alignment of all objects to at most 4-bytes.  When
20930 @option{-m8byte-align} is in effect the C preprocessor symbol
20931 @code{__V850_8BYTE_ALIGN__} will be defined.
20933 @item -mbig-switch
20934 @opindex mbig-switch
20935 Generate code suitable for big switch tables.  Use this option only if
20936 the assembler/linker complain about out of range branches within a switch
20937 table.
20939 @item -mapp-regs
20940 @opindex mapp-regs
20941 This option causes r2 and r5 to be used in the code generated by
20942 the compiler.  This setting is the default.
20944 @item -mno-app-regs
20945 @opindex mno-app-regs
20946 This option causes r2 and r5 to be treated as fixed registers.
20948 @end table
20950 @node VAX Options
20951 @subsection VAX Options
20952 @cindex VAX options
20954 These @samp{-m} options are defined for the VAX:
20956 @table @gcctabopt
20957 @item -munix
20958 @opindex munix
20959 Do not output certain jump instructions (@code{aobleq} and so on)
20960 that the Unix assembler for the VAX cannot handle across long
20961 ranges.
20963 @item -mgnu
20964 @opindex mgnu
20965 Do output those jump instructions, on the assumption that the
20966 GNU assembler is being used.
20968 @item -mg
20969 @opindex mg
20970 Output code for G-format floating-point numbers instead of D-format.
20971 @end table
20973 @node VMS Options
20974 @subsection VMS Options
20976 These @samp{-m} options are defined for the VMS implementations:
20978 @table @gcctabopt
20979 @item -mvms-return-codes
20980 @opindex mvms-return-codes
20981 Return VMS condition codes from @code{main}. The default is to return POSIX-style
20982 condition (e.g.@ error) codes.
20984 @item -mdebug-main=@var{prefix}
20985 @opindex mdebug-main=@var{prefix}
20986 Flag the first routine whose name starts with @var{prefix} as the main
20987 routine for the debugger.
20989 @item -mmalloc64
20990 @opindex mmalloc64
20991 Default to 64-bit memory allocation routines.
20993 @item -mpointer-size=@var{size}
20994 @opindex -mpointer-size=@var{size}
20995 Set the default size of pointers. Possible options for @var{size} are
20996 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
20997 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
20998 The later option disables @code{pragma pointer_size}.
20999 @end table
21001 @node VxWorks Options
21002 @subsection VxWorks Options
21003 @cindex VxWorks Options
21005 The options in this section are defined for all VxWorks targets.
21006 Options specific to the target hardware are listed with the other
21007 options for that target.
21009 @table @gcctabopt
21010 @item -mrtp
21011 @opindex mrtp
21012 GCC can generate code for both VxWorks kernels and real time processes
21013 (RTPs).  This option switches from the former to the latter.  It also
21014 defines the preprocessor macro @code{__RTP__}.
21016 @item -non-static
21017 @opindex non-static
21018 Link an RTP executable against shared libraries rather than static
21019 libraries.  The options @option{-static} and @option{-shared} can
21020 also be used for RTPs (@pxref{Link Options}); @option{-static}
21021 is the default.
21023 @item -Bstatic
21024 @itemx -Bdynamic
21025 @opindex Bstatic
21026 @opindex Bdynamic
21027 These options are passed down to the linker.  They are defined for
21028 compatibility with Diab.
21030 @item -Xbind-lazy
21031 @opindex Xbind-lazy
21032 Enable lazy binding of function calls.  This option is equivalent to
21033 @option{-Wl,-z,now} and is defined for compatibility with Diab.
21035 @item -Xbind-now
21036 @opindex Xbind-now
21037 Disable lazy binding of function calls.  This option is the default and
21038 is defined for compatibility with Diab.
21039 @end table
21041 @node x86-64 Options
21042 @subsection x86-64 Options
21043 @cindex x86-64 options
21045 These are listed under @xref{i386 and x86-64 Options}.
21047 @node Xstormy16 Options
21048 @subsection Xstormy16 Options
21049 @cindex Xstormy16 Options
21051 These options are defined for Xstormy16:
21053 @table @gcctabopt
21054 @item -msim
21055 @opindex msim
21056 Choose startup files and linker script suitable for the simulator.
21057 @end table
21059 @node Xtensa Options
21060 @subsection Xtensa Options
21061 @cindex Xtensa Options
21063 These options are supported for Xtensa targets:
21065 @table @gcctabopt
21066 @item -mconst16
21067 @itemx -mno-const16
21068 @opindex mconst16
21069 @opindex mno-const16
21070 Enable or disable use of @code{CONST16} instructions for loading
21071 constant values.  The @code{CONST16} instruction is currently not a
21072 standard option from Tensilica.  When enabled, @code{CONST16}
21073 instructions are always used in place of the standard @code{L32R}
21074 instructions.  The use of @code{CONST16} is enabled by default only if
21075 the @code{L32R} instruction is not available.
21077 @item -mfused-madd
21078 @itemx -mno-fused-madd
21079 @opindex mfused-madd
21080 @opindex mno-fused-madd
21081 Enable or disable use of fused multiply/add and multiply/subtract
21082 instructions in the floating-point option.  This has no effect if the
21083 floating-point option is not also enabled.  Disabling fused multiply/add
21084 and multiply/subtract instructions forces the compiler to use separate
21085 instructions for the multiply and add/subtract operations.  This may be
21086 desirable in some cases where strict IEEE 754-compliant results are
21087 required: the fused multiply add/subtract instructions do not round the
21088 intermediate result, thereby producing results with @emph{more} bits of
21089 precision than specified by the IEEE standard.  Disabling fused multiply
21090 add/subtract instructions also ensures that the program output is not
21091 sensitive to the compiler's ability to combine multiply and add/subtract
21092 operations.
21094 @item -mserialize-volatile
21095 @itemx -mno-serialize-volatile
21096 @opindex mserialize-volatile
21097 @opindex mno-serialize-volatile
21098 When this option is enabled, GCC inserts @code{MEMW} instructions before
21099 @code{volatile} memory references to guarantee sequential consistency.
21100 The default is @option{-mserialize-volatile}.  Use
21101 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
21103 @item -mforce-no-pic
21104 @opindex mforce-no-pic
21105 For targets, like GNU/Linux, where all user-mode Xtensa code must be
21106 position-independent code (PIC), this option disables PIC for compiling
21107 kernel code.
21109 @item -mtext-section-literals
21110 @itemx -mno-text-section-literals
21111 @opindex mtext-section-literals
21112 @opindex mno-text-section-literals
21113 Control the treatment of literal pools.  The default is
21114 @option{-mno-text-section-literals}, which places literals in a separate
21115 section in the output file.  This allows the literal pool to be placed
21116 in a data RAM/ROM, and it also allows the linker to combine literal
21117 pools from separate object files to remove redundant literals and
21118 improve code size.  With @option{-mtext-section-literals}, the literals
21119 are interspersed in the text section in order to keep them as close as
21120 possible to their references.  This may be necessary for large assembly
21121 files.
21123 @item -mtarget-align
21124 @itemx -mno-target-align
21125 @opindex mtarget-align
21126 @opindex mno-target-align
21127 When this option is enabled, GCC instructs the assembler to
21128 automatically align instructions to reduce branch penalties at the
21129 expense of some code density.  The assembler attempts to widen density
21130 instructions to align branch targets and the instructions following call
21131 instructions.  If there are not enough preceding safe density
21132 instructions to align a target, no widening is performed.  The
21133 default is @option{-mtarget-align}.  These options do not affect the
21134 treatment of auto-aligned instructions like @code{LOOP}, which the
21135 assembler always aligns, either by widening density instructions or
21136 by inserting NOP instructions.
21138 @item -mlongcalls
21139 @itemx -mno-longcalls
21140 @opindex mlongcalls
21141 @opindex mno-longcalls
21142 When this option is enabled, GCC instructs the assembler to translate
21143 direct calls to indirect calls unless it can determine that the target
21144 of a direct call is in the range allowed by the call instruction.  This
21145 translation typically occurs for calls to functions in other source
21146 files.  Specifically, the assembler translates a direct @code{CALL}
21147 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
21148 The default is @option{-mno-longcalls}.  This option should be used in
21149 programs where the call target can potentially be out of range.  This
21150 option is implemented in the assembler, not the compiler, so the
21151 assembly code generated by GCC still shows direct call
21152 instructions---look at the disassembled object code to see the actual
21153 instructions.  Note that the assembler uses an indirect call for
21154 every cross-file call, not just those that really are out of range.
21155 @end table
21157 @node zSeries Options
21158 @subsection zSeries Options
21159 @cindex zSeries options
21161 These are listed under @xref{S/390 and zSeries Options}.
21163 @node Code Gen Options
21164 @section Options for Code Generation Conventions
21165 @cindex code generation conventions
21166 @cindex options, code generation
21167 @cindex run-time options
21169 These machine-independent options control the interface conventions
21170 used in code generation.
21172 Most of them have both positive and negative forms; the negative form
21173 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
21174 one of the forms is listed---the one that is not the default.  You
21175 can figure out the other form by either removing @samp{no-} or adding
21178 @table @gcctabopt
21179 @item -fbounds-check
21180 @opindex fbounds-check
21181 For front ends that support it, generate additional code to check that
21182 indices used to access arrays are within the declared range.  This is
21183 currently only supported by the Java and Fortran front ends, where
21184 this option defaults to true and false respectively.
21186 @item -fstack-reuse=@var{reuse-level}
21187 @opindex fstack_reuse
21188 This option controls stack space reuse for user declared local/auto variables
21189 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
21190 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
21191 local variables and temporaries, @samp{named_vars} enables the reuse only for
21192 user defined local variables with names, and @samp{none} disables stack reuse
21193 completely. The default value is @samp{all}. The option is needed when the
21194 program extends the lifetime of a scoped local variable or a compiler generated
21195 temporary beyond the end point defined by the language.  When a lifetime of
21196 a variable ends, and if the variable lives in memory, the optimizing compiler
21197 has the freedom to reuse its stack space with other temporaries or scoped
21198 local variables whose live range does not overlap with it. Legacy code extending
21199 local lifetime will likely to break with the stack reuse optimization.
21201 For example,
21203 @smallexample
21204    int *p;
21205    @{
21206      int local1;
21208      p = &local1;
21209      local1 = 10;
21210      ....
21211    @}
21212    @{
21213       int local2;
21214       local2 = 20;
21215       ...
21216    @}
21218    if (*p == 10)  // out of scope use of local1
21219      @{
21221      @}
21222 @end smallexample
21224 Another example:
21225 @smallexample
21227    struct A
21228    @{
21229        A(int k) : i(k), j(k) @{ @}
21230        int i;
21231        int j;
21232    @};
21234    A *ap;
21236    void foo(const A& ar)
21237    @{
21238       ap = &ar;
21239    @}
21241    void bar()
21242    @{
21243       foo(A(10)); // temp object's lifetime ends when foo returns
21245       @{
21246         A a(20);
21247         ....
21248       @}
21249       ap->i+= 10;  // ap references out of scope temp whose space
21250                    // is reused with a. What is the value of ap->i?
21251    @}
21253 @end smallexample
21255 The lifetime of a compiler generated temporary is well defined by the C++
21256 standard. When a lifetime of a temporary ends, and if the temporary lives
21257 in memory, the optimizing compiler has the freedom to reuse its stack
21258 space with other temporaries or scoped local variables whose live range
21259 does not overlap with it. However some of the legacy code relies on
21260 the behavior of older compilers in which temporaries' stack space is
21261 not reused, the aggressive stack reuse can lead to runtime errors. This
21262 option is used to control the temporary stack reuse optimization.
21264 @item -ftrapv
21265 @opindex ftrapv
21266 This option generates traps for signed overflow on addition, subtraction,
21267 multiplication operations.
21269 @item -fwrapv
21270 @opindex fwrapv
21271 This option instructs the compiler to assume that signed arithmetic
21272 overflow of addition, subtraction and multiplication wraps around
21273 using twos-complement representation.  This flag enables some optimizations
21274 and disables others.  This option is enabled by default for the Java
21275 front end, as required by the Java language specification.
21277 @item -fexceptions
21278 @opindex fexceptions
21279 Enable exception handling.  Generates extra code needed to propagate
21280 exceptions.  For some targets, this implies GCC generates frame
21281 unwind information for all functions, which can produce significant data
21282 size overhead, although it does not affect execution.  If you do not
21283 specify this option, GCC enables it by default for languages like
21284 C++ that normally require exception handling, and disables it for
21285 languages like C that do not normally require it.  However, you may need
21286 to enable this option when compiling C code that needs to interoperate
21287 properly with exception handlers written in C++.  You may also wish to
21288 disable this option if you are compiling older C++ programs that don't
21289 use exception handling.
21291 @item -fnon-call-exceptions
21292 @opindex fnon-call-exceptions
21293 Generate code that allows trapping instructions to throw exceptions.
21294 Note that this requires platform-specific runtime support that does
21295 not exist everywhere.  Moreover, it only allows @emph{trapping}
21296 instructions to throw exceptions, i.e.@: memory references or floating-point
21297 instructions.  It does not allow exceptions to be thrown from
21298 arbitrary signal handlers such as @code{SIGALRM}.
21300 @item -fdelete-dead-exceptions
21301 @opindex fdelete-dead-exceptions
21302 Consider that instructions that may throw exceptions but don't otherwise
21303 contribute to the execution of the program can be optimized away.
21304 This option is enabled by default for the Ada front end, as permitted by
21305 the Ada language specification.
21306 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
21308 @item -funwind-tables
21309 @opindex funwind-tables
21310 Similar to @option{-fexceptions}, except that it just generates any needed
21311 static data, but does not affect the generated code in any other way.
21312 You normally do not need to enable this option; instead, a language processor
21313 that needs this handling enables it on your behalf.
21315 @item -fasynchronous-unwind-tables
21316 @opindex fasynchronous-unwind-tables
21317 Generate unwind table in DWARF 2 format, if supported by target machine.  The
21318 table is exact at each instruction boundary, so it can be used for stack
21319 unwinding from asynchronous events (such as debugger or garbage collector).
21321 @item -fpcc-struct-return
21322 @opindex fpcc-struct-return
21323 Return ``short'' @code{struct} and @code{union} values in memory like
21324 longer ones, rather than in registers.  This convention is less
21325 efficient, but it has the advantage of allowing intercallability between
21326 GCC-compiled files and files compiled with other compilers, particularly
21327 the Portable C Compiler (pcc).
21329 The precise convention for returning structures in memory depends
21330 on the target configuration macros.
21332 Short structures and unions are those whose size and alignment match
21333 that of some integer type.
21335 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
21336 switch is not binary compatible with code compiled with the
21337 @option{-freg-struct-return} switch.
21338 Use it to conform to a non-default application binary interface.
21340 @item -freg-struct-return
21341 @opindex freg-struct-return
21342 Return @code{struct} and @code{union} values in registers when possible.
21343 This is more efficient for small structures than
21344 @option{-fpcc-struct-return}.
21346 If you specify neither @option{-fpcc-struct-return} nor
21347 @option{-freg-struct-return}, GCC defaults to whichever convention is
21348 standard for the target.  If there is no standard convention, GCC
21349 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
21350 the principal compiler.  In those cases, we can choose the standard, and
21351 we chose the more efficient register return alternative.
21353 @strong{Warning:} code compiled with the @option{-freg-struct-return}
21354 switch is not binary compatible with code compiled with the
21355 @option{-fpcc-struct-return} switch.
21356 Use it to conform to a non-default application binary interface.
21358 @item -fshort-enums
21359 @opindex fshort-enums
21360 Allocate to an @code{enum} type only as many bytes as it needs for the
21361 declared range of possible values.  Specifically, the @code{enum} type
21362 is equivalent to the smallest integer type that has enough room.
21364 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
21365 code that is not binary compatible with code generated without that switch.
21366 Use it to conform to a non-default application binary interface.
21368 @item -fshort-double
21369 @opindex fshort-double
21370 Use the same size for @code{double} as for @code{float}.
21372 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
21373 code that is not binary compatible with code generated without that switch.
21374 Use it to conform to a non-default application binary interface.
21376 @item -fshort-wchar
21377 @opindex fshort-wchar
21378 Override the underlying type for @samp{wchar_t} to be @samp{short
21379 unsigned int} instead of the default for the target.  This option is
21380 useful for building programs to run under WINE@.
21382 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
21383 code that is not binary compatible with code generated without that switch.
21384 Use it to conform to a non-default application binary interface.
21386 @item -fno-common
21387 @opindex fno-common
21388 In C code, controls the placement of uninitialized global variables.
21389 Unix C compilers have traditionally permitted multiple definitions of
21390 such variables in different compilation units by placing the variables
21391 in a common block.
21392 This is the behavior specified by @option{-fcommon}, and is the default
21393 for GCC on most targets.
21394 On the other hand, this behavior is not required by ISO C, and on some
21395 targets may carry a speed or code size penalty on variable references.
21396 The @option{-fno-common} option specifies that the compiler should place
21397 uninitialized global variables in the data section of the object file,
21398 rather than generating them as common blocks.
21399 This has the effect that if the same variable is declared
21400 (without @code{extern}) in two different compilations,
21401 you get a multiple-definition error when you link them.
21402 In this case, you must compile with @option{-fcommon} instead.
21403 Compiling with @option{-fno-common} is useful on targets for which
21404 it provides better performance, or if you wish to verify that the
21405 program will work on other systems that always treat uninitialized
21406 variable declarations this way.
21408 @item -fno-ident
21409 @opindex fno-ident
21410 Ignore the @samp{#ident} directive.
21412 @item -finhibit-size-directive
21413 @opindex finhibit-size-directive
21414 Don't output a @code{.size} assembler directive, or anything else that
21415 would cause trouble if the function is split in the middle, and the
21416 two halves are placed at locations far apart in memory.  This option is
21417 used when compiling @file{crtstuff.c}; you should not need to use it
21418 for anything else.
21420 @item -fverbose-asm
21421 @opindex fverbose-asm
21422 Put extra commentary information in the generated assembly code to
21423 make it more readable.  This option is generally only of use to those
21424 who actually need to read the generated assembly code (perhaps while
21425 debugging the compiler itself).
21427 @option{-fno-verbose-asm}, the default, causes the
21428 extra information to be omitted and is useful when comparing two assembler
21429 files.
21431 @item -frecord-gcc-switches
21432 @opindex frecord-gcc-switches
21433 This switch causes the command line used to invoke the
21434 compiler to be recorded into the object file that is being created.
21435 This switch is only implemented on some targets and the exact format
21436 of the recording is target and binary file format dependent, but it
21437 usually takes the form of a section containing ASCII text.  This
21438 switch is related to the @option{-fverbose-asm} switch, but that
21439 switch only records information in the assembler output file as
21440 comments, so it never reaches the object file.
21441 See also @option{-grecord-gcc-switches} for another
21442 way of storing compiler options into the object file.
21444 @item -fpic
21445 @opindex fpic
21446 @cindex global offset table
21447 @cindex PIC
21448 Generate position-independent code (PIC) suitable for use in a shared
21449 library, if supported for the target machine.  Such code accesses all
21450 constant addresses through a global offset table (GOT)@.  The dynamic
21451 loader resolves the GOT entries when the program starts (the dynamic
21452 loader is not part of GCC; it is part of the operating system).  If
21453 the GOT size for the linked executable exceeds a machine-specific
21454 maximum size, you get an error message from the linker indicating that
21455 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
21456 instead.  (These maximums are 8k on the SPARC and 32k
21457 on the m68k and RS/6000.  The 386 has no such limit.)
21459 Position-independent code requires special support, and therefore works
21460 only on certain machines.  For the 386, GCC supports PIC for System V
21461 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
21462 position-independent.
21464 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
21465 are defined to 1.
21467 @item -fPIC
21468 @opindex fPIC
21469 If supported for the target machine, emit position-independent code,
21470 suitable for dynamic linking and avoiding any limit on the size of the
21471 global offset table.  This option makes a difference on the m68k,
21472 PowerPC and SPARC@.
21474 Position-independent code requires special support, and therefore works
21475 only on certain machines.
21477 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
21478 are defined to 2.
21480 @item -fpie
21481 @itemx -fPIE
21482 @opindex fpie
21483 @opindex fPIE
21484 These options are similar to @option{-fpic} and @option{-fPIC}, but
21485 generated position independent code can be only linked into executables.
21486 Usually these options are used when @option{-pie} GCC option is
21487 used during linking.
21489 @option{-fpie} and @option{-fPIE} both define the macros
21490 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
21491 for @option{-fpie} and 2 for @option{-fPIE}.
21493 @item -fno-jump-tables
21494 @opindex fno-jump-tables
21495 Do not use jump tables for switch statements even where it would be
21496 more efficient than other code generation strategies.  This option is
21497 of use in conjunction with @option{-fpic} or @option{-fPIC} for
21498 building code that forms part of a dynamic linker and cannot
21499 reference the address of a jump table.  On some targets, jump tables
21500 do not require a GOT and this option is not needed.
21502 @item -ffixed-@var{reg}
21503 @opindex ffixed
21504 Treat the register named @var{reg} as a fixed register; generated code
21505 should never refer to it (except perhaps as a stack pointer, frame
21506 pointer or in some other fixed role).
21508 @var{reg} must be the name of a register.  The register names accepted
21509 are machine-specific and are defined in the @code{REGISTER_NAMES}
21510 macro in the machine description macro file.
21512 This flag does not have a negative form, because it specifies a
21513 three-way choice.
21515 @item -fcall-used-@var{reg}
21516 @opindex fcall-used
21517 Treat the register named @var{reg} as an allocable register that is
21518 clobbered by function calls.  It may be allocated for temporaries or
21519 variables that do not live across a call.  Functions compiled this way
21520 do not save and restore the register @var{reg}.
21522 It is an error to use this flag with the frame pointer or stack pointer.
21523 Use of this flag for other registers that have fixed pervasive roles in
21524 the machine's execution model produces disastrous results.
21526 This flag does not have a negative form, because it specifies a
21527 three-way choice.
21529 @item -fcall-saved-@var{reg}
21530 @opindex fcall-saved
21531 Treat the register named @var{reg} as an allocable register saved by
21532 functions.  It may be allocated even for temporaries or variables that
21533 live across a call.  Functions compiled this way save and restore
21534 the register @var{reg} if they use it.
21536 It is an error to use this flag with the frame pointer or stack pointer.
21537 Use of this flag for other registers that have fixed pervasive roles in
21538 the machine's execution model produces disastrous results.
21540 A different sort of disaster results from the use of this flag for
21541 a register in which function values may be returned.
21543 This flag does not have a negative form, because it specifies a
21544 three-way choice.
21546 @item -fpack-struct[=@var{n}]
21547 @opindex fpack-struct
21548 Without a value specified, pack all structure members together without
21549 holes.  When a value is specified (which must be a small power of two), pack
21550 structure members according to this value, representing the maximum
21551 alignment (that is, objects with default alignment requirements larger than
21552 this are output potentially unaligned at the next fitting location.
21554 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
21555 code that is not binary compatible with code generated without that switch.
21556 Additionally, it makes the code suboptimal.
21557 Use it to conform to a non-default application binary interface.
21559 @item -finstrument-functions
21560 @opindex finstrument-functions
21561 Generate instrumentation calls for entry and exit to functions.  Just
21562 after function entry and just before function exit, the following
21563 profiling functions are called with the address of the current
21564 function and its call site.  (On some platforms,
21565 @code{__builtin_return_address} does not work beyond the current
21566 function, so the call site information may not be available to the
21567 profiling functions otherwise.)
21569 @smallexample
21570 void __cyg_profile_func_enter (void *this_fn,
21571                                void *call_site);
21572 void __cyg_profile_func_exit  (void *this_fn,
21573                                void *call_site);
21574 @end smallexample
21576 The first argument is the address of the start of the current function,
21577 which may be looked up exactly in the symbol table.
21579 This instrumentation is also done for functions expanded inline in other
21580 functions.  The profiling calls indicate where, conceptually, the
21581 inline function is entered and exited.  This means that addressable
21582 versions of such functions must be available.  If all your uses of a
21583 function are expanded inline, this may mean an additional expansion of
21584 code size.  If you use @samp{extern inline} in your C code, an
21585 addressable version of such functions must be provided.  (This is
21586 normally the case anyway, but if you get lucky and the optimizer always
21587 expands the functions inline, you might have gotten away without
21588 providing static copies.)
21590 A function may be given the attribute @code{no_instrument_function}, in
21591 which case this instrumentation is not done.  This can be used, for
21592 example, for the profiling functions listed above, high-priority
21593 interrupt routines, and any functions from which the profiling functions
21594 cannot safely be called (perhaps signal handlers, if the profiling
21595 routines generate output or allocate memory).
21597 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
21598 @opindex finstrument-functions-exclude-file-list
21600 Set the list of functions that are excluded from instrumentation (see
21601 the description of @code{-finstrument-functions}).  If the file that
21602 contains a function definition matches with one of @var{file}, then
21603 that function is not instrumented.  The match is done on substrings:
21604 if the @var{file} parameter is a substring of the file name, it is
21605 considered to be a match.
21607 For example:
21609 @smallexample
21610 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
21611 @end smallexample
21613 @noindent
21614 excludes any inline function defined in files whose pathnames
21615 contain @code{/bits/stl} or @code{include/sys}.
21617 If, for some reason, you want to include letter @code{','} in one of
21618 @var{sym}, write @code{'\,'}. For example,
21619 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
21620 (note the single quote surrounding the option).
21622 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
21623 @opindex finstrument-functions-exclude-function-list
21625 This is similar to @code{-finstrument-functions-exclude-file-list},
21626 but this option sets the list of function names to be excluded from
21627 instrumentation.  The function name to be matched is its user-visible
21628 name, such as @code{vector<int> blah(const vector<int> &)}, not the
21629 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
21630 match is done on substrings: if the @var{sym} parameter is a substring
21631 of the function name, it is considered to be a match.  For C99 and C++
21632 extended identifiers, the function name must be given in UTF-8, not
21633 using universal character names.
21635 @item -fstack-check
21636 @opindex fstack-check
21637 Generate code to verify that you do not go beyond the boundary of the
21638 stack.  You should specify this flag if you are running in an
21639 environment with multiple threads, but you only rarely need to specify it in
21640 a single-threaded environment since stack overflow is automatically
21641 detected on nearly all systems if there is only one stack.
21643 Note that this switch does not actually cause checking to be done; the
21644 operating system or the language runtime must do that.  The switch causes
21645 generation of code to ensure that they see the stack being extended.
21647 You can additionally specify a string parameter: @code{no} means no
21648 checking, @code{generic} means force the use of old-style checking,
21649 @code{specific} means use the best checking method and is equivalent
21650 to bare @option{-fstack-check}.
21652 Old-style checking is a generic mechanism that requires no specific
21653 target support in the compiler but comes with the following drawbacks:
21655 @enumerate
21656 @item
21657 Modified allocation strategy for large objects: they are always
21658 allocated dynamically if their size exceeds a fixed threshold.
21660 @item
21661 Fixed limit on the size of the static frame of functions: when it is
21662 topped by a particular function, stack checking is not reliable and
21663 a warning is issued by the compiler.
21665 @item
21666 Inefficiency: because of both the modified allocation strategy and the
21667 generic implementation, code performance is hampered.
21668 @end enumerate
21670 Note that old-style stack checking is also the fallback method for
21671 @code{specific} if no target support has been added in the compiler.
21673 @item -fstack-limit-register=@var{reg}
21674 @itemx -fstack-limit-symbol=@var{sym}
21675 @itemx -fno-stack-limit
21676 @opindex fstack-limit-register
21677 @opindex fstack-limit-symbol
21678 @opindex fno-stack-limit
21679 Generate code to ensure that the stack does not grow beyond a certain value,
21680 either the value of a register or the address of a symbol.  If a larger
21681 stack is required, a signal is raised at run time.  For most targets,
21682 the signal is raised before the stack overruns the boundary, so
21683 it is possible to catch the signal without taking special precautions.
21685 For instance, if the stack starts at absolute address @samp{0x80000000}
21686 and grows downwards, you can use the flags
21687 @option{-fstack-limit-symbol=__stack_limit} and
21688 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
21689 of 128KB@.  Note that this may only work with the GNU linker.
21691 @item -fsplit-stack
21692 @opindex fsplit-stack
21693 Generate code to automatically split the stack before it overflows.
21694 The resulting program has a discontiguous stack which can only
21695 overflow if the program is unable to allocate any more memory.  This
21696 is most useful when running threaded programs, as it is no longer
21697 necessary to calculate a good stack size to use for each thread.  This
21698 is currently only implemented for the i386 and x86_64 back ends running
21699 GNU/Linux.
21701 When code compiled with @option{-fsplit-stack} calls code compiled
21702 without @option{-fsplit-stack}, there may not be much stack space
21703 available for the latter code to run.  If compiling all code,
21704 including library code, with @option{-fsplit-stack} is not an option,
21705 then the linker can fix up these calls so that the code compiled
21706 without @option{-fsplit-stack} always has a large stack.  Support for
21707 this is implemented in the gold linker in GNU binutils release 2.21
21708 and later.
21710 @item -fleading-underscore
21711 @opindex fleading-underscore
21712 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
21713 change the way C symbols are represented in the object file.  One use
21714 is to help link with legacy assembly code.
21716 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
21717 generate code that is not binary compatible with code generated without that
21718 switch.  Use it to conform to a non-default application binary interface.
21719 Not all targets provide complete support for this switch.
21721 @item -ftls-model=@var{model}
21722 @opindex ftls-model
21723 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
21724 The @var{model} argument should be one of @code{global-dynamic},
21725 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
21726 Note that the choice is subject to optimization: the compiler may use
21727 a more efficient model for symbols not visible outside of the translation
21728 unit, or if @option{-fpic} is not given on the command line.
21730 The default without @option{-fpic} is @code{initial-exec}; with
21731 @option{-fpic} the default is @code{global-dynamic}.
21733 @item -fvisibility=@var{default|internal|hidden|protected}
21734 @opindex fvisibility
21735 Set the default ELF image symbol visibility to the specified option---all
21736 symbols are marked with this unless overridden within the code.
21737 Using this feature can very substantially improve linking and
21738 load times of shared object libraries, produce more optimized
21739 code, provide near-perfect API export and prevent symbol clashes.
21740 It is @strong{strongly} recommended that you use this in any shared objects
21741 you distribute.
21743 Despite the nomenclature, @code{default} always means public; i.e.,
21744 available to be linked against from outside the shared object.
21745 @code{protected} and @code{internal} are pretty useless in real-world
21746 usage so the only other commonly used option is @code{hidden}.
21747 The default if @option{-fvisibility} isn't specified is
21748 @code{default}, i.e., make every
21749 symbol public---this causes the same behavior as previous versions of
21750 GCC@.
21752 A good explanation of the benefits offered by ensuring ELF
21753 symbols have the correct visibility is given by ``How To Write
21754 Shared Libraries'' by Ulrich Drepper (which can be found at
21755 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
21756 solution made possible by this option to marking things hidden when
21757 the default is public is to make the default hidden and mark things
21758 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
21759 and @code{__attribute__ ((visibility("default")))} instead of
21760 @code{__declspec(dllexport)} you get almost identical semantics with
21761 identical syntax.  This is a great boon to those working with
21762 cross-platform projects.
21764 For those adding visibility support to existing code, you may find
21765 @samp{#pragma GCC visibility} of use.  This works by you enclosing
21766 the declarations you wish to set visibility for with (for example)
21767 @samp{#pragma GCC visibility push(hidden)} and
21768 @samp{#pragma GCC visibility pop}.
21769 Bear in mind that symbol visibility should be viewed @strong{as
21770 part of the API interface contract} and thus all new code should
21771 always specify visibility when it is not the default; i.e., declarations
21772 only for use within the local DSO should @strong{always} be marked explicitly
21773 as hidden as so to avoid PLT indirection overheads---making this
21774 abundantly clear also aids readability and self-documentation of the code.
21775 Note that due to ISO C++ specification requirements, @code{operator new} and
21776 @code{operator delete} must always be of default visibility.
21778 Be aware that headers from outside your project, in particular system
21779 headers and headers from any other library you use, may not be
21780 expecting to be compiled with visibility other than the default.  You
21781 may need to explicitly say @samp{#pragma GCC visibility push(default)}
21782 before including any such headers.
21784 @samp{extern} declarations are not affected by @option{-fvisibility}, so
21785 a lot of code can be recompiled with @option{-fvisibility=hidden} with
21786 no modifications.  However, this means that calls to @code{extern}
21787 functions with no explicit visibility use the PLT, so it is more
21788 effective to use @code{__attribute ((visibility))} and/or
21789 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
21790 declarations should be treated as hidden.
21792 Note that @option{-fvisibility} does affect C++ vague linkage
21793 entities. This means that, for instance, an exception class that is
21794 be thrown between DSOs must be explicitly marked with default
21795 visibility so that the @samp{type_info} nodes are unified between
21796 the DSOs.
21798 An overview of these techniques, their benefits and how to use them
21799 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
21801 @item -fstrict-volatile-bitfields
21802 @opindex fstrict-volatile-bitfields
21803 This option should be used if accesses to volatile bit-fields (or other
21804 structure fields, although the compiler usually honors those types
21805 anyway) should use a single access of the width of the
21806 field's type, aligned to a natural alignment if possible.  For
21807 example, targets with memory-mapped peripheral registers might require
21808 all such accesses to be 16 bits wide; with this flag you can
21809 declare all peripheral bit-fields as @code{unsigned short} (assuming short
21810 is 16 bits on these targets) to force GCC to use 16-bit accesses
21811 instead of, perhaps, a more efficient 32-bit access.
21813 If this option is disabled, the compiler uses the most efficient
21814 instruction.  In the previous example, that might be a 32-bit load
21815 instruction, even though that accesses bytes that do not contain
21816 any portion of the bit-field, or memory-mapped registers unrelated to
21817 the one being updated.
21819 The default value of this option is determined by the application binary
21820 interface for the target processor.
21822 @item -fsync-libcalls
21823 @opindex fsync-libcalls
21824 This option controls whether any out-of-line instance of the @code{__sync}
21825 family of functions may be used to implement the C++11 @code{__atomic}
21826 family of functions.
21828 The default value of this option is enabled, thus the only useful form
21829 of the option is @option{-fno-sync-libcalls}.  This option is used in
21830 the implementation of the @file{libatomic} runtime library.
21832 @end table
21834 @c man end
21836 @node Environment Variables
21837 @section Environment Variables Affecting GCC
21838 @cindex environment variables
21840 @c man begin ENVIRONMENT
21841 This section describes several environment variables that affect how GCC
21842 operates.  Some of them work by specifying directories or prefixes to use
21843 when searching for various kinds of files.  Some are used to specify other
21844 aspects of the compilation environment.
21846 Note that you can also specify places to search using options such as
21847 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
21848 take precedence over places specified using environment variables, which
21849 in turn take precedence over those specified by the configuration of GCC@.
21850 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
21851 GNU Compiler Collection (GCC) Internals}.
21853 @table @env
21854 @item LANG
21855 @itemx LC_CTYPE
21856 @c @itemx LC_COLLATE
21857 @itemx LC_MESSAGES
21858 @c @itemx LC_MONETARY
21859 @c @itemx LC_NUMERIC
21860 @c @itemx LC_TIME
21861 @itemx LC_ALL
21862 @findex LANG
21863 @findex LC_CTYPE
21864 @c @findex LC_COLLATE
21865 @findex LC_MESSAGES
21866 @c @findex LC_MONETARY
21867 @c @findex LC_NUMERIC
21868 @c @findex LC_TIME
21869 @findex LC_ALL
21870 @cindex locale
21871 These environment variables control the way that GCC uses
21872 localization information which allows GCC to work with different
21873 national conventions.  GCC inspects the locale categories
21874 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
21875 so.  These locale categories can be set to any value supported by your
21876 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
21877 Kingdom encoded in UTF-8.
21879 The @env{LC_CTYPE} environment variable specifies character
21880 classification.  GCC uses it to determine the character boundaries in
21881 a string; this is needed for some multibyte encodings that contain quote
21882 and escape characters that are otherwise interpreted as a string
21883 end or escape.
21885 The @env{LC_MESSAGES} environment variable specifies the language to
21886 use in diagnostic messages.
21888 If the @env{LC_ALL} environment variable is set, it overrides the value
21889 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
21890 and @env{LC_MESSAGES} default to the value of the @env{LANG}
21891 environment variable.  If none of these variables are set, GCC
21892 defaults to traditional C English behavior.
21894 @item TMPDIR
21895 @findex TMPDIR
21896 If @env{TMPDIR} is set, it specifies the directory to use for temporary
21897 files.  GCC uses temporary files to hold the output of one stage of
21898 compilation which is to be used as input to the next stage: for example,
21899 the output of the preprocessor, which is the input to the compiler
21900 proper.
21902 @item GCC_COMPARE_DEBUG
21903 @findex GCC_COMPARE_DEBUG
21904 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
21905 @option{-fcompare-debug} to the compiler driver.  See the documentation
21906 of this option for more details.
21908 @item GCC_EXEC_PREFIX
21909 @findex GCC_EXEC_PREFIX
21910 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
21911 names of the subprograms executed by the compiler.  No slash is added
21912 when this prefix is combined with the name of a subprogram, but you can
21913 specify a prefix that ends with a slash if you wish.
21915 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
21916 an appropriate prefix to use based on the pathname it is invoked with.
21918 If GCC cannot find the subprogram using the specified prefix, it
21919 tries looking in the usual places for the subprogram.
21921 The default value of @env{GCC_EXEC_PREFIX} is
21922 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
21923 the installed compiler. In many cases @var{prefix} is the value
21924 of @code{prefix} when you ran the @file{configure} script.
21926 Other prefixes specified with @option{-B} take precedence over this prefix.
21928 This prefix is also used for finding files such as @file{crt0.o} that are
21929 used for linking.
21931 In addition, the prefix is used in an unusual way in finding the
21932 directories to search for header files.  For each of the standard
21933 directories whose name normally begins with @samp{/usr/local/lib/gcc}
21934 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
21935 replacing that beginning with the specified prefix to produce an
21936 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
21937 @file{foo/bar} just before it searches the standard directory 
21938 @file{/usr/local/lib/bar}.
21939 If a standard directory begins with the configured
21940 @var{prefix} then the value of @var{prefix} is replaced by
21941 @env{GCC_EXEC_PREFIX} when looking for header files.
21943 @item COMPILER_PATH
21944 @findex COMPILER_PATH
21945 The value of @env{COMPILER_PATH} is a colon-separated list of
21946 directories, much like @env{PATH}.  GCC tries the directories thus
21947 specified when searching for subprograms, if it can't find the
21948 subprograms using @env{GCC_EXEC_PREFIX}.
21950 @item LIBRARY_PATH
21951 @findex LIBRARY_PATH
21952 The value of @env{LIBRARY_PATH} is a colon-separated list of
21953 directories, much like @env{PATH}.  When configured as a native compiler,
21954 GCC tries the directories thus specified when searching for special
21955 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
21956 using GCC also uses these directories when searching for ordinary
21957 libraries for the @option{-l} option (but directories specified with
21958 @option{-L} come first).
21960 @item LANG
21961 @findex LANG
21962 @cindex locale definition
21963 This variable is used to pass locale information to the compiler.  One way in
21964 which this information is used is to determine the character set to be used
21965 when character literals, string literals and comments are parsed in C and C++.
21966 When the compiler is configured to allow multibyte characters,
21967 the following values for @env{LANG} are recognized:
21969 @table @samp
21970 @item C-JIS
21971 Recognize JIS characters.
21972 @item C-SJIS
21973 Recognize SJIS characters.
21974 @item C-EUCJP
21975 Recognize EUCJP characters.
21976 @end table
21978 If @env{LANG} is not defined, or if it has some other value, then the
21979 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
21980 recognize and translate multibyte characters.
21981 @end table
21983 @noindent
21984 Some additional environment variables affect the behavior of the
21985 preprocessor.
21987 @include cppenv.texi
21989 @c man end
21991 @node Precompiled Headers
21992 @section Using Precompiled Headers
21993 @cindex precompiled headers
21994 @cindex speed of compilation
21996 Often large projects have many header files that are included in every
21997 source file.  The time the compiler takes to process these header files
21998 over and over again can account for nearly all of the time required to
21999 build the project.  To make builds faster, GCC allows you to
22000 @dfn{precompile} a header file.
22002 To create a precompiled header file, simply compile it as you would any
22003 other file, if necessary using the @option{-x} option to make the driver
22004 treat it as a C or C++ header file.  You may want to use a
22005 tool like @command{make} to keep the precompiled header up-to-date when
22006 the headers it contains change.
22008 A precompiled header file is searched for when @code{#include} is
22009 seen in the compilation.  As it searches for the included file
22010 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
22011 compiler looks for a precompiled header in each directory just before it
22012 looks for the include file in that directory.  The name searched for is
22013 the name specified in the @code{#include} with @samp{.gch} appended.  If
22014 the precompiled header file can't be used, it is ignored.
22016 For instance, if you have @code{#include "all.h"}, and you have
22017 @file{all.h.gch} in the same directory as @file{all.h}, then the
22018 precompiled header file is used if possible, and the original
22019 header is used otherwise.
22021 Alternatively, you might decide to put the precompiled header file in a
22022 directory and use @option{-I} to ensure that directory is searched
22023 before (or instead of) the directory containing the original header.
22024 Then, if you want to check that the precompiled header file is always
22025 used, you can put a file of the same name as the original header in this
22026 directory containing an @code{#error} command.
22028 This also works with @option{-include}.  So yet another way to use
22029 precompiled headers, good for projects not designed with precompiled
22030 header files in mind, is to simply take most of the header files used by
22031 a project, include them from another header file, precompile that header
22032 file, and @option{-include} the precompiled header.  If the header files
22033 have guards against multiple inclusion, they are skipped because
22034 they've already been included (in the precompiled header).
22036 If you need to precompile the same header file for different
22037 languages, targets, or compiler options, you can instead make a
22038 @emph{directory} named like @file{all.h.gch}, and put each precompiled
22039 header in the directory, perhaps using @option{-o}.  It doesn't matter
22040 what you call the files in the directory; every precompiled header in
22041 the directory is considered.  The first precompiled header
22042 encountered in the directory that is valid for this compilation is
22043 used; they're searched in no particular order.
22045 There are many other possibilities, limited only by your imagination,
22046 good sense, and the constraints of your build system.
22048 A precompiled header file can be used only when these conditions apply:
22050 @itemize
22051 @item
22052 Only one precompiled header can be used in a particular compilation.
22054 @item
22055 A precompiled header can't be used once the first C token is seen.  You
22056 can have preprocessor directives before a precompiled header; you cannot
22057 include a precompiled header from inside another header.
22059 @item
22060 The precompiled header file must be produced for the same language as
22061 the current compilation.  You can't use a C precompiled header for a C++
22062 compilation.
22064 @item
22065 The precompiled header file must have been produced by the same compiler
22066 binary as the current compilation is using.
22068 @item
22069 Any macros defined before the precompiled header is included must
22070 either be defined in the same way as when the precompiled header was
22071 generated, or must not affect the precompiled header, which usually
22072 means that they don't appear in the precompiled header at all.
22074 The @option{-D} option is one way to define a macro before a
22075 precompiled header is included; using a @code{#define} can also do it.
22076 There are also some options that define macros implicitly, like
22077 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
22078 defined this way.
22080 @item If debugging information is output when using the precompiled
22081 header, using @option{-g} or similar, the same kind of debugging information
22082 must have been output when building the precompiled header.  However,
22083 a precompiled header built using @option{-g} can be used in a compilation
22084 when no debugging information is being output.
22086 @item The same @option{-m} options must generally be used when building
22087 and using the precompiled header.  @xref{Submodel Options},
22088 for any cases where this rule is relaxed.
22090 @item Each of the following options must be the same when building and using
22091 the precompiled header:
22093 @gccoptlist{-fexceptions}
22095 @item
22096 Some other command-line options starting with @option{-f},
22097 @option{-p}, or @option{-O} must be defined in the same way as when
22098 the precompiled header was generated.  At present, it's not clear
22099 which options are safe to change and which are not; the safest choice
22100 is to use exactly the same options when generating and using the
22101 precompiled header.  The following are known to be safe:
22103 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
22104 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
22105 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
22106 -pedantic-errors}
22108 @end itemize
22110 For all of these except the last, the compiler automatically
22111 ignores the precompiled header if the conditions aren't met.  If you
22112 find an option combination that doesn't work and doesn't cause the
22113 precompiled header to be ignored, please consider filing a bug report,
22114 see @ref{Bugs}.
22116 If you do use differing options when generating and using the
22117 precompiled header, the actual behavior is a mixture of the
22118 behavior for the options.  For instance, if you use @option{-g} to
22119 generate the precompiled header but not when using it, you may or may
22120 not get debugging information for routines in the precompiled header.