Merge branches/gcc-4_9-branch rev 225109.
[official-gcc.git] / gcc-4_9-branch / gcc / doc / invoke.texi
blob7477a555aeeae0c67e81c367dc80565ece4e3912
1 @c Copyright (C) 1988-2015 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-2015 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified.  Also,
105 the placement of the @option{-l} option is significant.
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}.  This manual documents
112 only one of these two forms, whichever one is not the default.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
118 @menu
119 * Option Summary::      Brief list of all options, without explanations.
120 * Overall Options::     Controlling the kind of output:
121                         an executable, object files, assembler files,
122                         or preprocessed source.
123 * Invoking G++::        Compiling C++ programs.
124 * C Dialect Options::   Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127                         and Objective-C++.
128 * Language Independent Options:: Controlling how diagnostics should be
129                         formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
161 -pipe  -pass-exit-codes  @gol
162 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
171 -fhosted  -ffreestanding -fopenmp -fopenmp-simd -fms-extensions @gol
172 -fplan9-extensions -trigraphs  -traditional  -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
191 -ftemplate-depth=@var{n} @gol
192 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
193 -fvisibility-inlines-hidden @gol
194 -fvtable-verify=@var{std|preinit|none} @gol
195 -fvtv-counts -fvtv-debug @gol
196 -fvisibility-ms-compat @gol
197 -fext-numeric-literals @gol
198 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
199 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
200 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
201 -Weffc++  -Wstrict-null-sentinel @gol
202 -Wno-non-template-friend  -Wold-style-cast @gol
203 -Woverloaded-virtual  -Wno-pmf-conversions @gol
204 -Wsign-promo}
206 @item Objective-C and Objective-C++ Language Options
207 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
208 Objective-C and Objective-C++ Dialects}.
209 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
210 -fgnu-runtime  -fnext-runtime @gol
211 -fno-nil-receivers @gol
212 -fobjc-abi-version=@var{n} @gol
213 -fobjc-call-cxx-cdtors @gol
214 -fobjc-direct-dispatch @gol
215 -fobjc-exceptions @gol
216 -fobjc-gc @gol
217 -fobjc-nilcheck @gol
218 -fobjc-std=objc1 @gol
219 -freplace-objc-classes @gol
220 -fzero-link @gol
221 -gen-decls @gol
222 -Wassign-intercept @gol
223 -Wno-protocol  -Wselector @gol
224 -Wstrict-selector-match @gol
225 -Wundeclared-selector}
227 @item Language Independent Options
228 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
229 @gccoptlist{-fmessage-length=@var{n}  @gol
230 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
231 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
232 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
234 @item Warning Options
235 @xref{Warning Options,,Options to Request or Suppress Warnings}.
236 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
237 -pedantic-errors @gol
238 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
239 -Waggressive-loop-optimizations -Warray-bounds @gol
240 -Wno-attributes -Wno-builtin-macro-redefined @gol
241 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
242 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
243 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
244 -Wno-deprecated -Wno-deprecated-declarations -Wdisabled-optimization  @gol
245 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
246 -Wno-endif-labels -Werror  -Werror=* @gol
247 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
248 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
249 -Wformat-security  -Wformat-y2k @gol
250 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
251 -Wignored-qualifiers @gol
252 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
253 -Winit-self  -Winline -Wmaybe-uninitialized @gol
254 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
255 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
256 -Wlogical-op -Wlong-long @gol
257 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
258 -Wmissing-include-dirs @gol
259 -Wno-multichar  -Wnonnull  -Wno-overflow -Wopenmp-simd @gol
260 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
261 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
262 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
263 -Wredundant-decls  -Wno-return-local-addr @gol
264 -Wreturn-type  -Wsequence-point  -Wshadow @gol
265 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
266 -Wsizeof-pointer-memaccess @gol
267 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
268 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
270 -Wmissing-format-attribute @gol
271 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
272 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
273 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
274 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
275 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
276 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
277 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
278 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
279 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
281 @item C and Objective-C-only Warning Options
282 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
283 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
284 -Wold-style-declaration  -Wold-style-definition @gol
285 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
286 -Wdeclaration-after-statement -Wpointer-sign}
288 @item Debugging Options
289 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
290 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
291 -fsanitize=@var{style} @gol
292 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
293 -fdisable-ipa-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass_name} @gol
295 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
296 -fdisable-tree-@var{pass_name} @gol
297 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
298 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
299 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
300 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
301 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
302 -fdump-passes @gol
303 -fdump-statistics @gol
304 -fdump-tree-all @gol
305 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
306 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-cfg -fdump-tree-alias @gol
308 -fdump-tree-ch @gol
309 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-gimple@r{[}-raw@r{]} @gol
312 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-nrv -fdump-tree-vect @gol
319 -fdump-tree-sink @gol
320 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
323 -fdump-tree-vtable-verify @gol
324 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
325 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
326 -fdump-final-insns=@var{file} @gol
327 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
328 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
329 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
330 -fenable-@var{kind}-@var{pass} @gol
331 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
332 -fdebug-types-section -fmem-report-wpa @gol
333 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
334 -fopt-info @gol
335 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
336 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
337 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
338 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
339 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
340 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
341 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
342 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
343 -gvms  -gxcoff  -gxcoff+ @gol
344 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
345 -fdebug-prefix-map=@var{old}=@var{new} @gol
346 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
347 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
348 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
349 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
350 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
351 -print-sysroot -print-sysroot-headers-suffix @gol
352 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
354 @item Optimization Options
355 @xref{Optimize Options,,Options that Control Optimization}.
356 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
357 -falign-jumps[=@var{n}] @gol
358 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
359 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
360 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
361 -fbtr-bb-exclusive -fcaller-saves @gol
362 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
363 -fcompare-elim -fcprop-registers -fcrossjumping @gol
364 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
365 -fcx-limited-range @gol
366 -fdata-sections -fdce -fdelayed-branch @gol
367 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively -fdse @gol
368 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
369 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
370 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
371 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
372 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
373 -fif-conversion2 -findirect-inlining @gol
374 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
375 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
376 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
377 -fira-algorithm=@var{algorithm} @gol
378 -fira-region=@var{region} -fira-hoist-pressure @gol
379 -fira-loop-pressure -fno-ira-share-save-slots @gol
380 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
381 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute
382 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
383 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
384 -floop-parallelize-all -flto -flto-compression-level @gol
385 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
386 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
387 -fmove-loop-invariants -fno-branch-count-reg @gol
388 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
389 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
390 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
391 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
392 -fomit-frame-pointer -foptimize-sibling-calls @gol
393 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
394 -fprefetch-loop-arrays -fprofile-report @gol
395 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
396 -fprofile-generate=@var{path} @gol
397 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
398 -freciprocal-math -free -frename-registers -freorder-blocks @gol
399 -freorder-blocks-and-partition -freorder-functions @gol
400 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
401 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
402 -fsched-spec-load -fsched-spec-load-dangerous @gol
403 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
404 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
405 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
406 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
407 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
408 -fselective-scheduling -fselective-scheduling2 @gol
409 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
410 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
411 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
412 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
413 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
414 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
415 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
416 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
417 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
418 -ftree-loop-if-convert-stores -ftree-loop-im @gol
419 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
420 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
421 -ftree-loop-vectorize @gol
422 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
423 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
424 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
425 -ftree-vectorize -ftree-vrp @gol
426 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
427 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
428 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
429 -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
430 --param @var{name}=@var{value}
431 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
433 @item Preprocessor Options
434 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
435 @gccoptlist{-A@var{question}=@var{answer} @gol
436 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
437 -C  -dD  -dI  -dM  -dN @gol
438 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
439 -idirafter @var{dir} @gol
440 -include @var{file}  -imacros @var{file} @gol
441 -iprefix @var{file}  -iwithprefix @var{dir} @gol
442 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
443 -imultilib @var{dir} -isysroot @var{dir} @gol
444 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
445 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
446 -remap -trigraphs  -undef  -U@var{macro}  @gol
447 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
449 @item Assembler Option
450 @xref{Assembler Options,,Passing Options to the Assembler}.
451 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
453 @item Linker Options
454 @xref{Link Options,,Options for Linking}.
455 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
456 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
457 -s  -static -static-libgcc -static-libstdc++ @gol
458 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
459 -shared -shared-libgcc  -symbolic @gol
460 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
461 -u @var{symbol}}
463 @item Directory Options
464 @xref{Directory Options,,Options for Directory Search}.
465 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
466 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
467 --sysroot=@var{dir} --no-sysroot-suffix}
469 @item Machine Dependent Options
470 @xref{Submodel Options,,Hardware Models and Configurations}.
471 @c This list is ordered alphanumerically by subsection name.
472 @c Try and put the significant identifier (CPU or system) first,
473 @c so users have a clue at guessing where the ones they want will be.
475 @emph{AArch64 Options}
476 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
477 -mgeneral-regs-only @gol
478 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
479 -mstrict-align @gol
480 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
481 -mtls-dialect=desc  -mtls-dialect=traditional @gol
482 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
483 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
484 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
486 @emph{Adapteva Epiphany Options}
487 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
488 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
489 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
490 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
491 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
492 -msplit-vecmove-early -m1reg-@var{reg}}
494 @emph{ARC Options}
495 @gccoptlist{-mbarrel-shifter @gol
496 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
497 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
498 -mea -mno-mpy -mmul32x16 -mmul64 @gol
499 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
500 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
501 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
502 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
503 -mucb-mcount -mvolatile-cache @gol
504 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
505 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
506 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
507 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
508 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
509 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
511 @emph{ARM Options}
512 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
513 -mabi=@var{name} @gol
514 -mapcs-stack-check  -mno-apcs-stack-check @gol
515 -mapcs-float  -mno-apcs-float @gol
516 -mapcs-reentrant  -mno-apcs-reentrant @gol
517 -msched-prolog  -mno-sched-prolog @gol
518 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
519 -mfloat-abi=@var{name} @gol
520 -mfp16-format=@var{name}
521 -mthumb-interwork  -mno-thumb-interwork @gol
522 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
523 -mstructure-size-boundary=@var{n} @gol
524 -mabort-on-noreturn @gol
525 -mlong-calls  -mno-long-calls @gol
526 -msingle-pic-base  -mno-single-pic-base @gol
527 -mpic-register=@var{reg} @gol
528 -mnop-fun-dllimport @gol
529 -mpoke-function-name @gol
530 -mthumb  -marm @gol
531 -mtpcs-frame  -mtpcs-leaf-frame @gol
532 -mcaller-super-interworking  -mcallee-super-interworking @gol
533 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
534 -mword-relocations @gol
535 -mfix-cortex-m3-ldrd @gol
536 -munaligned-access @gol
537 -mneon-for-64bits @gol
538 -mslow-flash-data @gol
539 -mrestrict-it}
541 @emph{AVR Options}
542 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
543 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
544 -mstrict-X -mtiny-stack -Waddr-space-convert}
546 @emph{Blackfin Options}
547 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
548 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
549 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
550 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
551 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
552 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
553 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
554 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
555 -micplb}
557 @emph{C6X Options}
558 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
559 -msim -msdata=@var{sdata-type}}
561 @emph{CRIS Options}
562 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
563 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
564 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
565 -mstack-align  -mdata-align  -mconst-align @gol
566 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
567 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
568 -mmul-bug-workaround  -mno-mul-bug-workaround}
570 @emph{CR16 Options}
571 @gccoptlist{-mmac @gol
572 -mcr16cplus -mcr16c @gol
573 -msim -mint32 -mbit-ops
574 -mdata-model=@var{model}}
576 @emph{Darwin Options}
577 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
578 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
579 -client_name  -compatibility_version  -current_version @gol
580 -dead_strip @gol
581 -dependency-file  -dylib_file  -dylinker_install_name @gol
582 -dynamic  -dynamiclib  -exported_symbols_list @gol
583 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
584 -force_flat_namespace  -headerpad_max_install_names @gol
585 -iframework @gol
586 -image_base  -init  -install_name  -keep_private_externs @gol
587 -multi_module  -multiply_defined  -multiply_defined_unused @gol
588 -noall_load   -no_dead_strip_inits_and_terms @gol
589 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
590 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
591 -private_bundle  -read_only_relocs  -sectalign @gol
592 -sectobjectsymbols  -whyload  -seg1addr @gol
593 -sectcreate  -sectobjectsymbols  -sectorder @gol
594 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
595 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
596 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
597 -single_module  -static  -sub_library  -sub_umbrella @gol
598 -twolevel_namespace  -umbrella  -undefined @gol
599 -unexported_symbols_list  -weak_reference_mismatches @gol
600 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
601 -mkernel -mone-byte-bool}
603 @emph{DEC Alpha Options}
604 @gccoptlist{-mno-fp-regs  -msoft-float @gol
605 -mieee  -mieee-with-inexact  -mieee-conformant @gol
606 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
607 -mtrap-precision=@var{mode}  -mbuild-constants @gol
608 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
609 -mbwx  -mmax  -mfix  -mcix @gol
610 -mfloat-vax  -mfloat-ieee @gol
611 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
612 -msmall-text  -mlarge-text @gol
613 -mmemory-latency=@var{time}}
615 @emph{FR30 Options}
616 @gccoptlist{-msmall-model -mno-lsim}
618 @emph{FRV Options}
619 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
620 -mhard-float  -msoft-float @gol
621 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
622 -mdouble  -mno-double @gol
623 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
624 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
625 -mlinked-fp  -mlong-calls  -malign-labels @gol
626 -mlibrary-pic  -macc-4  -macc-8 @gol
627 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
628 -moptimize-membar -mno-optimize-membar @gol
629 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
630 -mvliw-branch  -mno-vliw-branch @gol
631 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
632 -mno-nested-cond-exec  -mtomcat-stats @gol
633 -mTLS -mtls @gol
634 -mcpu=@var{cpu}}
636 @emph{GNU/Linux Options}
637 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
638 -tno-android-cc -tno-android-ld}
640 @emph{H8/300 Options}
641 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
643 @emph{HPPA Options}
644 @gccoptlist{-march=@var{architecture-type} @gol
645 -mdisable-fpregs  -mdisable-indexing @gol
646 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
647 -mfixed-range=@var{register-range} @gol
648 -mjump-in-delay -mlinker-opt -mlong-calls @gol
649 -mlong-load-store  -mno-disable-fpregs @gol
650 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
651 -mno-jump-in-delay  -mno-long-load-store @gol
652 -mno-portable-runtime  -mno-soft-float @gol
653 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
654 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
655 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
656 -munix=@var{unix-std}  -nolibdld  -static  -threads}
658 @emph{i386 and x86-64 Options}
659 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
660 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
661 -mfpmath=@var{unit} @gol
662 -masm=@var{dialect}  -mno-fancy-math-387 @gol
663 -mno-fp-ret-in-387  -msoft-float @gol
664 -mno-wide-multiply  -mrtd  -malign-double @gol
665 -mpreferred-stack-boundary=@var{num} @gol
666 -mincoming-stack-boundary=@var{num} @gol
667 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
668 -mrecip -mrecip=@var{opt} @gol
669 -mvzeroupper -mprefer-avx128 @gol
670 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
671 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
672 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
673 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
674 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mthreads @gol
675 -mno-align-stringops  -minline-all-stringops @gol
676 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
677 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
678 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
679 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
680 -mregparm=@var{num}  -msseregparm @gol
681 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
682 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
683 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
684 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
685 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
686 -msse2avx -mfentry -m8bit-idiv @gol
687 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
688 -mstack-protector-guard=@var{guard}}
690 @emph{i386 and x86-64 Windows Options}
691 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
692 -mnop-fun-dllimport -mthread @gol
693 -municode -mwin32 -mwindows -fno-set-stack-executable}
695 @emph{IA-64 Options}
696 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
697 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
698 -mconstant-gp  -mauto-pic  -mfused-madd @gol
699 -minline-float-divide-min-latency @gol
700 -minline-float-divide-max-throughput @gol
701 -mno-inline-float-divide @gol
702 -minline-int-divide-min-latency @gol
703 -minline-int-divide-max-throughput  @gol
704 -mno-inline-int-divide @gol
705 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
706 -mno-inline-sqrt @gol
707 -mdwarf2-asm -mearly-stop-bits @gol
708 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
709 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
710 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
711 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
712 -msched-spec-ldc -msched-spec-control-ldc @gol
713 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
714 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
715 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
716 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
718 @emph{LM32 Options}
719 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
720 -msign-extend-enabled -muser-enabled}
722 @emph{M32R/D Options}
723 @gccoptlist{-m32r2 -m32rx -m32r @gol
724 -mdebug @gol
725 -malign-loops -mno-align-loops @gol
726 -missue-rate=@var{number} @gol
727 -mbranch-cost=@var{number} @gol
728 -mmodel=@var{code-size-model-type} @gol
729 -msdata=@var{sdata-type} @gol
730 -mno-flush-func -mflush-func=@var{name} @gol
731 -mno-flush-trap -mflush-trap=@var{number} @gol
732 -G @var{num}}
734 @emph{M32C Options}
735 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
737 @emph{M680x0 Options}
738 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
739 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
740 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
741 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
742 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
743 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
744 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
745 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
746 -mxgot -mno-xgot}
748 @emph{MCore Options}
749 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
750 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
751 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
752 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
753 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
755 @emph{MeP Options}
756 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
757 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
758 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
759 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
760 -mtiny=@var{n}}
762 @emph{MicroBlaze Options}
763 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
764 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
765 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
766 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
767 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
769 @emph{MIPS Options}
770 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
771 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
772 -mips64  -mips64r2 @gol
773 -mips16  -mno-mips16  -mflip-mips16 @gol
774 -minterlink-compressed -mno-interlink-compressed @gol
775 -minterlink-mips16  -mno-interlink-mips16 @gol
776 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
777 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
778 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
779 -mno-float  -msingle-float  -mdouble-float @gol
780 -mabs=@var{mode}  -mnan=@var{encoding} @gol
781 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
782 -mmcu -mmno-mcu @gol
783 -meva -mno-eva @gol
784 -mvirt -mno-virt @gol
785 -mmicromips -mno-micromips @gol
786 -mfpu=@var{fpu-type} @gol
787 -msmartmips  -mno-smartmips @gol
788 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
789 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
790 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
791 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
792 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
793 -membedded-data  -mno-embedded-data @gol
794 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
795 -mcode-readable=@var{setting} @gol
796 -msplit-addresses  -mno-split-addresses @gol
797 -mexplicit-relocs  -mno-explicit-relocs @gol
798 -mcheck-zero-division  -mno-check-zero-division @gol
799 -mdivide-traps  -mdivide-breaks @gol
800 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
801 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
802 -mfix-24k -mno-fix-24k @gol
803 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
804 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
805 -mfix-vr4120  -mno-fix-vr4120 @gol
806 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
807 -mflush-func=@var{func}  -mno-flush-func @gol
808 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
809 -mfp-exceptions -mno-fp-exceptions @gol
810 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
811 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
813 @emph{MMIX Options}
814 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
815 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
816 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
817 -mno-base-addresses  -msingle-exit  -mno-single-exit}
819 @emph{MN10300 Options}
820 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
821 -mno-am33 -mam33 -mam33-2 -mam34 @gol
822 -mtune=@var{cpu-type} @gol
823 -mreturn-pointer-on-d0 @gol
824 -mno-crt0  -mrelax -mliw -msetlb}
826 @emph{Moxie Options}
827 @gccoptlist{-meb -mel -mno-crt0}
829 @emph{MSP430 Options}
830 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
831 -mhwmult= -minrt}
833 @emph{NDS32 Options}
834 @gccoptlist{-mbig-endian -mlittle-endian @gol
835 -mreduced-regs -mfull-regs @gol
836 -mcmov -mno-cmov @gol
837 -mperf-ext -mno-perf-ext @gol
838 -mv3push -mno-v3push @gol
839 -m16bit -mno-16bit @gol
840 -mgp-direct -mno-gp-direct @gol
841 -misr-vector-size=@var{num} @gol
842 -mcache-block-size=@var{num} @gol
843 -march=@var{arch} @gol
844 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
845 -mex9 -mctor-dtor -mrelax}
847 @emph{Nios II Options}
848 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
849 -mno-bypass-cache -mbypass-cache @gol
850 -mno-cache-volatile -mcache-volatile @gol
851 -mno-fast-sw-div -mfast-sw-div @gol
852 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
853 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
854 -mcustom-fpu-cfg=@var{name} @gol
855 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
857 @emph{PDP-11 Options}
858 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
859 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
860 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
861 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
862 -mbranch-expensive  -mbranch-cheap @gol
863 -munix-asm  -mdec-asm}
865 @emph{picoChip Options}
866 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
867 -msymbol-as-address -mno-inefficient-warnings}
869 @emph{PowerPC Options}
870 See RS/6000 and PowerPC Options.
872 @emph{RL78 Options}
873 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
875 @emph{RS/6000 and PowerPC Options}
876 @gccoptlist{-mcpu=@var{cpu-type} @gol
877 -mtune=@var{cpu-type} @gol
878 -mcmodel=@var{code-model} @gol
879 -mpowerpc64 @gol
880 -maltivec  -mno-altivec @gol
881 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
882 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
883 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
884 -mfprnd  -mno-fprnd @gol
885 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
886 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
887 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
888 -malign-power  -malign-natural @gol
889 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
890 -msingle-float -mdouble-float -msimple-fpu @gol
891 -mstring  -mno-string  -mupdate  -mno-update @gol
892 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
893 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
894 -mstrict-align  -mno-strict-align  -mrelocatable @gol
895 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
896 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
897 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
898 -mprioritize-restricted-insns=@var{priority} @gol
899 -msched-costly-dep=@var{dependence_type} @gol
900 -minsert-sched-nops=@var{scheme} @gol
901 -mcall-sysv  -mcall-netbsd @gol
902 -maix-struct-return  -msvr4-struct-return @gol
903 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
904 -mblock-move-inline-limit=@var{num} @gol
905 -misel -mno-isel @gol
906 -misel=yes  -misel=no @gol
907 -mspe -mno-spe @gol
908 -mspe=yes  -mspe=no @gol
909 -mpaired @gol
910 -mgen-cell-microcode -mwarn-cell-microcode @gol
911 -mvrsave -mno-vrsave @gol
912 -mmulhw -mno-mulhw @gol
913 -mdlmzb -mno-dlmzb @gol
914 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
915 -mprototype  -mno-prototype @gol
916 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
917 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
918 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
919 -mno-recip-precision @gol
920 -mveclibabi=@var{type} -mfriz -mno-friz @gol
921 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
922 -msave-toc-indirect -mno-save-toc-indirect @gol
923 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
924 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
925 -mquad-memory -mno-quad-memory @gol
926 -mquad-memory-atomic -mno-quad-memory-atomic @gol
927 -mcompat-align-parm -mno-compat-align-parm}
929 @emph{RX Options}
930 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
931 -mcpu=@gol
932 -mbig-endian-data -mlittle-endian-data @gol
933 -msmall-data @gol
934 -msim  -mno-sim@gol
935 -mas100-syntax -mno-as100-syntax@gol
936 -mrelax@gol
937 -mmax-constant-size=@gol
938 -mint-register=@gol
939 -mpid@gol
940 -mno-warn-multiple-fast-interrupts@gol
941 -msave-acc-in-interrupts}
943 @emph{S/390 and zSeries Options}
944 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
945 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
946 -mlong-double-64 -mlong-double-128 @gol
947 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
948 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
949 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
950 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
951 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
952 -mhotpatch=@var{halfwords},@var{halfwords}}
954 @emph{Score Options}
955 @gccoptlist{-meb -mel @gol
956 -mnhwloop @gol
957 -muls @gol
958 -mmac @gol
959 -mscore5 -mscore5u -mscore7 -mscore7d}
961 @emph{SH Options}
962 @gccoptlist{-m1  -m2  -m2e @gol
963 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
964 -m3  -m3e @gol
965 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
966 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
967 -m5-64media  -m5-64media-nofpu @gol
968 -m5-32media  -m5-32media-nofpu @gol
969 -m5-compact  -m5-compact-nofpu @gol
970 -mb  -ml  -mdalign  -mrelax @gol
971 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
972 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
973 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
974 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
975 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
976 -maccumulate-outgoing-args -minvalid-symbols @gol
977 -matomic-model=@var{atomic-model} @gol
978 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
979 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
980 -mpretend-cmove -mtas}
982 @emph{Solaris 2 Options}
983 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
984 -pthreads -pthread}
986 @emph{SPARC Options}
987 @gccoptlist{-mcpu=@var{cpu-type} @gol
988 -mtune=@var{cpu-type} @gol
989 -mcmodel=@var{code-model} @gol
990 -mmemory-model=@var{mem-model} @gol
991 -m32  -m64  -mapp-regs  -mno-app-regs @gol
992 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
993 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
994 -mhard-quad-float  -msoft-quad-float @gol
995 -mstack-bias  -mno-stack-bias @gol
996 -munaligned-doubles  -mno-unaligned-doubles @gol
997 -muser-mode  -mno-user-mode @gol
998 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
999 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1000 -mcbcond -mno-cbcond @gol
1001 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1002 -mfix-at697f -mfix-ut699}
1004 @emph{SPU Options}
1005 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1006 -msafe-dma -munsafe-dma @gol
1007 -mbranch-hints @gol
1008 -msmall-mem -mlarge-mem -mstdmain @gol
1009 -mfixed-range=@var{register-range} @gol
1010 -mea32 -mea64 @gol
1011 -maddress-space-conversion -mno-address-space-conversion @gol
1012 -mcache-size=@var{cache-size} @gol
1013 -matomic-updates -mno-atomic-updates}
1015 @emph{System V Options}
1016 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1018 @emph{TILE-Gx Options}
1019 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1020 -mcmodel=@var{code-model}}
1022 @emph{TILEPro Options}
1023 @gccoptlist{-mcpu=@var{cpu} -m32}
1025 @emph{V850 Options}
1026 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1027 -mprolog-function  -mno-prolog-function  -mspace @gol
1028 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1029 -mapp-regs  -mno-app-regs @gol
1030 -mdisable-callt  -mno-disable-callt @gol
1031 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1032 -mv850e -mv850 -mv850e3v5 @gol
1033 -mloop @gol
1034 -mrelax @gol
1035 -mlong-jumps @gol
1036 -msoft-float @gol
1037 -mhard-float @gol
1038 -mgcc-abi @gol
1039 -mrh850-abi @gol
1040 -mbig-switch}
1042 @emph{VAX Options}
1043 @gccoptlist{-mg  -mgnu  -munix}
1045 @emph{VMS Options}
1046 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1047 -mpointer-size=@var{size}}
1049 @emph{VxWorks Options}
1050 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1051 -Xbind-lazy  -Xbind-now}
1053 @emph{x86-64 Options}
1054 See i386 and x86-64 Options.
1056 @emph{Xstormy16 Options}
1057 @gccoptlist{-msim}
1059 @emph{Xtensa Options}
1060 @gccoptlist{-mconst16 -mno-const16 @gol
1061 -mfused-madd  -mno-fused-madd @gol
1062 -mforce-no-pic @gol
1063 -mserialize-volatile  -mno-serialize-volatile @gol
1064 -mtext-section-literals  -mno-text-section-literals @gol
1065 -mtarget-align  -mno-target-align @gol
1066 -mlongcalls  -mno-longcalls}
1068 @emph{zSeries Options}
1069 See S/390 and zSeries Options.
1071 @item Code Generation Options
1072 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1073 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1074 -ffixed-@var{reg}  -fexceptions @gol
1075 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1076 -fasynchronous-unwind-tables @gol
1077 -fno-gnu-unique @gol
1078 -finhibit-size-directive  -finstrument-functions @gol
1079 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1080 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1081 -fno-common  -fno-ident @gol
1082 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1083 -fno-jump-tables @gol
1084 -frecord-gcc-switches @gol
1085 -freg-struct-return  -fshort-enums @gol
1086 -fshort-double  -fshort-wchar @gol
1087 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1088 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1089 -fno-stack-limit -fsplit-stack @gol
1090 -fleading-underscore  -ftls-model=@var{model} @gol
1091 -fstack-reuse=@var{reuse_level} @gol
1092 -ftrapv  -fwrapv  -fbounds-check @gol
1093 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1094 @end table
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 @opindex fplugin
1502 Load the plugin code in file @var{name}.so, assumed to be a
1503 shared object to be dlopen'd by the compiler.  The base name of
1504 the shared object file is used to identify the plugin for the
1505 purposes of argument parsing (See
1506 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1507 Each plugin should define the callback functions specified in the
1508 Plugins API.
1510 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1511 @opindex fplugin-arg
1512 Define an argument called @var{key} with a value of @var{value}
1513 for the plugin called @var{name}.
1515 @item -fdump-ada-spec@r{[}-slim@r{]}
1516 @opindex fdump-ada-spec
1517 For C and C++ source and include files, generate corresponding Ada specs.
1518 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1519 GNAT User's Guide}, which provides detailed documentation on this feature.
1521 @item -fada-spec-parent=@var{unit}
1522 @opindex fada-spec-parent
1523 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1524 Ada specs as child units of parent @var{unit}.
1526 @item -fdump-go-spec=@var{file}
1527 @opindex fdump-go-spec
1528 For input files in any language, generate corresponding Go
1529 declarations in @var{file}.  This generates Go @code{const},
1530 @code{type}, @code{var}, and @code{func} declarations which may be a
1531 useful way to start writing a Go interface to code written in some
1532 other language.
1534 @include @value{srcdir}/../libiberty/at-file.texi
1535 @end table
1537 @node Invoking G++
1538 @section Compiling C++ Programs
1540 @cindex suffixes for C++ source
1541 @cindex C++ source file suffixes
1542 C++ source files conventionally use one of the suffixes @samp{.C},
1543 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1544 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1545 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1546 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1547 files with these names and compiles them as C++ programs even if you
1548 call the compiler the same way as for compiling C programs (usually
1549 with the name @command{gcc}).
1551 @findex g++
1552 @findex c++
1553 However, the use of @command{gcc} does not add the C++ library.
1554 @command{g++} is a program that calls GCC and automatically specifies linking
1555 against the C++ library.  It treats @samp{.c},
1556 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1557 files unless @option{-x} is used.  This program is also useful when
1558 precompiling a C header file with a @samp{.h} extension for use in C++
1559 compilations.  On many systems, @command{g++} is also installed with
1560 the name @command{c++}.
1562 @cindex invoking @command{g++}
1563 When you compile C++ programs, you may specify many of the same
1564 command-line options that you use for compiling programs in any
1565 language; or command-line options meaningful for C and related
1566 languages; or options that are meaningful only for C++ programs.
1567 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1568 explanations of options for languages related to C@.
1569 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1570 explanations of options that are meaningful only for C++ programs.
1572 @node C Dialect Options
1573 @section Options Controlling C Dialect
1574 @cindex dialect options
1575 @cindex language dialect options
1576 @cindex options, dialect
1578 The following options control the dialect of C (or languages derived
1579 from C, such as C++, Objective-C and Objective-C++) that the compiler
1580 accepts:
1582 @table @gcctabopt
1583 @cindex ANSI support
1584 @cindex ISO support
1585 @item -ansi
1586 @opindex ansi
1587 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1588 equivalent to @option{-std=c++98}.
1590 This turns off certain features of GCC that are incompatible with ISO
1591 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1592 such as the @code{asm} and @code{typeof} keywords, and
1593 predefined macros such as @code{unix} and @code{vax} that identify the
1594 type of system you are using.  It also enables the undesirable and
1595 rarely used ISO trigraph feature.  For the C compiler,
1596 it disables recognition of C++ style @samp{//} comments as well as
1597 the @code{inline} keyword.
1599 The alternate keywords @code{__asm__}, @code{__extension__},
1600 @code{__inline__} and @code{__typeof__} continue to work despite
1601 @option{-ansi}.  You would not want to use them in an ISO C program, of
1602 course, but it is useful to put them in header files that might be included
1603 in compilations done with @option{-ansi}.  Alternate predefined macros
1604 such as @code{__unix__} and @code{__vax__} are also available, with or
1605 without @option{-ansi}.
1607 The @option{-ansi} option does not cause non-ISO programs to be
1608 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1609 addition to @option{-ansi}.  @xref{Warning Options}.
1611 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1612 option is used.  Some header files may notice this macro and refrain
1613 from declaring certain functions or defining certain macros that the
1614 ISO standard doesn't call for; this is to avoid interfering with any
1615 programs that might use these names for other things.
1617 Functions that are normally built in but do not have semantics
1618 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1619 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1620 built-in functions provided by GCC}, for details of the functions
1621 affected.
1623 @item -std=
1624 @opindex std
1625 Determine the language standard. @xref{Standards,,Language Standards
1626 Supported by GCC}, for details of these standard versions.  This option
1627 is currently only supported when compiling C or C++.
1629 The compiler can accept several base standards, such as @samp{c90} or
1630 @samp{c++98}, and GNU dialects of those standards, such as
1631 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1632 compiler accepts all programs following that standard plus those
1633 using GNU extensions that do not contradict it.  For example,
1634 @option{-std=c90} turns off certain features of GCC that are
1635 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1636 keywords, but not other GNU extensions that do not have a meaning in
1637 ISO C90, such as omitting the middle term of a @code{?:}
1638 expression. On the other hand, when a GNU dialect of a standard is
1639 specified, all features supported by the compiler are enabled, even when
1640 those features change the meaning of the base standard.  As a result, some
1641 strict-conforming programs may be rejected.  The particular standard
1642 is used by @option{-Wpedantic} to identify which features are GNU
1643 extensions given that version of the standard. For example
1644 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1645 comments, while @option{-std=gnu99 -Wpedantic} does not.
1647 A value for this option must be provided; possible values are
1649 @table @samp
1650 @item c90
1651 @itemx c89
1652 @itemx iso9899:1990
1653 Support all ISO C90 programs (certain GNU extensions that conflict
1654 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1656 @item iso9899:199409
1657 ISO C90 as modified in amendment 1.
1659 @item c99
1660 @itemx c9x
1661 @itemx iso9899:1999
1662 @itemx iso9899:199x
1663 ISO C99.  This standard is substantially completely supported, modulo
1664 bugs, extended identifiers (supported except for corner cases when
1665 @option{-fextended-identifiers} is used) and floating-point issues
1666 (mainly but not entirely relating to optional C99 features from
1667 Annexes F and G).  See
1668 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1669 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1671 @item c11
1672 @itemx c1x
1673 @itemx iso9899:2011
1674 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1675 substantially completely supported, modulo bugs, extended identifiers
1676 (supported except for corner cases when
1677 @option{-fextended-identifiers} is used), floating-point issues
1678 (mainly but not entirely relating to optional C11 features from
1679 Annexes F and G) and the optional Annexes K (Bounds-checking
1680 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1682 @item gnu90
1683 @itemx gnu89
1684 GNU dialect of ISO C90 (including some C99 features). This
1685 is the default for C code.
1687 @item gnu99
1688 @itemx gnu9x
1689 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1691 @item gnu11
1692 @itemx gnu1x
1693 GNU dialect of ISO C11.  This is intended to become the default in a
1694 future release of GCC.  The name @samp{gnu1x} is deprecated.
1696 @item c++98
1697 @itemx c++03
1698 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1699 additional defect reports. Same as @option{-ansi} for C++ code.
1701 @item gnu++98
1702 @itemx gnu++03
1703 GNU dialect of @option{-std=c++98}.  This is the default for
1704 C++ code.
1706 @item c++11
1707 @itemx c++0x
1708 The 2011 ISO C++ standard plus amendments.
1709 The name @samp{c++0x} is deprecated.
1711 @item gnu++11
1712 @itemx gnu++0x
1713 GNU dialect of @option{-std=c++11}.
1714 The name @samp{gnu++0x} is deprecated.
1716 @item c++1y
1717 The next revision of the ISO C++ standard, tentatively planned for
1718 2014.  Support is highly experimental, and will almost certainly
1719 change in incompatible ways in future releases.
1721 @item gnu++1y
1722 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1723 and will almost certainly change in incompatible ways in future
1724 releases.
1725 @end table
1727 @item -fgnu89-inline
1728 @opindex fgnu89-inline
1729 The option @option{-fgnu89-inline} tells GCC to use the traditional
1730 GNU semantics for @code{inline} functions when in C99 mode.
1731 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1732 is accepted and ignored by GCC versions 4.1.3 up to but not including
1733 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1734 C99 mode.  Using this option is roughly equivalent to adding the
1735 @code{gnu_inline} function attribute to all inline functions
1736 (@pxref{Function Attributes}).
1738 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1739 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1740 specifies the default behavior).  This option was first supported in
1741 GCC 4.3.  This option is not supported in @option{-std=c90} or
1742 @option{-std=gnu90} mode.
1744 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1745 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1746 in effect for @code{inline} functions.  @xref{Common Predefined
1747 Macros,,,cpp,The C Preprocessor}.
1749 @item -aux-info @var{filename}
1750 @opindex aux-info
1751 Output to the given filename prototyped declarations for all functions
1752 declared and/or defined in a translation unit, including those in header
1753 files.  This option is silently ignored in any language other than C@.
1755 Besides declarations, the file indicates, in comments, the origin of
1756 each declaration (source file and line), whether the declaration was
1757 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1758 @samp{O} for old, respectively, in the first character after the line
1759 number and the colon), and whether it came from a declaration or a
1760 definition (@samp{C} or @samp{F}, respectively, in the following
1761 character).  In the case of function definitions, a K&R-style list of
1762 arguments followed by their declarations is also provided, inside
1763 comments, after the declaration.
1765 @item -fallow-parameterless-variadic-functions
1766 @opindex fallow-parameterless-variadic-functions
1767 Accept variadic functions without named parameters.
1769 Although it is possible to define such a function, this is not very
1770 useful as it is not possible to read the arguments.  This is only
1771 supported for C as this construct is allowed by C++.
1773 @item -fno-asm
1774 @opindex fno-asm
1775 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1776 keyword, so that code can use these words as identifiers.  You can use
1777 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1778 instead.  @option{-ansi} implies @option{-fno-asm}.
1780 In C++, this switch only affects the @code{typeof} keyword, since
1781 @code{asm} and @code{inline} are standard keywords.  You may want to
1782 use the @option{-fno-gnu-keywords} flag instead, which has the same
1783 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1784 switch only affects the @code{asm} and @code{typeof} keywords, since
1785 @code{inline} is a standard keyword in ISO C99.
1787 @item -fno-builtin
1788 @itemx -fno-builtin-@var{function}
1789 @opindex fno-builtin
1790 @cindex built-in functions
1791 Don't recognize built-in functions that do not begin with
1792 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1793 functions provided by GCC}, for details of the functions affected,
1794 including those which are not built-in functions when @option{-ansi} or
1795 @option{-std} options for strict ISO C conformance are used because they
1796 do not have an ISO standard meaning.
1798 GCC normally generates special code to handle certain built-in functions
1799 more efficiently; for instance, calls to @code{alloca} may become single
1800 instructions which adjust the stack directly, and calls to @code{memcpy}
1801 may become inline copy loops.  The resulting code is often both smaller
1802 and faster, but since the function calls no longer appear as such, you
1803 cannot set a breakpoint on those calls, nor can you change the behavior
1804 of the functions by linking with a different library.  In addition,
1805 when a function is recognized as a built-in function, GCC may use
1806 information about that function to warn about problems with calls to
1807 that function, or to generate more efficient code, even if the
1808 resulting code still contains calls to that function.  For example,
1809 warnings are given with @option{-Wformat} for bad calls to
1810 @code{printf} when @code{printf} is built in and @code{strlen} is
1811 known not to modify global memory.
1813 With the @option{-fno-builtin-@var{function}} option
1814 only the built-in function @var{function} is
1815 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1816 function is named that is not built-in in this version of GCC, this
1817 option is ignored.  There is no corresponding
1818 @option{-fbuiltin-@var{function}} option; if you wish to enable
1819 built-in functions selectively when using @option{-fno-builtin} or
1820 @option{-ffreestanding}, you may define macros such as:
1822 @smallexample
1823 #define abs(n)          __builtin_abs ((n))
1824 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1825 @end smallexample
1827 @item -fhosted
1828 @opindex fhosted
1829 @cindex hosted environment
1831 Assert that compilation targets a hosted environment.  This implies
1832 @option{-fbuiltin}.  A hosted environment is one in which the
1833 entire standard library is available, and in which @code{main} has a return
1834 type of @code{int}.  Examples are nearly everything except a kernel.
1835 This is equivalent to @option{-fno-freestanding}.
1837 @item -ffreestanding
1838 @opindex ffreestanding
1839 @cindex hosted environment
1841 Assert that compilation targets a freestanding environment.  This
1842 implies @option{-fno-builtin}.  A freestanding environment
1843 is one in which the standard library may not exist, and program startup may
1844 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1845 This is equivalent to @option{-fno-hosted}.
1847 @xref{Standards,,Language Standards Supported by GCC}, for details of
1848 freestanding and hosted environments.
1850 @item -fopenmp
1851 @opindex fopenmp
1852 @cindex OpenMP parallel
1853 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1854 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1855 compiler generates parallel code according to the OpenMP Application
1856 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1857 implies @option{-pthread}, and thus is only supported on targets that
1858 have support for @option{-pthread}. @option{-fopenmp} implies
1859 @option{-fopenmp-simd}.
1861 @item -fopenmp-simd
1862 @opindex fopenmp-simd
1863 @cindex OpenMP SIMD
1864 @cindex SIMD
1865 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1866 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1867 are ignored.
1869 @item -fcilkplus
1870 @opindex fcilkplus
1871 @cindex Enable Cilk Plus
1872 Enable the usage of Cilk Plus language extension features for C/C++.
1873 When the option @option{-fcilkplus} is specified, enable the usage of
1874 the Cilk Plus Language extension features for C/C++.  The present
1875 implementation follows ABI version 1.2.  This is an experimental
1876 feature that is only partially complete, and whose interface may
1877 change in future versions of GCC as the official specification
1878 changes.  Currently, all features but @code{_Cilk_for} have been
1879 implemented.
1881 @item -fgnu-tm
1882 @opindex fgnu-tm
1883 When the option @option{-fgnu-tm} is specified, the compiler
1884 generates code for the Linux variant of Intel's current Transactional
1885 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1886 an experimental feature whose interface may change in future versions
1887 of GCC, as the official specification changes.  Please note that not
1888 all architectures are supported for this feature.
1890 For more information on GCC's support for transactional memory,
1891 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1892 Transactional Memory Library}.
1894 Note that the transactional memory feature is not supported with
1895 non-call exceptions (@option{-fnon-call-exceptions}).
1897 @item -fms-extensions
1898 @opindex fms-extensions
1899 Accept some non-standard constructs used in Microsoft header files.
1901 In C++ code, this allows member names in structures to be similar
1902 to previous types declarations.
1904 @smallexample
1905 typedef int UOW;
1906 struct ABC @{
1907   UOW UOW;
1909 @end smallexample
1911 Some cases of unnamed fields in structures and unions are only
1912 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1913 fields within structs/unions}, for details.
1915 Note that this option is off for all targets but i?86 and x86_64
1916 targets using ms-abi.
1917 @item -fplan9-extensions
1918 Accept some non-standard constructs used in Plan 9 code.
1920 This enables @option{-fms-extensions}, permits passing pointers to
1921 structures with anonymous fields to functions that expect pointers to
1922 elements of the type of the field, and permits referring to anonymous
1923 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1924 struct/union fields within structs/unions}, for details.  This is only
1925 supported for C, not C++.
1927 @item -trigraphs
1928 @opindex trigraphs
1929 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1930 options for strict ISO C conformance) implies @option{-trigraphs}.
1932 @cindex traditional C language
1933 @cindex C language, traditional
1934 @item -traditional
1935 @itemx -traditional-cpp
1936 @opindex traditional-cpp
1937 @opindex traditional
1938 Formerly, these options caused GCC to attempt to emulate a pre-standard
1939 C compiler.  They are now only supported with the @option{-E} switch.
1940 The preprocessor continues to support a pre-standard mode.  See the GNU
1941 CPP manual for details.
1943 @item -fcond-mismatch
1944 @opindex fcond-mismatch
1945 Allow conditional expressions with mismatched types in the second and
1946 third arguments.  The value of such an expression is void.  This option
1947 is not supported for C++.
1949 @item -flax-vector-conversions
1950 @opindex flax-vector-conversions
1951 Allow implicit conversions between vectors with differing numbers of
1952 elements and/or incompatible element types.  This option should not be
1953 used for new code.
1955 @item -funsigned-char
1956 @opindex funsigned-char
1957 Let the type @code{char} be unsigned, like @code{unsigned char}.
1959 Each kind of machine has a default for what @code{char} should
1960 be.  It is either like @code{unsigned char} by default or like
1961 @code{signed char} by default.
1963 Ideally, a portable program should always use @code{signed char} or
1964 @code{unsigned char} when it depends on the signedness of an object.
1965 But many programs have been written to use plain @code{char} and
1966 expect it to be signed, or expect it to be unsigned, depending on the
1967 machines they were written for.  This option, and its inverse, let you
1968 make such a program work with the opposite default.
1970 The type @code{char} is always a distinct type from each of
1971 @code{signed char} or @code{unsigned char}, even though its behavior
1972 is always just like one of those two.
1974 @item -fsigned-char
1975 @opindex fsigned-char
1976 Let the type @code{char} be signed, like @code{signed char}.
1978 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1979 the negative form of @option{-funsigned-char}.  Likewise, the option
1980 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1982 @item -fsigned-bitfields
1983 @itemx -funsigned-bitfields
1984 @itemx -fno-signed-bitfields
1985 @itemx -fno-unsigned-bitfields
1986 @opindex fsigned-bitfields
1987 @opindex funsigned-bitfields
1988 @opindex fno-signed-bitfields
1989 @opindex fno-unsigned-bitfields
1990 These options control whether a bit-field is signed or unsigned, when the
1991 declaration does not use either @code{signed} or @code{unsigned}.  By
1992 default, such a bit-field is signed, because this is consistent: the
1993 basic integer types such as @code{int} are signed types.
1994 @end table
1996 @node C++ Dialect Options
1997 @section Options Controlling C++ Dialect
1999 @cindex compiler options, C++
2000 @cindex C++ options, command-line
2001 @cindex options, C++
2002 This section describes the command-line options that are only meaningful
2003 for C++ programs.  You can also use most of the GNU compiler options
2004 regardless of what language your program is in.  For example, you
2005 might compile a file @code{firstClass.C} like this:
2007 @smallexample
2008 g++ -g -frepo -O -c firstClass.C
2009 @end smallexample
2011 @noindent
2012 In this example, only @option{-frepo} is an option meant
2013 only for C++ programs; you can use the other options with any
2014 language supported by GCC@.
2016 Here is a list of options that are @emph{only} for compiling C++ programs:
2018 @table @gcctabopt
2020 @item -fabi-version=@var{n}
2021 @opindex fabi-version
2022 Use version @var{n} of the C++ ABI@.  The default is version 2.
2024 Version 0 refers to the version conforming most closely to
2025 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2026 will change in different versions of G++ as ABI bugs are fixed.
2028 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2030 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.  
2032 Version 3 corrects an error in mangling a constant address as a
2033 template argument.
2035 Version 4, which first appeared in G++ 4.5, implements a standard
2036 mangling for vector types.
2038 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2039 attribute const/volatile on function pointer types, decltype of a
2040 plain decl, and use of a function parameter in the declaration of
2041 another parameter.
2043 Version 6, which first appeared in G++ 4.7, corrects the promotion
2044 behavior of C++11 scoped enums and the mangling of template argument
2045 packs, const/static_cast, prefix ++ and --, and a class scope function
2046 used as a template argument.
2048 See also @option{-Wabi}.
2050 @item -fno-access-control
2051 @opindex fno-access-control
2052 Turn off all access checking.  This switch is mainly useful for working
2053 around bugs in the access control code.
2055 @item -fcheck-new
2056 @opindex fcheck-new
2057 Check that the pointer returned by @code{operator new} is non-null
2058 before attempting to modify the storage allocated.  This check is
2059 normally unnecessary because the C++ standard specifies that
2060 @code{operator new} only returns @code{0} if it is declared
2061 @samp{throw()}, in which case the compiler always checks the
2062 return value even without this option.  In all other cases, when
2063 @code{operator new} has a non-empty exception specification, memory
2064 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2065 @samp{new (nothrow)}.
2067 @item -fconstexpr-depth=@var{n}
2068 @opindex fconstexpr-depth
2069 Set the maximum nested evaluation depth for C++11 constexpr functions
2070 to @var{n}.  A limit is needed to detect endless recursion during
2071 constant expression evaluation.  The minimum specified by the standard
2072 is 512.
2074 @item -fdeduce-init-list
2075 @opindex fdeduce-init-list
2076 Enable deduction of a template type parameter as
2077 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2079 @smallexample
2080 template <class T> auto forward(T t) -> decltype (realfn (t))
2082   return realfn (t);
2085 void f()
2087   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2089 @end smallexample
2091 This deduction was implemented as a possible extension to the
2092 originally proposed semantics for the C++11 standard, but was not part
2093 of the final standard, so it is disabled by default.  This option is
2094 deprecated, and may be removed in a future version of G++.
2096 @item -ffriend-injection
2097 @opindex ffriend-injection
2098 Inject friend functions into the enclosing namespace, so that they are
2099 visible outside the scope of the class in which they are declared.
2100 Friend functions were documented to work this way in the old Annotated
2101 C++ Reference Manual, and versions of G++ before 4.1 always worked
2102 that way.  However, in ISO C++ a friend function that is not declared
2103 in an enclosing scope can only be found using argument dependent
2104 lookup.  This option causes friends to be injected as they were in
2105 earlier releases.
2107 This option is for compatibility, and may be removed in a future
2108 release of G++.
2110 @item -fno-elide-constructors
2111 @opindex fno-elide-constructors
2112 The C++ standard allows an implementation to omit creating a temporary
2113 that is only used to initialize another object of the same type.
2114 Specifying this option disables that optimization, and forces G++ to
2115 call the copy constructor in all cases.
2117 @item -fno-enforce-eh-specs
2118 @opindex fno-enforce-eh-specs
2119 Don't generate code to check for violation of exception specifications
2120 at run time.  This option violates the C++ standard, but may be useful
2121 for reducing code size in production builds, much like defining
2122 @samp{NDEBUG}.  This does not give user code permission to throw
2123 exceptions in violation of the exception specifications; the compiler
2124 still optimizes based on the specifications, so throwing an
2125 unexpected exception results in undefined behavior at run time.
2127 @item -fextern-tls-init
2128 @itemx -fno-extern-tls-init
2129 @opindex fextern-tls-init
2130 @opindex fno-extern-tls-init
2131 The C++11 and OpenMP standards allow @samp{thread_local} and
2132 @samp{threadprivate} variables to have dynamic (runtime)
2133 initialization.  To support this, any use of such a variable goes
2134 through a wrapper function that performs any necessary initialization.
2135 When the use and definition of the variable are in the same
2136 translation unit, this overhead can be optimized away, but when the
2137 use is in a different translation unit there is significant overhead
2138 even if the variable doesn't actually need dynamic initialization.  If
2139 the programmer can be sure that no use of the variable in a
2140 non-defining TU needs to trigger dynamic initialization (either
2141 because the variable is statically initialized, or a use of the
2142 variable in the defining TU will be executed before any uses in
2143 another TU), they can avoid this overhead with the
2144 @option{-fno-extern-tls-init} option.
2146 On targets that support symbol aliases, the default is
2147 @option{-fextern-tls-init}.  On targets that do not support symbol
2148 aliases, the default is @option{-fno-extern-tls-init}.
2150 @item -ffor-scope
2151 @itemx -fno-for-scope
2152 @opindex ffor-scope
2153 @opindex fno-for-scope
2154 If @option{-ffor-scope} is specified, the scope of variables declared in
2155 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2156 as specified by the C++ standard.
2157 If @option{-fno-for-scope} is specified, the scope of variables declared in
2158 a @i{for-init-statement} extends to the end of the enclosing scope,
2159 as was the case in old versions of G++, and other (traditional)
2160 implementations of C++.
2162 If neither flag is given, the default is to follow the standard,
2163 but to allow and give a warning for old-style code that would
2164 otherwise be invalid, or have different behavior.
2166 @item -fno-gnu-keywords
2167 @opindex fno-gnu-keywords
2168 Do not recognize @code{typeof} as a keyword, so that code can use this
2169 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2170 @option{-ansi} implies @option{-fno-gnu-keywords}.
2172 @item -fno-implicit-templates
2173 @opindex fno-implicit-templates
2174 Never emit code for non-inline templates that are instantiated
2175 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2176 @xref{Template Instantiation}, for more information.
2178 @item -fno-implicit-inline-templates
2179 @opindex fno-implicit-inline-templates
2180 Don't emit code for implicit instantiations of inline templates, either.
2181 The default is to handle inlines differently so that compiles with and
2182 without optimization need the same set of explicit instantiations.
2184 @item -fno-implement-inlines
2185 @opindex fno-implement-inlines
2186 To save space, do not emit out-of-line copies of inline functions
2187 controlled by @samp{#pragma implementation}.  This causes linker
2188 errors if these functions are not inlined everywhere they are called.
2190 @item -fms-extensions
2191 @opindex fms-extensions
2192 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2193 int and getting a pointer to member function via non-standard syntax.
2195 @item -fno-nonansi-builtins
2196 @opindex fno-nonansi-builtins
2197 Disable built-in declarations of functions that are not mandated by
2198 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2199 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2201 @item -fnothrow-opt
2202 @opindex fnothrow-opt
2203 Treat a @code{throw()} exception specification as if it were a
2204 @code{noexcept} specification to reduce or eliminate the text size
2205 overhead relative to a function with no exception specification.  If
2206 the function has local variables of types with non-trivial
2207 destructors, the exception specification actually makes the
2208 function smaller because the EH cleanups for those variables can be
2209 optimized away.  The semantic effect is that an exception thrown out of
2210 a function with such an exception specification results in a call
2211 to @code{terminate} rather than @code{unexpected}.
2213 @item -fno-operator-names
2214 @opindex fno-operator-names
2215 Do not treat the operator name keywords @code{and}, @code{bitand},
2216 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2217 synonyms as keywords.
2219 @item -fno-optional-diags
2220 @opindex fno-optional-diags
2221 Disable diagnostics that the standard says a compiler does not need to
2222 issue.  Currently, the only such diagnostic issued by G++ is the one for
2223 a name having multiple meanings within a class.
2225 @item -fpermissive
2226 @opindex fpermissive
2227 Downgrade some diagnostics about nonconformant code from errors to
2228 warnings.  Thus, using @option{-fpermissive} allows some
2229 nonconforming code to compile.
2231 @item -fno-pretty-templates
2232 @opindex fno-pretty-templates
2233 When an error message refers to a specialization of a function
2234 template, the compiler normally prints the signature of the
2235 template followed by the template arguments and any typedefs or
2236 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2237 rather than @code{void f(int)}) so that it's clear which template is
2238 involved.  When an error message refers to a specialization of a class
2239 template, the compiler omits any template arguments that match
2240 the default template arguments for that template.  If either of these
2241 behaviors make it harder to understand the error message rather than
2242 easier, you can use @option{-fno-pretty-templates} to disable them.
2244 @item -frepo
2245 @opindex frepo
2246 Enable automatic template instantiation at link time.  This option also
2247 implies @option{-fno-implicit-templates}.  @xref{Template
2248 Instantiation}, for more information.
2250 @item -fno-rtti
2251 @opindex fno-rtti
2252 Disable generation of information about every class with virtual
2253 functions for use by the C++ run-time type identification features
2254 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2255 of the language, you can save some space by using this flag.  Note that
2256 exception handling uses the same information, but G++ generates it as
2257 needed. The @samp{dynamic_cast} operator can still be used for casts that
2258 do not require run-time type information, i.e.@: casts to @code{void *} or to
2259 unambiguous base classes.
2261 @item -fstats
2262 @opindex fstats
2263 Emit statistics about front-end processing at the end of the compilation.
2264 This information is generally only useful to the G++ development team.
2266 @item -fstrict-enums
2267 @opindex fstrict-enums
2268 Allow the compiler to optimize using the assumption that a value of
2269 enumerated type can only be one of the values of the enumeration (as
2270 defined in the C++ standard; basically, a value that can be
2271 represented in the minimum number of bits needed to represent all the
2272 enumerators).  This assumption may not be valid if the program uses a
2273 cast to convert an arbitrary integer value to the enumerated type.
2275 @item -ftemplate-backtrace-limit=@var{n}
2276 @opindex ftemplate-backtrace-limit
2277 Set the maximum number of template instantiation notes for a single
2278 warning or error to @var{n}.  The default value is 10.
2280 @item -ftemplate-depth=@var{n}
2281 @opindex ftemplate-depth
2282 Set the maximum instantiation depth for template classes to @var{n}.
2283 A limit on the template instantiation depth is needed to detect
2284 endless recursions during template class instantiation.  ANSI/ISO C++
2285 conforming programs must not rely on a maximum depth greater than 17
2286 (changed to 1024 in C++11).  The default value is 900, as the compiler
2287 can run out of stack space before hitting 1024 in some situations.
2289 @item -fno-threadsafe-statics
2290 @opindex fno-threadsafe-statics
2291 Do not emit the extra code to use the routines specified in the C++
2292 ABI for thread-safe initialization of local statics.  You can use this
2293 option to reduce code size slightly in code that doesn't need to be
2294 thread-safe.
2296 @item -fuse-cxa-atexit
2297 @opindex fuse-cxa-atexit
2298 Register destructors for objects with static storage duration with the
2299 @code{__cxa_atexit} function rather than the @code{atexit} function.
2300 This option is required for fully standards-compliant handling of static
2301 destructors, but only works if your C library supports
2302 @code{__cxa_atexit}.
2304 @item -fno-use-cxa-get-exception-ptr
2305 @opindex fno-use-cxa-get-exception-ptr
2306 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2307 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2308 if the runtime routine is not available.
2310 @item -fvisibility-inlines-hidden
2311 @opindex fvisibility-inlines-hidden
2312 This switch declares that the user does not attempt to compare
2313 pointers to inline functions or methods where the addresses of the two functions
2314 are taken in different shared objects.
2316 The effect of this is that GCC may, effectively, mark inline methods with
2317 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2318 appear in the export table of a DSO and do not require a PLT indirection
2319 when used within the DSO@.  Enabling this option can have a dramatic effect
2320 on load and link times of a DSO as it massively reduces the size of the
2321 dynamic export table when the library makes heavy use of templates.
2323 The behavior of this switch is not quite the same as marking the
2324 methods as hidden directly, because it does not affect static variables
2325 local to the function or cause the compiler to deduce that
2326 the function is defined in only one shared object.
2328 You may mark a method as having a visibility explicitly to negate the
2329 effect of the switch for that method.  For example, if you do want to
2330 compare pointers to a particular inline method, you might mark it as
2331 having default visibility.  Marking the enclosing class with explicit
2332 visibility has no effect.
2334 Explicitly instantiated inline methods are unaffected by this option
2335 as their linkage might otherwise cross a shared library boundary.
2336 @xref{Template Instantiation}.
2338 @item -fvisibility-ms-compat
2339 @opindex fvisibility-ms-compat
2340 This flag attempts to use visibility settings to make GCC's C++
2341 linkage model compatible with that of Microsoft Visual Studio.
2343 The flag makes these changes to GCC's linkage model:
2345 @enumerate
2346 @item
2347 It sets the default visibility to @code{hidden}, like
2348 @option{-fvisibility=hidden}.
2350 @item
2351 Types, but not their members, are not hidden by default.
2353 @item
2354 The One Definition Rule is relaxed for types without explicit
2355 visibility specifications that are defined in more than one
2356 shared object: those declarations are permitted if they are
2357 permitted when this option is not used.
2358 @end enumerate
2360 In new code it is better to use @option{-fvisibility=hidden} and
2361 export those classes that are intended to be externally visible.
2362 Unfortunately it is possible for code to rely, perhaps accidentally,
2363 on the Visual Studio behavior.
2365 Among the consequences of these changes are that static data members
2366 of the same type with the same name but defined in different shared
2367 objects are different, so changing one does not change the other;
2368 and that pointers to function members defined in different shared
2369 objects may not compare equal.  When this flag is given, it is a
2370 violation of the ODR to define types with the same name differently.
2372 @item -fvtable-verify=@var{std|preinit|none}
2373 @opindex fvtable-verify
2374 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2375 feature that verifies at runtime, for every virtual call that is made, that
2376 the vtable pointer through which the call is made is valid for the type of
2377 the object, and has not been corrupted or overwritten.  If an invalid vtable
2378 pointer is detected (at runtime), an error is reported and execution of the
2379 program is immediately halted.
2381 This option causes runtime data structures to be built, at program start up,
2382 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2383 control the timing of when these data structures are built.  In both cases the
2384 data structures are built before execution reaches 'main'.  The
2385 @option{-fvtable-verify=std} causes these data structure to be built after the
2386 shared libraries have been loaded and initialized.
2387 @option{-fvtable-verify=preinit} causes them to be built before the shared
2388 libraries have been loaded and initialized.
2390 If this option appears multiple times in the compiler line, with different
2391 values specified, 'none' will take highest priority over both 'std' and
2392 'preinit'; 'preinit' will take priority over 'std'.
2394 @item -fvtv-debug
2395 @opindex (fvtv-debug)
2396 Causes debug versions of the runtime functions for the vtable verification 
2397 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2398 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2399 compiler to keep track of which vtable pointers it found for each class, and
2400 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2401 file directory on the user's machine.
2403 Note:  This feature APPENDS data to the log file. If you want a fresh log
2404 file, be sure to delete any existing one.
2406 @item -fvtv-counts
2407 @opindex fvtv-counts
2408 This is a debugging flag.  When used in conjunction with
2409 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2410 causes the compiler to keep track of the total number of virtual calls
2411 it encountered and the number of verifications it inserted.  It also
2412 counts the number of calls to certain runtime library functions
2413 that it inserts.  This information, for each compilation unit, is written
2414 to a file named ``vtv_count_data.log'', in the dump_file directory on
2415 the user's machine.   It also counts the size of the vtable pointer sets
2416 for each class, and writes this information to ``vtv_class_set_sizes.log''
2417 in the same directory.
2419 Note:  This feature APPENDS data to the log files.  To get a fresh log
2420 files, be sure to delete any existing ones.
2422 @item -fno-weak
2423 @opindex fno-weak
2424 Do not use weak symbol support, even if it is provided by the linker.
2425 By default, G++ uses weak symbols if they are available.  This
2426 option exists only for testing, and should not be used by end-users;
2427 it results in inferior code and has no benefits.  This option may
2428 be removed in a future release of G++.
2430 @item -nostdinc++
2431 @opindex nostdinc++
2432 Do not search for header files in the standard directories specific to
2433 C++, but do still search the other standard directories.  (This option
2434 is used when building the C++ library.)
2435 @end table
2437 In addition, these optimization, warning, and code generation options
2438 have meanings only for C++ programs:
2440 @table @gcctabopt
2441 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2442 @opindex Wabi
2443 @opindex Wno-abi
2444 Warn when G++ generates code that is probably not compatible with the
2445 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2446 all such cases, there are probably some cases that are not warned about,
2447 even though G++ is generating incompatible code.  There may also be
2448 cases where warnings are emitted even though the code that is generated
2449 is compatible.
2451 You should rewrite your code to avoid these warnings if you are
2452 concerned about the fact that code generated by G++ may not be binary
2453 compatible with code generated by other compilers.
2455 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2457 @itemize @bullet
2459 @item
2460 A template with a non-type template parameter of reference type is
2461 mangled incorrectly:
2462 @smallexample
2463 extern int N;
2464 template <int &> struct S @{@};
2465 void n (S<N>) @{2@}
2466 @end smallexample
2468 This is fixed in @option{-fabi-version=3}.
2470 @item
2471 SIMD vector types declared using @code{__attribute ((vector_size))} are
2472 mangled in a non-standard way that does not allow for overloading of
2473 functions taking vectors of different sizes.
2475 The mangling is changed in @option{-fabi-version=4}.
2476 @end itemize
2478 The known incompatibilities in @option{-fabi-version=1} include:
2480 @itemize @bullet
2482 @item
2483 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2484 pack data into the same byte as a base class.  For example:
2486 @smallexample
2487 struct A @{ virtual void f(); int f1 : 1; @};
2488 struct B : public A @{ int f2 : 1; @};
2489 @end smallexample
2491 @noindent
2492 In this case, G++ places @code{B::f2} into the same byte
2493 as @code{A::f1}; other compilers do not.  You can avoid this problem
2494 by explicitly padding @code{A} so that its size is a multiple of the
2495 byte size on your platform; that causes G++ and other compilers to
2496 lay out @code{B} identically.
2498 @item
2499 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2500 tail padding when laying out virtual bases.  For example:
2502 @smallexample
2503 struct A @{ virtual void f(); char c1; @};
2504 struct B @{ B(); char c2; @};
2505 struct C : public A, public virtual B @{@};
2506 @end smallexample
2508 @noindent
2509 In this case, G++ does not place @code{B} into the tail-padding for
2510 @code{A}; other compilers do.  You can avoid this problem by
2511 explicitly padding @code{A} so that its size is a multiple of its
2512 alignment (ignoring virtual base classes); that causes G++ and other
2513 compilers to lay out @code{C} identically.
2515 @item
2516 Incorrect handling of bit-fields with declared widths greater than that
2517 of their underlying types, when the bit-fields appear in a union.  For
2518 example:
2520 @smallexample
2521 union U @{ int i : 4096; @};
2522 @end smallexample
2524 @noindent
2525 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2526 union too small by the number of bits in an @code{int}.
2528 @item
2529 Empty classes can be placed at incorrect offsets.  For example:
2531 @smallexample
2532 struct A @{@};
2534 struct B @{
2535   A a;
2536   virtual void f ();
2539 struct C : public B, public A @{@};
2540 @end smallexample
2542 @noindent
2543 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2544 it should be placed at offset zero.  G++ mistakenly believes that the
2545 @code{A} data member of @code{B} is already at offset zero.
2547 @item
2548 Names of template functions whose types involve @code{typename} or
2549 template template parameters can be mangled incorrectly.
2551 @smallexample
2552 template <typename Q>
2553 void f(typename Q::X) @{@}
2555 template <template <typename> class Q>
2556 void f(typename Q<int>::X) @{@}
2557 @end smallexample
2559 @noindent
2560 Instantiations of these templates may be mangled incorrectly.
2562 @end itemize
2564 It also warns about psABI-related changes.  The known psABI changes at this
2565 point include:
2567 @itemize @bullet
2569 @item
2570 For SysV/x86-64, unions with @code{long double} members are 
2571 passed in memory as specified in psABI.  For example:
2573 @smallexample
2574 union U @{
2575   long double ld;
2576   int i;
2578 @end smallexample
2580 @noindent
2581 @code{union U} is always passed in memory.
2583 @end itemize
2585 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2586 @opindex Wctor-dtor-privacy
2587 @opindex Wno-ctor-dtor-privacy
2588 Warn when a class seems unusable because all the constructors or
2589 destructors in that class are private, and it has neither friends nor
2590 public static member functions.  Also warn if there are no non-private
2591 methods, and there's at least one private member function that isn't
2592 a constructor or destructor.
2594 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2595 @opindex Wdelete-non-virtual-dtor
2596 @opindex Wno-delete-non-virtual-dtor
2597 Warn when @samp{delete} is used to destroy an instance of a class that
2598 has virtual functions and non-virtual destructor. It is unsafe to delete
2599 an instance of a derived class through a pointer to a base class if the
2600 base class does not have a virtual destructor.  This warning is enabled
2601 by @option{-Wall}.
2603 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2604 @opindex Wliteral-suffix
2605 @opindex Wno-literal-suffix
2606 Warn when a string or character literal is followed by a ud-suffix which does
2607 not begin with an underscore.  As a conforming extension, GCC treats such
2608 suffixes as separate preprocessing tokens in order to maintain backwards
2609 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2610 For example:
2612 @smallexample
2613 #define __STDC_FORMAT_MACROS
2614 #include <inttypes.h>
2615 #include <stdio.h>
2617 int main() @{
2618   int64_t i64 = 123;
2619   printf("My int64: %"PRId64"\n", i64);
2621 @end smallexample
2623 In this case, @code{PRId64} is treated as a separate preprocessing token.
2625 This warning is enabled by default.
2627 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2628 @opindex Wnarrowing
2629 @opindex Wno-narrowing
2630 Warn when a narrowing conversion prohibited by C++11 occurs within
2631 @samp{@{ @}}, e.g.
2633 @smallexample
2634 int i = @{ 2.2 @}; // error: narrowing from double to int
2635 @end smallexample
2637 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2639 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2640 required by the standard.  Note that this does not affect the meaning
2641 of well-formed code; narrowing conversions are still considered
2642 ill-formed in SFINAE context.
2644 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2645 @opindex Wnoexcept
2646 @opindex Wno-noexcept
2647 Warn when a noexcept-expression evaluates to false because of a call
2648 to a function that does not have a non-throwing exception
2649 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2650 the compiler to never throw an exception.
2652 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2653 @opindex Wnon-virtual-dtor
2654 @opindex Wno-non-virtual-dtor
2655 Warn when a class has virtual functions and an accessible non-virtual
2656 destructor itself or in an accessible polymorphic base class, in which
2657 case it is possible but unsafe to delete an instance of a derived
2658 class through a pointer to the class itself or base class.  This
2659 warning is automatically enabled if @option{-Weffc++} is specified.
2661 @item -Wreorder @r{(C++ and Objective-C++ only)}
2662 @opindex Wreorder
2663 @opindex Wno-reorder
2664 @cindex reordering, warning
2665 @cindex warning for reordering of member initializers
2666 Warn when the order of member initializers given in the code does not
2667 match the order in which they must be executed.  For instance:
2669 @smallexample
2670 struct A @{
2671   int i;
2672   int j;
2673   A(): j (0), i (1) @{ @}
2675 @end smallexample
2677 @noindent
2678 The compiler rearranges the member initializers for @samp{i}
2679 and @samp{j} to match the declaration order of the members, emitting
2680 a warning to that effect.  This warning is enabled by @option{-Wall}.
2682 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2683 @opindex fext-numeric-literals
2684 @opindex fno-ext-numeric-literals
2685 Accept imaginary, fixed-point, or machine-defined
2686 literal number suffixes as GNU extensions.
2687 When this option is turned off these suffixes are treated
2688 as C++11 user-defined literal numeric suffixes.
2689 This is on by default for all pre-C++11 dialects and all GNU dialects:
2690 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2691 @option{-std=gnu++1y}.
2692 This option is off by default
2693 for ISO C++11 onwards (@option{-std=c++11}, ...).
2694 @end table
2696 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2698 @table @gcctabopt
2699 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2700 @opindex Weffc++
2701 @opindex Wno-effc++
2702 Warn about violations of the following style guidelines from Scott Meyers'
2703 @cite{Effective C++} series of books:
2705 @itemize @bullet
2706 @item
2707 Define a copy constructor and an assignment operator for classes
2708 with dynamically-allocated memory.
2710 @item
2711 Prefer initialization to assignment in constructors.
2713 @item
2714 Have @code{operator=} return a reference to @code{*this}.
2716 @item
2717 Don't try to return a reference when you must return an object.
2719 @item
2720 Distinguish between prefix and postfix forms of increment and
2721 decrement operators.
2723 @item
2724 Never overload @code{&&}, @code{||}, or @code{,}.
2726 @end itemize
2728 This option also enables @option{-Wnon-virtual-dtor}, which is also
2729 one of the effective C++ recommendations.  However, the check is
2730 extended to warn about the lack of virtual destructor in accessible
2731 non-polymorphic bases classes too.
2733 When selecting this option, be aware that the standard library
2734 headers do not obey all of these guidelines; use @samp{grep -v}
2735 to filter out those warnings.
2737 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2738 @opindex Wstrict-null-sentinel
2739 @opindex Wno-strict-null-sentinel
2740 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2741 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2742 to @code{__null}.  Although it is a null pointer constant rather than a
2743 null pointer, it is guaranteed to be of the same size as a pointer.
2744 But this use is not portable across different compilers.
2746 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2747 @opindex Wno-non-template-friend
2748 @opindex Wnon-template-friend
2749 Disable warnings when non-templatized friend functions are declared
2750 within a template.  Since the advent of explicit template specification
2751 support in G++, if the name of the friend is an unqualified-id (i.e.,
2752 @samp{friend foo(int)}), the C++ language specification demands that the
2753 friend declare or define an ordinary, nontemplate function.  (Section
2754 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2755 could be interpreted as a particular specialization of a templatized
2756 function.  Because this non-conforming behavior is no longer the default
2757 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2758 check existing code for potential trouble spots and is on by default.
2759 This new compiler behavior can be turned off with
2760 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2761 but disables the helpful warning.
2763 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2764 @opindex Wold-style-cast
2765 @opindex Wno-old-style-cast
2766 Warn if an old-style (C-style) cast to a non-void type is used within
2767 a C++ program.  The new-style casts (@samp{dynamic_cast},
2768 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2769 less vulnerable to unintended effects and much easier to search for.
2771 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2772 @opindex Woverloaded-virtual
2773 @opindex Wno-overloaded-virtual
2774 @cindex overloaded virtual function, warning
2775 @cindex warning for overloaded virtual function
2776 Warn when a function declaration hides virtual functions from a
2777 base class.  For example, in:
2779 @smallexample
2780 struct A @{
2781   virtual void f();
2784 struct B: public A @{
2785   void f(int);
2787 @end smallexample
2789 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2790 like:
2792 @smallexample
2793 B* b;
2794 b->f();
2795 @end smallexample
2797 @noindent
2798 fails to compile.
2800 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2801 @opindex Wno-pmf-conversions
2802 @opindex Wpmf-conversions
2803 Disable the diagnostic for converting a bound pointer to member function
2804 to a plain pointer.
2806 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2807 @opindex Wsign-promo
2808 @opindex Wno-sign-promo
2809 Warn when overload resolution chooses a promotion from unsigned or
2810 enumerated type to a signed type, over a conversion to an unsigned type of
2811 the same size.  Previous versions of G++ tried to preserve
2812 unsignedness, but the standard mandates the current behavior.
2813 @end table
2815 @node Objective-C and Objective-C++ Dialect Options
2816 @section Options Controlling Objective-C and Objective-C++ Dialects
2818 @cindex compiler options, Objective-C and Objective-C++
2819 @cindex Objective-C and Objective-C++ options, command-line
2820 @cindex options, Objective-C and Objective-C++
2821 (NOTE: This manual does not describe the Objective-C and Objective-C++
2822 languages themselves.  @xref{Standards,,Language Standards
2823 Supported by GCC}, for references.)
2825 This section describes the command-line options that are only meaningful
2826 for Objective-C and Objective-C++ programs.  You can also use most of
2827 the language-independent GNU compiler options.
2828 For example, you might compile a file @code{some_class.m} like this:
2830 @smallexample
2831 gcc -g -fgnu-runtime -O -c some_class.m
2832 @end smallexample
2834 @noindent
2835 In this example, @option{-fgnu-runtime} is an option meant only for
2836 Objective-C and Objective-C++ programs; you can use the other options with
2837 any language supported by GCC@.
2839 Note that since Objective-C is an extension of the C language, Objective-C
2840 compilations may also use options specific to the C front-end (e.g.,
2841 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2842 C++-specific options (e.g., @option{-Wabi}).
2844 Here is a list of options that are @emph{only} for compiling Objective-C
2845 and Objective-C++ programs:
2847 @table @gcctabopt
2848 @item -fconstant-string-class=@var{class-name}
2849 @opindex fconstant-string-class
2850 Use @var{class-name} as the name of the class to instantiate for each
2851 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2852 class name is @code{NXConstantString} if the GNU runtime is being used, and
2853 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2854 @option{-fconstant-cfstrings} option, if also present, overrides the
2855 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2856 to be laid out as constant CoreFoundation strings.
2858 @item -fgnu-runtime
2859 @opindex fgnu-runtime
2860 Generate object code compatible with the standard GNU Objective-C
2861 runtime.  This is the default for most types of systems.
2863 @item -fnext-runtime
2864 @opindex fnext-runtime
2865 Generate output compatible with the NeXT runtime.  This is the default
2866 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2867 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2868 used.
2870 @item -fno-nil-receivers
2871 @opindex fno-nil-receivers
2872 Assume that all Objective-C message dispatches (@code{[receiver
2873 message:arg]}) in this translation unit ensure that the receiver is
2874 not @code{nil}.  This allows for more efficient entry points in the
2875 runtime to be used.  This option is only available in conjunction with
2876 the NeXT runtime and ABI version 0 or 1.
2878 @item -fobjc-abi-version=@var{n}
2879 @opindex fobjc-abi-version
2880 Use version @var{n} of the Objective-C ABI for the selected runtime.
2881 This option is currently supported only for the NeXT runtime.  In that
2882 case, Version 0 is the traditional (32-bit) ABI without support for
2883 properties and other Objective-C 2.0 additions.  Version 1 is the
2884 traditional (32-bit) ABI with support for properties and other
2885 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2886 nothing is specified, the default is Version 0 on 32-bit target
2887 machines, and Version 2 on 64-bit target machines.
2889 @item -fobjc-call-cxx-cdtors
2890 @opindex fobjc-call-cxx-cdtors
2891 For each Objective-C class, check if any of its instance variables is a
2892 C++ object with a non-trivial default constructor.  If so, synthesize a
2893 special @code{- (id) .cxx_construct} instance method which runs
2894 non-trivial default constructors on any such instance variables, in order,
2895 and then return @code{self}.  Similarly, check if any instance variable
2896 is a C++ object with a non-trivial destructor, and if so, synthesize a
2897 special @code{- (void) .cxx_destruct} method which runs
2898 all such default destructors, in reverse order.
2900 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2901 methods thusly generated only operate on instance variables
2902 declared in the current Objective-C class, and not those inherited
2903 from superclasses.  It is the responsibility of the Objective-C
2904 runtime to invoke all such methods in an object's inheritance
2905 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2906 by the runtime immediately after a new object instance is allocated;
2907 the @code{- (void) .cxx_destruct} methods are invoked immediately
2908 before the runtime deallocates an object instance.
2910 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2911 support for invoking the @code{- (id) .cxx_construct} and
2912 @code{- (void) .cxx_destruct} methods.
2914 @item -fobjc-direct-dispatch
2915 @opindex fobjc-direct-dispatch
2916 Allow fast jumps to the message dispatcher.  On Darwin this is
2917 accomplished via the comm page.
2919 @item -fobjc-exceptions
2920 @opindex fobjc-exceptions
2921 Enable syntactic support for structured exception handling in
2922 Objective-C, similar to what is offered by C++ and Java.  This option
2923 is required to use the Objective-C keywords @code{@@try},
2924 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2925 @code{@@synchronized}.  This option is available with both the GNU
2926 runtime and the NeXT runtime (but not available in conjunction with
2927 the NeXT runtime on Mac OS X 10.2 and earlier).
2929 @item -fobjc-gc
2930 @opindex fobjc-gc
2931 Enable garbage collection (GC) in Objective-C and Objective-C++
2932 programs.  This option is only available with the NeXT runtime; the
2933 GNU runtime has a different garbage collection implementation that
2934 does not require special compiler flags.
2936 @item -fobjc-nilcheck
2937 @opindex fobjc-nilcheck
2938 For the NeXT runtime with version 2 of the ABI, check for a nil
2939 receiver in method invocations before doing the actual method call.
2940 This is the default and can be disabled using
2941 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2942 checked for nil in this way no matter what this flag is set to.
2943 Currently this flag does nothing when the GNU runtime, or an older
2944 version of the NeXT runtime ABI, is used.
2946 @item -fobjc-std=objc1
2947 @opindex fobjc-std
2948 Conform to the language syntax of Objective-C 1.0, the language
2949 recognized by GCC 4.0.  This only affects the Objective-C additions to
2950 the C/C++ language; it does not affect conformance to C/C++ standards,
2951 which is controlled by the separate C/C++ dialect option flags.  When
2952 this option is used with the Objective-C or Objective-C++ compiler,
2953 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2954 This is useful if you need to make sure that your Objective-C code can
2955 be compiled with older versions of GCC@.
2957 @item -freplace-objc-classes
2958 @opindex freplace-objc-classes
2959 Emit a special marker instructing @command{ld(1)} not to statically link in
2960 the resulting object file, and allow @command{dyld(1)} to load it in at
2961 run time instead.  This is used in conjunction with the Fix-and-Continue
2962 debugging mode, where the object file in question may be recompiled and
2963 dynamically reloaded in the course of program execution, without the need
2964 to restart the program itself.  Currently, Fix-and-Continue functionality
2965 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2966 and later.
2968 @item -fzero-link
2969 @opindex fzero-link
2970 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2971 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2972 compile time) with static class references that get initialized at load time,
2973 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2974 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2975 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2976 for individual class implementations to be modified during program execution.
2977 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2978 regardless of command-line options.
2980 @item -gen-decls
2981 @opindex gen-decls
2982 Dump interface declarations for all classes seen in the source file to a
2983 file named @file{@var{sourcename}.decl}.
2985 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2986 @opindex Wassign-intercept
2987 @opindex Wno-assign-intercept
2988 Warn whenever an Objective-C assignment is being intercepted by the
2989 garbage collector.
2991 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2992 @opindex Wno-protocol
2993 @opindex Wprotocol
2994 If a class is declared to implement a protocol, a warning is issued for
2995 every method in the protocol that is not implemented by the class.  The
2996 default behavior is to issue a warning for every method not explicitly
2997 implemented in the class, even if a method implementation is inherited
2998 from the superclass.  If you use the @option{-Wno-protocol} option, then
2999 methods inherited from the superclass are considered to be implemented,
3000 and no warning is issued for them.
3002 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3003 @opindex Wselector
3004 @opindex Wno-selector
3005 Warn if multiple methods of different types for the same selector are
3006 found during compilation.  The check is performed on the list of methods
3007 in the final stage of compilation.  Additionally, a check is performed
3008 for each selector appearing in a @code{@@selector(@dots{})}
3009 expression, and a corresponding method for that selector has been found
3010 during compilation.  Because these checks scan the method table only at
3011 the end of compilation, these warnings are not produced if the final
3012 stage of compilation is not reached, for example because an error is
3013 found during compilation, or because the @option{-fsyntax-only} option is
3014 being used.
3016 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3017 @opindex Wstrict-selector-match
3018 @opindex Wno-strict-selector-match
3019 Warn if multiple methods with differing argument and/or return types are
3020 found for a given selector when attempting to send a message using this
3021 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3022 is off (which is the default behavior), the compiler omits such warnings
3023 if any differences found are confined to types that share the same size
3024 and alignment.
3026 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3027 @opindex Wundeclared-selector
3028 @opindex Wno-undeclared-selector
3029 Warn if a @code{@@selector(@dots{})} expression referring to an
3030 undeclared selector is found.  A selector is considered undeclared if no
3031 method with that name has been declared before the
3032 @code{@@selector(@dots{})} expression, either explicitly in an
3033 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3034 an @code{@@implementation} section.  This option always performs its
3035 checks as soon as a @code{@@selector(@dots{})} expression is found,
3036 while @option{-Wselector} only performs its checks in the final stage of
3037 compilation.  This also enforces the coding style convention
3038 that methods and selectors must be declared before being used.
3040 @item -print-objc-runtime-info
3041 @opindex print-objc-runtime-info
3042 Generate C header describing the largest structure that is passed by
3043 value, if any.
3045 @end table
3047 @node Language Independent Options
3048 @section Options to Control Diagnostic Messages Formatting
3049 @cindex options to control diagnostics formatting
3050 @cindex diagnostic messages
3051 @cindex message formatting
3053 Traditionally, diagnostic messages have been formatted irrespective of
3054 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3055 options described below
3056 to control the formatting algorithm for diagnostic messages, 
3057 e.g.@: how many characters per line, how often source location
3058 information should be reported.  Note that some language front ends may not
3059 honor these options.
3061 @table @gcctabopt
3062 @item -fmessage-length=@var{n}
3063 @opindex fmessage-length
3064 Try to format error messages so that they fit on lines of about @var{n}
3065 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
3066 the front ends supported by GCC@.  If @var{n} is zero, then no
3067 line-wrapping is done; each error message appears on a single
3068 line.
3070 @item -fdiagnostics-show-location=once
3071 @opindex fdiagnostics-show-location
3072 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3073 reporter to emit source location information @emph{once}; that is, in
3074 case the message is too long to fit on a single physical line and has to
3075 be wrapped, the source location won't be emitted (as prefix) again,
3076 over and over, in subsequent continuation lines.  This is the default
3077 behavior.
3079 @item -fdiagnostics-show-location=every-line
3080 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3081 messages reporter to emit the same source location information (as
3082 prefix) for physical lines that result from the process of breaking
3083 a message which is too long to fit on a single line.
3085 @item -fdiagnostics-color[=@var{WHEN}]
3086 @itemx -fno-diagnostics-color
3087 @opindex fdiagnostics-color
3088 @cindex highlight, color, colour
3089 @vindex GCC_COLORS @r{environment variable}
3090 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3091 or @samp{auto}.  The default is @samp{never} if @env{GCC_COLORS} environment
3092 variable isn't present in the environment, and @samp{auto} otherwise.
3093 @samp{auto} means to use color only when the standard error is a terminal.
3094 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3095 aliases for @option{-fdiagnostics-color=always} and
3096 @option{-fdiagnostics-color=never}, respectively.
3098 The colors are defined by the environment variable @env{GCC_COLORS}.
3099 Its value is a colon-separated list of capabilities and Select Graphic
3100 Rendition (SGR) substrings. SGR commands are interpreted by the
3101 terminal or terminal emulator.  (See the section in the documentation
3102 of your text terminal for permitted values and their meanings as
3103 character attributes.)  These substring values are integers in decimal
3104 representation and can be concatenated with semicolons.
3105 Common values to concatenate include
3106 @samp{1} for bold,
3107 @samp{4} for underline,
3108 @samp{5} for blink,
3109 @samp{7} for inverse,
3110 @samp{39} for default foreground color,
3111 @samp{30} to @samp{37} for foreground colors,
3112 @samp{90} to @samp{97} for 16-color mode foreground colors,
3113 @samp{38;5;0} to @samp{38;5;255}
3114 for 88-color and 256-color modes foreground colors,
3115 @samp{49} for default background color,
3116 @samp{40} to @samp{47} for background colors,
3117 @samp{100} to @samp{107} for 16-color mode background colors,
3118 and @samp{48;5;0} to @samp{48;5;255}
3119 for 88-color and 256-color modes background colors.
3121 The default @env{GCC_COLORS} is
3122 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3123 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3124 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3125 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3126 string disables colors.
3127 Supported capabilities are as follows.
3129 @table @code
3130 @item error=
3131 @vindex error GCC_COLORS @r{capability}
3132 SGR substring for error: markers.
3134 @item warning=
3135 @vindex warning GCC_COLORS @r{capability}
3136 SGR substring for warning: markers.
3138 @item note=
3139 @vindex note GCC_COLORS @r{capability}
3140 SGR substring for note: markers.
3142 @item caret=
3143 @vindex caret GCC_COLORS @r{capability}
3144 SGR substring for caret line.
3146 @item locus=
3147 @vindex locus GCC_COLORS @r{capability}
3148 SGR substring for location information, @samp{file:line} or
3149 @samp{file:line:column} etc.
3151 @item quote=
3152 @vindex quote GCC_COLORS @r{capability}
3153 SGR substring for information printed within quotes.
3154 @end table
3156 @item -fno-diagnostics-show-option
3157 @opindex fno-diagnostics-show-option
3158 @opindex fdiagnostics-show-option
3159 By default, each diagnostic emitted includes text indicating the
3160 command-line option that directly controls the diagnostic (if such an
3161 option is known to the diagnostic machinery).  Specifying the
3162 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3164 @item -fno-diagnostics-show-caret
3165 @opindex fno-diagnostics-show-caret
3166 @opindex fdiagnostics-show-caret
3167 By default, each diagnostic emitted includes the original source line
3168 and a caret '^' indicating the column.  This option suppresses this
3169 information.
3171 @end table
3173 @node Warning Options
3174 @section Options to Request or Suppress Warnings
3175 @cindex options to control warnings
3176 @cindex warning messages
3177 @cindex messages, warning
3178 @cindex suppressing warnings
3180 Warnings are diagnostic messages that report constructions that
3181 are not inherently erroneous but that are risky or suggest there
3182 may have been an error.
3184 The following language-independent options do not enable specific
3185 warnings but control the kinds of diagnostics produced by GCC@.
3187 @table @gcctabopt
3188 @cindex syntax checking
3189 @item -fsyntax-only
3190 @opindex fsyntax-only
3191 Check the code for syntax errors, but don't do anything beyond that.
3193 @item -fmax-errors=@var{n}
3194 @opindex fmax-errors
3195 Limits the maximum number of error messages to @var{n}, at which point
3196 GCC bails out rather than attempting to continue processing the source
3197 code.  If @var{n} is 0 (the default), there is no limit on the number
3198 of error messages produced.  If @option{-Wfatal-errors} is also
3199 specified, then @option{-Wfatal-errors} takes precedence over this
3200 option.
3202 @item -w
3203 @opindex w
3204 Inhibit all warning messages.
3206 @item -Werror
3207 @opindex Werror
3208 @opindex Wno-error
3209 Make all warnings into errors.
3211 @item -Werror=
3212 @opindex Werror=
3213 @opindex Wno-error=
3214 Make the specified warning into an error.  The specifier for a warning
3215 is appended; for example @option{-Werror=switch} turns the warnings
3216 controlled by @option{-Wswitch} into errors.  This switch takes a
3217 negative form, to be used to negate @option{-Werror} for specific
3218 warnings; for example @option{-Wno-error=switch} makes
3219 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3220 is in effect.
3222 The warning message for each controllable warning includes the
3223 option that controls the warning.  That option can then be used with
3224 @option{-Werror=} and @option{-Wno-error=} as described above.
3225 (Printing of the option in the warning message can be disabled using the
3226 @option{-fno-diagnostics-show-option} flag.)
3228 Note that specifying @option{-Werror=}@var{foo} automatically implies
3229 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3230 imply anything.
3232 @item -Wfatal-errors
3233 @opindex Wfatal-errors
3234 @opindex Wno-fatal-errors
3235 This option causes the compiler to abort compilation on the first error
3236 occurred rather than trying to keep going and printing further error
3237 messages.
3239 @end table
3241 You can request many specific warnings with options beginning with
3242 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3243 implicit declarations.  Each of these specific warning options also
3244 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3245 example, @option{-Wno-implicit}.  This manual lists only one of the
3246 two forms, whichever is not the default.  For further
3247 language-specific options also refer to @ref{C++ Dialect Options} and
3248 @ref{Objective-C and Objective-C++ Dialect Options}.
3250 When an unrecognized warning option is requested (e.g.,
3251 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3252 that the option is not recognized.  However, if the @option{-Wno-} form
3253 is used, the behavior is slightly different: no diagnostic is
3254 produced for @option{-Wno-unknown-warning} unless other diagnostics
3255 are being produced.  This allows the use of new @option{-Wno-} options
3256 with old compilers, but if something goes wrong, the compiler
3257 warns that an unrecognized option is present.
3259 @table @gcctabopt
3260 @item -Wpedantic
3261 @itemx -pedantic
3262 @opindex pedantic
3263 @opindex Wpedantic
3264 Issue all the warnings demanded by strict ISO C and ISO C++;
3265 reject all programs that use forbidden extensions, and some other
3266 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3267 version of the ISO C standard specified by any @option{-std} option used.
3269 Valid ISO C and ISO C++ programs should compile properly with or without
3270 this option (though a rare few require @option{-ansi} or a
3271 @option{-std} option specifying the required version of ISO C)@.  However,
3272 without this option, certain GNU extensions and traditional C and C++
3273 features are supported as well.  With this option, they are rejected.
3275 @option{-Wpedantic} does not cause warning messages for use of the
3276 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3277 warnings are also disabled in the expression that follows
3278 @code{__extension__}.  However, only system header files should use
3279 these escape routes; application programs should avoid them.
3280 @xref{Alternate Keywords}.
3282 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3283 C conformance.  They soon find that it does not do quite what they want:
3284 it finds some non-ISO practices, but not all---only those for which
3285 ISO C @emph{requires} a diagnostic, and some others for which
3286 diagnostics have been added.
3288 A feature to report any failure to conform to ISO C might be useful in
3289 some instances, but would require considerable additional work and would
3290 be quite different from @option{-Wpedantic}.  We don't have plans to
3291 support such a feature in the near future.
3293 Where the standard specified with @option{-std} represents a GNU
3294 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3295 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3296 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3297 where they are required by the base standard.  (It does not make sense
3298 for such warnings to be given only for features not in the specified GNU
3299 C dialect, since by definition the GNU dialects of C include all
3300 features the compiler supports with the given option, and there would be
3301 nothing to warn about.)
3303 @item -pedantic-errors
3304 @opindex pedantic-errors
3305 Like @option{-Wpedantic}, except that errors are produced rather than
3306 warnings.
3308 @item -Wall
3309 @opindex Wall
3310 @opindex Wno-all
3311 This enables all the warnings about constructions that some users
3312 consider questionable, and that are easy to avoid (or modify to
3313 prevent the warning), even in conjunction with macros.  This also
3314 enables some language-specific warnings described in @ref{C++ Dialect
3315 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3317 @option{-Wall} turns on the following warning flags:
3319 @gccoptlist{-Waddress   @gol
3320 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3321 -Wc++11-compat  @gol
3322 -Wchar-subscripts  @gol
3323 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3324 -Wimplicit-int @r{(C and Objective-C only)} @gol
3325 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3326 -Wcomment  @gol
3327 -Wformat   @gol
3328 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3329 -Wmaybe-uninitialized @gol
3330 -Wmissing-braces @r{(only for C/ObjC)} @gol
3331 -Wnonnull  @gol
3332 -Wopenmp-simd @gol
3333 -Wparentheses  @gol
3334 -Wpointer-sign  @gol
3335 -Wreorder   @gol
3336 -Wreturn-type  @gol
3337 -Wsequence-point  @gol
3338 -Wsign-compare @r{(only in C++)}  @gol
3339 -Wstrict-aliasing  @gol
3340 -Wstrict-overflow=1  @gol
3341 -Wswitch  @gol
3342 -Wtrigraphs  @gol
3343 -Wuninitialized  @gol
3344 -Wunknown-pragmas  @gol
3345 -Wunused-function  @gol
3346 -Wunused-label     @gol
3347 -Wunused-value     @gol
3348 -Wunused-variable  @gol
3349 -Wvolatile-register-var @gol
3352 Note that some warning flags are not implied by @option{-Wall}.  Some of
3353 them warn about constructions that users generally do not consider
3354 questionable, but which occasionally you might wish to check for;
3355 others warn about constructions that are necessary or hard to avoid in
3356 some cases, and there is no simple way to modify the code to suppress
3357 the warning. Some of them are enabled by @option{-Wextra} but many of
3358 them must be enabled individually.
3360 @item -Wextra
3361 @opindex W
3362 @opindex Wextra
3363 @opindex Wno-extra
3364 This enables some extra warning flags that are not enabled by
3365 @option{-Wall}. (This option used to be called @option{-W}.  The older
3366 name is still supported, but the newer name is more descriptive.)
3368 @gccoptlist{-Wclobbered  @gol
3369 -Wempty-body  @gol
3370 -Wignored-qualifiers @gol
3371 -Wmissing-field-initializers  @gol
3372 -Wmissing-parameter-type @r{(C only)}  @gol
3373 -Wold-style-declaration @r{(C only)}  @gol
3374 -Woverride-init  @gol
3375 -Wsign-compare  @gol
3376 -Wtype-limits  @gol
3377 -Wuninitialized  @gol
3378 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3379 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3382 The option @option{-Wextra} also prints warning messages for the
3383 following cases:
3385 @itemize @bullet
3387 @item
3388 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3389 @samp{>}, or @samp{>=}.
3391 @item
3392 (C++ only) An enumerator and a non-enumerator both appear in a
3393 conditional expression.
3395 @item
3396 (C++ only) Ambiguous virtual bases.
3398 @item
3399 (C++ only) Subscripting an array that has been declared @samp{register}.
3401 @item
3402 (C++ only) Taking the address of a variable that has been declared
3403 @samp{register}.
3405 @item
3406 (C++ only) A base class is not initialized in a derived class's copy
3407 constructor.
3409 @end itemize
3411 @item -Wchar-subscripts
3412 @opindex Wchar-subscripts
3413 @opindex Wno-char-subscripts
3414 Warn if an array subscript has type @code{char}.  This is a common cause
3415 of error, as programmers often forget that this type is signed on some
3416 machines.
3417 This warning is enabled by @option{-Wall}.
3419 @item -Wcomment
3420 @opindex Wcomment
3421 @opindex Wno-comment
3422 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3423 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3424 This warning is enabled by @option{-Wall}.
3426 @item -Wno-coverage-mismatch
3427 @opindex Wno-coverage-mismatch
3428 Warn if feedback profiles do not match when using the
3429 @option{-fprofile-use} option.
3430 If a source file is changed between compiling with @option{-fprofile-gen} and
3431 with @option{-fprofile-use}, the files with the profile feedback can fail
3432 to match the source file and GCC cannot use the profile feedback
3433 information.  By default, this warning is enabled and is treated as an
3434 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3435 warning or @option{-Wno-error=coverage-mismatch} can be used to
3436 disable the error.  Disabling the error for this warning can result in
3437 poorly optimized code and is useful only in the
3438 case of very minor changes such as bug fixes to an existing code-base.
3439 Completely disabling the warning is not recommended.
3441 @item -Wno-cpp
3442 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3444 Suppress warning messages emitted by @code{#warning} directives.
3446 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3447 @opindex Wdouble-promotion
3448 @opindex Wno-double-promotion
3449 Give a warning when a value of type @code{float} is implicitly
3450 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3451 floating-point unit implement @code{float} in hardware, but emulate
3452 @code{double} in software.  On such a machine, doing computations
3453 using @code{double} values is much more expensive because of the
3454 overhead required for software emulation.
3456 It is easy to accidentally do computations with @code{double} because
3457 floating-point literals are implicitly of type @code{double}.  For
3458 example, in:
3459 @smallexample
3460 @group
3461 float area(float radius)
3463    return 3.14159 * radius * radius;
3465 @end group
3466 @end smallexample
3467 the compiler performs the entire computation with @code{double}
3468 because the floating-point literal is a @code{double}.
3470 @item -Wformat
3471 @itemx -Wformat=@var{n}
3472 @opindex Wformat
3473 @opindex Wno-format
3474 @opindex ffreestanding
3475 @opindex fno-builtin
3476 @opindex Wformat=
3477 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3478 the arguments supplied have types appropriate to the format string
3479 specified, and that the conversions specified in the format string make
3480 sense.  This includes standard functions, and others specified by format
3481 attributes (@pxref{Function Attributes}), in the @code{printf},
3482 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3483 not in the C standard) families (or other target-specific families).
3484 Which functions are checked without format attributes having been
3485 specified depends on the standard version selected, and such checks of
3486 functions without the attribute specified are disabled by
3487 @option{-ffreestanding} or @option{-fno-builtin}.
3489 The formats are checked against the format features supported by GNU
3490 libc version 2.2.  These include all ISO C90 and C99 features, as well
3491 as features from the Single Unix Specification and some BSD and GNU
3492 extensions.  Other library implementations may not support all these
3493 features; GCC does not support warning about features that go beyond a
3494 particular library's limitations.  However, if @option{-Wpedantic} is used
3495 with @option{-Wformat}, warnings are given about format features not
3496 in the selected standard version (but not for @code{strfmon} formats,
3497 since those are not in any version of the C standard).  @xref{C Dialect
3498 Options,,Options Controlling C Dialect}.
3500 @table @gcctabopt
3501 @item -Wformat=1
3502 @itemx -Wformat
3503 @opindex Wformat
3504 @opindex Wformat=1
3505 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3506 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3507 @option{-Wformat} also checks for null format arguments for several
3508 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3509 aspects of this level of format checking can be disabled by the
3510 options: @option{-Wno-format-contains-nul},
3511 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3512 @option{-Wformat} is enabled by @option{-Wall}.
3514 @item -Wno-format-contains-nul
3515 @opindex Wno-format-contains-nul
3516 @opindex Wformat-contains-nul
3517 If @option{-Wformat} is specified, do not warn about format strings that
3518 contain NUL bytes.
3520 @item -Wno-format-extra-args
3521 @opindex Wno-format-extra-args
3522 @opindex Wformat-extra-args
3523 If @option{-Wformat} is specified, do not warn about excess arguments to a
3524 @code{printf} or @code{scanf} format function.  The C standard specifies
3525 that such arguments are ignored.
3527 Where the unused arguments lie between used arguments that are
3528 specified with @samp{$} operand number specifications, normally
3529 warnings are still given, since the implementation could not know what
3530 type to pass to @code{va_arg} to skip the unused arguments.  However,
3531 in the case of @code{scanf} formats, this option suppresses the
3532 warning if the unused arguments are all pointers, since the Single
3533 Unix Specification says that such unused arguments are allowed.
3535 @item -Wno-format-zero-length
3536 @opindex Wno-format-zero-length
3537 @opindex Wformat-zero-length
3538 If @option{-Wformat} is specified, do not warn about zero-length formats.
3539 The C standard specifies that zero-length formats are allowed.
3542 @item -Wformat=2
3543 @opindex Wformat=2
3544 Enable @option{-Wformat} plus additional format checks.  Currently
3545 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3546 -Wformat-y2k}.
3548 @item -Wformat-nonliteral
3549 @opindex Wformat-nonliteral
3550 @opindex Wno-format-nonliteral
3551 If @option{-Wformat} is specified, also warn if the format string is not a
3552 string literal and so cannot be checked, unless the format function
3553 takes its format arguments as a @code{va_list}.
3555 @item -Wformat-security
3556 @opindex Wformat-security
3557 @opindex Wno-format-security
3558 If @option{-Wformat} is specified, also warn about uses of format
3559 functions that represent possible security problems.  At present, this
3560 warns about calls to @code{printf} and @code{scanf} functions where the
3561 format string is not a string literal and there are no format arguments,
3562 as in @code{printf (foo);}.  This may be a security hole if the format
3563 string came from untrusted input and contains @samp{%n}.  (This is
3564 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3565 in future warnings may be added to @option{-Wformat-security} that are not
3566 included in @option{-Wformat-nonliteral}.)
3568 @item -Wformat-y2k
3569 @opindex Wformat-y2k
3570 @opindex Wno-format-y2k
3571 If @option{-Wformat} is specified, also warn about @code{strftime}
3572 formats that may yield only a two-digit year.
3573 @end table
3575 @item -Wnonnull
3576 @opindex Wnonnull
3577 @opindex Wno-nonnull
3578 Warn about passing a null pointer for arguments marked as
3579 requiring a non-null value by the @code{nonnull} function attribute.
3581 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3582 can be disabled with the @option{-Wno-nonnull} option.
3584 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3585 @opindex Winit-self
3586 @opindex Wno-init-self
3587 Warn about uninitialized variables that are initialized with themselves.
3588 Note this option can only be used with the @option{-Wuninitialized} option.
3590 For example, GCC warns about @code{i} being uninitialized in the
3591 following snippet only when @option{-Winit-self} has been specified:
3592 @smallexample
3593 @group
3594 int f()
3596   int i = i;
3597   return i;
3599 @end group
3600 @end smallexample
3602 This warning is enabled by @option{-Wall} in C++.
3604 @item -Wimplicit-int @r{(C and Objective-C only)}
3605 @opindex Wimplicit-int
3606 @opindex Wno-implicit-int
3607 Warn when a declaration does not specify a type.
3608 This warning is enabled by @option{-Wall}.
3610 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3611 @opindex Wimplicit-function-declaration
3612 @opindex Wno-implicit-function-declaration
3613 Give a warning whenever a function is used before being declared. In
3614 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3615 enabled by default and it is made into an error by
3616 @option{-pedantic-errors}. This warning is also enabled by
3617 @option{-Wall}.
3619 @item -Wimplicit @r{(C and Objective-C only)}
3620 @opindex Wimplicit
3621 @opindex Wno-implicit
3622 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3623 This warning is enabled by @option{-Wall}.
3625 @item -Wignored-qualifiers @r{(C and C++ only)}
3626 @opindex Wignored-qualifiers
3627 @opindex Wno-ignored-qualifiers
3628 Warn if the return type of a function has a type qualifier
3629 such as @code{const}.  For ISO C such a type qualifier has no effect,
3630 since the value returned by a function is not an lvalue.
3631 For C++, the warning is only emitted for scalar types or @code{void}.
3632 ISO C prohibits qualified @code{void} return types on function
3633 definitions, so such return types always receive a warning
3634 even without this option.
3636 This warning is also enabled by @option{-Wextra}.
3638 @item -Wmain
3639 @opindex Wmain
3640 @opindex Wno-main
3641 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3642 a function with external linkage, returning int, taking either zero
3643 arguments, two, or three arguments of appropriate types.  This warning
3644 is enabled by default in C++ and is enabled by either @option{-Wall}
3645 or @option{-Wpedantic}.
3647 @item -Wmissing-braces
3648 @opindex Wmissing-braces
3649 @opindex Wno-missing-braces
3650 Warn if an aggregate or union initializer is not fully bracketed.  In
3651 the following example, the initializer for @samp{a} is not fully
3652 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3653 enabled by @option{-Wall} in C.
3655 @smallexample
3656 int a[2][2] = @{ 0, 1, 2, 3 @};
3657 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3658 @end smallexample
3660 This warning is enabled by @option{-Wall}.
3662 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3663 @opindex Wmissing-include-dirs
3664 @opindex Wno-missing-include-dirs
3665 Warn if a user-supplied include directory does not exist.
3667 @item -Wparentheses
3668 @opindex Wparentheses
3669 @opindex Wno-parentheses
3670 Warn if parentheses are omitted in certain contexts, such
3671 as when there is an assignment in a context where a truth value
3672 is expected, or when operators are nested whose precedence people
3673 often get confused about.
3675 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3676 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3677 interpretation from that of ordinary mathematical notation.
3679 Also warn about constructions where there may be confusion to which
3680 @code{if} statement an @code{else} branch belongs.  Here is an example of
3681 such a case:
3683 @smallexample
3684 @group
3686   if (a)
3687     if (b)
3688       foo ();
3689   else
3690     bar ();
3692 @end group
3693 @end smallexample
3695 In C/C++, every @code{else} branch belongs to the innermost possible
3696 @code{if} statement, which in this example is @code{if (b)}.  This is
3697 often not what the programmer expected, as illustrated in the above
3698 example by indentation the programmer chose.  When there is the
3699 potential for this confusion, GCC issues a warning when this flag
3700 is specified.  To eliminate the warning, add explicit braces around
3701 the innermost @code{if} statement so there is no way the @code{else}
3702 can belong to the enclosing @code{if}.  The resulting code
3703 looks like this:
3705 @smallexample
3706 @group
3708   if (a)
3709     @{
3710       if (b)
3711         foo ();
3712       else
3713         bar ();
3714     @}
3716 @end group
3717 @end smallexample
3719 Also warn for dangerous uses of the GNU extension to
3720 @code{?:} with omitted middle operand. When the condition
3721 in the @code{?}: operator is a boolean expression, the omitted value is
3722 always 1.  Often programmers expect it to be a value computed
3723 inside the conditional expression instead.
3725 This warning is enabled by @option{-Wall}.
3727 @item -Wsequence-point
3728 @opindex Wsequence-point
3729 @opindex Wno-sequence-point
3730 Warn about code that may have undefined semantics because of violations
3731 of sequence point rules in the C and C++ standards.
3733 The C and C++ standards define the order in which expressions in a C/C++
3734 program are evaluated in terms of @dfn{sequence points}, which represent
3735 a partial ordering between the execution of parts of the program: those
3736 executed before the sequence point, and those executed after it.  These
3737 occur after the evaluation of a full expression (one which is not part
3738 of a larger expression), after the evaluation of the first operand of a
3739 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3740 function is called (but after the evaluation of its arguments and the
3741 expression denoting the called function), and in certain other places.
3742 Other than as expressed by the sequence point rules, the order of
3743 evaluation of subexpressions of an expression is not specified.  All
3744 these rules describe only a partial order rather than a total order,
3745 since, for example, if two functions are called within one expression
3746 with no sequence point between them, the order in which the functions
3747 are called is not specified.  However, the standards committee have
3748 ruled that function calls do not overlap.
3750 It is not specified when between sequence points modifications to the
3751 values of objects take effect.  Programs whose behavior depends on this
3752 have undefined behavior; the C and C++ standards specify that ``Between
3753 the previous and next sequence point an object shall have its stored
3754 value modified at most once by the evaluation of an expression.
3755 Furthermore, the prior value shall be read only to determine the value
3756 to be stored.''.  If a program breaks these rules, the results on any
3757 particular implementation are entirely unpredictable.
3759 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3760 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3761 diagnosed by this option, and it may give an occasional false positive
3762 result, but in general it has been found fairly effective at detecting
3763 this sort of problem in programs.
3765 The standard is worded confusingly, therefore there is some debate
3766 over the precise meaning of the sequence point rules in subtle cases.
3767 Links to discussions of the problem, including proposed formal
3768 definitions, may be found on the GCC readings page, at
3769 @uref{http://gcc.gnu.org/@/readings.html}.
3771 This warning is enabled by @option{-Wall} for C and C++.
3773 @item -Wno-return-local-addr
3774 @opindex Wno-return-local-addr
3775 @opindex Wreturn-local-addr
3776 Do not warn about returning a pointer (or in C++, a reference) to a
3777 variable that goes out of scope after the function returns.
3779 @item -Wreturn-type
3780 @opindex Wreturn-type
3781 @opindex Wno-return-type
3782 Warn whenever a function is defined with a return type that defaults
3783 to @code{int}.  Also warn about any @code{return} statement with no
3784 return value in a function whose return type is not @code{void}
3785 (falling off the end of the function body is considered returning
3786 without a value), and about a @code{return} statement with an
3787 expression in a function whose return type is @code{void}.
3789 For C++, a function without return type always produces a diagnostic
3790 message, even when @option{-Wno-return-type} is specified.  The only
3791 exceptions are @samp{main} and functions defined in system headers.
3793 This warning is enabled by @option{-Wall}.
3795 @item -Wswitch
3796 @opindex Wswitch
3797 @opindex Wno-switch
3798 Warn whenever a @code{switch} statement has an index of enumerated type
3799 and lacks a @code{case} for one or more of the named codes of that
3800 enumeration.  (The presence of a @code{default} label prevents this
3801 warning.)  @code{case} labels outside the enumeration range also
3802 provoke warnings when this option is used (even if there is a
3803 @code{default} label).
3804 This warning is enabled by @option{-Wall}.
3806 @item -Wswitch-default
3807 @opindex Wswitch-default
3808 @opindex Wno-switch-default
3809 Warn whenever a @code{switch} statement does not have a @code{default}
3810 case.
3812 @item -Wswitch-enum
3813 @opindex Wswitch-enum
3814 @opindex Wno-switch-enum
3815 Warn whenever a @code{switch} statement has an index of enumerated type
3816 and lacks a @code{case} for one or more of the named codes of that
3817 enumeration.  @code{case} labels outside the enumeration range also
3818 provoke warnings when this option is used.  The only difference
3819 between @option{-Wswitch} and this option is that this option gives a
3820 warning about an omitted enumeration code even if there is a
3821 @code{default} label.
3823 @item -Wsync-nand @r{(C and C++ only)}
3824 @opindex Wsync-nand
3825 @opindex Wno-sync-nand
3826 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3827 built-in functions are used.  These functions changed semantics in GCC 4.4.
3829 @item -Wtrigraphs
3830 @opindex Wtrigraphs
3831 @opindex Wno-trigraphs
3832 Warn if any trigraphs are encountered that might change the meaning of
3833 the program (trigraphs within comments are not warned about).
3834 This warning is enabled by @option{-Wall}.
3836 @item -Wunused-but-set-parameter
3837 @opindex Wunused-but-set-parameter
3838 @opindex Wno-unused-but-set-parameter
3839 Warn whenever a function parameter is assigned to, but otherwise unused
3840 (aside from its declaration).
3842 To suppress this warning use the @samp{unused} attribute
3843 (@pxref{Variable Attributes}).
3845 This warning is also enabled by @option{-Wunused} together with
3846 @option{-Wextra}.
3848 @item -Wunused-but-set-variable
3849 @opindex Wunused-but-set-variable
3850 @opindex Wno-unused-but-set-variable
3851 Warn whenever a local variable is assigned to, but otherwise unused
3852 (aside from its declaration).
3853 This warning is enabled by @option{-Wall}.
3855 To suppress this warning use the @samp{unused} attribute
3856 (@pxref{Variable Attributes}).
3858 This warning is also enabled by @option{-Wunused}, which is enabled
3859 by @option{-Wall}.
3861 @item -Wunused-function
3862 @opindex Wunused-function
3863 @opindex Wno-unused-function
3864 Warn whenever a static function is declared but not defined or a
3865 non-inline static function is unused.
3866 This warning is enabled by @option{-Wall}.
3868 @item -Wunused-label
3869 @opindex Wunused-label
3870 @opindex Wno-unused-label
3871 Warn whenever a label is declared but not used.
3872 This warning is enabled by @option{-Wall}.
3874 To suppress this warning use the @samp{unused} attribute
3875 (@pxref{Variable Attributes}).
3877 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3878 @opindex Wunused-local-typedefs
3879 Warn when a typedef locally defined in a function is not used.
3880 This warning is enabled by @option{-Wall}.
3882 @item -Wunused-parameter
3883 @opindex Wunused-parameter
3884 @opindex Wno-unused-parameter
3885 Warn whenever a function parameter is unused aside from its declaration.
3887 To suppress this warning use the @samp{unused} attribute
3888 (@pxref{Variable Attributes}).
3890 @item -Wno-unused-result
3891 @opindex Wunused-result
3892 @opindex Wno-unused-result
3893 Do not warn if a caller of a function marked with attribute
3894 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3895 its return value. The default is @option{-Wunused-result}.
3897 @item -Wunused-variable
3898 @opindex Wunused-variable
3899 @opindex Wno-unused-variable
3900 Warn whenever a local variable or non-constant static variable is unused
3901 aside from its declaration.
3902 This warning is enabled by @option{-Wall}.
3904 To suppress this warning use the @samp{unused} attribute
3905 (@pxref{Variable Attributes}).
3907 @item -Wunused-value
3908 @opindex Wunused-value
3909 @opindex Wno-unused-value
3910 Warn whenever a statement computes a result that is explicitly not
3911 used. To suppress this warning cast the unused expression to
3912 @samp{void}. This includes an expression-statement or the left-hand
3913 side of a comma expression that contains no side effects. For example,
3914 an expression such as @samp{x[i,j]} causes a warning, while
3915 @samp{x[(void)i,j]} does not.
3917 This warning is enabled by @option{-Wall}.
3919 @item -Wunused
3920 @opindex Wunused
3921 @opindex Wno-unused
3922 All the above @option{-Wunused} options combined.
3924 In order to get a warning about an unused function parameter, you must
3925 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3926 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3928 @item -Wuninitialized
3929 @opindex Wuninitialized
3930 @opindex Wno-uninitialized
3931 Warn if an automatic variable is used without first being initialized
3932 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3933 warn if a non-static reference or non-static @samp{const} member
3934 appears in a class without constructors.
3936 If you want to warn about code that uses the uninitialized value of the
3937 variable in its own initializer, use the @option{-Winit-self} option.
3939 These warnings occur for individual uninitialized or clobbered
3940 elements of structure, union or array variables as well as for
3941 variables that are uninitialized or clobbered as a whole.  They do
3942 not occur for variables or elements declared @code{volatile}.  Because
3943 these warnings depend on optimization, the exact variables or elements
3944 for which there are warnings depends on the precise optimization
3945 options and version of GCC used.
3947 Note that there may be no warning about a variable that is used only
3948 to compute a value that itself is never used, because such
3949 computations may be deleted by data flow analysis before the warnings
3950 are printed.
3952 @item -Wmaybe-uninitialized
3953 @opindex Wmaybe-uninitialized
3954 @opindex Wno-maybe-uninitialized
3955 For an automatic variable, if there exists a path from the function
3956 entry to a use of the variable that is initialized, but there exist
3957 some other paths for which the variable is not initialized, the compiler
3958 emits a warning if it cannot prove the uninitialized paths are not
3959 executed at run time. These warnings are made optional because GCC is
3960 not smart enough to see all the reasons why the code might be correct
3961 in spite of appearing to have an error.  Here is one example of how
3962 this can happen:
3964 @smallexample
3965 @group
3967   int x;
3968   switch (y)
3969     @{
3970     case 1: x = 1;
3971       break;
3972     case 2: x = 4;
3973       break;
3974     case 3: x = 5;
3975     @}
3976   foo (x);
3978 @end group
3979 @end smallexample
3981 @noindent
3982 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3983 always initialized, but GCC doesn't know this. To suppress the
3984 warning, you need to provide a default case with assert(0) or
3985 similar code.
3987 @cindex @code{longjmp} warnings
3988 This option also warns when a non-volatile automatic variable might be
3989 changed by a call to @code{longjmp}.  These warnings as well are possible
3990 only in optimizing compilation.
3992 The compiler sees only the calls to @code{setjmp}.  It cannot know
3993 where @code{longjmp} will be called; in fact, a signal handler could
3994 call it at any point in the code.  As a result, you may get a warning
3995 even when there is in fact no problem because @code{longjmp} cannot
3996 in fact be called at the place that would cause a problem.
3998 Some spurious warnings can be avoided if you declare all the functions
3999 you use that never return as @code{noreturn}.  @xref{Function
4000 Attributes}.
4002 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4004 @item -Wunknown-pragmas
4005 @opindex Wunknown-pragmas
4006 @opindex Wno-unknown-pragmas
4007 @cindex warning for unknown pragmas
4008 @cindex unknown pragmas, warning
4009 @cindex pragmas, warning of unknown
4010 Warn when a @code{#pragma} directive is encountered that is not understood by 
4011 GCC@.  If this command-line option is used, warnings are even issued
4012 for unknown pragmas in system header files.  This is not the case if
4013 the warnings are only enabled by the @option{-Wall} command-line option.
4015 @item -Wno-pragmas
4016 @opindex Wno-pragmas
4017 @opindex Wpragmas
4018 Do not warn about misuses of pragmas, such as incorrect parameters,
4019 invalid syntax, or conflicts between pragmas.  See also
4020 @option{-Wunknown-pragmas}.
4022 @item -Wstrict-aliasing
4023 @opindex Wstrict-aliasing
4024 @opindex Wno-strict-aliasing
4025 This option is only active when @option{-fstrict-aliasing} is active.
4026 It warns about code that might break the strict aliasing rules that the
4027 compiler is using for optimization.  The warning does not catch all
4028 cases, but does attempt to catch the more common pitfalls.  It is
4029 included in @option{-Wall}.
4030 It is equivalent to @option{-Wstrict-aliasing=3}
4032 @item -Wstrict-aliasing=n
4033 @opindex Wstrict-aliasing=n
4034 This option is only active when @option{-fstrict-aliasing} is active.
4035 It warns about code that might break the strict aliasing rules that the
4036 compiler is using for optimization.
4037 Higher levels correspond to higher accuracy (fewer false positives).
4038 Higher levels also correspond to more effort, similar to the way @option{-O} 
4039 works.
4040 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4042 Level 1: Most aggressive, quick, least accurate.
4043 Possibly useful when higher levels
4044 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4045 false negatives.  However, it has many false positives.
4046 Warns for all pointer conversions between possibly incompatible types,
4047 even if never dereferenced.  Runs in the front end only.
4049 Level 2: Aggressive, quick, not too precise.
4050 May still have many false positives (not as many as level 1 though),
4051 and few false negatives (but possibly more than level 1).
4052 Unlike level 1, it only warns when an address is taken.  Warns about
4053 incomplete types.  Runs in the front end only.
4055 Level 3 (default for @option{-Wstrict-aliasing}):
4056 Should have very few false positives and few false
4057 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4058 Takes care of the common pun+dereference pattern in the front end:
4059 @code{*(int*)&some_float}.
4060 If optimization is enabled, it also runs in the back end, where it deals
4061 with multiple statement cases using flow-sensitive points-to information.
4062 Only warns when the converted pointer is dereferenced.
4063 Does not warn about incomplete types.
4065 @item -Wstrict-overflow
4066 @itemx -Wstrict-overflow=@var{n}
4067 @opindex Wstrict-overflow
4068 @opindex Wno-strict-overflow
4069 This option is only active when @option{-fstrict-overflow} is active.
4070 It warns about cases where the compiler optimizes based on the
4071 assumption that signed overflow does not occur.  Note that it does not
4072 warn about all cases where the code might overflow: it only warns
4073 about cases where the compiler implements some optimization.  Thus
4074 this warning depends on the optimization level.
4076 An optimization that assumes that signed overflow does not occur is
4077 perfectly safe if the values of the variables involved are such that
4078 overflow never does, in fact, occur.  Therefore this warning can
4079 easily give a false positive: a warning about code that is not
4080 actually a problem.  To help focus on important issues, several
4081 warning levels are defined.  No warnings are issued for the use of
4082 undefined signed overflow when estimating how many iterations a loop
4083 requires, in particular when determining whether a loop will be
4084 executed at all.
4086 @table @gcctabopt
4087 @item -Wstrict-overflow=1
4088 Warn about cases that are both questionable and easy to avoid.  For
4089 example,  with @option{-fstrict-overflow}, the compiler simplifies
4090 @code{x + 1 > x} to @code{1}.  This level of
4091 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4092 are not, and must be explicitly requested.
4094 @item -Wstrict-overflow=2
4095 Also warn about other cases where a comparison is simplified to a
4096 constant.  For example: @code{abs (x) >= 0}.  This can only be
4097 simplified when @option{-fstrict-overflow} is in effect, because
4098 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4099 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4100 @option{-Wstrict-overflow=2}.
4102 @item -Wstrict-overflow=3
4103 Also warn about other cases where a comparison is simplified.  For
4104 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4106 @item -Wstrict-overflow=4
4107 Also warn about other simplifications not covered by the above cases.
4108 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4110 @item -Wstrict-overflow=5
4111 Also warn about cases where the compiler reduces the magnitude of a
4112 constant involved in a comparison.  For example: @code{x + 2 > y} is
4113 simplified to @code{x + 1 >= y}.  This is reported only at the
4114 highest warning level because this simplification applies to many
4115 comparisons, so this warning level gives a very large number of
4116 false positives.
4117 @end table
4119 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4120 @opindex Wsuggest-attribute=
4121 @opindex Wno-suggest-attribute=
4122 Warn for cases where adding an attribute may be beneficial. The
4123 attributes currently supported are listed below.
4125 @table @gcctabopt
4126 @item -Wsuggest-attribute=pure
4127 @itemx -Wsuggest-attribute=const
4128 @itemx -Wsuggest-attribute=noreturn
4129 @opindex Wsuggest-attribute=pure
4130 @opindex Wno-suggest-attribute=pure
4131 @opindex Wsuggest-attribute=const
4132 @opindex Wno-suggest-attribute=const
4133 @opindex Wsuggest-attribute=noreturn
4134 @opindex Wno-suggest-attribute=noreturn
4136 Warn about functions that might be candidates for attributes
4137 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4138 functions visible in other compilation units or (in the case of @code{pure} and
4139 @code{const}) if it cannot prove that the function returns normally. A function
4140 returns normally if it doesn't contain an infinite loop or return abnormally
4141 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4142 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4143 higher.  Higher optimization levels improve the accuracy of the analysis.
4145 @item -Wsuggest-attribute=format
4146 @itemx -Wmissing-format-attribute
4147 @opindex Wsuggest-attribute=format
4148 @opindex Wmissing-format-attribute
4149 @opindex Wno-suggest-attribute=format
4150 @opindex Wno-missing-format-attribute
4151 @opindex Wformat
4152 @opindex Wno-format
4154 Warn about function pointers that might be candidates for @code{format}
4155 attributes.  Note these are only possible candidates, not absolute ones.
4156 GCC guesses that function pointers with @code{format} attributes that
4157 are used in assignment, initialization, parameter passing or return
4158 statements should have a corresponding @code{format} attribute in the
4159 resulting type.  I.e.@: the left-hand side of the assignment or
4160 initialization, the type of the parameter variable, or the return type
4161 of the containing function respectively should also have a @code{format}
4162 attribute to avoid the warning.
4164 GCC also warns about function definitions that might be
4165 candidates for @code{format} attributes.  Again, these are only
4166 possible candidates.  GCC guesses that @code{format} attributes
4167 might be appropriate for any function that calls a function like
4168 @code{vprintf} or @code{vscanf}, but this might not always be the
4169 case, and some functions for which @code{format} attributes are
4170 appropriate may not be detected.
4171 @end table
4173 @item -Warray-bounds
4174 @opindex Wno-array-bounds
4175 @opindex Warray-bounds
4176 This option is only active when @option{-ftree-vrp} is active
4177 (default for @option{-O2} and above). It warns about subscripts to arrays
4178 that are always out of bounds. This warning is enabled by @option{-Wall}.
4180 @item -Wno-div-by-zero
4181 @opindex Wno-div-by-zero
4182 @opindex Wdiv-by-zero
4183 Do not warn about compile-time integer division by zero.  Floating-point
4184 division by zero is not warned about, as it can be a legitimate way of
4185 obtaining infinities and NaNs.
4187 @item -Wsystem-headers
4188 @opindex Wsystem-headers
4189 @opindex Wno-system-headers
4190 @cindex warnings from system headers
4191 @cindex system headers, warnings from
4192 Print warning messages for constructs found in system header files.
4193 Warnings from system headers are normally suppressed, on the assumption
4194 that they usually do not indicate real problems and would only make the
4195 compiler output harder to read.  Using this command-line option tells
4196 GCC to emit warnings from system headers as if they occurred in user
4197 code.  However, note that using @option{-Wall} in conjunction with this
4198 option does @emph{not} warn about unknown pragmas in system
4199 headers---for that, @option{-Wunknown-pragmas} must also be used.
4201 @item -Wtrampolines
4202 @opindex Wtrampolines
4203 @opindex Wno-trampolines
4204  Warn about trampolines generated for pointers to nested functions.
4206  A trampoline is a small piece of data or code that is created at run
4207  time on the stack when the address of a nested function is taken, and
4208  is used to call the nested function indirectly.  For some targets, it
4209  is made up of data only and thus requires no special treatment.  But,
4210  for most targets, it is made up of code and thus requires the stack
4211  to be made executable in order for the program to work properly.
4213 @item -Wfloat-equal
4214 @opindex Wfloat-equal
4215 @opindex Wno-float-equal
4216 Warn if floating-point values are used in equality comparisons.
4218 The idea behind this is that sometimes it is convenient (for the
4219 programmer) to consider floating-point values as approximations to
4220 infinitely precise real numbers.  If you are doing this, then you need
4221 to compute (by analyzing the code, or in some other way) the maximum or
4222 likely maximum error that the computation introduces, and allow for it
4223 when performing comparisons (and when producing output, but that's a
4224 different problem).  In particular, instead of testing for equality, you
4225 should check to see whether the two values have ranges that overlap; and
4226 this is done with the relational operators, so equality comparisons are
4227 probably mistaken.
4229 @item -Wtraditional @r{(C and Objective-C only)}
4230 @opindex Wtraditional
4231 @opindex Wno-traditional
4232 Warn about certain constructs that behave differently in traditional and
4233 ISO C@.  Also warn about ISO C constructs that have no traditional C
4234 equivalent, and/or problematic constructs that should be avoided.
4236 @itemize @bullet
4237 @item
4238 Macro parameters that appear within string literals in the macro body.
4239 In traditional C macro replacement takes place within string literals,
4240 but in ISO C it does not.
4242 @item
4243 In traditional C, some preprocessor directives did not exist.
4244 Traditional preprocessors only considered a line to be a directive
4245 if the @samp{#} appeared in column 1 on the line.  Therefore
4246 @option{-Wtraditional} warns about directives that traditional C
4247 understands but ignores because the @samp{#} does not appear as the
4248 first character on the line.  It also suggests you hide directives like
4249 @samp{#pragma} not understood by traditional C by indenting them.  Some
4250 traditional implementations do not recognize @samp{#elif}, so this option
4251 suggests avoiding it altogether.
4253 @item
4254 A function-like macro that appears without arguments.
4256 @item
4257 The unary plus operator.
4259 @item
4260 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4261 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4262 constants.)  Note, these suffixes appear in macros defined in the system
4263 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4264 Use of these macros in user code might normally lead to spurious
4265 warnings, however GCC's integrated preprocessor has enough context to
4266 avoid warning in these cases.
4268 @item
4269 A function declared external in one block and then used after the end of
4270 the block.
4272 @item
4273 A @code{switch} statement has an operand of type @code{long}.
4275 @item
4276 A non-@code{static} function declaration follows a @code{static} one.
4277 This construct is not accepted by some traditional C compilers.
4279 @item
4280 The ISO type of an integer constant has a different width or
4281 signedness from its traditional type.  This warning is only issued if
4282 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4283 typically represent bit patterns, are not warned about.
4285 @item
4286 Usage of ISO string concatenation is detected.
4288 @item
4289 Initialization of automatic aggregates.
4291 @item
4292 Identifier conflicts with labels.  Traditional C lacks a separate
4293 namespace for labels.
4295 @item
4296 Initialization of unions.  If the initializer is zero, the warning is
4297 omitted.  This is done under the assumption that the zero initializer in
4298 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4299 initializer warnings and relies on default initialization to zero in the
4300 traditional C case.
4302 @item
4303 Conversions by prototypes between fixed/floating-point values and vice
4304 versa.  The absence of these prototypes when compiling with traditional
4305 C causes serious problems.  This is a subset of the possible
4306 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4308 @item
4309 Use of ISO C style function definitions.  This warning intentionally is
4310 @emph{not} issued for prototype declarations or variadic functions
4311 because these ISO C features appear in your code when using
4312 libiberty's traditional C compatibility macros, @code{PARAMS} and
4313 @code{VPARAMS}.  This warning is also bypassed for nested functions
4314 because that feature is already a GCC extension and thus not relevant to
4315 traditional C compatibility.
4316 @end itemize
4318 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4319 @opindex Wtraditional-conversion
4320 @opindex Wno-traditional-conversion
4321 Warn if a prototype causes a type conversion that is different from what
4322 would happen to the same argument in the absence of a prototype.  This
4323 includes conversions of fixed point to floating and vice versa, and
4324 conversions changing the width or signedness of a fixed-point argument
4325 except when the same as the default promotion.
4327 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4328 @opindex Wdeclaration-after-statement
4329 @opindex Wno-declaration-after-statement
4330 Warn when a declaration is found after a statement in a block.  This
4331 construct, known from C++, was introduced with ISO C99 and is by default
4332 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4333 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4335 @item -Wundef
4336 @opindex Wundef
4337 @opindex Wno-undef
4338 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4340 @item -Wno-endif-labels
4341 @opindex Wno-endif-labels
4342 @opindex Wendif-labels
4343 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4345 @item -Wshadow
4346 @opindex Wshadow
4347 @opindex Wno-shadow
4348 Warn whenever a local variable or type declaration shadows another variable,
4349 parameter, type, or class member (in C++), or whenever a built-in function
4350 is shadowed. Note that in C++, the compiler warns if a local variable
4351 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4353 @item -Wlarger-than=@var{len}
4354 @opindex Wlarger-than=@var{len}
4355 @opindex Wlarger-than-@var{len}
4356 Warn whenever an object of larger than @var{len} bytes is defined.
4358 @item -Wframe-larger-than=@var{len}
4359 @opindex Wframe-larger-than
4360 Warn if the size of a function frame is larger than @var{len} bytes.
4361 The computation done to determine the stack frame size is approximate
4362 and not conservative.
4363 The actual requirements may be somewhat greater than @var{len}
4364 even if you do not get a warning.  In addition, any space allocated
4365 via @code{alloca}, variable-length arrays, or related constructs
4366 is not included by the compiler when determining
4367 whether or not to issue a warning.
4369 @item -Wno-free-nonheap-object
4370 @opindex Wno-free-nonheap-object
4371 @opindex Wfree-nonheap-object
4372 Do not warn when attempting to free an object that was not allocated
4373 on the heap.
4375 @item -Wstack-usage=@var{len}
4376 @opindex Wstack-usage
4377 Warn if the stack usage of a function might be larger than @var{len} bytes.
4378 The computation done to determine the stack usage is conservative.
4379 Any space allocated via @code{alloca}, variable-length arrays, or related
4380 constructs is included by the compiler when determining whether or not to
4381 issue a warning.
4383 The message is in keeping with the output of @option{-fstack-usage}.
4385 @itemize
4386 @item
4387 If the stack usage is fully static but exceeds the specified amount, it's:
4389 @smallexample
4390   warning: stack usage is 1120 bytes
4391 @end smallexample
4392 @item
4393 If the stack usage is (partly) dynamic but bounded, it's:
4395 @smallexample
4396   warning: stack usage might be 1648 bytes
4397 @end smallexample
4398 @item
4399 If the stack usage is (partly) dynamic and not bounded, it's:
4401 @smallexample
4402   warning: stack usage might be unbounded
4403 @end smallexample
4404 @end itemize
4406 @item -Wunsafe-loop-optimizations
4407 @opindex Wunsafe-loop-optimizations
4408 @opindex Wno-unsafe-loop-optimizations
4409 Warn if the loop cannot be optimized because the compiler cannot
4410 assume anything on the bounds of the loop indices.  With
4411 @option{-funsafe-loop-optimizations} warn if the compiler makes
4412 such assumptions.
4414 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4415 @opindex Wno-pedantic-ms-format
4416 @opindex Wpedantic-ms-format
4417 When used in combination with @option{-Wformat}
4418 and @option{-pedantic} without GNU extensions, this option
4419 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4420 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4421 which depend on the MS runtime.
4423 @item -Wpointer-arith
4424 @opindex Wpointer-arith
4425 @opindex Wno-pointer-arith
4426 Warn about anything that depends on the ``size of'' a function type or
4427 of @code{void}.  GNU C assigns these types a size of 1, for
4428 convenience in calculations with @code{void *} pointers and pointers
4429 to functions.  In C++, warn also when an arithmetic operation involves
4430 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4432 @item -Wtype-limits
4433 @opindex Wtype-limits
4434 @opindex Wno-type-limits
4435 Warn if a comparison is always true or always false due to the limited
4436 range of the data type, but do not warn for constant expressions.  For
4437 example, warn if an unsigned variable is compared against zero with
4438 @samp{<} or @samp{>=}.  This warning is also enabled by
4439 @option{-Wextra}.
4441 @item -Wbad-function-cast @r{(C and Objective-C only)}
4442 @opindex Wbad-function-cast
4443 @opindex Wno-bad-function-cast
4444 Warn whenever a function call is cast to a non-matching type.
4445 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4447 @item -Wc++-compat @r{(C and Objective-C only)}
4448 Warn about ISO C constructs that are outside of the common subset of
4449 ISO C and ISO C++, e.g.@: request for implicit conversion from
4450 @code{void *} to a pointer to non-@code{void} type.
4452 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4453 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4454 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4455 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4456 enabled by @option{-Wall}.
4458 @item -Wcast-qual
4459 @opindex Wcast-qual
4460 @opindex Wno-cast-qual
4461 Warn whenever a pointer is cast so as to remove a type qualifier from
4462 the target type.  For example, warn if a @code{const char *} is cast
4463 to an ordinary @code{char *}.
4465 Also warn when making a cast that introduces a type qualifier in an
4466 unsafe way.  For example, casting @code{char **} to @code{const char **}
4467 is unsafe, as in this example:
4469 @smallexample
4470   /* p is char ** value.  */
4471   const char **q = (const char **) p;
4472   /* Assignment of readonly string to const char * is OK.  */
4473   *q = "string";
4474   /* Now char** pointer points to read-only memory.  */
4475   **p = 'b';
4476 @end smallexample
4478 @item -Wcast-align
4479 @opindex Wcast-align
4480 @opindex Wno-cast-align
4481 Warn whenever a pointer is cast such that the required alignment of the
4482 target is increased.  For example, warn if a @code{char *} is cast to
4483 an @code{int *} on machines where integers can only be accessed at
4484 two- or four-byte boundaries.
4486 @item -Wwrite-strings
4487 @opindex Wwrite-strings
4488 @opindex Wno-write-strings
4489 When compiling C, give string constants the type @code{const
4490 char[@var{length}]} so that copying the address of one into a
4491 non-@code{const} @code{char *} pointer produces a warning.  These
4492 warnings help you find at compile time code that can try to write
4493 into a string constant, but only if you have been very careful about
4494 using @code{const} in declarations and prototypes.  Otherwise, it is
4495 just a nuisance. This is why we did not make @option{-Wall} request
4496 these warnings.
4498 When compiling C++, warn about the deprecated conversion from string
4499 literals to @code{char *}.  This warning is enabled by default for C++
4500 programs.
4502 @item -Wclobbered
4503 @opindex Wclobbered
4504 @opindex Wno-clobbered
4505 Warn for variables that might be changed by @samp{longjmp} or
4506 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4508 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4509 @opindex Wconditionally-supported
4510 @opindex Wno-conditionally-supported
4511 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4513 @item -Wconversion
4514 @opindex Wconversion
4515 @opindex Wno-conversion
4516 Warn for implicit conversions that may alter a value. This includes
4517 conversions between real and integer, like @code{abs (x)} when
4518 @code{x} is @code{double}; conversions between signed and unsigned,
4519 like @code{unsigned ui = -1}; and conversions to smaller types, like
4520 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4521 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4522 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4523 conversions between signed and unsigned integers can be disabled by
4524 using @option{-Wno-sign-conversion}.
4526 For C++, also warn for confusing overload resolution for user-defined
4527 conversions; and conversions that never use a type conversion
4528 operator: conversions to @code{void}, the same type, a base class or a
4529 reference to them. Warnings about conversions between signed and
4530 unsigned integers are disabled by default in C++ unless
4531 @option{-Wsign-conversion} is explicitly enabled.
4533 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4534 @opindex Wconversion-null
4535 @opindex Wno-conversion-null
4536 Do not warn for conversions between @code{NULL} and non-pointer
4537 types. @option{-Wconversion-null} is enabled by default.
4539 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4540 @opindex Wzero-as-null-pointer-constant
4541 @opindex Wno-zero-as-null-pointer-constant
4542 Warn when a literal '0' is used as null pointer constant.  This can
4543 be useful to facilitate the conversion to @code{nullptr} in C++11.
4545 @item -Wdate-time
4546 @opindex Wdate-time
4547 @opindex Wno-date-time
4548 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4549 are encountered as they might prevent bit-wise-identical reproducible
4550 compilations.
4552 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4553 @opindex Wdelete-incomplete
4554 @opindex Wno-delete-incomplete
4555 Warn when deleting a pointer to incomplete type, which may cause
4556 undefined behavior at runtime.  This warning is enabled by default.
4558 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4559 @opindex Wuseless-cast
4560 @opindex Wno-useless-cast
4561 Warn when an expression is casted to its own type.
4563 @item -Wempty-body
4564 @opindex Wempty-body
4565 @opindex Wno-empty-body
4566 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4567 while} statement.  This warning is also enabled by @option{-Wextra}.
4569 @item -Wenum-compare
4570 @opindex Wenum-compare
4571 @opindex Wno-enum-compare
4572 Warn about a comparison between values of different enumerated types.
4573 In C++ enumeral mismatches in conditional expressions are also
4574 diagnosed and the warning is enabled by default.  In C this warning is 
4575 enabled by @option{-Wall}.
4577 @item -Wjump-misses-init @r{(C, Objective-C only)}
4578 @opindex Wjump-misses-init
4579 @opindex Wno-jump-misses-init
4580 Warn if a @code{goto} statement or a @code{switch} statement jumps
4581 forward across the initialization of a variable, or jumps backward to a
4582 label after the variable has been initialized.  This only warns about
4583 variables that are initialized when they are declared.  This warning is
4584 only supported for C and Objective-C; in C++ this sort of branch is an
4585 error in any case.
4587 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4588 can be disabled with the @option{-Wno-jump-misses-init} option.
4590 @item -Wsign-compare
4591 @opindex Wsign-compare
4592 @opindex Wno-sign-compare
4593 @cindex warning for comparison of signed and unsigned values
4594 @cindex comparison of signed and unsigned values, warning
4595 @cindex signed and unsigned values, comparison warning
4596 Warn when a comparison between signed and unsigned values could produce
4597 an incorrect result when the signed value is converted to unsigned.
4598 This warning is also enabled by @option{-Wextra}; to get the other warnings
4599 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4601 @item -Wsign-conversion
4602 @opindex Wsign-conversion
4603 @opindex Wno-sign-conversion
4604 Warn for implicit conversions that may change the sign of an integer
4605 value, like assigning a signed integer expression to an unsigned
4606 integer variable. An explicit cast silences the warning. In C, this
4607 option is enabled also by @option{-Wconversion}.
4609 @item -Wfloat-conversion
4610 @opindex Wfloat-conversion
4611 @opindex Wno-float-conversion
4612 Warn for implicit conversions that reduce the precision of a real value.
4613 This includes conversions from real to integer, and from higher precision
4614 real to lower precision real values.  This option is also enabled by
4615 @option{-Wconversion}.
4617 @item -Wsizeof-pointer-memaccess
4618 @opindex Wsizeof-pointer-memaccess
4619 @opindex Wno-sizeof-pointer-memaccess
4620 Warn for suspicious length parameters to certain string and memory built-in
4621 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4622 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4623 but a pointer, and suggests a possible fix, or about
4624 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4625 @option{-Wall}.
4627 @item -Waddress
4628 @opindex Waddress
4629 @opindex Wno-address
4630 Warn about suspicious uses of memory addresses. These include using
4631 the address of a function in a conditional expression, such as
4632 @code{void func(void); if (func)}, and comparisons against the memory
4633 address of a string literal, such as @code{if (x == "abc")}.  Such
4634 uses typically indicate a programmer error: the address of a function
4635 always evaluates to true, so their use in a conditional usually
4636 indicate that the programmer forgot the parentheses in a function
4637 call; and comparisons against string literals result in unspecified
4638 behavior and are not portable in C, so they usually indicate that the
4639 programmer intended to use @code{strcmp}.  This warning is enabled by
4640 @option{-Wall}.
4642 @item -Wlogical-op
4643 @opindex Wlogical-op
4644 @opindex Wno-logical-op
4645 Warn about suspicious uses of logical operators in expressions.
4646 This includes using logical operators in contexts where a
4647 bit-wise operator is likely to be expected.
4649 @item -Waggregate-return
4650 @opindex Waggregate-return
4651 @opindex Wno-aggregate-return
4652 Warn if any functions that return structures or unions are defined or
4653 called.  (In languages where you can return an array, this also elicits
4654 a warning.)
4656 @item -Wno-aggressive-loop-optimizations
4657 @opindex Wno-aggressive-loop-optimizations
4658 @opindex Waggressive-loop-optimizations
4659 Warn if in a loop with constant number of iterations the compiler detects
4660 undefined behavior in some statement during one or more of the iterations.
4662 @item -Wno-attributes
4663 @opindex Wno-attributes
4664 @opindex Wattributes
4665 Do not warn if an unexpected @code{__attribute__} is used, such as
4666 unrecognized attributes, function attributes applied to variables,
4667 etc.  This does not stop errors for incorrect use of supported
4668 attributes.
4670 @item -Wno-builtin-macro-redefined
4671 @opindex Wno-builtin-macro-redefined
4672 @opindex Wbuiltin-macro-redefined
4673 Do not warn if certain built-in macros are redefined.  This suppresses
4674 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4675 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4677 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4678 @opindex Wstrict-prototypes
4679 @opindex Wno-strict-prototypes
4680 Warn if a function is declared or defined without specifying the
4681 argument types.  (An old-style function definition is permitted without
4682 a warning if preceded by a declaration that specifies the argument
4683 types.)
4685 @item -Wold-style-declaration @r{(C and Objective-C only)}
4686 @opindex Wold-style-declaration
4687 @opindex Wno-old-style-declaration
4688 Warn for obsolescent usages, according to the C Standard, in a
4689 declaration. For example, warn if storage-class specifiers like
4690 @code{static} are not the first things in a declaration.  This warning
4691 is also enabled by @option{-Wextra}.
4693 @item -Wold-style-definition @r{(C and Objective-C only)}
4694 @opindex Wold-style-definition
4695 @opindex Wno-old-style-definition
4696 Warn if an old-style function definition is used.  A warning is given
4697 even if there is a previous prototype.
4699 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4700 @opindex Wmissing-parameter-type
4701 @opindex Wno-missing-parameter-type
4702 A function parameter is declared without a type specifier in K&R-style
4703 functions:
4705 @smallexample
4706 void foo(bar) @{ @}
4707 @end smallexample
4709 This warning is also enabled by @option{-Wextra}.
4711 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4712 @opindex Wmissing-prototypes
4713 @opindex Wno-missing-prototypes
4714 Warn if a global function is defined without a previous prototype
4715 declaration.  This warning is issued even if the definition itself
4716 provides a prototype.  Use this option to detect global functions
4717 that do not have a matching prototype declaration in a header file.
4718 This option is not valid for C++ because all function declarations
4719 provide prototypes and a non-matching declaration will declare an
4720 overload rather than conflict with an earlier declaration.
4721 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4723 @item -Wmissing-declarations
4724 @opindex Wmissing-declarations
4725 @opindex Wno-missing-declarations
4726 Warn if a global function is defined without a previous declaration.
4727 Do so even if the definition itself provides a prototype.
4728 Use this option to detect global functions that are not declared in
4729 header files.  In C, no warnings are issued for functions with previous
4730 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4731 missing prototypes.  In C++, no warnings are issued for function templates,
4732 or for inline functions, or for functions in anonymous namespaces.
4734 @item -Wmissing-field-initializers
4735 @opindex Wmissing-field-initializers
4736 @opindex Wno-missing-field-initializers
4737 @opindex W
4738 @opindex Wextra
4739 @opindex Wno-extra
4740 Warn if a structure's initializer has some fields missing.  For
4741 example, the following code causes such a warning, because
4742 @code{x.h} is implicitly zero:
4744 @smallexample
4745 struct s @{ int f, g, h; @};
4746 struct s x = @{ 3, 4 @};
4747 @end smallexample
4749 This option does not warn about designated initializers, so the following
4750 modification does not trigger a warning:
4752 @smallexample
4753 struct s @{ int f, g, h; @};
4754 struct s x = @{ .f = 3, .g = 4 @};
4755 @end smallexample
4757 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4758 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4760 @item -Wno-multichar
4761 @opindex Wno-multichar
4762 @opindex Wmultichar
4763 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4764 Usually they indicate a typo in the user's code, as they have
4765 implementation-defined values, and should not be used in portable code.
4767 @item -Wnormalized=<none|id|nfc|nfkc>
4768 @opindex Wnormalized=
4769 @cindex NFC
4770 @cindex NFKC
4771 @cindex character set, input normalization
4772 In ISO C and ISO C++, two identifiers are different if they are
4773 different sequences of characters.  However, sometimes when characters
4774 outside the basic ASCII character set are used, you can have two
4775 different character sequences that look the same.  To avoid confusion,
4776 the ISO 10646 standard sets out some @dfn{normalization rules} which
4777 when applied ensure that two sequences that look the same are turned into
4778 the same sequence.  GCC can warn you if you are using identifiers that
4779 have not been normalized; this option controls that warning.
4781 There are four levels of warning supported by GCC@.  The default is
4782 @option{-Wnormalized=nfc}, which warns about any identifier that is
4783 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4784 recommended form for most uses.
4786 Unfortunately, there are some characters allowed in identifiers by
4787 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4788 identifiers.  That is, there's no way to use these symbols in portable
4789 ISO C or C++ and have all your identifiers in NFC@.
4790 @option{-Wnormalized=id} suppresses the warning for these characters.
4791 It is hoped that future versions of the standards involved will correct
4792 this, which is why this option is not the default.
4794 You can switch the warning off for all characters by writing
4795 @option{-Wnormalized=none}.  You should only do this if you
4796 are using some other normalization scheme (like ``D''), because
4797 otherwise you can easily create bugs that are literally impossible to see.
4799 Some characters in ISO 10646 have distinct meanings but look identical
4800 in some fonts or display methodologies, especially once formatting has
4801 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4802 LETTER N'', displays just like a regular @code{n} that has been
4803 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4804 normalization scheme to convert all these into a standard form as
4805 well, and GCC warns if your code is not in NFKC if you use
4806 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4807 about every identifier that contains the letter O because it might be
4808 confused with the digit 0, and so is not the default, but may be
4809 useful as a local coding convention if the programming environment 
4810 cannot be fixed to display these characters distinctly.
4812 @item -Wno-deprecated
4813 @opindex Wno-deprecated
4814 @opindex Wdeprecated
4815 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4817 @item -Wno-deprecated-declarations
4818 @opindex Wno-deprecated-declarations
4819 @opindex Wdeprecated-declarations
4820 Do not warn about uses of functions (@pxref{Function Attributes}),
4821 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4822 Attributes}) marked as deprecated by using the @code{deprecated}
4823 attribute.
4825 @item -Wno-overflow
4826 @opindex Wno-overflow
4827 @opindex Woverflow
4828 Do not warn about compile-time overflow in constant expressions.
4830 @item -Wopenmp-simd
4831 @opindex Wopenm-simd
4832 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
4833 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
4834 be used to relax the cost model.
4836 @item -Woverride-init @r{(C and Objective-C only)}
4837 @opindex Woverride-init
4838 @opindex Wno-override-init
4839 @opindex W
4840 @opindex Wextra
4841 @opindex Wno-extra
4842 Warn if an initialized field without side effects is overridden when
4843 using designated initializers (@pxref{Designated Inits, , Designated
4844 Initializers}).
4846 This warning is included in @option{-Wextra}.  To get other
4847 @option{-Wextra} warnings without this one, use @option{-Wextra
4848 -Wno-override-init}.
4850 @item -Wpacked
4851 @opindex Wpacked
4852 @opindex Wno-packed
4853 Warn if a structure is given the packed attribute, but the packed
4854 attribute has no effect on the layout or size of the structure.
4855 Such structures may be mis-aligned for little benefit.  For
4856 instance, in this code, the variable @code{f.x} in @code{struct bar}
4857 is misaligned even though @code{struct bar} does not itself
4858 have the packed attribute:
4860 @smallexample
4861 @group
4862 struct foo @{
4863   int x;
4864   char a, b, c, d;
4865 @} __attribute__((packed));
4866 struct bar @{
4867   char z;
4868   struct foo f;
4870 @end group
4871 @end smallexample
4873 @item -Wpacked-bitfield-compat
4874 @opindex Wpacked-bitfield-compat
4875 @opindex Wno-packed-bitfield-compat
4876 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4877 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4878 the change can lead to differences in the structure layout.  GCC
4879 informs you when the offset of such a field has changed in GCC 4.4.
4880 For example there is no longer a 4-bit padding between field @code{a}
4881 and @code{b} in this structure:
4883 @smallexample
4884 struct foo
4886   char a:4;
4887   char b:8;
4888 @} __attribute__ ((packed));
4889 @end smallexample
4891 This warning is enabled by default.  Use
4892 @option{-Wno-packed-bitfield-compat} to disable this warning.
4894 @item -Wpadded
4895 @opindex Wpadded
4896 @opindex Wno-padded
4897 Warn if padding is included in a structure, either to align an element
4898 of the structure or to align the whole structure.  Sometimes when this
4899 happens it is possible to rearrange the fields of the structure to
4900 reduce the padding and so make the structure smaller.
4902 @item -Wredundant-decls
4903 @opindex Wredundant-decls
4904 @opindex Wno-redundant-decls
4905 Warn if anything is declared more than once in the same scope, even in
4906 cases where multiple declaration is valid and changes nothing.
4908 @item -Wnested-externs @r{(C and Objective-C only)}
4909 @opindex Wnested-externs
4910 @opindex Wno-nested-externs
4911 Warn if an @code{extern} declaration is encountered within a function.
4913 @item -Wno-inherited-variadic-ctor
4914 @opindex Winherited-variadic-ctor
4915 @opindex Wno-inherited-variadic-ctor
4916 Suppress warnings about use of C++11 inheriting constructors when the
4917 base class inherited from has a C variadic constructor; the warning is
4918 on by default because the ellipsis is not inherited.
4920 @item -Winline
4921 @opindex Winline
4922 @opindex Wno-inline
4923 Warn if a function that is declared as inline cannot be inlined.
4924 Even with this option, the compiler does not warn about failures to
4925 inline functions declared in system headers.
4927 The compiler uses a variety of heuristics to determine whether or not
4928 to inline a function.  For example, the compiler takes into account
4929 the size of the function being inlined and the amount of inlining
4930 that has already been done in the current function.  Therefore,
4931 seemingly insignificant changes in the source program can cause the
4932 warnings produced by @option{-Winline} to appear or disappear.
4934 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4935 @opindex Wno-invalid-offsetof
4936 @opindex Winvalid-offsetof
4937 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4938 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4939 to a non-POD type is undefined.  In existing C++ implementations,
4940 however, @samp{offsetof} typically gives meaningful results even when
4941 applied to certain kinds of non-POD types (such as a simple
4942 @samp{struct} that fails to be a POD type only by virtue of having a
4943 constructor).  This flag is for users who are aware that they are
4944 writing nonportable code and who have deliberately chosen to ignore the
4945 warning about it.
4947 The restrictions on @samp{offsetof} may be relaxed in a future version
4948 of the C++ standard.
4950 @item -Wno-int-to-pointer-cast
4951 @opindex Wno-int-to-pointer-cast
4952 @opindex Wint-to-pointer-cast
4953 Suppress warnings from casts to pointer type of an integer of a
4954 different size. In C++, casting to a pointer type of smaller size is
4955 an error. @option{Wint-to-pointer-cast} is enabled by default.
4958 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4959 @opindex Wno-pointer-to-int-cast
4960 @opindex Wpointer-to-int-cast
4961 Suppress warnings from casts from a pointer to an integer type of a
4962 different size.
4964 @item -Winvalid-pch
4965 @opindex Winvalid-pch
4966 @opindex Wno-invalid-pch
4967 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4968 the search path but can't be used.
4970 @item -Wlong-long
4971 @opindex Wlong-long
4972 @opindex Wno-long-long
4973 Warn if @samp{long long} type is used.  This is enabled by either
4974 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4975 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4977 @item -Wvariadic-macros
4978 @opindex Wvariadic-macros
4979 @opindex Wno-variadic-macros
4980 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4981 alternate syntax when in pedantic ISO C99 mode.  This is default.
4982 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4984 @item -Wvarargs
4985 @opindex Wvarargs
4986 @opindex Wno-varargs
4987 Warn upon questionable usage of the macros used to handle variable
4988 arguments like @samp{va_start}.  This is default.  To inhibit the
4989 warning messages, use @option{-Wno-varargs}.
4991 @item -Wvector-operation-performance
4992 @opindex Wvector-operation-performance
4993 @opindex Wno-vector-operation-performance
4994 Warn if vector operation is not implemented via SIMD capabilities of the
4995 architecture.  Mainly useful for the performance tuning.
4996 Vector operation can be implemented @code{piecewise}, which means that the
4997 scalar operation is performed on every vector element; 
4998 @code{in parallel}, which means that the vector operation is implemented
4999 using scalars of wider type, which normally is more performance efficient;
5000 and @code{as a single scalar}, which means that vector fits into a
5001 scalar type.
5003 @item -Wno-virtual-move-assign
5004 @opindex Wvirtual-move-assign
5005 @opindex Wno-virtual-move-assign
5006 Suppress warnings about inheriting from a virtual base with a
5007 non-trivial C++11 move assignment operator.  This is dangerous because
5008 if the virtual base is reachable along more than one path, it will be
5009 moved multiple times, which can mean both objects end up in the
5010 moved-from state.  If the move assignment operator is written to avoid
5011 moving from a moved-from object, this warning can be disabled.
5013 @item -Wvla
5014 @opindex Wvla
5015 @opindex Wno-vla
5016 Warn if variable length array is used in the code.
5017 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5018 the variable length array.
5020 @item -Wvolatile-register-var
5021 @opindex Wvolatile-register-var
5022 @opindex Wno-volatile-register-var
5023 Warn if a register variable is declared volatile.  The volatile
5024 modifier does not inhibit all optimizations that may eliminate reads
5025 and/or writes to register variables.  This warning is enabled by
5026 @option{-Wall}.
5028 @item -Wdisabled-optimization
5029 @opindex Wdisabled-optimization
5030 @opindex Wno-disabled-optimization
5031 Warn if a requested optimization pass is disabled.  This warning does
5032 not generally indicate that there is anything wrong with your code; it
5033 merely indicates that GCC's optimizers are unable to handle the code
5034 effectively.  Often, the problem is that your code is too big or too
5035 complex; GCC refuses to optimize programs when the optimization
5036 itself is likely to take inordinate amounts of time.
5038 @item -Wpointer-sign @r{(C and Objective-C only)}
5039 @opindex Wpointer-sign
5040 @opindex Wno-pointer-sign
5041 Warn for pointer argument passing or assignment with different signedness.
5042 This option is only supported for C and Objective-C@.  It is implied by
5043 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5044 @option{-Wno-pointer-sign}.
5046 @item -Wstack-protector
5047 @opindex Wstack-protector
5048 @opindex Wno-stack-protector
5049 This option is only active when @option{-fstack-protector} is active.  It
5050 warns about functions that are not protected against stack smashing.
5052 @item -Woverlength-strings
5053 @opindex Woverlength-strings
5054 @opindex Wno-overlength-strings
5055 Warn about string constants that are longer than the ``minimum
5056 maximum'' length specified in the C standard.  Modern compilers
5057 generally allow string constants that are much longer than the
5058 standard's minimum limit, but very portable programs should avoid
5059 using longer strings.
5061 The limit applies @emph{after} string constant concatenation, and does
5062 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5063 C99, it was raised to 4095.  C++98 does not specify a normative
5064 minimum maximum, so we do not diagnose overlength strings in C++@.
5066 This option is implied by @option{-Wpedantic}, and can be disabled with
5067 @option{-Wno-overlength-strings}.
5069 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5070 @opindex Wunsuffixed-float-constants
5072 Issue a warning for any floating constant that does not have
5073 a suffix.  When used together with @option{-Wsystem-headers} it
5074 warns about such constants in system header files.  This can be useful
5075 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5076 from the decimal floating-point extension to C99.
5077 @end table
5079 @node Debugging Options
5080 @section Options for Debugging Your Program or GCC
5081 @cindex options, debugging
5082 @cindex debugging information options
5084 GCC has various special options that are used for debugging
5085 either your program or GCC:
5087 @table @gcctabopt
5088 @item -g
5089 @opindex g
5090 Produce debugging information in the operating system's native format
5091 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5092 information.
5094 On most systems that use stabs format, @option{-g} enables use of extra
5095 debugging information that only GDB can use; this extra information
5096 makes debugging work better in GDB but probably makes other debuggers
5097 crash or
5098 refuse to read the program.  If you want to control for certain whether
5099 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5100 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5102 GCC allows you to use @option{-g} with
5103 @option{-O}.  The shortcuts taken by optimized code may occasionally
5104 produce surprising results: some variables you declared may not exist
5105 at all; flow of control may briefly move where you did not expect it;
5106 some statements may not be executed because they compute constant
5107 results or their values are already at hand; some statements may
5108 execute in different places because they have been moved out of loops.
5110 Nevertheless it proves possible to debug optimized output.  This makes
5111 it reasonable to use the optimizer for programs that might have bugs.
5113 The following options are useful when GCC is generated with the
5114 capability for more than one debugging format.
5116 @item -gsplit-dwarf
5117 @opindex gsplit-dwarf
5118 Separate as much dwarf debugging information as possible into a
5119 separate output file with the extension .dwo.  This option allows
5120 the build system to avoid linking files with debug information.  To
5121 be useful, this option requires a debugger capable of reading .dwo
5122 files.
5124 @item -ggdb
5125 @opindex ggdb
5126 Produce debugging information for use by GDB@.  This means to use the
5127 most expressive format available (DWARF 2, stabs, or the native format
5128 if neither of those are supported), including GDB extensions if at all
5129 possible.
5131 @item -gpubnames
5132 @opindex gpubnames
5133 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5135 @item -ggnu-pubnames
5136 @opindex ggnu-pubnames
5137 Generate .debug_pubnames and .debug_pubtypes sections in a format
5138 suitable for conversion into a GDB@ index.  This option is only useful
5139 with a linker that can produce GDB@ index version 7.
5141 @item -gstabs
5142 @opindex gstabs
5143 Produce debugging information in stabs format (if that is supported),
5144 without GDB extensions.  This is the format used by DBX on most BSD
5145 systems.  On MIPS, Alpha and System V Release 4 systems this option
5146 produces stabs debugging output that is not understood by DBX or SDB@.
5147 On System V Release 4 systems this option requires the GNU assembler.
5149 @item -feliminate-unused-debug-symbols
5150 @opindex feliminate-unused-debug-symbols
5151 Produce debugging information in stabs format (if that is supported),
5152 for only symbols that are actually used.
5154 @item -femit-class-debug-always
5155 Instead of emitting debugging information for a C++ class in only one
5156 object file, emit it in all object files using the class.  This option
5157 should be used only with debuggers that are unable to handle the way GCC
5158 normally emits debugging information for classes because using this
5159 option increases the size of debugging information by as much as a
5160 factor of two.
5162 @item -fdebug-types-section
5163 @opindex fdebug-types-section
5164 @opindex fno-debug-types-section
5165 When using DWARF Version 4 or higher, type DIEs can be put into
5166 their own @code{.debug_types} section instead of making them part of the
5167 @code{.debug_info} section.  It is more efficient to put them in a separate
5168 comdat sections since the linker can then remove duplicates.
5169 But not all DWARF consumers support @code{.debug_types} sections yet
5170 and on some objects @code{.debug_types} produces larger instead of smaller
5171 debugging information.
5173 @item -gstabs+
5174 @opindex gstabs+
5175 Produce debugging information in stabs format (if that is supported),
5176 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5177 use of these extensions is likely to make other debuggers crash or
5178 refuse to read the program.
5180 @item -gcoff
5181 @opindex gcoff
5182 Produce debugging information in COFF format (if that is supported).
5183 This is the format used by SDB on most System V systems prior to
5184 System V Release 4.
5186 @item -gxcoff
5187 @opindex gxcoff
5188 Produce debugging information in XCOFF format (if that is supported).
5189 This is the format used by the DBX debugger on IBM RS/6000 systems.
5191 @item -gxcoff+
5192 @opindex gxcoff+
5193 Produce debugging information in XCOFF format (if that is supported),
5194 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5195 use of these extensions is likely to make other debuggers crash or
5196 refuse to read the program, and may cause assemblers other than the GNU
5197 assembler (GAS) to fail with an error.
5199 @item -gdwarf-@var{version}
5200 @opindex gdwarf-@var{version}
5201 Produce debugging information in DWARF format (if that is supported).
5202 The value of @var{version} may be either 2, 3 or 4; the default version
5203 for most targets is 4.
5205 Note that with DWARF Version 2, some ports require and always
5206 use some non-conflicting DWARF 3 extensions in the unwind tables.
5208 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5209 for maximum benefit.
5211 @item -grecord-gcc-switches
5212 @opindex grecord-gcc-switches
5213 This switch causes the command-line options used to invoke the
5214 compiler that may affect code generation to be appended to the
5215 DW_AT_producer attribute in DWARF debugging information.  The options
5216 are concatenated with spaces separating them from each other and from
5217 the compiler version.  See also @option{-frecord-gcc-switches} for another
5218 way of storing compiler options into the object file.  This is the default.
5220 @item -gno-record-gcc-switches
5221 @opindex gno-record-gcc-switches
5222 Disallow appending command-line options to the DW_AT_producer attribute
5223 in DWARF debugging information.
5225 @item -gstrict-dwarf
5226 @opindex gstrict-dwarf
5227 Disallow using extensions of later DWARF standard version than selected
5228 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5229 DWARF extensions from later standard versions is allowed.
5231 @item -gno-strict-dwarf
5232 @opindex gno-strict-dwarf
5233 Allow using extensions of later DWARF standard version than selected with
5234 @option{-gdwarf-@var{version}}.
5236 @item -gvms
5237 @opindex gvms
5238 Produce debugging information in Alpha/VMS debug format (if that is
5239 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5241 @item -g@var{level}
5242 @itemx -ggdb@var{level}
5243 @itemx -gstabs@var{level}
5244 @itemx -gcoff@var{level}
5245 @itemx -gxcoff@var{level}
5246 @itemx -gvms@var{level}
5247 Request debugging information and also use @var{level} to specify how
5248 much information.  The default level is 2.
5250 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5251 @option{-g}.
5253 Level 1 produces minimal information, enough for making backtraces in
5254 parts of the program that you don't plan to debug.  This includes
5255 descriptions of functions and external variables, and line number
5256 tables, but no information about local variables.
5258 Level 3 includes extra information, such as all the macro definitions
5259 present in the program.  Some debuggers support macro expansion when
5260 you use @option{-g3}.
5262 @option{-gdwarf-2} does not accept a concatenated debug level, because
5263 GCC used to support an option @option{-gdwarf} that meant to generate
5264 debug information in version 1 of the DWARF format (which is very
5265 different from version 2), and it would have been too confusing.  That
5266 debug format is long obsolete, but the option cannot be changed now.
5267 Instead use an additional @option{-g@var{level}} option to change the
5268 debug level for DWARF.
5270 @item -gtoggle
5271 @opindex gtoggle
5272 Turn off generation of debug info, if leaving out this option
5273 generates it, or turn it on at level 2 otherwise.  The position of this
5274 argument in the command line does not matter; it takes effect after all
5275 other options are processed, and it does so only once, no matter how
5276 many times it is given.  This is mainly intended to be used with
5277 @option{-fcompare-debug}.
5279 @item -fsanitize=address
5280 @opindex fsanitize=address
5281 Enable AddressSanitizer, a fast memory error detector.
5282 Memory access instructions will be instrumented to detect
5283 out-of-bounds and use-after-free bugs.
5284 See @uref{http://code.google.com/p/address-sanitizer/} for
5285 more details.  The run-time behavior can be influenced using the
5286 @env{ASAN_OPTIONS} environment variable; see
5287 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5288 a list of supported options.
5290 @item -fsanitize=kernel-address
5291 @opindex fsanitize=kernel-address
5292 Enable AddressSanitizer for Linux kernel.
5293 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5295 @item -fsanitize=thread
5296 @opindex fsanitize=thread
5297 Enable ThreadSanitizer, a fast data race detector.
5298 Memory access instructions will be instrumented to detect
5299 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5300 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5301 environment variable; see
5302 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5303 supported options.
5305 @item -fsanitize=leak
5306 @opindex fsanitize=leak
5307 Enable LeakSanitizer, a memory leak detector.
5308 This option only matters for linking of executables and if neither
5309 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5310 case it will link the executable against a library that overrides @code{malloc}
5311 and other allocator functions.  See
5312 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5313 details.  The run-time behavior can be influenced using the
5314 @env{LSAN_OPTIONS} environment variable.
5316 @item -fsanitize=undefined
5317 @opindex fsanitize=undefined
5318 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5319 Various computations will be instrumented to detect undefined behavior
5320 at runtime.  Current suboptions are:
5322 @table @gcctabopt
5324 @item -fsanitize=shift
5325 @opindex fsanitize=shift
5327 This option enables checking that the result of a shift operation is
5328 not undefined.  Note that what exactly is considered undefined differs
5329 slightly between C and C++, as well as between ISO C90 and C99, etc.
5331 @item -fsanitize=integer-divide-by-zero
5332 @opindex fsanitize=integer-divide-by-zero
5334 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5336 @item -fsanitize=unreachable
5337 @opindex fsanitize=unreachable
5339 With this option, the compiler will turn the @code{__builtin_unreachable}
5340 call into a diagnostics message call instead.  When reaching the
5341 @code{__builtin_unreachable} call, the behavior is undefined.
5343 @item -fsanitize=vla-bound
5344 @opindex fsanitize=vla-bound
5346 This option instructs the compiler to check that the size of a variable
5347 length array is positive.  This option does not have any effect in
5348 @option{-std=c++1y} mode, as the standard requires the exception be thrown
5349 instead.
5351 @item -fsanitize=null
5352 @opindex fsanitize=null
5354 This option enables pointer checking.  Particularly, the application
5355 built with this option turned on will issue an error message when it
5356 tries to dereference a NULL pointer, or if a reference (possibly an
5357 rvalue reference) is bound to a NULL pointer.
5359 @item -fsanitize=return
5360 @opindex fsanitize=return
5362 This option enables return statement checking.  Programs
5363 built with this option turned on will issue an error message
5364 when the end of a non-void function is reached without actually
5365 returning a value.  This option works in C++ only.
5367 @item -fsanitize=signed-integer-overflow
5368 @opindex fsanitize=signed-integer-overflow
5370 This option enables signed integer overflow checking.  We check that
5371 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5372 does not overflow in the signed arithmetics.  Note, integer promotion
5373 rules must be taken into account.  That is, the following is not an
5374 overflow:
5375 @smallexample
5376 signed char a = SCHAR_MAX;
5377 a++;
5378 @end smallexample
5380 @end table
5382 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5383 @option{-fsanitize=undefined} gives a diagnostic message.
5384 This currently works only for the C family of languages.
5386 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5387 @opindex fdump-final-insns
5388 Dump the final internal representation (RTL) to @var{file}.  If the
5389 optional argument is omitted (or if @var{file} is @code{.}), the name
5390 of the dump file is determined by appending @code{.gkd} to the
5391 compilation output file name.
5393 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5394 @opindex fcompare-debug
5395 @opindex fno-compare-debug
5396 If no error occurs during compilation, run the compiler a second time,
5397 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5398 passed to the second compilation.  Dump the final internal
5399 representation in both compilations, and print an error if they differ.
5401 If the equal sign is omitted, the default @option{-gtoggle} is used.
5403 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5404 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5405 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5406 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5407 is used.
5409 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5410 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5411 of the final representation and the second compilation, preventing even
5412 @env{GCC_COMPARE_DEBUG} from taking effect.
5414 To verify full coverage during @option{-fcompare-debug} testing, set
5415 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5416 which GCC rejects as an invalid option in any actual compilation
5417 (rather than preprocessing, assembly or linking).  To get just a
5418 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5419 not overridden} will do.
5421 @item -fcompare-debug-second
5422 @opindex fcompare-debug-second
5423 This option is implicitly passed to the compiler for the second
5424 compilation requested by @option{-fcompare-debug}, along with options to
5425 silence warnings, and omitting other options that would cause
5426 side-effect compiler outputs to files or to the standard output.  Dump
5427 files and preserved temporary files are renamed so as to contain the
5428 @code{.gk} additional extension during the second compilation, to avoid
5429 overwriting those generated by the first.
5431 When this option is passed to the compiler driver, it causes the
5432 @emph{first} compilation to be skipped, which makes it useful for little
5433 other than debugging the compiler proper.
5435 @item -feliminate-dwarf2-dups
5436 @opindex feliminate-dwarf2-dups
5437 Compress DWARF 2 debugging information by eliminating duplicated
5438 information about each symbol.  This option only makes sense when
5439 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5441 @item -femit-struct-debug-baseonly
5442 @opindex femit-struct-debug-baseonly
5443 Emit debug information for struct-like types
5444 only when the base name of the compilation source file
5445 matches the base name of file in which the struct is defined.
5447 This option substantially reduces the size of debugging information,
5448 but at significant potential loss in type information to the debugger.
5449 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5450 See @option{-femit-struct-debug-detailed} for more detailed control.
5452 This option works only with DWARF 2.
5454 @item -femit-struct-debug-reduced
5455 @opindex femit-struct-debug-reduced
5456 Emit debug information for struct-like types
5457 only when the base name of the compilation source file
5458 matches the base name of file in which the type is defined,
5459 unless the struct is a template or defined in a system header.
5461 This option significantly reduces the size of debugging information,
5462 with some potential loss in type information to the debugger.
5463 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5464 See @option{-femit-struct-debug-detailed} for more detailed control.
5466 This option works only with DWARF 2.
5468 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5469 Specify the struct-like types
5470 for which the compiler generates debug information.
5471 The intent is to reduce duplicate struct debug information
5472 between different object files within the same program.
5474 This option is a detailed version of
5475 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5476 which serves for most needs.
5478 A specification has the syntax@*
5479 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5481 The optional first word limits the specification to
5482 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5483 A struct type is used directly when it is the type of a variable, member.
5484 Indirect uses arise through pointers to structs.
5485 That is, when use of an incomplete struct is valid, the use is indirect.
5486 An example is
5487 @samp{struct one direct; struct two * indirect;}.
5489 The optional second word limits the specification to
5490 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5491 Generic structs are a bit complicated to explain.
5492 For C++, these are non-explicit specializations of template classes,
5493 or non-template classes within the above.
5494 Other programming languages have generics,
5495 but @option{-femit-struct-debug-detailed} does not yet implement them.
5497 The third word specifies the source files for those
5498 structs for which the compiler should emit debug information.
5499 The values @samp{none} and @samp{any} have the normal meaning.
5500 The value @samp{base} means that
5501 the base of name of the file in which the type declaration appears
5502 must match the base of the name of the main compilation file.
5503 In practice, this means that when compiling @file{foo.c}, debug information
5504 is generated for types declared in that file and @file{foo.h},
5505 but not other header files.
5506 The value @samp{sys} means those types satisfying @samp{base}
5507 or declared in system or compiler headers.
5509 You may need to experiment to determine the best settings for your application.
5511 The default is @option{-femit-struct-debug-detailed=all}.
5513 This option works only with DWARF 2.
5515 @item -fno-merge-debug-strings
5516 @opindex fmerge-debug-strings
5517 @opindex fno-merge-debug-strings
5518 Direct the linker to not merge together strings in the debugging
5519 information that are identical in different object files.  Merging is
5520 not supported by all assemblers or linkers.  Merging decreases the size
5521 of the debug information in the output file at the cost of increasing
5522 link processing time.  Merging is enabled by default.
5524 @item -fdebug-prefix-map=@var{old}=@var{new}
5525 @opindex fdebug-prefix-map
5526 When compiling files in directory @file{@var{old}}, record debugging
5527 information describing them as in @file{@var{new}} instead.
5529 @item -fno-dwarf2-cfi-asm
5530 @opindex fdwarf2-cfi-asm
5531 @opindex fno-dwarf2-cfi-asm
5532 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5533 instead of using GAS @code{.cfi_*} directives.
5535 @cindex @command{prof}
5536 @item -p
5537 @opindex p
5538 Generate extra code to write profile information suitable for the
5539 analysis program @command{prof}.  You must use this option when compiling
5540 the source files you want data about, and you must also use it when
5541 linking.
5543 @cindex @command{gprof}
5544 @item -pg
5545 @opindex pg
5546 Generate extra code to write profile information suitable for the
5547 analysis program @command{gprof}.  You must use this option when compiling
5548 the source files you want data about, and you must also use it when
5549 linking.
5551 @item -Q
5552 @opindex Q
5553 Makes the compiler print out each function name as it is compiled, and
5554 print some statistics about each pass when it finishes.
5556 @item -ftime-report
5557 @opindex ftime-report
5558 Makes the compiler print some statistics about the time consumed by each
5559 pass when it finishes.
5561 @item -fmem-report
5562 @opindex fmem-report
5563 Makes the compiler print some statistics about permanent memory
5564 allocation when it finishes.
5566 @item -fmem-report-wpa
5567 @opindex fmem-report-wpa
5568 Makes the compiler print some statistics about permanent memory
5569 allocation for the WPA phase only.
5571 @item -fpre-ipa-mem-report
5572 @opindex fpre-ipa-mem-report
5573 @item -fpost-ipa-mem-report
5574 @opindex fpost-ipa-mem-report
5575 Makes the compiler print some statistics about permanent memory
5576 allocation before or after interprocedural optimization.
5578 @item -fprofile-report
5579 @opindex fprofile-report
5580 Makes the compiler print some statistics about consistency of the
5581 (estimated) profile and effect of individual passes.
5583 @item -fstack-usage
5584 @opindex fstack-usage
5585 Makes the compiler output stack usage information for the program, on a
5586 per-function basis.  The filename for the dump is made by appending
5587 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5588 the output file, if explicitly specified and it is not an executable,
5589 otherwise it is the basename of the source file.  An entry is made up
5590 of three fields:
5592 @itemize
5593 @item
5594 The name of the function.
5595 @item
5596 A number of bytes.
5597 @item
5598 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5599 @end itemize
5601 The qualifier @code{static} means that the function manipulates the stack
5602 statically: a fixed number of bytes are allocated for the frame on function
5603 entry and released on function exit; no stack adjustments are otherwise made
5604 in the function.  The second field is this fixed number of bytes.
5606 The qualifier @code{dynamic} means that the function manipulates the stack
5607 dynamically: in addition to the static allocation described above, stack
5608 adjustments are made in the body of the function, for example to push/pop
5609 arguments around function calls.  If the qualifier @code{bounded} is also
5610 present, the amount of these adjustments is bounded at compile time and
5611 the second field is an upper bound of the total amount of stack used by
5612 the function.  If it is not present, the amount of these adjustments is
5613 not bounded at compile time and the second field only represents the
5614 bounded part.
5616 @item -fprofile-arcs
5617 @opindex fprofile-arcs
5618 Add code so that program flow @dfn{arcs} are instrumented.  During
5619 execution the program records how many times each branch and call is
5620 executed and how many times it is taken or returns.  When the compiled
5621 program exits it saves this data to a file called
5622 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5623 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5624 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5625 @var{auxname} is generated from the name of the output file, if
5626 explicitly specified and it is not the final executable, otherwise it is
5627 the basename of the source file.  In both cases any suffix is removed
5628 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5629 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5630 @xref{Cross-profiling}.
5632 @cindex @command{gcov}
5633 @item --coverage
5634 @opindex coverage
5636 This option is used to compile and link code instrumented for coverage
5637 analysis.  The option is a synonym for @option{-fprofile-arcs}
5638 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5639 linking).  See the documentation for those options for more details.
5641 @itemize
5643 @item
5644 Compile the source files with @option{-fprofile-arcs} plus optimization
5645 and code generation options.  For test coverage analysis, use the
5646 additional @option{-ftest-coverage} option.  You do not need to profile
5647 every source file in a program.
5649 @item
5650 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5651 (the latter implies the former).
5653 @item
5654 Run the program on a representative workload to generate the arc profile
5655 information.  This may be repeated any number of times.  You can run
5656 concurrent instances of your program, and provided that the file system
5657 supports locking, the data files will be correctly updated.  Also
5658 @code{fork} calls are detected and correctly handled (double counting
5659 will not happen).
5661 @item
5662 For profile-directed optimizations, compile the source files again with
5663 the same optimization and code generation options plus
5664 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5665 Control Optimization}).
5667 @item
5668 For test coverage analysis, use @command{gcov} to produce human readable
5669 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5670 @command{gcov} documentation for further information.
5672 @end itemize
5674 With @option{-fprofile-arcs}, for each function of your program GCC
5675 creates a program flow graph, then finds a spanning tree for the graph.
5676 Only arcs that are not on the spanning tree have to be instrumented: the
5677 compiler adds code to count the number of times that these arcs are
5678 executed.  When an arc is the only exit or only entrance to a block, the
5679 instrumentation code can be added to the block; otherwise, a new basic
5680 block must be created to hold the instrumentation code.
5682 @need 2000
5683 @item -ftest-coverage
5684 @opindex ftest-coverage
5685 Produce a notes file that the @command{gcov} code-coverage utility
5686 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5687 show program coverage.  Each source file's note file is called
5688 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5689 above for a description of @var{auxname} and instructions on how to
5690 generate test coverage data.  Coverage data matches the source files
5691 more closely if you do not optimize.
5693 @item -fdbg-cnt-list
5694 @opindex fdbg-cnt-list
5695 Print the name and the counter upper bound for all debug counters.
5698 @item -fdbg-cnt=@var{counter-value-list}
5699 @opindex fdbg-cnt
5700 Set the internal debug counter upper bound.  @var{counter-value-list}
5701 is a comma-separated list of @var{name}:@var{value} pairs
5702 which sets the upper bound of each debug counter @var{name} to @var{value}.
5703 All debug counters have the initial upper bound of @code{UINT_MAX};
5704 thus @code{dbg_cnt()} returns true always unless the upper bound
5705 is set by this option.
5706 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5707 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5709 @item -fenable-@var{kind}-@var{pass}
5710 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5711 @opindex fdisable-
5712 @opindex fenable-
5714 This is a set of options that are used to explicitly disable/enable
5715 optimization passes.  These options are intended for use for debugging GCC.
5716 Compiler users should use regular options for enabling/disabling
5717 passes instead.
5719 @table @gcctabopt
5721 @item -fdisable-ipa-@var{pass}
5722 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5723 statically invoked in the compiler multiple times, the pass name should be
5724 appended with a sequential number starting from 1.
5726 @item -fdisable-rtl-@var{pass}
5727 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5728 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5729 statically invoked in the compiler multiple times, the pass name should be
5730 appended with a sequential number starting from 1.  @var{range-list} is a 
5731 comma-separated list of function ranges or assembler names.  Each range is a number
5732 pair separated by a colon.  The range is inclusive in both ends.  If the range
5733 is trivial, the number pair can be simplified as a single number.  If the
5734 function's call graph node's @var{uid} falls within one of the specified ranges,
5735 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5736 function header of a dump file, and the pass names can be dumped by using
5737 option @option{-fdump-passes}.
5739 @item -fdisable-tree-@var{pass}
5740 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5741 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5742 option arguments.
5744 @item -fenable-ipa-@var{pass}
5745 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5746 statically invoked in the compiler multiple times, the pass name should be
5747 appended with a sequential number starting from 1.
5749 @item -fenable-rtl-@var{pass}
5750 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5751 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5752 description and examples.
5754 @item -fenable-tree-@var{pass}
5755 @itemx -fenable-tree-@var{pass}=@var{range-list}
5756 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5757 of option arguments.
5759 @end table
5761 Here are some examples showing uses of these options.
5763 @smallexample
5765 # disable ccp1 for all functions
5766    -fdisable-tree-ccp1
5767 # disable complete unroll for function whose cgraph node uid is 1
5768    -fenable-tree-cunroll=1
5769 # disable gcse2 for functions at the following ranges [1,1],
5770 # [300,400], and [400,1000]
5771 # disable gcse2 for functions foo and foo2
5772    -fdisable-rtl-gcse2=foo,foo2
5773 # disable early inlining
5774    -fdisable-tree-einline
5775 # disable ipa inlining
5776    -fdisable-ipa-inline
5777 # enable tree full unroll
5778    -fenable-tree-unroll
5780 @end smallexample
5782 @item -d@var{letters}
5783 @itemx -fdump-rtl-@var{pass}
5784 @itemx -fdump-rtl-@var{pass}=@var{filename}
5785 @opindex d
5786 @opindex fdump-rtl-@var{pass}
5787 Says to make debugging dumps during compilation at times specified by
5788 @var{letters}.  This is used for debugging the RTL-based passes of the
5789 compiler.  The file names for most of the dumps are made by appending
5790 a pass number and a word to the @var{dumpname}, and the files are
5791 created in the directory of the output file. In case of
5792 @option{=@var{filename}} option, the dump is output on the given file
5793 instead of the pass numbered dump files. Note that the pass number is
5794 computed statically as passes get registered into the pass manager.
5795 Thus the numbering is not related to the dynamic order of execution of
5796 passes.  In particular, a pass installed by a plugin could have a
5797 number over 200 even if it executed quite early.  @var{dumpname} is
5798 generated from the name of the output file, if explicitly specified
5799 and it is not an executable, otherwise it is the basename of the
5800 source file. These switches may have different effects when
5801 @option{-E} is used for preprocessing.
5803 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5804 @option{-d} option @var{letters}.  Here are the possible
5805 letters for use in @var{pass} and @var{letters}, and their meanings:
5807 @table @gcctabopt
5809 @item -fdump-rtl-alignments
5810 @opindex fdump-rtl-alignments
5811 Dump after branch alignments have been computed.
5813 @item -fdump-rtl-asmcons
5814 @opindex fdump-rtl-asmcons
5815 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5817 @item -fdump-rtl-auto_inc_dec
5818 @opindex fdump-rtl-auto_inc_dec
5819 Dump after auto-inc-dec discovery.  This pass is only run on
5820 architectures that have auto inc or auto dec instructions.
5822 @item -fdump-rtl-barriers
5823 @opindex fdump-rtl-barriers
5824 Dump after cleaning up the barrier instructions.
5826 @item -fdump-rtl-bbpart
5827 @opindex fdump-rtl-bbpart
5828 Dump after partitioning hot and cold basic blocks.
5830 @item -fdump-rtl-bbro
5831 @opindex fdump-rtl-bbro
5832 Dump after block reordering.
5834 @item -fdump-rtl-btl1
5835 @itemx -fdump-rtl-btl2
5836 @opindex fdump-rtl-btl2
5837 @opindex fdump-rtl-btl2
5838 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5839 after the two branch
5840 target load optimization passes.
5842 @item -fdump-rtl-bypass
5843 @opindex fdump-rtl-bypass
5844 Dump after jump bypassing and control flow optimizations.
5846 @item -fdump-rtl-combine
5847 @opindex fdump-rtl-combine
5848 Dump after the RTL instruction combination pass.
5850 @item -fdump-rtl-compgotos
5851 @opindex fdump-rtl-compgotos
5852 Dump after duplicating the computed gotos.
5854 @item -fdump-rtl-ce1
5855 @itemx -fdump-rtl-ce2
5856 @itemx -fdump-rtl-ce3
5857 @opindex fdump-rtl-ce1
5858 @opindex fdump-rtl-ce2
5859 @opindex fdump-rtl-ce3
5860 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5861 @option{-fdump-rtl-ce3} enable dumping after the three
5862 if conversion passes.
5864 @item -fdump-rtl-cprop_hardreg
5865 @opindex fdump-rtl-cprop_hardreg
5866 Dump after hard register copy propagation.
5868 @item -fdump-rtl-csa
5869 @opindex fdump-rtl-csa
5870 Dump after combining stack adjustments.
5872 @item -fdump-rtl-cse1
5873 @itemx -fdump-rtl-cse2
5874 @opindex fdump-rtl-cse1
5875 @opindex fdump-rtl-cse2
5876 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5877 the two common subexpression elimination passes.
5879 @item -fdump-rtl-dce
5880 @opindex fdump-rtl-dce
5881 Dump after the standalone dead code elimination passes.
5883 @item -fdump-rtl-dbr
5884 @opindex fdump-rtl-dbr
5885 Dump after delayed branch scheduling.
5887 @item -fdump-rtl-dce1
5888 @itemx -fdump-rtl-dce2
5889 @opindex fdump-rtl-dce1
5890 @opindex fdump-rtl-dce2
5891 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5892 the two dead store elimination passes.
5894 @item -fdump-rtl-eh
5895 @opindex fdump-rtl-eh
5896 Dump after finalization of EH handling code.
5898 @item -fdump-rtl-eh_ranges
5899 @opindex fdump-rtl-eh_ranges
5900 Dump after conversion of EH handling range regions.
5902 @item -fdump-rtl-expand
5903 @opindex fdump-rtl-expand
5904 Dump after RTL generation.
5906 @item -fdump-rtl-fwprop1
5907 @itemx -fdump-rtl-fwprop2
5908 @opindex fdump-rtl-fwprop1
5909 @opindex fdump-rtl-fwprop2
5910 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5911 dumping after the two forward propagation passes.
5913 @item -fdump-rtl-gcse1
5914 @itemx -fdump-rtl-gcse2
5915 @opindex fdump-rtl-gcse1
5916 @opindex fdump-rtl-gcse2
5917 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5918 after global common subexpression elimination.
5920 @item -fdump-rtl-init-regs
5921 @opindex fdump-rtl-init-regs
5922 Dump after the initialization of the registers.
5924 @item -fdump-rtl-initvals
5925 @opindex fdump-rtl-initvals
5926 Dump after the computation of the initial value sets.
5928 @item -fdump-rtl-into_cfglayout
5929 @opindex fdump-rtl-into_cfglayout
5930 Dump after converting to cfglayout mode.
5932 @item -fdump-rtl-ira
5933 @opindex fdump-rtl-ira
5934 Dump after iterated register allocation.
5936 @item -fdump-rtl-jump
5937 @opindex fdump-rtl-jump
5938 Dump after the second jump optimization.
5940 @item -fdump-rtl-loop2
5941 @opindex fdump-rtl-loop2
5942 @option{-fdump-rtl-loop2} enables dumping after the rtl
5943 loop optimization passes.
5945 @item -fdump-rtl-mach
5946 @opindex fdump-rtl-mach
5947 Dump after performing the machine dependent reorganization pass, if that
5948 pass exists.
5950 @item -fdump-rtl-mode_sw
5951 @opindex fdump-rtl-mode_sw
5952 Dump after removing redundant mode switches.
5954 @item -fdump-rtl-rnreg
5955 @opindex fdump-rtl-rnreg
5956 Dump after register renumbering.
5958 @item -fdump-rtl-outof_cfglayout
5959 @opindex fdump-rtl-outof_cfglayout
5960 Dump after converting from cfglayout mode.
5962 @item -fdump-rtl-peephole2
5963 @opindex fdump-rtl-peephole2
5964 Dump after the peephole pass.
5966 @item -fdump-rtl-postreload
5967 @opindex fdump-rtl-postreload
5968 Dump after post-reload optimizations.
5970 @item -fdump-rtl-pro_and_epilogue
5971 @opindex fdump-rtl-pro_and_epilogue
5972 Dump after generating the function prologues and epilogues.
5974 @item -fdump-rtl-sched1
5975 @itemx -fdump-rtl-sched2
5976 @opindex fdump-rtl-sched1
5977 @opindex fdump-rtl-sched2
5978 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5979 after the basic block scheduling passes.
5981 @item -fdump-rtl-ree
5982 @opindex fdump-rtl-ree
5983 Dump after sign/zero extension elimination.
5985 @item -fdump-rtl-seqabstr
5986 @opindex fdump-rtl-seqabstr
5987 Dump after common sequence discovery.
5989 @item -fdump-rtl-shorten
5990 @opindex fdump-rtl-shorten
5991 Dump after shortening branches.
5993 @item -fdump-rtl-sibling
5994 @opindex fdump-rtl-sibling
5995 Dump after sibling call optimizations.
5997 @item -fdump-rtl-split1
5998 @itemx -fdump-rtl-split2
5999 @itemx -fdump-rtl-split3
6000 @itemx -fdump-rtl-split4
6001 @itemx -fdump-rtl-split5
6002 @opindex fdump-rtl-split1
6003 @opindex fdump-rtl-split2
6004 @opindex fdump-rtl-split3
6005 @opindex fdump-rtl-split4
6006 @opindex fdump-rtl-split5
6007 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6008 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6009 @option{-fdump-rtl-split5} enable dumping after five rounds of
6010 instruction splitting.
6012 @item -fdump-rtl-sms
6013 @opindex fdump-rtl-sms
6014 Dump after modulo scheduling.  This pass is only run on some
6015 architectures.
6017 @item -fdump-rtl-stack
6018 @opindex fdump-rtl-stack
6019 Dump after conversion from GCC's ``flat register file'' registers to the
6020 x87's stack-like registers.  This pass is only run on x86 variants.
6022 @item -fdump-rtl-subreg1
6023 @itemx -fdump-rtl-subreg2
6024 @opindex fdump-rtl-subreg1
6025 @opindex fdump-rtl-subreg2
6026 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6027 the two subreg expansion passes.
6029 @item -fdump-rtl-unshare
6030 @opindex fdump-rtl-unshare
6031 Dump after all rtl has been unshared.
6033 @item -fdump-rtl-vartrack
6034 @opindex fdump-rtl-vartrack
6035 Dump after variable tracking.
6037 @item -fdump-rtl-vregs
6038 @opindex fdump-rtl-vregs
6039 Dump after converting virtual registers to hard registers.
6041 @item -fdump-rtl-web
6042 @opindex fdump-rtl-web
6043 Dump after live range splitting.
6045 @item -fdump-rtl-regclass
6046 @itemx -fdump-rtl-subregs_of_mode_init
6047 @itemx -fdump-rtl-subregs_of_mode_finish
6048 @itemx -fdump-rtl-dfinit
6049 @itemx -fdump-rtl-dfinish
6050 @opindex fdump-rtl-regclass
6051 @opindex fdump-rtl-subregs_of_mode_init
6052 @opindex fdump-rtl-subregs_of_mode_finish
6053 @opindex fdump-rtl-dfinit
6054 @opindex fdump-rtl-dfinish
6055 These dumps are defined but always produce empty files.
6057 @item -da
6058 @itemx -fdump-rtl-all
6059 @opindex da
6060 @opindex fdump-rtl-all
6061 Produce all the dumps listed above.
6063 @item -dA
6064 @opindex dA
6065 Annotate the assembler output with miscellaneous debugging information.
6067 @item -dD
6068 @opindex dD
6069 Dump all macro definitions, at the end of preprocessing, in addition to
6070 normal output.
6072 @item -dH
6073 @opindex dH
6074 Produce a core dump whenever an error occurs.
6076 @item -dp
6077 @opindex dp
6078 Annotate the assembler output with a comment indicating which
6079 pattern and alternative is used.  The length of each instruction is
6080 also printed.
6082 @item -dP
6083 @opindex dP
6084 Dump the RTL in the assembler output as a comment before each instruction.
6085 Also turns on @option{-dp} annotation.
6087 @item -dx
6088 @opindex dx
6089 Just generate RTL for a function instead of compiling it.  Usually used
6090 with @option{-fdump-rtl-expand}.
6091 @end table
6093 @item -fdump-noaddr
6094 @opindex fdump-noaddr
6095 When doing debugging dumps, suppress address output.  This makes it more
6096 feasible to use diff on debugging dumps for compiler invocations with
6097 different compiler binaries and/or different
6098 text / bss / data / heap / stack / dso start locations.
6100 @item -fdump-unnumbered
6101 @opindex fdump-unnumbered
6102 When doing debugging dumps, suppress instruction numbers and address output.
6103 This makes it more feasible to use diff on debugging dumps for compiler
6104 invocations with different options, in particular with and without
6105 @option{-g}.
6107 @item -fdump-unnumbered-links
6108 @opindex fdump-unnumbered-links
6109 When doing debugging dumps (see @option{-d} option above), suppress
6110 instruction numbers for the links to the previous and next instructions
6111 in a sequence.
6113 @item -fdump-translation-unit @r{(C++ only)}
6114 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6115 @opindex fdump-translation-unit
6116 Dump a representation of the tree structure for the entire translation
6117 unit to a file.  The file name is made by appending @file{.tu} to the
6118 source file name, and the file is created in the same directory as the
6119 output file.  If the @samp{-@var{options}} form is used, @var{options}
6120 controls the details of the dump as described for the
6121 @option{-fdump-tree} options.
6123 @item -fdump-class-hierarchy @r{(C++ only)}
6124 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6125 @opindex fdump-class-hierarchy
6126 Dump a representation of each class's hierarchy and virtual function
6127 table layout to a file.  The file name is made by appending
6128 @file{.class} to the source file name, and the file is created in the
6129 same directory as the output file.  If the @samp{-@var{options}} form
6130 is used, @var{options} controls the details of the dump as described
6131 for the @option{-fdump-tree} options.
6133 @item -fdump-ipa-@var{switch}
6134 @opindex fdump-ipa
6135 Control the dumping at various stages of inter-procedural analysis
6136 language tree to a file.  The file name is generated by appending a
6137 switch specific suffix to the source file name, and the file is created
6138 in the same directory as the output file.  The following dumps are
6139 possible:
6141 @table @samp
6142 @item all
6143 Enables all inter-procedural analysis dumps.
6145 @item cgraph
6146 Dumps information about call-graph optimization, unused function removal,
6147 and inlining decisions.
6149 @item inline
6150 Dump after function inlining.
6152 @end table
6154 @item -fdump-passes
6155 @opindex fdump-passes
6156 Dump the list of optimization passes that are turned on and off by
6157 the current command-line options.
6159 @item -fdump-statistics-@var{option}
6160 @opindex fdump-statistics
6161 Enable and control dumping of pass statistics in a separate file.  The
6162 file name is generated by appending a suffix ending in
6163 @samp{.statistics} to the source file name, and the file is created in
6164 the same directory as the output file.  If the @samp{-@var{option}}
6165 form is used, @samp{-stats} causes counters to be summed over the
6166 whole compilation unit while @samp{-details} dumps every event as
6167 the passes generate them.  The default with no option is to sum
6168 counters for each function compiled.
6170 @item -fdump-tree-@var{switch}
6171 @itemx -fdump-tree-@var{switch}-@var{options}
6172 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6173 @opindex fdump-tree
6174 Control the dumping at various stages of processing the intermediate
6175 language tree to a file.  The file name is generated by appending a
6176 switch-specific suffix to the source file name, and the file is
6177 created in the same directory as the output file. In case of
6178 @option{=@var{filename}} option, the dump is output on the given file
6179 instead of the auto named dump files.  If the @samp{-@var{options}}
6180 form is used, @var{options} is a list of @samp{-} separated options
6181 which control the details of the dump.  Not all options are applicable
6182 to all dumps; those that are not meaningful are ignored.  The
6183 following options are available
6185 @table @samp
6186 @item address
6187 Print the address of each node.  Usually this is not meaningful as it
6188 changes according to the environment and source file.  Its primary use
6189 is for tying up a dump file with a debug environment.
6190 @item asmname
6191 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6192 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6193 use working backward from mangled names in the assembly file.
6194 @item slim
6195 When dumping front-end intermediate representations, inhibit dumping
6196 of members of a scope or body of a function merely because that scope
6197 has been reached.  Only dump such items when they are directly reachable
6198 by some other path.
6200 When dumping pretty-printed trees, this option inhibits dumping the
6201 bodies of control structures.
6203 When dumping RTL, print the RTL in slim (condensed) form instead of
6204 the default LISP-like representation.
6205 @item raw
6206 Print a raw representation of the tree.  By default, trees are
6207 pretty-printed into a C-like representation.
6208 @item details
6209 Enable more detailed dumps (not honored by every dump option). Also
6210 include information from the optimization passes.
6211 @item stats
6212 Enable dumping various statistics about the pass (not honored by every dump
6213 option).
6214 @item blocks
6215 Enable showing basic block boundaries (disabled in raw dumps).
6216 @item graph
6217 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6218 dump a representation of the control flow graph suitable for viewing with
6219 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6220 the file is pretty-printed as a subgraph, so that GraphViz can render them
6221 all in a single plot.
6223 This option currently only works for RTL dumps, and the RTL is always
6224 dumped in slim form.
6225 @item vops
6226 Enable showing virtual operands for every statement.
6227 @item lineno
6228 Enable showing line numbers for statements.
6229 @item uid
6230 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6231 @item verbose
6232 Enable showing the tree dump for each statement.
6233 @item eh
6234 Enable showing the EH region number holding each statement.
6235 @item scev
6236 Enable showing scalar evolution analysis details.
6237 @item optimized
6238 Enable showing optimization information (only available in certain
6239 passes).
6240 @item missed
6241 Enable showing missed optimization information (only available in certain
6242 passes).
6243 @item notes
6244 Enable other detailed optimization information (only available in
6245 certain passes).
6246 @item =@var{filename}
6247 Instead of an auto named dump file, output into the given file
6248 name. The file names @file{stdout} and @file{stderr} are treated
6249 specially and are considered already open standard streams. For
6250 example,
6252 @smallexample
6253 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6254      -fdump-tree-pre=stderr file.c
6255 @end smallexample
6257 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6258 output on to @file{stderr}. If two conflicting dump filenames are
6259 given for the same pass, then the latter option overrides the earlier
6260 one.
6262 @item all
6263 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6264 and @option{lineno}.
6266 @item optall
6267 Turn on all optimization options, i.e., @option{optimized},
6268 @option{missed}, and @option{note}.
6269 @end table
6271 The following tree dumps are possible:
6272 @table @samp
6274 @item original
6275 @opindex fdump-tree-original
6276 Dump before any tree based optimization, to @file{@var{file}.original}.
6278 @item optimized
6279 @opindex fdump-tree-optimized
6280 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6282 @item gimple
6283 @opindex fdump-tree-gimple
6284 Dump each function before and after the gimplification pass to a file.  The
6285 file name is made by appending @file{.gimple} to the source file name.
6287 @item cfg
6288 @opindex fdump-tree-cfg
6289 Dump the control flow graph of each function to a file.  The file name is
6290 made by appending @file{.cfg} to the source file name.
6292 @item ch
6293 @opindex fdump-tree-ch
6294 Dump each function after copying loop headers.  The file name is made by
6295 appending @file{.ch} to the source file name.
6297 @item ssa
6298 @opindex fdump-tree-ssa
6299 Dump SSA related information to a file.  The file name is made by appending
6300 @file{.ssa} to the source file name.
6302 @item alias
6303 @opindex fdump-tree-alias
6304 Dump aliasing information for each function.  The file name is made by
6305 appending @file{.alias} to the source file name.
6307 @item ccp
6308 @opindex fdump-tree-ccp
6309 Dump each function after CCP@.  The file name is made by appending
6310 @file{.ccp} to the source file name.
6312 @item storeccp
6313 @opindex fdump-tree-storeccp
6314 Dump each function after STORE-CCP@.  The file name is made by appending
6315 @file{.storeccp} to the source file name.
6317 @item pre
6318 @opindex fdump-tree-pre
6319 Dump trees after partial redundancy elimination.  The file name is made
6320 by appending @file{.pre} to the source file name.
6322 @item fre
6323 @opindex fdump-tree-fre
6324 Dump trees after full redundancy elimination.  The file name is made
6325 by appending @file{.fre} to the source file name.
6327 @item copyprop
6328 @opindex fdump-tree-copyprop
6329 Dump trees after copy propagation.  The file name is made
6330 by appending @file{.copyprop} to the source file name.
6332 @item store_copyprop
6333 @opindex fdump-tree-store_copyprop
6334 Dump trees after store copy-propagation.  The file name is made
6335 by appending @file{.store_copyprop} to the source file name.
6337 @item dce
6338 @opindex fdump-tree-dce
6339 Dump each function after dead code elimination.  The file name is made by
6340 appending @file{.dce} to the source file name.
6342 @item sra
6343 @opindex fdump-tree-sra
6344 Dump each function after performing scalar replacement of aggregates.  The
6345 file name is made by appending @file{.sra} to the source file name.
6347 @item sink
6348 @opindex fdump-tree-sink
6349 Dump each function after performing code sinking.  The file name is made
6350 by appending @file{.sink} to the source file name.
6352 @item dom
6353 @opindex fdump-tree-dom
6354 Dump each function after applying dominator tree optimizations.  The file
6355 name is made by appending @file{.dom} to the source file name.
6357 @item dse
6358 @opindex fdump-tree-dse
6359 Dump each function after applying dead store elimination.  The file
6360 name is made by appending @file{.dse} to the source file name.
6362 @item phiopt
6363 @opindex fdump-tree-phiopt
6364 Dump each function after optimizing PHI nodes into straightline code.  The file
6365 name is made by appending @file{.phiopt} to the source file name.
6367 @item forwprop
6368 @opindex fdump-tree-forwprop
6369 Dump each function after forward propagating single use variables.  The file
6370 name is made by appending @file{.forwprop} to the source file name.
6372 @item copyrename
6373 @opindex fdump-tree-copyrename
6374 Dump each function after applying the copy rename optimization.  The file
6375 name is made by appending @file{.copyrename} to the source file name.
6377 @item nrv
6378 @opindex fdump-tree-nrv
6379 Dump each function after applying the named return value optimization on
6380 generic trees.  The file name is made by appending @file{.nrv} to the source
6381 file name.
6383 @item vect
6384 @opindex fdump-tree-vect
6385 Dump each function after applying vectorization of loops.  The file name is
6386 made by appending @file{.vect} to the source file name.
6388 @item slp
6389 @opindex fdump-tree-slp
6390 Dump each function after applying vectorization of basic blocks.  The file name
6391 is made by appending @file{.slp} to the source file name.
6393 @item vrp
6394 @opindex fdump-tree-vrp
6395 Dump each function after Value Range Propagation (VRP).  The file name
6396 is made by appending @file{.vrp} to the source file name.
6398 @item all
6399 @opindex fdump-tree-all
6400 Enable all the available tree dumps with the flags provided in this option.
6401 @end table
6403 @item -fopt-info
6404 @itemx -fopt-info-@var{options}
6405 @itemx -fopt-info-@var{options}=@var{filename}
6406 @opindex fopt-info
6407 Controls optimization dumps from various optimization passes. If the
6408 @samp{-@var{options}} form is used, @var{options} is a list of
6409 @samp{-} separated options to select the dump details and
6410 optimizations.  If @var{options} is not specified, it defaults to
6411 @option{optimized} for details and @option{optall} for optimization
6412 groups. If the @var{filename} is not specified, it defaults to
6413 @file{stderr}. Note that the output @var{filename} will be overwritten
6414 in case of multiple translation units. If a combined output from
6415 multiple translation units is desired, @file{stderr} should be used
6416 instead.
6418 The options can be divided into two groups, 1) options describing the
6419 verbosity of the dump, and 2) options describing which optimizations
6420 should be included. The options from both the groups can be freely
6421 mixed as they are non-overlapping. However, in case of any conflicts,
6422 the latter options override the earlier options on the command
6423 line. Though multiple -fopt-info options are accepted, only one of
6424 them can have @option{=filename}. If other filenames are provided then
6425 all but the first one are ignored.
6427 The dump verbosity has the following options
6429 @table @samp
6430 @item optimized
6431 Print information when an optimization is successfully applied. It is
6432 up to a pass to decide which information is relevant. For example, the
6433 vectorizer passes print the source location of loops which got
6434 successfully vectorized.
6435 @item missed
6436 Print information about missed optimizations. Individual passes
6437 control which information to include in the output. For example,
6439 @smallexample
6440 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6441 @end smallexample
6443 will print information about missed optimization opportunities from
6444 vectorization passes on stderr.
6445 @item note
6446 Print verbose information about optimizations, such as certain
6447 transformations, more detailed messages about decisions etc.
6448 @item all
6449 Print detailed optimization information. This includes
6450 @var{optimized}, @var{missed}, and @var{note}.
6451 @end table
6453 The second set of options describes a group of optimizations and may
6454 include one or more of the following.
6456 @table @samp
6457 @item ipa
6458 Enable dumps from all interprocedural optimizations.
6459 @item loop
6460 Enable dumps from all loop optimizations.
6461 @item inline
6462 Enable dumps from all inlining optimizations.
6463 @item vec
6464 Enable dumps from all vectorization optimizations.
6465 @item optall
6466 Enable dumps from all optimizations. This is a superset of
6467 the optimization groups listed above.
6468 @end table
6470 For example,
6471 @smallexample
6472 gcc -O3 -fopt-info-missed=missed.all
6473 @end smallexample
6475 outputs missed optimization report from all the passes into
6476 @file{missed.all}.
6478 As another example,
6479 @smallexample
6480 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6481 @end smallexample
6483 will output information about missed optimizations as well as
6484 optimized locations from all the inlining passes into
6485 @file{inline.txt}.
6487 If the @var{filename} is provided, then the dumps from all the
6488 applicable optimizations are concatenated into the @file{filename}.
6489 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6490 omitted, it defaults to @option{all-optall}, which means dump all
6491 available optimization info from all the passes. In the following
6492 example, all optimization info is output on to @file{stderr}.
6494 @smallexample
6495 gcc -O3 -fopt-info
6496 @end smallexample
6498 Note that @option{-fopt-info-vec-missed} behaves the same as
6499 @option{-fopt-info-missed-vec}.
6501 As another example, consider
6503 @smallexample
6504 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6505 @end smallexample
6507 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6508 in conflict since only one output file is allowed. In this case, only
6509 the first option takes effect and the subsequent options are
6510 ignored. Thus only the @file{vec.miss} is produced which contains
6511 dumps from the vectorizer about missed opportunities.
6513 @item -frandom-seed=@var{string}
6514 @opindex frandom-seed
6515 This option provides a seed that GCC uses in place of
6516 random numbers in generating certain symbol names
6517 that have to be different in every compiled file.  It is also used to
6518 place unique stamps in coverage data files and the object files that
6519 produce them.  You can use the @option{-frandom-seed} option to produce
6520 reproducibly identical object files.
6522 The @var{string} should be different for every file you compile.
6524 @item -fsched-verbose=@var{n}
6525 @opindex fsched-verbose
6526 On targets that use instruction scheduling, this option controls the
6527 amount of debugging output the scheduler prints.  This information is
6528 written to standard error, unless @option{-fdump-rtl-sched1} or
6529 @option{-fdump-rtl-sched2} is specified, in which case it is output
6530 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6531 respectively.  However for @var{n} greater than nine, the output is
6532 always printed to standard error.
6534 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6535 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6536 For @var{n} greater than one, it also output basic block probabilities,
6537 detailed ready list information and unit/insn info.  For @var{n} greater
6538 than two, it includes RTL at abort point, control-flow and regions info.
6539 And for @var{n} over four, @option{-fsched-verbose} also includes
6540 dependence info.
6542 @item -save-temps
6543 @itemx -save-temps=cwd
6544 @opindex save-temps
6545 Store the usual ``temporary'' intermediate files permanently; place them
6546 in the current directory and name them based on the source file.  Thus,
6547 compiling @file{foo.c} with @option{-c -save-temps} produces files
6548 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6549 preprocessed @file{foo.i} output file even though the compiler now
6550 normally uses an integrated preprocessor.
6552 When used in combination with the @option{-x} command-line option,
6553 @option{-save-temps} is sensible enough to avoid over writing an
6554 input source file with the same extension as an intermediate file.
6555 The corresponding intermediate file may be obtained by renaming the
6556 source file before using @option{-save-temps}.
6558 If you invoke GCC in parallel, compiling several different source
6559 files that share a common base name in different subdirectories or the
6560 same source file compiled for multiple output destinations, it is
6561 likely that the different parallel compilers will interfere with each
6562 other, and overwrite the temporary files.  For instance:
6564 @smallexample
6565 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6566 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6567 @end smallexample
6569 may result in @file{foo.i} and @file{foo.o} being written to
6570 simultaneously by both compilers.
6572 @item -save-temps=obj
6573 @opindex save-temps=obj
6574 Store the usual ``temporary'' intermediate files permanently.  If the
6575 @option{-o} option is used, the temporary files are based on the
6576 object file.  If the @option{-o} option is not used, the
6577 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6579 For example:
6581 @smallexample
6582 gcc -save-temps=obj -c foo.c
6583 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6584 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6585 @end smallexample
6587 @noindent
6588 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6589 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6590 @file{dir2/yfoobar.o}.
6592 @item -time@r{[}=@var{file}@r{]}
6593 @opindex time
6594 Report the CPU time taken by each subprocess in the compilation
6595 sequence.  For C source files, this is the compiler proper and assembler
6596 (plus the linker if linking is done).
6598 Without the specification of an output file, the output looks like this:
6600 @smallexample
6601 # cc1 0.12 0.01
6602 # as 0.00 0.01
6603 @end smallexample
6605 The first number on each line is the ``user time'', that is time spent
6606 executing the program itself.  The second number is ``system time'',
6607 time spent executing operating system routines on behalf of the program.
6608 Both numbers are in seconds.
6610 With the specification of an output file, the output is appended to the
6611 named file, and it looks like this:
6613 @smallexample
6614 0.12 0.01 cc1 @var{options}
6615 0.00 0.01 as @var{options}
6616 @end smallexample
6618 The ``user time'' and the ``system time'' are moved before the program
6619 name, and the options passed to the program are displayed, so that one
6620 can later tell what file was being compiled, and with which options.
6622 @item -fvar-tracking
6623 @opindex fvar-tracking
6624 Run variable tracking pass.  It computes where variables are stored at each
6625 position in code.  Better debugging information is then generated
6626 (if the debugging information format supports this information).
6628 It is enabled by default when compiling with optimization (@option{-Os},
6629 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6630 the debug info format supports it.
6632 @item -fvar-tracking-assignments
6633 @opindex fvar-tracking-assignments
6634 @opindex fno-var-tracking-assignments
6635 Annotate assignments to user variables early in the compilation and
6636 attempt to carry the annotations over throughout the compilation all the
6637 way to the end, in an attempt to improve debug information while
6638 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6640 It can be enabled even if var-tracking is disabled, in which case
6641 annotations are created and maintained, but discarded at the end.
6643 @item -fvar-tracking-assignments-toggle
6644 @opindex fvar-tracking-assignments-toggle
6645 @opindex fno-var-tracking-assignments-toggle
6646 Toggle @option{-fvar-tracking-assignments}, in the same way that
6647 @option{-gtoggle} toggles @option{-g}.
6649 @item -print-file-name=@var{library}
6650 @opindex print-file-name
6651 Print the full absolute name of the library file @var{library} that
6652 would be used when linking---and don't do anything else.  With this
6653 option, GCC does not compile or link anything; it just prints the
6654 file name.
6656 @item -print-multi-directory
6657 @opindex print-multi-directory
6658 Print the directory name corresponding to the multilib selected by any
6659 other switches present in the command line.  This directory is supposed
6660 to exist in @env{GCC_EXEC_PREFIX}.
6662 @item -print-multi-lib
6663 @opindex print-multi-lib
6664 Print the mapping from multilib directory names to compiler switches
6665 that enable them.  The directory name is separated from the switches by
6666 @samp{;}, and each switch starts with an @samp{@@} instead of the
6667 @samp{-}, without spaces between multiple switches.  This is supposed to
6668 ease shell processing.
6670 @item -print-multi-os-directory
6671 @opindex print-multi-os-directory
6672 Print the path to OS libraries for the selected
6673 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6674 present in the @file{lib} subdirectory and no multilibs are used, this is
6675 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6676 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6677 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6678 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6680 @item -print-multiarch
6681 @opindex print-multiarch
6682 Print the path to OS libraries for the selected multiarch,
6683 relative to some @file{lib} subdirectory.
6685 @item -print-prog-name=@var{program}
6686 @opindex print-prog-name
6687 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6689 @item -print-libgcc-file-name
6690 @opindex print-libgcc-file-name
6691 Same as @option{-print-file-name=libgcc.a}.
6693 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6694 but you do want to link with @file{libgcc.a}.  You can do:
6696 @smallexample
6697 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6698 @end smallexample
6700 @item -print-search-dirs
6701 @opindex print-search-dirs
6702 Print the name of the configured installation directory and a list of
6703 program and library directories @command{gcc} searches---and don't do anything else.
6705 This is useful when @command{gcc} prints the error message
6706 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6707 To resolve this you either need to put @file{cpp0} and the other compiler
6708 components where @command{gcc} expects to find them, or you can set the environment
6709 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6710 Don't forget the trailing @samp{/}.
6711 @xref{Environment Variables}.
6713 @item -print-sysroot
6714 @opindex print-sysroot
6715 Print the target sysroot directory that is used during
6716 compilation.  This is the target sysroot specified either at configure
6717 time or using the @option{--sysroot} option, possibly with an extra
6718 suffix that depends on compilation options.  If no target sysroot is
6719 specified, the option prints nothing.
6721 @item -print-sysroot-headers-suffix
6722 @opindex print-sysroot-headers-suffix
6723 Print the suffix added to the target sysroot when searching for
6724 headers, or give an error if the compiler is not configured with such
6725 a suffix---and don't do anything else.
6727 @item -dumpmachine
6728 @opindex dumpmachine
6729 Print the compiler's target machine (for example,
6730 @samp{i686-pc-linux-gnu})---and don't do anything else.
6732 @item -dumpversion
6733 @opindex dumpversion
6734 Print the compiler version (for example, @samp{3.0})---and don't do
6735 anything else.
6737 @item -dumpspecs
6738 @opindex dumpspecs
6739 Print the compiler's built-in specs---and don't do anything else.  (This
6740 is used when GCC itself is being built.)  @xref{Spec Files}.
6742 @item -fno-eliminate-unused-debug-types
6743 @opindex feliminate-unused-debug-types
6744 @opindex fno-eliminate-unused-debug-types
6745 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6746 output for types that are nowhere used in the source file being compiled.
6747 Sometimes it is useful to have GCC emit debugging
6748 information for all types declared in a compilation
6749 unit, regardless of whether or not they are actually used
6750 in that compilation unit, for example 
6751 if, in the debugger, you want to cast a value to a type that is
6752 not actually used in your program (but is declared).  More often,
6753 however, this results in a significant amount of wasted space.
6754 @end table
6756 @node Optimize Options
6757 @section Options That Control Optimization
6758 @cindex optimize options
6759 @cindex options, optimization
6761 These options control various sorts of optimizations.
6763 Without any optimization option, the compiler's goal is to reduce the
6764 cost of compilation and to make debugging produce the expected
6765 results.  Statements are independent: if you stop the program with a
6766 breakpoint between statements, you can then assign a new value to any
6767 variable or change the program counter to any other statement in the
6768 function and get exactly the results you expect from the source
6769 code.
6771 Turning on optimization flags makes the compiler attempt to improve
6772 the performance and/or code size at the expense of compilation time
6773 and possibly the ability to debug the program.
6775 The compiler performs optimization based on the knowledge it has of the
6776 program.  Compiling multiple files at once to a single output file mode allows
6777 the compiler to use information gained from all of the files when compiling
6778 each of them.
6780 Not all optimizations are controlled directly by a flag.  Only
6781 optimizations that have a flag are listed in this section.
6783 Most optimizations are only enabled if an @option{-O} level is set on
6784 the command line.  Otherwise they are disabled, even if individual
6785 optimization flags are specified.
6787 Depending on the target and how GCC was configured, a slightly different
6788 set of optimizations may be enabled at each @option{-O} level than
6789 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6790 to find out the exact set of optimizations that are enabled at each level.
6791 @xref{Overall Options}, for examples.
6793 @table @gcctabopt
6794 @item -O
6795 @itemx -O1
6796 @opindex O
6797 @opindex O1
6798 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6799 more memory for a large function.
6801 With @option{-O}, the compiler tries to reduce code size and execution
6802 time, without performing any optimizations that take a great deal of
6803 compilation time.
6805 @option{-O} turns on the following optimization flags:
6806 @gccoptlist{
6807 -fauto-inc-dec @gol
6808 -fcompare-elim @gol
6809 -fcprop-registers @gol
6810 -fdce @gol
6811 -fdefer-pop @gol
6812 -fdelayed-branch @gol
6813 -fdse @gol
6814 -fguess-branch-probability @gol
6815 -fif-conversion2 @gol
6816 -fif-conversion @gol
6817 -fipa-pure-const @gol
6818 -fipa-profile @gol
6819 -fipa-reference @gol
6820 -fmerge-constants
6821 -fsplit-wide-types @gol
6822 -ftree-bit-ccp @gol
6823 -ftree-builtin-call-dce @gol
6824 -ftree-ccp @gol
6825 -ftree-ch @gol
6826 -ftree-copyrename @gol
6827 -ftree-dce @gol
6828 -ftree-dominator-opts @gol
6829 -ftree-dse @gol
6830 -ftree-forwprop @gol
6831 -ftree-fre @gol
6832 -ftree-phiprop @gol
6833 -ftree-slsr @gol
6834 -ftree-sra @gol
6835 -ftree-pta @gol
6836 -ftree-ter @gol
6837 -funit-at-a-time}
6839 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6840 where doing so does not interfere with debugging.
6842 @item -O2
6843 @opindex O2
6844 Optimize even more.  GCC performs nearly all supported optimizations
6845 that do not involve a space-speed tradeoff.
6846 As compared to @option{-O}, this option increases both compilation time
6847 and the performance of the generated code.
6849 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6850 also turns on the following optimization flags:
6851 @gccoptlist{-fthread-jumps @gol
6852 -falign-functions  -falign-jumps @gol
6853 -falign-loops  -falign-labels @gol
6854 -fcaller-saves @gol
6855 -fcrossjumping @gol
6856 -fcse-follow-jumps  -fcse-skip-blocks @gol
6857 -fdelete-null-pointer-checks @gol
6858 -fdevirtualize -fdevirtualize-speculatively @gol
6859 -fexpensive-optimizations @gol
6860 -fgcse  -fgcse-lm  @gol
6861 -fhoist-adjacent-loads @gol
6862 -finline-small-functions @gol
6863 -findirect-inlining @gol
6864 -fipa-sra @gol
6865 -fisolate-erroneous-paths-dereference @gol
6866 -foptimize-sibling-calls @gol
6867 -fpartial-inlining @gol
6868 -fpeephole2 @gol
6869 -freorder-blocks  -freorder-functions @gol
6870 -frerun-cse-after-loop  @gol
6871 -fsched-interblock  -fsched-spec @gol
6872 -fschedule-insns  -fschedule-insns2 @gol
6873 -fstrict-aliasing -fstrict-overflow @gol
6874 -ftree-switch-conversion -ftree-tail-merge @gol
6875 -ftree-pre @gol
6876 -ftree-vrp}
6878 Please note the warning under @option{-fgcse} about
6879 invoking @option{-O2} on programs that use computed gotos.
6881 @item -O3
6882 @opindex O3
6883 Optimize yet more.  @option{-O3} turns on all optimizations specified
6884 by @option{-O2} and also turns on the @option{-finline-functions},
6885 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6886 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
6887 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
6888 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6890 @item -O0
6891 @opindex O0
6892 Reduce compilation time and make debugging produce the expected
6893 results.  This is the default.
6895 @item -Os
6896 @opindex Os
6897 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6898 do not typically increase code size.  It also performs further
6899 optimizations designed to reduce code size.
6901 @option{-Os} disables the following optimization flags:
6902 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6903 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6904 -fprefetch-loop-arrays}
6906 @item -Ofast
6907 @opindex Ofast
6908 Disregard strict standards compliance.  @option{-Ofast} enables all
6909 @option{-O3} optimizations.  It also enables optimizations that are not
6910 valid for all standard-compliant programs.
6911 It turns on @option{-ffast-math} and the Fortran-specific
6912 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6914 @item -Og
6915 @opindex Og
6916 Optimize debugging experience.  @option{-Og} enables optimizations
6917 that do not interfere with debugging. It should be the optimization
6918 level of choice for the standard edit-compile-debug cycle, offering
6919 a reasonable level of optimization while maintaining fast compilation
6920 and a good debugging experience.
6922 If you use multiple @option{-O} options, with or without level numbers,
6923 the last such option is the one that is effective.
6924 @end table
6926 Options of the form @option{-f@var{flag}} specify machine-independent
6927 flags.  Most flags have both positive and negative forms; the negative
6928 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6929 below, only one of the forms is listed---the one you typically 
6930 use.  You can figure out the other form by either removing @samp{no-}
6931 or adding it.
6933 The following options control specific optimizations.  They are either
6934 activated by @option{-O} options or are related to ones that are.  You
6935 can use the following flags in the rare cases when ``fine-tuning'' of
6936 optimizations to be performed is desired.
6938 @table @gcctabopt
6939 @item -fno-defer-pop
6940 @opindex fno-defer-pop
6941 Always pop the arguments to each function call as soon as that function
6942 returns.  For machines that must pop arguments after a function call,
6943 the compiler normally lets arguments accumulate on the stack for several
6944 function calls and pops them all at once.
6946 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6948 @item -fforward-propagate
6949 @opindex fforward-propagate
6950 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6951 instructions and checks if the result can be simplified.  If loop unrolling
6952 is active, two passes are performed and the second is scheduled after
6953 loop unrolling.
6955 This option is enabled by default at optimization levels @option{-O},
6956 @option{-O2}, @option{-O3}, @option{-Os}.
6958 @item -ffp-contract=@var{style}
6959 @opindex ffp-contract
6960 @option{-ffp-contract=off} disables floating-point expression contraction.
6961 @option{-ffp-contract=fast} enables floating-point expression contraction
6962 such as forming of fused multiply-add operations if the target has
6963 native support for them.
6964 @option{-ffp-contract=on} enables floating-point expression contraction
6965 if allowed by the language standard.  This is currently not implemented
6966 and treated equal to @option{-ffp-contract=off}.
6968 The default is @option{-ffp-contract=fast}.
6970 @item -fomit-frame-pointer
6971 @opindex fomit-frame-pointer
6972 Don't keep the frame pointer in a register for functions that
6973 don't need one.  This avoids the instructions to save, set up and
6974 restore frame pointers; it also makes an extra register available
6975 in many functions.  @strong{It also makes debugging impossible on
6976 some machines.}
6978 On some machines, such as the VAX, this flag has no effect, because
6979 the standard calling sequence automatically handles the frame pointer
6980 and nothing is saved by pretending it doesn't exist.  The
6981 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6982 whether a target machine supports this flag.  @xref{Registers,,Register
6983 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6985 Starting with GCC version 4.6, the default setting (when not optimizing for
6986 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6987 @option{-fomit-frame-pointer}.  The default can be reverted to
6988 @option{-fno-omit-frame-pointer} by configuring GCC with the
6989 @option{--enable-frame-pointer} configure option.
6991 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6993 @item -foptimize-sibling-calls
6994 @opindex foptimize-sibling-calls
6995 Optimize sibling and tail recursive calls.
6997 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6999 @item -fno-inline
7000 @opindex fno-inline
7001 Do not expand any functions inline apart from those marked with
7002 the @code{always_inline} attribute.  This is the default when not
7003 optimizing.
7005 Single functions can be exempted from inlining by marking them
7006 with the @code{noinline} attribute.
7008 @item -finline-small-functions
7009 @opindex finline-small-functions
7010 Integrate functions into their callers when their body is smaller than expected
7011 function call code (so overall size of program gets smaller).  The compiler
7012 heuristically decides which functions are simple enough to be worth integrating
7013 in this way.  This inlining applies to all functions, even those not declared
7014 inline.
7016 Enabled at level @option{-O2}.
7018 @item -findirect-inlining
7019 @opindex findirect-inlining
7020 Inline also indirect calls that are discovered to be known at compile
7021 time thanks to previous inlining.  This option has any effect only
7022 when inlining itself is turned on by the @option{-finline-functions}
7023 or @option{-finline-small-functions} options.
7025 Enabled at level @option{-O2}.
7027 @item -finline-functions
7028 @opindex finline-functions
7029 Consider all functions for inlining, even if they are not declared inline.
7030 The compiler heuristically decides which functions are worth integrating
7031 in this way.
7033 If all calls to a given function are integrated, and the function is
7034 declared @code{static}, then the function is normally not output as
7035 assembler code in its own right.
7037 Enabled at level @option{-O3}.
7039 @item -finline-functions-called-once
7040 @opindex finline-functions-called-once
7041 Consider all @code{static} functions called once for inlining into their
7042 caller even if they are not marked @code{inline}.  If a call to a given
7043 function is integrated, then the function is not output as assembler code
7044 in its own right.
7046 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7048 @item -fearly-inlining
7049 @opindex fearly-inlining
7050 Inline functions marked by @code{always_inline} and functions whose body seems
7051 smaller than the function call overhead early before doing
7052 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7053 makes profiling significantly cheaper and usually inlining faster on programs
7054 having large chains of nested wrapper functions.
7056 Enabled by default.
7058 @item -fipa-sra
7059 @opindex fipa-sra
7060 Perform interprocedural scalar replacement of aggregates, removal of
7061 unused parameters and replacement of parameters passed by reference
7062 by parameters passed by value.
7064 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7066 @item -finline-limit=@var{n}
7067 @opindex finline-limit
7068 By default, GCC limits the size of functions that can be inlined.  This flag
7069 allows coarse control of this limit.  @var{n} is the size of functions that
7070 can be inlined in number of pseudo instructions.
7072 Inlining is actually controlled by a number of parameters, which may be
7073 specified individually by using @option{--param @var{name}=@var{value}}.
7074 The @option{-finline-limit=@var{n}} option sets some of these parameters
7075 as follows:
7077 @table @gcctabopt
7078 @item max-inline-insns-single
7079 is set to @var{n}/2.
7080 @item max-inline-insns-auto
7081 is set to @var{n}/2.
7082 @end table
7084 See below for a documentation of the individual
7085 parameters controlling inlining and for the defaults of these parameters.
7087 @emph{Note:} there may be no value to @option{-finline-limit} that results
7088 in default behavior.
7090 @emph{Note:} pseudo instruction represents, in this particular context, an
7091 abstract measurement of function's size.  In no way does it represent a count
7092 of assembly instructions and as such its exact meaning might change from one
7093 release to an another.
7095 @item -fno-keep-inline-dllexport
7096 @opindex -fno-keep-inline-dllexport
7097 This is a more fine-grained version of @option{-fkeep-inline-functions},
7098 which applies only to functions that are declared using the @code{dllexport}
7099 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7100 Functions}.)
7102 @item -fkeep-inline-functions
7103 @opindex fkeep-inline-functions
7104 In C, emit @code{static} functions that are declared @code{inline}
7105 into the object file, even if the function has been inlined into all
7106 of its callers.  This switch does not affect functions using the
7107 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7108 inline functions into the object file.
7110 @item -fkeep-static-consts
7111 @opindex fkeep-static-consts
7112 Emit variables declared @code{static const} when optimization isn't turned
7113 on, even if the variables aren't referenced.
7115 GCC enables this option by default.  If you want to force the compiler to
7116 check if a variable is referenced, regardless of whether or not
7117 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7119 @item -fmerge-constants
7120 @opindex fmerge-constants
7121 Attempt to merge identical constants (string constants and floating-point
7122 constants) across compilation units.
7124 This option is the default for optimized compilation if the assembler and
7125 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7126 behavior.
7128 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7130 @item -fmerge-all-constants
7131 @opindex fmerge-all-constants
7132 Attempt to merge identical constants and identical variables.
7134 This option implies @option{-fmerge-constants}.  In addition to
7135 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7136 arrays or initialized constant variables with integral or floating-point
7137 types.  Languages like C or C++ require each variable, including multiple
7138 instances of the same variable in recursive calls, to have distinct locations,
7139 so using this option results in non-conforming
7140 behavior.
7142 @item -fmodulo-sched
7143 @opindex fmodulo-sched
7144 Perform swing modulo scheduling immediately before the first scheduling
7145 pass.  This pass looks at innermost loops and reorders their
7146 instructions by overlapping different iterations.
7148 @item -fmodulo-sched-allow-regmoves
7149 @opindex fmodulo-sched-allow-regmoves
7150 Perform more aggressive SMS-based modulo scheduling with register moves
7151 allowed.  By setting this flag certain anti-dependences edges are
7152 deleted, which triggers the generation of reg-moves based on the
7153 life-range analysis.  This option is effective only with
7154 @option{-fmodulo-sched} enabled.
7156 @item -fno-branch-count-reg
7157 @opindex fno-branch-count-reg
7158 Do not use ``decrement and branch'' instructions on a count register,
7159 but instead generate a sequence of instructions that decrement a
7160 register, compare it against zero, then branch based upon the result.
7161 This option is only meaningful on architectures that support such
7162 instructions, which include x86, PowerPC, IA-64 and S/390.
7164 The default is @option{-fbranch-count-reg}.
7166 @item -fno-function-cse
7167 @opindex fno-function-cse
7168 Do not put function addresses in registers; make each instruction that
7169 calls a constant function contain the function's address explicitly.
7171 This option results in less efficient code, but some strange hacks
7172 that alter the assembler output may be confused by the optimizations
7173 performed when this option is not used.
7175 The default is @option{-ffunction-cse}
7177 @item -fno-zero-initialized-in-bss
7178 @opindex fno-zero-initialized-in-bss
7179 If the target supports a BSS section, GCC by default puts variables that
7180 are initialized to zero into BSS@.  This can save space in the resulting
7181 code.
7183 This option turns off this behavior because some programs explicitly
7184 rely on variables going to the data section---e.g., so that the
7185 resulting executable can find the beginning of that section and/or make
7186 assumptions based on that.
7188 The default is @option{-fzero-initialized-in-bss}.
7190 @item -fthread-jumps
7191 @opindex fthread-jumps
7192 Perform optimizations that check to see if a jump branches to a
7193 location where another comparison subsumed by the first is found.  If
7194 so, the first branch is redirected to either the destination of the
7195 second branch or a point immediately following it, depending on whether
7196 the condition is known to be true or false.
7198 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7200 @item -fsplit-wide-types
7201 @opindex fsplit-wide-types
7202 When using a type that occupies multiple registers, such as @code{long
7203 long} on a 32-bit system, split the registers apart and allocate them
7204 independently.  This normally generates better code for those types,
7205 but may make debugging more difficult.
7207 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7208 @option{-Os}.
7210 @item -fcse-follow-jumps
7211 @opindex fcse-follow-jumps
7212 In common subexpression elimination (CSE), scan through jump instructions
7213 when the target of the jump is not reached by any other path.  For
7214 example, when CSE encounters an @code{if} statement with an
7215 @code{else} clause, CSE follows the jump when the condition
7216 tested is false.
7218 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7220 @item -fcse-skip-blocks
7221 @opindex fcse-skip-blocks
7222 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7223 follow jumps that conditionally skip over blocks.  When CSE
7224 encounters a simple @code{if} statement with no else clause,
7225 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7226 body of the @code{if}.
7228 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7230 @item -frerun-cse-after-loop
7231 @opindex frerun-cse-after-loop
7232 Re-run common subexpression elimination after loop optimizations are
7233 performed.
7235 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7237 @item -fgcse
7238 @opindex fgcse
7239 Perform a global common subexpression elimination pass.
7240 This pass also performs global constant and copy propagation.
7242 @emph{Note:} When compiling a program using computed gotos, a GCC
7243 extension, you may get better run-time performance if you disable
7244 the global common subexpression elimination pass by adding
7245 @option{-fno-gcse} to the command line.
7247 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7249 @item -fgcse-lm
7250 @opindex fgcse-lm
7251 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7252 attempts to move loads that are only killed by stores into themselves.  This
7253 allows a loop containing a load/store sequence to be changed to a load outside
7254 the loop, and a copy/store within the loop.
7256 Enabled by default when @option{-fgcse} is enabled.
7258 @item -fgcse-sm
7259 @opindex fgcse-sm
7260 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7261 global common subexpression elimination.  This pass attempts to move
7262 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7263 loops containing a load/store sequence can be changed to a load before
7264 the loop and a store after the loop.
7266 Not enabled at any optimization level.
7268 @item -fgcse-las
7269 @opindex fgcse-las
7270 When @option{-fgcse-las} is enabled, the global common subexpression
7271 elimination pass eliminates redundant loads that come after stores to the
7272 same memory location (both partial and full redundancies).
7274 Not enabled at any optimization level.
7276 @item -fgcse-after-reload
7277 @opindex fgcse-after-reload
7278 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7279 pass is performed after reload.  The purpose of this pass is to clean up
7280 redundant spilling.
7282 @item -faggressive-loop-optimizations
7283 @opindex faggressive-loop-optimizations
7284 This option tells the loop optimizer to use language constraints to
7285 derive bounds for the number of iterations of a loop.  This assumes that
7286 loop code does not invoke undefined behavior by for example causing signed
7287 integer overflows or out-of-bound array accesses.  The bounds for the
7288 number of iterations of a loop are used to guide loop unrolling and peeling
7289 and loop exit test optimizations.
7290 This option is enabled by default.
7292 @item -funsafe-loop-optimizations
7293 @opindex funsafe-loop-optimizations
7294 This option tells the loop optimizer to assume that loop indices do not
7295 overflow, and that loops with nontrivial exit condition are not
7296 infinite.  This enables a wider range of loop optimizations even if
7297 the loop optimizer itself cannot prove that these assumptions are valid.
7298 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7299 if it finds this kind of loop.
7301 @item -fcrossjumping
7302 @opindex fcrossjumping
7303 Perform cross-jumping transformation.
7304 This transformation unifies equivalent code and saves code size.  The
7305 resulting code may or may not perform better than without cross-jumping.
7307 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7309 @item -fauto-inc-dec
7310 @opindex fauto-inc-dec
7311 Combine increments or decrements of addresses with memory accesses.
7312 This pass is always skipped on architectures that do not have
7313 instructions to support this.  Enabled by default at @option{-O} and
7314 higher on architectures that support this.
7316 @item -fdce
7317 @opindex fdce
7318 Perform dead code elimination (DCE) on RTL@.
7319 Enabled by default at @option{-O} and higher.
7321 @item -fdse
7322 @opindex fdse
7323 Perform dead store elimination (DSE) on RTL@.
7324 Enabled by default at @option{-O} and higher.
7326 @item -fif-conversion
7327 @opindex fif-conversion
7328 Attempt to transform conditional jumps into branch-less equivalents.  This
7329 includes use of conditional moves, min, max, set flags and abs instructions, and
7330 some tricks doable by standard arithmetics.  The use of conditional execution
7331 on chips where it is available is controlled by @code{if-conversion2}.
7333 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7335 @item -fif-conversion2
7336 @opindex fif-conversion2
7337 Use conditional execution (where available) to transform conditional jumps into
7338 branch-less equivalents.
7340 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7342 @item -fdeclone-ctor-dtor
7343 @opindex fdeclone-ctor-dtor
7344 The C++ ABI requires multiple entry points for constructors and
7345 destructors: one for a base subobject, one for a complete object, and
7346 one for a virtual destructor that calls operator delete afterwards.
7347 For a hierarchy with virtual bases, the base and complete variants are
7348 clones, which means two copies of the function.  With this option, the
7349 base and complete variants are changed to be thunks that call a common
7350 implementation.
7352 Enabled by @option{-Os}.
7354 @item -fdelete-null-pointer-checks
7355 @opindex fdelete-null-pointer-checks
7356 Assume that programs cannot safely dereference null pointers, and that
7357 no code or data element resides there.  This enables simple constant
7358 folding optimizations at all optimization levels.  In addition, other
7359 optimization passes in GCC use this flag to control global dataflow
7360 analyses that eliminate useless checks for null pointers; these assume
7361 that if a pointer is checked after it has already been dereferenced,
7362 it cannot be null.
7364 Note however that in some environments this assumption is not true.
7365 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7366 for programs that depend on that behavior.
7368 Some targets, especially embedded ones, disable this option at all levels.
7369 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7370 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7371 are enabled independently at different optimization levels.
7373 @item -fdevirtualize
7374 @opindex fdevirtualize
7375 Attempt to convert calls to virtual functions to direct calls.  This
7376 is done both within a procedure and interprocedurally as part of
7377 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7378 propagation (@option{-fipa-cp}).
7379 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7381 @item -fdevirtualize-speculatively
7382 @opindex fdevirtualize-speculatively
7383 Attempt to convert calls to virtual functions to speculative direct calls.
7384 Based on the analysis of the type inheritance graph, determine for a given call
7385 the set of likely targets. If the set is small, preferably of size 1, change
7386 the call into an conditional deciding on direct and indirect call.  The
7387 speculative calls enable more optimizations, such as inlining.  When they seem
7388 useless after further optimization, they are converted back into original form.
7390 @item -fexpensive-optimizations
7391 @opindex fexpensive-optimizations
7392 Perform a number of minor optimizations that are relatively expensive.
7394 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7396 @item -free
7397 @opindex free
7398 Attempt to remove redundant extension instructions.  This is especially
7399 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7400 registers after writing to their lower 32-bit half.
7402 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7403 @option{-O3}, @option{-Os}.
7405 @item -fno-lifetime-dse
7406 @opindex fno-lifetime-dse
7407 In C++ the value of an object is only affected by changes within its
7408 lifetime: when the constructor begins, the object has an indeterminate
7409 value, and any changes during the lifetime of the object are dead when
7410 the object is destroyed.  Normally dead store elimination will take
7411 advantage of this; if your code relies on the value of the object
7412 storage persisting beyond the lifetime of the object, you can use this
7413 flag to disable this optimization.
7415 @item -flive-range-shrinkage
7416 @opindex flive-range-shrinkage
7417 Attempt to decrease register pressure through register live range
7418 shrinkage.  This is helpful for fast processors with small or moderate
7419 size register sets.
7421 @item -fira-algorithm=@var{algorithm}
7422 Use the specified coloring algorithm for the integrated register
7423 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7424 specifies Chow's priority coloring, or @samp{CB}, which specifies
7425 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7426 for all architectures, but for those targets that do support it, it is
7427 the default because it generates better code.
7429 @item -fira-region=@var{region}
7430 Use specified regions for the integrated register allocator.  The
7431 @var{region} argument should be one of the following:
7433 @table @samp
7435 @item all
7436 Use all loops as register allocation regions.
7437 This can give the best results for machines with a small and/or
7438 irregular register set.
7440 @item mixed
7441 Use all loops except for loops with small register pressure 
7442 as the regions.  This value usually gives
7443 the best results in most cases and for most architectures,
7444 and is enabled by default when compiling with optimization for speed
7445 (@option{-O}, @option{-O2}, @dots{}).
7447 @item one
7448 Use all functions as a single region.  
7449 This typically results in the smallest code size, and is enabled by default for
7450 @option{-Os} or @option{-O0}.
7452 @end table
7454 @item -fira-hoist-pressure
7455 @opindex fira-hoist-pressure
7456 Use IRA to evaluate register pressure in the code hoisting pass for
7457 decisions to hoist expressions.  This option usually results in smaller
7458 code, but it can slow the compiler down.
7460 This option is enabled at level @option{-Os} for all targets.
7462 @item -fira-loop-pressure
7463 @opindex fira-loop-pressure
7464 Use IRA to evaluate register pressure in loops for decisions to move
7465 loop invariants.  This option usually results in generation
7466 of faster and smaller code on machines with large register files (>= 32
7467 registers), but it can slow the compiler down.
7469 This option is enabled at level @option{-O3} for some targets.
7471 @item -fno-ira-share-save-slots
7472 @opindex fno-ira-share-save-slots
7473 Disable sharing of stack slots used for saving call-used hard
7474 registers living through a call.  Each hard register gets a
7475 separate stack slot, and as a result function stack frames are
7476 larger.
7478 @item -fno-ira-share-spill-slots
7479 @opindex fno-ira-share-spill-slots
7480 Disable sharing of stack slots allocated for pseudo-registers.  Each
7481 pseudo-register that does not get a hard register gets a separate
7482 stack slot, and as a result function stack frames are larger.
7484 @item -fira-verbose=@var{n}
7485 @opindex fira-verbose
7486 Control the verbosity of the dump file for the integrated register allocator.
7487 The default value is 5.  If the value @var{n} is greater or equal to 10,
7488 the dump output is sent to stderr using the same format as @var{n} minus 10.
7490 @item -fdelayed-branch
7491 @opindex fdelayed-branch
7492 If supported for the target machine, attempt to reorder instructions
7493 to exploit instruction slots available after delayed branch
7494 instructions.
7496 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7498 @item -fschedule-insns
7499 @opindex fschedule-insns
7500 If supported for the target machine, attempt to reorder instructions to
7501 eliminate execution stalls due to required data being unavailable.  This
7502 helps machines that have slow floating point or memory load instructions
7503 by allowing other instructions to be issued until the result of the load
7504 or floating-point instruction is required.
7506 Enabled at levels @option{-O2}, @option{-O3}.
7508 @item -fschedule-insns2
7509 @opindex fschedule-insns2
7510 Similar to @option{-fschedule-insns}, but requests an additional pass of
7511 instruction scheduling after register allocation has been done.  This is
7512 especially useful on machines with a relatively small number of
7513 registers and where memory load instructions take more than one cycle.
7515 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7517 @item -fno-sched-interblock
7518 @opindex fno-sched-interblock
7519 Don't schedule instructions across basic blocks.  This is normally
7520 enabled by default when scheduling before register allocation, i.e.@:
7521 with @option{-fschedule-insns} or at @option{-O2} or higher.
7523 @item -fno-sched-spec
7524 @opindex fno-sched-spec
7525 Don't allow speculative motion of non-load instructions.  This is normally
7526 enabled by default when scheduling before register allocation, i.e.@:
7527 with @option{-fschedule-insns} or at @option{-O2} or higher.
7529 @item -fsched-pressure
7530 @opindex fsched-pressure
7531 Enable register pressure sensitive insn scheduling before register
7532 allocation.  This only makes sense when scheduling before register
7533 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7534 @option{-O2} or higher.  Usage of this option can improve the
7535 generated code and decrease its size by preventing register pressure
7536 increase above the number of available hard registers and subsequent
7537 spills in register allocation.
7539 @item -fsched-spec-load
7540 @opindex fsched-spec-load
7541 Allow speculative motion of some load instructions.  This only makes
7542 sense when scheduling before register allocation, i.e.@: with
7543 @option{-fschedule-insns} or at @option{-O2} or higher.
7545 @item -fsched-spec-load-dangerous
7546 @opindex fsched-spec-load-dangerous
7547 Allow speculative motion of more load instructions.  This only makes
7548 sense when scheduling before register allocation, i.e.@: with
7549 @option{-fschedule-insns} or at @option{-O2} or higher.
7551 @item -fsched-stalled-insns
7552 @itemx -fsched-stalled-insns=@var{n}
7553 @opindex fsched-stalled-insns
7554 Define how many insns (if any) can be moved prematurely from the queue
7555 of stalled insns into the ready list during the second scheduling pass.
7556 @option{-fno-sched-stalled-insns} means that no insns are moved
7557 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7558 on how many queued insns can be moved prematurely.
7559 @option{-fsched-stalled-insns} without a value is equivalent to
7560 @option{-fsched-stalled-insns=1}.
7562 @item -fsched-stalled-insns-dep
7563 @itemx -fsched-stalled-insns-dep=@var{n}
7564 @opindex fsched-stalled-insns-dep
7565 Define how many insn groups (cycles) are examined for a dependency
7566 on a stalled insn that is a candidate for premature removal from the queue
7567 of stalled insns.  This has an effect only during the second scheduling pass,
7568 and only if @option{-fsched-stalled-insns} is used.
7569 @option{-fno-sched-stalled-insns-dep} is equivalent to
7570 @option{-fsched-stalled-insns-dep=0}.
7571 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7572 @option{-fsched-stalled-insns-dep=1}.
7574 @item -fsched2-use-superblocks
7575 @opindex fsched2-use-superblocks
7576 When scheduling after register allocation, use superblock scheduling.
7577 This allows motion across basic block boundaries,
7578 resulting in faster schedules.  This option is experimental, as not all machine
7579 descriptions used by GCC model the CPU closely enough to avoid unreliable
7580 results from the algorithm.
7582 This only makes sense when scheduling after register allocation, i.e.@: with
7583 @option{-fschedule-insns2} or at @option{-O2} or higher.
7585 @item -fsched-group-heuristic
7586 @opindex fsched-group-heuristic
7587 Enable the group heuristic in the scheduler.  This heuristic favors
7588 the instruction that belongs to a schedule group.  This is enabled
7589 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7590 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7592 @item -fsched-critical-path-heuristic
7593 @opindex fsched-critical-path-heuristic
7594 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7595 instructions on the critical path.  This is enabled by default when
7596 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7597 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7599 @item -fsched-spec-insn-heuristic
7600 @opindex fsched-spec-insn-heuristic
7601 Enable the speculative instruction heuristic in the scheduler.  This
7602 heuristic favors speculative instructions with greater dependency weakness.
7603 This is enabled by default when scheduling is enabled, i.e.@:
7604 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7605 or at @option{-O2} or higher.
7607 @item -fsched-rank-heuristic
7608 @opindex fsched-rank-heuristic
7609 Enable the rank heuristic in the scheduler.  This heuristic favors
7610 the instruction belonging to a basic block with greater size or frequency.
7611 This is enabled by default when scheduling is enabled, i.e.@:
7612 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7613 at @option{-O2} or higher.
7615 @item -fsched-last-insn-heuristic
7616 @opindex fsched-last-insn-heuristic
7617 Enable the last-instruction heuristic in the scheduler.  This heuristic
7618 favors the instruction that is less dependent on the last instruction
7619 scheduled.  This is enabled by default when scheduling is enabled,
7620 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7621 at @option{-O2} or higher.
7623 @item -fsched-dep-count-heuristic
7624 @opindex fsched-dep-count-heuristic
7625 Enable the dependent-count heuristic in the scheduler.  This heuristic
7626 favors the instruction that has more instructions depending on it.
7627 This is enabled by default when scheduling is enabled, i.e.@:
7628 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7629 at @option{-O2} or higher.
7631 @item -freschedule-modulo-scheduled-loops
7632 @opindex freschedule-modulo-scheduled-loops
7633 Modulo scheduling is performed before traditional scheduling.  If a loop
7634 is modulo scheduled, later scheduling passes may change its schedule.  
7635 Use this option to control that behavior.
7637 @item -fselective-scheduling
7638 @opindex fselective-scheduling
7639 Schedule instructions using selective scheduling algorithm.  Selective
7640 scheduling runs instead of the first scheduler pass.
7642 @item -fselective-scheduling2
7643 @opindex fselective-scheduling2
7644 Schedule instructions using selective scheduling algorithm.  Selective
7645 scheduling runs instead of the second scheduler pass.
7647 @item -fsel-sched-pipelining
7648 @opindex fsel-sched-pipelining
7649 Enable software pipelining of innermost loops during selective scheduling.
7650 This option has no effect unless one of @option{-fselective-scheduling} or
7651 @option{-fselective-scheduling2} is turned on.
7653 @item -fsel-sched-pipelining-outer-loops
7654 @opindex fsel-sched-pipelining-outer-loops
7655 When pipelining loops during selective scheduling, also pipeline outer loops.
7656 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7658 @item -fshrink-wrap
7659 @opindex fshrink-wrap
7660 Emit function prologues only before parts of the function that need it,
7661 rather than at the top of the function.  This flag is enabled by default at
7662 @option{-O} and higher.
7664 @item -fcaller-saves
7665 @opindex fcaller-saves
7666 Enable allocation of values to registers that are clobbered by
7667 function calls, by emitting extra instructions to save and restore the
7668 registers around such calls.  Such allocation is done only when it
7669 seems to result in better code.
7671 This option is always enabled by default on certain machines, usually
7672 those which have no call-preserved registers to use instead.
7674 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7676 @item -fcombine-stack-adjustments
7677 @opindex fcombine-stack-adjustments
7678 Tracks stack adjustments (pushes and pops) and stack memory references
7679 and then tries to find ways to combine them.
7681 Enabled by default at @option{-O1} and higher.
7683 @item -fconserve-stack
7684 @opindex fconserve-stack
7685 Attempt to minimize stack usage.  The compiler attempts to use less
7686 stack space, even if that makes the program slower.  This option
7687 implies setting the @option{large-stack-frame} parameter to 100
7688 and the @option{large-stack-frame-growth} parameter to 400.
7690 @item -ftree-reassoc
7691 @opindex ftree-reassoc
7692 Perform reassociation on trees.  This flag is enabled by default
7693 at @option{-O} and higher.
7695 @item -ftree-pre
7696 @opindex ftree-pre
7697 Perform partial redundancy elimination (PRE) on trees.  This flag is
7698 enabled by default at @option{-O2} and @option{-O3}.
7700 @item -ftree-partial-pre
7701 @opindex ftree-partial-pre
7702 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7703 enabled by default at @option{-O3}.
7705 @item -ftree-forwprop
7706 @opindex ftree-forwprop
7707 Perform forward propagation on trees.  This flag is enabled by default
7708 at @option{-O} and higher.
7710 @item -ftree-fre
7711 @opindex ftree-fre
7712 Perform full redundancy elimination (FRE) on trees.  The difference
7713 between FRE and PRE is that FRE only considers expressions
7714 that are computed on all paths leading to the redundant computation.
7715 This analysis is faster than PRE, though it exposes fewer redundancies.
7716 This flag is enabled by default at @option{-O} and higher.
7718 @item -ftree-phiprop
7719 @opindex ftree-phiprop
7720 Perform hoisting of loads from conditional pointers on trees.  This
7721 pass is enabled by default at @option{-O} and higher.
7723 @item -fhoist-adjacent-loads
7724 @opindex hoist-adjacent-loads
7725 Speculatively hoist loads from both branches of an if-then-else if the
7726 loads are from adjacent locations in the same structure and the target
7727 architecture has a conditional move instruction.  This flag is enabled
7728 by default at @option{-O2} and higher.
7730 @item -ftree-copy-prop
7731 @opindex ftree-copy-prop
7732 Perform copy propagation on trees.  This pass eliminates unnecessary
7733 copy operations.  This flag is enabled by default at @option{-O} and
7734 higher.
7736 @item -fipa-pure-const
7737 @opindex fipa-pure-const
7738 Discover which functions are pure or constant.
7739 Enabled by default at @option{-O} and higher.
7741 @item -fipa-reference
7742 @opindex fipa-reference
7743 Discover which static variables do not escape the
7744 compilation unit.
7745 Enabled by default at @option{-O} and higher.
7747 @item -fipa-pta
7748 @opindex fipa-pta
7749 Perform interprocedural pointer analysis and interprocedural modification
7750 and reference analysis.  This option can cause excessive memory and
7751 compile-time usage on large compilation units.  It is not enabled by
7752 default at any optimization level.
7754 @item -fipa-profile
7755 @opindex fipa-profile
7756 Perform interprocedural profile propagation.  The functions called only from
7757 cold functions are marked as cold. Also functions executed once (such as
7758 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7759 functions and loop less parts of functions executed once are then optimized for
7760 size.
7761 Enabled by default at @option{-O} and higher.
7763 @item -fipa-cp
7764 @opindex fipa-cp
7765 Perform interprocedural constant propagation.
7766 This optimization analyzes the program to determine when values passed
7767 to functions are constants and then optimizes accordingly.
7768 This optimization can substantially increase performance
7769 if the application has constants passed to functions.
7770 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7772 @item -fipa-cp-clone
7773 @opindex fipa-cp-clone
7774 Perform function cloning to make interprocedural constant propagation stronger.
7775 When enabled, interprocedural constant propagation performs function cloning
7776 when externally visible function can be called with constant arguments.
7777 Because this optimization can create multiple copies of functions,
7778 it may significantly increase code size
7779 (see @option{--param ipcp-unit-growth=@var{value}}).
7780 This flag is enabled by default at @option{-O3}.
7782 @item -fisolate-erroneous-paths-dereference
7783 Detect paths which trigger erroneous or undefined behaviour due to
7784 dereferencing a NULL pointer.  Isolate those paths from the main control
7785 flow and turn the statement with erroneous or undefined behaviour into a trap.
7787 @item -fisolate-erroneous-paths-attribute
7788 Detect paths which trigger erroneous or undefined behaviour due a NULL value
7789 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
7790 attribute.  Isolate those paths from the main control flow and turn the
7791 statement with erroneous or undefined behaviour into a trap.  This is not
7792 currently enabled, but may be enabled by @code{-O2} in the future.
7794 @item -ftree-sink
7795 @opindex ftree-sink
7796 Perform forward store motion  on trees.  This flag is
7797 enabled by default at @option{-O} and higher.
7799 @item -ftree-bit-ccp
7800 @opindex ftree-bit-ccp
7801 Perform sparse conditional bit constant propagation on trees and propagate
7802 pointer alignment information.
7803 This pass only operates on local scalar variables and is enabled by default
7804 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7806 @item -ftree-ccp
7807 @opindex ftree-ccp
7808 Perform sparse conditional constant propagation (CCP) on trees.  This
7809 pass only operates on local scalar variables and is enabled by default
7810 at @option{-O} and higher.
7812 @item -ftree-switch-conversion
7813 Perform conversion of simple initializations in a switch to
7814 initializations from a scalar array.  This flag is enabled by default
7815 at @option{-O2} and higher.
7817 @item -ftree-tail-merge
7818 Look for identical code sequences.  When found, replace one with a jump to the
7819 other.  This optimization is known as tail merging or cross jumping.  This flag
7820 is enabled by default at @option{-O2} and higher.  The compilation time
7821 in this pass can
7822 be limited using @option{max-tail-merge-comparisons} parameter and
7823 @option{max-tail-merge-iterations} parameter.
7825 @item -ftree-dce
7826 @opindex ftree-dce
7827 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7828 default at @option{-O} and higher.
7830 @item -ftree-builtin-call-dce
7831 @opindex ftree-builtin-call-dce
7832 Perform conditional dead code elimination (DCE) for calls to built-in functions
7833 that may set @code{errno} but are otherwise side-effect free.  This flag is
7834 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7835 specified.
7837 @item -ftree-dominator-opts
7838 @opindex ftree-dominator-opts
7839 Perform a variety of simple scalar cleanups (constant/copy
7840 propagation, redundancy elimination, range propagation and expression
7841 simplification) based on a dominator tree traversal.  This also
7842 performs jump threading (to reduce jumps to jumps). This flag is
7843 enabled by default at @option{-O} and higher.
7845 @item -ftree-dse
7846 @opindex ftree-dse
7847 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7848 a memory location that is later overwritten by another store without
7849 any intervening loads.  In this case the earlier store can be deleted.  This
7850 flag is enabled by default at @option{-O} and higher.
7852 @item -ftree-ch
7853 @opindex ftree-ch
7854 Perform loop header copying on trees.  This is beneficial since it increases
7855 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7856 is enabled by default at @option{-O} and higher.  It is not enabled
7857 for @option{-Os}, since it usually increases code size.
7859 @item -ftree-loop-optimize
7860 @opindex ftree-loop-optimize
7861 Perform loop optimizations on trees.  This flag is enabled by default
7862 at @option{-O} and higher.
7864 @item -ftree-loop-linear
7865 @opindex ftree-loop-linear
7866 Perform loop interchange transformations on tree.  Same as
7867 @option{-floop-interchange}.  To use this code transformation, GCC has
7868 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7869 enable the Graphite loop transformation infrastructure.
7871 @item -floop-interchange
7872 @opindex floop-interchange
7873 Perform loop interchange transformations on loops.  Interchanging two
7874 nested loops switches the inner and outer loops.  For example, given a
7875 loop like:
7876 @smallexample
7877 DO J = 1, M
7878   DO I = 1, N
7879     A(J, I) = A(J, I) * C
7880   ENDDO
7881 ENDDO
7882 @end smallexample
7883 loop interchange transforms the loop as if it were written:
7884 @smallexample
7885 DO I = 1, N
7886   DO J = 1, M
7887     A(J, I) = A(J, I) * C
7888   ENDDO
7889 ENDDO
7890 @end smallexample
7891 which can be beneficial when @code{N} is larger than the caches,
7892 because in Fortran, the elements of an array are stored in memory
7893 contiguously by column, and the original loop iterates over rows,
7894 potentially creating at each access a cache miss.  This optimization
7895 applies to all the languages supported by GCC and is not limited to
7896 Fortran.  To use this code transformation, GCC has to be configured
7897 with @option{--with-ppl} and @option{--with-cloog} to enable the
7898 Graphite loop transformation infrastructure.
7900 @item -floop-strip-mine
7901 @opindex floop-strip-mine
7902 Perform loop strip mining transformations on loops.  Strip mining
7903 splits a loop into two nested loops.  The outer loop has strides
7904 equal to the strip size and the inner loop has strides of the
7905 original loop within a strip.  The strip length can be changed
7906 using the @option{loop-block-tile-size} parameter.  For example,
7907 given a loop like:
7908 @smallexample
7909 DO I = 1, N
7910   A(I) = A(I) + C
7911 ENDDO
7912 @end smallexample
7913 loop strip mining transforms the loop as if it were written:
7914 @smallexample
7915 DO II = 1, N, 51
7916   DO I = II, min (II + 50, N)
7917     A(I) = A(I) + C
7918   ENDDO
7919 ENDDO
7920 @end smallexample
7921 This optimization applies to all the languages supported by GCC and is
7922 not limited to Fortran.  To use this code transformation, GCC has to
7923 be configured with @option{--with-ppl} and @option{--with-cloog} to
7924 enable the Graphite loop transformation infrastructure.
7926 @item -floop-block
7927 @opindex floop-block
7928 Perform loop blocking transformations on loops.  Blocking strip mines
7929 each loop in the loop nest such that the memory accesses of the
7930 element loops fit inside caches.  The strip length can be changed
7931 using the @option{loop-block-tile-size} parameter.  For example, given
7932 a loop like:
7933 @smallexample
7934 DO I = 1, N
7935   DO J = 1, M
7936     A(J, I) = B(I) + C(J)
7937   ENDDO
7938 ENDDO
7939 @end smallexample
7940 loop blocking transforms the loop as if it were written:
7941 @smallexample
7942 DO II = 1, N, 51
7943   DO JJ = 1, M, 51
7944     DO I = II, min (II + 50, N)
7945       DO J = JJ, min (JJ + 50, M)
7946         A(J, I) = B(I) + C(J)
7947       ENDDO
7948     ENDDO
7949   ENDDO
7950 ENDDO
7951 @end smallexample
7952 which can be beneficial when @code{M} is larger than the caches,
7953 because the innermost loop iterates over a smaller amount of data
7954 which can be kept in the caches.  This optimization applies to all the
7955 languages supported by GCC and is not limited to Fortran.  To use this
7956 code transformation, GCC has to be configured with @option{--with-ppl}
7957 and @option{--with-cloog} to enable the Graphite loop transformation
7958 infrastructure.
7960 @item -fgraphite-identity
7961 @opindex fgraphite-identity
7962 Enable the identity transformation for graphite.  For every SCoP we generate
7963 the polyhedral representation and transform it back to gimple.  Using
7964 @option{-fgraphite-identity} we can check the costs or benefits of the
7965 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7966 are also performed by the code generator CLooG, like index splitting and
7967 dead code elimination in loops.
7969 @item -floop-nest-optimize
7970 @opindex floop-nest-optimize
7971 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7972 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7973 structure optimized for data-locality and parallelism.  This option
7974 is experimental.
7976 @item -floop-parallelize-all
7977 @opindex floop-parallelize-all
7978 Use the Graphite data dependence analysis to identify loops that can
7979 be parallelized.  Parallelize all the loops that can be analyzed to
7980 not contain loop carried dependences without checking that it is
7981 profitable to parallelize the loops.
7983 @item -fcheck-data-deps
7984 @opindex fcheck-data-deps
7985 Compare the results of several data dependence analyzers.  This option
7986 is used for debugging the data dependence analyzers.
7988 @item -ftree-loop-if-convert
7989 Attempt to transform conditional jumps in the innermost loops to
7990 branch-less equivalents.  The intent is to remove control-flow from
7991 the innermost loops in order to improve the ability of the
7992 vectorization pass to handle these loops.  This is enabled by default
7993 if vectorization is enabled.
7995 @item -ftree-loop-if-convert-stores
7996 Attempt to also if-convert conditional jumps containing memory writes.
7997 This transformation can be unsafe for multi-threaded programs as it
7998 transforms conditional memory writes into unconditional memory writes.
7999 For example,
8000 @smallexample
8001 for (i = 0; i < N; i++)
8002   if (cond)
8003     A[i] = expr;
8004 @end smallexample
8005 is transformed to
8006 @smallexample
8007 for (i = 0; i < N; i++)
8008   A[i] = cond ? expr : A[i];
8009 @end smallexample
8010 potentially producing data races.
8012 @item -ftree-loop-distribution
8013 Perform loop distribution.  This flag can improve cache performance on
8014 big loop bodies and allow further loop optimizations, like
8015 parallelization or vectorization, to take place.  For example, the loop
8016 @smallexample
8017 DO I = 1, N
8018   A(I) = B(I) + C
8019   D(I) = E(I) * F
8020 ENDDO
8021 @end smallexample
8022 is transformed to
8023 @smallexample
8024 DO I = 1, N
8025    A(I) = B(I) + C
8026 ENDDO
8027 DO I = 1, N
8028    D(I) = E(I) * F
8029 ENDDO
8030 @end smallexample
8032 @item -ftree-loop-distribute-patterns
8033 Perform loop distribution of patterns that can be code generated with
8034 calls to a library.  This flag is enabled by default at @option{-O3}.
8036 This pass distributes the initialization loops and generates a call to
8037 memset zero.  For example, the loop
8038 @smallexample
8039 DO I = 1, N
8040   A(I) = 0
8041   B(I) = A(I) + I
8042 ENDDO
8043 @end smallexample
8044 is transformed to
8045 @smallexample
8046 DO I = 1, N
8047    A(I) = 0
8048 ENDDO
8049 DO I = 1, N
8050    B(I) = A(I) + I
8051 ENDDO
8052 @end smallexample
8053 and the initialization loop is transformed into a call to memset zero.
8055 @item -ftree-loop-im
8056 @opindex ftree-loop-im
8057 Perform loop invariant motion on trees.  This pass moves only invariants that
8058 are hard to handle at RTL level (function calls, operations that expand to
8059 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8060 operands of conditions that are invariant out of the loop, so that we can use
8061 just trivial invariantness analysis in loop unswitching.  The pass also includes
8062 store motion.
8064 @item -ftree-loop-ivcanon
8065 @opindex ftree-loop-ivcanon
8066 Create a canonical counter for number of iterations in loops for which
8067 determining number of iterations requires complicated analysis.  Later
8068 optimizations then may determine the number easily.  Useful especially
8069 in connection with unrolling.
8071 @item -fivopts
8072 @opindex fivopts
8073 Perform induction variable optimizations (strength reduction, induction
8074 variable merging and induction variable elimination) on trees.
8076 @item -ftree-parallelize-loops=n
8077 @opindex ftree-parallelize-loops
8078 Parallelize loops, i.e., split their iteration space to run in n threads.
8079 This is only possible for loops whose iterations are independent
8080 and can be arbitrarily reordered.  The optimization is only
8081 profitable on multiprocessor machines, for loops that are CPU-intensive,
8082 rather than constrained e.g.@: by memory bandwidth.  This option
8083 implies @option{-pthread}, and thus is only supported on targets
8084 that have support for @option{-pthread}.
8086 @item -ftree-pta
8087 @opindex ftree-pta
8088 Perform function-local points-to analysis on trees.  This flag is
8089 enabled by default at @option{-O} and higher.
8091 @item -ftree-sra
8092 @opindex ftree-sra
8093 Perform scalar replacement of aggregates.  This pass replaces structure
8094 references with scalars to prevent committing structures to memory too
8095 early.  This flag is enabled by default at @option{-O} and higher.
8097 @item -ftree-copyrename
8098 @opindex ftree-copyrename
8099 Perform copy renaming on trees.  This pass attempts to rename compiler
8100 temporaries to other variables at copy locations, usually resulting in
8101 variable names which more closely resemble the original variables.  This flag
8102 is enabled by default at @option{-O} and higher.
8104 @item -ftree-coalesce-inlined-vars
8105 @opindex ftree-coalesce-inlined-vars
8106 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8107 combine small user-defined variables too, but only if they were inlined
8108 from other functions.  It is a more limited form of
8109 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8110 inlined variables, but it will keep variables of the inlined-into
8111 function apart from each other, such that they are more likely to
8112 contain the expected values in a debugging session.  This was the
8113 default in GCC versions older than 4.7.
8115 @item -ftree-coalesce-vars
8116 @opindex ftree-coalesce-vars
8117 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8118 combine small user-defined variables too, instead of just compiler
8119 temporaries.  This may severely limit the ability to debug an optimized
8120 program compiled with @option{-fno-var-tracking-assignments}.  In the
8121 negated form, this flag prevents SSA coalescing of user variables,
8122 including inlined ones.  This option is enabled by default.
8124 @item -ftree-ter
8125 @opindex ftree-ter
8126 Perform temporary expression replacement during the SSA->normal phase.  Single
8127 use/single def temporaries are replaced at their use location with their
8128 defining expression.  This results in non-GIMPLE code, but gives the expanders
8129 much more complex trees to work on resulting in better RTL generation.  This is
8130 enabled by default at @option{-O} and higher.
8132 @item -ftree-slsr
8133 @opindex ftree-slsr
8134 Perform straight-line strength reduction on trees.  This recognizes related
8135 expressions involving multiplications and replaces them by less expensive
8136 calculations when possible.  This is enabled by default at @option{-O} and
8137 higher.
8139 @item -ftree-vectorize
8140 @opindex ftree-vectorize
8141 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8142 and @option{-ftree-slp-vectorize} if not explicitly specified.
8144 @item -ftree-loop-vectorize
8145 @opindex ftree-loop-vectorize
8146 Perform loop vectorization on trees. This flag is enabled by default at
8147 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8149 @item -ftree-slp-vectorize
8150 @opindex ftree-slp-vectorize
8151 Perform basic block vectorization on trees. This flag is enabled by default at
8152 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8154 @item -fvect-cost-model=@var{model}
8155 @opindex fvect-cost-model
8156 Alter the cost model used for vectorization.  The @var{model} argument
8157 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8158 With the @code{unlimited} model the vectorized code-path is assumed
8159 to be profitable while with the @code{dynamic} model a runtime check
8160 will guard the vectorized code-path to enable it only for iteration
8161 counts that will likely execute faster than when executing the original
8162 scalar loop.  The @code{cheap} model will disable vectorization of
8163 loops where doing so would be cost prohibitive for example due to
8164 required runtime checks for data dependence or alignment but otherwise
8165 is equal to the @code{dynamic} model.
8166 The default cost model depends on other optimization flags and is
8167 either @code{dynamic} or @code{cheap}.
8169 @item -fsimd-cost-model=@var{model}
8170 @opindex fsimd-cost-model
8171 Alter the cost model used for vectorization of loops marked with the OpenMP
8172 or Cilk Plus simd directive.  The @var{model} argument should be one of
8173 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8174 have the same meaning as described in @option{-fvect-cost-model} and by
8175 default a cost model defined with @option{-fvect-cost-model} is used.
8177 @item -ftree-vrp
8178 @opindex ftree-vrp
8179 Perform Value Range Propagation on trees.  This is similar to the
8180 constant propagation pass, but instead of values, ranges of values are
8181 propagated.  This allows the optimizers to remove unnecessary range
8182 checks like array bound checks and null pointer checks.  This is
8183 enabled by default at @option{-O2} and higher.  Null pointer check
8184 elimination is only done if @option{-fdelete-null-pointer-checks} is
8185 enabled.
8187 @item -ftracer
8188 @opindex ftracer
8189 Perform tail duplication to enlarge superblock size.  This transformation
8190 simplifies the control flow of the function allowing other optimizations to do
8191 a better job.
8193 @item -funroll-loops
8194 @opindex funroll-loops
8195 Unroll loops whose number of iterations can be determined at compile
8196 time or upon entry to the loop.  @option{-funroll-loops} implies
8197 @option{-frerun-cse-after-loop}.  This option makes code larger,
8198 and may or may not make it run faster.
8200 @item -funroll-all-loops
8201 @opindex funroll-all-loops
8202 Unroll all loops, even if their number of iterations is uncertain when
8203 the loop is entered.  This usually makes programs run more slowly.
8204 @option{-funroll-all-loops} implies the same options as
8205 @option{-funroll-loops},
8207 @item -fsplit-ivs-in-unroller
8208 @opindex fsplit-ivs-in-unroller
8209 Enables expression of values of induction variables in later iterations
8210 of the unrolled loop using the value in the first iteration.  This breaks
8211 long dependency chains, thus improving efficiency of the scheduling passes.
8213 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8214 same effect.  However, that is not reliable in cases where the loop body
8215 is more complicated than a single basic block.  It also does not work at all
8216 on some architectures due to restrictions in the CSE pass.
8218 This optimization is enabled by default.
8220 @item -fvariable-expansion-in-unroller
8221 @opindex fvariable-expansion-in-unroller
8222 With this option, the compiler creates multiple copies of some
8223 local variables when unrolling a loop, which can result in superior code.
8225 @item -fpartial-inlining
8226 @opindex fpartial-inlining
8227 Inline parts of functions.  This option has any effect only
8228 when inlining itself is turned on by the @option{-finline-functions}
8229 or @option{-finline-small-functions} options.
8231 Enabled at level @option{-O2}.
8233 @item -fpredictive-commoning
8234 @opindex fpredictive-commoning
8235 Perform predictive commoning optimization, i.e., reusing computations
8236 (especially memory loads and stores) performed in previous
8237 iterations of loops.
8239 This option is enabled at level @option{-O3}.
8241 @item -fprefetch-loop-arrays
8242 @opindex fprefetch-loop-arrays
8243 If supported by the target machine, generate instructions to prefetch
8244 memory to improve the performance of loops that access large arrays.
8246 This option may generate better or worse code; results are highly
8247 dependent on the structure of loops within the source code.
8249 Disabled at level @option{-Os}.
8251 @item -fno-peephole
8252 @itemx -fno-peephole2
8253 @opindex fno-peephole
8254 @opindex fno-peephole2
8255 Disable any machine-specific peephole optimizations.  The difference
8256 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8257 are implemented in the compiler; some targets use one, some use the
8258 other, a few use both.
8260 @option{-fpeephole} is enabled by default.
8261 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8263 @item -fno-guess-branch-probability
8264 @opindex fno-guess-branch-probability
8265 Do not guess branch probabilities using heuristics.
8267 GCC uses heuristics to guess branch probabilities if they are
8268 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8269 heuristics are based on the control flow graph.  If some branch probabilities
8270 are specified by @samp{__builtin_expect}, then the heuristics are
8271 used to guess branch probabilities for the rest of the control flow graph,
8272 taking the @samp{__builtin_expect} info into account.  The interactions
8273 between the heuristics and @samp{__builtin_expect} can be complex, and in
8274 some cases, it may be useful to disable the heuristics so that the effects
8275 of @samp{__builtin_expect} are easier to understand.
8277 The default is @option{-fguess-branch-probability} at levels
8278 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8280 @item -freorder-blocks
8281 @opindex freorder-blocks
8282 Reorder basic blocks in the compiled function in order to reduce number of
8283 taken branches and improve code locality.
8285 Enabled at levels @option{-O2}, @option{-O3}.
8287 @item -freorder-blocks-and-partition
8288 @opindex freorder-blocks-and-partition
8289 In addition to reordering basic blocks in the compiled function, in order
8290 to reduce number of taken branches, partitions hot and cold basic blocks
8291 into separate sections of the assembly and .o files, to improve
8292 paging and cache locality performance.
8294 This optimization is automatically turned off in the presence of
8295 exception handling, for linkonce sections, for functions with a user-defined
8296 section attribute and on any architecture that does not support named
8297 sections.
8299 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8301 @item -freorder-functions
8302 @opindex freorder-functions
8303 Reorder functions in the object file in order to
8304 improve code locality.  This is implemented by using special
8305 subsections @code{.text.hot} for most frequently executed functions and
8306 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8307 the linker so object file format must support named sections and linker must
8308 place them in a reasonable way.
8310 Also profile feedback must be available to make this option effective.  See
8311 @option{-fprofile-arcs} for details.
8313 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8315 @item -fstrict-aliasing
8316 @opindex fstrict-aliasing
8317 Allow the compiler to assume the strictest aliasing rules applicable to
8318 the language being compiled.  For C (and C++), this activates
8319 optimizations based on the type of expressions.  In particular, an
8320 object of one type is assumed never to reside at the same address as an
8321 object of a different type, unless the types are almost the same.  For
8322 example, an @code{unsigned int} can alias an @code{int}, but not a
8323 @code{void*} or a @code{double}.  A character type may alias any other
8324 type.
8326 @anchor{Type-punning}Pay special attention to code like this:
8327 @smallexample
8328 union a_union @{
8329   int i;
8330   double d;
8333 int f() @{
8334   union a_union t;
8335   t.d = 3.0;
8336   return t.i;
8338 @end smallexample
8339 The practice of reading from a different union member than the one most
8340 recently written to (called ``type-punning'') is common.  Even with
8341 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8342 is accessed through the union type.  So, the code above works as
8343 expected.  @xref{Structures unions enumerations and bit-fields
8344 implementation}.  However, this code might not:
8345 @smallexample
8346 int f() @{
8347   union a_union t;
8348   int* ip;
8349   t.d = 3.0;
8350   ip = &t.i;
8351   return *ip;
8353 @end smallexample
8355 Similarly, access by taking the address, casting the resulting pointer
8356 and dereferencing the result has undefined behavior, even if the cast
8357 uses a union type, e.g.:
8358 @smallexample
8359 int f() @{
8360   double d = 3.0;
8361   return ((union a_union *) &d)->i;
8363 @end smallexample
8365 The @option{-fstrict-aliasing} option is enabled at levels
8366 @option{-O2}, @option{-O3}, @option{-Os}.
8368 @item -fstrict-overflow
8369 @opindex fstrict-overflow
8370 Allow the compiler to assume strict signed overflow rules, depending
8371 on the language being compiled.  For C (and C++) this means that
8372 overflow when doing arithmetic with signed numbers is undefined, which
8373 means that the compiler may assume that it does not happen.  This
8374 permits various optimizations.  For example, the compiler assumes
8375 that an expression like @code{i + 10 > i} is always true for
8376 signed @code{i}.  This assumption is only valid if signed overflow is
8377 undefined, as the expression is false if @code{i + 10} overflows when
8378 using twos complement arithmetic.  When this option is in effect any
8379 attempt to determine whether an operation on signed numbers 
8380 overflows must be written carefully to not actually involve overflow.
8382 This option also allows the compiler to assume strict pointer
8383 semantics: given a pointer to an object, if adding an offset to that
8384 pointer does not produce a pointer to the same object, the addition is
8385 undefined.  This permits the compiler to conclude that @code{p + u >
8386 p} is always true for a pointer @code{p} and unsigned integer
8387 @code{u}.  This assumption is only valid because pointer wraparound is
8388 undefined, as the expression is false if @code{p + u} overflows using
8389 twos complement arithmetic.
8391 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8392 that integer signed overflow is fully defined: it wraps.  When
8393 @option{-fwrapv} is used, there is no difference between
8394 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8395 integers.  With @option{-fwrapv} certain types of overflow are
8396 permitted.  For example, if the compiler gets an overflow when doing
8397 arithmetic on constants, the overflowed value can still be used with
8398 @option{-fwrapv}, but not otherwise.
8400 The @option{-fstrict-overflow} option is enabled at levels
8401 @option{-O2}, @option{-O3}, @option{-Os}.
8403 @item -falign-functions
8404 @itemx -falign-functions=@var{n}
8405 @opindex falign-functions
8406 Align the start of functions to the next power-of-two greater than
8407 @var{n}, skipping up to @var{n} bytes.  For instance,
8408 @option{-falign-functions=32} aligns functions to the next 32-byte
8409 boundary, but @option{-falign-functions=24} aligns to the next
8410 32-byte boundary only if this can be done by skipping 23 bytes or less.
8412 @option{-fno-align-functions} and @option{-falign-functions=1} are
8413 equivalent and mean that functions are not aligned.
8415 Some assemblers only support this flag when @var{n} is a power of two;
8416 in that case, it is rounded up.
8418 If @var{n} is not specified or is zero, use a machine-dependent default.
8420 Enabled at levels @option{-O2}, @option{-O3}.
8422 @item -falign-labels
8423 @itemx -falign-labels=@var{n}
8424 @opindex falign-labels
8425 Align all branch targets to a power-of-two boundary, skipping up to
8426 @var{n} bytes like @option{-falign-functions}.  This option can easily
8427 make code slower, because it must insert dummy operations for when the
8428 branch target is reached in the usual flow of the code.
8430 @option{-fno-align-labels} and @option{-falign-labels=1} are
8431 equivalent and mean that labels are not aligned.
8433 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8434 are greater than this value, then their values are used instead.
8436 If @var{n} is not specified or is zero, use a machine-dependent default
8437 which is very likely to be @samp{1}, meaning no alignment.
8439 Enabled at levels @option{-O2}, @option{-O3}.
8441 @item -falign-loops
8442 @itemx -falign-loops=@var{n}
8443 @opindex falign-loops
8444 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8445 like @option{-falign-functions}.  If the loops are
8446 executed many times, this makes up for any execution of the dummy
8447 operations.
8449 @option{-fno-align-loops} and @option{-falign-loops=1} are
8450 equivalent and mean that loops are not aligned.
8452 If @var{n} is not specified or is zero, use a machine-dependent default.
8454 Enabled at levels @option{-O2}, @option{-O3}.
8456 @item -falign-jumps
8457 @itemx -falign-jumps=@var{n}
8458 @opindex falign-jumps
8459 Align branch targets to a power-of-two boundary, for branch targets
8460 where the targets can only be reached by jumping, skipping up to @var{n}
8461 bytes like @option{-falign-functions}.  In this case, no dummy operations
8462 need be executed.
8464 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8465 equivalent and mean that loops are not aligned.
8467 If @var{n} is not specified or is zero, use a machine-dependent default.
8469 Enabled at levels @option{-O2}, @option{-O3}.
8471 @item -funit-at-a-time
8472 @opindex funit-at-a-time
8473 This option is left for compatibility reasons. @option{-funit-at-a-time}
8474 has no effect, while @option{-fno-unit-at-a-time} implies
8475 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8477 Enabled by default.
8479 @item -fno-toplevel-reorder
8480 @opindex fno-toplevel-reorder
8481 Do not reorder top-level functions, variables, and @code{asm}
8482 statements.  Output them in the same order that they appear in the
8483 input file.  When this option is used, unreferenced static variables
8484 are not removed.  This option is intended to support existing code
8485 that relies on a particular ordering.  For new code, it is better to
8486 use attributes when possible.
8488 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8489 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8490 targets.
8492 @item -fweb
8493 @opindex fweb
8494 Constructs webs as commonly used for register allocation purposes and assign
8495 each web individual pseudo register.  This allows the register allocation pass
8496 to operate on pseudos directly, but also strengthens several other optimization
8497 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8498 however, make debugging impossible, since variables no longer stay in a
8499 ``home register''.
8501 Enabled by default with @option{-funroll-loops}.
8503 @item -fwhole-program
8504 @opindex fwhole-program
8505 Assume that the current compilation unit represents the whole program being
8506 compiled.  All public functions and variables with the exception of @code{main}
8507 and those merged by attribute @code{externally_visible} become static functions
8508 and in effect are optimized more aggressively by interprocedural optimizers.
8510 This option should not be used in combination with @code{-flto}.
8511 Instead relying on a linker plugin should provide safer and more precise
8512 information.
8514 @item -flto[=@var{n}]
8515 @opindex flto
8516 This option runs the standard link-time optimizer.  When invoked
8517 with source code, it generates GIMPLE (one of GCC's internal
8518 representations) and writes it to special ELF sections in the object
8519 file.  When the object files are linked together, all the function
8520 bodies are read from these ELF sections and instantiated as if they
8521 had been part of the same translation unit.
8523 To use the link-time optimizer, @option{-flto} and optimization
8524 options should be specified at compile time and during the final link.
8525 For example:
8527 @smallexample
8528 gcc -c -O2 -flto foo.c
8529 gcc -c -O2 -flto bar.c
8530 gcc -o myprog -flto -O2 foo.o bar.o
8531 @end smallexample
8533 The first two invocations to GCC save a bytecode representation
8534 of GIMPLE into special ELF sections inside @file{foo.o} and
8535 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8536 @file{foo.o} and @file{bar.o}, merges the two files into a single
8537 internal image, and compiles the result as usual.  Since both
8538 @file{foo.o} and @file{bar.o} are merged into a single image, this
8539 causes all the interprocedural analyses and optimizations in GCC to
8540 work across the two files as if they were a single one.  This means,
8541 for example, that the inliner is able to inline functions in
8542 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8544 Another (simpler) way to enable link-time optimization is:
8546 @smallexample
8547 gcc -o myprog -flto -O2 foo.c bar.c
8548 @end smallexample
8550 The above generates bytecode for @file{foo.c} and @file{bar.c},
8551 merges them together into a single GIMPLE representation and optimizes
8552 them as usual to produce @file{myprog}.
8554 The only important thing to keep in mind is that to enable link-time
8555 optimizations you need to use the GCC driver to perform the link-step.
8556 GCC then automatically performs link-time optimization if any of the
8557 objects involved were compiled with the @option{-flto}.  You generally
8558 should specify the optimization options to be used for link-time
8559 optimization though GCC will try to be clever at guessing an
8560 optimization level to use from the options used at compile-time
8561 if you fail to specify one at link-time.  You can always override
8562 the automatic decision to do link-time optimization at link-time
8563 by passing @option{-fno-lto} to the link command.
8565 To make whole program optimization effective, it is necessary to make
8566 certain whole program assumptions.  The compiler needs to know
8567 what functions and variables can be accessed by libraries and runtime
8568 outside of the link-time optimized unit.  When supported by the linker,
8569 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8570 to the compiler about used and externally visible symbols.  When
8571 the linker plugin is not available, @option{-fwhole-program} should be
8572 used to allow the compiler to make these assumptions, which leads
8573 to more aggressive optimization decisions.
8575 When @option{-fuse-linker-plugin} is not enabled then, when a file is
8576 compiled with @option{-flto}, the generated object file is larger than
8577 a regular object file because it contains GIMPLE bytecodes and the usual
8578 final code (see @option{-ffat-lto-objects}.  This means that
8579 object files with LTO information can be linked as normal object
8580 files; if @option{-fno-lto} is passed to the linker, no
8581 interprocedural optimizations are applied.  Note that when
8582 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
8583 but you cannot perform a regular, non-LTO link on them.
8585 Additionally, the optimization flags used to compile individual files
8586 are not necessarily related to those used at link time.  For instance,
8588 @smallexample
8589 gcc -c -O0 -ffat-lto-objects -flto foo.c
8590 gcc -c -O0 -ffat-lto-objects -flto bar.c
8591 gcc -o myprog -O3 foo.o bar.o
8592 @end smallexample
8594 This produces individual object files with unoptimized assembler
8595 code, but the resulting binary @file{myprog} is optimized at
8596 @option{-O3}.  If, instead, the final binary is generated with
8597 @option{-fno-lto}, then @file{myprog} is not optimized.
8599 When producing the final binary, GCC only
8600 applies link-time optimizations to those files that contain bytecode.
8601 Therefore, you can mix and match object files and libraries with
8602 GIMPLE bytecodes and final object code.  GCC automatically selects
8603 which files to optimize in LTO mode and which files to link without
8604 further processing.
8606 There are some code generation flags preserved by GCC when
8607 generating bytecodes, as they need to be used during the final link
8608 stage.  Generally options specified at link-time override those
8609 specified at compile-time.
8611 If you do not specify an optimization level option @option{-O} at
8612 link-time then GCC will compute one based on the optimization levels
8613 used when compiling the object files.  The highest optimization
8614 level will win here.
8616 Currently, the following options and their setting are take from
8617 the first object file that explicitely specified it: 
8618 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8619 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8620 and all the @option{-m} target flags.
8622 Certain ABI changing flags are required to match in all compilation-units
8623 and trying to override this at link-time with a conflicting value
8624 is ignored.  This includes options such as @option{-freg-struct-return}
8625 and @option{-fpcc-struct-return}. 
8627 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8628 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8629 are passed through to the link stage and merged conservatively for
8630 conflicting translation units.  Specifically
8631 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8632 precedence and for example @option{-ffp-contract=off} takes precedence
8633 over @option{-ffp-contract=fast}.  You can override them at linke-time.
8635 It is recommended that you compile all the files participating in the
8636 same link with the same options and also specify those options at
8637 link time.
8639 If LTO encounters objects with C linkage declared with incompatible
8640 types in separate translation units to be linked together (undefined
8641 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8642 issued.  The behavior is still undefined at run time.  Similar
8643 diagnostics may be raised for other languages.
8645 Another feature of LTO is that it is possible to apply interprocedural
8646 optimizations on files written in different languages:
8648 @smallexample
8649 gcc -c -flto foo.c
8650 g++ -c -flto bar.cc
8651 gfortran -c -flto baz.f90
8652 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8653 @end smallexample
8655 Notice that the final link is done with @command{g++} to get the C++
8656 runtime libraries and @option{-lgfortran} is added to get the Fortran
8657 runtime libraries.  In general, when mixing languages in LTO mode, you
8658 should use the same link command options as when mixing languages in a
8659 regular (non-LTO) compilation.
8661 If object files containing GIMPLE bytecode are stored in a library archive, say
8662 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8663 are using a linker with plugin support.  To create static libraries suitable
8664 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8665 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
8666 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8667 and @command{nm} have been compiled with plugin support.  At link time, use the the
8668 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8669 the LTO optimization process:
8671 @smallexample
8672 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8673 @end smallexample
8675 With the linker plugin enabled, the linker extracts the needed
8676 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8677 to make them part of the aggregated GIMPLE image to be optimized.
8679 If you are not using a linker with plugin support and/or do not
8680 enable the linker plugin, then the objects inside @file{libfoo.a}
8681 are extracted and linked as usual, but they do not participate
8682 in the LTO optimization process.  In order to make a static library suitable
8683 for both LTO optimization and usual linkage, compile its object files with
8684 @option{-flto} @code{-ffat-lto-objects}.
8686 Link-time optimizations do not require the presence of the whole program to
8687 operate.  If the program does not require any symbols to be exported, it is
8688 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8689 the interprocedural optimizers to use more aggressive assumptions which may
8690 lead to improved optimization opportunities.
8691 Use of @option{-fwhole-program} is not needed when linker plugin is
8692 active (see @option{-fuse-linker-plugin}).
8694 The current implementation of LTO makes no
8695 attempt to generate bytecode that is portable between different
8696 types of hosts.  The bytecode files are versioned and there is a
8697 strict version check, so bytecode files generated in one version of
8698 GCC will not work with an older or newer version of GCC.
8700 Link-time optimization does not work well with generation of debugging
8701 information.  Combining @option{-flto} with
8702 @option{-g} is currently experimental and expected to produce unexpected
8703 results.
8705 If you specify the optional @var{n}, the optimization and code
8706 generation done at link time is executed in parallel using @var{n}
8707 parallel jobs by utilizing an installed @command{make} program.  The
8708 environment variable @env{MAKE} may be used to override the program
8709 used.  The default value for @var{n} is 1.
8711 You can also specify @option{-flto=jobserver} to use GNU make's
8712 job server mode to determine the number of parallel jobs. This
8713 is useful when the Makefile calling GCC is already executing in parallel.
8714 You must prepend a @samp{+} to the command recipe in the parent Makefile
8715 for this to work.  This option likely only works if @env{MAKE} is
8716 GNU make.
8718 @item -flto-partition=@var{alg}
8719 @opindex flto-partition
8720 Specify the partitioning algorithm used by the link-time optimizer.
8721 The value is either @code{1to1} to specify a partitioning mirroring
8722 the original source files or @code{balanced} to specify partitioning
8723 into equally sized chunks (whenever possible) or @code{max} to create
8724 new partition for every symbol where possible.  Specifying @code{none}
8725 as an algorithm disables partitioning and streaming completely. 
8726 The default value is @code{balanced}. While @code{1to1} can be used
8727 as an workaround for various code ordering issues, the @code{max}
8728 partitioning is intended for internal testing only.
8730 @item -flto-compression-level=@var{n}
8731 This option specifies the level of compression used for intermediate
8732 language written to LTO object files, and is only meaningful in
8733 conjunction with LTO mode (@option{-flto}).  Valid
8734 values are 0 (no compression) to 9 (maximum compression).  Values
8735 outside this range are clamped to either 0 or 9.  If the option is not
8736 given, a default balanced compression setting is used.
8738 @item -flto-report
8739 Prints a report with internal details on the workings of the link-time
8740 optimizer.  The contents of this report vary from version to version.
8741 It is meant to be useful to GCC developers when processing object
8742 files in LTO mode (via @option{-flto}).
8744 Disabled by default.
8746 @item -flto-report-wpa
8747 Like @option{-flto-report}, but only print for the WPA phase of Link
8748 Time Optimization.
8750 @item -fuse-linker-plugin
8751 Enables the use of a linker plugin during link-time optimization.  This
8752 option relies on plugin support in the linker, which is available in gold
8753 or in GNU ld 2.21 or newer.
8755 This option enables the extraction of object files with GIMPLE bytecode out
8756 of library archives. This improves the quality of optimization by exposing
8757 more code to the link-time optimizer.  This information specifies what
8758 symbols can be accessed externally (by non-LTO object or during dynamic
8759 linking).  Resulting code quality improvements on binaries (and shared
8760 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8761 See @option{-flto} for a description of the effect of this flag and how to
8762 use it.
8764 This option is enabled by default when LTO support in GCC is enabled
8765 and GCC was configured for use with
8766 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8768 @item -ffat-lto-objects
8769 @opindex ffat-lto-objects
8770 Fat LTO objects are object files that contain both the intermediate language
8771 and the object code. This makes them usable for both LTO linking and normal
8772 linking. This option is effective only when compiling with @option{-flto}
8773 and is ignored at link time.
8775 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8776 requires the complete toolchain to be aware of LTO. It requires a linker with
8777 linker plugin support for basic functionality.  Additionally,
8778 @command{nm}, @command{ar} and @command{ranlib}
8779 need to support linker plugins to allow a full-featured build environment
8780 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8781 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8782 to these tools. With non fat LTO makefiles need to be modified to use them.
8784 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
8785 support.
8787 @item -fcompare-elim
8788 @opindex fcompare-elim
8789 After register allocation and post-register allocation instruction splitting,
8790 identify arithmetic instructions that compute processor flags similar to a
8791 comparison operation based on that arithmetic.  If possible, eliminate the
8792 explicit comparison operation.
8794 This pass only applies to certain targets that cannot explicitly represent
8795 the comparison operation before register allocation is complete.
8797 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8799 @item -fuse-ld=bfd
8800 @opindex fuse-ld=bfd
8801 Use the @command{bfd} linker instead of the default linker.
8803 @item -fuse-ld=gold
8804 @opindex fuse-ld=gold
8805 Use the @command{gold} linker instead of the default linker.
8807 @item -fcprop-registers
8808 @opindex fcprop-registers
8809 After register allocation and post-register allocation instruction splitting,
8810 perform a copy-propagation pass to try to reduce scheduling dependencies
8811 and occasionally eliminate the copy.
8813 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8815 @item -fprofile-correction
8816 @opindex fprofile-correction
8817 Profiles collected using an instrumented binary for multi-threaded programs may
8818 be inconsistent due to missed counter updates. When this option is specified,
8819 GCC uses heuristics to correct or smooth out such inconsistencies. By
8820 default, GCC emits an error message when an inconsistent profile is detected.
8822 @item -fprofile-dir=@var{path}
8823 @opindex fprofile-dir
8825 Set the directory to search for the profile data files in to @var{path}.
8826 This option affects only the profile data generated by
8827 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8828 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8829 and its related options.  Both absolute and relative paths can be used.
8830 By default, GCC uses the current directory as @var{path}, thus the
8831 profile data file appears in the same directory as the object file.
8833 @item -fprofile-generate
8834 @itemx -fprofile-generate=@var{path}
8835 @opindex fprofile-generate
8837 Enable options usually used for instrumenting application to produce
8838 profile useful for later recompilation with profile feedback based
8839 optimization.  You must use @option{-fprofile-generate} both when
8840 compiling and when linking your program.
8842 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8844 If @var{path} is specified, GCC looks at the @var{path} to find
8845 the profile feedback data files. See @option{-fprofile-dir}.
8847 @item -fprofile-use
8848 @itemx -fprofile-use=@var{path}
8849 @opindex fprofile-use
8850 Enable profile feedback directed optimizations, and optimizations
8851 generally profitable only with profile feedback available.
8853 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8854 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8855 @code{ftree-loop-distribute-patterns}
8857 By default, GCC emits an error message if the feedback profiles do not
8858 match the source code.  This error can be turned into a warning by using
8859 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8860 code.
8862 If @var{path} is specified, GCC looks at the @var{path} to find
8863 the profile feedback data files. See @option{-fprofile-dir}.
8864 @end table
8866 The following options control compiler behavior regarding floating-point 
8867 arithmetic.  These options trade off between speed and
8868 correctness.  All must be specifically enabled.
8870 @table @gcctabopt
8871 @item -ffloat-store
8872 @opindex ffloat-store
8873 Do not store floating-point variables in registers, and inhibit other
8874 options that might change whether a floating-point value is taken from a
8875 register or memory.
8877 @cindex floating-point precision
8878 This option prevents undesirable excess precision on machines such as
8879 the 68000 where the floating registers (of the 68881) keep more
8880 precision than a @code{double} is supposed to have.  Similarly for the
8881 x86 architecture.  For most programs, the excess precision does only
8882 good, but a few programs rely on the precise definition of IEEE floating
8883 point.  Use @option{-ffloat-store} for such programs, after modifying
8884 them to store all pertinent intermediate computations into variables.
8886 @item -fexcess-precision=@var{style}
8887 @opindex fexcess-precision
8888 This option allows further control over excess precision on machines
8889 where floating-point registers have more precision than the IEEE
8890 @code{float} and @code{double} types and the processor does not
8891 support operations rounding to those types.  By default,
8892 @option{-fexcess-precision=fast} is in effect; this means that
8893 operations are carried out in the precision of the registers and that
8894 it is unpredictable when rounding to the types specified in the source
8895 code takes place.  When compiling C, if
8896 @option{-fexcess-precision=standard} is specified then excess
8897 precision follows the rules specified in ISO C99; in particular,
8898 both casts and assignments cause values to be rounded to their
8899 semantic types (whereas @option{-ffloat-store} only affects
8900 assignments).  This option is enabled by default for C if a strict
8901 conformance option such as @option{-std=c99} is used.
8903 @opindex mfpmath
8904 @option{-fexcess-precision=standard} is not implemented for languages
8905 other than C, and has no effect if
8906 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8907 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8908 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8909 semantics apply without excess precision, and in the latter, rounding
8910 is unpredictable.
8912 @item -ffast-math
8913 @opindex ffast-math
8914 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8915 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8916 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8918 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8920 This option is not turned on by any @option{-O} option besides
8921 @option{-Ofast} since it can result in incorrect output for programs
8922 that depend on an exact implementation of IEEE or ISO rules/specifications
8923 for math functions. It may, however, yield faster code for programs
8924 that do not require the guarantees of these specifications.
8926 @item -fno-math-errno
8927 @opindex fno-math-errno
8928 Do not set @code{errno} after calling math functions that are executed
8929 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8930 IEEE exceptions for math error handling may want to use this flag
8931 for speed while maintaining IEEE arithmetic compatibility.
8933 This option is not turned on by any @option{-O} option since
8934 it can result in incorrect output for programs that depend on
8935 an exact implementation of IEEE or ISO rules/specifications for
8936 math functions. It may, however, yield faster code for programs
8937 that do not require the guarantees of these specifications.
8939 The default is @option{-fmath-errno}.
8941 On Darwin systems, the math library never sets @code{errno}.  There is
8942 therefore no reason for the compiler to consider the possibility that
8943 it might, and @option{-fno-math-errno} is the default.
8945 @item -funsafe-math-optimizations
8946 @opindex funsafe-math-optimizations
8948 Allow optimizations for floating-point arithmetic that (a) assume
8949 that arguments and results are valid and (b) may violate IEEE or
8950 ANSI standards.  When used at link-time, it may include libraries
8951 or startup files that change the default FPU control word or other
8952 similar optimizations.
8954 This option is not turned on by any @option{-O} option since
8955 it can result in incorrect output for programs that depend on
8956 an exact implementation of IEEE or ISO rules/specifications for
8957 math functions. It may, however, yield faster code for programs
8958 that do not require the guarantees of these specifications.
8959 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8960 @option{-fassociative-math} and @option{-freciprocal-math}.
8962 The default is @option{-fno-unsafe-math-optimizations}.
8964 @item -fassociative-math
8965 @opindex fassociative-math
8967 Allow re-association of operands in series of floating-point operations.
8968 This violates the ISO C and C++ language standard by possibly changing
8969 computation result.  NOTE: re-ordering may change the sign of zero as
8970 well as ignore NaNs and inhibit or create underflow or overflow (and
8971 thus cannot be used on code that relies on rounding behavior like
8972 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8973 and thus may not be used when ordered comparisons are required.
8974 This option requires that both @option{-fno-signed-zeros} and
8975 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8976 much sense with @option{-frounding-math}. For Fortran the option
8977 is automatically enabled when both @option{-fno-signed-zeros} and
8978 @option{-fno-trapping-math} are in effect.
8980 The default is @option{-fno-associative-math}.
8982 @item -freciprocal-math
8983 @opindex freciprocal-math
8985 Allow the reciprocal of a value to be used instead of dividing by
8986 the value if this enables optimizations.  For example @code{x / y}
8987 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8988 is subject to common subexpression elimination.  Note that this loses
8989 precision and increases the number of flops operating on the value.
8991 The default is @option{-fno-reciprocal-math}.
8993 @item -ffinite-math-only
8994 @opindex ffinite-math-only
8995 Allow optimizations for floating-point arithmetic that assume
8996 that arguments and results are not NaNs or +-Infs.
8998 This option is not turned on by any @option{-O} option since
8999 it can result in incorrect output for programs that depend on
9000 an exact implementation of IEEE or ISO rules/specifications for
9001 math functions. It may, however, yield faster code for programs
9002 that do not require the guarantees of these specifications.
9004 The default is @option{-fno-finite-math-only}.
9006 @item -fno-signed-zeros
9007 @opindex fno-signed-zeros
9008 Allow optimizations for floating-point arithmetic that ignore the
9009 signedness of zero.  IEEE arithmetic specifies the behavior of
9010 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9011 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9012 This option implies that the sign of a zero result isn't significant.
9014 The default is @option{-fsigned-zeros}.
9016 @item -fno-trapping-math
9017 @opindex fno-trapping-math
9018 Compile code assuming that floating-point operations cannot generate
9019 user-visible traps.  These traps include division by zero, overflow,
9020 underflow, inexact result and invalid operation.  This option requires
9021 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9022 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9024 This option should never be turned on by any @option{-O} option since
9025 it can result in incorrect output for programs that depend on
9026 an exact implementation of IEEE or ISO rules/specifications for
9027 math functions.
9029 The default is @option{-ftrapping-math}.
9031 @item -frounding-math
9032 @opindex frounding-math
9033 Disable transformations and optimizations that assume default floating-point
9034 rounding behavior.  This is round-to-zero for all floating point
9035 to integer conversions, and round-to-nearest for all other arithmetic
9036 truncations.  This option should be specified for programs that change
9037 the FP rounding mode dynamically, or that may be executed with a
9038 non-default rounding mode.  This option disables constant folding of
9039 floating-point expressions at compile time (which may be affected by
9040 rounding mode) and arithmetic transformations that are unsafe in the
9041 presence of sign-dependent rounding modes.
9043 The default is @option{-fno-rounding-math}.
9045 This option is experimental and does not currently guarantee to
9046 disable all GCC optimizations that are affected by rounding mode.
9047 Future versions of GCC may provide finer control of this setting
9048 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9049 will be used to specify the default state for @code{FENV_ACCESS}.
9051 @item -fsignaling-nans
9052 @opindex fsignaling-nans
9053 Compile code assuming that IEEE signaling NaNs may generate user-visible
9054 traps during floating-point operations.  Setting this option disables
9055 optimizations that may change the number of exceptions visible with
9056 signaling NaNs.  This option implies @option{-ftrapping-math}.
9058 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9059 be defined.
9061 The default is @option{-fno-signaling-nans}.
9063 This option is experimental and does not currently guarantee to
9064 disable all GCC optimizations that affect signaling NaN behavior.
9066 @item -fsingle-precision-constant
9067 @opindex fsingle-precision-constant
9068 Treat floating-point constants as single precision instead of
9069 implicitly converting them to double-precision constants.
9071 @item -fcx-limited-range
9072 @opindex fcx-limited-range
9073 When enabled, this option states that a range reduction step is not
9074 needed when performing complex division.  Also, there is no checking
9075 whether the result of a complex multiplication or division is @code{NaN
9076 + I*NaN}, with an attempt to rescue the situation in that case.  The
9077 default is @option{-fno-cx-limited-range}, but is enabled by
9078 @option{-ffast-math}.
9080 This option controls the default setting of the ISO C99
9081 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9082 all languages.
9084 @item -fcx-fortran-rules
9085 @opindex fcx-fortran-rules
9086 Complex multiplication and division follow Fortran rules.  Range
9087 reduction is done as part of complex division, but there is no checking
9088 whether the result of a complex multiplication or division is @code{NaN
9089 + I*NaN}, with an attempt to rescue the situation in that case.
9091 The default is @option{-fno-cx-fortran-rules}.
9093 @end table
9095 The following options control optimizations that may improve
9096 performance, but are not enabled by any @option{-O} options.  This
9097 section includes experimental options that may produce broken code.
9099 @table @gcctabopt
9100 @item -fbranch-probabilities
9101 @opindex fbranch-probabilities
9102 After running a program compiled with @option{-fprofile-arcs}
9103 (@pxref{Debugging Options,, Options for Debugging Your Program or
9104 @command{gcc}}), you can compile it a second time using
9105 @option{-fbranch-probabilities}, to improve optimizations based on
9106 the number of times each branch was taken.  When a program
9107 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9108 counts to a file called @file{@var{sourcename}.gcda} for each source
9109 file.  The information in this data file is very dependent on the
9110 structure of the generated code, so you must use the same source code
9111 and the same optimization options for both compilations.
9113 With @option{-fbranch-probabilities}, GCC puts a
9114 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9115 These can be used to improve optimization.  Currently, they are only
9116 used in one place: in @file{reorg.c}, instead of guessing which path a
9117 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9118 exactly determine which path is taken more often.
9120 @item -fprofile-values
9121 @opindex fprofile-values
9122 If combined with @option{-fprofile-arcs}, it adds code so that some
9123 data about values of expressions in the program is gathered.
9125 With @option{-fbranch-probabilities}, it reads back the data gathered
9126 from profiling values of expressions for usage in optimizations.
9128 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9130 @item -fprofile-reorder-functions
9131 @opindex fprofile-reorder-functions
9132 Function reordering based on profile instrumentation collects
9133 first time of execution of a function and orders these functions
9134 in ascending order.
9136 Enabled with @option{-fprofile-use}.
9138 @item -fvpt
9139 @opindex fvpt
9140 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9141 to add code to gather information about values of expressions.
9143 With @option{-fbranch-probabilities}, it reads back the data gathered
9144 and actually performs the optimizations based on them.
9145 Currently the optimizations include specialization of division operations
9146 using the knowledge about the value of the denominator.
9148 @item -frename-registers
9149 @opindex frename-registers
9150 Attempt to avoid false dependencies in scheduled code by making use
9151 of registers left over after register allocation.  This optimization
9152 most benefits processors with lots of registers.  Depending on the
9153 debug information format adopted by the target, however, it can
9154 make debugging impossible, since variables no longer stay in
9155 a ``home register''.
9157 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9159 @item -ftracer
9160 @opindex ftracer
9161 Perform tail duplication to enlarge superblock size.  This transformation
9162 simplifies the control flow of the function allowing other optimizations to do
9163 a better job.
9165 Enabled with @option{-fprofile-use}.
9167 @item -funroll-loops
9168 @opindex funroll-loops
9169 Unroll loops whose number of iterations can be determined at compile time or
9170 upon entry to the loop.  @option{-funroll-loops} implies
9171 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9172 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9173 a small constant number of iterations).  This option makes code larger, and may
9174 or may not make it run faster.
9176 Enabled with @option{-fprofile-use}.
9178 @item -funroll-all-loops
9179 @opindex funroll-all-loops
9180 Unroll all loops, even if their number of iterations is uncertain when
9181 the loop is entered.  This usually makes programs run more slowly.
9182 @option{-funroll-all-loops} implies the same options as
9183 @option{-funroll-loops}.
9185 @item -fpeel-loops
9186 @opindex fpeel-loops
9187 Peels loops for which there is enough information that they do not
9188 roll much (from profile feedback).  It also turns on complete loop peeling
9189 (i.e.@: complete removal of loops with small constant number of iterations).
9191 Enabled with @option{-fprofile-use}.
9193 @item -fmove-loop-invariants
9194 @opindex fmove-loop-invariants
9195 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9196 at level @option{-O1}
9198 @item -funswitch-loops
9199 @opindex funswitch-loops
9200 Move branches with loop invariant conditions out of the loop, with duplicates
9201 of the loop on both branches (modified according to result of the condition).
9203 @item -ffunction-sections
9204 @itemx -fdata-sections
9205 @opindex ffunction-sections
9206 @opindex fdata-sections
9207 Place each function or data item into its own section in the output
9208 file if the target supports arbitrary sections.  The name of the
9209 function or the name of the data item determines the section's name
9210 in the output file.
9212 Use these options on systems where the linker can perform optimizations
9213 to improve locality of reference in the instruction space.  Most systems
9214 using the ELF object format and SPARC processors running Solaris 2 have
9215 linkers with such optimizations.  AIX may have these optimizations in
9216 the future.
9218 Only use these options when there are significant benefits from doing
9219 so.  When you specify these options, the assembler and linker
9220 create larger object and executable files and are also slower.
9221 You cannot use @code{gprof} on all systems if you
9222 specify this option, and you may have problems with debugging if
9223 you specify both this option and @option{-g}.
9225 @item -fbranch-target-load-optimize
9226 @opindex fbranch-target-load-optimize
9227 Perform branch target register load optimization before prologue / epilogue
9228 threading.
9229 The use of target registers can typically be exposed only during reload,
9230 thus hoisting loads out of loops and doing inter-block scheduling needs
9231 a separate optimization pass.
9233 @item -fbranch-target-load-optimize2
9234 @opindex fbranch-target-load-optimize2
9235 Perform branch target register load optimization after prologue / epilogue
9236 threading.
9238 @item -fbtr-bb-exclusive
9239 @opindex fbtr-bb-exclusive
9240 When performing branch target register load optimization, don't reuse
9241 branch target registers within any basic block.
9243 @item -fstack-protector
9244 @opindex fstack-protector
9245 Emit extra code to check for buffer overflows, such as stack smashing
9246 attacks.  This is done by adding a guard variable to functions with
9247 vulnerable objects.  This includes functions that call @code{alloca}, and
9248 functions with buffers larger than 8 bytes.  The guards are initialized
9249 when a function is entered and then checked when the function exits.
9250 If a guard check fails, an error message is printed and the program exits.
9252 @item -fstack-protector-all
9253 @opindex fstack-protector-all
9254 Like @option{-fstack-protector} except that all functions are protected.
9256 @item -fstack-protector-strong
9257 @opindex fstack-protector-strong
9258 Like @option{-fstack-protector} but includes additional functions to
9259 be protected --- those that have local array definitions, or have
9260 references to local frame addresses.
9262 @item -fsection-anchors
9263 @opindex fsection-anchors
9264 Try to reduce the number of symbolic address calculations by using
9265 shared ``anchor'' symbols to address nearby objects.  This transformation
9266 can help to reduce the number of GOT entries and GOT accesses on some
9267 targets.
9269 For example, the implementation of the following function @code{foo}:
9271 @smallexample
9272 static int a, b, c;
9273 int foo (void) @{ return a + b + c; @}
9274 @end smallexample
9276 @noindent
9277 usually calculates the addresses of all three variables, but if you
9278 compile it with @option{-fsection-anchors}, it accesses the variables
9279 from a common anchor point instead.  The effect is similar to the
9280 following pseudocode (which isn't valid C):
9282 @smallexample
9283 int foo (void)
9285   register int *xr = &x;
9286   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9288 @end smallexample
9290 Not all targets support this option.
9292 @item --param @var{name}=@var{value}
9293 @opindex param
9294 In some places, GCC uses various constants to control the amount of
9295 optimization that is done.  For example, GCC does not inline functions
9296 that contain more than a certain number of instructions.  You can
9297 control some of these constants on the command line using the
9298 @option{--param} option.
9300 The names of specific parameters, and the meaning of the values, are
9301 tied to the internals of the compiler, and are subject to change
9302 without notice in future releases.
9304 In each case, the @var{value} is an integer.  The allowable choices for
9305 @var{name} are:
9307 @table @gcctabopt
9308 @item predictable-branch-outcome
9309 When branch is predicted to be taken with probability lower than this threshold
9310 (in percent), then it is considered well predictable. The default is 10.
9312 @item max-crossjump-edges
9313 The maximum number of incoming edges to consider for cross-jumping.
9314 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9315 the number of edges incoming to each block.  Increasing values mean
9316 more aggressive optimization, making the compilation time increase with
9317 probably small improvement in executable size.
9319 @item min-crossjump-insns
9320 The minimum number of instructions that must be matched at the end
9321 of two blocks before cross-jumping is performed on them.  This
9322 value is ignored in the case where all instructions in the block being
9323 cross-jumped from are matched.  The default value is 5.
9325 @item max-grow-copy-bb-insns
9326 The maximum code size expansion factor when copying basic blocks
9327 instead of jumping.  The expansion is relative to a jump instruction.
9328 The default value is 8.
9330 @item max-goto-duplication-insns
9331 The maximum number of instructions to duplicate to a block that jumps
9332 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9333 passes, GCC factors computed gotos early in the compilation process,
9334 and unfactors them as late as possible.  Only computed jumps at the
9335 end of a basic blocks with no more than max-goto-duplication-insns are
9336 unfactored.  The default value is 8.
9338 @item max-delay-slot-insn-search
9339 The maximum number of instructions to consider when looking for an
9340 instruction to fill a delay slot.  If more than this arbitrary number of
9341 instructions are searched, the time savings from filling the delay slot
9342 are minimal, so stop searching.  Increasing values mean more
9343 aggressive optimization, making the compilation time increase with probably
9344 small improvement in execution time.
9346 @item max-delay-slot-live-search
9347 When trying to fill delay slots, the maximum number of instructions to
9348 consider when searching for a block with valid live register
9349 information.  Increasing this arbitrarily chosen value means more
9350 aggressive optimization, increasing the compilation time.  This parameter
9351 should be removed when the delay slot code is rewritten to maintain the
9352 control-flow graph.
9354 @item max-gcse-memory
9355 The approximate maximum amount of memory that can be allocated in
9356 order to perform the global common subexpression elimination
9357 optimization.  If more memory than specified is required, the
9358 optimization is not done.
9360 @item max-gcse-insertion-ratio
9361 If the ratio of expression insertions to deletions is larger than this value
9362 for any expression, then RTL PRE inserts or removes the expression and thus
9363 leaves partially redundant computations in the instruction stream.  The default value is 20.
9365 @item max-pending-list-length
9366 The maximum number of pending dependencies scheduling allows
9367 before flushing the current state and starting over.  Large functions
9368 with few branches or calls can create excessively large lists which
9369 needlessly consume memory and resources.
9371 @item max-modulo-backtrack-attempts
9372 The maximum number of backtrack attempts the scheduler should make
9373 when modulo scheduling a loop.  Larger values can exponentially increase
9374 compilation time.
9376 @item max-inline-insns-single
9377 Several parameters control the tree inliner used in GCC@.
9378 This number sets the maximum number of instructions (counted in GCC's
9379 internal representation) in a single function that the tree inliner
9380 considers for inlining.  This only affects functions declared
9381 inline and methods implemented in a class declaration (C++).
9382 The default value is 400.
9384 @item max-inline-insns-auto
9385 When you use @option{-finline-functions} (included in @option{-O3}),
9386 a lot of functions that would otherwise not be considered for inlining
9387 by the compiler are investigated.  To those functions, a different
9388 (more restrictive) limit compared to functions declared inline can
9389 be applied.
9390 The default value is 40.
9392 @item inline-min-speedup
9393 When estimated performance improvement of caller + callee runtime exceeds this
9394 threshold (in precent), the function can be inlined regardless the limit on
9395 @option{--param max-inline-insns-single} and @option{--param
9396 max-inline-insns-auto}.
9398 @item large-function-insns
9399 The limit specifying really large functions.  For functions larger than this
9400 limit after inlining, inlining is constrained by
9401 @option{--param large-function-growth}.  This parameter is useful primarily
9402 to avoid extreme compilation time caused by non-linear algorithms used by the
9403 back end.
9404 The default value is 2700.
9406 @item large-function-growth
9407 Specifies maximal growth of large function caused by inlining in percents.
9408 The default value is 100 which limits large function growth to 2.0 times
9409 the original size.
9411 @item large-unit-insns
9412 The limit specifying large translation unit.  Growth caused by inlining of
9413 units larger than this limit is limited by @option{--param inline-unit-growth}.
9414 For small units this might be too tight.
9415 For example, consider a unit consisting of function A
9416 that is inline and B that just calls A three times.  If B is small relative to
9417 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9418 large units consisting of small inlineable functions, however, the overall unit
9419 growth limit is needed to avoid exponential explosion of code size.  Thus for
9420 smaller units, the size is increased to @option{--param large-unit-insns}
9421 before applying @option{--param inline-unit-growth}.  The default is 10000.
9423 @item inline-unit-growth
9424 Specifies maximal overall growth of the compilation unit caused by inlining.
9425 The default value is 30 which limits unit growth to 1.3 times the original
9426 size.
9428 @item ipcp-unit-growth
9429 Specifies maximal overall growth of the compilation unit caused by
9430 interprocedural constant propagation.  The default value is 10 which limits
9431 unit growth to 1.1 times the original size.
9433 @item large-stack-frame
9434 The limit specifying large stack frames.  While inlining the algorithm is trying
9435 to not grow past this limit too much.  The default value is 256 bytes.
9437 @item large-stack-frame-growth
9438 Specifies maximal growth of large stack frames caused by inlining in percents.
9439 The default value is 1000 which limits large stack frame growth to 11 times
9440 the original size.
9442 @item max-inline-insns-recursive
9443 @itemx max-inline-insns-recursive-auto
9444 Specifies the maximum number of instructions an out-of-line copy of a
9445 self-recursive inline
9446 function can grow into by performing recursive inlining.
9448 For functions declared inline, @option{--param max-inline-insns-recursive} is
9449 taken into account.  For functions not declared inline, recursive inlining
9450 happens only when @option{-finline-functions} (included in @option{-O3}) is
9451 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9452 default value is 450.
9454 @item max-inline-recursive-depth
9455 @itemx max-inline-recursive-depth-auto
9456 Specifies the maximum recursion depth used for recursive inlining.
9458 For functions declared inline, @option{--param max-inline-recursive-depth} is
9459 taken into account.  For functions not declared inline, recursive inlining
9460 happens only when @option{-finline-functions} (included in @option{-O3}) is
9461 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9462 default value is 8.
9464 @item min-inline-recursive-probability
9465 Recursive inlining is profitable only for function having deep recursion
9466 in average and can hurt for function having little recursion depth by
9467 increasing the prologue size or complexity of function body to other
9468 optimizers.
9470 When profile feedback is available (see @option{-fprofile-generate}) the actual
9471 recursion depth can be guessed from probability that function recurses via a
9472 given call expression.  This parameter limits inlining only to call expressions
9473 whose probability exceeds the given threshold (in percents).
9474 The default value is 10.
9476 @item early-inlining-insns
9477 Specify growth that the early inliner can make.  In effect it increases
9478 the amount of inlining for code having a large abstraction penalty.
9479 The default value is 10.
9481 @item max-early-inliner-iterations
9482 @itemx max-early-inliner-iterations
9483 Limit of iterations of the early inliner.  This basically bounds
9484 the number of nested indirect calls the early inliner can resolve.
9485 Deeper chains are still handled by late inlining.
9487 @item comdat-sharing-probability
9488 @itemx comdat-sharing-probability
9489 Probability (in percent) that C++ inline function with comdat visibility
9490 are shared across multiple compilation units.  The default value is 20.
9492 @item min-vect-loop-bound
9493 The minimum number of iterations under which loops are not vectorized
9494 when @option{-ftree-vectorize} is used.  The number of iterations after
9495 vectorization needs to be greater than the value specified by this option
9496 to allow vectorization.  The default value is 0.
9498 @item gcse-cost-distance-ratio
9499 Scaling factor in calculation of maximum distance an expression
9500 can be moved by GCSE optimizations.  This is currently supported only in the
9501 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9502 is with simple expressions, i.e., the expressions that have cost
9503 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9504 hoisting of simple expressions.  The default value is 10.
9506 @item gcse-unrestricted-cost
9507 Cost, roughly measured as the cost of a single typical machine
9508 instruction, at which GCSE optimizations do not constrain
9509 the distance an expression can travel.  This is currently
9510 supported only in the code hoisting pass.  The lesser the cost,
9511 the more aggressive code hoisting is.  Specifying 0 
9512 allows all expressions to travel unrestricted distances.
9513 The default value is 3.
9515 @item max-hoist-depth
9516 The depth of search in the dominator tree for expressions to hoist.
9517 This is used to avoid quadratic behavior in hoisting algorithm.
9518 The value of 0 does not limit on the search, but may slow down compilation
9519 of huge functions.  The default value is 30.
9521 @item max-tail-merge-comparisons
9522 The maximum amount of similar bbs to compare a bb with.  This is used to
9523 avoid quadratic behavior in tree tail merging.  The default value is 10.
9525 @item max-tail-merge-iterations
9526 The maximum amount of iterations of the pass over the function.  This is used to
9527 limit compilation time in tree tail merging.  The default value is 2.
9529 @item max-unrolled-insns
9530 The maximum number of instructions that a loop may have to be unrolled.
9531 If a loop is unrolled, this parameter also determines how many times
9532 the loop code is unrolled.
9534 @item max-average-unrolled-insns
9535 The maximum number of instructions biased by probabilities of their execution
9536 that a loop may have to be unrolled.  If a loop is unrolled,
9537 this parameter also determines how many times the loop code is unrolled.
9539 @item max-unroll-times
9540 The maximum number of unrollings of a single loop.
9542 @item max-peeled-insns
9543 The maximum number of instructions that a loop may have to be peeled.
9544 If a loop is peeled, this parameter also determines how many times
9545 the loop code is peeled.
9547 @item max-peel-times
9548 The maximum number of peelings of a single loop.
9550 @item max-peel-branches
9551 The maximum number of branches on the hot path through the peeled sequence.
9553 @item max-completely-peeled-insns
9554 The maximum number of insns of a completely peeled loop.
9556 @item max-completely-peel-times
9557 The maximum number of iterations of a loop to be suitable for complete peeling.
9559 @item max-completely-peel-loop-nest-depth
9560 The maximum depth of a loop nest suitable for complete peeling.
9562 @item max-unswitch-insns
9563 The maximum number of insns of an unswitched loop.
9565 @item max-unswitch-level
9566 The maximum number of branches unswitched in a single loop.
9568 @item lim-expensive
9569 The minimum cost of an expensive expression in the loop invariant motion.
9571 @item iv-consider-all-candidates-bound
9572 Bound on number of candidates for induction variables, below which
9573 all candidates are considered for each use in induction variable
9574 optimizations.  If there are more candidates than this,
9575 only the most relevant ones are considered to avoid quadratic time complexity.
9577 @item iv-max-considered-uses
9578 The induction variable optimizations give up on loops that contain more
9579 induction variable uses.
9581 @item iv-always-prune-cand-set-bound
9582 If the number of candidates in the set is smaller than this value,
9583 always try to remove unnecessary ivs from the set
9584 when adding a new one.
9586 @item scev-max-expr-size
9587 Bound on size of expressions used in the scalar evolutions analyzer.
9588 Large expressions slow the analyzer.
9590 @item scev-max-expr-complexity
9591 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9592 Complex expressions slow the analyzer.
9594 @item omega-max-vars
9595 The maximum number of variables in an Omega constraint system.
9596 The default value is 128.
9598 @item omega-max-geqs
9599 The maximum number of inequalities in an Omega constraint system.
9600 The default value is 256.
9602 @item omega-max-eqs
9603 The maximum number of equalities in an Omega constraint system.
9604 The default value is 128.
9606 @item omega-max-wild-cards
9607 The maximum number of wildcard variables that the Omega solver is
9608 able to insert.  The default value is 18.
9610 @item omega-hash-table-size
9611 The size of the hash table in the Omega solver.  The default value is
9612 550.
9614 @item omega-max-keys
9615 The maximal number of keys used by the Omega solver.  The default
9616 value is 500.
9618 @item omega-eliminate-redundant-constraints
9619 When set to 1, use expensive methods to eliminate all redundant
9620 constraints.  The default value is 0.
9622 @item vect-max-version-for-alignment-checks
9623 The maximum number of run-time checks that can be performed when
9624 doing loop versioning for alignment in the vectorizer. 
9626 @item vect-max-version-for-alias-checks
9627 The maximum number of run-time checks that can be performed when
9628 doing loop versioning for alias in the vectorizer. 
9630 @item vect-max-peeling-for-alignment
9631 The maximum number of loop peels to enhance access alignment
9632 for vectorizer. Value -1 means 'no limit'.
9634 @item max-iterations-to-track
9635 The maximum number of iterations of a loop the brute-force algorithm
9636 for analysis of the number of iterations of the loop tries to evaluate.
9638 @item hot-bb-count-ws-permille
9639 A basic block profile count is considered hot if it contributes to 
9640 the given permillage (i.e. 0...1000) of the entire profiled execution.
9642 @item hot-bb-frequency-fraction
9643 Select fraction of the entry block frequency of executions of basic block in
9644 function given basic block needs to have to be considered hot.
9646 @item max-predicted-iterations
9647 The maximum number of loop iterations we predict statically.  This is useful
9648 in cases where a function contains a single loop with known bound and
9649 another loop with unknown bound.
9650 The known number of iterations is predicted correctly, while
9651 the unknown number of iterations average to roughly 10.  This means that the
9652 loop without bounds appears artificially cold relative to the other one.
9654 @item builtin-expect-probability
9655 Control the probability of the expression having the specified value. This
9656 parameter takes a percentage (i.e. 0 ... 100) as input.
9657 The default probability of 90 is obtained empirically.
9659 @item align-threshold
9661 Select fraction of the maximal frequency of executions of a basic block in
9662 a function to align the basic block.
9664 @item align-loop-iterations
9666 A loop expected to iterate at least the selected number of iterations is
9667 aligned.
9669 @item tracer-dynamic-coverage
9670 @itemx tracer-dynamic-coverage-feedback
9672 This value is used to limit superblock formation once the given percentage of
9673 executed instructions is covered.  This limits unnecessary code size
9674 expansion.
9676 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9677 feedback is available.  The real profiles (as opposed to statically estimated
9678 ones) are much less balanced allowing the threshold to be larger value.
9680 @item tracer-max-code-growth
9681 Stop tail duplication once code growth has reached given percentage.  This is
9682 a rather artificial limit, as most of the duplicates are eliminated later in
9683 cross jumping, so it may be set to much higher values than is the desired code
9684 growth.
9686 @item tracer-min-branch-ratio
9688 Stop reverse growth when the reverse probability of best edge is less than this
9689 threshold (in percent).
9691 @item tracer-min-branch-ratio
9692 @itemx tracer-min-branch-ratio-feedback
9694 Stop forward growth if the best edge has probability lower than this
9695 threshold.
9697 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9698 compilation for profile feedback and one for compilation without.  The value
9699 for compilation with profile feedback needs to be more conservative (higher) in
9700 order to make tracer effective.
9702 @item max-cse-path-length
9704 The maximum number of basic blocks on path that CSE considers.
9705 The default is 10.
9707 @item max-cse-insns
9708 The maximum number of instructions CSE processes before flushing.
9709 The default is 1000.
9711 @item ggc-min-expand
9713 GCC uses a garbage collector to manage its own memory allocation.  This
9714 parameter specifies the minimum percentage by which the garbage
9715 collector's heap should be allowed to expand between collections.
9716 Tuning this may improve compilation speed; it has no effect on code
9717 generation.
9719 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9720 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9721 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9722 GCC is not able to calculate RAM on a particular platform, the lower
9723 bound of 30% is used.  Setting this parameter and
9724 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9725 every opportunity.  This is extremely slow, but can be useful for
9726 debugging.
9728 @item ggc-min-heapsize
9730 Minimum size of the garbage collector's heap before it begins bothering
9731 to collect garbage.  The first collection occurs after the heap expands
9732 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9733 tuning this may improve compilation speed, and has no effect on code
9734 generation.
9736 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9737 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9738 with a lower bound of 4096 (four megabytes) and an upper bound of
9739 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9740 particular platform, the lower bound is used.  Setting this parameter
9741 very large effectively disables garbage collection.  Setting this
9742 parameter and @option{ggc-min-expand} to zero causes a full collection
9743 to occur at every opportunity.
9745 @item max-reload-search-insns
9746 The maximum number of instruction reload should look backward for equivalent
9747 register.  Increasing values mean more aggressive optimization, making the
9748 compilation time increase with probably slightly better performance.
9749 The default value is 100.
9751 @item max-cselib-memory-locations
9752 The maximum number of memory locations cselib should take into account.
9753 Increasing values mean more aggressive optimization, making the compilation time
9754 increase with probably slightly better performance.  The default value is 500.
9756 @item reorder-blocks-duplicate
9757 @itemx reorder-blocks-duplicate-feedback
9759 Used by the basic block reordering pass to decide whether to use unconditional
9760 branch or duplicate the code on its destination.  Code is duplicated when its
9761 estimated size is smaller than this value multiplied by the estimated size of
9762 unconditional jump in the hot spots of the program.
9764 The @option{reorder-block-duplicate-feedback} is used only when profile
9765 feedback is available.  It may be set to higher values than
9766 @option{reorder-block-duplicate} since information about the hot spots is more
9767 accurate.
9769 @item max-sched-ready-insns
9770 The maximum number of instructions ready to be issued the scheduler should
9771 consider at any given time during the first scheduling pass.  Increasing
9772 values mean more thorough searches, making the compilation time increase
9773 with probably little benefit.  The default value is 100.
9775 @item max-sched-region-blocks
9776 The maximum number of blocks in a region to be considered for
9777 interblock scheduling.  The default value is 10.
9779 @item max-pipeline-region-blocks
9780 The maximum number of blocks in a region to be considered for
9781 pipelining in the selective scheduler.  The default value is 15.
9783 @item max-sched-region-insns
9784 The maximum number of insns in a region to be considered for
9785 interblock scheduling.  The default value is 100.
9787 @item max-pipeline-region-insns
9788 The maximum number of insns in a region to be considered for
9789 pipelining in the selective scheduler.  The default value is 200.
9791 @item min-spec-prob
9792 The minimum probability (in percents) of reaching a source block
9793 for interblock speculative scheduling.  The default value is 40.
9795 @item max-sched-extend-regions-iters
9796 The maximum number of iterations through CFG to extend regions.
9797 A value of 0 (the default) disables region extensions.
9799 @item max-sched-insn-conflict-delay
9800 The maximum conflict delay for an insn to be considered for speculative motion.
9801 The default value is 3.
9803 @item sched-spec-prob-cutoff
9804 The minimal probability of speculation success (in percents), so that
9805 speculative insns are scheduled.
9806 The default value is 40.
9808 @item sched-spec-state-edge-prob-cutoff
9809 The minimum probability an edge must have for the scheduler to save its
9810 state across it.
9811 The default value is 10.
9813 @item sched-mem-true-dep-cost
9814 Minimal distance (in CPU cycles) between store and load targeting same
9815 memory locations.  The default value is 1.
9817 @item selsched-max-lookahead
9818 The maximum size of the lookahead window of selective scheduling.  It is a
9819 depth of search for available instructions.
9820 The default value is 50.
9822 @item selsched-max-sched-times
9823 The maximum number of times that an instruction is scheduled during
9824 selective scheduling.  This is the limit on the number of iterations
9825 through which the instruction may be pipelined.  The default value is 2.
9827 @item selsched-max-insns-to-rename
9828 The maximum number of best instructions in the ready list that are considered
9829 for renaming in the selective scheduler.  The default value is 2.
9831 @item sms-min-sc
9832 The minimum value of stage count that swing modulo scheduler
9833 generates.  The default value is 2.
9835 @item max-last-value-rtl
9836 The maximum size measured as number of RTLs that can be recorded in an expression
9837 in combiner for a pseudo register as last known value of that register.  The default
9838 is 10000.
9840 @item integer-share-limit
9841 Small integer constants can use a shared data structure, reducing the
9842 compiler's memory usage and increasing its speed.  This sets the maximum
9843 value of a shared integer constant.  The default value is 256.
9845 @item ssp-buffer-size
9846 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9847 protection when @option{-fstack-protection} is used.
9849 @item min-size-for-stack-sharing
9850 The minimum size of variables taking part in stack slot sharing when not
9851 optimizing. The default value is 32.
9853 @item max-jump-thread-duplication-stmts
9854 Maximum number of statements allowed in a block that needs to be
9855 duplicated when threading jumps.
9857 @item max-fields-for-field-sensitive
9858 Maximum number of fields in a structure treated in
9859 a field sensitive manner during pointer analysis.  The default is zero
9860 for @option{-O0} and @option{-O1},
9861 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9863 @item prefetch-latency
9864 Estimate on average number of instructions that are executed before
9865 prefetch finishes.  The distance prefetched ahead is proportional
9866 to this constant.  Increasing this number may also lead to less
9867 streams being prefetched (see @option{simultaneous-prefetches}).
9869 @item simultaneous-prefetches
9870 Maximum number of prefetches that can run at the same time.
9872 @item l1-cache-line-size
9873 The size of cache line in L1 cache, in bytes.
9875 @item l1-cache-size
9876 The size of L1 cache, in kilobytes.
9878 @item l2-cache-size
9879 The size of L2 cache, in kilobytes.
9881 @item min-insn-to-prefetch-ratio
9882 The minimum ratio between the number of instructions and the
9883 number of prefetches to enable prefetching in a loop.
9885 @item prefetch-min-insn-to-mem-ratio
9886 The minimum ratio between the number of instructions and the
9887 number of memory references to enable prefetching in a loop.
9889 @item use-canonical-types
9890 Whether the compiler should use the ``canonical'' type system.  By
9891 default, this should always be 1, which uses a more efficient internal
9892 mechanism for comparing types in C++ and Objective-C++.  However, if
9893 bugs in the canonical type system are causing compilation failures,
9894 set this value to 0 to disable canonical types.
9896 @item switch-conversion-max-branch-ratio
9897 Switch initialization conversion refuses to create arrays that are
9898 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9899 branches in the switch.
9901 @item max-partial-antic-length
9902 Maximum length of the partial antic set computed during the tree
9903 partial redundancy elimination optimization (@option{-ftree-pre}) when
9904 optimizing at @option{-O3} and above.  For some sorts of source code
9905 the enhanced partial redundancy elimination optimization can run away,
9906 consuming all of the memory available on the host machine.  This
9907 parameter sets a limit on the length of the sets that are computed,
9908 which prevents the runaway behavior.  Setting a value of 0 for
9909 this parameter allows an unlimited set length.
9911 @item sccvn-max-scc-size
9912 Maximum size of a strongly connected component (SCC) during SCCVN
9913 processing.  If this limit is hit, SCCVN processing for the whole
9914 function is not done and optimizations depending on it are
9915 disabled.  The default maximum SCC size is 10000.
9917 @item sccvn-max-alias-queries-per-access
9918 Maximum number of alias-oracle queries we perform when looking for
9919 redundancies for loads and stores.  If this limit is hit the search
9920 is aborted and the load or store is not considered redundant.  The
9921 number of queries is algorithmically limited to the number of
9922 stores on all paths from the load to the function entry.
9923 The default maxmimum number of queries is 1000.
9925 @item ira-max-loops-num
9926 IRA uses regional register allocation by default.  If a function
9927 contains more loops than the number given by this parameter, only at most
9928 the given number of the most frequently-executed loops form regions
9929 for regional register allocation.  The default value of the
9930 parameter is 100.
9932 @item ira-max-conflict-table-size 
9933 Although IRA uses a sophisticated algorithm to compress the conflict
9934 table, the table can still require excessive amounts of memory for
9935 huge functions.  If the conflict table for a function could be more
9936 than the size in MB given by this parameter, the register allocator
9937 instead uses a faster, simpler, and lower-quality
9938 algorithm that does not require building a pseudo-register conflict table.  
9939 The default value of the parameter is 2000.
9941 @item ira-loop-reserved-regs
9942 IRA can be used to evaluate more accurate register pressure in loops
9943 for decisions to move loop invariants (see @option{-O3}).  The number
9944 of available registers reserved for some other purposes is given
9945 by this parameter.  The default value of the parameter is 2, which is
9946 the minimal number of registers needed by typical instructions.
9947 This value is the best found from numerous experiments.
9949 @item loop-invariant-max-bbs-in-loop
9950 Loop invariant motion can be very expensive, both in compilation time and
9951 in amount of needed compile-time memory, with very large loops.  Loops
9952 with more basic blocks than this parameter won't have loop invariant
9953 motion optimization performed on them.  The default value of the
9954 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9956 @item loop-max-datarefs-for-datadeps
9957 Building data dapendencies is expensive for very large loops.  This
9958 parameter limits the number of data references in loops that are
9959 considered for data dependence analysis.  These large loops are no
9960 handled by the optimizations using loop data dependencies.
9961 The default value is 1000.
9963 @item max-vartrack-size
9964 Sets a maximum number of hash table slots to use during variable
9965 tracking dataflow analysis of any function.  If this limit is exceeded
9966 with variable tracking at assignments enabled, analysis for that
9967 function is retried without it, after removing all debug insns from
9968 the function.  If the limit is exceeded even without debug insns, var
9969 tracking analysis is completely disabled for the function.  Setting
9970 the parameter to zero makes it unlimited.
9972 @item max-vartrack-expr-depth
9973 Sets a maximum number of recursion levels when attempting to map
9974 variable names or debug temporaries to value expressions.  This trades
9975 compilation time for more complete debug information.  If this is set too
9976 low, value expressions that are available and could be represented in
9977 debug information may end up not being used; setting this higher may
9978 enable the compiler to find more complex debug expressions, but compile
9979 time and memory use may grow.  The default is 12.
9981 @item min-nondebug-insn-uid
9982 Use uids starting at this parameter for nondebug insns.  The range below
9983 the parameter is reserved exclusively for debug insns created by
9984 @option{-fvar-tracking-assignments}, but debug insns may get
9985 (non-overlapping) uids above it if the reserved range is exhausted.
9987 @item ipa-sra-ptr-growth-factor
9988 IPA-SRA replaces a pointer to an aggregate with one or more new
9989 parameters only when their cumulative size is less or equal to
9990 @option{ipa-sra-ptr-growth-factor} times the size of the original
9991 pointer parameter.
9993 @item tm-max-aggregate-size
9994 When making copies of thread-local variables in a transaction, this
9995 parameter specifies the size in bytes after which variables are
9996 saved with the logging functions as opposed to save/restore code
9997 sequence pairs.  This option only applies when using
9998 @option{-fgnu-tm}.
10000 @item graphite-max-nb-scop-params
10001 To avoid exponential effects in the Graphite loop transforms, the
10002 number of parameters in a Static Control Part (SCoP) is bounded.  The
10003 default value is 10 parameters.  A variable whose value is unknown at
10004 compilation time and defined outside a SCoP is a parameter of the SCoP.
10006 @item graphite-max-bbs-per-function
10007 To avoid exponential effects in the detection of SCoPs, the size of
10008 the functions analyzed by Graphite is bounded.  The default value is
10009 100 basic blocks.
10011 @item loop-block-tile-size
10012 Loop blocking or strip mining transforms, enabled with
10013 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10014 loop in the loop nest by a given number of iterations.  The strip
10015 length can be changed using the @option{loop-block-tile-size}
10016 parameter.  The default value is 51 iterations.
10018 @item ipa-cp-value-list-size
10019 IPA-CP attempts to track all possible values and types passed to a function's
10020 parameter in order to propagate them and perform devirtualization.
10021 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10022 stores per one formal parameter of a function.
10024 @item ipa-cp-eval-threshold
10025 IPA-CP calculates its own score of cloning profitability heuristics
10026 and performs those cloning opportunities with scores that exceed
10027 @option{ipa-cp-eval-threshold}.
10029 @item ipa-max-agg-items
10030 IPA-CP is also capable to propagate a number of scalar values passed
10031 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10032 number of such values per one parameter.
10034 @item ipa-cp-loop-hint-bonus
10035 When IPA-CP determines that a cloning candidate would make the number
10036 of iterations of a loop known, it adds a bonus of
10037 @option{ipa-cp-loop-hint-bonus} bonus to the profitability score of
10038 the candidate.
10040 @item ipa-cp-array-index-hint-bonus
10041 When IPA-CP determines that a cloning candidate would make the index of
10042 an array access known, it adds a bonus of
10043 @option{ipa-cp-array-index-hint-bonus} bonus to the profitability
10044 score of the candidate.
10046 @item lto-partitions
10047 Specify desired number of partitions produced during WHOPR compilation.
10048 The number of partitions should exceed the number of CPUs used for compilation.
10049 The default value is 32.
10051 @item lto-minpartition
10052 Size of minimal partition for WHOPR (in estimated instructions).
10053 This prevents expenses of splitting very small programs into too many
10054 partitions.
10056 @item cxx-max-namespaces-for-diagnostic-help
10057 The maximum number of namespaces to consult for suggestions when C++
10058 name lookup fails for an identifier.  The default is 1000.
10060 @item sink-frequency-threshold
10061 The maximum relative execution frequency (in percents) of the target block
10062 relative to a statement's original block to allow statement sinking of a
10063 statement.  Larger numbers result in more aggressive statement sinking.
10064 The default value is 75.  A small positive adjustment is applied for
10065 statements with memory operands as those are even more profitable so sink.
10067 @item max-stores-to-sink
10068 The maximum number of conditional stores paires that can be sunk.  Set to 0
10069 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10070 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10072 @item allow-load-data-races
10073 Allow optimizers to introduce new data races on loads.
10074 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10075 unless implicitly set by the @option{-fmemory-model=} option.
10077 @item allow-store-data-races
10078 Allow optimizers to introduce new data races on stores.
10079 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10080 unless implicitly set by the @option{-fmemory-model=} option.
10082 @item allow-packed-load-data-races
10083 Allow optimizers to introduce new data races on packed data loads.
10084 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10085 unless implicitly set by the @option{-fmemory-model=} option.
10087 @item allow-packed-store-data-races
10088 Allow optimizers to introduce new data races on packed data stores.
10089 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10090 unless implicitly set by the @option{-fmemory-model=} option.
10092 @item case-values-threshold
10093 The smallest number of different values for which it is best to use a
10094 jump-table instead of a tree of conditional branches.  If the value is
10095 0, use the default for the machine.  The default is 0.
10097 @item tree-reassoc-width
10098 Set the maximum number of instructions executed in parallel in
10099 reassociated tree. This parameter overrides target dependent
10100 heuristics used by default if has non zero value.
10102 @item sched-pressure-algorithm
10103 Choose between the two available implementations of
10104 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10105 and is the more likely to prevent instructions from being reordered.
10106 Algorithm 2 was designed to be a compromise between the relatively
10107 conservative approach taken by algorithm 1 and the rather aggressive
10108 approach taken by the default scheduler.  It relies more heavily on
10109 having a regular register file and accurate register pressure classes.
10110 See @file{haifa-sched.c} in the GCC sources for more details.
10112 The default choice depends on the target.
10114 @item max-slsr-cand-scan
10115 Set the maximum number of existing candidates that will be considered when
10116 seeking a basis for a new straight-line strength reduction candidate.
10118 @item asan-globals
10119 Enable buffer overflow detection for global objects.  This kind
10120 of protection is enabled by default if you are using
10121 @option{-fsanitize=address} option.
10122 To disable global objects protection use @option{--param asan-globals=0}.
10124 @item asan-stack
10125 Enable buffer overflow detection for stack objects.  This kind of
10126 protection is enabled by default when using@option{-fsanitize=address}.
10127 To disable stack protection use @option{--param asan-stack=0} option.
10129 @item asan-instrument-reads
10130 Enable buffer overflow detection for memory reads.  This kind of
10131 protection is enabled by default when using @option{-fsanitize=address}.
10132 To disable memory reads protection use
10133 @option{--param asan-instrument-reads=0}.
10135 @item asan-instrument-writes
10136 Enable buffer overflow detection for memory writes.  This kind of
10137 protection is enabled by default when using @option{-fsanitize=address}.
10138 To disable memory writes protection use
10139 @option{--param asan-instrument-writes=0} option.
10141 @item asan-memintrin
10142 Enable detection for built-in functions.  This kind of protection
10143 is enabled by default when using @option{-fsanitize=address}.
10144 To disable built-in functions protection use
10145 @option{--param asan-memintrin=0}.
10147 @item asan-use-after-return
10148 Enable detection of use-after-return.  This kind of protection
10149 is enabled by default when using @option{-fsanitize=address} option.
10150 To disable use-after-return detection use 
10151 @option{--param asan-use-after-return=0}.
10153 @item asan-instrumentation-with-call-threshold
10154 If number of memory accesses in function being instrumented
10155 is greater or equal to this number, use callbacks instead of inline checks.
10156 E.g. to disable inline code use
10157 @option{--param asan-instrumentation-with-call-threshold=0}.
10159 @item max-fsm-thread-path-insns
10160 Maximum number of instructions to copy when duplicating blocks on a
10161 finite state automaton jump thread path.  The default is 100.
10163 @item max-fsm-thread-length
10164 Maximum number of basic blocks on a finite state automaton jump thread
10165 path.  The default is 10.
10167 @item max-fsm-thread-paths
10168 Maximum number of new jump thread paths to create for a finite state
10169 automaton.  The default is 50.
10171 @end table
10172 @end table
10174 @node Preprocessor Options
10175 @section Options Controlling the Preprocessor
10176 @cindex preprocessor options
10177 @cindex options, preprocessor
10179 These options control the C preprocessor, which is run on each C source
10180 file before actual compilation.
10182 If you use the @option{-E} option, nothing is done except preprocessing.
10183 Some of these options make sense only together with @option{-E} because
10184 they cause the preprocessor output to be unsuitable for actual
10185 compilation.
10187 @table @gcctabopt
10188 @item -Wp,@var{option}
10189 @opindex Wp
10190 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10191 and pass @var{option} directly through to the preprocessor.  If
10192 @var{option} contains commas, it is split into multiple options at the
10193 commas.  However, many options are modified, translated or interpreted
10194 by the compiler driver before being passed to the preprocessor, and
10195 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10196 interface is undocumented and subject to change, so whenever possible
10197 you should avoid using @option{-Wp} and let the driver handle the
10198 options instead.
10200 @item -Xpreprocessor @var{option}
10201 @opindex Xpreprocessor
10202 Pass @var{option} as an option to the preprocessor.  You can use this to
10203 supply system-specific preprocessor options that GCC does not 
10204 recognize.
10206 If you want to pass an option that takes an argument, you must use
10207 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10209 @item -no-integrated-cpp
10210 @opindex no-integrated-cpp
10211 Perform preprocessing as a separate pass before compilation.
10212 By default, GCC performs preprocessing as an integrated part of
10213 input tokenization and parsing.
10214 If this option is provided, the appropriate language front end
10215 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10216 and Objective-C, respectively) is instead invoked twice,
10217 once for preprocessing only and once for actual compilation
10218 of the preprocessed input.
10219 This option may be useful in conjunction with the @option{-B} or
10220 @option{-wrapper} options to specify an alternate preprocessor or
10221 perform additional processing of the program source between
10222 normal preprocessing and compilation.
10223 @end table
10225 @include cppopts.texi
10227 @node Assembler Options
10228 @section Passing Options to the Assembler
10230 @c prevent bad page break with this line
10231 You can pass options to the assembler.
10233 @table @gcctabopt
10234 @item -Wa,@var{option}
10235 @opindex Wa
10236 Pass @var{option} as an option to the assembler.  If @var{option}
10237 contains commas, it is split into multiple options at the commas.
10239 @item -Xassembler @var{option}
10240 @opindex Xassembler
10241 Pass @var{option} as an option to the assembler.  You can use this to
10242 supply system-specific assembler options that GCC does not
10243 recognize.
10245 If you want to pass an option that takes an argument, you must use
10246 @option{-Xassembler} twice, once for the option and once for the argument.
10248 @end table
10250 @node Link Options
10251 @section Options for Linking
10252 @cindex link options
10253 @cindex options, linking
10255 These options come into play when the compiler links object files into
10256 an executable output file.  They are meaningless if the compiler is
10257 not doing a link step.
10259 @table @gcctabopt
10260 @cindex file names
10261 @item @var{object-file-name}
10262 A file name that does not end in a special recognized suffix is
10263 considered to name an object file or library.  (Object files are
10264 distinguished from libraries by the linker according to the file
10265 contents.)  If linking is done, these object files are used as input
10266 to the linker.
10268 @item -c
10269 @itemx -S
10270 @itemx -E
10271 @opindex c
10272 @opindex S
10273 @opindex E
10274 If any of these options is used, then the linker is not run, and
10275 object file names should not be used as arguments.  @xref{Overall
10276 Options}.
10278 @cindex Libraries
10279 @item -l@var{library}
10280 @itemx -l @var{library}
10281 @opindex l
10282 Search the library named @var{library} when linking.  (The second
10283 alternative with the library as a separate argument is only for
10284 POSIX compliance and is not recommended.)
10286 It makes a difference where in the command you write this option; the
10287 linker searches and processes libraries and object files in the order they
10288 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10289 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10290 to functions in @samp{z}, those functions may not be loaded.
10292 The linker searches a standard list of directories for the library,
10293 which is actually a file named @file{lib@var{library}.a}.  The linker
10294 then uses this file as if it had been specified precisely by name.
10296 The directories searched include several standard system directories
10297 plus any that you specify with @option{-L}.
10299 Normally the files found this way are library files---archive files
10300 whose members are object files.  The linker handles an archive file by
10301 scanning through it for members which define symbols that have so far
10302 been referenced but not defined.  But if the file that is found is an
10303 ordinary object file, it is linked in the usual fashion.  The only
10304 difference between using an @option{-l} option and specifying a file name
10305 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10306 and searches several directories.
10308 @item -lobjc
10309 @opindex lobjc
10310 You need this special case of the @option{-l} option in order to
10311 link an Objective-C or Objective-C++ program.
10313 @item -nostartfiles
10314 @opindex nostartfiles
10315 Do not use the standard system startup files when linking.
10316 The standard system libraries are used normally, unless @option{-nostdlib}
10317 or @option{-nodefaultlibs} is used.
10319 @item -nodefaultlibs
10320 @opindex nodefaultlibs
10321 Do not use the standard system libraries when linking.
10322 Only the libraries you specify are passed to the linker, and options
10323 specifying linkage of the system libraries, such as @code{-static-libgcc}
10324 or @code{-shared-libgcc}, are ignored.  
10325 The standard startup files are used normally, unless @option{-nostartfiles}
10326 is used.  
10328 The compiler may generate calls to @code{memcmp},
10329 @code{memset}, @code{memcpy} and @code{memmove}.
10330 These entries are usually resolved by entries in
10331 libc.  These entry points should be supplied through some other
10332 mechanism when this option is specified.
10334 @item -nostdlib
10335 @opindex nostdlib
10336 Do not use the standard system startup files or libraries when linking.
10337 No startup files and only the libraries you specify are passed to
10338 the linker, and options specifying linkage of the system libraries, such as
10339 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10341 The compiler may generate calls to @code{memcmp}, @code{memset},
10342 @code{memcpy} and @code{memmove}.
10343 These entries are usually resolved by entries in
10344 libc.  These entry points should be supplied through some other
10345 mechanism when this option is specified.
10347 @cindex @option{-lgcc}, use with @option{-nostdlib}
10348 @cindex @option{-nostdlib} and unresolved references
10349 @cindex unresolved references and @option{-nostdlib}
10350 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10351 @cindex @option{-nodefaultlibs} and unresolved references
10352 @cindex unresolved references and @option{-nodefaultlibs}
10353 One of the standard libraries bypassed by @option{-nostdlib} and
10354 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10355 which GCC uses to overcome shortcomings of particular machines, or special
10356 needs for some languages.
10357 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10358 Collection (GCC) Internals},
10359 for more discussion of @file{libgcc.a}.)
10360 In most cases, you need @file{libgcc.a} even when you want to avoid
10361 other standard libraries.  In other words, when you specify @option{-nostdlib}
10362 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10363 This ensures that you have no unresolved references to internal GCC
10364 library subroutines.
10365 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10366 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10367 GNU Compiler Collection (GCC) Internals}.)
10369 @item -pie
10370 @opindex pie
10371 Produce a position independent executable on targets that support it.
10372 For predictable results, you must also specify the same set of options
10373 used for compilation (@option{-fpie}, @option{-fPIE},
10374 or model suboptions) when you specify this linker option.
10376 @item -rdynamic
10377 @opindex rdynamic
10378 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10379 that support it. This instructs the linker to add all symbols, not
10380 only used ones, to the dynamic symbol table. This option is needed
10381 for some uses of @code{dlopen} or to allow obtaining backtraces
10382 from within a program.
10384 @item -s
10385 @opindex s
10386 Remove all symbol table and relocation information from the executable.
10388 @item -static
10389 @opindex static
10390 On systems that support dynamic linking, this prevents linking with the shared
10391 libraries.  On other systems, this option has no effect.
10393 @item -shared
10394 @opindex shared
10395 Produce a shared object which can then be linked with other objects to
10396 form an executable.  Not all systems support this option.  For predictable
10397 results, you must also specify the same set of options used for compilation
10398 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10399 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10400 needs to build supplementary stub code for constructors to work.  On
10401 multi-libbed systems, @samp{gcc -shared} must select the correct support
10402 libraries to link against.  Failing to supply the correct flags may lead
10403 to subtle defects.  Supplying them in cases where they are not necessary
10404 is innocuous.}
10406 @item -shared-libgcc
10407 @itemx -static-libgcc
10408 @opindex shared-libgcc
10409 @opindex static-libgcc
10410 On systems that provide @file{libgcc} as a shared library, these options
10411 force the use of either the shared or static version, respectively.
10412 If no shared version of @file{libgcc} was built when the compiler was
10413 configured, these options have no effect.
10415 There are several situations in which an application should use the
10416 shared @file{libgcc} instead of the static version.  The most common
10417 of these is when the application wishes to throw and catch exceptions
10418 across different shared libraries.  In that case, each of the libraries
10419 as well as the application itself should use the shared @file{libgcc}.
10421 Therefore, the G++ and GCJ drivers automatically add
10422 @option{-shared-libgcc} whenever you build a shared library or a main
10423 executable, because C++ and Java programs typically use exceptions, so
10424 this is the right thing to do.
10426 If, instead, you use the GCC driver to create shared libraries, you may
10427 find that they are not always linked with the shared @file{libgcc}.
10428 If GCC finds, at its configuration time, that you have a non-GNU linker
10429 or a GNU linker that does not support option @option{--eh-frame-hdr},
10430 it links the shared version of @file{libgcc} into shared libraries
10431 by default.  Otherwise, it takes advantage of the linker and optimizes
10432 away the linking with the shared version of @file{libgcc}, linking with
10433 the static version of libgcc by default.  This allows exceptions to
10434 propagate through such shared libraries, without incurring relocation
10435 costs at library load time.
10437 However, if a library or main executable is supposed to throw or catch
10438 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10439 for the languages used in the program, or using the option
10440 @option{-shared-libgcc}, such that it is linked with the shared
10441 @file{libgcc}.
10443 @item -static-libasan
10444 @opindex static-libasan
10445 When the @option{-fsanitize=address} option is used to link a program,
10446 the GCC driver automatically links against @option{libasan}.  If
10447 @file{libasan} is available as a shared library, and the @option{-static}
10448 option is not used, then this links against the shared version of
10449 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10450 driver to link @file{libasan} statically, without necessarily linking
10451 other libraries statically.
10453 @item -static-libtsan
10454 @opindex static-libtsan
10455 When the @option{-fsanitize=thread} option is used to link a program,
10456 the GCC driver automatically links against @option{libtsan}.  If
10457 @file{libtsan} is available as a shared library, and the @option{-static}
10458 option is not used, then this links against the shared version of
10459 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10460 driver to link @file{libtsan} statically, without necessarily linking
10461 other libraries statically.
10463 @item -static-liblsan
10464 @opindex static-liblsan
10465 When the @option{-fsanitize=leak} option is used to link a program,
10466 the GCC driver automatically links against @option{liblsan}.  If
10467 @file{liblsan} is available as a shared library, and the @option{-static}
10468 option is not used, then this links against the shared version of
10469 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10470 driver to link @file{liblsan} statically, without necessarily linking
10471 other libraries statically.
10473 @item -static-libubsan
10474 @opindex static-libubsan
10475 When the @option{-fsanitize=undefined} option is used to link a program,
10476 the GCC driver automatically links against @option{libubsan}.  If
10477 @file{libubsan} is available as a shared library, and the @option{-static}
10478 option is not used, then this links against the shared version of
10479 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10480 driver to link @file{libubsan} statically, without necessarily linking
10481 other libraries statically.
10483 @item -static-libstdc++
10484 @opindex static-libstdc++
10485 When the @command{g++} program is used to link a C++ program, it
10486 normally automatically links against @option{libstdc++}.  If
10487 @file{libstdc++} is available as a shared library, and the
10488 @option{-static} option is not used, then this links against the
10489 shared version of @file{libstdc++}.  That is normally fine.  However, it
10490 is sometimes useful to freeze the version of @file{libstdc++} used by
10491 the program without going all the way to a fully static link.  The
10492 @option{-static-libstdc++} option directs the @command{g++} driver to
10493 link @file{libstdc++} statically, without necessarily linking other
10494 libraries statically.
10496 @item -symbolic
10497 @opindex symbolic
10498 Bind references to global symbols when building a shared object.  Warn
10499 about any unresolved references (unless overridden by the link editor
10500 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10501 this option.
10503 @item -T @var{script}
10504 @opindex T
10505 @cindex linker script
10506 Use @var{script} as the linker script.  This option is supported by most
10507 systems using the GNU linker.  On some targets, such as bare-board
10508 targets without an operating system, the @option{-T} option may be required
10509 when linking to avoid references to undefined symbols.
10511 @item -Xlinker @var{option}
10512 @opindex Xlinker
10513 Pass @var{option} as an option to the linker.  You can use this to
10514 supply system-specific linker options that GCC does not recognize.
10516 If you want to pass an option that takes a separate argument, you must use
10517 @option{-Xlinker} twice, once for the option and once for the argument.
10518 For example, to pass @option{-assert definitions}, you must write
10519 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10520 @option{-Xlinker "-assert definitions"}, because this passes the entire
10521 string as a single argument, which is not what the linker expects.
10523 When using the GNU linker, it is usually more convenient to pass
10524 arguments to linker options using the @option{@var{option}=@var{value}}
10525 syntax than as separate arguments.  For example, you can specify
10526 @option{-Xlinker -Map=output.map} rather than
10527 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10528 this syntax for command-line options.
10530 @item -Wl,@var{option}
10531 @opindex Wl
10532 Pass @var{option} as an option to the linker.  If @var{option} contains
10533 commas, it is split into multiple options at the commas.  You can use this
10534 syntax to pass an argument to the option.
10535 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10536 linker.  When using the GNU linker, you can also get the same effect with
10537 @option{-Wl,-Map=output.map}.
10539 @item -u @var{symbol}
10540 @opindex u
10541 Pretend the symbol @var{symbol} is undefined, to force linking of
10542 library modules to define it.  You can use @option{-u} multiple times with
10543 different symbols to force loading of additional library modules.
10544 @end table
10546 @node Directory Options
10547 @section Options for Directory Search
10548 @cindex directory options
10549 @cindex options, directory search
10550 @cindex search path
10552 These options specify directories to search for header files, for
10553 libraries and for parts of the compiler:
10555 @table @gcctabopt
10556 @item -I@var{dir}
10557 @opindex I
10558 Add the directory @var{dir} to the head of the list of directories to be
10559 searched for header files.  This can be used to override a system header
10560 file, substituting your own version, since these directories are
10561 searched before the system header file directories.  However, you should
10562 not use this option to add directories that contain vendor-supplied
10563 system header files (use @option{-isystem} for that).  If you use more than
10564 one @option{-I} option, the directories are scanned in left-to-right
10565 order; the standard system directories come after.
10567 If a standard system include directory, or a directory specified with
10568 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10569 option is ignored.  The directory is still searched but as a
10570 system directory at its normal position in the system include chain.
10571 This is to ensure that GCC's procedure to fix buggy system headers and
10572 the ordering for the @code{include_next} directive are not inadvertently changed.
10573 If you really need to change the search order for system directories,
10574 use the @option{-nostdinc} and/or @option{-isystem} options.
10576 @item -iplugindir=@var{dir}
10577 @opindex iplugindir=
10578 Set the directory to search for plugins that are passed
10579 by @option{-fplugin=@var{name}} instead of
10580 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10581 to be used by the user, but only passed by the driver.
10583 @item -iquote@var{dir}
10584 @opindex iquote
10585 Add the directory @var{dir} to the head of the list of directories to
10586 be searched for header files only for the case of @samp{#include
10587 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10588 otherwise just like @option{-I}.
10590 @item -L@var{dir}
10591 @opindex L
10592 Add directory @var{dir} to the list of directories to be searched
10593 for @option{-l}.
10595 @item -B@var{prefix}
10596 @opindex B
10597 This option specifies where to find the executables, libraries,
10598 include files, and data files of the compiler itself.
10600 The compiler driver program runs one or more of the subprograms
10601 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10602 @var{prefix} as a prefix for each program it tries to run, both with and
10603 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10605 For each subprogram to be run, the compiler driver first tries the
10606 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10607 is not specified, the driver tries two standard prefixes, 
10608 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10609 those results in a file name that is found, the unmodified program
10610 name is searched for using the directories specified in your
10611 @env{PATH} environment variable.
10613 The compiler checks to see if the path provided by the @option{-B}
10614 refers to a directory, and if necessary it adds a directory
10615 separator character at the end of the path.
10617 @option{-B} prefixes that effectively specify directory names also apply
10618 to libraries in the linker, because the compiler translates these
10619 options into @option{-L} options for the linker.  They also apply to
10620 include files in the preprocessor, because the compiler translates these
10621 options into @option{-isystem} options for the preprocessor.  In this case,
10622 the compiler appends @samp{include} to the prefix.
10624 The runtime support file @file{libgcc.a} can also be searched for using
10625 the @option{-B} prefix, if needed.  If it is not found there, the two
10626 standard prefixes above are tried, and that is all.  The file is left
10627 out of the link if it is not found by those means.
10629 Another way to specify a prefix much like the @option{-B} prefix is to use
10630 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10631 Variables}.
10633 As a special kludge, if the path provided by @option{-B} is
10634 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10635 9, then it is replaced by @file{[dir/]include}.  This is to help
10636 with boot-strapping the compiler.
10638 @item -specs=@var{file}
10639 @opindex specs
10640 Process @var{file} after the compiler reads in the standard @file{specs}
10641 file, in order to override the defaults which the @command{gcc} driver
10642 program uses when determining what switches to pass to @command{cc1},
10643 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10644 @option{-specs=@var{file}} can be specified on the command line, and they
10645 are processed in order, from left to right.
10647 @item --sysroot=@var{dir}
10648 @opindex sysroot
10649 Use @var{dir} as the logical root directory for headers and libraries.
10650 For example, if the compiler normally searches for headers in
10651 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10652 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10654 If you use both this option and the @option{-isysroot} option, then
10655 the @option{--sysroot} option applies to libraries, but the
10656 @option{-isysroot} option applies to header files.
10658 The GNU linker (beginning with version 2.16) has the necessary support
10659 for this option.  If your linker does not support this option, the
10660 header file aspect of @option{--sysroot} still works, but the
10661 library aspect does not.
10663 @item --no-sysroot-suffix
10664 @opindex no-sysroot-suffix
10665 For some targets, a suffix is added to the root directory specified
10666 with @option{--sysroot}, depending on the other options used, so that
10667 headers may for example be found in
10668 @file{@var{dir}/@var{suffix}/usr/include} instead of
10669 @file{@var{dir}/usr/include}.  This option disables the addition of
10670 such a suffix.
10672 @item -I-
10673 @opindex I-
10674 This option has been deprecated.  Please use @option{-iquote} instead for
10675 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10676 Any directories you specify with @option{-I} options before the @option{-I-}
10677 option are searched only for the case of @samp{#include "@var{file}"};
10678 they are not searched for @samp{#include <@var{file}>}.
10680 If additional directories are specified with @option{-I} options after
10681 the @option{-I-}, these directories are searched for all @samp{#include}
10682 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10683 this way.)
10685 In addition, the @option{-I-} option inhibits the use of the current
10686 directory (where the current input file came from) as the first search
10687 directory for @samp{#include "@var{file}"}.  There is no way to
10688 override this effect of @option{-I-}.  With @option{-I.} you can specify
10689 searching the directory that is current when the compiler is
10690 invoked.  That is not exactly the same as what the preprocessor does
10691 by default, but it is often satisfactory.
10693 @option{-I-} does not inhibit the use of the standard system directories
10694 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10695 independent.
10696 @end table
10698 @c man end
10700 @node Spec Files
10701 @section Specifying subprocesses and the switches to pass to them
10702 @cindex Spec Files
10704 @command{gcc} is a driver program.  It performs its job by invoking a
10705 sequence of other programs to do the work of compiling, assembling and
10706 linking.  GCC interprets its command-line parameters and uses these to
10707 deduce which programs it should invoke, and which command-line options
10708 it ought to place on their command lines.  This behavior is controlled
10709 by @dfn{spec strings}.  In most cases there is one spec string for each
10710 program that GCC can invoke, but a few programs have multiple spec
10711 strings to control their behavior.  The spec strings built into GCC can
10712 be overridden by using the @option{-specs=} command-line switch to specify
10713 a spec file.
10715 @dfn{Spec files} are plaintext files that are used to construct spec
10716 strings.  They consist of a sequence of directives separated by blank
10717 lines.  The type of directive is determined by the first non-whitespace
10718 character on the line, which can be one of the following:
10720 @table @code
10721 @item %@var{command}
10722 Issues a @var{command} to the spec file processor.  The commands that can
10723 appear here are:
10725 @table @code
10726 @item %include <@var{file}>
10727 @cindex @code{%include}
10728 Search for @var{file} and insert its text at the current point in the
10729 specs file.
10731 @item %include_noerr <@var{file}>
10732 @cindex @code{%include_noerr}
10733 Just like @samp{%include}, but do not generate an error message if the include
10734 file cannot be found.
10736 @item %rename @var{old_name} @var{new_name}
10737 @cindex @code{%rename}
10738 Rename the spec string @var{old_name} to @var{new_name}.
10740 @end table
10742 @item *[@var{spec_name}]:
10743 This tells the compiler to create, override or delete the named spec
10744 string.  All lines after this directive up to the next directive or
10745 blank line are considered to be the text for the spec string.  If this
10746 results in an empty string then the spec is deleted.  (Or, if the
10747 spec did not exist, then nothing happens.)  Otherwise, if the spec
10748 does not currently exist a new spec is created.  If the spec does
10749 exist then its contents are overridden by the text of this
10750 directive, unless the first character of that text is the @samp{+}
10751 character, in which case the text is appended to the spec.
10753 @item [@var{suffix}]:
10754 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10755 and up to the next directive or blank line are considered to make up the
10756 spec string for the indicated suffix.  When the compiler encounters an
10757 input file with the named suffix, it processes the spec string in
10758 order to work out how to compile that file.  For example:
10760 @smallexample
10761 .ZZ:
10762 z-compile -input %i
10763 @end smallexample
10765 This says that any input file whose name ends in @samp{.ZZ} should be
10766 passed to the program @samp{z-compile}, which should be invoked with the
10767 command-line switch @option{-input} and with the result of performing the
10768 @samp{%i} substitution.  (See below.)
10770 As an alternative to providing a spec string, the text following a
10771 suffix directive can be one of the following:
10773 @table @code
10774 @item @@@var{language}
10775 This says that the suffix is an alias for a known @var{language}.  This is
10776 similar to using the @option{-x} command-line switch to GCC to specify a
10777 language explicitly.  For example:
10779 @smallexample
10780 .ZZ:
10781 @@c++
10782 @end smallexample
10784 Says that .ZZ files are, in fact, C++ source files.
10786 @item #@var{name}
10787 This causes an error messages saying:
10789 @smallexample
10790 @var{name} compiler not installed on this system.
10791 @end smallexample
10792 @end table
10794 GCC already has an extensive list of suffixes built into it.
10795 This directive adds an entry to the end of the list of suffixes, but
10796 since the list is searched from the end backwards, it is effectively
10797 possible to override earlier entries using this technique.
10799 @end table
10801 GCC has the following spec strings built into it.  Spec files can
10802 override these strings or create their own.  Note that individual
10803 targets can also add their own spec strings to this list.
10805 @smallexample
10806 asm          Options to pass to the assembler
10807 asm_final    Options to pass to the assembler post-processor
10808 cpp          Options to pass to the C preprocessor
10809 cc1          Options to pass to the C compiler
10810 cc1plus      Options to pass to the C++ compiler
10811 endfile      Object files to include at the end of the link
10812 link         Options to pass to the linker
10813 lib          Libraries to include on the command line to the linker
10814 libgcc       Decides which GCC support library to pass to the linker
10815 linker       Sets the name of the linker
10816 predefines   Defines to be passed to the C preprocessor
10817 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10818              by default
10819 startfile    Object files to include at the start of the link
10820 @end smallexample
10822 Here is a small example of a spec file:
10824 @smallexample
10825 %rename lib                 old_lib
10827 *lib:
10828 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10829 @end smallexample
10831 This example renames the spec called @samp{lib} to @samp{old_lib} and
10832 then overrides the previous definition of @samp{lib} with a new one.
10833 The new definition adds in some extra command-line options before
10834 including the text of the old definition.
10836 @dfn{Spec strings} are a list of command-line options to be passed to their
10837 corresponding program.  In addition, the spec strings can contain
10838 @samp{%}-prefixed sequences to substitute variable text or to
10839 conditionally insert text into the command line.  Using these constructs
10840 it is possible to generate quite complex command lines.
10842 Here is a table of all defined @samp{%}-sequences for spec
10843 strings.  Note that spaces are not generated automatically around the
10844 results of expanding these sequences.  Therefore you can concatenate them
10845 together or combine them with constant text in a single argument.
10847 @table @code
10848 @item %%
10849 Substitute one @samp{%} into the program name or argument.
10851 @item %i
10852 Substitute the name of the input file being processed.
10854 @item %b
10855 Substitute the basename of the input file being processed.
10856 This is the substring up to (and not including) the last period
10857 and not including the directory.
10859 @item %B
10860 This is the same as @samp{%b}, but include the file suffix (text after
10861 the last period).
10863 @item %d
10864 Marks the argument containing or following the @samp{%d} as a
10865 temporary file name, so that that file is deleted if GCC exits
10866 successfully.  Unlike @samp{%g}, this contributes no text to the
10867 argument.
10869 @item %g@var{suffix}
10870 Substitute a file name that has suffix @var{suffix} and is chosen
10871 once per compilation, and mark the argument in the same way as
10872 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10873 name is now chosen in a way that is hard to predict even when previously
10874 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10875 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10876 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10877 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10878 was simply substituted with a file name chosen once per compilation,
10879 without regard to any appended suffix (which was therefore treated
10880 just like ordinary text), making such attacks more likely to succeed.
10882 @item %u@var{suffix}
10883 Like @samp{%g}, but generates a new temporary file name
10884 each time it appears instead of once per compilation.
10886 @item %U@var{suffix}
10887 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10888 new one if there is no such last file name.  In the absence of any
10889 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10890 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10891 involves the generation of two distinct file names, one
10892 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10893 simply substituted with a file name chosen for the previous @samp{%u},
10894 without regard to any appended suffix.
10896 @item %j@var{suffix}
10897 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10898 writable, and if @option{-save-temps} is not used; 
10899 otherwise, substitute the name
10900 of a temporary file, just like @samp{%u}.  This temporary file is not
10901 meant for communication between processes, but rather as a junk
10902 disposal mechanism.
10904 @item %|@var{suffix}
10905 @itemx %m@var{suffix}
10906 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10907 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10908 all.  These are the two most common ways to instruct a program that it
10909 should read from standard input or write to standard output.  If you
10910 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10911 construct: see for example @file{f/lang-specs.h}.
10913 @item %.@var{SUFFIX}
10914 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10915 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10916 terminated by the next space or %.
10918 @item %w
10919 Marks the argument containing or following the @samp{%w} as the
10920 designated output file of this compilation.  This puts the argument
10921 into the sequence of arguments that @samp{%o} substitutes.
10923 @item %o
10924 Substitutes the names of all the output files, with spaces
10925 automatically placed around them.  You should write spaces
10926 around the @samp{%o} as well or the results are undefined.
10927 @samp{%o} is for use in the specs for running the linker.
10928 Input files whose names have no recognized suffix are not compiled
10929 at all, but they are included among the output files, so they are
10930 linked.
10932 @item %O
10933 Substitutes the suffix for object files.  Note that this is
10934 handled specially when it immediately follows @samp{%g, %u, or %U},
10935 because of the need for those to form complete file names.  The
10936 handling is such that @samp{%O} is treated exactly as if it had already
10937 been substituted, except that @samp{%g, %u, and %U} do not currently
10938 support additional @var{suffix} characters following @samp{%O} as they do
10939 following, for example, @samp{.o}.
10941 @item %p
10942 Substitutes the standard macro predefinitions for the
10943 current target machine.  Use this when running @code{cpp}.
10945 @item %P
10946 Like @samp{%p}, but puts @samp{__} before and after the name of each
10947 predefined macro, except for macros that start with @samp{__} or with
10948 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10951 @item %I
10952 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10953 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10954 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10955 and @option{-imultilib} as necessary.
10957 @item %s
10958 Current argument is the name of a library or startup file of some sort.
10959 Search for that file in a standard list of directories and substitute
10960 the full name found.  The current working directory is included in the
10961 list of directories scanned.
10963 @item %T
10964 Current argument is the name of a linker script.  Search for that file
10965 in the current list of directories to scan for libraries. If the file
10966 is located insert a @option{--script} option into the command line
10967 followed by the full path name found.  If the file is not found then
10968 generate an error message.  Note: the current working directory is not
10969 searched.
10971 @item %e@var{str}
10972 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10973 Use this when inconsistent options are detected.
10975 @item %(@var{name})
10976 Substitute the contents of spec string @var{name} at this point.
10978 @item %x@{@var{option}@}
10979 Accumulate an option for @samp{%X}.
10981 @item %X
10982 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10983 spec string.
10985 @item %Y
10986 Output the accumulated assembler options specified by @option{-Wa}.
10988 @item %Z
10989 Output the accumulated preprocessor options specified by @option{-Wp}.
10991 @item %a
10992 Process the @code{asm} spec.  This is used to compute the
10993 switches to be passed to the assembler.
10995 @item %A
10996 Process the @code{asm_final} spec.  This is a spec string for
10997 passing switches to an assembler post-processor, if such a program is
10998 needed.
11000 @item %l
11001 Process the @code{link} spec.  This is the spec for computing the
11002 command line passed to the linker.  Typically it makes use of the
11003 @samp{%L %G %S %D and %E} sequences.
11005 @item %D
11006 Dump out a @option{-L} option for each directory that GCC believes might
11007 contain startup files.  If the target supports multilibs then the
11008 current multilib directory is prepended to each of these paths.
11010 @item %L
11011 Process the @code{lib} spec.  This is a spec string for deciding which
11012 libraries are included on the command line to the linker.
11014 @item %G
11015 Process the @code{libgcc} spec.  This is a spec string for deciding
11016 which GCC support library is included on the command line to the linker.
11018 @item %S
11019 Process the @code{startfile} spec.  This is a spec for deciding which
11020 object files are the first ones passed to the linker.  Typically
11021 this might be a file named @file{crt0.o}.
11023 @item %E
11024 Process the @code{endfile} spec.  This is a spec string that specifies
11025 the last object files that are passed to the linker.
11027 @item %C
11028 Process the @code{cpp} spec.  This is used to construct the arguments
11029 to be passed to the C preprocessor.
11031 @item %1
11032 Process the @code{cc1} spec.  This is used to construct the options to be
11033 passed to the actual C compiler (@samp{cc1}).
11035 @item %2
11036 Process the @code{cc1plus} spec.  This is used to construct the options to be
11037 passed to the actual C++ compiler (@samp{cc1plus}).
11039 @item %*
11040 Substitute the variable part of a matched option.  See below.
11041 Note that each comma in the substituted string is replaced by
11042 a single space.
11044 @item %<@code{S}
11045 Remove all occurrences of @code{-S} from the command line.  Note---this
11046 command is position dependent.  @samp{%} commands in the spec string
11047 before this one see @code{-S}, @samp{%} commands in the spec string
11048 after this one do not.
11050 @item %:@var{function}(@var{args})
11051 Call the named function @var{function}, passing it @var{args}.
11052 @var{args} is first processed as a nested spec string, then split
11053 into an argument vector in the usual fashion.  The function returns
11054 a string which is processed as if it had appeared literally as part
11055 of the current spec.
11057 The following built-in spec functions are provided:
11059 @table @code
11060 @item @code{getenv}
11061 The @code{getenv} spec function takes two arguments: an environment
11062 variable name and a string.  If the environment variable is not
11063 defined, a fatal error is issued.  Otherwise, the return value is the
11064 value of the environment variable concatenated with the string.  For
11065 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11067 @smallexample
11068 %:getenv(TOPDIR /include)
11069 @end smallexample
11071 expands to @file{/path/to/top/include}.
11073 @item @code{if-exists}
11074 The @code{if-exists} spec function takes one argument, an absolute
11075 pathname to a file.  If the file exists, @code{if-exists} returns the
11076 pathname.  Here is a small example of its usage:
11078 @smallexample
11079 *startfile:
11080 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11081 @end smallexample
11083 @item @code{if-exists-else}
11084 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11085 spec function, except that it takes two arguments.  The first argument is
11086 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11087 returns the pathname.  If it does not exist, it returns the second argument.
11088 This way, @code{if-exists-else} can be used to select one file or another,
11089 based on the existence of the first.  Here is a small example of its usage:
11091 @smallexample
11092 *startfile:
11093 crt0%O%s %:if-exists(crti%O%s) \
11094 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11095 @end smallexample
11097 @item @code{replace-outfile}
11098 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11099 first argument in the outfiles array and replaces it with the second argument.  Here
11100 is a small example of its usage:
11102 @smallexample
11103 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11104 @end smallexample
11106 @item @code{remove-outfile}
11107 The @code{remove-outfile} spec function takes one argument.  It looks for the
11108 first argument in the outfiles array and removes it.  Here is a small example
11109 its usage:
11111 @smallexample
11112 %:remove-outfile(-lm)
11113 @end smallexample
11115 @item @code{pass-through-libs}
11116 The @code{pass-through-libs} spec function takes any number of arguments.  It
11117 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11118 assumes are the names of linker input library archive files) and returns a
11119 result containing all the found arguments each prepended by
11120 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11121 intended to be passed to the LTO linker plugin.
11123 @smallexample
11124 %:pass-through-libs(%G %L %G)
11125 @end smallexample
11127 @item @code{print-asm-header}
11128 The @code{print-asm-header} function takes no arguments and simply
11129 prints a banner like:
11131 @smallexample
11132 Assembler options
11133 =================
11135 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11136 @end smallexample
11138 It is used to separate compiler options from assembler options
11139 in the @option{--target-help} output.
11140 @end table
11142 @item %@{@code{S}@}
11143 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11144 If that switch is not specified, this substitutes nothing.  Note that
11145 the leading dash is omitted when specifying this option, and it is
11146 automatically inserted if the substitution is performed.  Thus the spec
11147 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11148 and outputs the command-line option @option{-foo}.
11150 @item %W@{@code{S}@}
11151 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11152 deleted on failure.
11154 @item %@{@code{S}*@}
11155 Substitutes all the switches specified to GCC whose names start
11156 with @code{-S}, but which also take an argument.  This is used for
11157 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11158 GCC considers @option{-o foo} as being
11159 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11160 text, including the space.  Thus two arguments are generated.
11162 @item %@{@code{S}*&@code{T}*@}
11163 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11164 (the order of @code{S} and @code{T} in the spec is not significant).
11165 There can be any number of ampersand-separated variables; for each the
11166 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11168 @item %@{@code{S}:@code{X}@}
11169 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11171 @item %@{!@code{S}:@code{X}@}
11172 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11174 @item %@{@code{S}*:@code{X}@}
11175 Substitutes @code{X} if one or more switches whose names start with
11176 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11177 once, no matter how many such switches appeared.  However, if @code{%*}
11178 appears somewhere in @code{X}, then @code{X} is substituted once
11179 for each matching switch, with the @code{%*} replaced by the part of
11180 that switch matching the @code{*}.
11182 If @code{%*} appears as the last part of a spec sequence then a space
11183 will be added after the end of the last substitution.  If there is more
11184 text in the sequence however then a space will not be generated.  This
11185 allows the @code{%*} substitution to be used as part of a larger
11186 string.  For example, a spec string like this:
11188 @smallexample
11189 %@{mcu=*:--script=%*/memory.ld@}
11190 @end smallexample
11192 when matching an option like @code{-mcu=newchip} will produce:
11194 @smallexample
11195 --script=newchip/memory.ld
11196 @end smallexample
11198 @item %@{.@code{S}:@code{X}@}
11199 Substitutes @code{X}, if processing a file with suffix @code{S}.
11201 @item %@{!.@code{S}:@code{X}@}
11202 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11204 @item %@{,@code{S}:@code{X}@}
11205 Substitutes @code{X}, if processing a file for language @code{S}.
11207 @item %@{!,@code{S}:@code{X}@}
11208 Substitutes @code{X}, if not processing a file for language @code{S}.
11210 @item %@{@code{S}|@code{P}:@code{X}@}
11211 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11212 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11213 @code{*} sequences as well, although they have a stronger binding than
11214 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11215 alternatives must be starred, and only the first matching alternative
11216 is substituted.
11218 For example, a spec string like this:
11220 @smallexample
11221 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11222 @end smallexample
11224 @noindent
11225 outputs the following command-line options from the following input
11226 command-line options:
11228 @smallexample
11229 fred.c        -foo -baz
11230 jim.d         -bar -boggle
11231 -d fred.c     -foo -baz -boggle
11232 -d jim.d      -bar -baz -boggle
11233 @end smallexample
11235 @item %@{S:X; T:Y; :D@}
11237 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11238 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11239 be as many clauses as you need.  This may be combined with @code{.},
11240 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11243 @end table
11245 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11246 construct may contain other nested @samp{%} constructs or spaces, or
11247 even newlines.  They are processed as usual, as described above.
11248 Trailing white space in @code{X} is ignored.  White space may also
11249 appear anywhere on the left side of the colon in these constructs,
11250 except between @code{.} or @code{*} and the corresponding word.
11252 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11253 handled specifically in these constructs.  If another value of
11254 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11255 @option{-W} switch is found later in the command line, the earlier
11256 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11257 just one letter, which passes all matching options.
11259 The character @samp{|} at the beginning of the predicate text is used to
11260 indicate that a command should be piped to the following command, but
11261 only if @option{-pipe} is specified.
11263 It is built into GCC which switches take arguments and which do not.
11264 (You might think it would be useful to generalize this to allow each
11265 compiler's spec to say which switches take arguments.  But this cannot
11266 be done in a consistent fashion.  GCC cannot even decide which input
11267 files have been specified without knowing which switches take arguments,
11268 and it must know which input files to compile in order to tell which
11269 compilers to run).
11271 GCC also knows implicitly that arguments starting in @option{-l} are to be
11272 treated as compiler output files, and passed to the linker in their
11273 proper position among the other output files.
11275 @c man begin OPTIONS
11277 @node Target Options
11278 @section Specifying Target Machine and Compiler Version
11279 @cindex target options
11280 @cindex cross compiling
11281 @cindex specifying machine version
11282 @cindex specifying compiler version and target machine
11283 @cindex compiler version, specifying
11284 @cindex target machine, specifying
11286 The usual way to run GCC is to run the executable called @command{gcc}, or
11287 @command{@var{machine}-gcc} when cross-compiling, or
11288 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11289 one that was installed last.
11291 @node Submodel Options
11292 @section Hardware Models and Configurations
11293 @cindex submodel options
11294 @cindex specifying hardware config
11295 @cindex hardware models and configurations, specifying
11296 @cindex machine dependent options
11298 Each target machine types can have its own
11299 special options, starting with @samp{-m}, to choose among various
11300 hardware models or configurations---for example, 68010 vs 68020,
11301 floating coprocessor or none.  A single installed version of the
11302 compiler can compile for any model or configuration, according to the
11303 options specified.
11305 Some configurations of the compiler also support additional special
11306 options, usually for compatibility with other compilers on the same
11307 platform.
11309 @c This list is ordered alphanumerically by subsection name.
11310 @c It should be the same order and spelling as these options are listed
11311 @c in Machine Dependent Options
11313 @menu
11314 * AArch64 Options::
11315 * Adapteva Epiphany Options::
11316 * ARC Options::
11317 * ARM Options::
11318 * AVR Options::
11319 * Blackfin Options::
11320 * C6X Options::
11321 * CRIS Options::
11322 * CR16 Options::
11323 * Darwin Options::
11324 * DEC Alpha Options::
11325 * FR30 Options::
11326 * FRV Options::
11327 * GNU/Linux Options::
11328 * H8/300 Options::
11329 * HPPA Options::
11330 * i386 and x86-64 Options::
11331 * i386 and x86-64 Windows Options::
11332 * IA-64 Options::
11333 * LM32 Options::
11334 * M32C Options::
11335 * M32R/D Options::
11336 * M680x0 Options::
11337 * MCore Options::
11338 * MeP Options::
11339 * MicroBlaze Options::
11340 * MIPS Options::
11341 * MMIX Options::
11342 * MN10300 Options::
11343 * Moxie Options::
11344 * MSP430 Options::
11345 * NDS32 Options::
11346 * Nios II Options::
11347 * PDP-11 Options::
11348 * picoChip Options::
11349 * PowerPC Options::
11350 * RL78 Options::
11351 * RS/6000 and PowerPC Options::
11352 * RX Options::
11353 * S/390 and zSeries Options::
11354 * Score Options::
11355 * SH Options::
11356 * Solaris 2 Options::
11357 * SPARC Options::
11358 * SPU Options::
11359 * System V Options::
11360 * TILE-Gx Options::
11361 * TILEPro Options::
11362 * V850 Options::
11363 * VAX Options::
11364 * VMS Options::
11365 * VxWorks Options::
11366 * x86-64 Options::
11367 * Xstormy16 Options::
11368 * Xtensa Options::
11369 * zSeries Options::
11370 @end menu
11372 @node AArch64 Options
11373 @subsection AArch64 Options
11374 @cindex AArch64 Options
11376 These options are defined for AArch64 implementations:
11378 @table @gcctabopt
11380 @item -mabi=@var{name}
11381 @opindex mabi
11382 Generate code for the specified data model.  Permissible values
11383 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11384 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11385 but long int and pointer are 64-bit.
11387 The default depends on the specific target configuration.  Note that
11388 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11389 entire program with the same ABI, and link with a compatible set of libraries.
11391 @item -mbig-endian
11392 @opindex mbig-endian
11393 Generate big-endian code.  This is the default when GCC is configured for an
11394 @samp{aarch64_be-*-*} target.
11396 @item -mgeneral-regs-only
11397 @opindex mgeneral-regs-only
11398 Generate code which uses only the general registers.
11400 @item -mlittle-endian
11401 @opindex mlittle-endian
11402 Generate little-endian code.  This is the default when GCC is configured for an
11403 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11405 @item -mcmodel=tiny
11406 @opindex mcmodel=tiny
11407 Generate code for the tiny code model.  The program and its statically defined
11408 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11409 be statically or dynamically linked.  This model is not fully implemented and
11410 mostly treated as @samp{small}.
11412 @item -mcmodel=small
11413 @opindex mcmodel=small
11414 Generate code for the small code model.  The program and its statically defined
11415 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11416 be statically or dynamically linked.  This is the default code model.
11418 @item -mcmodel=large
11419 @opindex mcmodel=large
11420 Generate code for the large code model.  This makes no assumptions about
11421 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11422 statically linked only.
11424 @item -mstrict-align
11425 @opindex mstrict-align
11426 Do not assume that unaligned memory references will be handled by the system.
11428 @item -momit-leaf-frame-pointer
11429 @itemx -mno-omit-leaf-frame-pointer
11430 @opindex momit-leaf-frame-pointer
11431 @opindex mno-omit-leaf-frame-pointer
11432 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11433 default.
11435 @item -mtls-dialect=desc
11436 @opindex mtls-dialect=desc
11437 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11438 of TLS variables.  This is the default.
11440 @item -mtls-dialect=traditional
11441 @opindex mtls-dialect=traditional
11442 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11443 of TLS variables.
11445 @item -mfix-cortex-a53-835769
11446 @itemx -mno-fix-cortex-a53-835769
11447 @opindex -mfix-cortex-a53-835769
11448 @opindex -mno-fix-cortex-a53-835769
11449 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
11450 This will involve inserting a NOP instruction between memory instructions and
11451 64-bit integer multiply-accumulate instructions.
11453 @item -mfix-cortex-a53-843419
11454 @itemx -mno-fix-cortex-a53-843419
11455 @opindex mfix-cortex-a53-843419
11456 @opindex mno-fix-cortex-a53-843419
11457 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
11458 This erratum workaround is made at link time and this will only pass the
11459 corresponding flag to the linker.
11461 @item -march=@var{name}
11462 @opindex march
11463 Specify the name of the target architecture, optionally suffixed by one or
11464 more feature modifiers.  This option has the form
11465 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11466 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11467 values for @var{feature} are documented in the sub-section below.
11469 Where conflicting feature modifiers are specified, the right-most feature is
11470 used.
11472 GCC uses this name to determine what kind of instructions it can emit when
11473 generating assembly code.
11475 Where @option{-march} is specified without either of @option{-mtune}
11476 or @option{-mcpu} also being specified, the code will be tuned to perform
11477 well across a range of target processors implementing the target
11478 architecture.
11480 @item -mtune=@var{name}
11481 @opindex mtune
11482 Specify the name of the target processor for which GCC should tune the
11483 performance of the code.  Permissible values for this option are:
11484 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57},
11485 @samp{cortex-a72}, @samp{thunderx}, @samp{xgene1}.
11487 Additionally, this option can specify that GCC should tune the performance
11488 of the code for a big.LITTLE system.  Permissible values for this
11489 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
11491 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
11492 are specified, the code will be tuned to perform well across a range
11493 of target processors.
11495 This option cannot be suffixed by feature modifiers.
11497 @item -mcpu=@var{name}
11498 @opindex mcpu
11499 Specify the name of the target processor, optionally suffixed by one or more
11500 feature modifiers.  This option has the form
11501 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11502 permissible values for @var{cpu} are the same as those available for
11503 @option{-mtune}.
11505 The permissible values for @var{feature} are documented in the sub-section
11506 below.
11508 Where conflicting feature modifiers are specified, the right-most feature is
11509 used.
11511 GCC uses this name to determine what kind of instructions it can emit when
11512 generating assembly code (as if by @option{-march}) and to determine
11513 the target processor for which to tune for performance (as if
11514 by @option{-mtune}).  Where this option is used in conjunction
11515 with @option{-march} or @option{-mtune}, those options take precedence
11516 over the appropriate part of this option.
11517 @end table
11519 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11520 @cindex @option{-march} feature modifiers
11521 @cindex @option{-mcpu} feature modifiers
11522 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11523 the following:
11525 @table @samp
11526 @item crc
11527 Enable CRC extension.
11528 @item crypto
11529 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11530 @item fp
11531 Enable floating-point instructions.
11532 @item simd
11533 Enable Advanced SIMD instructions.  This implies floating-point instructions
11534 are enabled.  This is the default for all current possible values for options
11535 @option{-march} and @option{-mcpu=}.
11536 @end table
11538 @node Adapteva Epiphany Options
11539 @subsection Adapteva Epiphany Options
11541 These @samp{-m} options are defined for Adapteva Epiphany:
11543 @table @gcctabopt
11544 @item -mhalf-reg-file
11545 @opindex mhalf-reg-file
11546 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11547 That allows code to run on hardware variants that lack these registers.
11549 @item -mprefer-short-insn-regs
11550 @opindex mprefer-short-insn-regs
11551 Preferrentially allocate registers that allow short instruction generation.
11552 This can result in increased instruction count, so this may either reduce or
11553 increase overall code size.
11555 @item -mbranch-cost=@var{num}
11556 @opindex mbranch-cost
11557 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11558 This cost is only a heuristic and is not guaranteed to produce
11559 consistent results across releases.
11561 @item -mcmove
11562 @opindex mcmove
11563 Enable the generation of conditional moves.
11565 @item -mnops=@var{num}
11566 @opindex mnops
11567 Emit @var{num} NOPs before every other generated instruction.
11569 @item -mno-soft-cmpsf
11570 @opindex mno-soft-cmpsf
11571 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11572 and test the flags.  This is faster than a software comparison, but can
11573 get incorrect results in the presence of NaNs, or when two different small
11574 numbers are compared such that their difference is calculated as zero.
11575 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11576 software comparisons.
11578 @item -mstack-offset=@var{num}
11579 @opindex mstack-offset
11580 Set the offset between the top of the stack and the stack pointer.
11581 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11582 can be used by leaf functions without stack allocation.
11583 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11584 Note also that this option changes the ABI; compiling a program with a
11585 different stack offset than the libraries have been compiled with
11586 generally does not work.
11587 This option can be useful if you want to evaluate if a different stack
11588 offset would give you better code, but to actually use a different stack
11589 offset to build working programs, it is recommended to configure the
11590 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11592 @item -mno-round-nearest
11593 @opindex mno-round-nearest
11594 Make the scheduler assume that the rounding mode has been set to
11595 truncating.  The default is @option{-mround-nearest}.
11597 @item -mlong-calls
11598 @opindex mlong-calls
11599 If not otherwise specified by an attribute, assume all calls might be beyond
11600 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11601 function address into a register before performing a (otherwise direct) call.
11602 This is the default.
11604 @item -mshort-calls
11605 @opindex short-calls
11606 If not otherwise specified by an attribute, assume all direct calls are
11607 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11608 for direct calls.  The default is @option{-mlong-calls}.
11610 @item -msmall16
11611 @opindex msmall16
11612 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11613 apply to function addresses for which @option{-mlong-calls} semantics
11614 are in effect.
11616 @item -mfp-mode=@var{mode}
11617 @opindex mfp-mode
11618 Set the prevailing mode of the floating-point unit.
11619 This determines the floating-point mode that is provided and expected
11620 at function call and return time.  Making this mode match the mode you
11621 predominantly need at function start can make your programs smaller and
11622 faster by avoiding unnecessary mode switches.
11624 @var{mode} can be set to one the following values:
11626 @table @samp
11627 @item caller
11628 Any mode at function entry is valid, and retained or restored when
11629 the function returns, and when it calls other functions.
11630 This mode is useful for compiling libraries or other compilation units
11631 you might want to incorporate into different programs with different
11632 prevailing FPU modes, and the convenience of being able to use a single
11633 object file outweighs the size and speed overhead for any extra
11634 mode switching that might be needed, compared with what would be needed
11635 with a more specific choice of prevailing FPU mode.
11637 @item truncate
11638 This is the mode used for floating-point calculations with
11639 truncating (i.e.@: round towards zero) rounding mode.  That includes
11640 conversion from floating point to integer.
11642 @item round-nearest
11643 This is the mode used for floating-point calculations with
11644 round-to-nearest-or-even rounding mode.
11646 @item int
11647 This is the mode used to perform integer calculations in the FPU, e.g.@:
11648 integer multiply, or integer multiply-and-accumulate.
11649 @end table
11651 The default is @option{-mfp-mode=caller}
11653 @item -mnosplit-lohi
11654 @itemx -mno-postinc
11655 @itemx -mno-postmodify
11656 @opindex mnosplit-lohi
11657 @opindex mno-postinc
11658 @opindex mno-postmodify
11659 Code generation tweaks that disable, respectively, splitting of 32-bit
11660 loads, generation of post-increment addresses, and generation of
11661 post-modify addresses.  The defaults are @option{msplit-lohi},
11662 @option{-mpost-inc}, and @option{-mpost-modify}.
11664 @item -mnovect-double
11665 @opindex mno-vect-double
11666 Change the preferred SIMD mode to SImode.  The default is
11667 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11669 @item -max-vect-align=@var{num}
11670 @opindex max-vect-align
11671 The maximum alignment for SIMD vector mode types.
11672 @var{num} may be 4 or 8.  The default is 8.
11673 Note that this is an ABI change, even though many library function
11674 interfaces are unaffected if they don't use SIMD vector modes
11675 in places that affect size and/or alignment of relevant types.
11677 @item -msplit-vecmove-early
11678 @opindex msplit-vecmove-early
11679 Split vector moves into single word moves before reload.  In theory this
11680 can give better register allocation, but so far the reverse seems to be
11681 generally the case.
11683 @item -m1reg-@var{reg}
11684 @opindex m1reg-
11685 Specify a register to hold the constant @minus{}1, which makes loading small negative
11686 constants and certain bitmasks faster.
11687 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11688 which specify use of that register as a fixed register,
11689 and @samp{none}, which means that no register is used for this
11690 purpose.  The default is @option{-m1reg-none}.
11692 @end table
11694 @node ARC Options
11695 @subsection ARC Options
11696 @cindex ARC options
11698 The following options control the architecture variant for which code
11699 is being compiled:
11701 @c architecture variants
11702 @table @gcctabopt
11704 @item -mbarrel-shifter
11705 @opindex mbarrel-shifter
11706 Generate instructions supported by barrel shifter.  This is the default
11707 unless @samp{-mcpu=ARC601} is in effect.
11709 @item -mcpu=@var{cpu}
11710 @opindex mcpu
11711 Set architecture type, register usage, and instruction scheduling
11712 parameters for @var{cpu}.  There are also shortcut alias options
11713 available for backward compatibility and convenience.  Supported
11714 values for @var{cpu} are
11716 @table @samp
11717 @opindex mA6
11718 @opindex mARC600
11719 @item ARC600
11720 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
11722 @item ARC601
11723 @opindex mARC601
11724 Compile for ARC601.  Alias: @option{-mARC601}.
11726 @item ARC700
11727 @opindex mA7
11728 @opindex mARC700
11729 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
11730 This is the default when configured with @samp{--with-cpu=arc700}@.
11731 @end table
11733 @item -mdpfp
11734 @opindex mdpfp
11735 @itemx -mdpfp-compact
11736 @opindex mdpfp-compact
11737 FPX: Generate Double Precision FPX instructions, tuned for the compact
11738 implementation.
11740 @item -mdpfp-fast
11741 @opindex mdpfp-fast
11742 FPX: Generate Double Precision FPX instructions, tuned for the fast
11743 implementation.
11745 @item -mno-dpfp-lrsr
11746 @opindex mno-dpfp-lrsr
11747 Disable LR and SR instructions from using FPX extension aux registers.
11749 @item -mea
11750 @opindex mea
11751 Generate Extended arithmetic instructions.  Currently only
11752 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
11753 supported.  This is always enabled for @samp{-mcpu=ARC700}.
11755 @item -mno-mpy
11756 @opindex mno-mpy
11757 Do not generate mpy instructions for ARC700.
11759 @item -mmul32x16
11760 @opindex mmul32x16
11761 Generate 32x16 bit multiply and mac instructions.
11763 @item -mmul64
11764 @opindex mmul64
11765 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
11767 @item -mnorm
11768 @opindex mnorm
11769 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
11770 is in effect.
11772 @item -mspfp
11773 @opindex mspfp
11774 @itemx -mspfp-compact
11775 @opindex mspfp-compact
11776 FPX: Generate Single Precision FPX instructions, tuned for the compact
11777 implementation.
11779 @item -mspfp-fast
11780 @opindex mspfp-fast
11781 FPX: Generate Single Precision FPX instructions, tuned for the fast
11782 implementation.
11784 @item -msimd
11785 @opindex msimd
11786 Enable generation of ARC SIMD instructions via target-specific
11787 builtins.  Only valid for @samp{-mcpu=ARC700}.
11789 @item -msoft-float
11790 @opindex msoft-float
11791 This option ignored; it is provided for compatibility purposes only.
11792 Software floating point code is emitted by default, and this default
11793 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
11794 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
11795 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
11797 @item -mswap
11798 @opindex mswap
11799 Generate swap instructions.
11801 @end table
11803 The following options are passed through to the assembler, and also
11804 define preprocessor macro symbols.
11806 @c Flags used by the assembler, but for which we define preprocessor
11807 @c macro symbols as well.
11808 @table @gcctabopt
11809 @item -mdsp-packa
11810 @opindex mdsp-packa
11811 Passed down to the assembler to enable the DSP Pack A extensions.
11812 Also sets the preprocessor symbol @code{__Xdsp_packa}.
11814 @item -mdvbf
11815 @opindex mdvbf
11816 Passed down to the assembler to enable the dual viterbi butterfly
11817 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
11819 @c ARC700 4.10 extension instruction
11820 @item -mlock
11821 @opindex mlock
11822 Passed down to the assembler to enable the Locked Load/Store
11823 Conditional extension.  Also sets the preprocessor symbol
11824 @code{__Xlock}.
11826 @item -mmac-d16
11827 @opindex mmac-d16
11828 Passed down to the assembler.  Also sets the preprocessor symbol
11829 @code{__Xxmac_d16}.
11831 @item -mmac-24
11832 @opindex mmac-24
11833 Passed down to the assembler.  Also sets the preprocessor symbol
11834 @code{__Xxmac_24}.
11836 @c ARC700 4.10 extension instruction
11837 @item -mrtsc
11838 @opindex mrtsc
11839 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
11840 extension instruction.  Also sets the preprocessor symbol
11841 @code{__Xrtsc}.
11843 @c ARC700 4.10 extension instruction
11844 @item -mswape
11845 @opindex mswape
11846 Passed down to the assembler to enable the swap byte ordering
11847 extension instruction.  Also sets the preprocessor symbol
11848 @code{__Xswape}.
11850 @item -mtelephony
11851 @opindex mtelephony
11852 Passed down to the assembler to enable dual and single operand
11853 instructions for telephony.  Also sets the preprocessor symbol
11854 @code{__Xtelephony}.
11856 @item -mxy
11857 @opindex mxy
11858 Passed down to the assembler to enable the XY Memory extension.  Also
11859 sets the preprocessor symbol @code{__Xxy}.
11861 @end table
11863 The following options control how the assembly code is annotated:
11865 @c Assembly annotation options
11866 @table @gcctabopt
11867 @item -misize
11868 @opindex misize
11869 Annotate assembler instructions with estimated addresses.
11871 @item -mannotate-align
11872 @opindex mannotate-align
11873 Explain what alignment considerations lead to the decision to make an
11874 instruction short or long.
11876 @end table
11878 The following options are passed through to the linker:
11880 @c options passed through to the linker
11881 @table @gcctabopt
11882 @item -marclinux
11883 @opindex marclinux
11884 Passed through to the linker, to specify use of the @code{arclinux} emulation.
11885 This option is enabled by default in tool chains built for
11886 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
11887 when profiling is not requested.
11889 @item -marclinux_prof
11890 @opindex marclinux_prof
11891 Passed through to the linker, to specify use of the
11892 @code{arclinux_prof} emulation.  This option is enabled by default in
11893 tool chains built for @w{@code{arc-linux-uclibc}} and
11894 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
11896 @end table
11898 The following options control the semantics of generated code:
11900 @c semantically relevant code generation options
11901 @table @gcctabopt
11902 @item -mepilogue-cfi
11903 @opindex mepilogue-cfi
11904 Enable generation of call frame information for epilogues.
11906 @item -mno-epilogue-cfi
11907 @opindex mno-epilogue-cfi
11908 Disable generation of call frame information for epilogues.
11910 @item -mlong-calls
11911 @opindex mlong-calls
11912 Generate call insns as register indirect calls, thus providing access
11913 to the full 32-bit address range.
11915 @item -mmedium-calls
11916 @opindex mmedium-calls
11917 Don't use less than 25 bit addressing range for calls, which is the
11918 offset available for an unconditional branch-and-link
11919 instruction.  Conditional execution of function calls is suppressed, to
11920 allow use of the 25-bit range, rather than the 21-bit range with
11921 conditional branch-and-link.  This is the default for tool chains built
11922 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
11924 @item -mno-sdata
11925 @opindex mno-sdata
11926 Do not generate sdata references.  This is the default for tool chains
11927 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
11928 targets.
11930 @item -mucb-mcount
11931 @opindex mucb-mcount
11932 Instrument with mcount calls as used in UCB code.  I.e. do the
11933 counting in the callee, not the caller.  By default ARC instrumentation
11934 counts in the caller.
11936 @item -mvolatile-cache
11937 @opindex mvolatile-cache
11938 Use ordinarily cached memory accesses for volatile references.  This is the
11939 default.
11941 @item -mno-volatile-cache
11942 @opindex mno-volatile-cache
11943 Enable cache bypass for volatile references.
11945 @end table
11947 The following options fine tune code generation:
11948 @c code generation tuning options
11949 @table @gcctabopt
11950 @item -malign-call
11951 @opindex malign-call
11952 Do alignment optimizations for call instructions.
11954 @item -mauto-modify-reg
11955 @opindex mauto-modify-reg
11956 Enable the use of pre/post modify with register displacement.
11958 @item -mbbit-peephole
11959 @opindex mbbit-peephole
11960 Enable bbit peephole2.
11962 @item -mno-brcc
11963 @opindex mno-brcc
11964 This option disables a target-specific pass in @file{arc_reorg} to
11965 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
11966 generation driven by the combiner pass.
11968 @item -mcase-vector-pcrel
11969 @opindex mcase-vector-pcrel
11970 Use pc-relative switch case tables - this enables case table shortening.
11971 This is the default for @option{-Os}.
11973 @item -mcompact-casesi
11974 @opindex mcompact-casesi
11975 Enable compact casesi pattern.
11976 This is the default for @option{-Os}.
11978 @item -mno-cond-exec
11979 @opindex mno-cond-exec
11980 Disable ARCompact specific pass to generate conditional execution instructions.
11981 Due to delay slot scheduling and interactions between operand numbers,
11982 literal sizes, instruction lengths, and the support for conditional execution,
11983 the target-independent pass to generate conditional execution is often lacking,
11984 so the ARC port has kept a special pass around that tries to find more
11985 conditional execution generating opportunities after register allocation,
11986 branch shortening, and delay slot scheduling have been done.  This pass
11987 generally, but not always, improves performance and code size, at the cost of
11988 extra compilation time, which is why there is an option to switch it off.
11989 If you have a problem with call instructions exceeding their allowable
11990 offset range because they are conditionalized, you should consider using
11991 @option{-mmedium-calls} instead.
11993 @item -mearly-cbranchsi
11994 @opindex mearly-cbranchsi
11995 Enable pre-reload use of the cbranchsi pattern.
11997 @item -mexpand-adddi
11998 @opindex mexpand-adddi
11999 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12000 @code{add.f}, @code{adc} etc.
12002 @item -mindexed-loads
12003 @opindex mindexed-loads
12004 Enable the use of indexed loads.  This can be problematic because some
12005 optimizers will then assume the that indexed stores exist, which is not
12006 the case.
12008 @item -mlra
12009 @opindex mlra
12010 Enable Local Register Allocation.  This is still experimental for ARC,
12011 so by default the compiler uses standard reload
12012 (i.e. @samp{-mno-lra}).
12014 @item -mlra-priority-none
12015 @opindex mlra-priority-none
12016 Don't indicate any priority for target registers.
12018 @item -mlra-priority-compact
12019 @opindex mlra-priority-compact
12020 Indicate target register priority for r0..r3 / r12..r15.
12022 @item -mlra-priority-noncompact
12023 @opindex mlra-priority-noncompact
12024 Reduce target regsiter priority for r0..r3 / r12..r15.
12026 @item -mno-millicode
12027 @opindex mno-millicode
12028 When optimizing for size (using @option{-Os}), prologues and epilogues
12029 that have to save or restore a large number of registers are often
12030 shortened by using call to a special function in libgcc; this is
12031 referred to as a @emph{millicode} call.  As these calls can pose
12032 performance issues, and/or cause linking issues when linking in a
12033 nonstandard way, this option is provided to turn off millicode call
12034 generation.
12036 @item -mmixed-code
12037 @opindex mmixed-code
12038 Tweak register allocation to help 16-bit instruction generation.
12039 This generally has the effect of decreasing the average instruction size
12040 while increasing the instruction count.
12042 @item -mq-class
12043 @opindex mq-class
12044 Enable 'q' instruction alternatives.
12045 This is the default for @option{-Os}.
12047 @item -mRcq
12048 @opindex mRcq
12049 Enable Rcq constraint handling - most short code generation depends on this.
12050 This is the default.
12052 @item -mRcw
12053 @opindex mRcw
12054 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12055 This is the default.
12057 @item -msize-level=@var{level}
12058 @opindex msize-level
12059 Fine-tune size optimization with regards to instruction lengths and alignment.
12060 The recognized values for @var{level} are:
12061 @table @samp
12062 @item 0
12063 No size optimization.  This level is deprecated and treated like @samp{1}.
12065 @item 1
12066 Short instructions are used opportunistically.
12068 @item 2
12069 In addition, alignment of loops and of code after barriers are dropped.
12071 @item 3
12072 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12074 @end table
12076 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12077 the behavior when this is not set is equivalent to level @samp{1}.
12079 @item -mtune=@var{cpu}
12080 @opindex mtune
12081 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12082 by @option{-mcpu=}.
12084 Supported values for @var{cpu} are
12086 @table @samp
12087 @item ARC600
12088 Tune for ARC600 cpu.
12090 @item ARC601
12091 Tune for ARC601 cpu.
12093 @item ARC700
12094 Tune for ARC700 cpu with standard multiplier block.
12096 @item ARC700-xmac
12097 Tune for ARC700 cpu with XMAC block.
12099 @item ARC725D
12100 Tune for ARC725D cpu.
12102 @item ARC750D
12103 Tune for ARC750D cpu.
12105 @end table
12107 @item -mmultcost=@var{num}
12108 @opindex mmultcost
12109 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12110 normal instruction.
12112 @item -munalign-prob-threshold=@var{probability}
12113 @opindex munalign-prob-threshold
12114 Set probability threshold for unaligning branches.
12115 When tuning for @samp{ARC700} and optimizing for speed, branches without
12116 filled delay slot are preferably emitted unaligned and long, unless
12117 profiling indicates that the probability for the branch to be taken
12118 is below @var{probability}.  @xref{Cross-profiling}.
12119 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12121 @end table
12123 The following options are maintained for backward compatibility, but
12124 are now deprecated and will be removed in a future release:
12126 @c Deprecated options
12127 @table @gcctabopt
12129 @item -margonaut
12130 @opindex margonaut
12131 Obsolete FPX.
12133 @item -mbig-endian
12134 @opindex mbig-endian
12135 @itemx -EB
12136 @opindex EB
12137 Compile code for big endian targets.  Use of these options is now
12138 deprecated.  Users wanting big-endian code, should use the
12139 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12140 building the tool chain, for which big-endian is the default.
12142 @item -mlittle-endian
12143 @opindex mlittle-endian
12144 @itemx -EL
12145 @opindex EL
12146 Compile code for little endian targets.  Use of these options is now
12147 deprecated.  Users wanting little-endian code should use the
12148 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12149 building the tool chain, for which little-endian is the default.
12151 @item -mbarrel_shifter
12152 @opindex mbarrel_shifter
12153 Replaced by @samp{-mbarrel-shifter}
12155 @item -mdpfp_compact
12156 @opindex mdpfp_compact
12157 Replaced by @samp{-mdpfp-compact}
12159 @item -mdpfp_fast
12160 @opindex mdpfp_fast
12161 Replaced by @samp{-mdpfp-fast}
12163 @item -mdsp_packa
12164 @opindex mdsp_packa
12165 Replaced by @samp{-mdsp-packa}
12167 @item -mEA
12168 @opindex mEA
12169 Replaced by @samp{-mea}
12171 @item -mmac_24
12172 @opindex mmac_24
12173 Replaced by @samp{-mmac-24}
12175 @item -mmac_d16
12176 @opindex mmac_d16
12177 Replaced by @samp{-mmac-d16}
12179 @item -mspfp_compact
12180 @opindex mspfp_compact
12181 Replaced by @samp{-mspfp-compact}
12183 @item -mspfp_fast
12184 @opindex mspfp_fast
12185 Replaced by @samp{-mspfp-fast}
12187 @item -mtune=@var{cpu}
12188 @opindex mtune
12189 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12190 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12191 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12193 @item -multcost=@var{num}
12194 @opindex multcost
12195 Replaced by @samp{-mmultcost}.
12197 @end table
12199 @node ARM Options
12200 @subsection ARM Options
12201 @cindex ARM options
12203 These @samp{-m} options are defined for the ARM port:
12205 @table @gcctabopt
12206 @item -mabi=@var{name}
12207 @opindex mabi
12208 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12209 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12211 @item -mapcs-frame
12212 @opindex mapcs-frame
12213 Generate a stack frame that is compliant with the ARM Procedure Call
12214 Standard for all functions, even if this is not strictly necessary for
12215 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12216 with this option causes the stack frames not to be generated for
12217 leaf functions.  The default is @option{-mno-apcs-frame}.
12219 @item -mapcs
12220 @opindex mapcs
12221 This is a synonym for @option{-mapcs-frame}.
12223 @ignore
12224 @c not currently implemented
12225 @item -mapcs-stack-check
12226 @opindex mapcs-stack-check
12227 Generate code to check the amount of stack space available upon entry to
12228 every function (that actually uses some stack space).  If there is
12229 insufficient space available then either the function
12230 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12231 called, depending upon the amount of stack space required.  The runtime
12232 system is required to provide these functions.  The default is
12233 @option{-mno-apcs-stack-check}, since this produces smaller code.
12235 @c not currently implemented
12236 @item -mapcs-float
12237 @opindex mapcs-float
12238 Pass floating-point arguments using the floating-point registers.  This is
12239 one of the variants of the APCS@.  This option is recommended if the
12240 target hardware has a floating-point unit or if a lot of floating-point
12241 arithmetic is going to be performed by the code.  The default is
12242 @option{-mno-apcs-float}, since the size of integer-only code is 
12243 slightly increased if @option{-mapcs-float} is used.
12245 @c not currently implemented
12246 @item -mapcs-reentrant
12247 @opindex mapcs-reentrant
12248 Generate reentrant, position-independent code.  The default is
12249 @option{-mno-apcs-reentrant}.
12250 @end ignore
12252 @item -mthumb-interwork
12253 @opindex mthumb-interwork
12254 Generate code that supports calling between the ARM and Thumb
12255 instruction sets.  Without this option, on pre-v5 architectures, the
12256 two instruction sets cannot be reliably used inside one program.  The
12257 default is @option{-mno-thumb-interwork}, since slightly larger code
12258 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12259 configurations this option is meaningless.
12261 @item -mno-sched-prolog
12262 @opindex mno-sched-prolog
12263 Prevent the reordering of instructions in the function prologue, or the
12264 merging of those instruction with the instructions in the function's
12265 body.  This means that all functions start with a recognizable set
12266 of instructions (or in fact one of a choice from a small set of
12267 different function prologues), and this information can be used to
12268 locate the start of functions inside an executable piece of code.  The
12269 default is @option{-msched-prolog}.
12271 @item -mfloat-abi=@var{name}
12272 @opindex mfloat-abi
12273 Specifies which floating-point ABI to use.  Permissible values
12274 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12276 Specifying @samp{soft} causes GCC to generate output containing
12277 library calls for floating-point operations.
12278 @samp{softfp} allows the generation of code using hardware floating-point
12279 instructions, but still uses the soft-float calling conventions.
12280 @samp{hard} allows generation of floating-point instructions
12281 and uses FPU-specific calling conventions.
12283 The default depends on the specific target configuration.  Note that
12284 the hard-float and soft-float ABIs are not link-compatible; you must
12285 compile your entire program with the same ABI, and link with a
12286 compatible set of libraries.
12288 @item -mlittle-endian
12289 @opindex mlittle-endian
12290 Generate code for a processor running in little-endian mode.  This is
12291 the default for all standard configurations.
12293 @item -mbig-endian
12294 @opindex mbig-endian
12295 Generate code for a processor running in big-endian mode; the default is
12296 to compile code for a little-endian processor.
12298 @item -mwords-little-endian
12299 @opindex mwords-little-endian
12300 This option only applies when generating code for big-endian processors.
12301 Generate code for a little-endian word order but a big-endian byte
12302 order.  That is, a byte order of the form @samp{32107654}.  Note: this
12303 option should only be used if you require compatibility with code for
12304 big-endian ARM processors generated by versions of the compiler prior to
12305 2.8.  This option is now deprecated.
12307 @item -march=@var{name}
12308 @opindex march
12309 This specifies the name of the target ARM architecture.  GCC uses this
12310 name to determine what kind of instructions it can emit when generating
12311 assembly code.  This option can be used in conjunction with or instead
12312 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12313 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12314 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12315 @samp{armv6}, @samp{armv6j},
12316 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12317 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12318 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12319 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12321 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12322 extensions.
12324 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12325 architecture together with the optional CRC32 extensions.
12327 @option{-march=native} causes the compiler to auto-detect the architecture
12328 of the build computer.  At present, this feature is only supported on
12329 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12330 is unsuccessful the option has no effect.
12332 @item -mtune=@var{name}
12333 @opindex mtune
12334 This option specifies the name of the target ARM processor for
12335 which GCC should tune the performance of the code.
12336 For some ARM implementations better performance can be obtained by using
12337 this option.
12338 Permissible names are: @samp{arm2}, @samp{arm250},
12339 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12340 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12341 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12342 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12343 @samp{arm720},
12344 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12345 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12346 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12347 @samp{strongarm1110},
12348 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12349 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12350 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12351 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12352 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12353 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12354 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12355 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12356 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53},
12357 @samp{cortex-a57}, @samp{cortex-a72},
12358 @samp{cortex-r4},
12359 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12360 @samp{cortex-m4},
12361 @samp{cortex-m3},
12362 @samp{cortex-m1},
12363 @samp{cortex-m0},
12364 @samp{cortex-m0plus},
12365 @samp{cortex-m1.small-multiply},
12366 @samp{cortex-m0.small-multiply},
12367 @samp{cortex-m0plus.small-multiply},
12368 @samp{marvell-pj4},
12369 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12370 @samp{fa526}, @samp{fa626},
12371 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
12372 @samp{xgene1}.
12374 Additionally, this option can specify that GCC should tune the performance
12375 of the code for a big.LITTLE system.  Permissible names are:
12376 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53},
12377 @samp{cortex-a72.cortex-a53}.
12379 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12380 performance for a blend of processors within architecture @var{arch}.
12381 The aim is to generate code that run well on the current most popular
12382 processors, balancing between optimizations that benefit some CPUs in the
12383 range, and avoiding performance pitfalls of other CPUs.  The effects of
12384 this option may change in future GCC versions as CPU models come and go.
12386 @option{-mtune=native} causes the compiler to auto-detect the CPU
12387 of the build computer.  At present, this feature is only supported on
12388 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12389 unsuccessful the option has no effect.
12391 @item -mcpu=@var{name}
12392 @opindex mcpu
12393 This specifies the name of the target ARM processor.  GCC uses this name
12394 to derive the name of the target ARM architecture (as if specified
12395 by @option{-march}) and the ARM processor type for which to tune for
12396 performance (as if specified by @option{-mtune}).  Where this option
12397 is used in conjunction with @option{-march} or @option{-mtune},
12398 those options take precedence over the appropriate part of this option.
12400 Permissible names for this option are the same as those for
12401 @option{-mtune}.
12403 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12404 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12405 See @option{-mtune} for more information.
12407 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12408 of the build computer.  At present, this feature is only supported on
12409 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12410 is unsuccessful the option has no effect.
12412 @item -mfpu=@var{name}
12413 @opindex mfpu
12414 This specifies what floating-point hardware (or hardware emulation) is
12415 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12416 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12417 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12418 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12419 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12420 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12422 If @option{-msoft-float} is specified this specifies the format of
12423 floating-point values.
12425 If the selected floating-point hardware includes the NEON extension
12426 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12427 operations are not generated by GCC's auto-vectorization pass unless
12428 @option{-funsafe-math-optimizations} is also specified.  This is
12429 because NEON hardware does not fully implement the IEEE 754 standard for
12430 floating-point arithmetic (in particular denormal values are treated as
12431 zero), so the use of NEON instructions may lead to a loss of precision.
12433 @item -mfp16-format=@var{name}
12434 @opindex mfp16-format
12435 Specify the format of the @code{__fp16} half-precision floating-point type.
12436 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12437 the default is @samp{none}, in which case the @code{__fp16} type is not
12438 defined.  @xref{Half-Precision}, for more information.
12440 @item -mstructure-size-boundary=@var{n}
12441 @opindex mstructure-size-boundary
12442 The sizes of all structures and unions are rounded up to a multiple
12443 of the number of bits set by this option.  Permissible values are 8, 32
12444 and 64.  The default value varies for different toolchains.  For the COFF
12445 targeted toolchain the default value is 8.  A value of 64 is only allowed
12446 if the underlying ABI supports it.
12448 Specifying a larger number can produce faster, more efficient code, but
12449 can also increase the size of the program.  Different values are potentially
12450 incompatible.  Code compiled with one value cannot necessarily expect to
12451 work with code or libraries compiled with another value, if they exchange
12452 information using structures or unions.
12454 @item -mabort-on-noreturn
12455 @opindex mabort-on-noreturn
12456 Generate a call to the function @code{abort} at the end of a
12457 @code{noreturn} function.  It is executed if the function tries to
12458 return.
12460 @item -mlong-calls
12461 @itemx -mno-long-calls
12462 @opindex mlong-calls
12463 @opindex mno-long-calls
12464 Tells the compiler to perform function calls by first loading the
12465 address of the function into a register and then performing a subroutine
12466 call on this register.  This switch is needed if the target function
12467 lies outside of the 64-megabyte addressing range of the offset-based
12468 version of subroutine call instruction.
12470 Even if this switch is enabled, not all function calls are turned
12471 into long calls.  The heuristic is that static functions, functions
12472 that have the @samp{short-call} attribute, functions that are inside
12473 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12474 definitions have already been compiled within the current compilation
12475 unit are not turned into long calls.  The exceptions to this rule are
12476 that weak function definitions, functions with the @samp{long-call}
12477 attribute or the @samp{section} attribute, and functions that are within
12478 the scope of a @samp{#pragma long_calls} directive are always
12479 turned into long calls.
12481 This feature is not enabled by default.  Specifying
12482 @option{-mno-long-calls} restores the default behavior, as does
12483 placing the function calls within the scope of a @samp{#pragma
12484 long_calls_off} directive.  Note these switches have no effect on how
12485 the compiler generates code to handle function calls via function
12486 pointers.
12488 @item -msingle-pic-base
12489 @opindex msingle-pic-base
12490 Treat the register used for PIC addressing as read-only, rather than
12491 loading it in the prologue for each function.  The runtime system is
12492 responsible for initializing this register with an appropriate value
12493 before execution begins.
12495 @item -mpic-register=@var{reg}
12496 @opindex mpic-register
12497 Specify the register to be used for PIC addressing.
12498 For standard PIC base case, the default will be any suitable register
12499 determined by compiler.  For single PIC base case, the default is
12500 @samp{R9} if target is EABI based or stack-checking is enabled,
12501 otherwise the default is @samp{R10}.
12503 @item -mpic-data-is-text-relative
12504 @opindex mpic-data-is-text-relative
12505 Assume that each data segments are relative to text segment at load time.
12506 Therefore, it permits addressing data using PC-relative operations.
12507 This option is on by default for targets other than VxWorks RTP.
12509 @item -mpoke-function-name
12510 @opindex mpoke-function-name
12511 Write the name of each function into the text section, directly
12512 preceding the function prologue.  The generated code is similar to this:
12514 @smallexample
12515      t0
12516          .ascii "arm_poke_function_name", 0
12517          .align
12518      t1
12519          .word 0xff000000 + (t1 - t0)
12520      arm_poke_function_name
12521          mov     ip, sp
12522          stmfd   sp!, @{fp, ip, lr, pc@}
12523          sub     fp, ip, #4
12524 @end smallexample
12526 When performing a stack backtrace, code can inspect the value of
12527 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
12528 location @code{pc - 12} and the top 8 bits are set, then we know that
12529 there is a function name embedded immediately preceding this location
12530 and has length @code{((pc[-3]) & 0xff000000)}.
12532 @item -mthumb
12533 @itemx -marm
12534 @opindex marm
12535 @opindex mthumb
12537 Select between generating code that executes in ARM and Thumb
12538 states.  The default for most configurations is to generate code
12539 that executes in ARM state, but the default can be changed by
12540 configuring GCC with the @option{--with-mode=}@var{state}
12541 configure option.
12543 @item -mtpcs-frame
12544 @opindex mtpcs-frame
12545 Generate a stack frame that is compliant with the Thumb Procedure Call
12546 Standard for all non-leaf functions.  (A leaf function is one that does
12547 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
12549 @item -mtpcs-leaf-frame
12550 @opindex mtpcs-leaf-frame
12551 Generate a stack frame that is compliant with the Thumb Procedure Call
12552 Standard for all leaf functions.  (A leaf function is one that does
12553 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
12555 @item -mcallee-super-interworking
12556 @opindex mcallee-super-interworking
12557 Gives all externally visible functions in the file being compiled an ARM
12558 instruction set header which switches to Thumb mode before executing the
12559 rest of the function.  This allows these functions to be called from
12560 non-interworking code.  This option is not valid in AAPCS configurations
12561 because interworking is enabled by default.
12563 @item -mcaller-super-interworking
12564 @opindex mcaller-super-interworking
12565 Allows calls via function pointers (including virtual functions) to
12566 execute correctly regardless of whether the target code has been
12567 compiled for interworking or not.  There is a small overhead in the cost
12568 of executing a function pointer if this option is enabled.  This option
12569 is not valid in AAPCS configurations because interworking is enabled
12570 by default.
12572 @item -mtp=@var{name}
12573 @opindex mtp
12574 Specify the access model for the thread local storage pointer.  The valid
12575 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
12576 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
12577 (supported in the arm6k architecture), and @option{auto}, which uses the
12578 best available method for the selected processor.  The default setting is
12579 @option{auto}.
12581 @item -mtls-dialect=@var{dialect}
12582 @opindex mtls-dialect
12583 Specify the dialect to use for accessing thread local storage.  Two
12584 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
12585 @samp{gnu} dialect selects the original GNU scheme for supporting
12586 local and global dynamic TLS models.  The @samp{gnu2} dialect
12587 selects the GNU descriptor scheme, which provides better performance
12588 for shared libraries.  The GNU descriptor scheme is compatible with
12589 the original scheme, but does require new assembler, linker and
12590 library support.  Initial and local exec TLS models are unaffected by
12591 this option and always use the original scheme.
12593 @item -mword-relocations
12594 @opindex mword-relocations
12595 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
12596 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
12597 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
12598 is specified.
12600 @item -mfix-cortex-m3-ldrd
12601 @opindex mfix-cortex-m3-ldrd
12602 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
12603 with overlapping destination and base registers are used.  This option avoids
12604 generating these instructions.  This option is enabled by default when
12605 @option{-mcpu=cortex-m3} is specified.
12607 @item -munaligned-access
12608 @itemx -mno-unaligned-access
12609 @opindex munaligned-access
12610 @opindex mno-unaligned-access
12611 Enables (or disables) reading and writing of 16- and 32- bit values
12612 from addresses that are not 16- or 32- bit aligned.  By default
12613 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
12614 architectures, and enabled for all other architectures.  If unaligned
12615 access is not enabled then words in packed data structures will be
12616 accessed a byte at a time.
12618 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
12619 generated object file to either true or false, depending upon the
12620 setting of this option.  If unaligned access is enabled then the
12621 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
12622 defined.
12624 @item -mneon-for-64bits
12625 @opindex mneon-for-64bits
12626 Enables using Neon to handle scalar 64-bits operations. This is
12627 disabled by default since the cost of moving data from core registers
12628 to Neon is high.
12630 @item -mslow-flash-data
12631 @opindex mslow-flash-data
12632 Assume loading data from flash is slower than fetching instruction.
12633 Therefore literal load is minimized for better performance.
12634 This option is only supported when compiling for ARMv7 M-profile and
12635 off by default.
12637 @item -mrestrict-it
12638 @opindex mrestrict-it
12639 Restricts generation of IT blocks to conform to the rules of ARMv8.
12640 IT blocks can only contain a single 16-bit instruction from a select
12641 set of instructions. This option is on by default for ARMv8 Thumb mode.
12642 @end table
12644 @node AVR Options
12645 @subsection AVR Options
12646 @cindex AVR Options
12648 These options are defined for AVR implementations:
12650 @table @gcctabopt
12651 @item -mmcu=@var{mcu}
12652 @opindex mmcu
12653 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
12655 The default for this option is@tie{}@code{avr2}.
12657 GCC supports the following AVR devices and ISAs:
12659 @include avr-mmcu.texi
12661 @item -maccumulate-args
12662 @opindex maccumulate-args
12663 Accumulate outgoing function arguments and acquire/release the needed
12664 stack space for outgoing function arguments once in function
12665 prologue/epilogue.  Without this option, outgoing arguments are pushed
12666 before calling a function and popped afterwards.
12668 Popping the arguments after the function call can be expensive on
12669 AVR so that accumulating the stack space might lead to smaller
12670 executables because arguments need not to be removed from the
12671 stack after such a function call.
12673 This option can lead to reduced code size for functions that perform
12674 several calls to functions that get their arguments on the stack like
12675 calls to printf-like functions.
12677 @item -mbranch-cost=@var{cost}
12678 @opindex mbranch-cost
12679 Set the branch costs for conditional branch instructions to
12680 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
12681 integers. The default branch cost is 0.
12683 @item -mcall-prologues
12684 @opindex mcall-prologues
12685 Functions prologues/epilogues are expanded as calls to appropriate
12686 subroutines.  Code size is smaller.
12688 @item -mint8
12689 @opindex mint8
12690 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
12691 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
12692 and @code{long long} is 4 bytes.  Please note that this option does not
12693 conform to the C standards, but it results in smaller code
12694 size.
12696 @item -mno-interrupts
12697 @opindex mno-interrupts
12698 Generated code is not compatible with hardware interrupts.
12699 Code size is smaller.
12701 @item -mrelax
12702 @opindex mrelax
12703 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
12704 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
12705 Setting @code{-mrelax} just adds the @code{--relax} option to the
12706 linker command line when the linker is called.
12708 Jump relaxing is performed by the linker because jump offsets are not
12709 known before code is located. Therefore, the assembler code generated by the
12710 compiler is the same, but the instructions in the executable may
12711 differ from instructions in the assembler code.
12713 Relaxing must be turned on if linker stubs are needed, see the
12714 section on @code{EIND} and linker stubs below.
12716 @item -msp8
12717 @opindex msp8
12718 Treat the stack pointer register as an 8-bit register,
12719 i.e.@: assume the high byte of the stack pointer is zero.
12720 In general, you don't need to set this option by hand.
12722 This option is used internally by the compiler to select and
12723 build multilibs for architectures @code{avr2} and @code{avr25}.
12724 These architectures mix devices with and without @code{SPH}.
12725 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
12726 the compiler driver will add or remove this option from the compiler
12727 proper's command line, because the compiler then knows if the device
12728 or architecture has an 8-bit stack pointer and thus no @code{SPH}
12729 register or not.
12731 @item -mstrict-X
12732 @opindex mstrict-X
12733 Use address register @code{X} in a way proposed by the hardware.  This means
12734 that @code{X} is only used in indirect, post-increment or
12735 pre-decrement addressing.
12737 Without this option, the @code{X} register may be used in the same way
12738 as @code{Y} or @code{Z} which then is emulated by additional
12739 instructions.  
12740 For example, loading a value with @code{X+const} addressing with a
12741 small non-negative @code{const < 64} to a register @var{Rn} is
12742 performed as
12744 @example
12745 adiw r26, const   ; X += const
12746 ld   @var{Rn}, X        ; @var{Rn} = *X
12747 sbiw r26, const   ; X -= const
12748 @end example
12750 @item -mtiny-stack
12751 @opindex mtiny-stack
12752 Only change the lower 8@tie{}bits of the stack pointer.
12754 @item -Waddr-space-convert
12755 @opindex Waddr-space-convert
12756 Warn about conversions between address spaces in the case where the
12757 resulting address space is not contained in the incoming address space.
12758 @end table
12760 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
12761 @cindex @code{EIND}
12762 Pointers in the implementation are 16@tie{}bits wide.
12763 The address of a function or label is represented as word address so
12764 that indirect jumps and calls can target any code address in the
12765 range of 64@tie{}Ki words.
12767 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
12768 bytes of program memory space, there is a special function register called
12769 @code{EIND} that serves as most significant part of the target address
12770 when @code{EICALL} or @code{EIJMP} instructions are used.
12772 Indirect jumps and calls on these devices are handled as follows by
12773 the compiler and are subject to some limitations:
12775 @itemize @bullet
12777 @item
12778 The compiler never sets @code{EIND}.
12780 @item
12781 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
12782 instructions or might read @code{EIND} directly in order to emulate an
12783 indirect call/jump by means of a @code{RET} instruction.
12785 @item
12786 The compiler assumes that @code{EIND} never changes during the startup
12787 code or during the application. In particular, @code{EIND} is not
12788 saved/restored in function or interrupt service routine
12789 prologue/epilogue.
12791 @item
12792 For indirect calls to functions and computed goto, the linker
12793 generates @emph{stubs}. Stubs are jump pads sometimes also called
12794 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
12795 The stub contains a direct jump to the desired address.
12797 @item
12798 Linker relaxation must be turned on so that the linker will generate
12799 the stubs correctly an all situaltion. See the compiler option
12800 @code{-mrelax} and the linler option @code{--relax}.
12801 There are corner cases where the linker is supposed to generate stubs
12802 but aborts without relaxation and without a helpful error message.
12804 @item
12805 The default linker script is arranged for code with @code{EIND = 0}.
12806 If code is supposed to work for a setup with @code{EIND != 0}, a custom
12807 linker script has to be used in order to place the sections whose
12808 name start with @code{.trampolines} into the segment where @code{EIND}
12809 points to.
12811 @item
12812 The startup code from libgcc never sets @code{EIND}.
12813 Notice that startup code is a blend of code from libgcc and AVR-LibC.
12814 For the impact of AVR-LibC on @code{EIND}, see the
12815 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
12817 @item
12818 It is legitimate for user-specific startup code to set up @code{EIND}
12819 early, for example by means of initialization code located in
12820 section @code{.init3}. Such code runs prior to general startup code
12821 that initializes RAM and calls constructors, but after the bit
12822 of startup code from AVR-LibC that sets @code{EIND} to the segment
12823 where the vector table is located.
12824 @example
12825 #include <avr/io.h>
12827 static void
12828 __attribute__((section(".init3"),naked,used,no_instrument_function))
12829 init3_set_eind (void)
12831   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
12832                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
12834 @end example
12836 @noindent
12837 The @code{__trampolines_start} symbol is defined in the linker script.
12839 @item
12840 Stubs are generated automatically by the linker if
12841 the following two conditions are met:
12842 @itemize @minus
12844 @item The address of a label is taken by means of the @code{gs} modifier
12845 (short for @emph{generate stubs}) like so:
12846 @example
12847 LDI r24, lo8(gs(@var{func}))
12848 LDI r25, hi8(gs(@var{func}))
12849 @end example
12850 @item The final location of that label is in a code segment
12851 @emph{outside} the segment where the stubs are located.
12852 @end itemize
12854 @item
12855 The compiler emits such @code{gs} modifiers for code labels in the
12856 following situations:
12857 @itemize @minus
12858 @item Taking address of a function or code label.
12859 @item Computed goto.
12860 @item If prologue-save function is used, see @option{-mcall-prologues}
12861 command-line option.
12862 @item Switch/case dispatch tables. If you do not want such dispatch
12863 tables you can specify the @option{-fno-jump-tables} command-line option.
12864 @item C and C++ constructors/destructors called during startup/shutdown.
12865 @item If the tools hit a @code{gs()} modifier explained above.
12866 @end itemize
12868 @item
12869 Jumping to non-symbolic addresses like so is @emph{not} supported:
12871 @example
12872 int main (void)
12874     /* Call function at word address 0x2 */
12875     return ((int(*)(void)) 0x2)();
12877 @end example
12879 Instead, a stub has to be set up, i.e.@: the function has to be called
12880 through a symbol (@code{func_4} in the example):
12882 @example
12883 int main (void)
12885     extern int func_4 (void);
12887     /* Call function at byte address 0x4 */
12888     return func_4();
12890 @end example
12892 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
12893 Alternatively, @code{func_4} can be defined in the linker script.
12894 @end itemize
12896 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
12897 @cindex @code{RAMPD}
12898 @cindex @code{RAMPX}
12899 @cindex @code{RAMPY}
12900 @cindex @code{RAMPZ}
12901 Some AVR devices support memories larger than the 64@tie{}KiB range
12902 that can be accessed with 16-bit pointers.  To access memory locations
12903 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
12904 register is used as high part of the address:
12905 The @code{X}, @code{Y}, @code{Z} address register is concatenated
12906 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
12907 register, respectively, to get a wide address. Similarly,
12908 @code{RAMPD} is used together with direct addressing.
12910 @itemize
12911 @item
12912 The startup code initializes the @code{RAMP} special function
12913 registers with zero.
12915 @item
12916 If a @ref{AVR Named Address Spaces,named address space} other than
12917 generic or @code{__flash} is used, then @code{RAMPZ} is set
12918 as needed before the operation.
12920 @item
12921 If the device supports RAM larger than 64@tie{}KiB and the compiler
12922 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
12923 is reset to zero after the operation.
12925 @item
12926 If the device comes with a specific @code{RAMP} register, the ISR
12927 prologue/epilogue saves/restores that SFR and initializes it with
12928 zero in case the ISR code might (implicitly) use it.
12930 @item
12931 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
12932 If you use inline assembler to read from locations outside the
12933 16-bit address range and change one of the @code{RAMP} registers,
12934 you must reset it to zero after the access.
12936 @end itemize
12938 @subsubsection AVR Built-in Macros
12940 GCC defines several built-in macros so that the user code can test
12941 for the presence or absence of features.  Almost any of the following
12942 built-in macros are deduced from device capabilities and thus
12943 triggered by the @code{-mmcu=} command-line option.
12945 For even more AVR-specific built-in macros see
12946 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
12948 @table @code
12950 @item __AVR_ARCH__
12951 Build-in macro that resolves to a decimal number that identifies the
12952 architecture and depends on the @code{-mmcu=@var{mcu}} option.
12953 Possible values are:
12955 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
12956 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
12957 @code{105}, @code{106}, @code{107}
12959 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
12960 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
12961 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
12962 @code{avrxmega6}, @code{avrxmega7}, respectively.
12963 If @var{mcu} specifies a device, this built-in macro is set
12964 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
12965 defined to @code{4}.
12967 @item __AVR_@var{Device}__
12968 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
12969 the device's name. For example, @code{-mmcu=atmega8} defines the
12970 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
12971 @code{__AVR_ATtiny261A__}, etc.
12973 The built-in macros' names follow
12974 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
12975 the device name as from the AVR user manual. The difference between
12976 @var{Device} in the built-in macro and @var{device} in
12977 @code{-mmcu=@var{device}} is that the latter is always lowercase.
12979 If @var{device} is not a device but only a core architecture like
12980 @code{avr51}, this macro will not be defined.
12982 @item __AVR_XMEGA__
12983 The device / architecture belongs to the XMEGA family of devices.
12985 @item __AVR_HAVE_ELPM__
12986 The device has the the @code{ELPM} instruction.
12988 @item __AVR_HAVE_ELPMX__
12989 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
12990 R@var{n},Z+} instructions.
12992 @item __AVR_HAVE_MOVW__
12993 The device has the @code{MOVW} instruction to perform 16-bit
12994 register-register moves.
12996 @item __AVR_HAVE_LPMX__
12997 The device has the @code{LPM R@var{n},Z} and
12998 @code{LPM R@var{n},Z+} instructions.
13000 @item __AVR_HAVE_MUL__
13001 The device has a hardware multiplier. 
13003 @item __AVR_HAVE_JMP_CALL__
13004 The device has the @code{JMP} and @code{CALL} instructions.
13005 This is the case for devices with at least 16@tie{}KiB of program
13006 memory.
13008 @item __AVR_HAVE_EIJMP_EICALL__
13009 @itemx __AVR_3_BYTE_PC__
13010 The device has the @code{EIJMP} and @code{EICALL} instructions.
13011 This is the case for devices with more than 128@tie{}KiB of program memory.
13012 This also means that the program counter
13013 (PC) is 3@tie{}bytes wide.
13015 @item __AVR_2_BYTE_PC__
13016 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13017 with up to 128@tie{}KiB of program memory.
13019 @item __AVR_HAVE_8BIT_SP__
13020 @itemx __AVR_HAVE_16BIT_SP__
13021 The stack pointer (SP) register is treated as 8-bit respectively
13022 16-bit register by the compiler.
13023 The definition of these macros is affected by @code{-mtiny-stack}.
13025 @item __AVR_HAVE_SPH__
13026 @itemx __AVR_SP8__
13027 The device has the SPH (high part of stack pointer) special function
13028 register or has an 8-bit stack pointer, respectively.
13029 The definition of these macros is affected by @code{-mmcu=} and
13030 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13031 by @code{-msp8}.
13033 @item __AVR_HAVE_RAMPD__
13034 @itemx __AVR_HAVE_RAMPX__
13035 @itemx __AVR_HAVE_RAMPY__
13036 @itemx __AVR_HAVE_RAMPZ__
13037 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13038 @code{RAMPZ} special function register, respectively.
13040 @item __NO_INTERRUPTS__
13041 This macro reflects the @code{-mno-interrupts} command line option.
13043 @item __AVR_ERRATA_SKIP__
13044 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13045 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13046 instructions because of a hardware erratum.  Skip instructions are
13047 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13048 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13049 set.
13051 @item __AVR_ISA_RMW__
13052 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13054 @item __AVR_SFR_OFFSET__=@var{offset}
13055 Instructions that can address I/O special function registers directly
13056 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13057 address as if addressed by an instruction to access RAM like @code{LD}
13058 or @code{STS}. This offset depends on the device architecture and has
13059 to be subtracted from the RAM address in order to get the
13060 respective I/O@tie{}address.
13062 @item __WITH_AVRLIBC__
13063 The compiler is configured to be used together with AVR-Libc.
13064 See the @code{--with-avrlibc} configure option.
13066 @end table
13068 @node Blackfin Options
13069 @subsection Blackfin Options
13070 @cindex Blackfin Options
13072 @table @gcctabopt
13073 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13074 @opindex mcpu=
13075 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13076 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13077 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13078 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13079 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13080 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13081 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13082 @samp{bf561}, @samp{bf592}.
13084 The optional @var{sirevision} specifies the silicon revision of the target
13085 Blackfin processor.  Any workarounds available for the targeted silicon revision
13086 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13087 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13088 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13089 hexadecimal digits representing the major and minor numbers in the silicon
13090 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13091 is not defined.  If @var{sirevision} is @samp{any}, the
13092 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13093 If this optional @var{sirevision} is not used, GCC assumes the latest known
13094 silicon revision of the targeted Blackfin processor.
13096 GCC defines a preprocessor macro for the specified @var{cpu}.
13097 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13098 provided by libgloss to be linked in if @option{-msim} is not given.
13100 Without this option, @samp{bf532} is used as the processor by default.
13102 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13103 only the preprocessor macro is defined.
13105 @item -msim
13106 @opindex msim
13107 Specifies that the program will be run on the simulator.  This causes
13108 the simulator BSP provided by libgloss to be linked in.  This option
13109 has effect only for @samp{bfin-elf} toolchain.
13110 Certain other options, such as @option{-mid-shared-library} and
13111 @option{-mfdpic}, imply @option{-msim}.
13113 @item -momit-leaf-frame-pointer
13114 @opindex momit-leaf-frame-pointer
13115 Don't keep the frame pointer in a register for leaf functions.  This
13116 avoids the instructions to save, set up and restore frame pointers and
13117 makes an extra register available in leaf functions.  The option
13118 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13119 which might make debugging harder.
13121 @item -mspecld-anomaly
13122 @opindex mspecld-anomaly
13123 When enabled, the compiler ensures that the generated code does not
13124 contain speculative loads after jump instructions. If this option is used,
13125 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13127 @item -mno-specld-anomaly
13128 @opindex mno-specld-anomaly
13129 Don't generate extra code to prevent speculative loads from occurring.
13131 @item -mcsync-anomaly
13132 @opindex mcsync-anomaly
13133 When enabled, the compiler ensures that the generated code does not
13134 contain CSYNC or SSYNC instructions too soon after conditional branches.
13135 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13137 @item -mno-csync-anomaly
13138 @opindex mno-csync-anomaly
13139 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13140 occurring too soon after a conditional branch.
13142 @item -mlow-64k
13143 @opindex mlow-64k
13144 When enabled, the compiler is free to take advantage of the knowledge that
13145 the entire program fits into the low 64k of memory.
13147 @item -mno-low-64k
13148 @opindex mno-low-64k
13149 Assume that the program is arbitrarily large.  This is the default.
13151 @item -mstack-check-l1
13152 @opindex mstack-check-l1
13153 Do stack checking using information placed into L1 scratchpad memory by the
13154 uClinux kernel.
13156 @item -mid-shared-library
13157 @opindex mid-shared-library
13158 Generate code that supports shared libraries via the library ID method.
13159 This allows for execute in place and shared libraries in an environment
13160 without virtual memory management.  This option implies @option{-fPIC}.
13161 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13163 @item -mno-id-shared-library
13164 @opindex mno-id-shared-library
13165 Generate code that doesn't assume ID-based shared libraries are being used.
13166 This is the default.
13168 @item -mleaf-id-shared-library
13169 @opindex mleaf-id-shared-library
13170 Generate code that supports shared libraries via the library ID method,
13171 but assumes that this library or executable won't link against any other
13172 ID shared libraries.  That allows the compiler to use faster code for jumps
13173 and calls.
13175 @item -mno-leaf-id-shared-library
13176 @opindex mno-leaf-id-shared-library
13177 Do not assume that the code being compiled won't link against any ID shared
13178 libraries.  Slower code is generated for jump and call insns.
13180 @item -mshared-library-id=n
13181 @opindex mshared-library-id
13182 Specifies the identification number of the ID-based shared library being
13183 compiled.  Specifying a value of 0 generates more compact code; specifying
13184 other values forces the allocation of that number to the current
13185 library but is no more space- or time-efficient than omitting this option.
13187 @item -msep-data
13188 @opindex msep-data
13189 Generate code that allows the data segment to be located in a different
13190 area of memory from the text segment.  This allows for execute in place in
13191 an environment without virtual memory management by eliminating relocations
13192 against the text section.
13194 @item -mno-sep-data
13195 @opindex mno-sep-data
13196 Generate code that assumes that the data segment follows the text segment.
13197 This is the default.
13199 @item -mlong-calls
13200 @itemx -mno-long-calls
13201 @opindex mlong-calls
13202 @opindex mno-long-calls
13203 Tells the compiler to perform function calls by first loading the
13204 address of the function into a register and then performing a subroutine
13205 call on this register.  This switch is needed if the target function
13206 lies outside of the 24-bit addressing range of the offset-based
13207 version of subroutine call instruction.
13209 This feature is not enabled by default.  Specifying
13210 @option{-mno-long-calls} restores the default behavior.  Note these
13211 switches have no effect on how the compiler generates code to handle
13212 function calls via function pointers.
13214 @item -mfast-fp
13215 @opindex mfast-fp
13216 Link with the fast floating-point library. This library relaxes some of
13217 the IEEE floating-point standard's rules for checking inputs against
13218 Not-a-Number (NAN), in the interest of performance.
13220 @item -minline-plt
13221 @opindex minline-plt
13222 Enable inlining of PLT entries in function calls to functions that are
13223 not known to bind locally.  It has no effect without @option{-mfdpic}.
13225 @item -mmulticore
13226 @opindex mmulticore
13227 Build a standalone application for multicore Blackfin processors. 
13228 This option causes proper start files and link scripts supporting 
13229 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13230 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13232 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13233 selects the one-application-per-core programming model.  Without
13234 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13235 programming model is used. In this model, the main function of Core B
13236 should be named as @code{coreb_main}.
13238 If this option is not used, the single-core application programming
13239 model is used.
13241 @item -mcorea
13242 @opindex mcorea
13243 Build a standalone application for Core A of BF561 when using
13244 the one-application-per-core programming model. Proper start files
13245 and link scripts are used to support Core A, and the macro
13246 @code{__BFIN_COREA} is defined.
13247 This option can only be used in conjunction with @option{-mmulticore}.
13249 @item -mcoreb
13250 @opindex mcoreb
13251 Build a standalone application for Core B of BF561 when using
13252 the one-application-per-core programming model. Proper start files
13253 and link scripts are used to support Core B, and the macro
13254 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13255 should be used instead of @code{main}. 
13256 This option can only be used in conjunction with @option{-mmulticore}.
13258 @item -msdram
13259 @opindex msdram
13260 Build a standalone application for SDRAM. Proper start files and
13261 link scripts are used to put the application into SDRAM, and the macro
13262 @code{__BFIN_SDRAM} is defined.
13263 The loader should initialize SDRAM before loading the application.
13265 @item -micplb
13266 @opindex micplb
13267 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13268 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13269 are enabled; for standalone applications the default is off.
13270 @end table
13272 @node C6X Options
13273 @subsection C6X Options
13274 @cindex C6X Options
13276 @table @gcctabopt
13277 @item -march=@var{name}
13278 @opindex march
13279 This specifies the name of the target architecture.  GCC uses this
13280 name to determine what kind of instructions it can emit when generating
13281 assembly code.  Permissible names are: @samp{c62x},
13282 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13284 @item -mbig-endian
13285 @opindex mbig-endian
13286 Generate code for a big-endian target.
13288 @item -mlittle-endian
13289 @opindex mlittle-endian
13290 Generate code for a little-endian target.  This is the default.
13292 @item -msim
13293 @opindex msim
13294 Choose startup files and linker script suitable for the simulator.
13296 @item -msdata=default
13297 @opindex msdata=default
13298 Put small global and static data in the @samp{.neardata} section,
13299 which is pointed to by register @code{B14}.  Put small uninitialized
13300 global and static data in the @samp{.bss} section, which is adjacent
13301 to the @samp{.neardata} section.  Put small read-only data into the
13302 @samp{.rodata} section.  The corresponding sections used for large
13303 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13305 @item -msdata=all
13306 @opindex msdata=all
13307 Put all data, not just small objects, into the sections reserved for
13308 small data, and use addressing relative to the @code{B14} register to
13309 access them.
13311 @item -msdata=none
13312 @opindex msdata=none
13313 Make no use of the sections reserved for small data, and use absolute
13314 addresses to access all data.  Put all initialized global and static
13315 data in the @samp{.fardata} section, and all uninitialized data in the
13316 @samp{.far} section.  Put all constant data into the @samp{.const}
13317 section.
13318 @end table
13320 @node CRIS Options
13321 @subsection CRIS Options
13322 @cindex CRIS Options
13324 These options are defined specifically for the CRIS ports.
13326 @table @gcctabopt
13327 @item -march=@var{architecture-type}
13328 @itemx -mcpu=@var{architecture-type}
13329 @opindex march
13330 @opindex mcpu
13331 Generate code for the specified architecture.  The choices for
13332 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13333 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13334 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13335 @samp{v10}.
13337 @item -mtune=@var{architecture-type}
13338 @opindex mtune
13339 Tune to @var{architecture-type} everything applicable about the generated
13340 code, except for the ABI and the set of available instructions.  The
13341 choices for @var{architecture-type} are the same as for
13342 @option{-march=@var{architecture-type}}.
13344 @item -mmax-stack-frame=@var{n}
13345 @opindex mmax-stack-frame
13346 Warn when the stack frame of a function exceeds @var{n} bytes.
13348 @item -metrax4
13349 @itemx -metrax100
13350 @opindex metrax4
13351 @opindex metrax100
13352 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13353 @option{-march=v3} and @option{-march=v8} respectively.
13355 @item -mmul-bug-workaround
13356 @itemx -mno-mul-bug-workaround
13357 @opindex mmul-bug-workaround
13358 @opindex mno-mul-bug-workaround
13359 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13360 models where it applies.  This option is active by default.
13362 @item -mpdebug
13363 @opindex mpdebug
13364 Enable CRIS-specific verbose debug-related information in the assembly
13365 code.  This option also has the effect of turning off the @samp{#NO_APP}
13366 formatted-code indicator to the assembler at the beginning of the
13367 assembly file.
13369 @item -mcc-init
13370 @opindex mcc-init
13371 Do not use condition-code results from previous instruction; always emit
13372 compare and test instructions before use of condition codes.
13374 @item -mno-side-effects
13375 @opindex mno-side-effects
13376 Do not emit instructions with side effects in addressing modes other than
13377 post-increment.
13379 @item -mstack-align
13380 @itemx -mno-stack-align
13381 @itemx -mdata-align
13382 @itemx -mno-data-align
13383 @itemx -mconst-align
13384 @itemx -mno-const-align
13385 @opindex mstack-align
13386 @opindex mno-stack-align
13387 @opindex mdata-align
13388 @opindex mno-data-align
13389 @opindex mconst-align
13390 @opindex mno-const-align
13391 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13392 stack frame, individual data and constants to be aligned for the maximum
13393 single data access size for the chosen CPU model.  The default is to
13394 arrange for 32-bit alignment.  ABI details such as structure layout are
13395 not affected by these options.
13397 @item -m32-bit
13398 @itemx -m16-bit
13399 @itemx -m8-bit
13400 @opindex m32-bit
13401 @opindex m16-bit
13402 @opindex m8-bit
13403 Similar to the stack- data- and const-align options above, these options
13404 arrange for stack frame, writable data and constants to all be 32-bit,
13405 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13407 @item -mno-prologue-epilogue
13408 @itemx -mprologue-epilogue
13409 @opindex mno-prologue-epilogue
13410 @opindex mprologue-epilogue
13411 With @option{-mno-prologue-epilogue}, the normal function prologue and
13412 epilogue which set up the stack frame are omitted and no return
13413 instructions or return sequences are generated in the code.  Use this
13414 option only together with visual inspection of the compiled code: no
13415 warnings or errors are generated when call-saved registers must be saved,
13416 or storage for local variables needs to be allocated.
13418 @item -mno-gotplt
13419 @itemx -mgotplt
13420 @opindex mno-gotplt
13421 @opindex mgotplt
13422 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13423 instruction sequences that load addresses for functions from the PLT part
13424 of the GOT rather than (traditional on other architectures) calls to the
13425 PLT@.  The default is @option{-mgotplt}.
13427 @item -melf
13428 @opindex melf
13429 Legacy no-op option only recognized with the cris-axis-elf and
13430 cris-axis-linux-gnu targets.
13432 @item -mlinux
13433 @opindex mlinux
13434 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13436 @item -sim
13437 @opindex sim
13438 This option, recognized for the cris-axis-elf, arranges
13439 to link with input-output functions from a simulator library.  Code,
13440 initialized data and zero-initialized data are allocated consecutively.
13442 @item -sim2
13443 @opindex sim2
13444 Like @option{-sim}, but pass linker options to locate initialized data at
13445 0x40000000 and zero-initialized data at 0x80000000.
13446 @end table
13448 @node CR16 Options
13449 @subsection CR16 Options
13450 @cindex CR16 Options
13452 These options are defined specifically for the CR16 ports.
13454 @table @gcctabopt
13456 @item -mmac
13457 @opindex mmac
13458 Enable the use of multiply-accumulate instructions. Disabled by default.
13460 @item -mcr16cplus
13461 @itemx -mcr16c
13462 @opindex mcr16cplus
13463 @opindex mcr16c
13464 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13465 is default.
13467 @item -msim
13468 @opindex msim
13469 Links the library libsim.a which is in compatible with simulator. Applicable
13470 to ELF compiler only.
13472 @item -mint32
13473 @opindex mint32
13474 Choose integer type as 32-bit wide.
13476 @item -mbit-ops
13477 @opindex mbit-ops
13478 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13480 @item -mdata-model=@var{model}
13481 @opindex mdata-model
13482 Choose a data model. The choices for @var{model} are @samp{near},
13483 @samp{far} or @samp{medium}. @samp{medium} is default.
13484 However, @samp{far} is not valid with @option{-mcr16c}, as the
13485 CR16C architecture does not support the far data model.
13486 @end table
13488 @node Darwin Options
13489 @subsection Darwin Options
13490 @cindex Darwin options
13492 These options are defined for all architectures running the Darwin operating
13493 system.
13495 FSF GCC on Darwin does not create ``fat'' object files; it creates
13496 an object file for the single architecture that GCC was built to
13497 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13498 @option{-arch} options are used; it does so by running the compiler or
13499 linker multiple times and joining the results together with
13500 @file{lipo}.
13502 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13503 @samp{i686}) is determined by the flags that specify the ISA
13504 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13505 @option{-force_cpusubtype_ALL} option can be used to override this.
13507 The Darwin tools vary in their behavior when presented with an ISA
13508 mismatch.  The assembler, @file{as}, only permits instructions to
13509 be used that are valid for the subtype of the file it is generating,
13510 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
13511 The linker for shared libraries, @file{/usr/bin/libtool}, fails
13512 and prints an error if asked to create a shared library with a less
13513 restrictive subtype than its input files (for instance, trying to put
13514 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
13515 for executables, @command{ld}, quietly gives the executable the most
13516 restrictive subtype of any of its input files.
13518 @table @gcctabopt
13519 @item -F@var{dir}
13520 @opindex F
13521 Add the framework directory @var{dir} to the head of the list of
13522 directories to be searched for header files.  These directories are
13523 interleaved with those specified by @option{-I} options and are
13524 scanned in a left-to-right order.
13526 A framework directory is a directory with frameworks in it.  A
13527 framework is a directory with a @file{Headers} and/or
13528 @file{PrivateHeaders} directory contained directly in it that ends
13529 in @file{.framework}.  The name of a framework is the name of this
13530 directory excluding the @file{.framework}.  Headers associated with
13531 the framework are found in one of those two directories, with
13532 @file{Headers} being searched first.  A subframework is a framework
13533 directory that is in a framework's @file{Frameworks} directory.
13534 Includes of subframework headers can only appear in a header of a
13535 framework that contains the subframework, or in a sibling subframework
13536 header.  Two subframeworks are siblings if they occur in the same
13537 framework.  A subframework should not have the same name as a
13538 framework; a warning is issued if this is violated.  Currently a
13539 subframework cannot have subframeworks; in the future, the mechanism
13540 may be extended to support this.  The standard frameworks can be found
13541 in @file{/System/Library/Frameworks} and
13542 @file{/Library/Frameworks}.  An example include looks like
13543 @code{#include <Framework/header.h>}, where @file{Framework} denotes
13544 the name of the framework and @file{header.h} is found in the
13545 @file{PrivateHeaders} or @file{Headers} directory.
13547 @item -iframework@var{dir}
13548 @opindex iframework
13549 Like @option{-F} except the directory is a treated as a system
13550 directory.  The main difference between this @option{-iframework} and
13551 @option{-F} is that with @option{-iframework} the compiler does not
13552 warn about constructs contained within header files found via
13553 @var{dir}.  This option is valid only for the C family of languages.
13555 @item -gused
13556 @opindex gused
13557 Emit debugging information for symbols that are used.  For stabs
13558 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
13559 This is by default ON@.
13561 @item -gfull
13562 @opindex gfull
13563 Emit debugging information for all symbols and types.
13565 @item -mmacosx-version-min=@var{version}
13566 The earliest version of MacOS X that this executable will run on
13567 is @var{version}.  Typical values of @var{version} include @code{10.1},
13568 @code{10.2}, and @code{10.3.9}.
13570 If the compiler was built to use the system's headers by default,
13571 then the default for this option is the system version on which the
13572 compiler is running, otherwise the default is to make choices that
13573 are compatible with as many systems and code bases as possible.
13575 @item -mkernel
13576 @opindex mkernel
13577 Enable kernel development mode.  The @option{-mkernel} option sets
13578 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
13579 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
13580 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
13581 applicable.  This mode also sets @option{-mno-altivec},
13582 @option{-msoft-float}, @option{-fno-builtin} and
13583 @option{-mlong-branch} for PowerPC targets.
13585 @item -mone-byte-bool
13586 @opindex mone-byte-bool
13587 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
13588 By default @samp{sizeof(bool)} is @samp{4} when compiling for
13589 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
13590 option has no effect on x86.
13592 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
13593 to generate code that is not binary compatible with code generated
13594 without that switch.  Using this switch may require recompiling all
13595 other modules in a program, including system libraries.  Use this
13596 switch to conform to a non-default data model.
13598 @item -mfix-and-continue
13599 @itemx -ffix-and-continue
13600 @itemx -findirect-data
13601 @opindex mfix-and-continue
13602 @opindex ffix-and-continue
13603 @opindex findirect-data
13604 Generate code suitable for fast turnaround development, such as to
13605 allow GDB to dynamically load @code{.o} files into already-running
13606 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
13607 are provided for backwards compatibility.
13609 @item -all_load
13610 @opindex all_load
13611 Loads all members of static archive libraries.
13612 See man ld(1) for more information.
13614 @item -arch_errors_fatal
13615 @opindex arch_errors_fatal
13616 Cause the errors having to do with files that have the wrong architecture
13617 to be fatal.
13619 @item -bind_at_load
13620 @opindex bind_at_load
13621 Causes the output file to be marked such that the dynamic linker will
13622 bind all undefined references when the file is loaded or launched.
13624 @item -bundle
13625 @opindex bundle
13626 Produce a Mach-o bundle format file.
13627 See man ld(1) for more information.
13629 @item -bundle_loader @var{executable}
13630 @opindex bundle_loader
13631 This option specifies the @var{executable} that will load the build
13632 output file being linked.  See man ld(1) for more information.
13634 @item -dynamiclib
13635 @opindex dynamiclib
13636 When passed this option, GCC produces a dynamic library instead of
13637 an executable when linking, using the Darwin @file{libtool} command.
13639 @item -force_cpusubtype_ALL
13640 @opindex force_cpusubtype_ALL
13641 This causes GCC's output file to have the @var{ALL} subtype, instead of
13642 one controlled by the @option{-mcpu} or @option{-march} option.
13644 @item -allowable_client  @var{client_name}
13645 @itemx -client_name
13646 @itemx -compatibility_version
13647 @itemx -current_version
13648 @itemx -dead_strip
13649 @itemx -dependency-file
13650 @itemx -dylib_file
13651 @itemx -dylinker_install_name
13652 @itemx -dynamic
13653 @itemx -exported_symbols_list
13654 @itemx -filelist
13655 @need 800
13656 @itemx -flat_namespace
13657 @itemx -force_flat_namespace
13658 @itemx -headerpad_max_install_names
13659 @itemx -image_base
13660 @itemx -init
13661 @itemx -install_name
13662 @itemx -keep_private_externs
13663 @itemx -multi_module
13664 @itemx -multiply_defined
13665 @itemx -multiply_defined_unused
13666 @need 800
13667 @itemx -noall_load
13668 @itemx -no_dead_strip_inits_and_terms
13669 @itemx -nofixprebinding
13670 @itemx -nomultidefs
13671 @itemx -noprebind
13672 @itemx -noseglinkedit
13673 @itemx -pagezero_size
13674 @itemx -prebind
13675 @itemx -prebind_all_twolevel_modules
13676 @itemx -private_bundle
13677 @need 800
13678 @itemx -read_only_relocs
13679 @itemx -sectalign
13680 @itemx -sectobjectsymbols
13681 @itemx -whyload
13682 @itemx -seg1addr
13683 @itemx -sectcreate
13684 @itemx -sectobjectsymbols
13685 @itemx -sectorder
13686 @itemx -segaddr
13687 @itemx -segs_read_only_addr
13688 @need 800
13689 @itemx -segs_read_write_addr
13690 @itemx -seg_addr_table
13691 @itemx -seg_addr_table_filename
13692 @itemx -seglinkedit
13693 @itemx -segprot
13694 @itemx -segs_read_only_addr
13695 @itemx -segs_read_write_addr
13696 @itemx -single_module
13697 @itemx -static
13698 @itemx -sub_library
13699 @need 800
13700 @itemx -sub_umbrella
13701 @itemx -twolevel_namespace
13702 @itemx -umbrella
13703 @itemx -undefined
13704 @itemx -unexported_symbols_list
13705 @itemx -weak_reference_mismatches
13706 @itemx -whatsloaded
13707 @opindex allowable_client
13708 @opindex client_name
13709 @opindex compatibility_version
13710 @opindex current_version
13711 @opindex dead_strip
13712 @opindex dependency-file
13713 @opindex dylib_file
13714 @opindex dylinker_install_name
13715 @opindex dynamic
13716 @opindex exported_symbols_list
13717 @opindex filelist
13718 @opindex flat_namespace
13719 @opindex force_flat_namespace
13720 @opindex headerpad_max_install_names
13721 @opindex image_base
13722 @opindex init
13723 @opindex install_name
13724 @opindex keep_private_externs
13725 @opindex multi_module
13726 @opindex multiply_defined
13727 @opindex multiply_defined_unused
13728 @opindex noall_load
13729 @opindex no_dead_strip_inits_and_terms
13730 @opindex nofixprebinding
13731 @opindex nomultidefs
13732 @opindex noprebind
13733 @opindex noseglinkedit
13734 @opindex pagezero_size
13735 @opindex prebind
13736 @opindex prebind_all_twolevel_modules
13737 @opindex private_bundle
13738 @opindex read_only_relocs
13739 @opindex sectalign
13740 @opindex sectobjectsymbols
13741 @opindex whyload
13742 @opindex seg1addr
13743 @opindex sectcreate
13744 @opindex sectobjectsymbols
13745 @opindex sectorder
13746 @opindex segaddr
13747 @opindex segs_read_only_addr
13748 @opindex segs_read_write_addr
13749 @opindex seg_addr_table
13750 @opindex seg_addr_table_filename
13751 @opindex seglinkedit
13752 @opindex segprot
13753 @opindex segs_read_only_addr
13754 @opindex segs_read_write_addr
13755 @opindex single_module
13756 @opindex static
13757 @opindex sub_library
13758 @opindex sub_umbrella
13759 @opindex twolevel_namespace
13760 @opindex umbrella
13761 @opindex undefined
13762 @opindex unexported_symbols_list
13763 @opindex weak_reference_mismatches
13764 @opindex whatsloaded
13765 These options are passed to the Darwin linker.  The Darwin linker man page
13766 describes them in detail.
13767 @end table
13769 @node DEC Alpha Options
13770 @subsection DEC Alpha Options
13772 These @samp{-m} options are defined for the DEC Alpha implementations:
13774 @table @gcctabopt
13775 @item -mno-soft-float
13776 @itemx -msoft-float
13777 @opindex mno-soft-float
13778 @opindex msoft-float
13779 Use (do not use) the hardware floating-point instructions for
13780 floating-point operations.  When @option{-msoft-float} is specified,
13781 functions in @file{libgcc.a} are used to perform floating-point
13782 operations.  Unless they are replaced by routines that emulate the
13783 floating-point operations, or compiled in such a way as to call such
13784 emulations routines, these routines issue floating-point
13785 operations.   If you are compiling for an Alpha without floating-point
13786 operations, you must ensure that the library is built so as not to call
13787 them.
13789 Note that Alpha implementations without floating-point operations are
13790 required to have floating-point registers.
13792 @item -mfp-reg
13793 @itemx -mno-fp-regs
13794 @opindex mfp-reg
13795 @opindex mno-fp-regs
13796 Generate code that uses (does not use) the floating-point register set.
13797 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
13798 register set is not used, floating-point operands are passed in integer
13799 registers as if they were integers and floating-point results are passed
13800 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
13801 so any function with a floating-point argument or return value called by code
13802 compiled with @option{-mno-fp-regs} must also be compiled with that
13803 option.
13805 A typical use of this option is building a kernel that does not use,
13806 and hence need not save and restore, any floating-point registers.
13808 @item -mieee
13809 @opindex mieee
13810 The Alpha architecture implements floating-point hardware optimized for
13811 maximum performance.  It is mostly compliant with the IEEE floating-point
13812 standard.  However, for full compliance, software assistance is
13813 required.  This option generates code fully IEEE-compliant code
13814 @emph{except} that the @var{inexact-flag} is not maintained (see below).
13815 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
13816 defined during compilation.  The resulting code is less efficient but is
13817 able to correctly support denormalized numbers and exceptional IEEE
13818 values such as not-a-number and plus/minus infinity.  Other Alpha
13819 compilers call this option @option{-ieee_with_no_inexact}.
13821 @item -mieee-with-inexact
13822 @opindex mieee-with-inexact
13823 This is like @option{-mieee} except the generated code also maintains
13824 the IEEE @var{inexact-flag}.  Turning on this option causes the
13825 generated code to implement fully-compliant IEEE math.  In addition to
13826 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
13827 macro.  On some Alpha implementations the resulting code may execute
13828 significantly slower than the code generated by default.  Since there is
13829 very little code that depends on the @var{inexact-flag}, you should
13830 normally not specify this option.  Other Alpha compilers call this
13831 option @option{-ieee_with_inexact}.
13833 @item -mfp-trap-mode=@var{trap-mode}
13834 @opindex mfp-trap-mode
13835 This option controls what floating-point related traps are enabled.
13836 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
13837 The trap mode can be set to one of four values:
13839 @table @samp
13840 @item n
13841 This is the default (normal) setting.  The only traps that are enabled
13842 are the ones that cannot be disabled in software (e.g., division by zero
13843 trap).
13845 @item u
13846 In addition to the traps enabled by @samp{n}, underflow traps are enabled
13847 as well.
13849 @item su
13850 Like @samp{u}, but the instructions are marked to be safe for software
13851 completion (see Alpha architecture manual for details).
13853 @item sui
13854 Like @samp{su}, but inexact traps are enabled as well.
13855 @end table
13857 @item -mfp-rounding-mode=@var{rounding-mode}
13858 @opindex mfp-rounding-mode
13859 Selects the IEEE rounding mode.  Other Alpha compilers call this option
13860 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
13863 @table @samp
13864 @item n
13865 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
13866 the nearest machine number or towards the even machine number in case
13867 of a tie.
13869 @item m
13870 Round towards minus infinity.
13872 @item c
13873 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
13875 @item d
13876 Dynamic rounding mode.  A field in the floating-point control register
13877 (@var{fpcr}, see Alpha architecture reference manual) controls the
13878 rounding mode in effect.  The C library initializes this register for
13879 rounding towards plus infinity.  Thus, unless your program modifies the
13880 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
13881 @end table
13883 @item -mtrap-precision=@var{trap-precision}
13884 @opindex mtrap-precision
13885 In the Alpha architecture, floating-point traps are imprecise.  This
13886 means without software assistance it is impossible to recover from a
13887 floating trap and program execution normally needs to be terminated.
13888 GCC can generate code that can assist operating system trap handlers
13889 in determining the exact location that caused a floating-point trap.
13890 Depending on the requirements of an application, different levels of
13891 precisions can be selected:
13893 @table @samp
13894 @item p
13895 Program precision.  This option is the default and means a trap handler
13896 can only identify which program caused a floating-point exception.
13898 @item f
13899 Function precision.  The trap handler can determine the function that
13900 caused a floating-point exception.
13902 @item i
13903 Instruction precision.  The trap handler can determine the exact
13904 instruction that caused a floating-point exception.
13905 @end table
13907 Other Alpha compilers provide the equivalent options called
13908 @option{-scope_safe} and @option{-resumption_safe}.
13910 @item -mieee-conformant
13911 @opindex mieee-conformant
13912 This option marks the generated code as IEEE conformant.  You must not
13913 use this option unless you also specify @option{-mtrap-precision=i} and either
13914 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
13915 is to emit the line @samp{.eflag 48} in the function prologue of the
13916 generated assembly file.
13918 @item -mbuild-constants
13919 @opindex mbuild-constants
13920 Normally GCC examines a 32- or 64-bit integer constant to
13921 see if it can construct it from smaller constants in two or three
13922 instructions.  If it cannot, it outputs the constant as a literal and
13923 generates code to load it from the data segment at run time.
13925 Use this option to require GCC to construct @emph{all} integer constants
13926 using code, even if it takes more instructions (the maximum is six).
13928 You typically use this option to build a shared library dynamic
13929 loader.  Itself a shared library, it must relocate itself in memory
13930 before it can find the variables and constants in its own data segment.
13932 @item -mbwx
13933 @itemx -mno-bwx
13934 @itemx -mcix
13935 @itemx -mno-cix
13936 @itemx -mfix
13937 @itemx -mno-fix
13938 @itemx -mmax
13939 @itemx -mno-max
13940 @opindex mbwx
13941 @opindex mno-bwx
13942 @opindex mcix
13943 @opindex mno-cix
13944 @opindex mfix
13945 @opindex mno-fix
13946 @opindex mmax
13947 @opindex mno-max
13948 Indicate whether GCC should generate code to use the optional BWX,
13949 CIX, FIX and MAX instruction sets.  The default is to use the instruction
13950 sets supported by the CPU type specified via @option{-mcpu=} option or that
13951 of the CPU on which GCC was built if none is specified.
13953 @item -mfloat-vax
13954 @itemx -mfloat-ieee
13955 @opindex mfloat-vax
13956 @opindex mfloat-ieee
13957 Generate code that uses (does not use) VAX F and G floating-point
13958 arithmetic instead of IEEE single and double precision.
13960 @item -mexplicit-relocs
13961 @itemx -mno-explicit-relocs
13962 @opindex mexplicit-relocs
13963 @opindex mno-explicit-relocs
13964 Older Alpha assemblers provided no way to generate symbol relocations
13965 except via assembler macros.  Use of these macros does not allow
13966 optimal instruction scheduling.  GNU binutils as of version 2.12
13967 supports a new syntax that allows the compiler to explicitly mark
13968 which relocations should apply to which instructions.  This option
13969 is mostly useful for debugging, as GCC detects the capabilities of
13970 the assembler when it is built and sets the default accordingly.
13972 @item -msmall-data
13973 @itemx -mlarge-data
13974 @opindex msmall-data
13975 @opindex mlarge-data
13976 When @option{-mexplicit-relocs} is in effect, static data is
13977 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
13978 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
13979 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
13980 16-bit relocations off of the @code{$gp} register.  This limits the
13981 size of the small data area to 64KB, but allows the variables to be
13982 directly accessed via a single instruction.
13984 The default is @option{-mlarge-data}.  With this option the data area
13985 is limited to just below 2GB@.  Programs that require more than 2GB of
13986 data must use @code{malloc} or @code{mmap} to allocate the data in the
13987 heap instead of in the program's data segment.
13989 When generating code for shared libraries, @option{-fpic} implies
13990 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
13992 @item -msmall-text
13993 @itemx -mlarge-text
13994 @opindex msmall-text
13995 @opindex mlarge-text
13996 When @option{-msmall-text} is used, the compiler assumes that the
13997 code of the entire program (or shared library) fits in 4MB, and is
13998 thus reachable with a branch instruction.  When @option{-msmall-data}
13999 is used, the compiler can assume that all local symbols share the
14000 same @code{$gp} value, and thus reduce the number of instructions
14001 required for a function call from 4 to 1.
14003 The default is @option{-mlarge-text}.
14005 @item -mcpu=@var{cpu_type}
14006 @opindex mcpu
14007 Set the instruction set and instruction scheduling parameters for
14008 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14009 style name or the corresponding chip number.  GCC supports scheduling
14010 parameters for the EV4, EV5 and EV6 family of processors and
14011 chooses the default values for the instruction set from the processor
14012 you specify.  If you do not specify a processor type, GCC defaults
14013 to the processor on which the compiler was built.
14015 Supported values for @var{cpu_type} are
14017 @table @samp
14018 @item ev4
14019 @itemx ev45
14020 @itemx 21064
14021 Schedules as an EV4 and has no instruction set extensions.
14023 @item ev5
14024 @itemx 21164
14025 Schedules as an EV5 and has no instruction set extensions.
14027 @item ev56
14028 @itemx 21164a
14029 Schedules as an EV5 and supports the BWX extension.
14031 @item pca56
14032 @itemx 21164pc
14033 @itemx 21164PC
14034 Schedules as an EV5 and supports the BWX and MAX extensions.
14036 @item ev6
14037 @itemx 21264
14038 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14040 @item ev67
14041 @itemx 21264a
14042 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14043 @end table
14045 Native toolchains also support the value @samp{native},
14046 which selects the best architecture option for the host processor.
14047 @option{-mcpu=native} has no effect if GCC does not recognize
14048 the processor.
14050 @item -mtune=@var{cpu_type}
14051 @opindex mtune
14052 Set only the instruction scheduling parameters for machine type
14053 @var{cpu_type}.  The instruction set is not changed.
14055 Native toolchains also support the value @samp{native},
14056 which selects the best architecture option for the host processor.
14057 @option{-mtune=native} has no effect if GCC does not recognize
14058 the processor.
14060 @item -mmemory-latency=@var{time}
14061 @opindex mmemory-latency
14062 Sets the latency the scheduler should assume for typical memory
14063 references as seen by the application.  This number is highly
14064 dependent on the memory access patterns used by the application
14065 and the size of the external cache on the machine.
14067 Valid options for @var{time} are
14069 @table @samp
14070 @item @var{number}
14071 A decimal number representing clock cycles.
14073 @item L1
14074 @itemx L2
14075 @itemx L3
14076 @itemx main
14077 The compiler contains estimates of the number of clock cycles for
14078 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14079 (also called Dcache, Scache, and Bcache), as well as to main memory.
14080 Note that L3 is only valid for EV5.
14082 @end table
14083 @end table
14085 @node FR30 Options
14086 @subsection FR30 Options
14087 @cindex FR30 Options
14089 These options are defined specifically for the FR30 port.
14091 @table @gcctabopt
14093 @item -msmall-model
14094 @opindex msmall-model
14095 Use the small address space model.  This can produce smaller code, but
14096 it does assume that all symbolic values and addresses fit into a
14097 20-bit range.
14099 @item -mno-lsim
14100 @opindex mno-lsim
14101 Assume that runtime support has been provided and so there is no need
14102 to include the simulator library (@file{libsim.a}) on the linker
14103 command line.
14105 @end table
14107 @node FRV Options
14108 @subsection FRV Options
14109 @cindex FRV Options
14111 @table @gcctabopt
14112 @item -mgpr-32
14113 @opindex mgpr-32
14115 Only use the first 32 general-purpose registers.
14117 @item -mgpr-64
14118 @opindex mgpr-64
14120 Use all 64 general-purpose registers.
14122 @item -mfpr-32
14123 @opindex mfpr-32
14125 Use only the first 32 floating-point registers.
14127 @item -mfpr-64
14128 @opindex mfpr-64
14130 Use all 64 floating-point registers.
14132 @item -mhard-float
14133 @opindex mhard-float
14135 Use hardware instructions for floating-point operations.
14137 @item -msoft-float
14138 @opindex msoft-float
14140 Use library routines for floating-point operations.
14142 @item -malloc-cc
14143 @opindex malloc-cc
14145 Dynamically allocate condition code registers.
14147 @item -mfixed-cc
14148 @opindex mfixed-cc
14150 Do not try to dynamically allocate condition code registers, only
14151 use @code{icc0} and @code{fcc0}.
14153 @item -mdword
14154 @opindex mdword
14156 Change ABI to use double word insns.
14158 @item -mno-dword
14159 @opindex mno-dword
14161 Do not use double word instructions.
14163 @item -mdouble
14164 @opindex mdouble
14166 Use floating-point double instructions.
14168 @item -mno-double
14169 @opindex mno-double
14171 Do not use floating-point double instructions.
14173 @item -mmedia
14174 @opindex mmedia
14176 Use media instructions.
14178 @item -mno-media
14179 @opindex mno-media
14181 Do not use media instructions.
14183 @item -mmuladd
14184 @opindex mmuladd
14186 Use multiply and add/subtract instructions.
14188 @item -mno-muladd
14189 @opindex mno-muladd
14191 Do not use multiply and add/subtract instructions.
14193 @item -mfdpic
14194 @opindex mfdpic
14196 Select the FDPIC ABI, which uses function descriptors to represent
14197 pointers to functions.  Without any PIC/PIE-related options, it
14198 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14199 assumes GOT entries and small data are within a 12-bit range from the
14200 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14201 are computed with 32 bits.
14202 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14204 @item -minline-plt
14205 @opindex minline-plt
14207 Enable inlining of PLT entries in function calls to functions that are
14208 not known to bind locally.  It has no effect without @option{-mfdpic}.
14209 It's enabled by default if optimizing for speed and compiling for
14210 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14211 optimization option such as @option{-O3} or above is present in the
14212 command line.
14214 @item -mTLS
14215 @opindex mTLS
14217 Assume a large TLS segment when generating thread-local code.
14219 @item -mtls
14220 @opindex mtls
14222 Do not assume a large TLS segment when generating thread-local code.
14224 @item -mgprel-ro
14225 @opindex mgprel-ro
14227 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14228 that is known to be in read-only sections.  It's enabled by default,
14229 except for @option{-fpic} or @option{-fpie}: even though it may help
14230 make the global offset table smaller, it trades 1 instruction for 4.
14231 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14232 one of which may be shared by multiple symbols, and it avoids the need
14233 for a GOT entry for the referenced symbol, so it's more likely to be a
14234 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14236 @item -multilib-library-pic
14237 @opindex multilib-library-pic
14239 Link with the (library, not FD) pic libraries.  It's implied by
14240 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14241 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14242 it explicitly.
14244 @item -mlinked-fp
14245 @opindex mlinked-fp
14247 Follow the EABI requirement of always creating a frame pointer whenever
14248 a stack frame is allocated.  This option is enabled by default and can
14249 be disabled with @option{-mno-linked-fp}.
14251 @item -mlong-calls
14252 @opindex mlong-calls
14254 Use indirect addressing to call functions outside the current
14255 compilation unit.  This allows the functions to be placed anywhere
14256 within the 32-bit address space.
14258 @item -malign-labels
14259 @opindex malign-labels
14261 Try to align labels to an 8-byte boundary by inserting NOPs into the
14262 previous packet.  This option only has an effect when VLIW packing
14263 is enabled.  It doesn't create new packets; it merely adds NOPs to
14264 existing ones.
14266 @item -mlibrary-pic
14267 @opindex mlibrary-pic
14269 Generate position-independent EABI code.
14271 @item -macc-4
14272 @opindex macc-4
14274 Use only the first four media accumulator registers.
14276 @item -macc-8
14277 @opindex macc-8
14279 Use all eight media accumulator registers.
14281 @item -mpack
14282 @opindex mpack
14284 Pack VLIW instructions.
14286 @item -mno-pack
14287 @opindex mno-pack
14289 Do not pack VLIW instructions.
14291 @item -mno-eflags
14292 @opindex mno-eflags
14294 Do not mark ABI switches in e_flags.
14296 @item -mcond-move
14297 @opindex mcond-move
14299 Enable the use of conditional-move instructions (default).
14301 This switch is mainly for debugging the compiler and will likely be removed
14302 in a future version.
14304 @item -mno-cond-move
14305 @opindex mno-cond-move
14307 Disable the use of conditional-move instructions.
14309 This switch is mainly for debugging the compiler and will likely be removed
14310 in a future version.
14312 @item -mscc
14313 @opindex mscc
14315 Enable the use of conditional set instructions (default).
14317 This switch is mainly for debugging the compiler and will likely be removed
14318 in a future version.
14320 @item -mno-scc
14321 @opindex mno-scc
14323 Disable the use of conditional set instructions.
14325 This switch is mainly for debugging the compiler and will likely be removed
14326 in a future version.
14328 @item -mcond-exec
14329 @opindex mcond-exec
14331 Enable the use of conditional execution (default).
14333 This switch is mainly for debugging the compiler and will likely be removed
14334 in a future version.
14336 @item -mno-cond-exec
14337 @opindex mno-cond-exec
14339 Disable the use of conditional execution.
14341 This switch is mainly for debugging the compiler and will likely be removed
14342 in a future version.
14344 @item -mvliw-branch
14345 @opindex mvliw-branch
14347 Run a pass to pack branches into VLIW instructions (default).
14349 This switch is mainly for debugging the compiler and will likely be removed
14350 in a future version.
14352 @item -mno-vliw-branch
14353 @opindex mno-vliw-branch
14355 Do not run a pass to pack branches into VLIW instructions.
14357 This switch is mainly for debugging the compiler and will likely be removed
14358 in a future version.
14360 @item -mmulti-cond-exec
14361 @opindex mmulti-cond-exec
14363 Enable optimization of @code{&&} and @code{||} in conditional execution
14364 (default).
14366 This switch is mainly for debugging the compiler and will likely be removed
14367 in a future version.
14369 @item -mno-multi-cond-exec
14370 @opindex mno-multi-cond-exec
14372 Disable optimization of @code{&&} and @code{||} in conditional execution.
14374 This switch is mainly for debugging the compiler and will likely be removed
14375 in a future version.
14377 @item -mnested-cond-exec
14378 @opindex mnested-cond-exec
14380 Enable nested conditional execution optimizations (default).
14382 This switch is mainly for debugging the compiler and will likely be removed
14383 in a future version.
14385 @item -mno-nested-cond-exec
14386 @opindex mno-nested-cond-exec
14388 Disable nested conditional execution optimizations.
14390 This switch is mainly for debugging the compiler and will likely be removed
14391 in a future version.
14393 @item -moptimize-membar
14394 @opindex moptimize-membar
14396 This switch removes redundant @code{membar} instructions from the
14397 compiler-generated code.  It is enabled by default.
14399 @item -mno-optimize-membar
14400 @opindex mno-optimize-membar
14402 This switch disables the automatic removal of redundant @code{membar}
14403 instructions from the generated code.
14405 @item -mtomcat-stats
14406 @opindex mtomcat-stats
14408 Cause gas to print out tomcat statistics.
14410 @item -mcpu=@var{cpu}
14411 @opindex mcpu
14413 Select the processor type for which to generate code.  Possible values are
14414 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14415 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14417 @end table
14419 @node GNU/Linux Options
14420 @subsection GNU/Linux Options
14422 These @samp{-m} options are defined for GNU/Linux targets:
14424 @table @gcctabopt
14425 @item -mglibc
14426 @opindex mglibc
14427 Use the GNU C library.  This is the default except
14428 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14430 @item -muclibc
14431 @opindex muclibc
14432 Use uClibc C library.  This is the default on
14433 @samp{*-*-linux-*uclibc*} targets.
14435 @item -mbionic
14436 @opindex mbionic
14437 Use Bionic C library.  This is the default on
14438 @samp{*-*-linux-*android*} targets.
14440 @item -mandroid
14441 @opindex mandroid
14442 Compile code compatible with Android platform.  This is the default on
14443 @samp{*-*-linux-*android*} targets.
14445 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14446 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14447 this option makes the GCC driver pass Android-specific options to the linker.
14448 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14449 to be defined.
14451 @item -tno-android-cc
14452 @opindex tno-android-cc
14453 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14454 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14455 @option{-fno-rtti} by default.
14457 @item -tno-android-ld
14458 @opindex tno-android-ld
14459 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14460 linking options to the linker.
14462 @end table
14464 @node H8/300 Options
14465 @subsection H8/300 Options
14467 These @samp{-m} options are defined for the H8/300 implementations:
14469 @table @gcctabopt
14470 @item -mrelax
14471 @opindex mrelax
14472 Shorten some address references at link time, when possible; uses the
14473 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14474 ld, Using ld}, for a fuller description.
14476 @item -mh
14477 @opindex mh
14478 Generate code for the H8/300H@.
14480 @item -ms
14481 @opindex ms
14482 Generate code for the H8S@.
14484 @item -mn
14485 @opindex mn
14486 Generate code for the H8S and H8/300H in the normal mode.  This switch
14487 must be used either with @option{-mh} or @option{-ms}.
14489 @item -ms2600
14490 @opindex ms2600
14491 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14493 @item -mexr
14494 @opindex mexr
14495 Extended registers are stored on stack before execution of function
14496 with monitor attribute. Default option is @option{-mexr}.
14497 This option is valid only for H8S targets.
14499 @item -mno-exr
14500 @opindex mno-exr
14501 Extended registers are not stored on stack before execution of function 
14502 with monitor attribute. Default option is @option{-mno-exr}. 
14503 This option is valid only for H8S targets.
14505 @item -mint32
14506 @opindex mint32
14507 Make @code{int} data 32 bits by default.
14509 @item -malign-300
14510 @opindex malign-300
14511 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
14512 The default for the H8/300H and H8S is to align longs and floats on
14513 4-byte boundaries.
14514 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
14515 This option has no effect on the H8/300.
14516 @end table
14518 @node HPPA Options
14519 @subsection HPPA Options
14520 @cindex HPPA Options
14522 These @samp{-m} options are defined for the HPPA family of computers:
14524 @table @gcctabopt
14525 @item -march=@var{architecture-type}
14526 @opindex march
14527 Generate code for the specified architecture.  The choices for
14528 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
14529 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
14530 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
14531 architecture option for your machine.  Code compiled for lower numbered
14532 architectures runs on higher numbered architectures, but not the
14533 other way around.
14535 @item -mpa-risc-1-0
14536 @itemx -mpa-risc-1-1
14537 @itemx -mpa-risc-2-0
14538 @opindex mpa-risc-1-0
14539 @opindex mpa-risc-1-1
14540 @opindex mpa-risc-2-0
14541 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
14543 @item -mjump-in-delay
14544 @opindex mjump-in-delay
14545 Fill delay slots of function calls with unconditional jump instructions
14546 by modifying the return pointer for the function call to be the target
14547 of the conditional jump.
14549 @item -mdisable-fpregs
14550 @opindex mdisable-fpregs
14551 Prevent floating-point registers from being used in any manner.  This is
14552 necessary for compiling kernels that perform lazy context switching of
14553 floating-point registers.  If you use this option and attempt to perform
14554 floating-point operations, the compiler aborts.
14556 @item -mdisable-indexing
14557 @opindex mdisable-indexing
14558 Prevent the compiler from using indexing address modes.  This avoids some
14559 rather obscure problems when compiling MIG generated code under MACH@.
14561 @item -mno-space-regs
14562 @opindex mno-space-regs
14563 Generate code that assumes the target has no space registers.  This allows
14564 GCC to generate faster indirect calls and use unscaled index address modes.
14566 Such code is suitable for level 0 PA systems and kernels.
14568 @item -mfast-indirect-calls
14569 @opindex mfast-indirect-calls
14570 Generate code that assumes calls never cross space boundaries.  This
14571 allows GCC to emit code that performs faster indirect calls.
14573 This option does not work in the presence of shared libraries or nested
14574 functions.
14576 @item -mfixed-range=@var{register-range}
14577 @opindex mfixed-range
14578 Generate code treating the given register range as fixed registers.
14579 A fixed register is one that the register allocator cannot use.  This is
14580 useful when compiling kernel code.  A register range is specified as
14581 two registers separated by a dash.  Multiple register ranges can be
14582 specified separated by a comma.
14584 @item -mlong-load-store
14585 @opindex mlong-load-store
14586 Generate 3-instruction load and store sequences as sometimes required by
14587 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
14588 the HP compilers.
14590 @item -mportable-runtime
14591 @opindex mportable-runtime
14592 Use the portable calling conventions proposed by HP for ELF systems.
14594 @item -mgas
14595 @opindex mgas
14596 Enable the use of assembler directives only GAS understands.
14598 @item -mschedule=@var{cpu-type}
14599 @opindex mschedule
14600 Schedule code according to the constraints for the machine type
14601 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
14602 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
14603 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
14604 proper scheduling option for your machine.  The default scheduling is
14605 @samp{8000}.
14607 @item -mlinker-opt
14608 @opindex mlinker-opt
14609 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
14610 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
14611 linkers in which they give bogus error messages when linking some programs.
14613 @item -msoft-float
14614 @opindex msoft-float
14615 Generate output containing library calls for floating point.
14616 @strong{Warning:} the requisite libraries are not available for all HPPA
14617 targets.  Normally the facilities of the machine's usual C compiler are
14618 used, but this cannot be done directly in cross-compilation.  You must make
14619 your own arrangements to provide suitable library functions for
14620 cross-compilation.
14622 @option{-msoft-float} changes the calling convention in the output file;
14623 therefore, it is only useful if you compile @emph{all} of a program with
14624 this option.  In particular, you need to compile @file{libgcc.a}, the
14625 library that comes with GCC, with @option{-msoft-float} in order for
14626 this to work.
14628 @item -msio
14629 @opindex msio
14630 Generate the predefine, @code{_SIO}, for server IO@.  The default is
14631 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
14632 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
14633 options are available under HP-UX and HI-UX@.
14635 @item -mgnu-ld
14636 @opindex mgnu-ld
14637 Use options specific to GNU @command{ld}.
14638 This passes @option{-shared} to @command{ld} when
14639 building a shared library.  It is the default when GCC is configured,
14640 explicitly or implicitly, with the GNU linker.  This option does not
14641 affect which @command{ld} is called; it only changes what parameters
14642 are passed to that @command{ld}.
14643 The @command{ld} that is called is determined by the
14644 @option{--with-ld} configure option, GCC's program search path, and
14645 finally by the user's @env{PATH}.  The linker used by GCC can be printed
14646 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
14647 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14649 @item -mhp-ld
14650 @opindex mhp-ld
14651 Use options specific to HP @command{ld}.
14652 This passes @option{-b} to @command{ld} when building
14653 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
14654 links.  It is the default when GCC is configured, explicitly or
14655 implicitly, with the HP linker.  This option does not affect
14656 which @command{ld} is called; it only changes what parameters are passed to that
14657 @command{ld}.
14658 The @command{ld} that is called is determined by the @option{--with-ld}
14659 configure option, GCC's program search path, and finally by the user's
14660 @env{PATH}.  The linker used by GCC can be printed using @samp{which
14661 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
14662 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14664 @item -mlong-calls
14665 @opindex mno-long-calls
14666 Generate code that uses long call sequences.  This ensures that a call
14667 is always able to reach linker generated stubs.  The default is to generate
14668 long calls only when the distance from the call site to the beginning
14669 of the function or translation unit, as the case may be, exceeds a
14670 predefined limit set by the branch type being used.  The limits for
14671 normal calls are 7,600,000 and 240,000 bytes, respectively for the
14672 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
14673 240,000 bytes.
14675 Distances are measured from the beginning of functions when using the
14676 @option{-ffunction-sections} option, or when using the @option{-mgas}
14677 and @option{-mno-portable-runtime} options together under HP-UX with
14678 the SOM linker.
14680 It is normally not desirable to use this option as it degrades
14681 performance.  However, it may be useful in large applications,
14682 particularly when partial linking is used to build the application.
14684 The types of long calls used depends on the capabilities of the
14685 assembler and linker, and the type of code being generated.  The
14686 impact on systems that support long absolute calls, and long pic
14687 symbol-difference or pc-relative calls should be relatively small.
14688 However, an indirect call is used on 32-bit ELF systems in pic code
14689 and it is quite long.
14691 @item -munix=@var{unix-std}
14692 @opindex march
14693 Generate compiler predefines and select a startfile for the specified
14694 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
14695 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
14696 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
14697 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
14698 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
14699 and later.
14701 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
14702 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
14703 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
14704 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
14705 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
14706 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
14708 It is @emph{important} to note that this option changes the interfaces
14709 for various library routines.  It also affects the operational behavior
14710 of the C library.  Thus, @emph{extreme} care is needed in using this
14711 option.
14713 Library code that is intended to operate with more than one UNIX
14714 standard must test, set and restore the variable @var{__xpg4_extended_mask}
14715 as appropriate.  Most GNU software doesn't provide this capability.
14717 @item -nolibdld
14718 @opindex nolibdld
14719 Suppress the generation of link options to search libdld.sl when the
14720 @option{-static} option is specified on HP-UX 10 and later.
14722 @item -static
14723 @opindex static
14724 The HP-UX implementation of setlocale in libc has a dependency on
14725 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
14726 when the @option{-static} option is specified, special link options
14727 are needed to resolve this dependency.
14729 On HP-UX 10 and later, the GCC driver adds the necessary options to
14730 link with libdld.sl when the @option{-static} option is specified.
14731 This causes the resulting binary to be dynamic.  On the 64-bit port,
14732 the linkers generate dynamic binaries by default in any case.  The
14733 @option{-nolibdld} option can be used to prevent the GCC driver from
14734 adding these link options.
14736 @item -threads
14737 @opindex threads
14738 Add support for multithreading with the @dfn{dce thread} library
14739 under HP-UX@.  This option sets flags for both the preprocessor and
14740 linker.
14741 @end table
14743 @node i386 and x86-64 Options
14744 @subsection Intel 386 and AMD x86-64 Options
14745 @cindex i386 Options
14746 @cindex x86-64 Options
14747 @cindex Intel 386 Options
14748 @cindex AMD x86-64 Options
14750 These @samp{-m} options are defined for the i386 and x86-64 family of
14751 computers:
14753 @table @gcctabopt
14755 @item -march=@var{cpu-type}
14756 @opindex march
14757 Generate instructions for the machine type @var{cpu-type}.  In contrast to
14758 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
14759 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
14760 to generate code that may not run at all on processors other than the one
14761 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
14762 @option{-mtune=@var{cpu-type}}.
14764 The choices for @var{cpu-type} are:
14766 @table @samp
14767 @item native
14768 This selects the CPU to generate code for at compilation time by determining
14769 the processor type of the compiling machine.  Using @option{-march=native}
14770 enables all instruction subsets supported by the local machine (hence
14771 the result might not run on different machines).  Using @option{-mtune=native}
14772 produces code optimized for the local machine under the constraints
14773 of the selected instruction set.  
14775 @item i386
14776 Original Intel i386 CPU@.
14778 @item i486
14779 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
14781 @item i586
14782 @itemx pentium
14783 Intel Pentium CPU with no MMX support.
14785 @item pentium-mmx
14786 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
14788 @item pentiumpro
14789 Intel Pentium Pro CPU@.
14791 @item i686
14792 When used with @option{-march}, the Pentium Pro
14793 instruction set is used, so the code runs on all i686 family chips.
14794 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
14796 @item pentium2
14797 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
14798 support.
14800 @item pentium3
14801 @itemx pentium3m
14802 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
14803 set support.
14805 @item pentium-m
14806 Intel Pentium M; low-power version of Intel Pentium III CPU
14807 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
14809 @item pentium4
14810 @itemx pentium4m
14811 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
14813 @item prescott
14814 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
14815 set support.
14817 @item nocona
14818 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
14819 SSE2 and SSE3 instruction set support.
14821 @item core2
14822 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
14823 instruction set support.
14825 @item nehalem
14826 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14827 SSE4.1, SSE4.2 and POPCNT instruction set support.
14829 @item westmere
14830 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14831 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
14833 @item sandybridge
14834 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14835 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
14837 @item ivybridge
14838 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14839 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
14840 instruction set support.
14842 @item haswell
14843 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14844 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
14845 BMI, BMI2 and F16C instruction set support.
14847 @item broadwell
14848 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14849 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
14850 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
14852 @item bonnell
14853 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
14854 instruction set support.
14856 @item silvermont
14857 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14858 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
14860 @item k6
14861 AMD K6 CPU with MMX instruction set support.
14863 @item k6-2
14864 @itemx k6-3
14865 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
14867 @item athlon
14868 @itemx athlon-tbird
14869 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
14870 support.
14872 @item athlon-4
14873 @itemx athlon-xp
14874 @itemx athlon-mp
14875 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
14876 instruction set support.
14878 @item k8
14879 @itemx opteron
14880 @itemx athlon64
14881 @itemx athlon-fx
14882 Processors based on the AMD K8 core with x86-64 instruction set support,
14883 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
14884 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
14885 instruction set extensions.)
14887 @item k8-sse3
14888 @itemx opteron-sse3
14889 @itemx athlon64-sse3
14890 Improved versions of AMD K8 cores with SSE3 instruction set support.
14892 @item amdfam10
14893 @itemx barcelona
14894 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
14895 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
14896 instruction set extensions.)
14898 @item bdver1
14899 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
14900 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
14901 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
14902 @item bdver2
14903 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14904 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
14905 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
14906 extensions.)
14907 @item bdver3
14908 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14909 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
14910 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
14911 64-bit instruction set extensions.
14912 @item bdver4
14913 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14914 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
14915 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
14916 SSE4.2, ABM and 64-bit instruction set extensions.
14918 @item btver1
14919 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
14920 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
14921 instruction set extensions.)
14923 @item btver2
14924 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
14925 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
14926 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
14928 @item winchip-c6
14929 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
14930 set support.
14932 @item winchip2
14933 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
14934 instruction set support.
14936 @item c3
14937 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
14938 implemented for this chip.)
14940 @item c3-2
14941 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
14942 (No scheduling is
14943 implemented for this chip.)
14945 @item geode
14946 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
14947 @end table
14949 @item -mtune=@var{cpu-type}
14950 @opindex mtune
14951 Tune to @var{cpu-type} everything applicable about the generated code, except
14952 for the ABI and the set of available instructions.  
14953 While picking a specific @var{cpu-type} schedules things appropriately
14954 for that particular chip, the compiler does not generate any code that
14955 cannot run on the default machine type unless you use a
14956 @option{-march=@var{cpu-type}} option.
14957 For example, if GCC is configured for i686-pc-linux-gnu
14958 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
14959 but still runs on i686 machines.
14961 The choices for @var{cpu-type} are the same as for @option{-march}.
14962 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
14964 @table @samp
14965 @item generic
14966 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
14967 If you know the CPU on which your code will run, then you should use
14968 the corresponding @option{-mtune} or @option{-march} option instead of
14969 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
14970 of your application will have, then you should use this option.
14972 As new processors are deployed in the marketplace, the behavior of this
14973 option will change.  Therefore, if you upgrade to a newer version of
14974 GCC, code generation controlled by this option will change to reflect
14975 the processors
14976 that are most common at the time that version of GCC is released.
14978 There is no @option{-march=generic} option because @option{-march}
14979 indicates the instruction set the compiler can use, and there is no
14980 generic instruction set applicable to all processors.  In contrast,
14981 @option{-mtune} indicates the processor (or, in this case, collection of
14982 processors) for which the code is optimized.
14984 @item intel
14985 Produce code optimized for the most current Intel processors, which are
14986 Haswell and Silvermont for this version of GCC.  If you know the CPU
14987 on which your code will run, then you should use the corresponding
14988 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
14989 But, if you want your application performs better on both Haswell and
14990 Silvermont, then you should use this option.
14992 As new Intel processors are deployed in the marketplace, the behavior of
14993 this option will change.  Therefore, if you upgrade to a newer version of
14994 GCC, code generation controlled by this option will change to reflect
14995 the most current Intel processors at the time that version of GCC is
14996 released.
14998 There is no @option{-march=intel} option because @option{-march} indicates
14999 the instruction set the compiler can use, and there is no common
15000 instruction set applicable to all processors.  In contrast,
15001 @option{-mtune} indicates the processor (or, in this case, collection of
15002 processors) for which the code is optimized.
15003 @end table
15005 @item -mcpu=@var{cpu-type}
15006 @opindex mcpu
15007 A deprecated synonym for @option{-mtune}.
15009 @item -mfpmath=@var{unit}
15010 @opindex mfpmath
15011 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15012 for @var{unit} are:
15014 @table @samp
15015 @item 387
15016 Use the standard 387 floating-point coprocessor present on the majority of chips and
15017 emulated otherwise.  Code compiled with this option runs almost everywhere.
15018 The temporary results are computed in 80-bit precision instead of the precision
15019 specified by the type, resulting in slightly different results compared to most
15020 of other chips.  See @option{-ffloat-store} for more detailed description.
15022 This is the default choice for i386 compiler.
15024 @item sse
15025 Use scalar floating-point instructions present in the SSE instruction set.
15026 This instruction set is supported by Pentium III and newer chips,
15027 and in the AMD line
15028 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15029 instruction set supports only single-precision arithmetic, thus the double and
15030 extended-precision arithmetic are still done using 387.  A later version, present
15031 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15032 arithmetic too.
15034 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15035 or @option{-msse2} switches to enable SSE extensions and make this option
15036 effective.  For the x86-64 compiler, these extensions are enabled by default.
15038 The resulting code should be considerably faster in the majority of cases and avoid
15039 the numerical instability problems of 387 code, but may break some existing
15040 code that expects temporaries to be 80 bits.
15042 This is the default choice for the x86-64 compiler.
15044 @item sse,387
15045 @itemx sse+387
15046 @itemx both
15047 Attempt to utilize both instruction sets at once.  This effectively doubles the
15048 amount of available registers, and on chips with separate execution units for
15049 387 and SSE the execution resources too.  Use this option with care, as it is
15050 still experimental, because the GCC register allocator does not model separate
15051 functional units well, resulting in unstable performance.
15052 @end table
15054 @item -masm=@var{dialect}
15055 @opindex masm=@var{dialect}
15056 Output assembly instructions using selected @var{dialect}.  Supported
15057 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15058 not support @samp{intel}.
15060 @item -mieee-fp
15061 @itemx -mno-ieee-fp
15062 @opindex mieee-fp
15063 @opindex mno-ieee-fp
15064 Control whether or not the compiler uses IEEE floating-point
15065 comparisons.  These correctly handle the case where the result of a
15066 comparison is unordered.
15068 @item -msoft-float
15069 @opindex msoft-float
15070 Generate output containing library calls for floating point.
15072 @strong{Warning:} the requisite libraries are not part of GCC@.
15073 Normally the facilities of the machine's usual C compiler are used, but
15074 this can't be done directly in cross-compilation.  You must make your
15075 own arrangements to provide suitable library functions for
15076 cross-compilation.
15078 On machines where a function returns floating-point results in the 80387
15079 register stack, some floating-point opcodes may be emitted even if
15080 @option{-msoft-float} is used.
15082 @item -mno-fp-ret-in-387
15083 @opindex mno-fp-ret-in-387
15084 Do not use the FPU registers for return values of functions.
15086 The usual calling convention has functions return values of types
15087 @code{float} and @code{double} in an FPU register, even if there
15088 is no FPU@.  The idea is that the operating system should emulate
15089 an FPU@.
15091 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15092 in ordinary CPU registers instead.
15094 @item -mno-fancy-math-387
15095 @opindex mno-fancy-math-387
15096 Some 387 emulators do not support the @code{sin}, @code{cos} and
15097 @code{sqrt} instructions for the 387.  Specify this option to avoid
15098 generating those instructions.  This option is the default on FreeBSD,
15099 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15100 indicates that the target CPU always has an FPU and so the
15101 instruction does not need emulation.  These
15102 instructions are not generated unless you also use the
15103 @option{-funsafe-math-optimizations} switch.
15105 @item -malign-double
15106 @itemx -mno-align-double
15107 @opindex malign-double
15108 @opindex mno-align-double
15109 Control whether GCC aligns @code{double}, @code{long double}, and
15110 @code{long long} variables on a two-word boundary or a one-word
15111 boundary.  Aligning @code{double} variables on a two-word boundary
15112 produces code that runs somewhat faster on a Pentium at the
15113 expense of more memory.
15115 On x86-64, @option{-malign-double} is enabled by default.
15117 @strong{Warning:} if you use the @option{-malign-double} switch,
15118 structures containing the above types are aligned differently than
15119 the published application binary interface specifications for the 386
15120 and are not binary compatible with structures in code compiled
15121 without that switch.
15123 @item -m96bit-long-double
15124 @itemx -m128bit-long-double
15125 @opindex m96bit-long-double
15126 @opindex m128bit-long-double
15127 These switches control the size of @code{long double} type.  The i386
15128 application binary interface specifies the size to be 96 bits,
15129 so @option{-m96bit-long-double} is the default in 32-bit mode.
15131 Modern architectures (Pentium and newer) prefer @code{long double}
15132 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15133 conforming to the ABI, this is not possible.  So specifying
15134 @option{-m128bit-long-double} aligns @code{long double}
15135 to a 16-byte boundary by padding the @code{long double} with an additional
15136 32-bit zero.
15138 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15139 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15141 Notice that neither of these options enable any extra precision over the x87
15142 standard of 80 bits for a @code{long double}.
15144 @strong{Warning:} if you override the default value for your target ABI, this
15145 changes the size of 
15146 structures and arrays containing @code{long double} variables,
15147 as well as modifying the function calling convention for functions taking
15148 @code{long double}.  Hence they are not binary-compatible
15149 with code compiled without that switch.
15151 @item -mlong-double-64
15152 @itemx -mlong-double-80
15153 @itemx -mlong-double-128
15154 @opindex mlong-double-64
15155 @opindex mlong-double-80
15156 @opindex mlong-double-128
15157 These switches control the size of @code{long double} type. A size
15158 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15159 type. This is the default for 32-bit Bionic C library.  A size
15160 of 128 bits makes the @code{long double} type equivalent to the
15161 @code{__float128} type. This is the default for 64-bit Bionic C library.
15163 @strong{Warning:} if you override the default value for your target ABI, this
15164 changes the size of
15165 structures and arrays containing @code{long double} variables,
15166 as well as modifying the function calling convention for functions taking
15167 @code{long double}.  Hence they are not binary-compatible
15168 with code compiled without that switch.
15170 @item -mlarge-data-threshold=@var{threshold}
15171 @opindex mlarge-data-threshold
15172 When @option{-mcmodel=medium} is specified, data objects larger than
15173 @var{threshold} are placed in the large data section.  This value must be the
15174 same across all objects linked into the binary, and defaults to 65535.
15176 @item -mrtd
15177 @opindex mrtd
15178 Use a different function-calling convention, in which functions that
15179 take a fixed number of arguments return with the @code{ret @var{num}}
15180 instruction, which pops their arguments while returning.  This saves one
15181 instruction in the caller since there is no need to pop the arguments
15182 there.
15184 You can specify that an individual function is called with this calling
15185 sequence with the function attribute @samp{stdcall}.  You can also
15186 override the @option{-mrtd} option by using the function attribute
15187 @samp{cdecl}.  @xref{Function Attributes}.
15189 @strong{Warning:} this calling convention is incompatible with the one
15190 normally used on Unix, so you cannot use it if you need to call
15191 libraries compiled with the Unix compiler.
15193 Also, you must provide function prototypes for all functions that
15194 take variable numbers of arguments (including @code{printf});
15195 otherwise incorrect code is generated for calls to those
15196 functions.
15198 In addition, seriously incorrect code results if you call a
15199 function with too many arguments.  (Normally, extra arguments are
15200 harmlessly ignored.)
15202 @item -mregparm=@var{num}
15203 @opindex mregparm
15204 Control how many registers are used to pass integer arguments.  By
15205 default, no registers are used to pass arguments, and at most 3
15206 registers can be used.  You can control this behavior for a specific
15207 function by using the function attribute @samp{regparm}.
15208 @xref{Function Attributes}.
15210 @strong{Warning:} if you use this switch, and
15211 @var{num} is nonzero, then you must build all modules with the same
15212 value, including any libraries.  This includes the system libraries and
15213 startup modules.
15215 @item -msseregparm
15216 @opindex msseregparm
15217 Use SSE register passing conventions for float and double arguments
15218 and return values.  You can control this behavior for a specific
15219 function by using the function attribute @samp{sseregparm}.
15220 @xref{Function Attributes}.
15222 @strong{Warning:} if you use this switch then you must build all
15223 modules with the same value, including any libraries.  This includes
15224 the system libraries and startup modules.
15226 @item -mvect8-ret-in-mem
15227 @opindex mvect8-ret-in-mem
15228 Return 8-byte vectors in memory instead of MMX registers.  This is the
15229 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15230 Studio compilers until version 12.  Later compiler versions (starting
15231 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15232 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15233 you need to remain compatible with existing code produced by those
15234 previous compiler versions or older versions of GCC@.
15236 @item -mpc32
15237 @itemx -mpc64
15238 @itemx -mpc80
15239 @opindex mpc32
15240 @opindex mpc64
15241 @opindex mpc80
15243 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15244 is specified, the significands of results of floating-point operations are
15245 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15246 significands of results of floating-point operations to 53 bits (double
15247 precision) and @option{-mpc80} rounds the significands of results of
15248 floating-point operations to 64 bits (extended double precision), which is
15249 the default.  When this option is used, floating-point operations in higher
15250 precisions are not available to the programmer without setting the FPU
15251 control word explicitly.
15253 Setting the rounding of floating-point operations to less than the default
15254 80 bits can speed some programs by 2% or more.  Note that some mathematical
15255 libraries assume that extended-precision (80-bit) floating-point operations
15256 are enabled by default; routines in such libraries could suffer significant
15257 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15258 when this option is used to set the precision to less than extended precision.
15260 @item -mstackrealign
15261 @opindex mstackrealign
15262 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15263 option generates an alternate prologue and epilogue that realigns the
15264 run-time stack if necessary.  This supports mixing legacy codes that keep
15265 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15266 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15267 applicable to individual functions.
15269 @item -mpreferred-stack-boundary=@var{num}
15270 @opindex mpreferred-stack-boundary
15271 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15272 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15273 the default is 4 (16 bytes or 128 bits).
15275 @strong{Warning:} When generating code for the x86-64 architecture with
15276 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15277 used to keep the stack boundary aligned to 8 byte boundary.  Since
15278 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15279 intended to be used in controlled environment where stack space is
15280 important limitation.  This option will lead to wrong code when functions
15281 compiled with 16 byte stack alignment (such as functions from a standard
15282 library) are called with misaligned stack.  In this case, SSE
15283 instructions may lead to misaligned memory access traps.  In addition,
15284 variable arguments will be handled incorrectly for 16 byte aligned
15285 objects (including x87 long double and __int128), leading to wrong
15286 results.  You must build all modules with
15287 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15288 includes the system libraries and startup modules.
15290 @item -mincoming-stack-boundary=@var{num}
15291 @opindex mincoming-stack-boundary
15292 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15293 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15294 the one specified by @option{-mpreferred-stack-boundary} is used.
15296 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15297 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15298 suffer significant run time performance penalties.  On Pentium III, the
15299 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15300 properly if it is not 16-byte aligned.
15302 To ensure proper alignment of this values on the stack, the stack boundary
15303 must be as aligned as that required by any value stored on the stack.
15304 Further, every function must be generated such that it keeps the stack
15305 aligned.  Thus calling a function compiled with a higher preferred
15306 stack boundary from a function compiled with a lower preferred stack
15307 boundary most likely misaligns the stack.  It is recommended that
15308 libraries that use callbacks always use the default setting.
15310 This extra alignment does consume extra stack space, and generally
15311 increases code size.  Code that is sensitive to stack space usage, such
15312 as embedded systems and operating system kernels, may want to reduce the
15313 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15315 @item -mmmx
15316 @itemx -mno-mmx
15317 @itemx -msse
15318 @itemx -mno-sse
15319 @itemx -msse2
15320 @itemx -mno-sse2
15321 @itemx -msse3
15322 @itemx -mno-sse3
15323 @itemx -mssse3
15324 @itemx -mno-ssse3
15325 @itemx -msse4.1
15326 @need 800
15327 @itemx -mno-sse4.1
15328 @itemx -msse4.2
15329 @itemx -mno-sse4.2
15330 @itemx -msse4
15331 @itemx -mno-sse4
15332 @itemx -mavx
15333 @itemx -mno-avx
15334 @itemx -mavx2
15335 @itemx -mno-avx2
15336 @itemx -mavx512f
15337 @itemx -mno-avx512f
15338 @need 800
15339 @itemx -mavx512pf
15340 @itemx -mno-avx512pf
15341 @itemx -mavx512er
15342 @itemx -mno-avx512er
15343 @itemx -mavx512cd
15344 @itemx -mno-avx512cd
15345 @itemx -msha
15346 @itemx -mno-sha
15347 @itemx -maes
15348 @itemx -mno-aes
15349 @itemx -mpclmul
15350 @itemx -mno-pclmul
15351 @need 800
15352 @itemx -mfsgsbase
15353 @itemx -mno-fsgsbase
15354 @itemx -mrdrnd
15355 @itemx -mno-rdrnd
15356 @itemx -mf16c
15357 @itemx -mno-f16c
15358 @itemx -mfma
15359 @itemx -mno-fma
15360 @itemx -mprefetchwt1
15361 @itemx -mno-prefetchwt1
15362 @itemx -msse4a
15363 @itemx -mno-sse4a
15364 @itemx -mfma4
15365 @itemx -mno-fma4
15366 @need 800
15367 @itemx -mxop
15368 @itemx -mno-xop
15369 @itemx -mlwp
15370 @itemx -mno-lwp
15371 @itemx -m3dnow
15372 @itemx -mno-3dnow
15373 @itemx -mpopcnt
15374 @itemx -mno-popcnt
15375 @itemx -mabm
15376 @itemx -mno-abm
15377 @itemx -mbmi
15378 @itemx -mbmi2
15379 @itemx -mno-bmi
15380 @itemx -mno-bmi2
15381 @itemx -mlzcnt
15382 @itemx -mno-lzcnt
15383 @itemx -mfxsr
15384 @itemx -mxsave
15385 @itemx -mxsaveopt
15386 @itemx -mrtm
15387 @itemx -mtbm
15388 @itemx -mno-tbm
15389 @opindex mmmx
15390 @opindex mno-mmx
15391 @opindex msse
15392 @opindex mno-sse
15393 @opindex m3dnow
15394 @opindex mno-3dnow
15395 These switches enable or disable the use of instructions in the MMX, SSE,
15396 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15397 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15398 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, or 3DNow!@:
15399 extended instruction sets.
15400 These extensions are also available as built-in functions: see
15401 @ref{X86 Built-in Functions}, for details of the functions enabled and
15402 disabled by these switches.
15404 To generate SSE/SSE2 instructions automatically from floating-point
15405 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15407 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15408 generates new AVX instructions or AVX equivalence for all SSEx instructions
15409 when needed.
15411 These options enable GCC to use these extended instructions in
15412 generated code, even without @option{-mfpmath=sse}.  Applications that
15413 perform run-time CPU detection must compile separate files for each
15414 supported architecture, using the appropriate flags.  In particular,
15415 the file containing the CPU detection code should be compiled without
15416 these options.
15418 @item -mdump-tune-features
15419 @opindex mdump-tune-features
15420 This option instructs GCC to dump the names of the x86 performance 
15421 tuning features and default settings. The names can be used in 
15422 @option{-mtune-ctrl=@var{feature-list}}.
15424 @item -mtune-ctrl=@var{feature-list}
15425 @opindex mtune-ctrl=@var{feature-list}
15426 This option is used to do fine grain control of x86 code generation features.
15427 @var{feature-list} is a comma separated list of @var{feature} names. See also
15428 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15429 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15430 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15431 developers. Using it may lead to code paths not covered by testing and can
15432 potentially result in compiler ICEs or runtime errors.
15434 @item -mno-default
15435 @opindex mno-default
15436 This option instructs GCC to turn off all tunable features. See also 
15437 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15439 @item -mcld
15440 @opindex mcld
15441 This option instructs GCC to emit a @code{cld} instruction in the prologue
15442 of functions that use string instructions.  String instructions depend on
15443 the DF flag to select between autoincrement or autodecrement mode.  While the
15444 ABI specifies the DF flag to be cleared on function entry, some operating
15445 systems violate this specification by not clearing the DF flag in their
15446 exception dispatchers.  The exception handler can be invoked with the DF flag
15447 set, which leads to wrong direction mode when string instructions are used.
15448 This option can be enabled by default on 32-bit x86 targets by configuring
15449 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15450 instructions can be suppressed with the @option{-mno-cld} compiler option
15451 in this case.
15453 @item -mvzeroupper
15454 @opindex mvzeroupper
15455 This option instructs GCC to emit a @code{vzeroupper} instruction
15456 before a transfer of control flow out of the function to minimize
15457 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15458 intrinsics.
15460 @item -mprefer-avx128
15461 @opindex mprefer-avx128
15462 This option instructs GCC to use 128-bit AVX instructions instead of
15463 256-bit AVX instructions in the auto-vectorizer.
15465 @item -mcx16
15466 @opindex mcx16
15467 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15468 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15469 (or oword) data types.  
15470 This is useful for high-resolution counters that can be updated
15471 by multiple processors (or cores).  This instruction is generated as part of
15472 atomic built-in functions: see @ref{__sync Builtins} or
15473 @ref{__atomic Builtins} for details.
15475 @item -msahf
15476 @opindex msahf
15477 This option enables generation of @code{SAHF} instructions in 64-bit code.
15478 Early Intel Pentium 4 CPUs with Intel 64 support,
15479 prior to the introduction of Pentium 4 G1 step in December 2005,
15480 lacked the @code{LAHF} and @code{SAHF} instructions
15481 which were supported by AMD64.
15482 These are load and store instructions, respectively, for certain status flags.
15483 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15484 @code{drem}, and @code{remainder} built-in functions;
15485 see @ref{Other Builtins} for details.
15487 @item -mmovbe
15488 @opindex mmovbe
15489 This option enables use of the @code{movbe} instruction to implement
15490 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15492 @item -mcrc32
15493 @opindex mcrc32
15494 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15495 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15496 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15498 @item -mrecip
15499 @opindex mrecip
15500 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
15501 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
15502 with an additional Newton-Raphson step
15503 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
15504 (and their vectorized
15505 variants) for single-precision floating-point arguments.  These instructions
15506 are generated only when @option{-funsafe-math-optimizations} is enabled
15507 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
15508 Note that while the throughput of the sequence is higher than the throughput
15509 of the non-reciprocal instruction, the precision of the sequence can be
15510 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
15512 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
15513 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
15514 combination), and doesn't need @option{-mrecip}.
15516 Also note that GCC emits the above sequence with additional Newton-Raphson step
15517 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
15518 already with @option{-ffast-math} (or the above option combination), and
15519 doesn't need @option{-mrecip}.
15521 @item -mrecip=@var{opt}
15522 @opindex mrecip=opt
15523 This option controls which reciprocal estimate instructions
15524 may be used.  @var{opt} is a comma-separated list of options, which may
15525 be preceded by a @samp{!} to invert the option:
15527 @table @samp
15528 @item all
15529 Enable all estimate instructions.
15531 @item default
15532 Enable the default instructions, equivalent to @option{-mrecip}.
15534 @item none
15535 Disable all estimate instructions, equivalent to @option{-mno-recip}.
15537 @item div
15538 Enable the approximation for scalar division.
15540 @item vec-div
15541 Enable the approximation for vectorized division.
15543 @item sqrt
15544 Enable the approximation for scalar square root.
15546 @item vec-sqrt
15547 Enable the approximation for vectorized square root.
15548 @end table
15550 So, for example, @option{-mrecip=all,!sqrt} enables
15551 all of the reciprocal approximations, except for square root.
15553 @item -mveclibabi=@var{type}
15554 @opindex mveclibabi
15555 Specifies the ABI type to use for vectorizing intrinsics using an
15556 external library.  Supported values for @var{type} are @samp{svml} 
15557 for the Intel short
15558 vector math library and @samp{acml} for the AMD math core library.
15559 To use this option, both @option{-ftree-vectorize} and
15560 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
15561 ABI-compatible library must be specified at link time.
15563 GCC currently emits calls to @code{vmldExp2},
15564 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
15565 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
15566 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
15567 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
15568 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
15569 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
15570 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
15571 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
15572 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
15573 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
15574 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
15575 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
15576 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
15577 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
15578 when @option{-mveclibabi=acml} is used.  
15580 @item -mabi=@var{name}
15581 @opindex mabi
15582 Generate code for the specified calling convention.  Permissible values
15583 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
15584 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
15585 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
15586 You can control this behavior for a specific function by
15587 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
15588 @xref{Function Attributes}.
15590 @item -mtls-dialect=@var{type}
15591 @opindex mtls-dialect
15592 Generate code to access thread-local storage using the @samp{gnu} or
15593 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
15594 @samp{gnu2} is more efficient, but it may add compile- and run-time
15595 requirements that cannot be satisfied on all systems.
15597 @item -mpush-args
15598 @itemx -mno-push-args
15599 @opindex mpush-args
15600 @opindex mno-push-args
15601 Use PUSH operations to store outgoing parameters.  This method is shorter
15602 and usually equally fast as method using SUB/MOV operations and is enabled
15603 by default.  In some cases disabling it may improve performance because of
15604 improved scheduling and reduced dependencies.
15606 @item -maccumulate-outgoing-args
15607 @opindex maccumulate-outgoing-args
15608 If enabled, the maximum amount of space required for outgoing arguments is
15609 computed in the function prologue.  This is faster on most modern CPUs
15610 because of reduced dependencies, improved scheduling and reduced stack usage
15611 when the preferred stack boundary is not equal to 2.  The drawback is a notable
15612 increase in code size.  This switch implies @option{-mno-push-args}.
15614 @item -mthreads
15615 @opindex mthreads
15616 Support thread-safe exception handling on MinGW.  Programs that rely
15617 on thread-safe exception handling must compile and link all code with the
15618 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
15619 @code{-D_MT}; when linking, it links in a special thread helper library
15620 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
15622 @item -mno-align-stringops
15623 @opindex mno-align-stringops
15624 Do not align the destination of inlined string operations.  This switch reduces
15625 code size and improves performance in case the destination is already aligned,
15626 but GCC doesn't know about it.
15628 @item -minline-all-stringops
15629 @opindex minline-all-stringops
15630 By default GCC inlines string operations only when the destination is 
15631 known to be aligned to least a 4-byte boundary.  
15632 This enables more inlining and increases code
15633 size, but may improve performance of code that depends on fast
15634 @code{memcpy}, @code{strlen},
15635 and @code{memset} for short lengths.
15637 @item -minline-stringops-dynamically
15638 @opindex minline-stringops-dynamically
15639 For string operations of unknown size, use run-time checks with
15640 inline code for small blocks and a library call for large blocks.
15642 @item -mstringop-strategy=@var{alg}
15643 @opindex mstringop-strategy=@var{alg}
15644 Override the internal decision heuristic for the particular algorithm to use
15645 for inlining string operations.  The allowed values for @var{alg} are:
15647 @table @samp
15648 @item rep_byte
15649 @itemx rep_4byte
15650 @itemx rep_8byte
15651 Expand using i386 @code{rep} prefix of the specified size.
15653 @item byte_loop
15654 @itemx loop
15655 @itemx unrolled_loop
15656 Expand into an inline loop.
15658 @item libcall
15659 Always use a library call.
15660 @end table
15662 @item -mmemcpy-strategy=@var{strategy}
15663 @opindex mmemcpy-strategy=@var{strategy}
15664 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
15665 should be inlined and what inline algorithm to use when the expected size
15666 of the copy operation is known. @var{strategy} 
15667 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
15668 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
15669 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
15670 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
15671 in the list must be specified in increasing order.  The minimal byte size for 
15672 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
15673 preceding range.
15675 @item -mmemset-strategy=@var{strategy}
15676 @opindex mmemset-strategy=@var{strategy}
15677 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
15678 @code{__builtin_memset} expansion.
15680 @item -momit-leaf-frame-pointer
15681 @opindex momit-leaf-frame-pointer
15682 Don't keep the frame pointer in a register for leaf functions.  This
15683 avoids the instructions to save, set up, and restore frame pointers and
15684 makes an extra register available in leaf functions.  The option
15685 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
15686 which might make debugging harder.
15688 @item -mtls-direct-seg-refs
15689 @itemx -mno-tls-direct-seg-refs
15690 @opindex mtls-direct-seg-refs
15691 Controls whether TLS variables may be accessed with offsets from the
15692 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
15693 or whether the thread base pointer must be added.  Whether or not this
15694 is valid depends on the operating system, and whether it maps the
15695 segment to cover the entire TLS area.
15697 For systems that use the GNU C Library, the default is on.
15699 @item -msse2avx
15700 @itemx -mno-sse2avx
15701 @opindex msse2avx
15702 Specify that the assembler should encode SSE instructions with VEX
15703 prefix.  The option @option{-mavx} turns this on by default.
15705 @item -mfentry
15706 @itemx -mno-fentry
15707 @opindex mfentry
15708 If profiling is active (@option{-pg}), put the profiling
15709 counter call before the prologue.
15710 Note: On x86 architectures the attribute @code{ms_hook_prologue}
15711 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
15713 @item -m8bit-idiv
15714 @itemx -mno-8bit-idiv
15715 @opindex 8bit-idiv
15716 On some processors, like Intel Atom, 8-bit unsigned integer divide is
15717 much faster than 32-bit/64-bit integer divide.  This option generates a
15718 run-time check.  If both dividend and divisor are within range of 0
15719 to 255, 8-bit unsigned integer divide is used instead of
15720 32-bit/64-bit integer divide.
15722 @item -mavx256-split-unaligned-load
15723 @itemx -mavx256-split-unaligned-store
15724 @opindex avx256-split-unaligned-load
15725 @opindex avx256-split-unaligned-store
15726 Split 32-byte AVX unaligned load and store.
15728 @item -mstack-protector-guard=@var{guard}
15729 @opindex mstack-protector-guard=@var{guard}
15730 Generate stack protection code using canary at @var{guard}.  Supported
15731 locations are @samp{global} for global canary or @samp{tls} for per-thread
15732 canary in the TLS block (the default).  This option has effect only when
15733 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
15735 @end table
15737 These @samp{-m} switches are supported in addition to the above
15738 on x86-64 processors in 64-bit environments.
15740 @table @gcctabopt
15741 @item -m32
15742 @itemx -m64
15743 @itemx -mx32
15744 @itemx -m16
15745 @opindex m32
15746 @opindex m64
15747 @opindex mx32
15748 @opindex m16
15749 Generate code for a 16-bit, 32-bit or 64-bit environment.
15750 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
15751 to 32 bits, and
15752 generates code that runs on any i386 system.
15754 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
15755 types to 64 bits, and generates code for the x86-64 architecture.
15756 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
15757 and @option{-mdynamic-no-pic} options.
15759 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
15760 to 32 bits, and
15761 generates code for the x86-64 architecture.
15763 The @option{-m16} option is the same as @option{-m32}, except for that
15764 it outputs the @code{.code16gcc} assembly directive at the beginning of
15765 the assembly output so that the binary can run in 16-bit mode.
15767 @item -mno-red-zone
15768 @opindex mno-red-zone
15769 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
15770 by the x86-64 ABI; it is a 128-byte area beyond the location of the
15771 stack pointer that is not modified by signal or interrupt handlers
15772 and therefore can be used for temporary data without adjusting the stack
15773 pointer.  The flag @option{-mno-red-zone} disables this red zone.
15775 @item -mcmodel=small
15776 @opindex mcmodel=small
15777 Generate code for the small code model: the program and its symbols must
15778 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
15779 Programs can be statically or dynamically linked.  This is the default
15780 code model.
15782 @item -mcmodel=kernel
15783 @opindex mcmodel=kernel
15784 Generate code for the kernel code model.  The kernel runs in the
15785 negative 2 GB of the address space.
15786 This model has to be used for Linux kernel code.
15788 @item -mcmodel=medium
15789 @opindex mcmodel=medium
15790 Generate code for the medium model: the program is linked in the lower 2
15791 GB of the address space.  Small symbols are also placed there.  Symbols
15792 with sizes larger than @option{-mlarge-data-threshold} are put into
15793 large data or BSS sections and can be located above 2GB.  Programs can
15794 be statically or dynamically linked.
15796 @item -mcmodel=large
15797 @opindex mcmodel=large
15798 Generate code for the large model.  This model makes no assumptions
15799 about addresses and sizes of sections.
15801 @item -maddress-mode=long
15802 @opindex maddress-mode=long
15803 Generate code for long address mode.  This is only supported for 64-bit
15804 and x32 environments.  It is the default address mode for 64-bit
15805 environments.
15807 @item -maddress-mode=short
15808 @opindex maddress-mode=short
15809 Generate code for short address mode.  This is only supported for 32-bit
15810 and x32 environments.  It is the default address mode for 32-bit and
15811 x32 environments.
15812 @end table
15814 @node i386 and x86-64 Windows Options
15815 @subsection i386 and x86-64 Windows Options
15816 @cindex i386 and x86-64 Windows Options
15818 These additional options are available for Microsoft Windows targets:
15820 @table @gcctabopt
15821 @item -mconsole
15822 @opindex mconsole
15823 This option
15824 specifies that a console application is to be generated, by
15825 instructing the linker to set the PE header subsystem type
15826 required for console applications.
15827 This option is available for Cygwin and MinGW targets and is
15828 enabled by default on those targets.
15830 @item -mdll
15831 @opindex mdll
15832 This option is available for Cygwin and MinGW targets.  It
15833 specifies that a DLL---a dynamic link library---is to be
15834 generated, enabling the selection of the required runtime
15835 startup object and entry point.
15837 @item -mnop-fun-dllimport
15838 @opindex mnop-fun-dllimport
15839 This option is available for Cygwin and MinGW targets.  It
15840 specifies that the @code{dllimport} attribute should be ignored.
15842 @item -mthread
15843 @opindex mthread
15844 This option is available for MinGW targets. It specifies
15845 that MinGW-specific thread support is to be used.
15847 @item -municode
15848 @opindex municode
15849 This option is available for MinGW-w64 targets.  It causes
15850 the @code{UNICODE} preprocessor macro to be predefined, and
15851 chooses Unicode-capable runtime startup code.
15853 @item -mwin32
15854 @opindex mwin32
15855 This option is available for Cygwin and MinGW targets.  It
15856 specifies that the typical Microsoft Windows predefined macros are to
15857 be set in the pre-processor, but does not influence the choice
15858 of runtime library/startup code.
15860 @item -mwindows
15861 @opindex mwindows
15862 This option is available for Cygwin and MinGW targets.  It
15863 specifies that a GUI application is to be generated by
15864 instructing the linker to set the PE header subsystem type
15865 appropriately.
15867 @item -fno-set-stack-executable
15868 @opindex fno-set-stack-executable
15869 This option is available for MinGW targets. It specifies that
15870 the executable flag for the stack used by nested functions isn't
15871 set. This is necessary for binaries running in kernel mode of
15872 Microsoft Windows, as there the User32 API, which is used to set executable
15873 privileges, isn't available.
15875 @item -fwritable-relocated-rdata
15876 @opindex fno-writable-relocated-rdata
15877 This option is available for MinGW and Cygwin targets.  It specifies
15878 that relocated-data in read-only section is put into .data
15879 section.  This is a necessary for older runtimes not supporting
15880 modification of .rdata sections for pseudo-relocation.
15882 @item -mpe-aligned-commons
15883 @opindex mpe-aligned-commons
15884 This option is available for Cygwin and MinGW targets.  It
15885 specifies that the GNU extension to the PE file format that
15886 permits the correct alignment of COMMON variables should be
15887 used when generating code.  It is enabled by default if
15888 GCC detects that the target assembler found during configuration
15889 supports the feature.
15890 @end table
15892 See also under @ref{i386 and x86-64 Options} for standard options.
15894 @node IA-64 Options
15895 @subsection IA-64 Options
15896 @cindex IA-64 Options
15898 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15900 @table @gcctabopt
15901 @item -mbig-endian
15902 @opindex mbig-endian
15903 Generate code for a big-endian target.  This is the default for HP-UX@.
15905 @item -mlittle-endian
15906 @opindex mlittle-endian
15907 Generate code for a little-endian target.  This is the default for AIX5
15908 and GNU/Linux.
15910 @item -mgnu-as
15911 @itemx -mno-gnu-as
15912 @opindex mgnu-as
15913 @opindex mno-gnu-as
15914 Generate (or don't) code for the GNU assembler.  This is the default.
15915 @c Also, this is the default if the configure option @option{--with-gnu-as}
15916 @c is used.
15918 @item -mgnu-ld
15919 @itemx -mno-gnu-ld
15920 @opindex mgnu-ld
15921 @opindex mno-gnu-ld
15922 Generate (or don't) code for the GNU linker.  This is the default.
15923 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15924 @c is used.
15926 @item -mno-pic
15927 @opindex mno-pic
15928 Generate code that does not use a global pointer register.  The result
15929 is not position independent code, and violates the IA-64 ABI@.
15931 @item -mvolatile-asm-stop
15932 @itemx -mno-volatile-asm-stop
15933 @opindex mvolatile-asm-stop
15934 @opindex mno-volatile-asm-stop
15935 Generate (or don't) a stop bit immediately before and after volatile asm
15936 statements.
15938 @item -mregister-names
15939 @itemx -mno-register-names
15940 @opindex mregister-names
15941 @opindex mno-register-names
15942 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15943 the stacked registers.  This may make assembler output more readable.
15945 @item -mno-sdata
15946 @itemx -msdata
15947 @opindex mno-sdata
15948 @opindex msdata
15949 Disable (or enable) optimizations that use the small data section.  This may
15950 be useful for working around optimizer bugs.
15952 @item -mconstant-gp
15953 @opindex mconstant-gp
15954 Generate code that uses a single constant global pointer value.  This is
15955 useful when compiling kernel code.
15957 @item -mauto-pic
15958 @opindex mauto-pic
15959 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15960 This is useful when compiling firmware code.
15962 @item -minline-float-divide-min-latency
15963 @opindex minline-float-divide-min-latency
15964 Generate code for inline divides of floating-point values
15965 using the minimum latency algorithm.
15967 @item -minline-float-divide-max-throughput
15968 @opindex minline-float-divide-max-throughput
15969 Generate code for inline divides of floating-point values
15970 using the maximum throughput algorithm.
15972 @item -mno-inline-float-divide
15973 @opindex mno-inline-float-divide
15974 Do not generate inline code for divides of floating-point values.
15976 @item -minline-int-divide-min-latency
15977 @opindex minline-int-divide-min-latency
15978 Generate code for inline divides of integer values
15979 using the minimum latency algorithm.
15981 @item -minline-int-divide-max-throughput
15982 @opindex minline-int-divide-max-throughput
15983 Generate code for inline divides of integer values
15984 using the maximum throughput algorithm.
15986 @item -mno-inline-int-divide
15987 @opindex mno-inline-int-divide
15988 Do not generate inline code for divides of integer values.
15990 @item -minline-sqrt-min-latency
15991 @opindex minline-sqrt-min-latency
15992 Generate code for inline square roots
15993 using the minimum latency algorithm.
15995 @item -minline-sqrt-max-throughput
15996 @opindex minline-sqrt-max-throughput
15997 Generate code for inline square roots
15998 using the maximum throughput algorithm.
16000 @item -mno-inline-sqrt
16001 @opindex mno-inline-sqrt
16002 Do not generate inline code for @code{sqrt}.
16004 @item -mfused-madd
16005 @itemx -mno-fused-madd
16006 @opindex mfused-madd
16007 @opindex mno-fused-madd
16008 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16009 instructions.  The default is to use these instructions.
16011 @item -mno-dwarf2-asm
16012 @itemx -mdwarf2-asm
16013 @opindex mno-dwarf2-asm
16014 @opindex mdwarf2-asm
16015 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16016 info.  This may be useful when not using the GNU assembler.
16018 @item -mearly-stop-bits
16019 @itemx -mno-early-stop-bits
16020 @opindex mearly-stop-bits
16021 @opindex mno-early-stop-bits
16022 Allow stop bits to be placed earlier than immediately preceding the
16023 instruction that triggered the stop bit.  This can improve instruction
16024 scheduling, but does not always do so.
16026 @item -mfixed-range=@var{register-range}
16027 @opindex mfixed-range
16028 Generate code treating the given register range as fixed registers.
16029 A fixed register is one that the register allocator cannot use.  This is
16030 useful when compiling kernel code.  A register range is specified as
16031 two registers separated by a dash.  Multiple register ranges can be
16032 specified separated by a comma.
16034 @item -mtls-size=@var{tls-size}
16035 @opindex mtls-size
16036 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16039 @item -mtune=@var{cpu-type}
16040 @opindex mtune
16041 Tune the instruction scheduling for a particular CPU, Valid values are
16042 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16043 and @samp{mckinley}.
16045 @item -milp32
16046 @itemx -mlp64
16047 @opindex milp32
16048 @opindex mlp64
16049 Generate code for a 32-bit or 64-bit environment.
16050 The 32-bit environment sets int, long and pointer to 32 bits.
16051 The 64-bit environment sets int to 32 bits and long and pointer
16052 to 64 bits.  These are HP-UX specific flags.
16054 @item -mno-sched-br-data-spec
16055 @itemx -msched-br-data-spec
16056 @opindex mno-sched-br-data-spec
16057 @opindex msched-br-data-spec
16058 (Dis/En)able data speculative scheduling before reload.
16059 This results in generation of @code{ld.a} instructions and
16060 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16061 The default is 'disable'.
16063 @item -msched-ar-data-spec
16064 @itemx -mno-sched-ar-data-spec
16065 @opindex msched-ar-data-spec
16066 @opindex mno-sched-ar-data-spec
16067 (En/Dis)able data speculative scheduling after reload.
16068 This results in generation of @code{ld.a} instructions and
16069 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16070 The default is 'enable'.
16072 @item -mno-sched-control-spec
16073 @itemx -msched-control-spec
16074 @opindex mno-sched-control-spec
16075 @opindex msched-control-spec
16076 (Dis/En)able control speculative scheduling.  This feature is
16077 available only during region scheduling (i.e.@: before reload).
16078 This results in generation of the @code{ld.s} instructions and
16079 the corresponding check instructions @code{chk.s}.
16080 The default is 'disable'.
16082 @item -msched-br-in-data-spec
16083 @itemx -mno-sched-br-in-data-spec
16084 @opindex msched-br-in-data-spec
16085 @opindex mno-sched-br-in-data-spec
16086 (En/Dis)able speculative scheduling of the instructions that
16087 are dependent on the data speculative loads before reload.
16088 This is effective only with @option{-msched-br-data-spec} enabled.
16089 The default is 'enable'.
16091 @item -msched-ar-in-data-spec
16092 @itemx -mno-sched-ar-in-data-spec
16093 @opindex msched-ar-in-data-spec
16094 @opindex mno-sched-ar-in-data-spec
16095 (En/Dis)able speculative scheduling of the instructions that
16096 are dependent on the data speculative loads after reload.
16097 This is effective only with @option{-msched-ar-data-spec} enabled.
16098 The default is 'enable'.
16100 @item -msched-in-control-spec
16101 @itemx -mno-sched-in-control-spec
16102 @opindex msched-in-control-spec
16103 @opindex mno-sched-in-control-spec
16104 (En/Dis)able speculative scheduling of the instructions that
16105 are dependent on the control speculative loads.
16106 This is effective only with @option{-msched-control-spec} enabled.
16107 The default is 'enable'.
16109 @item -mno-sched-prefer-non-data-spec-insns
16110 @itemx -msched-prefer-non-data-spec-insns
16111 @opindex mno-sched-prefer-non-data-spec-insns
16112 @opindex msched-prefer-non-data-spec-insns
16113 If enabled, data-speculative instructions are chosen for schedule
16114 only if there are no other choices at the moment.  This makes
16115 the use of the data speculation much more conservative.
16116 The default is 'disable'.
16118 @item -mno-sched-prefer-non-control-spec-insns
16119 @itemx -msched-prefer-non-control-spec-insns
16120 @opindex mno-sched-prefer-non-control-spec-insns
16121 @opindex msched-prefer-non-control-spec-insns
16122 If enabled, control-speculative instructions are chosen for schedule
16123 only if there are no other choices at the moment.  This makes
16124 the use of the control speculation much more conservative.
16125 The default is 'disable'.
16127 @item -mno-sched-count-spec-in-critical-path
16128 @itemx -msched-count-spec-in-critical-path
16129 @opindex mno-sched-count-spec-in-critical-path
16130 @opindex msched-count-spec-in-critical-path
16131 If enabled, speculative dependencies are considered during
16132 computation of the instructions priorities.  This makes the use of the
16133 speculation a bit more conservative.
16134 The default is 'disable'.
16136 @item -msched-spec-ldc
16137 @opindex msched-spec-ldc
16138 Use a simple data speculation check.  This option is on by default.
16140 @item -msched-control-spec-ldc
16141 @opindex msched-spec-ldc
16142 Use a simple check for control speculation.  This option is on by default.
16144 @item -msched-stop-bits-after-every-cycle
16145 @opindex msched-stop-bits-after-every-cycle
16146 Place a stop bit after every cycle when scheduling.  This option is on
16147 by default.
16149 @item -msched-fp-mem-deps-zero-cost
16150 @opindex msched-fp-mem-deps-zero-cost
16151 Assume that floating-point stores and loads are not likely to cause a conflict
16152 when placed into the same instruction group.  This option is disabled by
16153 default.
16155 @item -msel-sched-dont-check-control-spec
16156 @opindex msel-sched-dont-check-control-spec
16157 Generate checks for control speculation in selective scheduling.
16158 This flag is disabled by default.
16160 @item -msched-max-memory-insns=@var{max-insns}
16161 @opindex msched-max-memory-insns
16162 Limit on the number of memory insns per instruction group, giving lower
16163 priority to subsequent memory insns attempting to schedule in the same
16164 instruction group. Frequently useful to prevent cache bank conflicts.
16165 The default value is 1.
16167 @item -msched-max-memory-insns-hard-limit
16168 @opindex msched-max-memory-insns-hard-limit
16169 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16170 disallowing more than that number in an instruction group.
16171 Otherwise, the limit is ``soft'', meaning that non-memory operations
16172 are preferred when the limit is reached, but memory operations may still
16173 be scheduled.
16175 @end table
16177 @node LM32 Options
16178 @subsection LM32 Options
16179 @cindex LM32 options
16181 These @option{-m} options are defined for the LatticeMico32 architecture:
16183 @table @gcctabopt
16184 @item -mbarrel-shift-enabled
16185 @opindex mbarrel-shift-enabled
16186 Enable barrel-shift instructions.
16188 @item -mdivide-enabled
16189 @opindex mdivide-enabled
16190 Enable divide and modulus instructions.
16192 @item -mmultiply-enabled
16193 @opindex multiply-enabled
16194 Enable multiply instructions.
16196 @item -msign-extend-enabled
16197 @opindex msign-extend-enabled
16198 Enable sign extend instructions.
16200 @item -muser-enabled
16201 @opindex muser-enabled
16202 Enable user-defined instructions.
16204 @end table
16206 @node M32C Options
16207 @subsection M32C Options
16208 @cindex M32C options
16210 @table @gcctabopt
16211 @item -mcpu=@var{name}
16212 @opindex mcpu=
16213 Select the CPU for which code is generated.  @var{name} may be one of
16214 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16215 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16216 the M32C/80 series.
16218 @item -msim
16219 @opindex msim
16220 Specifies that the program will be run on the simulator.  This causes
16221 an alternate runtime library to be linked in which supports, for
16222 example, file I/O@.  You must not use this option when generating
16223 programs that will run on real hardware; you must provide your own
16224 runtime library for whatever I/O functions are needed.
16226 @item -memregs=@var{number}
16227 @opindex memregs=
16228 Specifies the number of memory-based pseudo-registers GCC uses
16229 during code generation.  These pseudo-registers are used like real
16230 registers, so there is a tradeoff between GCC's ability to fit the
16231 code into available registers, and the performance penalty of using
16232 memory instead of registers.  Note that all modules in a program must
16233 be compiled with the same value for this option.  Because of that, you
16234 must not use this option with GCC's default runtime libraries.
16236 @end table
16238 @node M32R/D Options
16239 @subsection M32R/D Options
16240 @cindex M32R/D options
16242 These @option{-m} options are defined for Renesas M32R/D architectures:
16244 @table @gcctabopt
16245 @item -m32r2
16246 @opindex m32r2
16247 Generate code for the M32R/2@.
16249 @item -m32rx
16250 @opindex m32rx
16251 Generate code for the M32R/X@.
16253 @item -m32r
16254 @opindex m32r
16255 Generate code for the M32R@.  This is the default.
16257 @item -mmodel=small
16258 @opindex mmodel=small
16259 Assume all objects live in the lower 16MB of memory (so that their addresses
16260 can be loaded with the @code{ld24} instruction), and assume all subroutines
16261 are reachable with the @code{bl} instruction.
16262 This is the default.
16264 The addressability of a particular object can be set with the
16265 @code{model} attribute.
16267 @item -mmodel=medium
16268 @opindex mmodel=medium
16269 Assume objects may be anywhere in the 32-bit address space (the compiler
16270 generates @code{seth/add3} instructions to load their addresses), and
16271 assume all subroutines are reachable with the @code{bl} instruction.
16273 @item -mmodel=large
16274 @opindex mmodel=large
16275 Assume objects may be anywhere in the 32-bit address space (the compiler
16276 generates @code{seth/add3} instructions to load their addresses), and
16277 assume subroutines may not be reachable with the @code{bl} instruction
16278 (the compiler generates the much slower @code{seth/add3/jl}
16279 instruction sequence).
16281 @item -msdata=none
16282 @opindex msdata=none
16283 Disable use of the small data area.  Variables are put into
16284 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16285 @code{section} attribute has been specified).
16286 This is the default.
16288 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16289 Objects may be explicitly put in the small data area with the
16290 @code{section} attribute using one of these sections.
16292 @item -msdata=sdata
16293 @opindex msdata=sdata
16294 Put small global and static data in the small data area, but do not
16295 generate special code to reference them.
16297 @item -msdata=use
16298 @opindex msdata=use
16299 Put small global and static data in the small data area, and generate
16300 special instructions to reference them.
16302 @item -G @var{num}
16303 @opindex G
16304 @cindex smaller data references
16305 Put global and static objects less than or equal to @var{num} bytes
16306 into the small data or BSS sections instead of the normal data or BSS
16307 sections.  The default value of @var{num} is 8.
16308 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16309 for this option to have any effect.
16311 All modules should be compiled with the same @option{-G @var{num}} value.
16312 Compiling with different values of @var{num} may or may not work; if it
16313 doesn't the linker gives an error message---incorrect code is not
16314 generated.
16316 @item -mdebug
16317 @opindex mdebug
16318 Makes the M32R-specific code in the compiler display some statistics
16319 that might help in debugging programs.
16321 @item -malign-loops
16322 @opindex malign-loops
16323 Align all loops to a 32-byte boundary.
16325 @item -mno-align-loops
16326 @opindex mno-align-loops
16327 Do not enforce a 32-byte alignment for loops.  This is the default.
16329 @item -missue-rate=@var{number}
16330 @opindex missue-rate=@var{number}
16331 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16332 or 2.
16334 @item -mbranch-cost=@var{number}
16335 @opindex mbranch-cost=@var{number}
16336 @var{number} can only be 1 or 2.  If it is 1 then branches are
16337 preferred over conditional code, if it is 2, then the opposite applies.
16339 @item -mflush-trap=@var{number}
16340 @opindex mflush-trap=@var{number}
16341 Specifies the trap number to use to flush the cache.  The default is
16342 12.  Valid numbers are between 0 and 15 inclusive.
16344 @item -mno-flush-trap
16345 @opindex mno-flush-trap
16346 Specifies that the cache cannot be flushed by using a trap.
16348 @item -mflush-func=@var{name}
16349 @opindex mflush-func=@var{name}
16350 Specifies the name of the operating system function to call to flush
16351 the cache.  The default is @emph{_flush_cache}, but a function call
16352 is only used if a trap is not available.
16354 @item -mno-flush-func
16355 @opindex mno-flush-func
16356 Indicates that there is no OS function for flushing the cache.
16358 @end table
16360 @node M680x0 Options
16361 @subsection M680x0 Options
16362 @cindex M680x0 options
16364 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16365 The default settings depend on which architecture was selected when
16366 the compiler was configured; the defaults for the most common choices
16367 are given below.
16369 @table @gcctabopt
16370 @item -march=@var{arch}
16371 @opindex march
16372 Generate code for a specific M680x0 or ColdFire instruction set
16373 architecture.  Permissible values of @var{arch} for M680x0
16374 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16375 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16376 architectures are selected according to Freescale's ISA classification
16377 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16378 @samp{isab} and @samp{isac}.
16380 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16381 code for a ColdFire target.  The @var{arch} in this macro is one of the
16382 @option{-march} arguments given above.
16384 When used together, @option{-march} and @option{-mtune} select code
16385 that runs on a family of similar processors but that is optimized
16386 for a particular microarchitecture.
16388 @item -mcpu=@var{cpu}
16389 @opindex mcpu
16390 Generate code for a specific M680x0 or ColdFire processor.
16391 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16392 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16393 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16394 below, which also classifies the CPUs into families:
16396 @multitable @columnfractions 0.20 0.80
16397 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16398 @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}
16399 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16400 @item @samp{5206e} @tab @samp{5206e}
16401 @item @samp{5208} @tab @samp{5207} @samp{5208}
16402 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16403 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16404 @item @samp{5216} @tab @samp{5214} @samp{5216}
16405 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16406 @item @samp{5225} @tab @samp{5224} @samp{5225}
16407 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16408 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16409 @item @samp{5249} @tab @samp{5249}
16410 @item @samp{5250} @tab @samp{5250}
16411 @item @samp{5271} @tab @samp{5270} @samp{5271}
16412 @item @samp{5272} @tab @samp{5272}
16413 @item @samp{5275} @tab @samp{5274} @samp{5275}
16414 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16415 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16416 @item @samp{5307} @tab @samp{5307}
16417 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16418 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16419 @item @samp{5407} @tab @samp{5407}
16420 @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}
16421 @end multitable
16423 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16424 @var{arch} is compatible with @var{cpu}.  Other combinations of
16425 @option{-mcpu} and @option{-march} are rejected.
16427 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16428 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16429 where the value of @var{family} is given by the table above.
16431 @item -mtune=@var{tune}
16432 @opindex mtune
16433 Tune the code for a particular microarchitecture within the
16434 constraints set by @option{-march} and @option{-mcpu}.
16435 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16436 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16437 and @samp{cpu32}.  The ColdFire microarchitectures
16438 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16440 You can also use @option{-mtune=68020-40} for code that needs
16441 to run relatively well on 68020, 68030 and 68040 targets.
16442 @option{-mtune=68020-60} is similar but includes 68060 targets
16443 as well.  These two options select the same tuning decisions as
16444 @option{-m68020-40} and @option{-m68020-60} respectively.
16446 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16447 when tuning for 680x0 architecture @var{arch}.  It also defines
16448 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16449 option is used.  If GCC is tuning for a range of architectures,
16450 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16451 it defines the macros for every architecture in the range.
16453 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16454 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16455 of the arguments given above.
16457 @item -m68000
16458 @itemx -mc68000
16459 @opindex m68000
16460 @opindex mc68000
16461 Generate output for a 68000.  This is the default
16462 when the compiler is configured for 68000-based systems.
16463 It is equivalent to @option{-march=68000}.
16465 Use this option for microcontrollers with a 68000 or EC000 core,
16466 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16468 @item -m68010
16469 @opindex m68010
16470 Generate output for a 68010.  This is the default
16471 when the compiler is configured for 68010-based systems.
16472 It is equivalent to @option{-march=68010}.
16474 @item -m68020
16475 @itemx -mc68020
16476 @opindex m68020
16477 @opindex mc68020
16478 Generate output for a 68020.  This is the default
16479 when the compiler is configured for 68020-based systems.
16480 It is equivalent to @option{-march=68020}.
16482 @item -m68030
16483 @opindex m68030
16484 Generate output for a 68030.  This is the default when the compiler is
16485 configured for 68030-based systems.  It is equivalent to
16486 @option{-march=68030}.
16488 @item -m68040
16489 @opindex m68040
16490 Generate output for a 68040.  This is the default when the compiler is
16491 configured for 68040-based systems.  It is equivalent to
16492 @option{-march=68040}.
16494 This option inhibits the use of 68881/68882 instructions that have to be
16495 emulated by software on the 68040.  Use this option if your 68040 does not
16496 have code to emulate those instructions.
16498 @item -m68060
16499 @opindex m68060
16500 Generate output for a 68060.  This is the default when the compiler is
16501 configured for 68060-based systems.  It is equivalent to
16502 @option{-march=68060}.
16504 This option inhibits the use of 68020 and 68881/68882 instructions that
16505 have to be emulated by software on the 68060.  Use this option if your 68060
16506 does not have code to emulate those instructions.
16508 @item -mcpu32
16509 @opindex mcpu32
16510 Generate output for a CPU32.  This is the default
16511 when the compiler is configured for CPU32-based systems.
16512 It is equivalent to @option{-march=cpu32}.
16514 Use this option for microcontrollers with a
16515 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16516 68336, 68340, 68341, 68349 and 68360.
16518 @item -m5200
16519 @opindex m5200
16520 Generate output for a 520X ColdFire CPU@.  This is the default
16521 when the compiler is configured for 520X-based systems.
16522 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16523 in favor of that option.
16525 Use this option for microcontroller with a 5200 core, including
16526 the MCF5202, MCF5203, MCF5204 and MCF5206.
16528 @item -m5206e
16529 @opindex m5206e
16530 Generate output for a 5206e ColdFire CPU@.  The option is now
16531 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16533 @item -m528x
16534 @opindex m528x
16535 Generate output for a member of the ColdFire 528X family.
16536 The option is now deprecated in favor of the equivalent
16537 @option{-mcpu=528x}.
16539 @item -m5307
16540 @opindex m5307
16541 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16542 in favor of the equivalent @option{-mcpu=5307}.
16544 @item -m5407
16545 @opindex m5407
16546 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16547 in favor of the equivalent @option{-mcpu=5407}.
16549 @item -mcfv4e
16550 @opindex mcfv4e
16551 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16552 This includes use of hardware floating-point instructions.
16553 The option is equivalent to @option{-mcpu=547x}, and is now
16554 deprecated in favor of that option.
16556 @item -m68020-40
16557 @opindex m68020-40
16558 Generate output for a 68040, without using any of the new instructions.
16559 This results in code that can run relatively efficiently on either a
16560 68020/68881 or a 68030 or a 68040.  The generated code does use the
16561 68881 instructions that are emulated on the 68040.
16563 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16565 @item -m68020-60
16566 @opindex m68020-60
16567 Generate output for a 68060, without using any of the new instructions.
16568 This results in code that can run relatively efficiently on either a
16569 68020/68881 or a 68030 or a 68040.  The generated code does use the
16570 68881 instructions that are emulated on the 68060.
16572 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16574 @item -mhard-float
16575 @itemx -m68881
16576 @opindex mhard-float
16577 @opindex m68881
16578 Generate floating-point instructions.  This is the default for 68020
16579 and above, and for ColdFire devices that have an FPU@.  It defines the
16580 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
16581 on ColdFire targets.
16583 @item -msoft-float
16584 @opindex msoft-float
16585 Do not generate floating-point instructions; use library calls instead.
16586 This is the default for 68000, 68010, and 68832 targets.  It is also
16587 the default for ColdFire devices that have no FPU.
16589 @item -mdiv
16590 @itemx -mno-div
16591 @opindex mdiv
16592 @opindex mno-div
16593 Generate (do not generate) ColdFire hardware divide and remainder
16594 instructions.  If @option{-march} is used without @option{-mcpu},
16595 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16596 architectures.  Otherwise, the default is taken from the target CPU
16597 (either the default CPU, or the one specified by @option{-mcpu}).  For
16598 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16599 @option{-mcpu=5206e}.
16601 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
16603 @item -mshort
16604 @opindex mshort
16605 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16606 Additionally, parameters passed on the stack are also aligned to a
16607 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16609 @item -mno-short
16610 @opindex mno-short
16611 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16613 @item -mnobitfield
16614 @itemx -mno-bitfield
16615 @opindex mnobitfield
16616 @opindex mno-bitfield
16617 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16618 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16620 @item -mbitfield
16621 @opindex mbitfield
16622 Do use the bit-field instructions.  The @option{-m68020} option implies
16623 @option{-mbitfield}.  This is the default if you use a configuration
16624 designed for a 68020.
16626 @item -mrtd
16627 @opindex mrtd
16628 Use a different function-calling convention, in which functions
16629 that take a fixed number of arguments return with the @code{rtd}
16630 instruction, which pops their arguments while returning.  This
16631 saves one instruction in the caller since there is no need to pop
16632 the arguments there.
16634 This calling convention is incompatible with the one normally
16635 used on Unix, so you cannot use it if you need to call libraries
16636 compiled with the Unix compiler.
16638 Also, you must provide function prototypes for all functions that
16639 take variable numbers of arguments (including @code{printf});
16640 otherwise incorrect code is generated for calls to those
16641 functions.
16643 In addition, seriously incorrect code results if you call a
16644 function with too many arguments.  (Normally, extra arguments are
16645 harmlessly ignored.)
16647 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16648 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16650 @item -mno-rtd
16651 @opindex mno-rtd
16652 Do not use the calling conventions selected by @option{-mrtd}.
16653 This is the default.
16655 @item -malign-int
16656 @itemx -mno-align-int
16657 @opindex malign-int
16658 @opindex mno-align-int
16659 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16660 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16661 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16662 Aligning variables on 32-bit boundaries produces code that runs somewhat
16663 faster on processors with 32-bit busses at the expense of more memory.
16665 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16666 aligns structures containing the above types differently than
16667 most published application binary interface specifications for the m68k.
16669 @item -mpcrel
16670 @opindex mpcrel
16671 Use the pc-relative addressing mode of the 68000 directly, instead of
16672 using a global offset table.  At present, this option implies @option{-fpic},
16673 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16674 not presently supported with @option{-mpcrel}, though this could be supported for
16675 68020 and higher processors.
16677 @item -mno-strict-align
16678 @itemx -mstrict-align
16679 @opindex mno-strict-align
16680 @opindex mstrict-align
16681 Do not (do) assume that unaligned memory references are handled by
16682 the system.
16684 @item -msep-data
16685 Generate code that allows the data segment to be located in a different
16686 area of memory from the text segment.  This allows for execute-in-place in
16687 an environment without virtual memory management.  This option implies
16688 @option{-fPIC}.
16690 @item -mno-sep-data
16691 Generate code that assumes that the data segment follows the text segment.
16692 This is the default.
16694 @item -mid-shared-library
16695 Generate code that supports shared libraries via the library ID method.
16696 This allows for execute-in-place and shared libraries in an environment
16697 without virtual memory management.  This option implies @option{-fPIC}.
16699 @item -mno-id-shared-library
16700 Generate code that doesn't assume ID-based shared libraries are being used.
16701 This is the default.
16703 @item -mshared-library-id=n
16704 Specifies the identification number of the ID-based shared library being
16705 compiled.  Specifying a value of 0 generates more compact code; specifying
16706 other values forces the allocation of that number to the current
16707 library, but is no more space- or time-efficient than omitting this option.
16709 @item -mxgot
16710 @itemx -mno-xgot
16711 @opindex mxgot
16712 @opindex mno-xgot
16713 When generating position-independent code for ColdFire, generate code
16714 that works if the GOT has more than 8192 entries.  This code is
16715 larger and slower than code generated without this option.  On M680x0
16716 processors, this option is not needed; @option{-fPIC} suffices.
16718 GCC normally uses a single instruction to load values from the GOT@.
16719 While this is relatively efficient, it only works if the GOT
16720 is smaller than about 64k.  Anything larger causes the linker
16721 to report an error such as:
16723 @cindex relocation truncated to fit (ColdFire)
16724 @smallexample
16725 relocation truncated to fit: R_68K_GOT16O foobar
16726 @end smallexample
16728 If this happens, you should recompile your code with @option{-mxgot}.
16729 It should then work with very large GOTs.  However, code generated with
16730 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16731 the value of a global symbol.
16733 Note that some linkers, including newer versions of the GNU linker,
16734 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16735 you should only need to use @option{-mxgot} when compiling a single
16736 object file that accesses more than 8192 GOT entries.  Very few do.
16738 These options have no effect unless GCC is generating
16739 position-independent code.
16741 @end table
16743 @node MCore Options
16744 @subsection MCore Options
16745 @cindex MCore options
16747 These are the @samp{-m} options defined for the Motorola M*Core
16748 processors.
16750 @table @gcctabopt
16752 @item -mhardlit
16753 @itemx -mno-hardlit
16754 @opindex mhardlit
16755 @opindex mno-hardlit
16756 Inline constants into the code stream if it can be done in two
16757 instructions or less.
16759 @item -mdiv
16760 @itemx -mno-div
16761 @opindex mdiv
16762 @opindex mno-div
16763 Use the divide instruction.  (Enabled by default).
16765 @item -mrelax-immediate
16766 @itemx -mno-relax-immediate
16767 @opindex mrelax-immediate
16768 @opindex mno-relax-immediate
16769 Allow arbitrary-sized immediates in bit operations.
16771 @item -mwide-bitfields
16772 @itemx -mno-wide-bitfields
16773 @opindex mwide-bitfields
16774 @opindex mno-wide-bitfields
16775 Always treat bit-fields as @code{int}-sized.
16777 @item -m4byte-functions
16778 @itemx -mno-4byte-functions
16779 @opindex m4byte-functions
16780 @opindex mno-4byte-functions
16781 Force all functions to be aligned to a 4-byte boundary.
16783 @item -mcallgraph-data
16784 @itemx -mno-callgraph-data
16785 @opindex mcallgraph-data
16786 @opindex mno-callgraph-data
16787 Emit callgraph information.
16789 @item -mslow-bytes
16790 @itemx -mno-slow-bytes
16791 @opindex mslow-bytes
16792 @opindex mno-slow-bytes
16793 Prefer word access when reading byte quantities.
16795 @item -mlittle-endian
16796 @itemx -mbig-endian
16797 @opindex mlittle-endian
16798 @opindex mbig-endian
16799 Generate code for a little-endian target.
16801 @item -m210
16802 @itemx -m340
16803 @opindex m210
16804 @opindex m340
16805 Generate code for the 210 processor.
16807 @item -mno-lsim
16808 @opindex mno-lsim
16809 Assume that runtime support has been provided and so omit the
16810 simulator library (@file{libsim.a)} from the linker command line.
16812 @item -mstack-increment=@var{size}
16813 @opindex mstack-increment
16814 Set the maximum amount for a single stack increment operation.  Large
16815 values can increase the speed of programs that contain functions
16816 that need a large amount of stack space, but they can also trigger a
16817 segmentation fault if the stack is extended too much.  The default
16818 value is 0x1000.
16820 @end table
16822 @node MeP Options
16823 @subsection MeP Options
16824 @cindex MeP options
16826 @table @gcctabopt
16828 @item -mabsdiff
16829 @opindex mabsdiff
16830 Enables the @code{abs} instruction, which is the absolute difference
16831 between two registers.
16833 @item -mall-opts
16834 @opindex mall-opts
16835 Enables all the optional instructions---average, multiply, divide, bit
16836 operations, leading zero, absolute difference, min/max, clip, and
16837 saturation.
16840 @item -maverage
16841 @opindex maverage
16842 Enables the @code{ave} instruction, which computes the average of two
16843 registers.
16845 @item -mbased=@var{n}
16846 @opindex mbased=
16847 Variables of size @var{n} bytes or smaller are placed in the
16848 @code{.based} section by default.  Based variables use the @code{$tp}
16849 register as a base register, and there is a 128-byte limit to the
16850 @code{.based} section.
16852 @item -mbitops
16853 @opindex mbitops
16854 Enables the bit operation instructions---bit test (@code{btstm}), set
16855 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16856 test-and-set (@code{tas}).
16858 @item -mc=@var{name}
16859 @opindex mc=
16860 Selects which section constant data is placed in.  @var{name} may
16861 be @code{tiny}, @code{near}, or @code{far}.
16863 @item -mclip
16864 @opindex mclip
16865 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
16866 useful unless you also provide @code{-mminmax}.
16868 @item -mconfig=@var{name}
16869 @opindex mconfig=
16870 Selects one of the built-in core configurations.  Each MeP chip has
16871 one or more modules in it; each module has a core CPU and a variety of
16872 coprocessors, optional instructions, and peripherals.  The
16873 @code{MeP-Integrator} tool, not part of GCC, provides these
16874 configurations through this option; using this option is the same as
16875 using all the corresponding command-line options.  The default
16876 configuration is @code{default}.
16878 @item -mcop
16879 @opindex mcop
16880 Enables the coprocessor instructions.  By default, this is a 32-bit
16881 coprocessor.  Note that the coprocessor is normally enabled via the
16882 @code{-mconfig=} option.
16884 @item -mcop32
16885 @opindex mcop32
16886 Enables the 32-bit coprocessor's instructions.
16888 @item -mcop64
16889 @opindex mcop64
16890 Enables the 64-bit coprocessor's instructions.
16892 @item -mivc2
16893 @opindex mivc2
16894 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16896 @item -mdc
16897 @opindex mdc
16898 Causes constant variables to be placed in the @code{.near} section.
16900 @item -mdiv
16901 @opindex mdiv
16902 Enables the @code{div} and @code{divu} instructions.
16904 @item -meb
16905 @opindex meb
16906 Generate big-endian code.
16908 @item -mel
16909 @opindex mel
16910 Generate little-endian code.
16912 @item -mio-volatile
16913 @opindex mio-volatile
16914 Tells the compiler that any variable marked with the @code{io}
16915 attribute is to be considered volatile.
16917 @item -ml
16918 @opindex ml
16919 Causes variables to be assigned to the @code{.far} section by default.
16921 @item -mleadz
16922 @opindex mleadz
16923 Enables the @code{leadz} (leading zero) instruction.
16925 @item -mm
16926 @opindex mm
16927 Causes variables to be assigned to the @code{.near} section by default.
16929 @item -mminmax
16930 @opindex mminmax
16931 Enables the @code{min} and @code{max} instructions.
16933 @item -mmult
16934 @opindex mmult
16935 Enables the multiplication and multiply-accumulate instructions.
16937 @item -mno-opts
16938 @opindex mno-opts
16939 Disables all the optional instructions enabled by @code{-mall-opts}.
16941 @item -mrepeat
16942 @opindex mrepeat
16943 Enables the @code{repeat} and @code{erepeat} instructions, used for
16944 low-overhead looping.
16946 @item -ms
16947 @opindex ms
16948 Causes all variables to default to the @code{.tiny} section.  Note
16949 that there is a 65536-byte limit to this section.  Accesses to these
16950 variables use the @code{%gp} base register.
16952 @item -msatur
16953 @opindex msatur
16954 Enables the saturation instructions.  Note that the compiler does not
16955 currently generate these itself, but this option is included for
16956 compatibility with other tools, like @code{as}.
16958 @item -msdram
16959 @opindex msdram
16960 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16962 @item -msim
16963 @opindex msim
16964 Link the simulator run-time libraries.
16966 @item -msimnovec
16967 @opindex msimnovec
16968 Link the simulator runtime libraries, excluding built-in support
16969 for reset and exception vectors and tables.
16971 @item -mtf
16972 @opindex mtf
16973 Causes all functions to default to the @code{.far} section.  Without
16974 this option, functions default to the @code{.near} section.
16976 @item -mtiny=@var{n}
16977 @opindex mtiny=
16978 Variables that are @var{n} bytes or smaller are allocated to the
16979 @code{.tiny} section.  These variables use the @code{$gp} base
16980 register.  The default for this option is 4, but note that there's a
16981 65536-byte limit to the @code{.tiny} section.
16983 @end table
16985 @node MicroBlaze Options
16986 @subsection MicroBlaze Options
16987 @cindex MicroBlaze Options
16989 @table @gcctabopt
16991 @item -msoft-float
16992 @opindex msoft-float
16993 Use software emulation for floating point (default).
16995 @item -mhard-float
16996 @opindex mhard-float
16997 Use hardware floating-point instructions.
16999 @item -mmemcpy
17000 @opindex mmemcpy
17001 Do not optimize block moves, use @code{memcpy}.
17003 @item -mno-clearbss
17004 @opindex mno-clearbss
17005 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17007 @item -mcpu=@var{cpu-type}
17008 @opindex mcpu=
17009 Use features of, and schedule code for, the given CPU.
17010 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17011 where @var{X} is a major version, @var{YY} is the minor version, and
17012 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17013 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17015 @item -mxl-soft-mul
17016 @opindex mxl-soft-mul
17017 Use software multiply emulation (default).
17019 @item -mxl-soft-div
17020 @opindex mxl-soft-div
17021 Use software emulation for divides (default).
17023 @item -mxl-barrel-shift
17024 @opindex mxl-barrel-shift
17025 Use the hardware barrel shifter.
17027 @item -mxl-pattern-compare
17028 @opindex mxl-pattern-compare
17029 Use pattern compare instructions.
17031 @item -msmall-divides
17032 @opindex msmall-divides
17033 Use table lookup optimization for small signed integer divisions.
17035 @item -mxl-stack-check
17036 @opindex mxl-stack-check
17037 This option is deprecated.  Use @option{-fstack-check} instead.
17039 @item -mxl-gp-opt
17040 @opindex mxl-gp-opt
17041 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17043 @item -mxl-multiply-high
17044 @opindex mxl-multiply-high
17045 Use multiply high instructions for high part of 32x32 multiply.
17047 @item -mxl-float-convert
17048 @opindex mxl-float-convert
17049 Use hardware floating-point conversion instructions.
17051 @item -mxl-float-sqrt
17052 @opindex mxl-float-sqrt
17053 Use hardware floating-point square root instruction.
17055 @item -mbig-endian
17056 @opindex mbig-endian
17057 Generate code for a big-endian target.
17059 @item -mlittle-endian
17060 @opindex mlittle-endian
17061 Generate code for a little-endian target.
17063 @item -mxl-reorder
17064 @opindex mxl-reorder
17065 Use reorder instructions (swap and byte reversed load/store).
17067 @item -mxl-mode-@var{app-model}
17068 Select application model @var{app-model}.  Valid models are
17069 @table @samp
17070 @item executable
17071 normal executable (default), uses startup code @file{crt0.o}.
17073 @item xmdstub
17074 for use with Xilinx Microprocessor Debugger (XMD) based
17075 software intrusive debug agent called xmdstub. This uses startup file
17076 @file{crt1.o} and sets the start address of the program to 0x800.
17078 @item bootstrap
17079 for applications that are loaded using a bootloader.
17080 This model uses startup file @file{crt2.o} which does not contain a processor
17081 reset vector handler. This is suitable for transferring control on a
17082 processor reset to the bootloader rather than the application.
17084 @item novectors
17085 for applications that do not require any of the
17086 MicroBlaze vectors. This option may be useful for applications running
17087 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17088 @end table
17090 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17091 @option{-mxl-mode-@var{app-model}}.
17093 @end table
17095 @node MIPS Options
17096 @subsection MIPS Options
17097 @cindex MIPS options
17099 @table @gcctabopt
17101 @item -EB
17102 @opindex EB
17103 Generate big-endian code.
17105 @item -EL
17106 @opindex EL
17107 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17108 configurations.
17110 @item -march=@var{arch}
17111 @opindex march
17112 Generate code that runs on @var{arch}, which can be the name of a
17113 generic MIPS ISA, or the name of a particular processor.
17114 The ISA names are:
17115 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17116 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
17117 The processor names are:
17118 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17119 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17120 @samp{5kc}, @samp{5kf},
17121 @samp{20kc},
17122 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17123 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17124 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17125 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17126 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17127 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17128 @samp{m4k},
17129 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17130 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
17131 @samp{orion},
17132 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17133 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17134 @samp{rm7000}, @samp{rm9000},
17135 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17136 @samp{sb1},
17137 @samp{sr71000},
17138 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17139 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17140 @samp{xlr} and @samp{xlp}.
17141 The special value @samp{from-abi} selects the
17142 most compatible architecture for the selected ABI (that is,
17143 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17145 The native Linux/GNU toolchain also supports the value @samp{native},
17146 which selects the best architecture option for the host processor.
17147 @option{-march=native} has no effect if GCC does not recognize
17148 the processor.
17150 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17151 (for example, @option{-march=r2k}).  Prefixes are optional, and
17152 @samp{vr} may be written @samp{r}.
17154 Names of the form @samp{@var{n}f2_1} refer to processors with
17155 FPUs clocked at half the rate of the core, names of the form
17156 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17157 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17158 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17159 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17160 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17161 accepted as synonyms for @samp{@var{n}f1_1}.
17163 GCC defines two macros based on the value of this option.  The first
17164 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17165 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17166 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17167 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17168 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17170 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17171 above.  In other words, it has the full prefix and does not
17172 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17173 the macro names the resolved architecture (either @samp{"mips1"} or
17174 @samp{"mips3"}).  It names the default architecture when no
17175 @option{-march} option is given.
17177 @item -mtune=@var{arch}
17178 @opindex mtune
17179 Optimize for @var{arch}.  Among other things, this option controls
17180 the way instructions are scheduled, and the perceived cost of arithmetic
17181 operations.  The list of @var{arch} values is the same as for
17182 @option{-march}.
17184 When this option is not used, GCC optimizes for the processor
17185 specified by @option{-march}.  By using @option{-march} and
17186 @option{-mtune} together, it is possible to generate code that
17187 runs on a family of processors, but optimize the code for one
17188 particular member of that family.
17190 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17191 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17192 @option{-march} ones described above.
17194 @item -mips1
17195 @opindex mips1
17196 Equivalent to @option{-march=mips1}.
17198 @item -mips2
17199 @opindex mips2
17200 Equivalent to @option{-march=mips2}.
17202 @item -mips3
17203 @opindex mips3
17204 Equivalent to @option{-march=mips3}.
17206 @item -mips4
17207 @opindex mips4
17208 Equivalent to @option{-march=mips4}.
17210 @item -mips32
17211 @opindex mips32
17212 Equivalent to @option{-march=mips32}.
17214 @item -mips32r2
17215 @opindex mips32r2
17216 Equivalent to @option{-march=mips32r2}.
17218 @item -mips64
17219 @opindex mips64
17220 Equivalent to @option{-march=mips64}.
17222 @item -mips64r2
17223 @opindex mips64r2
17224 Equivalent to @option{-march=mips64r2}.
17226 @item -mips16
17227 @itemx -mno-mips16
17228 @opindex mips16
17229 @opindex mno-mips16
17230 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17231 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17233 MIPS16 code generation can also be controlled on a per-function basis
17234 by means of @code{mips16} and @code{nomips16} attributes.
17235 @xref{Function Attributes}, for more information.
17237 @item -mflip-mips16
17238 @opindex mflip-mips16
17239 Generate MIPS16 code on alternating functions.  This option is provided
17240 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17241 not intended for ordinary use in compiling user code.
17243 @item -minterlink-compressed
17244 @item -mno-interlink-compressed
17245 @opindex minterlink-compressed
17246 @opindex mno-interlink-compressed
17247 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17248 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17250 For example, code using the standard ISA encoding cannot jump directly
17251 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17252 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17253 knows that the target of the jump is not compressed.
17255 @item -minterlink-mips16
17256 @itemx -mno-interlink-mips16
17257 @opindex minterlink-mips16
17258 @opindex mno-interlink-mips16
17259 Aliases of @option{-minterlink-compressed} and
17260 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17261 and are retained for backwards compatibility.
17263 @item -mabi=32
17264 @itemx -mabi=o64
17265 @itemx -mabi=n32
17266 @itemx -mabi=64
17267 @itemx -mabi=eabi
17268 @opindex mabi=32
17269 @opindex mabi=o64
17270 @opindex mabi=n32
17271 @opindex mabi=64
17272 @opindex mabi=eabi
17273 Generate code for the given ABI@.
17275 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17276 generates 64-bit code when you select a 64-bit architecture, but you
17277 can use @option{-mgp32} to get 32-bit code instead.
17279 For information about the O64 ABI, see
17280 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17282 GCC supports a variant of the o32 ABI in which floating-point registers
17283 are 64 rather than 32 bits wide.  You can select this combination with
17284 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17285 and @code{mfhc1} instructions and is therefore only supported for
17286 MIPS32R2 processors.
17288 The register assignments for arguments and return values remain the
17289 same, but each scalar value is passed in a single 64-bit register
17290 rather than a pair of 32-bit registers.  For example, scalar
17291 floating-point values are returned in @samp{$f0} only, not a
17292 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17293 remains the same, but all 64 bits are saved.
17295 @item -mabicalls
17296 @itemx -mno-abicalls
17297 @opindex mabicalls
17298 @opindex mno-abicalls
17299 Generate (do not generate) code that is suitable for SVR4-style
17300 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17301 systems.
17303 @item -mshared
17304 @itemx -mno-shared
17305 Generate (do not generate) code that is fully position-independent,
17306 and that can therefore be linked into shared libraries.  This option
17307 only affects @option{-mabicalls}.
17309 All @option{-mabicalls} code has traditionally been position-independent,
17310 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17311 as an extension, the GNU toolchain allows executables to use absolute
17312 accesses for locally-binding symbols.  It can also use shorter GP
17313 initialization sequences and generate direct calls to locally-defined
17314 functions.  This mode is selected by @option{-mno-shared}.
17316 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17317 objects that can only be linked by the GNU linker.  However, the option
17318 does not affect the ABI of the final executable; it only affects the ABI
17319 of relocatable objects.  Using @option{-mno-shared} generally makes
17320 executables both smaller and quicker.
17322 @option{-mshared} is the default.
17324 @item -mplt
17325 @itemx -mno-plt
17326 @opindex mplt
17327 @opindex mno-plt
17328 Assume (do not assume) that the static and dynamic linkers
17329 support PLTs and copy relocations.  This option only affects
17330 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17331 has no effect without @option{-msym32}.
17333 You can make @option{-mplt} the default by configuring
17334 GCC with @option{--with-mips-plt}.  The default is
17335 @option{-mno-plt} otherwise.
17337 @item -mxgot
17338 @itemx -mno-xgot
17339 @opindex mxgot
17340 @opindex mno-xgot
17341 Lift (do not lift) the usual restrictions on the size of the global
17342 offset table.
17344 GCC normally uses a single instruction to load values from the GOT@.
17345 While this is relatively efficient, it only works if the GOT
17346 is smaller than about 64k.  Anything larger causes the linker
17347 to report an error such as:
17349 @cindex relocation truncated to fit (MIPS)
17350 @smallexample
17351 relocation truncated to fit: R_MIPS_GOT16 foobar
17352 @end smallexample
17354 If this happens, you should recompile your code with @option{-mxgot}.
17355 This works with very large GOTs, although the code is also
17356 less efficient, since it takes three instructions to fetch the
17357 value of a global symbol.
17359 Note that some linkers can create multiple GOTs.  If you have such a
17360 linker, you should only need to use @option{-mxgot} when a single object
17361 file accesses more than 64k's worth of GOT entries.  Very few do.
17363 These options have no effect unless GCC is generating position
17364 independent code.
17366 @item -mgp32
17367 @opindex mgp32
17368 Assume that general-purpose registers are 32 bits wide.
17370 @item -mgp64
17371 @opindex mgp64
17372 Assume that general-purpose registers are 64 bits wide.
17374 @item -mfp32
17375 @opindex mfp32
17376 Assume that floating-point registers are 32 bits wide.
17378 @item -mfp64
17379 @opindex mfp64
17380 Assume that floating-point registers are 64 bits wide.
17382 @item -mhard-float
17383 @opindex mhard-float
17384 Use floating-point coprocessor instructions.
17386 @item -msoft-float
17387 @opindex msoft-float
17388 Do not use floating-point coprocessor instructions.  Implement
17389 floating-point calculations using library calls instead.
17391 @item -mno-float
17392 @opindex mno-float
17393 Equivalent to @option{-msoft-float}, but additionally asserts that the
17394 program being compiled does not perform any floating-point operations.
17395 This option is presently supported only by some bare-metal MIPS
17396 configurations, where it may select a special set of libraries
17397 that lack all floating-point support (including, for example, the
17398 floating-point @code{printf} formats).  
17399 If code compiled with @code{-mno-float} accidentally contains
17400 floating-point operations, it is likely to suffer a link-time
17401 or run-time failure.
17403 @item -msingle-float
17404 @opindex msingle-float
17405 Assume that the floating-point coprocessor only supports single-precision
17406 operations.
17408 @item -mdouble-float
17409 @opindex mdouble-float
17410 Assume that the floating-point coprocessor supports double-precision
17411 operations.  This is the default.
17413 @item -mabs=2008
17414 @itemx -mabs=legacy
17415 @opindex mabs=2008
17416 @opindex mabs=legacy
17417 These options control the treatment of the special not-a-number (NaN)
17418 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17419 @code{neg.@i{fmt}} machine instructions.
17421 By default or when the @option{-mabs=legacy} is used the legacy
17422 treatment is selected.  In this case these instructions are considered
17423 arithmetic and avoided where correct operation is required and the
17424 input operand might be a NaN.  A longer sequence of instructions that
17425 manipulate the sign bit of floating-point datum manually is used
17426 instead unless the @option{-ffinite-math-only} option has also been
17427 specified.
17429 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17430 this case these instructions are considered non-arithmetic and therefore
17431 operating correctly in all cases, including in particular where the
17432 input operand is a NaN.  These instructions are therefore always used
17433 for the respective operations.
17435 @item -mnan=2008
17436 @itemx -mnan=legacy
17437 @opindex mnan=2008
17438 @opindex mnan=legacy
17439 These options control the encoding of the special not-a-number (NaN)
17440 IEEE 754 floating-point data.
17442 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17443 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17444 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17445 by the first bit of their trailing significand field being 1.
17447 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17448 this case qNaNs are denoted by the first bit of their trailing
17449 significand field being 1, whereas sNaNs are denoted by the first bit of
17450 their trailing significand field being 0.
17452 The default is @option{-mnan=legacy} unless GCC has been configured with
17453 @option{--with-nan=2008}.
17455 @item -mllsc
17456 @itemx -mno-llsc
17457 @opindex mllsc
17458 @opindex mno-llsc
17459 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17460 implement atomic memory built-in functions.  When neither option is
17461 specified, GCC uses the instructions if the target architecture
17462 supports them.
17464 @option{-mllsc} is useful if the runtime environment can emulate the
17465 instructions and @option{-mno-llsc} can be useful when compiling for
17466 nonstandard ISAs.  You can make either option the default by
17467 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17468 respectively.  @option{--with-llsc} is the default for some
17469 configurations; see the installation documentation for details.
17471 @item -mdsp
17472 @itemx -mno-dsp
17473 @opindex mdsp
17474 @opindex mno-dsp
17475 Use (do not use) revision 1 of the MIPS DSP ASE@.
17476 @xref{MIPS DSP Built-in Functions}.  This option defines the
17477 preprocessor macro @samp{__mips_dsp}.  It also defines
17478 @samp{__mips_dsp_rev} to 1.
17480 @item -mdspr2
17481 @itemx -mno-dspr2
17482 @opindex mdspr2
17483 @opindex mno-dspr2
17484 Use (do not use) revision 2 of the MIPS DSP ASE@.
17485 @xref{MIPS DSP Built-in Functions}.  This option defines the
17486 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
17487 It also defines @samp{__mips_dsp_rev} to 2.
17489 @item -msmartmips
17490 @itemx -mno-smartmips
17491 @opindex msmartmips
17492 @opindex mno-smartmips
17493 Use (do not use) the MIPS SmartMIPS ASE.
17495 @item -mpaired-single
17496 @itemx -mno-paired-single
17497 @opindex mpaired-single
17498 @opindex mno-paired-single
17499 Use (do not use) paired-single floating-point instructions.
17500 @xref{MIPS Paired-Single Support}.  This option requires
17501 hardware floating-point support to be enabled.
17503 @item -mdmx
17504 @itemx -mno-mdmx
17505 @opindex mdmx
17506 @opindex mno-mdmx
17507 Use (do not use) MIPS Digital Media Extension instructions.
17508 This option can only be used when generating 64-bit code and requires
17509 hardware floating-point support to be enabled.
17511 @item -mips3d
17512 @itemx -mno-mips3d
17513 @opindex mips3d
17514 @opindex mno-mips3d
17515 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17516 The option @option{-mips3d} implies @option{-mpaired-single}.
17518 @item -mmicromips
17519 @itemx -mno-micromips
17520 @opindex mmicromips
17521 @opindex mno-mmicromips
17522 Generate (do not generate) microMIPS code.
17524 MicroMIPS code generation can also be controlled on a per-function basis
17525 by means of @code{micromips} and @code{nomicromips} attributes.
17526 @xref{Function Attributes}, for more information.
17528 @item -mmt
17529 @itemx -mno-mt
17530 @opindex mmt
17531 @opindex mno-mt
17532 Use (do not use) MT Multithreading instructions.
17534 @item -mmcu
17535 @itemx -mno-mcu
17536 @opindex mmcu
17537 @opindex mno-mcu
17538 Use (do not use) the MIPS MCU ASE instructions.
17540 @item -meva
17541 @itemx -mno-eva
17542 @opindex meva
17543 @opindex mno-eva
17544 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17546 @item -mvirt
17547 @itemx -mno-virt
17548 @opindex mvirt
17549 @opindex mno-virt
17550 Use (do not use) the MIPS Virtualization Application Specific instructions.
17552 @item -mlong64
17553 @opindex mlong64
17554 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17555 an explanation of the default and the way that the pointer size is
17556 determined.
17558 @item -mlong32
17559 @opindex mlong32
17560 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17562 The default size of @code{int}s, @code{long}s and pointers depends on
17563 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17564 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17565 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17566 or the same size as integer registers, whichever is smaller.
17568 @item -msym32
17569 @itemx -mno-sym32
17570 @opindex msym32
17571 @opindex mno-sym32
17572 Assume (do not assume) that all symbols have 32-bit values, regardless
17573 of the selected ABI@.  This option is useful in combination with
17574 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17575 to generate shorter and faster references to symbolic addresses.
17577 @item -G @var{num}
17578 @opindex G
17579 Put definitions of externally-visible data in a small data section
17580 if that data is no bigger than @var{num} bytes.  GCC can then generate
17581 more efficient accesses to the data; see @option{-mgpopt} for details.
17583 The default @option{-G} option depends on the configuration.
17585 @item -mlocal-sdata
17586 @itemx -mno-local-sdata
17587 @opindex mlocal-sdata
17588 @opindex mno-local-sdata
17589 Extend (do not extend) the @option{-G} behavior to local data too,
17590 such as to static variables in C@.  @option{-mlocal-sdata} is the
17591 default for all configurations.
17593 If the linker complains that an application is using too much small data,
17594 you might want to try rebuilding the less performance-critical parts with
17595 @option{-mno-local-sdata}.  You might also want to build large
17596 libraries with @option{-mno-local-sdata}, so that the libraries leave
17597 more room for the main program.
17599 @item -mextern-sdata
17600 @itemx -mno-extern-sdata
17601 @opindex mextern-sdata
17602 @opindex mno-extern-sdata
17603 Assume (do not assume) that externally-defined data is in
17604 a small data section if the size of that data is within the @option{-G} limit.
17605 @option{-mextern-sdata} is the default for all configurations.
17607 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17608 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17609 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17610 is placed in a small data section.  If @var{Var} is defined by another
17611 module, you must either compile that module with a high-enough
17612 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17613 definition.  If @var{Var} is common, you must link the application
17614 with a high-enough @option{-G} setting.
17616 The easiest way of satisfying these restrictions is to compile
17617 and link every module with the same @option{-G} option.  However,
17618 you may wish to build a library that supports several different
17619 small data limits.  You can do this by compiling the library with
17620 the highest supported @option{-G} setting and additionally using
17621 @option{-mno-extern-sdata} to stop the library from making assumptions
17622 about externally-defined data.
17624 @item -mgpopt
17625 @itemx -mno-gpopt
17626 @opindex mgpopt
17627 @opindex mno-gpopt
17628 Use (do not use) GP-relative accesses for symbols that are known to be
17629 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17630 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17631 configurations.
17633 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17634 might not hold the value of @code{_gp}.  For example, if the code is
17635 part of a library that might be used in a boot monitor, programs that
17636 call boot monitor routines pass an unknown value in @code{$gp}.
17637 (In such situations, the boot monitor itself is usually compiled
17638 with @option{-G0}.)
17640 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17641 @option{-mno-extern-sdata}.
17643 @item -membedded-data
17644 @itemx -mno-embedded-data
17645 @opindex membedded-data
17646 @opindex mno-embedded-data
17647 Allocate variables to the read-only data section first if possible, then
17648 next in the small data section if possible, otherwise in data.  This gives
17649 slightly slower code than the default, but reduces the amount of RAM required
17650 when executing, and thus may be preferred for some embedded systems.
17652 @item -muninit-const-in-rodata
17653 @itemx -mno-uninit-const-in-rodata
17654 @opindex muninit-const-in-rodata
17655 @opindex mno-uninit-const-in-rodata
17656 Put uninitialized @code{const} variables in the read-only data section.
17657 This option is only meaningful in conjunction with @option{-membedded-data}.
17659 @item -mcode-readable=@var{setting}
17660 @opindex mcode-readable
17661 Specify whether GCC may generate code that reads from executable sections.
17662 There are three possible settings:
17664 @table @gcctabopt
17665 @item -mcode-readable=yes
17666 Instructions may freely access executable sections.  This is the
17667 default setting.
17669 @item -mcode-readable=pcrel
17670 MIPS16 PC-relative load instructions can access executable sections,
17671 but other instructions must not do so.  This option is useful on 4KSc
17672 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17673 It is also useful on processors that can be configured to have a dual
17674 instruction/data SRAM interface and that, like the M4K, automatically
17675 redirect PC-relative loads to the instruction RAM.
17677 @item -mcode-readable=no
17678 Instructions must not access executable sections.  This option can be
17679 useful on targets that are configured to have a dual instruction/data
17680 SRAM interface but that (unlike the M4K) do not automatically redirect
17681 PC-relative loads to the instruction RAM.
17682 @end table
17684 @item -msplit-addresses
17685 @itemx -mno-split-addresses
17686 @opindex msplit-addresses
17687 @opindex mno-split-addresses
17688 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17689 relocation operators.  This option has been superseded by
17690 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17692 @item -mexplicit-relocs
17693 @itemx -mno-explicit-relocs
17694 @opindex mexplicit-relocs
17695 @opindex mno-explicit-relocs
17696 Use (do not use) assembler relocation operators when dealing with symbolic
17697 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17698 is to use assembler macros instead.
17700 @option{-mexplicit-relocs} is the default if GCC was configured
17701 to use an assembler that supports relocation operators.
17703 @item -mcheck-zero-division
17704 @itemx -mno-check-zero-division
17705 @opindex mcheck-zero-division
17706 @opindex mno-check-zero-division
17707 Trap (do not trap) on integer division by zero.
17709 The default is @option{-mcheck-zero-division}.
17711 @item -mdivide-traps
17712 @itemx -mdivide-breaks
17713 @opindex mdivide-traps
17714 @opindex mdivide-breaks
17715 MIPS systems check for division by zero by generating either a
17716 conditional trap or a break instruction.  Using traps results in
17717 smaller code, but is only supported on MIPS II and later.  Also, some
17718 versions of the Linux kernel have a bug that prevents trap from
17719 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17720 allow conditional traps on architectures that support them and
17721 @option{-mdivide-breaks} to force the use of breaks.
17723 The default is usually @option{-mdivide-traps}, but this can be
17724 overridden at configure time using @option{--with-divide=breaks}.
17725 Divide-by-zero checks can be completely disabled using
17726 @option{-mno-check-zero-division}.
17728 @item -mmemcpy
17729 @itemx -mno-memcpy
17730 @opindex mmemcpy
17731 @opindex mno-memcpy
17732 Force (do not force) the use of @code{memcpy()} for non-trivial block
17733 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17734 most constant-sized copies.
17736 @item -mlong-calls
17737 @itemx -mno-long-calls
17738 @opindex mlong-calls
17739 @opindex mno-long-calls
17740 Disable (do not disable) use of the @code{jal} instruction.  Calling
17741 functions using @code{jal} is more efficient but requires the caller
17742 and callee to be in the same 256 megabyte segment.
17744 This option has no effect on abicalls code.  The default is
17745 @option{-mno-long-calls}.
17747 @item -mmad
17748 @itemx -mno-mad
17749 @opindex mmad
17750 @opindex mno-mad
17751 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17752 instructions, as provided by the R4650 ISA@.
17754 @item -mimadd
17755 @itemx -mno-imadd
17756 @opindex mimadd
17757 @opindex mno-imadd
17758 Enable (disable) use of the @code{madd} and @code{msub} integer
17759 instructions.  The default is @option{-mimadd} on architectures
17760 that support @code{madd} and @code{msub} except for the 74k 
17761 architecture where it was found to generate slower code.
17763 @item -mfused-madd
17764 @itemx -mno-fused-madd
17765 @opindex mfused-madd
17766 @opindex mno-fused-madd
17767 Enable (disable) use of the floating-point multiply-accumulate
17768 instructions, when they are available.  The default is
17769 @option{-mfused-madd}.
17771 On the R8000 CPU when multiply-accumulate instructions are used,
17772 the intermediate product is calculated to infinite precision
17773 and is not subject to the FCSR Flush to Zero bit.  This may be
17774 undesirable in some circumstances.  On other processors the result
17775 is numerically identical to the equivalent computation using
17776 separate multiply, add, subtract and negate instructions.
17778 @item -nocpp
17779 @opindex nocpp
17780 Tell the MIPS assembler to not run its preprocessor over user
17781 assembler files (with a @samp{.s} suffix) when assembling them.
17783 @item -mfix-24k
17784 @item -mno-fix-24k
17785 @opindex mfix-24k
17786 @opindex mno-fix-24k
17787 Work around the 24K E48 (lost data on stores during refill) errata.
17788 The workarounds are implemented by the assembler rather than by GCC@.
17790 @item -mfix-r4000
17791 @itemx -mno-fix-r4000
17792 @opindex mfix-r4000
17793 @opindex mno-fix-r4000
17794 Work around certain R4000 CPU errata:
17795 @itemize @minus
17796 @item
17797 A double-word or a variable shift may give an incorrect result if executed
17798 immediately after starting an integer division.
17799 @item
17800 A double-word or a variable shift may give an incorrect result if executed
17801 while an integer multiplication is in progress.
17802 @item
17803 An integer division may give an incorrect result if started in a delay slot
17804 of a taken branch or a jump.
17805 @end itemize
17807 @item -mfix-r4400
17808 @itemx -mno-fix-r4400
17809 @opindex mfix-r4400
17810 @opindex mno-fix-r4400
17811 Work around certain R4400 CPU errata:
17812 @itemize @minus
17813 @item
17814 A double-word or a variable shift may give an incorrect result if executed
17815 immediately after starting an integer division.
17816 @end itemize
17818 @item -mfix-r10000
17819 @itemx -mno-fix-r10000
17820 @opindex mfix-r10000
17821 @opindex mno-fix-r10000
17822 Work around certain R10000 errata:
17823 @itemize @minus
17824 @item
17825 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17826 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17827 @end itemize
17829 This option can only be used if the target architecture supports
17830 branch-likely instructions.  @option{-mfix-r10000} is the default when
17831 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17832 otherwise.
17834 @item -mfix-rm7000
17835 @itemx -mno-fix-rm7000
17836 @opindex mfix-rm7000
17837 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17838 workarounds are implemented by the assembler rather than by GCC@.
17840 @item -mfix-vr4120
17841 @itemx -mno-fix-vr4120
17842 @opindex mfix-vr4120
17843 Work around certain VR4120 errata:
17844 @itemize @minus
17845 @item
17846 @code{dmultu} does not always produce the correct result.
17847 @item
17848 @code{div} and @code{ddiv} do not always produce the correct result if one
17849 of the operands is negative.
17850 @end itemize
17851 The workarounds for the division errata rely on special functions in
17852 @file{libgcc.a}.  At present, these functions are only provided by
17853 the @code{mips64vr*-elf} configurations.
17855 Other VR4120 errata require a NOP to be inserted between certain pairs of
17856 instructions.  These errata are handled by the assembler, not by GCC itself.
17858 @item -mfix-vr4130
17859 @opindex mfix-vr4130
17860 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17861 workarounds are implemented by the assembler rather than by GCC,
17862 although GCC avoids using @code{mflo} and @code{mfhi} if the
17863 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17864 instructions are available instead.
17866 @item -mfix-sb1
17867 @itemx -mno-fix-sb1
17868 @opindex mfix-sb1
17869 Work around certain SB-1 CPU core errata.
17870 (This flag currently works around the SB-1 revision 2
17871 ``F1'' and ``F2'' floating-point errata.)
17873 @item -mr10k-cache-barrier=@var{setting}
17874 @opindex mr10k-cache-barrier
17875 Specify whether GCC should insert cache barriers to avoid the
17876 side-effects of speculation on R10K processors.
17878 In common with many processors, the R10K tries to predict the outcome
17879 of a conditional branch and speculatively executes instructions from
17880 the ``taken'' branch.  It later aborts these instructions if the
17881 predicted outcome is wrong.  However, on the R10K, even aborted
17882 instructions can have side effects.
17884 This problem only affects kernel stores and, depending on the system,
17885 kernel loads.  As an example, a speculatively-executed store may load
17886 the target memory into cache and mark the cache line as dirty, even if
17887 the store itself is later aborted.  If a DMA operation writes to the
17888 same area of memory before the ``dirty'' line is flushed, the cached
17889 data overwrites the DMA-ed data.  See the R10K processor manual
17890 for a full description, including other potential problems.
17892 One workaround is to insert cache barrier instructions before every memory
17893 access that might be speculatively executed and that might have side
17894 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17895 controls GCC's implementation of this workaround.  It assumes that
17896 aborted accesses to any byte in the following regions does not have
17897 side effects:
17899 @enumerate
17900 @item
17901 the memory occupied by the current function's stack frame;
17903 @item
17904 the memory occupied by an incoming stack argument;
17906 @item
17907 the memory occupied by an object with a link-time-constant address.
17908 @end enumerate
17910 It is the kernel's responsibility to ensure that speculative
17911 accesses to these regions are indeed safe.
17913 If the input program contains a function declaration such as:
17915 @smallexample
17916 void foo (void);
17917 @end smallexample
17919 then the implementation of @code{foo} must allow @code{j foo} and
17920 @code{jal foo} to be executed speculatively.  GCC honors this
17921 restriction for functions it compiles itself.  It expects non-GCC
17922 functions (such as hand-written assembly code) to do the same.
17924 The option has three forms:
17926 @table @gcctabopt
17927 @item -mr10k-cache-barrier=load-store
17928 Insert a cache barrier before a load or store that might be
17929 speculatively executed and that might have side effects even
17930 if aborted.
17932 @item -mr10k-cache-barrier=store
17933 Insert a cache barrier before a store that might be speculatively
17934 executed and that might have side effects even if aborted.
17936 @item -mr10k-cache-barrier=none
17937 Disable the insertion of cache barriers.  This is the default setting.
17938 @end table
17940 @item -mflush-func=@var{func}
17941 @itemx -mno-flush-func
17942 @opindex mflush-func
17943 Specifies the function to call to flush the I and D caches, or to not
17944 call any such function.  If called, the function must take the same
17945 arguments as the common @code{_flush_func()}, that is, the address of the
17946 memory range for which the cache is being flushed, the size of the
17947 memory range, and the number 3 (to flush both caches).  The default
17948 depends on the target GCC was configured for, but commonly is either
17949 @samp{_flush_func} or @samp{__cpu_flush}.
17951 @item mbranch-cost=@var{num}
17952 @opindex mbranch-cost
17953 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17954 This cost is only a heuristic and is not guaranteed to produce
17955 consistent results across releases.  A zero cost redundantly selects
17956 the default, which is based on the @option{-mtune} setting.
17958 @item -mbranch-likely
17959 @itemx -mno-branch-likely
17960 @opindex mbranch-likely
17961 @opindex mno-branch-likely
17962 Enable or disable use of Branch Likely instructions, regardless of the
17963 default for the selected architecture.  By default, Branch Likely
17964 instructions may be generated if they are supported by the selected
17965 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17966 and processors that implement those architectures; for those, Branch
17967 Likely instructions are not be generated by default because the MIPS32
17968 and MIPS64 architectures specifically deprecate their use.
17970 @item -mfp-exceptions
17971 @itemx -mno-fp-exceptions
17972 @opindex mfp-exceptions
17973 Specifies whether FP exceptions are enabled.  This affects how
17974 FP instructions are scheduled for some processors.
17975 The default is that FP exceptions are
17976 enabled.
17978 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17979 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17980 FP pipe.
17982 @item -mvr4130-align
17983 @itemx -mno-vr4130-align
17984 @opindex mvr4130-align
17985 The VR4130 pipeline is two-way superscalar, but can only issue two
17986 instructions together if the first one is 8-byte aligned.  When this
17987 option is enabled, GCC aligns pairs of instructions that it
17988 thinks should execute in parallel.
17990 This option only has an effect when optimizing for the VR4130.
17991 It normally makes code faster, but at the expense of making it bigger.
17992 It is enabled by default at optimization level @option{-O3}.
17994 @item -msynci
17995 @itemx -mno-synci
17996 @opindex msynci
17997 Enable (disable) generation of @code{synci} instructions on
17998 architectures that support it.  The @code{synci} instructions (if
17999 enabled) are generated when @code{__builtin___clear_cache()} is
18000 compiled.
18002 This option defaults to @code{-mno-synci}, but the default can be
18003 overridden by configuring with @code{--with-synci}.
18005 When compiling code for single processor systems, it is generally safe
18006 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18007 does not invalidate the instruction caches on all cores and may lead
18008 to undefined behavior.
18010 @item -mrelax-pic-calls
18011 @itemx -mno-relax-pic-calls
18012 @opindex mrelax-pic-calls
18013 Try to turn PIC calls that are normally dispatched via register
18014 @code{$25} into direct calls.  This is only possible if the linker can
18015 resolve the destination at link-time and if the destination is within
18016 range for a direct call.
18018 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18019 an assembler and a linker that support the @code{.reloc} assembly
18020 directive and @code{-mexplicit-relocs} is in effect.  With
18021 @code{-mno-explicit-relocs}, this optimization can be performed by the
18022 assembler and the linker alone without help from the compiler.
18024 @item -mmcount-ra-address
18025 @itemx -mno-mcount-ra-address
18026 @opindex mmcount-ra-address
18027 @opindex mno-mcount-ra-address
18028 Emit (do not emit) code that allows @code{_mcount} to modify the
18029 calling function's return address.  When enabled, this option extends
18030 the usual @code{_mcount} interface with a new @var{ra-address}
18031 parameter, which has type @code{intptr_t *} and is passed in register
18032 @code{$12}.  @code{_mcount} can then modify the return address by
18033 doing both of the following:
18034 @itemize
18035 @item
18036 Returning the new address in register @code{$31}.
18037 @item
18038 Storing the new address in @code{*@var{ra-address}},
18039 if @var{ra-address} is nonnull.
18040 @end itemize
18042 The default is @option{-mno-mcount-ra-address}.
18044 @end table
18046 @node MMIX Options
18047 @subsection MMIX Options
18048 @cindex MMIX Options
18050 These options are defined for the MMIX:
18052 @table @gcctabopt
18053 @item -mlibfuncs
18054 @itemx -mno-libfuncs
18055 @opindex mlibfuncs
18056 @opindex mno-libfuncs
18057 Specify that intrinsic library functions are being compiled, passing all
18058 values in registers, no matter the size.
18060 @item -mepsilon
18061 @itemx -mno-epsilon
18062 @opindex mepsilon
18063 @opindex mno-epsilon
18064 Generate floating-point comparison instructions that compare with respect
18065 to the @code{rE} epsilon register.
18067 @item -mabi=mmixware
18068 @itemx -mabi=gnu
18069 @opindex mabi=mmixware
18070 @opindex mabi=gnu
18071 Generate code that passes function parameters and return values that (in
18072 the called function) are seen as registers @code{$0} and up, as opposed to
18073 the GNU ABI which uses global registers @code{$231} and up.
18075 @item -mzero-extend
18076 @itemx -mno-zero-extend
18077 @opindex mzero-extend
18078 @opindex mno-zero-extend
18079 When reading data from memory in sizes shorter than 64 bits, use (do not
18080 use) zero-extending load instructions by default, rather than
18081 sign-extending ones.
18083 @item -mknuthdiv
18084 @itemx -mno-knuthdiv
18085 @opindex mknuthdiv
18086 @opindex mno-knuthdiv
18087 Make the result of a division yielding a remainder have the same sign as
18088 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18089 remainder follows the sign of the dividend.  Both methods are
18090 arithmetically valid, the latter being almost exclusively used.
18092 @item -mtoplevel-symbols
18093 @itemx -mno-toplevel-symbols
18094 @opindex mtoplevel-symbols
18095 @opindex mno-toplevel-symbols
18096 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18097 code can be used with the @code{PREFIX} assembly directive.
18099 @item -melf
18100 @opindex melf
18101 Generate an executable in the ELF format, rather than the default
18102 @samp{mmo} format used by the @command{mmix} simulator.
18104 @item -mbranch-predict
18105 @itemx -mno-branch-predict
18106 @opindex mbranch-predict
18107 @opindex mno-branch-predict
18108 Use (do not use) the probable-branch instructions, when static branch
18109 prediction indicates a probable branch.
18111 @item -mbase-addresses
18112 @itemx -mno-base-addresses
18113 @opindex mbase-addresses
18114 @opindex mno-base-addresses
18115 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18116 base address automatically generates a request (handled by the assembler
18117 and the linker) for a constant to be set up in a global register.  The
18118 register is used for one or more base address requests within the range 0
18119 to 255 from the value held in the register.  The generally leads to short
18120 and fast code, but the number of different data items that can be
18121 addressed is limited.  This means that a program that uses lots of static
18122 data may require @option{-mno-base-addresses}.
18124 @item -msingle-exit
18125 @itemx -mno-single-exit
18126 @opindex msingle-exit
18127 @opindex mno-single-exit
18128 Force (do not force) generated code to have a single exit point in each
18129 function.
18130 @end table
18132 @node MN10300 Options
18133 @subsection MN10300 Options
18134 @cindex MN10300 options
18136 These @option{-m} options are defined for Matsushita MN10300 architectures:
18138 @table @gcctabopt
18139 @item -mmult-bug
18140 @opindex mmult-bug
18141 Generate code to avoid bugs in the multiply instructions for the MN10300
18142 processors.  This is the default.
18144 @item -mno-mult-bug
18145 @opindex mno-mult-bug
18146 Do not generate code to avoid bugs in the multiply instructions for the
18147 MN10300 processors.
18149 @item -mam33
18150 @opindex mam33
18151 Generate code using features specific to the AM33 processor.
18153 @item -mno-am33
18154 @opindex mno-am33
18155 Do not generate code using features specific to the AM33 processor.  This
18156 is the default.
18158 @item -mam33-2
18159 @opindex mam33-2
18160 Generate code using features specific to the AM33/2.0 processor.
18162 @item -mam34
18163 @opindex mam34
18164 Generate code using features specific to the AM34 processor.
18166 @item -mtune=@var{cpu-type}
18167 @opindex mtune
18168 Use the timing characteristics of the indicated CPU type when
18169 scheduling instructions.  This does not change the targeted processor
18170 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18171 @samp{am33-2} or @samp{am34}.
18173 @item -mreturn-pointer-on-d0
18174 @opindex mreturn-pointer-on-d0
18175 When generating a function that returns a pointer, return the pointer
18176 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18177 only in @code{a0}, and attempts to call such functions without a prototype
18178 result in errors.  Note that this option is on by default; use
18179 @option{-mno-return-pointer-on-d0} to disable it.
18181 @item -mno-crt0
18182 @opindex mno-crt0
18183 Do not link in the C run-time initialization object file.
18185 @item -mrelax
18186 @opindex mrelax
18187 Indicate to the linker that it should perform a relaxation optimization pass
18188 to shorten branches, calls and absolute memory addresses.  This option only
18189 has an effect when used on the command line for the final link step.
18191 This option makes symbolic debugging impossible.
18193 @item -mliw
18194 @opindex mliw
18195 Allow the compiler to generate @emph{Long Instruction Word}
18196 instructions if the target is the @samp{AM33} or later.  This is the
18197 default.  This option defines the preprocessor macro @samp{__LIW__}.
18199 @item -mnoliw
18200 @opindex mnoliw
18201 Do not allow the compiler to generate @emph{Long Instruction Word}
18202 instructions.  This option defines the preprocessor macro
18203 @samp{__NO_LIW__}.
18205 @item -msetlb
18206 @opindex msetlb
18207 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18208 instructions if the target is the @samp{AM33} or later.  This is the
18209 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18211 @item -mnosetlb
18212 @opindex mnosetlb
18213 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18214 instructions.  This option defines the preprocessor macro
18215 @samp{__NO_SETLB__}.
18217 @end table
18219 @node Moxie Options
18220 @subsection Moxie Options
18221 @cindex Moxie Options
18223 @table @gcctabopt
18225 @item -meb
18226 @opindex meb
18227 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18228 configurations.
18230 @item -mel
18231 @opindex mel
18232 Generate little-endian code.
18234 @item -mno-crt0
18235 @opindex mno-crt0
18236 Do not link in the C run-time initialization object file.
18238 @end table
18240 @node MSP430 Options
18241 @subsection MSP430 Options
18242 @cindex MSP430 Options
18244 These options are defined for the MSP430:
18246 @table @gcctabopt
18248 @item -masm-hex
18249 @opindex masm-hex
18250 Force assembly output to always use hex constants.  Normally such
18251 constants are signed decimals, but this option is available for
18252 testsuite and/or aesthetic purposes.
18254 @item -mmcu=
18255 @opindex mmcu=
18256 Select the MCU to target.  This is used to create a C preprocessor
18257 symbol based upon the MCU name, converted to upper case and pre- and
18258 post- fixed with @code{__}.  This in turn will be used by the
18259 @code{msp430.h} header file to select an MCU specific supplimentary
18260 header file.
18262 The option also sets the ISA to use.  If the MCU name is one that is
18263 known to only support the 430 ISA then that is selected, otherwise the
18264 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18265 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18266 name will select the 430X ISA.
18268 In addition an MCU specific linker script will be added to the linker
18269 command line.  The script's name is the name of the MCU with
18270 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18271 command line will define the C preprocessor symbol @code{__XXX__} and
18272 cause the linker to search for a script called @file{xxx.ld}.
18274 This option is also passed on to the assembler.
18276 @item -mcpu=
18277 @opindex -mcpu=
18278 Specifies the ISA to use.  Accepted values are @code{msp430},
18279 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18280 @option{-mmcu=} option should be used to select the ISA.
18282 @item -msim
18283 @opindex msim
18284 Link to the simulator runtime libraries and linker script.  Overrides
18285 any scripts that would be selected by the @option{-mmcu=} option.
18287 @item -mlarge
18288 @opindex mlarge
18289 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18291 @item -msmall
18292 @opindex msmall
18293 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18295 @item -mrelax
18296 @opindex mrelax
18297 This option is passed to the assembler and linker, and allows the
18298 linker to perform certain optimizations that cannot be done until
18299 the final link.
18301 @item mhwmult=
18302 @opindex mhwmult=
18303 Describes the type of hardware multiply supported by the target.
18304 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18305 for the original 16-bit-only multiply supported by early MCUs.
18306 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18307 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18308 A value of @code{auto} can also be given.  This tells GCC to deduce
18309 the hardware multiply support based upon the MCU name provided by the
18310 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18311 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18312 default setting.
18314 Hardware multiplies are normally performed by calling a library
18315 routine.  This saves space in the generated code.  When compiling at
18316 @code{-O3} or higher however the hardware multiplier is invoked
18317 inline.  This makes for bigger, but faster code.
18319 The hardware multiply routines disable interrupts whilst running and
18320 restore the previous interrupt state when they finish.  This makes
18321 them safe to use inside interrupt handlers as well as in normal code.
18323 @item -minrt
18324 @opindex minrt
18325 Enable the use of a minimum runtime environment - no static
18326 initializers or constructors.  This is intended for memory-constrained
18327 devices.  The compiler will include special symbols in some objects
18328 that tell the linker and runtime which code fragments are required.
18330 @end table
18332 @node NDS32 Options
18333 @subsection NDS32 Options
18334 @cindex NDS32 Options
18336 These options are defined for NDS32 implementations:
18338 @table @gcctabopt
18340 @item -mbig-endian
18341 @opindex mbig-endian
18342 Generate code in big-endian mode.
18344 @item -mlittle-endian
18345 @opindex mlittle-endian
18346 Generate code in little-endian mode.
18348 @item -mreduced-regs
18349 @opindex mreduced-regs
18350 Use reduced-set registers for register allocation.
18352 @item -mfull-regs
18353 @opindex mfull-regs
18354 Use full-set registers for register allocation.
18356 @item -mcmov
18357 @opindex mcmov
18358 Generate conditional move instructions.
18360 @item -mno-cmov
18361 @opindex mno-cmov
18362 Do not generate conditional move instructions.
18364 @item -mperf-ext
18365 @opindex mperf-ext
18366 Generate performance extension instructions.
18368 @item -mno-perf-ext
18369 @opindex mno-perf-ext
18370 Do not generate performance extension instructions.
18372 @item -mv3push
18373 @opindex mv3push
18374 Generate v3 push25/pop25 instructions.
18376 @item -mno-v3push
18377 @opindex mno-v3push
18378 Do not generate v3 push25/pop25 instructions.
18380 @item -m16-bit
18381 @opindex m16-bit
18382 Generate 16-bit instructions.
18384 @item -mno-16-bit
18385 @opindex mno-16-bit
18386 Do not generate 16-bit instructions.
18388 @item -mgp-direct
18389 @opindex mgp-direct
18390 Generate GP base instructions directly.
18392 @item -mno-gp-direct
18393 @opindex mno-gp-direct
18394 Do no generate GP base instructions directly.
18396 @item -misr-vector-size=@var{num}
18397 @opindex misr-vector-size
18398 Specify the size of each interrupt vector, which must be 4 or 16.
18400 @item -mcache-block-size=@var{num}
18401 @opindex mcache-block-size
18402 Specify the size of each cache block,
18403 which must be a power of 2 between 4 and 512.
18405 @item -march=@var{arch}
18406 @opindex march
18407 Specify the name of the target architecture.
18409 @item -mforce-fp-as-gp
18410 @opindex mforce-fp-as-gp
18411 Prevent $fp being allocated during register allocation so that compiler
18412 is able to force performing fp-as-gp optimization.
18414 @item -mforbid-fp-as-gp
18415 @opindex mforbid-fp-as-gp
18416 Forbid using $fp to access static and global variables.
18417 This option strictly forbids fp-as-gp optimization
18418 regardless of @option{-mforce-fp-as-gp}.
18420 @item -mex9
18421 @opindex mex9
18422 Use special directives to guide linker doing ex9 optimization.
18424 @item -mctor-dtor
18425 @opindex mctor-dtor
18426 Enable constructor/destructor feature.
18428 @item -mrelax
18429 @opindex mrelax
18430 Guide linker to relax instructions.
18432 @end table
18434 @node Nios II Options
18435 @subsection Nios II Options
18436 @cindex Nios II options
18437 @cindex Altera Nios II options
18439 These are the options defined for the Altera Nios II processor.
18441 @table @gcctabopt
18443 @item -G @var{num}
18444 @opindex G
18445 @cindex smaller data references
18446 Put global and static objects less than or equal to @var{num} bytes
18447 into the small data or BSS sections instead of the normal data or BSS
18448 sections.  The default value of @var{num} is 8.
18450 @item -mgpopt
18451 @itemx -mno-gpopt
18452 @opindex mgpopt
18453 @opindex mno-gpopt
18454 Generate (do not generate) GP-relative accesses for objects in the
18455 small data or BSS sections.  The default is @option{-mgpopt} except
18456 when @option{-fpic} or @option{-fPIC} is specified to generate
18457 position-independent code.  Note that the Nios II ABI does not permit
18458 GP-relative accesses from shared libraries.
18460 You may need to specify @option{-mno-gpopt} explicitly when building
18461 programs that include large amounts of small data, including large
18462 GOT data sections.  In this case, the 16-bit offset for GP-relative
18463 addressing may not be large enough to allow access to the entire 
18464 small data section.
18466 @item -mel
18467 @itemx -meb
18468 @opindex mel
18469 @opindex meb
18470 Generate little-endian (default) or big-endian (experimental) code,
18471 respectively.
18473 @item -mbypass-cache
18474 @itemx -mno-bypass-cache
18475 @opindex mno-bypass-cache
18476 @opindex mbypass-cache
18477 Force all load and store instructions to always bypass cache by 
18478 using I/O variants of the instructions. The default is not to
18479 bypass the cache.
18481 @item -mno-cache-volatile 
18482 @itemx -mcache-volatile       
18483 @opindex mcache-volatile 
18484 @opindex mno-cache-volatile
18485 Volatile memory access bypass the cache using the I/O variants of 
18486 the load and store instructions. The default is not to bypass the cache.
18488 @item -mno-fast-sw-div
18489 @itemx -mfast-sw-div
18490 @opindex mno-fast-sw-div
18491 @opindex mfast-sw-div
18492 Do not use table-based fast divide for small numbers. The default 
18493 is to use the fast divide at @option{-O3} and above.
18495 @item -mno-hw-mul
18496 @itemx -mhw-mul
18497 @itemx -mno-hw-mulx
18498 @itemx -mhw-mulx
18499 @itemx -mno-hw-div
18500 @itemx -mhw-div
18501 @opindex mno-hw-mul
18502 @opindex mhw-mul
18503 @opindex mno-hw-mulx
18504 @opindex mhw-mulx
18505 @opindex mno-hw-div
18506 @opindex mhw-div
18507 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18508 instructions by the compiler. The default is to emit @code{mul}
18509 and not emit @code{div} and @code{mulx}.
18511 @item -mcustom-@var{insn}=@var{N}
18512 @itemx -mno-custom-@var{insn}
18513 @opindex mcustom-@var{insn}
18514 @opindex mno-custom-@var{insn}
18515 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18516 custom instruction with encoding @var{N} when generating code that uses 
18517 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
18518 instruction 253 for single-precision floating-point add operations instead
18519 of the default behavior of using a library call.
18521 The following values of @var{insn} are supported.  Except as otherwise
18522 noted, floating-point operations are expected to be implemented with
18523 normal IEEE 754 semantics and correspond directly to the C operators or the
18524 equivalent GCC built-in functions (@pxref{Other Builtins}).
18526 Single-precision floating point:
18527 @table @asis
18529 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18530 Binary arithmetic operations.
18532 @item @samp{fnegs}
18533 Unary negation.
18535 @item @samp{fabss}
18536 Unary absolute value.
18538 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18539 Comparison operations.
18541 @item @samp{fmins}, @samp{fmaxs}
18542 Floating-point minimum and maximum.  These instructions are only
18543 generated if @option{-ffinite-math-only} is specified.
18545 @item @samp{fsqrts}
18546 Unary square root operation.
18548 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18549 Floating-point trigonometric and exponential functions.  These instructions
18550 are only generated if @option{-funsafe-math-optimizations} is also specified.
18552 @end table
18554 Double-precision floating point:
18555 @table @asis
18557 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18558 Binary arithmetic operations.
18560 @item @samp{fnegd}
18561 Unary negation.
18563 @item @samp{fabsd}
18564 Unary absolute value.
18566 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18567 Comparison operations.
18569 @item @samp{fmind}, @samp{fmaxd}
18570 Double-precision minimum and maximum.  These instructions are only
18571 generated if @option{-ffinite-math-only} is specified.
18573 @item @samp{fsqrtd}
18574 Unary square root operation.
18576 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18577 Double-precision trigonometric and exponential functions.  These instructions
18578 are only generated if @option{-funsafe-math-optimizations} is also specified.
18580 @end table
18582 Conversions:
18583 @table @asis
18584 @item @samp{fextsd}
18585 Conversion from single precision to double precision.
18587 @item @samp{ftruncds}
18588 Conversion from double precision to single precision.
18590 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18591 Conversion from floating point to signed or unsigned integer types, with
18592 truncation towards zero.
18594 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18595 Conversion from signed or unsigned integer types to floating-point types.
18597 @end table
18599 In addition, all of the following transfer instructions for internal
18600 registers X and Y must be provided to use any of the double-precision
18601 floating-point instructions.  Custom instructions taking two
18602 double-precision source operands expect the first operand in the
18603 64-bit register X.  The other operand (or only operand of a unary
18604 operation) is given to the custom arithmetic instruction with the
18605 least significant half in source register @var{src1} and the most
18606 significant half in @var{src2}.  A custom instruction that returns a
18607 double-precision result returns the most significant 32 bits in the
18608 destination register and the other half in 32-bit register Y.  
18609 GCC automatically generates the necessary code sequences to write
18610 register X and/or read register Y when double-precision floating-point
18611 instructions are used.
18613 @table @asis
18615 @item @samp{fwrx}
18616 Write @var{src1} into the least significant half of X and @var{src2} into
18617 the most significant half of X.
18619 @item @samp{fwry}
18620 Write @var{src1} into Y.
18622 @item @samp{frdxhi}, @samp{frdxlo}
18623 Read the most or least (respectively) significant half of X and store it in
18624 @var{dest}.
18626 @item @samp{frdy}
18627 Read the value of Y and store it into @var{dest}.
18628 @end table
18630 Note that you can gain more local control over generation of Nios II custom
18631 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18632 and @code{target("no-custom-@var{insn}")} function attributes
18633 (@pxref{Function Attributes})
18634 or pragmas (@pxref{Function Specific Option Pragmas}).
18636 @item -mcustom-fpu-cfg=@var{name}
18637 @opindex mcustom-fpu-cfg
18639 This option enables a predefined, named set of custom instruction encodings
18640 (see @option{-mcustom-@var{insn}} above).  
18641 Currently, the following sets are defined:
18643 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18644 @gccoptlist{-mcustom-fmuls=252 @gol
18645 -mcustom-fadds=253 @gol
18646 -mcustom-fsubs=254 @gol
18647 -fsingle-precision-constant}
18649 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18650 @gccoptlist{-mcustom-fmuls=252 @gol
18651 -mcustom-fadds=253 @gol
18652 -mcustom-fsubs=254 @gol
18653 -mcustom-fdivs=255 @gol
18654 -fsingle-precision-constant}
18656 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18657 @gccoptlist{-mcustom-floatus=243 @gol
18658 -mcustom-fixsi=244 @gol
18659 -mcustom-floatis=245 @gol
18660 -mcustom-fcmpgts=246 @gol
18661 -mcustom-fcmples=249 @gol
18662 -mcustom-fcmpeqs=250 @gol
18663 -mcustom-fcmpnes=251 @gol
18664 -mcustom-fmuls=252 @gol
18665 -mcustom-fadds=253 @gol
18666 -mcustom-fsubs=254 @gol
18667 -mcustom-fdivs=255 @gol
18668 -fsingle-precision-constant}
18670 Custom instruction assignments given by individual
18671 @option{-mcustom-@var{insn}=} options override those given by
18672 @option{-mcustom-fpu-cfg=}, regardless of the
18673 order of the options on the command line.
18675 Note that you can gain more local control over selection of a FPU
18676 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18677 function attribute (@pxref{Function Attributes})
18678 or pragma (@pxref{Function Specific Option Pragmas}).
18680 @end table
18682 These additional @samp{-m} options are available for the Altera Nios II
18683 ELF (bare-metal) target:
18685 @table @gcctabopt
18687 @item -mhal
18688 @opindex mhal
18689 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18690 startup and termination code, and is typically used in conjunction with
18691 @option{-msys-crt0=} to specify the location of the alternate startup code
18692 provided by the HAL BSP.
18694 @item -msmallc
18695 @opindex msmallc
18696 Link with a limited version of the C library, @option{-lsmallc}, rather than
18697 Newlib.
18699 @item -msys-crt0=@var{startfile}
18700 @opindex msys-crt0
18701 @var{startfile} is the file name of the startfile (crt0) to use 
18702 when linking.  This option is only useful in conjunction with @option{-mhal}.
18704 @item -msys-lib=@var{systemlib}
18705 @opindex msys-lib
18706 @var{systemlib} is the library name of the library that provides
18707 low-level system calls required by the C library,
18708 e.g. @code{read} and @code{write}.
18709 This option is typically used to link with a library provided by a HAL BSP.
18711 @end table
18713 @node PDP-11 Options
18714 @subsection PDP-11 Options
18715 @cindex PDP-11 Options
18717 These options are defined for the PDP-11:
18719 @table @gcctabopt
18720 @item -mfpu
18721 @opindex mfpu
18722 Use hardware FPP floating point.  This is the default.  (FIS floating
18723 point on the PDP-11/40 is not supported.)
18725 @item -msoft-float
18726 @opindex msoft-float
18727 Do not use hardware floating point.
18729 @item -mac0
18730 @opindex mac0
18731 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18733 @item -mno-ac0
18734 @opindex mno-ac0
18735 Return floating-point results in memory.  This is the default.
18737 @item -m40
18738 @opindex m40
18739 Generate code for a PDP-11/40.
18741 @item -m45
18742 @opindex m45
18743 Generate code for a PDP-11/45.  This is the default.
18745 @item -m10
18746 @opindex m10
18747 Generate code for a PDP-11/10.
18749 @item -mbcopy-builtin
18750 @opindex mbcopy-builtin
18751 Use inline @code{movmemhi} patterns for copying memory.  This is the
18752 default.
18754 @item -mbcopy
18755 @opindex mbcopy
18756 Do not use inline @code{movmemhi} patterns for copying memory.
18758 @item -mint16
18759 @itemx -mno-int32
18760 @opindex mint16
18761 @opindex mno-int32
18762 Use 16-bit @code{int}.  This is the default.
18764 @item -mint32
18765 @itemx -mno-int16
18766 @opindex mint32
18767 @opindex mno-int16
18768 Use 32-bit @code{int}.
18770 @item -mfloat64
18771 @itemx -mno-float32
18772 @opindex mfloat64
18773 @opindex mno-float32
18774 Use 64-bit @code{float}.  This is the default.
18776 @item -mfloat32
18777 @itemx -mno-float64
18778 @opindex mfloat32
18779 @opindex mno-float64
18780 Use 32-bit @code{float}.
18782 @item -mabshi
18783 @opindex mabshi
18784 Use @code{abshi2} pattern.  This is the default.
18786 @item -mno-abshi
18787 @opindex mno-abshi
18788 Do not use @code{abshi2} pattern.
18790 @item -mbranch-expensive
18791 @opindex mbranch-expensive
18792 Pretend that branches are expensive.  This is for experimenting with
18793 code generation only.
18795 @item -mbranch-cheap
18796 @opindex mbranch-cheap
18797 Do not pretend that branches are expensive.  This is the default.
18799 @item -munix-asm
18800 @opindex munix-asm
18801 Use Unix assembler syntax.  This is the default when configured for
18802 @samp{pdp11-*-bsd}.
18804 @item -mdec-asm
18805 @opindex mdec-asm
18806 Use DEC assembler syntax.  This is the default when configured for any
18807 PDP-11 target other than @samp{pdp11-*-bsd}.
18808 @end table
18810 @node picoChip Options
18811 @subsection picoChip Options
18812 @cindex picoChip options
18814 These @samp{-m} options are defined for picoChip implementations:
18816 @table @gcctabopt
18818 @item -mae=@var{ae_type}
18819 @opindex mcpu
18820 Set the instruction set, register set, and instruction scheduling
18821 parameters for array element type @var{ae_type}.  Supported values
18822 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18824 @option{-mae=ANY} selects a completely generic AE type.  Code
18825 generated with this option runs on any of the other AE types.  The
18826 code is not as efficient as it would be if compiled for a specific
18827 AE type, and some types of operation (e.g., multiplication) do not
18828 work properly on all types of AE.
18830 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18831 for compiled code, and is the default.
18833 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18834 option may suffer from poor performance of byte (char) manipulation,
18835 since the DSP AE does not provide hardware support for byte load/stores.
18837 @item -msymbol-as-address
18838 Enable the compiler to directly use a symbol name as an address in a
18839 load/store instruction, without first loading it into a
18840 register.  Typically, the use of this option generates larger
18841 programs, which run faster than when the option isn't used.  However, the
18842 results vary from program to program, so it is left as a user option,
18843 rather than being permanently enabled.
18845 @item -mno-inefficient-warnings
18846 Disables warnings about the generation of inefficient code.  These
18847 warnings can be generated, for example, when compiling code that
18848 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18849 no hardware support for byte-level memory operations, so all byte
18850 load/stores must be synthesized from word load/store operations.  This is
18851 inefficient and a warning is generated to indicate
18852 that you should rewrite the code to avoid byte operations, or to target
18853 an AE type that has the necessary hardware support.  This option disables
18854 these warnings.
18856 @end table
18858 @node PowerPC Options
18859 @subsection PowerPC Options
18860 @cindex PowerPC options
18862 These are listed under @xref{RS/6000 and PowerPC Options}.
18864 @node RL78 Options
18865 @subsection RL78 Options
18866 @cindex RL78 Options
18868 @table @gcctabopt
18870 @item -msim
18871 @opindex msim
18872 Links in additional target libraries to support operation within a
18873 simulator.
18875 @item -mmul=none
18876 @itemx -mmul=g13
18877 @itemx -mmul=rl78
18878 @opindex mmul
18879 Specifies the type of hardware multiplication support to be used.  The
18880 default is @code{none}, which uses software multiplication functions.
18881 The @code{g13} option is for the hardware multiply/divide peripheral
18882 only on the RL78/G13 targets.  The @code{rl78} option is for the
18883 standard hardware multiplication defined in the RL78 software manual.
18885 @end table
18887 @node RS/6000 and PowerPC Options
18888 @subsection IBM RS/6000 and PowerPC Options
18889 @cindex RS/6000 and PowerPC Options
18890 @cindex IBM RS/6000 and PowerPC Options
18892 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18893 @table @gcctabopt
18894 @item -mpowerpc-gpopt
18895 @itemx -mno-powerpc-gpopt
18896 @itemx -mpowerpc-gfxopt
18897 @itemx -mno-powerpc-gfxopt
18898 @need 800
18899 @itemx -mpowerpc64
18900 @itemx -mno-powerpc64
18901 @itemx -mmfcrf
18902 @itemx -mno-mfcrf
18903 @itemx -mpopcntb
18904 @itemx -mno-popcntb
18905 @itemx -mpopcntd
18906 @itemx -mno-popcntd
18907 @itemx -mfprnd
18908 @itemx -mno-fprnd
18909 @need 800
18910 @itemx -mcmpb
18911 @itemx -mno-cmpb
18912 @itemx -mmfpgpr
18913 @itemx -mno-mfpgpr
18914 @itemx -mhard-dfp
18915 @itemx -mno-hard-dfp
18916 @opindex mpowerpc-gpopt
18917 @opindex mno-powerpc-gpopt
18918 @opindex mpowerpc-gfxopt
18919 @opindex mno-powerpc-gfxopt
18920 @opindex mpowerpc64
18921 @opindex mno-powerpc64
18922 @opindex mmfcrf
18923 @opindex mno-mfcrf
18924 @opindex mpopcntb
18925 @opindex mno-popcntb
18926 @opindex mpopcntd
18927 @opindex mno-popcntd
18928 @opindex mfprnd
18929 @opindex mno-fprnd
18930 @opindex mcmpb
18931 @opindex mno-cmpb
18932 @opindex mmfpgpr
18933 @opindex mno-mfpgpr
18934 @opindex mhard-dfp
18935 @opindex mno-hard-dfp
18936 You use these options to specify which instructions are available on the
18937 processor you are using.  The default value of these options is
18938 determined when configuring GCC@.  Specifying the
18939 @option{-mcpu=@var{cpu_type}} overrides the specification of these
18940 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
18941 rather than the options listed above.
18943 Specifying @option{-mpowerpc-gpopt} allows
18944 GCC to use the optional PowerPC architecture instructions in the
18945 General Purpose group, including floating-point square root.  Specifying
18946 @option{-mpowerpc-gfxopt} allows GCC to
18947 use the optional PowerPC architecture instructions in the Graphics
18948 group, including floating-point select.
18950 The @option{-mmfcrf} option allows GCC to generate the move from
18951 condition register field instruction implemented on the POWER4
18952 processor and other processors that support the PowerPC V2.01
18953 architecture.
18954 The @option{-mpopcntb} option allows GCC to generate the popcount and
18955 double-precision FP reciprocal estimate instruction implemented on the
18956 POWER5 processor and other processors that support the PowerPC V2.02
18957 architecture.
18958 The @option{-mpopcntd} option allows GCC to generate the popcount
18959 instruction implemented on the POWER7 processor and other processors
18960 that support the PowerPC V2.06 architecture.
18961 The @option{-mfprnd} option allows GCC to generate the FP round to
18962 integer instructions implemented on the POWER5+ processor and other
18963 processors that support the PowerPC V2.03 architecture.
18964 The @option{-mcmpb} option allows GCC to generate the compare bytes
18965 instruction implemented on the POWER6 processor and other processors
18966 that support the PowerPC V2.05 architecture.
18967 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
18968 general-purpose register instructions implemented on the POWER6X
18969 processor and other processors that support the extended PowerPC V2.05
18970 architecture.
18971 The @option{-mhard-dfp} option allows GCC to generate the decimal
18972 floating-point instructions implemented on some POWER processors.
18974 The @option{-mpowerpc64} option allows GCC to generate the additional
18975 64-bit instructions that are found in the full PowerPC64 architecture
18976 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
18977 @option{-mno-powerpc64}.
18979 @item -mcpu=@var{cpu_type}
18980 @opindex mcpu
18981 Set architecture type, register usage, and
18982 instruction scheduling parameters for machine type @var{cpu_type}.
18983 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
18984 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
18985 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
18986 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
18987 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
18988 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
18989 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
18990 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
18991 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
18992 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
18993 @samp{powerpc64}, @samp{powerpc64le}, and @samp{rs64}.
18995 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
18996 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
18997 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
18998 architecture machine types, with an appropriate, generic processor
18999 model assumed for scheduling purposes.
19001 The other options specify a specific processor.  Code generated under
19002 those options runs best on that processor, and may not run at all on
19003 others.
19005 The @option{-mcpu} options automatically enable or disable the
19006 following options:
19008 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19009 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19010 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19011 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19012 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19013 -mquad-memory -mquad-memory-atomic}
19015 The particular options set for any particular CPU varies between
19016 compiler versions, depending on what setting seems to produce optimal
19017 code for that CPU; it doesn't necessarily reflect the actual hardware's
19018 capabilities.  If you wish to set an individual option to a particular
19019 value, you may specify it after the @option{-mcpu} option, like
19020 @option{-mcpu=970 -mno-altivec}.
19022 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19023 not enabled or disabled by the @option{-mcpu} option at present because
19024 AIX does not have full support for these options.  You may still
19025 enable or disable them individually if you're sure it'll work in your
19026 environment.
19028 @item -mtune=@var{cpu_type}
19029 @opindex mtune
19030 Set the instruction scheduling parameters for machine type
19031 @var{cpu_type}, but do not set the architecture type or register usage,
19032 as @option{-mcpu=@var{cpu_type}} does.  The same
19033 values for @var{cpu_type} are used for @option{-mtune} as for
19034 @option{-mcpu}.  If both are specified, the code generated uses the
19035 architecture and registers set by @option{-mcpu}, but the
19036 scheduling parameters set by @option{-mtune}.
19038 @item -mcmodel=small
19039 @opindex mcmodel=small
19040 Generate PowerPC64 code for the small model: The TOC is limited to
19041 64k.
19043 @item -mcmodel=medium
19044 @opindex mcmodel=medium
19045 Generate PowerPC64 code for the medium model: The TOC and other static
19046 data may be up to a total of 4G in size.
19048 @item -mcmodel=large
19049 @opindex mcmodel=large
19050 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19051 in size.  Other data and code is only limited by the 64-bit address
19052 space.
19054 @item -maltivec
19055 @itemx -mno-altivec
19056 @opindex maltivec
19057 @opindex mno-altivec
19058 Generate code that uses (does not use) AltiVec instructions, and also
19059 enable the use of built-in functions that allow more direct access to
19060 the AltiVec instruction set.  You may also need to set
19061 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19062 enhancements.
19064 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19065 @option{-maltivec=be}, the element order for Altivec intrinsics such
19066 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19067 match array element order corresponding to the endianness of the
19068 target.  That is, element zero identifies the leftmost element in a
19069 vector register when targeting a big-endian platform, and identifies
19070 the rightmost element in a vector register when targeting a
19071 little-endian platform.
19073 @item -maltivec=be
19074 @opindex maltivec=be
19075 Generate Altivec instructions using big-endian element order,
19076 regardless of whether the target is big- or little-endian.  This is
19077 the default when targeting a big-endian platform.
19079 The element order is used to interpret element numbers in Altivec
19080 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19081 @code{vec_insert}.  By default, these will match array element order
19082 corresponding to the endianness for the target.
19084 @item -maltivec=le
19085 @opindex maltivec=le
19086 Generate Altivec instructions using little-endian element order,
19087 regardless of whether the target is big- or little-endian.  This is
19088 the default when targeting a little-endian platform.  This option is
19089 currently ignored when targeting a big-endian platform.
19091 The element order is used to interpret element numbers in Altivec
19092 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19093 @code{vec_insert}.  By default, these will match array element order
19094 corresponding to the endianness for the target.
19096 @item -mvrsave
19097 @itemx -mno-vrsave
19098 @opindex mvrsave
19099 @opindex mno-vrsave
19100 Generate VRSAVE instructions when generating AltiVec code.
19102 @item -mgen-cell-microcode
19103 @opindex mgen-cell-microcode
19104 Generate Cell microcode instructions.
19106 @item -mwarn-cell-microcode
19107 @opindex mwarn-cell-microcode
19108 Warn when a Cell microcode instruction is emitted.  An example
19109 of a Cell microcode instruction is a variable shift.
19111 @item -msecure-plt
19112 @opindex msecure-plt
19113 Generate code that allows @command{ld} and @command{ld.so}
19114 to build executables and shared
19115 libraries with non-executable @code{.plt} and @code{.got} sections.
19116 This is a PowerPC
19117 32-bit SYSV ABI option.
19119 @item -mbss-plt
19120 @opindex mbss-plt
19121 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19122 fills in, and
19123 requires @code{.plt} and @code{.got}
19124 sections that are both writable and executable.
19125 This is a PowerPC 32-bit SYSV ABI option.
19127 @item -misel
19128 @itemx -mno-isel
19129 @opindex misel
19130 @opindex mno-isel
19131 This switch enables or disables the generation of ISEL instructions.
19133 @item -misel=@var{yes/no}
19134 This switch has been deprecated.  Use @option{-misel} and
19135 @option{-mno-isel} instead.
19137 @item -mspe
19138 @itemx -mno-spe
19139 @opindex mspe
19140 @opindex mno-spe
19141 This switch enables or disables the generation of SPE simd
19142 instructions.
19144 @item -mpaired
19145 @itemx -mno-paired
19146 @opindex mpaired
19147 @opindex mno-paired
19148 This switch enables or disables the generation of PAIRED simd
19149 instructions.
19151 @item -mspe=@var{yes/no}
19152 This option has been deprecated.  Use @option{-mspe} and
19153 @option{-mno-spe} instead.
19155 @item -mvsx
19156 @itemx -mno-vsx
19157 @opindex mvsx
19158 @opindex mno-vsx
19159 Generate code that uses (does not use) vector/scalar (VSX)
19160 instructions, and also enable the use of built-in functions that allow
19161 more direct access to the VSX instruction set.
19163 @item -mcrypto
19164 @itemx -mno-crypto
19165 @opindex mcrypto
19166 @opindex mno-crypto
19167 Enable the use (disable) of the built-in functions that allow direct
19168 access to the cryptographic instructions that were added in version
19169 2.07 of the PowerPC ISA.
19171 @item -mdirect-move
19172 @itemx -mno-direct-move
19173 @opindex mdirect-move
19174 @opindex mno-direct-move
19175 Generate code that uses (does not use) the instructions to move data
19176 between the general purpose registers and the vector/scalar (VSX)
19177 registers that were added in version 2.07 of the PowerPC ISA.
19179 @item -mpower8-fusion
19180 @itemx -mno-power8-fusion
19181 @opindex mpower8-fusion
19182 @opindex mno-power8-fusion
19183 Generate code that keeps (does not keeps) some integer operations
19184 adjacent so that the instructions can be fused together on power8 and
19185 later processors.
19187 @item -mpower8-vector
19188 @itemx -mno-power8-vector
19189 @opindex mpower8-vector
19190 @opindex mno-power8-vector
19191 Generate code that uses (does not use) the vector and scalar
19192 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19193 enable the use of built-in functions that allow more direct access to
19194 the vector instructions.
19196 @item -mquad-memory
19197 @itemx -mno-quad-memory
19198 @opindex mquad-memory
19199 @opindex mno-quad-memory
19200 Generate code that uses (does not use) the non-atomic quad word memory
19201 instructions.  The @option{-mquad-memory} option requires use of
19202 64-bit mode.
19204 @item -mquad-memory-atomic
19205 @itemx -mno-quad-memory-atomic
19206 @opindex mquad-memory-atomic
19207 @opindex mno-quad-memory-atomic
19208 Generate code that uses (does not use) the atomic quad word memory
19209 instructions.  The @option{-mquad-memory-atomic} option requires use of
19210 64-bit mode.
19212 @item -mfloat-gprs=@var{yes/single/double/no}
19213 @itemx -mfloat-gprs
19214 @opindex mfloat-gprs
19215 This switch enables or disables the generation of floating-point
19216 operations on the general-purpose registers for architectures that
19217 support it.
19219 The argument @var{yes} or @var{single} enables the use of
19220 single-precision floating-point operations.
19222 The argument @var{double} enables the use of single and
19223 double-precision floating-point operations.
19225 The argument @var{no} disables floating-point operations on the
19226 general-purpose registers.
19228 This option is currently only available on the MPC854x.
19230 @item -m32
19231 @itemx -m64
19232 @opindex m32
19233 @opindex m64
19234 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19235 targets (including GNU/Linux).  The 32-bit environment sets int, long
19236 and pointer to 32 bits and generates code that runs on any PowerPC
19237 variant.  The 64-bit environment sets int to 32 bits and long and
19238 pointer to 64 bits, and generates code for PowerPC64, as for
19239 @option{-mpowerpc64}.
19241 @item -mfull-toc
19242 @itemx -mno-fp-in-toc
19243 @itemx -mno-sum-in-toc
19244 @itemx -mminimal-toc
19245 @opindex mfull-toc
19246 @opindex mno-fp-in-toc
19247 @opindex mno-sum-in-toc
19248 @opindex mminimal-toc
19249 Modify generation of the TOC (Table Of Contents), which is created for
19250 every executable file.  The @option{-mfull-toc} option is selected by
19251 default.  In that case, GCC allocates at least one TOC entry for
19252 each unique non-automatic variable reference in your program.  GCC
19253 also places floating-point constants in the TOC@.  However, only
19254 16,384 entries are available in the TOC@.
19256 If you receive a linker error message that saying you have overflowed
19257 the available TOC space, you can reduce the amount of TOC space used
19258 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19259 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19260 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19261 generate code to calculate the sum of an address and a constant at
19262 run time instead of putting that sum into the TOC@.  You may specify one
19263 or both of these options.  Each causes GCC to produce very slightly
19264 slower and larger code at the expense of conserving TOC space.
19266 If you still run out of space in the TOC even when you specify both of
19267 these options, specify @option{-mminimal-toc} instead.  This option causes
19268 GCC to make only one TOC entry for every file.  When you specify this
19269 option, GCC produces code that is slower and larger but which
19270 uses extremely little TOC space.  You may wish to use this option
19271 only on files that contain less frequently-executed code.
19273 @item -maix64
19274 @itemx -maix32
19275 @opindex maix64
19276 @opindex maix32
19277 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19278 @code{long} type, and the infrastructure needed to support them.
19279 Specifying @option{-maix64} implies @option{-mpowerpc64},
19280 while @option{-maix32} disables the 64-bit ABI and
19281 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19283 @item -mxl-compat
19284 @itemx -mno-xl-compat
19285 @opindex mxl-compat
19286 @opindex mno-xl-compat
19287 Produce code that conforms more closely to IBM XL compiler semantics
19288 when using AIX-compatible ABI@.  Pass floating-point arguments to
19289 prototyped functions beyond the register save area (RSA) on the stack
19290 in addition to argument FPRs.  Do not assume that most significant
19291 double in 128-bit long double value is properly rounded when comparing
19292 values and converting to double.  Use XL symbol names for long double
19293 support routines.
19295 The AIX calling convention was extended but not initially documented to
19296 handle an obscure K&R C case of calling a function that takes the
19297 address of its arguments with fewer arguments than declared.  IBM XL
19298 compilers access floating-point arguments that do not fit in the
19299 RSA from the stack when a subroutine is compiled without
19300 optimization.  Because always storing floating-point arguments on the
19301 stack is inefficient and rarely needed, this option is not enabled by
19302 default and only is necessary when calling subroutines compiled by IBM
19303 XL compilers without optimization.
19305 @item -mpe
19306 @opindex mpe
19307 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19308 application written to use message passing with special startup code to
19309 enable the application to run.  The system must have PE installed in the
19310 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19311 must be overridden with the @option{-specs=} option to specify the
19312 appropriate directory location.  The Parallel Environment does not
19313 support threads, so the @option{-mpe} option and the @option{-pthread}
19314 option are incompatible.
19316 @item -malign-natural
19317 @itemx -malign-power
19318 @opindex malign-natural
19319 @opindex malign-power
19320 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19321 @option{-malign-natural} overrides the ABI-defined alignment of larger
19322 types, such as floating-point doubles, on their natural size-based boundary.
19323 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19324 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19326 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19327 is not supported.
19329 @item -msoft-float
19330 @itemx -mhard-float
19331 @opindex msoft-float
19332 @opindex mhard-float
19333 Generate code that does not use (uses) the floating-point register set.
19334 Software floating-point emulation is provided if you use the
19335 @option{-msoft-float} option, and pass the option to GCC when linking.
19337 @item -msingle-float
19338 @itemx -mdouble-float
19339 @opindex msingle-float
19340 @opindex mdouble-float
19341 Generate code for single- or double-precision floating-point operations.
19342 @option{-mdouble-float} implies @option{-msingle-float}.
19344 @item -msimple-fpu
19345 @opindex msimple-fpu
19346 Do not generate @code{sqrt} and @code{div} instructions for hardware
19347 floating-point unit.
19349 @item -mfpu=@var{name}
19350 @opindex mfpu
19351 Specify type of floating-point unit.  Valid values for @var{name} are
19352 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19353 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19354 @samp{sp_full} (equivalent to @option{-msingle-float}),
19355 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19357 @item -mxilinx-fpu
19358 @opindex mxilinx-fpu
19359 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19361 @item -mmultiple
19362 @itemx -mno-multiple
19363 @opindex mmultiple
19364 @opindex mno-multiple
19365 Generate code that uses (does not use) the load multiple word
19366 instructions and the store multiple word instructions.  These
19367 instructions are generated by default on POWER systems, and not
19368 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19369 PowerPC systems, since those instructions do not work when the
19370 processor is in little-endian mode.  The exceptions are PPC740 and
19371 PPC750 which permit these instructions in little-endian mode.
19373 @item -mstring
19374 @itemx -mno-string
19375 @opindex mstring
19376 @opindex mno-string
19377 Generate code that uses (does not use) the load string instructions
19378 and the store string word instructions to save multiple registers and
19379 do small block moves.  These instructions are generated by default on
19380 POWER systems, and not generated on PowerPC systems.  Do not use
19381 @option{-mstring} on little-endian PowerPC systems, since those
19382 instructions do not work when the processor is in little-endian mode.
19383 The exceptions are PPC740 and PPC750 which permit these instructions
19384 in little-endian mode.
19386 @item -mupdate
19387 @itemx -mno-update
19388 @opindex mupdate
19389 @opindex mno-update
19390 Generate code that uses (does not use) the load or store instructions
19391 that update the base register to the address of the calculated memory
19392 location.  These instructions are generated by default.  If you use
19393 @option{-mno-update}, there is a small window between the time that the
19394 stack pointer is updated and the address of the previous frame is
19395 stored, which means code that walks the stack frame across interrupts or
19396 signals may get corrupted data.
19398 @item -mavoid-indexed-addresses
19399 @itemx -mno-avoid-indexed-addresses
19400 @opindex mavoid-indexed-addresses
19401 @opindex mno-avoid-indexed-addresses
19402 Generate code that tries to avoid (not avoid) the use of indexed load
19403 or store instructions. These instructions can incur a performance
19404 penalty on Power6 processors in certain situations, such as when
19405 stepping through large arrays that cross a 16M boundary.  This option
19406 is enabled by default when targeting Power6 and disabled otherwise.
19408 @item -mfused-madd
19409 @itemx -mno-fused-madd
19410 @opindex mfused-madd
19411 @opindex mno-fused-madd
19412 Generate code that uses (does not use) the floating-point multiply and
19413 accumulate instructions.  These instructions are generated by default
19414 if hardware floating point is used.  The machine-dependent
19415 @option{-mfused-madd} option is now mapped to the machine-independent
19416 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19417 mapped to @option{-ffp-contract=off}.
19419 @item -mmulhw
19420 @itemx -mno-mulhw
19421 @opindex mmulhw
19422 @opindex mno-mulhw
19423 Generate code that uses (does not use) the half-word multiply and
19424 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19425 These instructions are generated by default when targeting those
19426 processors.
19428 @item -mdlmzb
19429 @itemx -mno-dlmzb
19430 @opindex mdlmzb
19431 @opindex mno-dlmzb
19432 Generate code that uses (does not use) the string-search @samp{dlmzb}
19433 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19434 generated by default when targeting those processors.
19436 @item -mno-bit-align
19437 @itemx -mbit-align
19438 @opindex mno-bit-align
19439 @opindex mbit-align
19440 On System V.4 and embedded PowerPC systems do not (do) force structures
19441 and unions that contain bit-fields to be aligned to the base type of the
19442 bit-field.
19444 For example, by default a structure containing nothing but 8
19445 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19446 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19447 the structure is aligned to a 1-byte boundary and is 1 byte in
19448 size.
19450 @item -mno-strict-align
19451 @itemx -mstrict-align
19452 @opindex mno-strict-align
19453 @opindex mstrict-align
19454 On System V.4 and embedded PowerPC systems do not (do) assume that
19455 unaligned memory references are handled by the system.
19457 @item -mrelocatable
19458 @itemx -mno-relocatable
19459 @opindex mrelocatable
19460 @opindex mno-relocatable
19461 Generate code that allows (does not allow) a static executable to be
19462 relocated to a different address at run time.  A simple embedded
19463 PowerPC system loader should relocate the entire contents of
19464 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19465 a table of 32-bit addresses generated by this option.  For this to
19466 work, all objects linked together must be compiled with
19467 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19468 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19470 @item -mrelocatable-lib
19471 @itemx -mno-relocatable-lib
19472 @opindex mrelocatable-lib
19473 @opindex mno-relocatable-lib
19474 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19475 @code{.fixup} section to allow static executables to be relocated at
19476 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19477 alignment of @option{-mrelocatable}.  Objects compiled with
19478 @option{-mrelocatable-lib} may be linked with objects compiled with
19479 any combination of the @option{-mrelocatable} options.
19481 @item -mno-toc
19482 @itemx -mtoc
19483 @opindex mno-toc
19484 @opindex mtoc
19485 On System V.4 and embedded PowerPC systems do not (do) assume that
19486 register 2 contains a pointer to a global area pointing to the addresses
19487 used in the program.
19489 @item -mlittle
19490 @itemx -mlittle-endian
19491 @opindex mlittle
19492 @opindex mlittle-endian
19493 On System V.4 and embedded PowerPC systems compile code for the
19494 processor in little-endian mode.  The @option{-mlittle-endian} option is
19495 the same as @option{-mlittle}.
19497 @item -mbig
19498 @itemx -mbig-endian
19499 @opindex mbig
19500 @opindex mbig-endian
19501 On System V.4 and embedded PowerPC systems compile code for the
19502 processor in big-endian mode.  The @option{-mbig-endian} option is
19503 the same as @option{-mbig}.
19505 @item -mdynamic-no-pic
19506 @opindex mdynamic-no-pic
19507 On Darwin and Mac OS X systems, compile code so that it is not
19508 relocatable, but that its external references are relocatable.  The
19509 resulting code is suitable for applications, but not shared
19510 libraries.
19512 @item -msingle-pic-base
19513 @opindex msingle-pic-base
19514 Treat the register used for PIC addressing as read-only, rather than
19515 loading it in the prologue for each function.  The runtime system is
19516 responsible for initializing this register with an appropriate value
19517 before execution begins.
19519 @item -mprioritize-restricted-insns=@var{priority}
19520 @opindex mprioritize-restricted-insns
19521 This option controls the priority that is assigned to
19522 dispatch-slot restricted instructions during the second scheduling
19523 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19524 or @samp{2} to assign no, highest, or second-highest (respectively) 
19525 priority to dispatch-slot restricted
19526 instructions.
19528 @item -msched-costly-dep=@var{dependence_type}
19529 @opindex msched-costly-dep
19530 This option controls which dependences are considered costly
19531 by the target during instruction scheduling.  The argument
19532 @var{dependence_type} takes one of the following values:
19534 @table @asis
19535 @item @samp{no}
19536 No dependence is costly.
19538 @item @samp{all}
19539 All dependences are costly.
19541 @item @samp{true_store_to_load}
19542 A true dependence from store to load is costly.
19544 @item @samp{store_to_load}
19545 Any dependence from store to load is costly.
19547 @item @var{number}
19548 Any dependence for which the latency is greater than or equal to 
19549 @var{number} is costly.
19550 @end table
19552 @item -minsert-sched-nops=@var{scheme}
19553 @opindex minsert-sched-nops
19554 This option controls which NOP insertion scheme is used during
19555 the second scheduling pass.  The argument @var{scheme} takes one of the
19556 following values:
19558 @table @asis
19559 @item @samp{no}
19560 Don't insert NOPs.
19562 @item @samp{pad}
19563 Pad with NOPs any dispatch group that has vacant issue slots,
19564 according to the scheduler's grouping.
19566 @item @samp{regroup_exact}
19567 Insert NOPs to force costly dependent insns into
19568 separate groups.  Insert exactly as many NOPs as needed to force an insn
19569 to a new group, according to the estimated processor grouping.
19571 @item @var{number}
19572 Insert NOPs to force costly dependent insns into
19573 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19574 @end table
19576 @item -mcall-sysv
19577 @opindex mcall-sysv
19578 On System V.4 and embedded PowerPC systems compile code using calling
19579 conventions that adhere to the March 1995 draft of the System V
19580 Application Binary Interface, PowerPC processor supplement.  This is the
19581 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19583 @item -mcall-sysv-eabi
19584 @itemx -mcall-eabi
19585 @opindex mcall-sysv-eabi
19586 @opindex mcall-eabi
19587 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19589 @item -mcall-sysv-noeabi
19590 @opindex mcall-sysv-noeabi
19591 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19593 @item -mcall-aixdesc
19594 @opindex m
19595 On System V.4 and embedded PowerPC systems compile code for the AIX
19596 operating system.
19598 @item -mcall-linux
19599 @opindex mcall-linux
19600 On System V.4 and embedded PowerPC systems compile code for the
19601 Linux-based GNU system.
19603 @item -mcall-freebsd
19604 @opindex mcall-freebsd
19605 On System V.4 and embedded PowerPC systems compile code for the
19606 FreeBSD operating system.
19608 @item -mcall-netbsd
19609 @opindex mcall-netbsd
19610 On System V.4 and embedded PowerPC systems compile code for the
19611 NetBSD operating system.
19613 @item -mcall-openbsd
19614 @opindex mcall-netbsd
19615 On System V.4 and embedded PowerPC systems compile code for the
19616 OpenBSD operating system.
19618 @item -maix-struct-return
19619 @opindex maix-struct-return
19620 Return all structures in memory (as specified by the AIX ABI)@.
19622 @item -msvr4-struct-return
19623 @opindex msvr4-struct-return
19624 Return structures smaller than 8 bytes in registers (as specified by the
19625 SVR4 ABI)@.
19627 @item -mabi=@var{abi-type}
19628 @opindex mabi
19629 Extend the current ABI with a particular extension, or remove such extension.
19630 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
19631 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
19632 @var{elfv1}, @var{elfv2}@.
19634 @item -mabi=spe
19635 @opindex mabi=spe
19636 Extend the current ABI with SPE ABI extensions.  This does not change
19637 the default ABI, instead it adds the SPE ABI extensions to the current
19638 ABI@.
19640 @item -mabi=no-spe
19641 @opindex mabi=no-spe
19642 Disable Book-E SPE ABI extensions for the current ABI@.
19644 @item -mabi=ibmlongdouble
19645 @opindex mabi=ibmlongdouble
19646 Change the current ABI to use IBM extended-precision long double.
19647 This is a PowerPC 32-bit SYSV ABI option.
19649 @item -mabi=ieeelongdouble
19650 @opindex mabi=ieeelongdouble
19651 Change the current ABI to use IEEE extended-precision long double.
19652 This is a PowerPC 32-bit Linux ABI option.
19654 @item -mabi=elfv1
19655 @opindex mabi=elfv1
19656 Change the current ABI to use the ELFv1 ABI.
19657 This is the default ABI for big-endian PowerPC 64-bit Linux.
19658 Overriding the default ABI requires special system support and is
19659 likely to fail in spectacular ways.
19661 @item -mabi=elfv2
19662 @opindex mabi=elfv2
19663 Change the current ABI to use the ELFv2 ABI.
19664 This is the default ABI for little-endian PowerPC 64-bit Linux.
19665 Overriding the default ABI requires special system support and is
19666 likely to fail in spectacular ways.
19668 @item -mprototype
19669 @itemx -mno-prototype
19670 @opindex mprototype
19671 @opindex mno-prototype
19672 On System V.4 and embedded PowerPC systems assume that all calls to
19673 variable argument functions are properly prototyped.  Otherwise, the
19674 compiler must insert an instruction before every non-prototyped call to
19675 set or clear bit 6 of the condition code register (@var{CR}) to
19676 indicate whether floating-point values are passed in the floating-point
19677 registers in case the function takes variable arguments.  With
19678 @option{-mprototype}, only calls to prototyped variable argument functions
19679 set or clear the bit.
19681 @item -msim
19682 @opindex msim
19683 On embedded PowerPC systems, assume that the startup module is called
19684 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19685 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19686 configurations.
19688 @item -mmvme
19689 @opindex mmvme
19690 On embedded PowerPC systems, assume that the startup module is called
19691 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19692 @file{libc.a}.
19694 @item -mads
19695 @opindex mads
19696 On embedded PowerPC systems, assume that the startup module is called
19697 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19698 @file{libc.a}.
19700 @item -myellowknife
19701 @opindex myellowknife
19702 On embedded PowerPC systems, assume that the startup module is called
19703 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19704 @file{libc.a}.
19706 @item -mvxworks
19707 @opindex mvxworks
19708 On System V.4 and embedded PowerPC systems, specify that you are
19709 compiling for a VxWorks system.
19711 @item -memb
19712 @opindex memb
19713 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
19714 header to indicate that @samp{eabi} extended relocations are used.
19716 @item -meabi
19717 @itemx -mno-eabi
19718 @opindex meabi
19719 @opindex mno-eabi
19720 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19721 Embedded Applications Binary Interface (EABI), which is a set of
19722 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19723 means that the stack is aligned to an 8-byte boundary, a function
19724 @code{__eabi} is called from @code{main} to set up the EABI
19725 environment, and the @option{-msdata} option can use both @code{r2} and
19726 @code{r13} to point to two separate small data areas.  Selecting
19727 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19728 no EABI initialization function is called from @code{main}, and the
19729 @option{-msdata} option only uses @code{r13} to point to a single
19730 small data area.  The @option{-meabi} option is on by default if you
19731 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19733 @item -msdata=eabi
19734 @opindex msdata=eabi
19735 On System V.4 and embedded PowerPC systems, put small initialized
19736 @code{const} global and static data in the @samp{.sdata2} section, which
19737 is pointed to by register @code{r2}.  Put small initialized
19738 non-@code{const} global and static data in the @samp{.sdata} section,
19739 which is pointed to by register @code{r13}.  Put small uninitialized
19740 global and static data in the @samp{.sbss} section, which is adjacent to
19741 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
19742 incompatible with the @option{-mrelocatable} option.  The
19743 @option{-msdata=eabi} option also sets the @option{-memb} option.
19745 @item -msdata=sysv
19746 @opindex msdata=sysv
19747 On System V.4 and embedded PowerPC systems, put small global and static
19748 data in the @samp{.sdata} section, which is pointed to by register
19749 @code{r13}.  Put small uninitialized global and static data in the
19750 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
19751 The @option{-msdata=sysv} option is incompatible with the
19752 @option{-mrelocatable} option.
19754 @item -msdata=default
19755 @itemx -msdata
19756 @opindex msdata=default
19757 @opindex msdata
19758 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19759 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19760 same as @option{-msdata=sysv}.
19762 @item -msdata=data
19763 @opindex msdata=data
19764 On System V.4 and embedded PowerPC systems, put small global
19765 data in the @samp{.sdata} section.  Put small uninitialized global
19766 data in the @samp{.sbss} section.  Do not use register @code{r13}
19767 to address small data however.  This is the default behavior unless
19768 other @option{-msdata} options are used.
19770 @item -msdata=none
19771 @itemx -mno-sdata
19772 @opindex msdata=none
19773 @opindex mno-sdata
19774 On embedded PowerPC systems, put all initialized global and static data
19775 in the @samp{.data} section, and all uninitialized data in the
19776 @samp{.bss} section.
19778 @item -mblock-move-inline-limit=@var{num}
19779 @opindex mblock-move-inline-limit
19780 Inline all block moves (such as calls to @code{memcpy} or structure
19781 copies) less than or equal to @var{num} bytes.  The minimum value for
19782 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19783 targets.  The default value is target-specific.
19785 @item -G @var{num}
19786 @opindex G
19787 @cindex smaller data references (PowerPC)
19788 @cindex .sdata/.sdata2 references (PowerPC)
19789 On embedded PowerPC systems, put global and static items less than or
19790 equal to @var{num} bytes into the small data or BSS sections instead of
19791 the normal data or BSS section.  By default, @var{num} is 8.  The
19792 @option{-G @var{num}} switch is also passed to the linker.
19793 All modules should be compiled with the same @option{-G @var{num}} value.
19795 @item -mregnames
19796 @itemx -mno-regnames
19797 @opindex mregnames
19798 @opindex mno-regnames
19799 On System V.4 and embedded PowerPC systems do (do not) emit register
19800 names in the assembly language output using symbolic forms.
19802 @item -mlongcall
19803 @itemx -mno-longcall
19804 @opindex mlongcall
19805 @opindex mno-longcall
19806 By default assume that all calls are far away so that a longer and more
19807 expensive calling sequence is required.  This is required for calls
19808 farther than 32 megabytes (33,554,432 bytes) from the current location.
19809 A short call is generated if the compiler knows
19810 the call cannot be that far away.  This setting can be overridden by
19811 the @code{shortcall} function attribute, or by @code{#pragma
19812 longcall(0)}.
19814 Some linkers are capable of detecting out-of-range calls and generating
19815 glue code on the fly.  On these systems, long calls are unnecessary and
19816 generate slower code.  As of this writing, the AIX linker can do this,
19817 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19818 to the GNU linker for 32-bit PowerPC systems as well.
19820 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19821 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19822 addresses represent the callee and the branch island.  The
19823 Darwin/PPC linker prefers the first address and generates a @code{bl
19824 callee} if the PPC @code{bl} instruction reaches the callee directly;
19825 otherwise, the linker generates @code{bl L42} to call the branch
19826 island.  The branch island is appended to the body of the
19827 calling function; it computes the full 32-bit address of the callee
19828 and jumps to it.
19830 On Mach-O (Darwin) systems, this option directs the compiler emit to
19831 the glue for every direct call, and the Darwin linker decides whether
19832 to use or discard it.
19834 In the future, GCC may ignore all longcall specifications
19835 when the linker is known to generate glue.
19837 @item -mtls-markers
19838 @itemx -mno-tls-markers
19839 @opindex mtls-markers
19840 @opindex mno-tls-markers
19841 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19842 specifying the function argument.  The relocation allows the linker to
19843 reliably associate function call with argument setup instructions for
19844 TLS optimization, which in turn allows GCC to better schedule the
19845 sequence.
19847 @item -pthread
19848 @opindex pthread
19849 Adds support for multithreading with the @dfn{pthreads} library.
19850 This option sets flags for both the preprocessor and linker.
19852 @item -mrecip
19853 @itemx -mno-recip
19854 @opindex mrecip
19855 This option enables use of the reciprocal estimate and
19856 reciprocal square root estimate instructions with additional
19857 Newton-Raphson steps to increase precision instead of doing a divide or
19858 square root and divide for floating-point arguments.  You should use
19859 the @option{-ffast-math} option when using @option{-mrecip} (or at
19860 least @option{-funsafe-math-optimizations},
19861 @option{-finite-math-only}, @option{-freciprocal-math} and
19862 @option{-fno-trapping-math}).  Note that while the throughput of the
19863 sequence is generally higher than the throughput of the non-reciprocal
19864 instruction, the precision of the sequence can be decreased by up to 2
19865 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19866 roots.
19868 @item -mrecip=@var{opt}
19869 @opindex mrecip=opt
19870 This option controls which reciprocal estimate instructions
19871 may be used.  @var{opt} is a comma-separated list of options, which may
19872 be preceded by a @code{!} to invert the option:
19873 @code{all}: enable all estimate instructions,
19874 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
19875 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
19876 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
19877 @code{divf}: enable the single-precision reciprocal approximation instructions;
19878 @code{divd}: enable the double-precision reciprocal approximation instructions;
19879 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
19880 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
19881 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
19883 So, for example, @option{-mrecip=all,!rsqrtd} enables
19884 all of the reciprocal estimate instructions, except for the
19885 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
19886 which handle the double-precision reciprocal square root calculations.
19888 @item -mrecip-precision
19889 @itemx -mno-recip-precision
19890 @opindex mrecip-precision
19891 Assume (do not assume) that the reciprocal estimate instructions
19892 provide higher-precision estimates than is mandated by the PowerPC
19893 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
19894 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
19895 The double-precision square root estimate instructions are not generated by
19896 default on low-precision machines, since they do not provide an
19897 estimate that converges after three steps.
19899 @item -mveclibabi=@var{type}
19900 @opindex mveclibabi
19901 Specifies the ABI type to use for vectorizing intrinsics using an
19902 external library.  The only type supported at present is @code{mass},
19903 which specifies to use IBM's Mathematical Acceleration Subsystem
19904 (MASS) libraries for vectorizing intrinsics using external libraries.
19905 GCC currently emits calls to @code{acosd2}, @code{acosf4},
19906 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
19907 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
19908 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
19909 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
19910 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
19911 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
19912 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
19913 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
19914 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
19915 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
19916 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
19917 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
19918 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
19919 for power7.  Both @option{-ftree-vectorize} and
19920 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
19921 libraries must be specified at link time.
19923 @item -mfriz
19924 @itemx -mno-friz
19925 @opindex mfriz
19926 Generate (do not generate) the @code{friz} instruction when the
19927 @option{-funsafe-math-optimizations} option is used to optimize
19928 rounding of floating-point values to 64-bit integer and back to floating
19929 point.  The @code{friz} instruction does not return the same value if
19930 the floating-point number is too large to fit in an integer.
19932 @item -mpointers-to-nested-functions
19933 @itemx -mno-pointers-to-nested-functions
19934 @opindex mpointers-to-nested-functions
19935 Generate (do not generate) code to load up the static chain register
19936 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
19937 systems where a function pointer points to a 3-word descriptor giving
19938 the function address, TOC value to be loaded in register @var{r2}, and
19939 static chain value to be loaded in register @var{r11}.  The
19940 @option{-mpointers-to-nested-functions} is on by default.  You cannot
19941 call through pointers to nested functions or pointers
19942 to functions compiled in other languages that use the static chain if
19943 you use the @option{-mno-pointers-to-nested-functions}.
19945 @item -msave-toc-indirect
19946 @itemx -mno-save-toc-indirect
19947 @opindex msave-toc-indirect
19948 Generate (do not generate) code to save the TOC value in the reserved
19949 stack location in the function prologue if the function calls through
19950 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
19951 saved in the prologue, it is saved just before the call through the
19952 pointer.  The @option{-mno-save-toc-indirect} option is the default.
19954 @item -mcompat-align-parm
19955 @itemx -mno-compat-align-parm
19956 @opindex mcompat-align-parm
19957 Generate (do not generate) code to pass structure parameters with a
19958 maximum alignment of 64 bits, for compatibility with older versions
19959 of GCC.
19961 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
19962 structure parameter on a 128-bit boundary when that structure contained
19963 a member requiring 128-bit alignment.  This is corrected in more
19964 recent versions of GCC.  This option may be used to generate code
19965 that is compatible with functions compiled with older versions of
19966 GCC.
19968 The @option{-mno-compat-align-parm} option is the default.
19969 @end table
19971 @node RX Options
19972 @subsection RX Options
19973 @cindex RX Options
19975 These command-line options are defined for RX targets:
19977 @table @gcctabopt
19978 @item -m64bit-doubles
19979 @itemx -m32bit-doubles
19980 @opindex m64bit-doubles
19981 @opindex m32bit-doubles
19982 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19983 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19984 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
19985 works on 32-bit values, which is why the default is
19986 @option{-m32bit-doubles}.
19988 @item -fpu
19989 @itemx -nofpu
19990 @opindex fpu
19991 @opindex nofpu
19992 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
19993 floating-point hardware.  The default is enabled for the @var{RX600}
19994 series and disabled for the @var{RX200} series.
19996 Floating-point instructions are only generated for 32-bit floating-point 
19997 values, however, so the FPU hardware is not used for doubles if the
19998 @option{-m64bit-doubles} option is used.
20000 @emph{Note} If the @option{-fpu} option is enabled then
20001 @option{-funsafe-math-optimizations} is also enabled automatically.
20002 This is because the RX FPU instructions are themselves unsafe.
20004 @item -mcpu=@var{name}
20005 @opindex -mcpu
20006 Selects the type of RX CPU to be targeted.  Currently three types are
20007 supported, the generic @var{RX600} and @var{RX200} series hardware and
20008 the specific @var{RX610} CPU.  The default is @var{RX600}.
20010 The only difference between @var{RX600} and @var{RX610} is that the
20011 @var{RX610} does not support the @code{MVTIPL} instruction.
20013 The @var{RX200} series does not have a hardware floating-point unit
20014 and so @option{-nofpu} is enabled by default when this type is
20015 selected.
20017 @item -mbig-endian-data
20018 @itemx -mlittle-endian-data
20019 @opindex mbig-endian-data
20020 @opindex mlittle-endian-data
20021 Store data (but not code) in the big-endian format.  The default is
20022 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20023 format.
20025 @item -msmall-data-limit=@var{N}
20026 @opindex msmall-data-limit
20027 Specifies the maximum size in bytes of global and static variables
20028 which can be placed into the small data area.  Using the small data
20029 area can lead to smaller and faster code, but the size of area is
20030 limited and it is up to the programmer to ensure that the area does
20031 not overflow.  Also when the small data area is used one of the RX's
20032 registers (usually @code{r13}) is reserved for use pointing to this
20033 area, so it is no longer available for use by the compiler.  This
20034 could result in slower and/or larger code if variables are pushed onto
20035 the stack instead of being held in this register.
20037 Note, common variables (variables that have not been initialized) and
20038 constants are not placed into the small data area as they are assigned
20039 to other sections in the output executable.
20041 The default value is zero, which disables this feature.  Note, this
20042 feature is not enabled by default with higher optimization levels
20043 (@option{-O2} etc) because of the potentially detrimental effects of
20044 reserving a register.  It is up to the programmer to experiment and
20045 discover whether this feature is of benefit to their program.  See the
20046 description of the @option{-mpid} option for a description of how the
20047 actual register to hold the small data area pointer is chosen.
20049 @item -msim
20050 @itemx -mno-sim
20051 @opindex msim
20052 @opindex mno-sim
20053 Use the simulator runtime.  The default is to use the libgloss
20054 board-specific runtime.
20056 @item -mas100-syntax
20057 @itemx -mno-as100-syntax
20058 @opindex mas100-syntax
20059 @opindex mno-as100-syntax
20060 When generating assembler output use a syntax that is compatible with
20061 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20062 assembler, but it has some restrictions so it is not generated by default.
20064 @item -mmax-constant-size=@var{N}
20065 @opindex mmax-constant-size
20066 Specifies the maximum size, in bytes, of a constant that can be used as
20067 an operand in a RX instruction.  Although the RX instruction set does
20068 allow constants of up to 4 bytes in length to be used in instructions,
20069 a longer value equates to a longer instruction.  Thus in some
20070 circumstances it can be beneficial to restrict the size of constants
20071 that are used in instructions.  Constants that are too big are instead
20072 placed into a constant pool and referenced via register indirection.
20074 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20075 or 4 means that constants of any size are allowed.
20077 @item -mrelax
20078 @opindex mrelax
20079 Enable linker relaxation.  Linker relaxation is a process whereby the
20080 linker attempts to reduce the size of a program by finding shorter
20081 versions of various instructions.  Disabled by default.
20083 @item -mint-register=@var{N}
20084 @opindex mint-register
20085 Specify the number of registers to reserve for fast interrupt handler
20086 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20087 means that register @code{r13} is reserved for the exclusive use
20088 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20089 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20090 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20091 A value of 0, the default, does not reserve any registers.
20093 @item -msave-acc-in-interrupts
20094 @opindex msave-acc-in-interrupts
20095 Specifies that interrupt handler functions should preserve the
20096 accumulator register.  This is only necessary if normal code might use
20097 the accumulator register, for example because it performs 64-bit
20098 multiplications.  The default is to ignore the accumulator as this
20099 makes the interrupt handlers faster.
20101 @item -mpid
20102 @itemx -mno-pid
20103 @opindex mpid
20104 @opindex mno-pid
20105 Enables the generation of position independent data.  When enabled any
20106 access to constant data is done via an offset from a base address
20107 held in a register.  This allows the location of constant data to be
20108 determined at run time without requiring the executable to be
20109 relocated, which is a benefit to embedded applications with tight
20110 memory constraints.  Data that can be modified is not affected by this
20111 option.
20113 Note, using this feature reserves a register, usually @code{r13}, for
20114 the constant data base address.  This can result in slower and/or
20115 larger code, especially in complicated functions.
20117 The actual register chosen to hold the constant data base address
20118 depends upon whether the @option{-msmall-data-limit} and/or the
20119 @option{-mint-register} command-line options are enabled.  Starting
20120 with register @code{r13} and proceeding downwards, registers are
20121 allocated first to satisfy the requirements of @option{-mint-register},
20122 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20123 is possible for the small data area register to be @code{r8} if both
20124 @option{-mint-register=4} and @option{-mpid} are specified on the
20125 command line.
20127 By default this feature is not enabled.  The default can be restored
20128 via the @option{-mno-pid} command-line option.
20130 @item -mno-warn-multiple-fast-interrupts
20131 @itemx -mwarn-multiple-fast-interrupts
20132 @opindex mno-warn-multiple-fast-interrupts
20133 @opindex mwarn-multiple-fast-interrupts
20134 Prevents GCC from issuing a warning message if it finds more than one
20135 fast interrupt handler when it is compiling a file.  The default is to
20136 issue a warning for each extra fast interrupt handler found, as the RX
20137 only supports one such interrupt.
20139 @end table
20141 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20142 has special significance to the RX port when used with the
20143 @code{interrupt} function attribute.  This attribute indicates a
20144 function intended to process fast interrupts.  GCC ensures
20145 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20146 and/or @code{r13} and only provided that the normal use of the
20147 corresponding registers have been restricted via the
20148 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20149 options.
20151 @node S/390 and zSeries Options
20152 @subsection S/390 and zSeries Options
20153 @cindex S/390 and zSeries Options
20155 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20157 @table @gcctabopt
20158 @item -mhard-float
20159 @itemx -msoft-float
20160 @opindex mhard-float
20161 @opindex msoft-float
20162 Use (do not use) the hardware floating-point instructions and registers
20163 for floating-point operations.  When @option{-msoft-float} is specified,
20164 functions in @file{libgcc.a} are used to perform floating-point
20165 operations.  When @option{-mhard-float} is specified, the compiler
20166 generates IEEE floating-point instructions.  This is the default.
20168 @item -mhard-dfp
20169 @itemx -mno-hard-dfp
20170 @opindex mhard-dfp
20171 @opindex mno-hard-dfp
20172 Use (do not use) the hardware decimal-floating-point instructions for
20173 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20174 specified, functions in @file{libgcc.a} are used to perform
20175 decimal-floating-point operations.  When @option{-mhard-dfp} is
20176 specified, the compiler generates decimal-floating-point hardware
20177 instructions.  This is the default for @option{-march=z9-ec} or higher.
20179 @item -mlong-double-64
20180 @itemx -mlong-double-128
20181 @opindex mlong-double-64
20182 @opindex mlong-double-128
20183 These switches control the size of @code{long double} type. A size
20184 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20185 type. This is the default.
20187 @item -mbackchain
20188 @itemx -mno-backchain
20189 @opindex mbackchain
20190 @opindex mno-backchain
20191 Store (do not store) the address of the caller's frame as backchain pointer
20192 into the callee's stack frame.
20193 A backchain may be needed to allow debugging using tools that do not understand
20194 DWARF 2 call frame information.
20195 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20196 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20197 the backchain is placed into the topmost word of the 96/160 byte register
20198 save area.
20200 In general, code compiled with @option{-mbackchain} is call-compatible with
20201 code compiled with @option{-mmo-backchain}; however, use of the backchain
20202 for debugging purposes usually requires that the whole binary is built with
20203 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20204 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20205 to build a linux kernel use @option{-msoft-float}.
20207 The default is to not maintain the backchain.
20209 @item -mpacked-stack
20210 @itemx -mno-packed-stack
20211 @opindex mpacked-stack
20212 @opindex mno-packed-stack
20213 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20214 specified, the compiler uses the all fields of the 96/160 byte register save
20215 area only for their default purpose; unused fields still take up stack space.
20216 When @option{-mpacked-stack} is specified, register save slots are densely
20217 packed at the top of the register save area; unused space is reused for other
20218 purposes, allowing for more efficient use of the available stack space.
20219 However, when @option{-mbackchain} is also in effect, the topmost word of
20220 the save area is always used to store the backchain, and the return address
20221 register is always saved two words below the backchain.
20223 As long as the stack frame backchain is not used, code generated with
20224 @option{-mpacked-stack} is call-compatible with code generated with
20225 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20226 S/390 or zSeries generated code that uses the stack frame backchain at run
20227 time, not just for debugging purposes.  Such code is not call-compatible
20228 with code compiled with @option{-mpacked-stack}.  Also, note that the
20229 combination of @option{-mbackchain},
20230 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20231 to build a linux kernel use @option{-msoft-float}.
20233 The default is to not use the packed stack layout.
20235 @item -msmall-exec
20236 @itemx -mno-small-exec
20237 @opindex msmall-exec
20238 @opindex mno-small-exec
20239 Generate (or do not generate) code using the @code{bras} instruction
20240 to do subroutine calls.
20241 This only works reliably if the total executable size does not
20242 exceed 64k.  The default is to use the @code{basr} instruction instead,
20243 which does not have this limitation.
20245 @item -m64
20246 @itemx -m31
20247 @opindex m64
20248 @opindex m31
20249 When @option{-m31} is specified, generate code compliant to the
20250 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20251 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20252 particular to generate 64-bit instructions.  For the @samp{s390}
20253 targets, the default is @option{-m31}, while the @samp{s390x}
20254 targets default to @option{-m64}.
20256 @item -mzarch
20257 @itemx -mesa
20258 @opindex mzarch
20259 @opindex mesa
20260 When @option{-mzarch} is specified, generate code using the
20261 instructions available on z/Architecture.
20262 When @option{-mesa} is specified, generate code using the
20263 instructions available on ESA/390.  Note that @option{-mesa} is
20264 not possible with @option{-m64}.
20265 When generating code compliant to the GNU/Linux for S/390 ABI,
20266 the default is @option{-mesa}.  When generating code compliant
20267 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20269 @item -mmvcle
20270 @itemx -mno-mvcle
20271 @opindex mmvcle
20272 @opindex mno-mvcle
20273 Generate (or do not generate) code using the @code{mvcle} instruction
20274 to perform block moves.  When @option{-mno-mvcle} is specified,
20275 use a @code{mvc} loop instead.  This is the default unless optimizing for
20276 size.
20278 @item -mdebug
20279 @itemx -mno-debug
20280 @opindex mdebug
20281 @opindex mno-debug
20282 Print (or do not print) additional debug information when compiling.
20283 The default is to not print debug information.
20285 @item -march=@var{cpu-type}
20286 @opindex march
20287 Generate code that runs on @var{cpu-type}, which is the name of a
20288 system representing a certain processor type.  Possible values for
20289 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20290 @samp{z9-109}, @samp{z9-ec}, @samp{z10}, @samp{z196}, and
20291 @samp{zEC12}.  When generating code using the instructions available
20292 on z/Architecture, the default is @option{-march=z900}.  Otherwise,
20293 the default is @option{-march=g5}.
20295 @item -mtune=@var{cpu-type}
20296 @opindex mtune
20297 Tune to @var{cpu-type} everything applicable about the generated code,
20298 except for the ABI and the set of available instructions.
20299 The list of @var{cpu-type} values is the same as for @option{-march}.
20300 The default is the value used for @option{-march}.
20302 @item -mtpf-trace
20303 @itemx -mno-tpf-trace
20304 @opindex mtpf-trace
20305 @opindex mno-tpf-trace
20306 Generate code that adds (does not add) in TPF OS specific branches to trace
20307 routines in the operating system.  This option is off by default, even
20308 when compiling for the TPF OS@.
20310 @item -mfused-madd
20311 @itemx -mno-fused-madd
20312 @opindex mfused-madd
20313 @opindex mno-fused-madd
20314 Generate code that uses (does not use) the floating-point multiply and
20315 accumulate instructions.  These instructions are generated by default if
20316 hardware floating point is used.
20318 @item -mwarn-framesize=@var{framesize}
20319 @opindex mwarn-framesize
20320 Emit a warning if the current function exceeds the given frame size.  Because
20321 this is a compile-time check it doesn't need to be a real problem when the program
20322 runs.  It is intended to identify functions that most probably cause
20323 a stack overflow.  It is useful to be used in an environment with limited stack
20324 size e.g.@: the linux kernel.
20326 @item -mwarn-dynamicstack
20327 @opindex mwarn-dynamicstack
20328 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20329 arrays.  This is generally a bad idea with a limited stack size.
20331 @item -mstack-guard=@var{stack-guard}
20332 @itemx -mstack-size=@var{stack-size}
20333 @opindex mstack-guard
20334 @opindex mstack-size
20335 If these options are provided the S/390 back end emits additional instructions in
20336 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20337 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20338 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20339 the frame size of the compiled function is chosen.
20340 These options are intended to be used to help debugging stack overflow problems.
20341 The additionally emitted code causes only little overhead and hence can also be
20342 used in production-like systems without greater performance degradation.  The given
20343 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20344 @var{stack-guard} without exceeding 64k.
20345 In order to be efficient the extra code makes the assumption that the stack starts
20346 at an address aligned to the value given by @var{stack-size}.
20347 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20349 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20350 @opindex mhotpatch
20351 If the hotpatch option is enabled, a ``hot-patching'' function
20352 prologue is generated for all functions in the compilation unit.
20353 The funtion label is prepended with the given number of two-byte
20354 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20355 the label, 2 * @var{post-halfwords} bytes are appended, using the
20356 largest NOP like instructions the architecture allows (maximum
20357 1000000).
20359 If both arguments are zero, hotpatching is disabled.
20361 This option can be overridden for individual functions with the
20362 @code{hotpatch} attribute.
20363 @end table
20365 @node Score Options
20366 @subsection Score Options
20367 @cindex Score Options
20369 These options are defined for Score implementations:
20371 @table @gcctabopt
20372 @item -meb
20373 @opindex meb
20374 Compile code for big-endian mode.  This is the default.
20376 @item -mel
20377 @opindex mel
20378 Compile code for little-endian mode.
20380 @item -mnhwloop
20381 @opindex mnhwloop
20382 Disable generation of @code{bcnz} instructions.
20384 @item -muls
20385 @opindex muls
20386 Enable generation of unaligned load and store instructions.
20388 @item -mmac
20389 @opindex mmac
20390 Enable the use of multiply-accumulate instructions. Disabled by default.
20392 @item -mscore5
20393 @opindex mscore5
20394 Specify the SCORE5 as the target architecture.
20396 @item -mscore5u
20397 @opindex mscore5u
20398 Specify the SCORE5U of the target architecture.
20400 @item -mscore7
20401 @opindex mscore7
20402 Specify the SCORE7 as the target architecture. This is the default.
20404 @item -mscore7d
20405 @opindex mscore7d
20406 Specify the SCORE7D as the target architecture.
20407 @end table
20409 @node SH Options
20410 @subsection SH Options
20412 These @samp{-m} options are defined for the SH implementations:
20414 @table @gcctabopt
20415 @item -m1
20416 @opindex m1
20417 Generate code for the SH1.
20419 @item -m2
20420 @opindex m2
20421 Generate code for the SH2.
20423 @item -m2e
20424 Generate code for the SH2e.
20426 @item -m2a-nofpu
20427 @opindex m2a-nofpu
20428 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20429 that the floating-point unit is not used.
20431 @item -m2a-single-only
20432 @opindex m2a-single-only
20433 Generate code for the SH2a-FPU, in such a way that no double-precision
20434 floating-point operations are used.
20436 @item -m2a-single
20437 @opindex m2a-single
20438 Generate code for the SH2a-FPU assuming the floating-point unit is in
20439 single-precision mode by default.
20441 @item -m2a
20442 @opindex m2a
20443 Generate code for the SH2a-FPU assuming the floating-point unit is in
20444 double-precision mode by default.
20446 @item -m3
20447 @opindex m3
20448 Generate code for the SH3.
20450 @item -m3e
20451 @opindex m3e
20452 Generate code for the SH3e.
20454 @item -m4-nofpu
20455 @opindex m4-nofpu
20456 Generate code for the SH4 without a floating-point unit.
20458 @item -m4-single-only
20459 @opindex m4-single-only
20460 Generate code for the SH4 with a floating-point unit that only
20461 supports single-precision arithmetic.
20463 @item -m4-single
20464 @opindex m4-single
20465 Generate code for the SH4 assuming the floating-point unit is in
20466 single-precision mode by default.
20468 @item -m4
20469 @opindex m4
20470 Generate code for the SH4.
20472 @item -m4-100
20473 @opindex m4-100
20474 Generate code for SH4-100.
20476 @item -m4-100-nofpu
20477 @opindex m4-100-nofpu
20478 Generate code for SH4-100 in such a way that the
20479 floating-point unit is not used.
20481 @item -m4-100-single
20482 @opindex m4-100-single
20483 Generate code for SH4-100 assuming the floating-point unit is in
20484 single-precision mode by default.
20486 @item -m4-100-single-only
20487 @opindex m4-100-single-only
20488 Generate code for SH4-100 in such a way that no double-precision
20489 floating-point operations are used.
20491 @item -m4-200
20492 @opindex m4-200
20493 Generate code for SH4-200.
20495 @item -m4-200-nofpu
20496 @opindex m4-200-nofpu
20497 Generate code for SH4-200 without in such a way that the
20498 floating-point unit is not used.
20500 @item -m4-200-single
20501 @opindex m4-200-single
20502 Generate code for SH4-200 assuming the floating-point unit is in
20503 single-precision mode by default.
20505 @item -m4-200-single-only
20506 @opindex m4-200-single-only
20507 Generate code for SH4-200 in such a way that no double-precision
20508 floating-point operations are used.
20510 @item -m4-300
20511 @opindex m4-300
20512 Generate code for SH4-300.
20514 @item -m4-300-nofpu
20515 @opindex m4-300-nofpu
20516 Generate code for SH4-300 without in such a way that the
20517 floating-point unit is not used.
20519 @item -m4-300-single
20520 @opindex m4-300-single
20521 Generate code for SH4-300 in such a way that no double-precision
20522 floating-point operations are used.
20524 @item -m4-300-single-only
20525 @opindex m4-300-single-only
20526 Generate code for SH4-300 in such a way that no double-precision
20527 floating-point operations are used.
20529 @item -m4-340
20530 @opindex m4-340
20531 Generate code for SH4-340 (no MMU, no FPU).
20533 @item -m4-500
20534 @opindex m4-500
20535 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20536 assembler.
20538 @item -m4a-nofpu
20539 @opindex m4a-nofpu
20540 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20541 floating-point unit is not used.
20543 @item -m4a-single-only
20544 @opindex m4a-single-only
20545 Generate code for the SH4a, in such a way that no double-precision
20546 floating-point operations are used.
20548 @item -m4a-single
20549 @opindex m4a-single
20550 Generate code for the SH4a assuming the floating-point unit is in
20551 single-precision mode by default.
20553 @item -m4a
20554 @opindex m4a
20555 Generate code for the SH4a.
20557 @item -m4al
20558 @opindex m4al
20559 Same as @option{-m4a-nofpu}, except that it implicitly passes
20560 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20561 instructions at the moment.
20563 @item -m5-32media
20564 @opindex m5-32media
20565 Generate 32-bit code for SHmedia.
20567 @item -m5-32media-nofpu
20568 @opindex m5-32media-nofpu
20569 Generate 32-bit code for SHmedia in such a way that the
20570 floating-point unit is not used.
20572 @item -m5-64media
20573 @opindex m5-64media
20574 Generate 64-bit code for SHmedia.
20576 @item -m5-64media-nofpu
20577 @opindex m5-64media-nofpu
20578 Generate 64-bit code for SHmedia in such a way that the
20579 floating-point unit is not used.
20581 @item -m5-compact
20582 @opindex m5-compact
20583 Generate code for SHcompact.
20585 @item -m5-compact-nofpu
20586 @opindex m5-compact-nofpu
20587 Generate code for SHcompact in such a way that the
20588 floating-point unit is not used.
20590 @item -mb
20591 @opindex mb
20592 Compile code for the processor in big-endian mode.
20594 @item -ml
20595 @opindex ml
20596 Compile code for the processor in little-endian mode.
20598 @item -mdalign
20599 @opindex mdalign
20600 Align doubles at 64-bit boundaries.  Note that this changes the calling
20601 conventions, and thus some functions from the standard C library do
20602 not work unless you recompile it first with @option{-mdalign}.
20604 @item -mrelax
20605 @opindex mrelax
20606 Shorten some address references at link time, when possible; uses the
20607 linker option @option{-relax}.
20609 @item -mbigtable
20610 @opindex mbigtable
20611 Use 32-bit offsets in @code{switch} tables.  The default is to use
20612 16-bit offsets.
20614 @item -mbitops
20615 @opindex mbitops
20616 Enable the use of bit manipulation instructions on SH2A.
20618 @item -mfmovd
20619 @opindex mfmovd
20620 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20621 alignment constraints.
20623 @item -mrenesas
20624 @opindex mrenesas
20625 Comply with the calling conventions defined by Renesas.
20627 @item -mno-renesas
20628 @opindex mno-renesas
20629 Comply with the calling conventions defined for GCC before the Renesas
20630 conventions were available.  This option is the default for all
20631 targets of the SH toolchain.
20633 @item -mnomacsave
20634 @opindex mnomacsave
20635 Mark the @code{MAC} register as call-clobbered, even if
20636 @option{-mrenesas} is given.
20638 @item -mieee
20639 @itemx -mno-ieee
20640 @opindex mieee
20641 @opindex mno-ieee
20642 Control the IEEE compliance of floating-point comparisons, which affects the
20643 handling of cases where the result of a comparison is unordered.  By default
20644 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20645 enabled @option{-mno-ieee} is implicitly set, which results in faster
20646 floating-point greater-equal and less-equal comparisons.  The implcit settings
20647 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20649 @item -minline-ic_invalidate
20650 @opindex minline-ic_invalidate
20651 Inline code to invalidate instruction cache entries after setting up
20652 nested function trampolines.
20653 This option has no effect if @option{-musermode} is in effect and the selected
20654 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20655 instruction.
20656 If the selected code generation option does not allow the use of the @code{icbi}
20657 instruction, and @option{-musermode} is not in effect, the inlined code
20658 manipulates the instruction cache address array directly with an associative
20659 write.  This not only requires privileged mode at run time, but it also
20660 fails if the cache line had been mapped via the TLB and has become unmapped.
20662 @item -misize
20663 @opindex misize
20664 Dump instruction size and location in the assembly code.
20666 @item -mpadstruct
20667 @opindex mpadstruct
20668 This option is deprecated.  It pads structures to multiple of 4 bytes,
20669 which is incompatible with the SH ABI@.
20671 @item -matomic-model=@var{model}
20672 @opindex matomic-model=@var{model}
20673 Sets the model of atomic operations and additional parameters as a comma
20674 separated list.  For details on the atomic built-in functions see
20675 @ref{__atomic Builtins}.  The following models and parameters are supported:
20677 @table @samp
20679 @item none
20680 Disable compiler generated atomic sequences and emit library calls for atomic
20681 operations.  This is the default if the target is not @code{sh*-*-linux*}.
20683 @item soft-gusa
20684 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20685 built-in functions.  The generated atomic sequences require additional support
20686 from the interrupt/exception handling code of the system and are only suitable
20687 for SH3* and SH4* single-core systems.  This option is enabled by default when
20688 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20689 this option will also partially utilize the hardware atomic instructions
20690 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20691 @samp{strict} is specified.  
20693 @item soft-tcb
20694 Generate software atomic sequences that use a variable in the thread control
20695 block.  This is a variation of the gUSA sequences which can also be used on
20696 SH1* and SH2* targets.  The generated atomic sequences require additional
20697 support from the interrupt/exception handling code of the system and are only
20698 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20699 parameter has to be specified as well.
20701 @item soft-imask
20702 Generate software atomic sequences that temporarily disable interrupts by
20703 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20704 in privileged mode and is only suitable for single-core systems.  Additional
20705 support from the interrupt/exception handling code of the system is not
20706 required.  This model is enabled by default when the target is
20707 @code{sh*-*-linux*} and SH1* or SH2*.
20709 @item hard-llcs
20710 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20711 instructions only.  This is only available on SH4A and is suitable for
20712 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20713 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20714 Code compiled with this option will also be compatible with other software
20715 atomic model interrupt/exception handling systems if executed on an SH4A
20716 system.  Additional support from the interrupt/exception handling code of the
20717 system is not required for this model.
20719 @item gbr-offset=
20720 This parameter specifies the offset in bytes of the variable in the thread
20721 control block structure that should be used by the generated atomic sequences
20722 when the @samp{soft-tcb} model has been selected.  For other models this
20723 parameter is ignored.  The specified value must be an integer multiple of four
20724 and in the range 0-1020.
20726 @item strict
20727 This parameter prevents mixed usage of multiple atomic models, even though they
20728 would be compatible, and will make the compiler generate atomic sequences of the
20729 specified model only.
20731 @end table
20733 @item -mtas
20734 @opindex mtas
20735 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20736 Notice that depending on the particular hardware and software configuration
20737 this can degrade overall performance due to the operand cache line flushes
20738 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20739 processors the @code{tas.b} instruction must be used with caution since it
20740 can result in data corruption for certain cache configurations.
20742 @item -mprefergot
20743 @opindex mprefergot
20744 When generating position-independent code, emit function calls using
20745 the Global Offset Table instead of the Procedure Linkage Table.
20747 @item -musermode
20748 @itemx -mno-usermode
20749 @opindex musermode
20750 @opindex mno-usermode
20751 Don't allow (allow) the compiler generating privileged mode code.  Specifying
20752 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
20753 inlined code would not work in user mode.  @option{-musermode} is the default
20754 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
20755 @option{-musermode} has no effect, since there is no user mode.
20757 @item -multcost=@var{number}
20758 @opindex multcost=@var{number}
20759 Set the cost to assume for a multiply insn.
20761 @item -mdiv=@var{strategy}
20762 @opindex mdiv=@var{strategy}
20763 Set the division strategy to be used for integer division operations.
20764 For SHmedia @var{strategy} can be one of: 
20766 @table @samp
20768 @item fp 
20769 Performs the operation in floating point.  This has a very high latency,
20770 but needs only a few instructions, so it might be a good choice if
20771 your code has enough easily-exploitable ILP to allow the compiler to
20772 schedule the floating-point instructions together with other instructions.
20773 Division by zero causes a floating-point exception.
20775 @item inv
20776 Uses integer operations to calculate the inverse of the divisor,
20777 and then multiplies the dividend with the inverse.  This strategy allows
20778 CSE and hoisting of the inverse calculation.  Division by zero calculates
20779 an unspecified result, but does not trap.
20781 @item inv:minlat
20782 A variant of @samp{inv} where, if no CSE or hoisting opportunities
20783 have been found, or if the entire operation has been hoisted to the same
20784 place, the last stages of the inverse calculation are intertwined with the
20785 final multiply to reduce the overall latency, at the expense of using a few
20786 more instructions, and thus offering fewer scheduling opportunities with
20787 other code.
20789 @item call
20790 Calls a library function that usually implements the @samp{inv:minlat}
20791 strategy.
20792 This gives high code density for @code{m5-*media-nofpu} compilations.
20794 @item call2
20795 Uses a different entry point of the same library function, where it
20796 assumes that a pointer to a lookup table has already been set up, which
20797 exposes the pointer load to CSE and code hoisting optimizations.
20799 @item inv:call
20800 @itemx inv:call2
20801 @itemx inv:fp
20802 Use the @samp{inv} algorithm for initial
20803 code generation, but if the code stays unoptimized, revert to the @samp{call},
20804 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
20805 potentially-trapping side effect of division by zero is carried by a
20806 separate instruction, so it is possible that all the integer instructions
20807 are hoisted out, but the marker for the side effect stays where it is.
20808 A recombination to floating-point operations or a call is not possible
20809 in that case.
20811 @item inv20u
20812 @itemx inv20l
20813 Variants of the @samp{inv:minlat} strategy.  In the case
20814 that the inverse calculation is not separated from the multiply, they speed
20815 up division where the dividend fits into 20 bits (plus sign where applicable)
20816 by inserting a test to skip a number of operations in this case; this test
20817 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
20818 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
20820 @end table
20822 For targets other than SHmedia @var{strategy} can be one of:
20824 @table @samp
20826 @item call-div1
20827 Calls a library function that uses the single-step division instruction
20828 @code{div1} to perform the operation.  Division by zero calculates an
20829 unspecified result and does not trap.  This is the default except for SH4,
20830 SH2A and SHcompact.
20832 @item call-fp
20833 Calls a library function that performs the operation in double precision
20834 floating point.  Division by zero causes a floating-point exception.  This is
20835 the default for SHcompact with FPU.  Specifying this for targets that do not
20836 have a double precision FPU will default to @code{call-div1}.
20838 @item call-table
20839 Calls a library function that uses a lookup table for small divisors and
20840 the @code{div1} instruction with case distinction for larger divisors.  Division
20841 by zero calculates an unspecified result and does not trap.  This is the default
20842 for SH4.  Specifying this for targets that do not have dynamic shift
20843 instructions will default to @code{call-div1}.
20845 @end table
20847 When a division strategy has not been specified the default strategy will be
20848 selected based on the current target.  For SH2A the default strategy is to
20849 use the @code{divs} and @code{divu} instructions instead of library function
20850 calls.
20852 @item -maccumulate-outgoing-args
20853 @opindex maccumulate-outgoing-args
20854 Reserve space once for outgoing arguments in the function prologue rather
20855 than around each call.  Generally beneficial for performance and size.  Also
20856 needed for unwinding to avoid changing the stack frame around conditional code.
20858 @item -mdivsi3_libfunc=@var{name}
20859 @opindex mdivsi3_libfunc=@var{name}
20860 Set the name of the library function used for 32-bit signed division to
20861 @var{name}.
20862 This only affects the name used in the @samp{call} and @samp{inv:call}
20863 division strategies, and the compiler still expects the same
20864 sets of input/output/clobbered registers as if this option were not present.
20866 @item -mfixed-range=@var{register-range}
20867 @opindex mfixed-range
20868 Generate code treating the given register range as fixed registers.
20869 A fixed register is one that the register allocator can not use.  This is
20870 useful when compiling kernel code.  A register range is specified as
20871 two registers separated by a dash.  Multiple register ranges can be
20872 specified separated by a comma.
20874 @item -mindexed-addressing
20875 @opindex mindexed-addressing
20876 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
20877 This is only safe if the hardware and/or OS implement 32-bit wrap-around
20878 semantics for the indexed addressing mode.  The architecture allows the
20879 implementation of processors with 64-bit MMU, which the OS could use to
20880 get 32-bit addressing, but since no current hardware implementation supports
20881 this or any other way to make the indexed addressing mode safe to use in
20882 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
20884 @item -mgettrcost=@var{number}
20885 @opindex mgettrcost=@var{number}
20886 Set the cost assumed for the @code{gettr} instruction to @var{number}.
20887 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
20889 @item -mpt-fixed
20890 @opindex mpt-fixed
20891 Assume @code{pt*} instructions won't trap.  This generally generates
20892 better-scheduled code, but is unsafe on current hardware.
20893 The current architecture
20894 definition says that @code{ptabs} and @code{ptrel} trap when the target 
20895 anded with 3 is 3.
20896 This has the unintentional effect of making it unsafe to schedule these
20897 instructions before a branch, or hoist them out of a loop.  For example,
20898 @code{__do_global_ctors}, a part of @file{libgcc}
20899 that runs constructors at program
20900 startup, calls functions in a list which is delimited by @minus{}1.  With the
20901 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
20902 That means that all the constructors run a bit more quickly, but when
20903 the loop comes to the end of the list, the program crashes because @code{ptabs}
20904 loads @minus{}1 into a target register.  
20906 Since this option is unsafe for any
20907 hardware implementing the current architecture specification, the default
20908 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
20909 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
20910 this deters register allocation from using target registers for storing
20911 ordinary integers.
20913 @item -minvalid-symbols
20914 @opindex minvalid-symbols
20915 Assume symbols might be invalid.  Ordinary function symbols generated by
20916 the compiler are always valid to load with
20917 @code{movi}/@code{shori}/@code{ptabs} or
20918 @code{movi}/@code{shori}/@code{ptrel},
20919 but with assembler and/or linker tricks it is possible
20920 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
20921 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
20922 It prevents cross-basic-block CSE, hoisting and most scheduling
20923 of symbol loads.  The default is @option{-mno-invalid-symbols}.
20925 @item -mbranch-cost=@var{num}
20926 @opindex mbranch-cost=@var{num}
20927 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
20928 make the compiler try to generate more branch-free code if possible.  
20929 If not specified the value is selected depending on the processor type that
20930 is being compiled for.
20932 @item -mzdcbranch
20933 @itemx -mno-zdcbranch
20934 @opindex mzdcbranch
20935 @opindex mno-zdcbranch
20936 Assume (do not assume) that zero displacement conditional branch instructions
20937 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
20938 compiler will try to prefer zero displacement branch code sequences.  This is
20939 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
20940 disabled by specifying @option{-mno-zdcbranch}.
20942 @item -mfused-madd
20943 @itemx -mno-fused-madd
20944 @opindex mfused-madd
20945 @opindex mno-fused-madd
20946 Generate code that uses (does not use) the floating-point multiply and
20947 accumulate instructions.  These instructions are generated by default
20948 if hardware floating point is used.  The machine-dependent
20949 @option{-mfused-madd} option is now mapped to the machine-independent
20950 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20951 mapped to @option{-ffp-contract=off}.
20953 @item -mfsca
20954 @itemx -mno-fsca
20955 @opindex mfsca
20956 @opindex mno-fsca
20957 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
20958 and cosine approximations.  The option @code{-mfsca} must be used in
20959 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
20960 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
20961 approximations even if @code{-funsafe-math-optimizations} is in effect.
20963 @item -mfsrra
20964 @itemx -mno-fsrra
20965 @opindex mfsrra
20966 @opindex mno-fsrra
20967 Allow or disallow the compiler to emit the @code{fsrra} instruction for
20968 reciprocal square root approximations.  The option @code{-mfsrra} must be used
20969 in combination with @code{-funsafe-math-optimizations} and
20970 @code{-ffinite-math-only}.  It is enabled by default when generating code for
20971 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
20972 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
20973 in effect.
20975 @item -mpretend-cmove
20976 @opindex mpretend-cmove
20977 Prefer zero-displacement conditional branches for conditional move instruction
20978 patterns.  This can result in faster code on the SH4 processor.
20980 @end table
20982 @node Solaris 2 Options
20983 @subsection Solaris 2 Options
20984 @cindex Solaris 2 options
20986 These @samp{-m} options are supported on Solaris 2:
20988 @table @gcctabopt
20989 @item -mclear-hwcap
20990 @opindex mclear-hwcap
20991 @option{-mclear-hwcap} tells the compiler to remove the hardware
20992 capabilities generated by the Solaris assembler.  This is only necessary
20993 when object files use ISA extensions not supported by the current
20994 machine, but check at runtime whether or not to use them.
20996 @item -mimpure-text
20997 @opindex mimpure-text
20998 @option{-mimpure-text}, used in addition to @option{-shared}, tells
20999 the compiler to not pass @option{-z text} to the linker when linking a
21000 shared object.  Using this option, you can link position-dependent
21001 code into a shared object.
21003 @option{-mimpure-text} suppresses the ``relocations remain against
21004 allocatable but non-writable sections'' linker error message.
21005 However, the necessary relocations trigger copy-on-write, and the
21006 shared object is not actually shared across processes.  Instead of
21007 using @option{-mimpure-text}, you should compile all source code with
21008 @option{-fpic} or @option{-fPIC}.
21010 @end table
21012 These switches are supported in addition to the above on Solaris 2:
21014 @table @gcctabopt
21015 @item -pthreads
21016 @opindex pthreads
21017 Add support for multithreading using the POSIX threads library.  This
21018 option sets flags for both the preprocessor and linker.  This option does
21019 not affect the thread safety of object code produced  by the compiler or
21020 that of libraries supplied with it.
21022 @item -pthread
21023 @opindex pthread
21024 This is a synonym for @option{-pthreads}.
21025 @end table
21027 @node SPARC Options
21028 @subsection SPARC Options
21029 @cindex SPARC options
21031 These @samp{-m} options are supported on the SPARC:
21033 @table @gcctabopt
21034 @item -mno-app-regs
21035 @itemx -mapp-regs
21036 @opindex mno-app-regs
21037 @opindex mapp-regs
21038 Specify @option{-mapp-regs} to generate output using the global registers
21039 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21040 global register 1, each global register 2 through 4 is then treated as an
21041 allocable register that is clobbered by function calls.  This is the default.
21043 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21044 specify @option{-mno-app-regs}.  You should compile libraries and system
21045 software with this option.
21047 @item -mflat
21048 @itemx -mno-flat
21049 @opindex mflat
21050 @opindex mno-flat
21051 With @option{-mflat}, the compiler does not generate save/restore instructions
21052 and uses a ``flat'' or single register window model.  This model is compatible
21053 with the regular register window model.  The local registers and the input
21054 registers (0--5) are still treated as ``call-saved'' registers and are
21055 saved on the stack as needed.
21057 With @option{-mno-flat} (the default), the compiler generates save/restore
21058 instructions (except for leaf functions).  This is the normal operating mode.
21060 @item -mfpu
21061 @itemx -mhard-float
21062 @opindex mfpu
21063 @opindex mhard-float
21064 Generate output containing floating-point instructions.  This is the
21065 default.
21067 @item -mno-fpu
21068 @itemx -msoft-float
21069 @opindex mno-fpu
21070 @opindex msoft-float
21071 Generate output containing library calls for floating point.
21072 @strong{Warning:} the requisite libraries are not available for all SPARC
21073 targets.  Normally the facilities of the machine's usual C compiler are
21074 used, but this cannot be done directly in cross-compilation.  You must make
21075 your own arrangements to provide suitable library functions for
21076 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21077 @samp{sparclite-*-*} do provide software floating-point support.
21079 @option{-msoft-float} changes the calling convention in the output file;
21080 therefore, it is only useful if you compile @emph{all} of a program with
21081 this option.  In particular, you need to compile @file{libgcc.a}, the
21082 library that comes with GCC, with @option{-msoft-float} in order for
21083 this to work.
21085 @item -mhard-quad-float
21086 @opindex mhard-quad-float
21087 Generate output containing quad-word (long double) floating-point
21088 instructions.
21090 @item -msoft-quad-float
21091 @opindex msoft-quad-float
21092 Generate output containing library calls for quad-word (long double)
21093 floating-point instructions.  The functions called are those specified
21094 in the SPARC ABI@.  This is the default.
21096 As of this writing, there are no SPARC implementations that have hardware
21097 support for the quad-word floating-point instructions.  They all invoke
21098 a trap handler for one of these instructions, and then the trap handler
21099 emulates the effect of the instruction.  Because of the trap handler overhead,
21100 this is much slower than calling the ABI library routines.  Thus the
21101 @option{-msoft-quad-float} option is the default.
21103 @item -mno-unaligned-doubles
21104 @itemx -munaligned-doubles
21105 @opindex mno-unaligned-doubles
21106 @opindex munaligned-doubles
21107 Assume that doubles have 8-byte alignment.  This is the default.
21109 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21110 alignment only if they are contained in another type, or if they have an
21111 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21112 Specifying this option avoids some rare compatibility problems with code
21113 generated by other compilers.  It is not the default because it results
21114 in a performance loss, especially for floating-point code.
21116 @item -muser-mode
21117 @itemx -mno-user-mode
21118 @opindex muser-mode
21119 @opindex mno-user-mode
21120 Do not generate code that can only run in supervisor mode.  This is relevant
21121 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21122 default is @option{-mno-user-mode}.
21124 @item -mno-faster-structs
21125 @itemx -mfaster-structs
21126 @opindex mno-faster-structs
21127 @opindex mfaster-structs
21128 With @option{-mfaster-structs}, the compiler assumes that structures
21129 should have 8-byte alignment.  This enables the use of pairs of
21130 @code{ldd} and @code{std} instructions for copies in structure
21131 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21132 However, the use of this changed alignment directly violates the SPARC
21133 ABI@.  Thus, it's intended only for use on targets where the developer
21134 acknowledges that their resulting code is not directly in line with
21135 the rules of the ABI@.
21137 @item -mcpu=@var{cpu_type}
21138 @opindex mcpu
21139 Set the instruction set, register set, and instruction scheduling parameters
21140 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21141 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21142 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21143 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21144 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21145 @samp{niagara3} and @samp{niagara4}.
21147 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21148 which selects the best architecture option for the host processor.
21149 @option{-mcpu=native} has no effect if GCC does not recognize
21150 the processor.
21152 Default instruction scheduling parameters are used for values that select
21153 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21154 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21156 Here is a list of each supported architecture and their supported
21157 implementations.
21159 @table @asis
21160 @item v7
21161 cypress, leon3v7
21163 @item v8
21164 supersparc, hypersparc, leon, leon3
21166 @item sparclite
21167 f930, f934, sparclite86x
21169 @item sparclet
21170 tsc701
21172 @item v9
21173 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21174 @end table
21176 By default (unless configured otherwise), GCC generates code for the V7
21177 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21178 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21179 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21180 SPARCStation 1, 2, IPX etc.
21182 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21183 architecture.  The only difference from V7 code is that the compiler emits
21184 the integer multiply and integer divide instructions which exist in SPARC-V8
21185 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21186 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21187 2000 series.
21189 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21190 the SPARC architecture.  This adds the integer multiply, integer divide step
21191 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21192 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21193 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21194 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21195 MB86934 chip, which is the more recent SPARClite with FPU@.
21197 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21198 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21199 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21200 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21201 optimizes it for the TEMIC SPARClet chip.
21203 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21204 architecture.  This adds 64-bit integer and floating-point move instructions,
21205 3 additional floating-point condition code registers and conditional move
21206 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21207 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21208 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21209 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21210 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21211 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21212 additionally optimizes it for Sun UltraSPARC T2 chips. With
21213 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21214 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21215 additionally optimizes it for Sun UltraSPARC T4 chips.
21217 @item -mtune=@var{cpu_type}
21218 @opindex mtune
21219 Set the instruction scheduling parameters for machine type
21220 @var{cpu_type}, but do not set the instruction set or register set that the
21221 option @option{-mcpu=@var{cpu_type}} does.
21223 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21224 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21225 that select a particular CPU implementation.  Those are @samp{cypress},
21226 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21227 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21228 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21229 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21230 toolchains, @samp{native} can also be used.
21232 @item -mv8plus
21233 @itemx -mno-v8plus
21234 @opindex mv8plus
21235 @opindex mno-v8plus
21236 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21237 difference from the V8 ABI is that the global and out registers are
21238 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21239 mode for all SPARC-V9 processors.
21241 @item -mvis
21242 @itemx -mno-vis
21243 @opindex mvis
21244 @opindex mno-vis
21245 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21246 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21248 @item -mvis2
21249 @itemx -mno-vis2
21250 @opindex mvis2
21251 @opindex mno-vis2
21252 With @option{-mvis2}, GCC generates code that takes advantage of
21253 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21254 default is @option{-mvis2} when targeting a cpu that supports such
21255 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21256 also sets @option{-mvis}.
21258 @item -mvis3
21259 @itemx -mno-vis3
21260 @opindex mvis3
21261 @opindex mno-vis3
21262 With @option{-mvis3}, GCC generates code that takes advantage of
21263 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21264 default is @option{-mvis3} when targeting a cpu that supports such
21265 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21266 also sets @option{-mvis2} and @option{-mvis}.
21268 @item -mcbcond
21269 @itemx -mno-cbcond
21270 @opindex mcbcond
21271 @opindex mno-cbcond
21272 With @option{-mcbcond}, GCC generates code that takes advantage of
21273 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21274 The default is @option{-mcbcond} when targeting a cpu that supports such
21275 instructions, such as niagara-4 and later.
21277 @item -mpopc
21278 @itemx -mno-popc
21279 @opindex mpopc
21280 @opindex mno-popc
21281 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21282 population count instruction.  The default is @option{-mpopc}
21283 when targeting a cpu that supports such instructions, such as Niagara-2 and
21284 later.
21286 @item -mfmaf
21287 @itemx -mno-fmaf
21288 @opindex mfmaf
21289 @opindex mno-fmaf
21290 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21291 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21292 when targeting a cpu that supports such instructions, such as Niagara-3 and
21293 later.
21295 @item -mfix-at697f
21296 @opindex mfix-at697f
21297 Enable the documented workaround for the single erratum of the Atmel AT697F
21298 processor (which corresponds to erratum #13 of the AT697E processor).
21300 @item -mfix-ut699
21301 @opindex mfix-ut699
21302 Enable the documented workarounds for the floating-point errata and the data
21303 cache nullify errata of the UT699 processor.
21304 @end table
21306 These @samp{-m} options are supported in addition to the above
21307 on SPARC-V9 processors in 64-bit environments:
21309 @table @gcctabopt
21310 @item -m32
21311 @itemx -m64
21312 @opindex m32
21313 @opindex m64
21314 Generate code for a 32-bit or 64-bit environment.
21315 The 32-bit environment sets int, long and pointer to 32 bits.
21316 The 64-bit environment sets int to 32 bits and long and pointer
21317 to 64 bits.
21319 @item -mcmodel=@var{which}
21320 @opindex mcmodel
21321 Set the code model to one of
21323 @table @samp
21324 @item medlow
21325 The Medium/Low code model: 64-bit addresses, programs
21326 must be linked in the low 32 bits of memory.  Programs can be statically
21327 or dynamically linked.
21329 @item medmid
21330 The Medium/Middle code model: 64-bit addresses, programs
21331 must be linked in the low 44 bits of memory, the text and data segments must
21332 be less than 2GB in size and the data segment must be located within 2GB of
21333 the text segment.
21335 @item medany
21336 The Medium/Anywhere code model: 64-bit addresses, programs
21337 may be linked anywhere in memory, the text and data segments must be less
21338 than 2GB in size and the data segment must be located within 2GB of the
21339 text segment.
21341 @item embmedany
21342 The Medium/Anywhere code model for embedded systems:
21343 64-bit addresses, the text and data segments must be less than 2GB in
21344 size, both starting anywhere in memory (determined at link time).  The
21345 global register %g4 points to the base of the data segment.  Programs
21346 are statically linked and PIC is not supported.
21347 @end table
21349 @item -mmemory-model=@var{mem-model}
21350 @opindex mmemory-model
21351 Set the memory model in force on the processor to one of
21353 @table @samp
21354 @item default
21355 The default memory model for the processor and operating system.
21357 @item rmo
21358 Relaxed Memory Order
21360 @item pso
21361 Partial Store Order
21363 @item tso
21364 Total Store Order
21366 @item sc
21367 Sequential Consistency
21368 @end table
21370 These memory models are formally defined in Appendix D of the Sparc V9
21371 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21373 @item -mstack-bias
21374 @itemx -mno-stack-bias
21375 @opindex mstack-bias
21376 @opindex mno-stack-bias
21377 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21378 frame pointer if present, are offset by @minus{}2047 which must be added back
21379 when making stack frame references.  This is the default in 64-bit mode.
21380 Otherwise, assume no such offset is present.
21381 @end table
21383 @node SPU Options
21384 @subsection SPU Options
21385 @cindex SPU options
21387 These @samp{-m} options are supported on the SPU:
21389 @table @gcctabopt
21390 @item -mwarn-reloc
21391 @itemx -merror-reloc
21392 @opindex mwarn-reloc
21393 @opindex merror-reloc
21395 The loader for SPU does not handle dynamic relocations.  By default, GCC
21396 gives an error when it generates code that requires a dynamic
21397 relocation.  @option{-mno-error-reloc} disables the error,
21398 @option{-mwarn-reloc} generates a warning instead.
21400 @item -msafe-dma
21401 @itemx -munsafe-dma
21402 @opindex msafe-dma
21403 @opindex munsafe-dma
21405 Instructions that initiate or test completion of DMA must not be
21406 reordered with respect to loads and stores of the memory that is being
21407 accessed.
21408 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21409 memory accesses, but that can lead to inefficient code in places where the
21410 memory is known to not change.  Rather than mark the memory as volatile,
21411 you can use @option{-msafe-dma} to tell the compiler to treat
21412 the DMA instructions as potentially affecting all memory.  
21414 @item -mbranch-hints
21415 @opindex mbranch-hints
21417 By default, GCC generates a branch hint instruction to avoid
21418 pipeline stalls for always-taken or probably-taken branches.  A hint
21419 is not generated closer than 8 instructions away from its branch.
21420 There is little reason to disable them, except for debugging purposes,
21421 or to make an object a little bit smaller.
21423 @item -msmall-mem
21424 @itemx -mlarge-mem
21425 @opindex msmall-mem
21426 @opindex mlarge-mem
21428 By default, GCC generates code assuming that addresses are never larger
21429 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21430 a full 32-bit address.
21432 @item -mstdmain
21433 @opindex mstdmain
21435 By default, GCC links against startup code that assumes the SPU-style
21436 main function interface (which has an unconventional parameter list).
21437 With @option{-mstdmain}, GCC links your program against startup
21438 code that assumes a C99-style interface to @code{main}, including a
21439 local copy of @code{argv} strings.
21441 @item -mfixed-range=@var{register-range}
21442 @opindex mfixed-range
21443 Generate code treating the given register range as fixed registers.
21444 A fixed register is one that the register allocator cannot use.  This is
21445 useful when compiling kernel code.  A register range is specified as
21446 two registers separated by a dash.  Multiple register ranges can be
21447 specified separated by a comma.
21449 @item -mea32
21450 @itemx -mea64
21451 @opindex mea32
21452 @opindex mea64
21453 Compile code assuming that pointers to the PPU address space accessed
21454 via the @code{__ea} named address space qualifier are either 32 or 64
21455 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21456 all object code in an executable must be compiled with the same setting.
21458 @item -maddress-space-conversion
21459 @itemx -mno-address-space-conversion
21460 @opindex maddress-space-conversion
21461 @opindex mno-address-space-conversion
21462 Allow/disallow treating the @code{__ea} address space as superset
21463 of the generic address space.  This enables explicit type casts
21464 between @code{__ea} and generic pointer as well as implicit
21465 conversions of generic pointers to @code{__ea} pointers.  The
21466 default is to allow address space pointer conversions.
21468 @item -mcache-size=@var{cache-size}
21469 @opindex mcache-size
21470 This option controls the version of libgcc that the compiler links to an
21471 executable and selects a software-managed cache for accessing variables
21472 in the @code{__ea} address space with a particular cache size.  Possible
21473 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21474 and @samp{128}.  The default cache size is 64KB.
21476 @item -matomic-updates
21477 @itemx -mno-atomic-updates
21478 @opindex matomic-updates
21479 @opindex mno-atomic-updates
21480 This option controls the version of libgcc that the compiler links to an
21481 executable and selects whether atomic updates to the software-managed
21482 cache of PPU-side variables are used.  If you use atomic updates, changes
21483 to a PPU variable from SPU code using the @code{__ea} named address space
21484 qualifier do not interfere with changes to other PPU variables residing
21485 in the same cache line from PPU code.  If you do not use atomic updates,
21486 such interference may occur; however, writing back cache lines is
21487 more efficient.  The default behavior is to use atomic updates.
21489 @item -mdual-nops
21490 @itemx -mdual-nops=@var{n}
21491 @opindex mdual-nops
21492 By default, GCC inserts nops to increase dual issue when it expects
21493 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21494 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21495 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21497 @item -mhint-max-nops=@var{n}
21498 @opindex mhint-max-nops
21499 Maximum number of nops to insert for a branch hint.  A branch hint must
21500 be at least 8 instructions away from the branch it is affecting.  GCC
21501 inserts up to @var{n} nops to enforce this, otherwise it does not
21502 generate the branch hint.
21504 @item -mhint-max-distance=@var{n}
21505 @opindex mhint-max-distance
21506 The encoding of the branch hint instruction limits the hint to be within
21507 256 instructions of the branch it is affecting.  By default, GCC makes
21508 sure it is within 125.
21510 @item -msafe-hints
21511 @opindex msafe-hints
21512 Work around a hardware bug that causes the SPU to stall indefinitely.
21513 By default, GCC inserts the @code{hbrp} instruction to make sure
21514 this stall won't happen.
21516 @end table
21518 @node System V Options
21519 @subsection Options for System V
21521 These additional options are available on System V Release 4 for
21522 compatibility with other compilers on those systems:
21524 @table @gcctabopt
21525 @item -G
21526 @opindex G
21527 Create a shared object.
21528 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21530 @item -Qy
21531 @opindex Qy
21532 Identify the versions of each tool used by the compiler, in a
21533 @code{.ident} assembler directive in the output.
21535 @item -Qn
21536 @opindex Qn
21537 Refrain from adding @code{.ident} directives to the output file (this is
21538 the default).
21540 @item -YP,@var{dirs}
21541 @opindex YP
21542 Search the directories @var{dirs}, and no others, for libraries
21543 specified with @option{-l}.
21545 @item -Ym,@var{dir}
21546 @opindex Ym
21547 Look in the directory @var{dir} to find the M4 preprocessor.
21548 The assembler uses this option.
21549 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21550 @c the generic assembler that comes with Solaris takes just -Ym.
21551 @end table
21553 @node TILE-Gx Options
21554 @subsection TILE-Gx Options
21555 @cindex TILE-Gx options
21557 These @samp{-m} options are supported on the TILE-Gx:
21559 @table @gcctabopt
21560 @item -mcmodel=small
21561 @opindex mcmodel=small
21562 Generate code for the small model.  The distance for direct calls is
21563 limited to 500M in either direction.  PC-relative addresses are 32
21564 bits.  Absolute addresses support the full address range.
21566 @item -mcmodel=large
21567 @opindex mcmodel=large
21568 Generate code for the large model.  There is no limitation on call
21569 distance, pc-relative addresses, or absolute addresses.
21571 @item -mcpu=@var{name}
21572 @opindex mcpu
21573 Selects the type of CPU to be targeted.  Currently the only supported
21574 type is @samp{tilegx}.
21576 @item -m32
21577 @itemx -m64
21578 @opindex m32
21579 @opindex m64
21580 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21581 environment sets int, long, and pointer to 32 bits.  The 64-bit
21582 environment sets int to 32 bits and long and pointer to 64 bits.
21584 @item -mbig-endian
21585 @itemx -mlittle-endian
21586 @opindex mbig-endian
21587 @opindex mlittle-endian
21588 Generate code in big/little endian mode, respectively.
21589 @end table
21591 @node TILEPro Options
21592 @subsection TILEPro Options
21593 @cindex TILEPro options
21595 These @samp{-m} options are supported on the TILEPro:
21597 @table @gcctabopt
21598 @item -mcpu=@var{name}
21599 @opindex mcpu
21600 Selects the type of CPU to be targeted.  Currently the only supported
21601 type is @samp{tilepro}.
21603 @item -m32
21604 @opindex m32
21605 Generate code for a 32-bit environment, which sets int, long, and
21606 pointer to 32 bits.  This is the only supported behavior so the flag
21607 is essentially ignored.
21608 @end table
21610 @node V850 Options
21611 @subsection V850 Options
21612 @cindex V850 Options
21614 These @samp{-m} options are defined for V850 implementations:
21616 @table @gcctabopt
21617 @item -mlong-calls
21618 @itemx -mno-long-calls
21619 @opindex mlong-calls
21620 @opindex mno-long-calls
21621 Treat all calls as being far away (near).  If calls are assumed to be
21622 far away, the compiler always loads the function's address into a
21623 register, and calls indirect through the pointer.
21625 @item -mno-ep
21626 @itemx -mep
21627 @opindex mno-ep
21628 @opindex mep
21629 Do not optimize (do optimize) basic blocks that use the same index
21630 pointer 4 or more times to copy pointer into the @code{ep} register, and
21631 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21632 option is on by default if you optimize.
21634 @item -mno-prolog-function
21635 @itemx -mprolog-function
21636 @opindex mno-prolog-function
21637 @opindex mprolog-function
21638 Do not use (do use) external functions to save and restore registers
21639 at the prologue and epilogue of a function.  The external functions
21640 are slower, but use less code space if more than one function saves
21641 the same number of registers.  The @option{-mprolog-function} option
21642 is on by default if you optimize.
21644 @item -mspace
21645 @opindex mspace
21646 Try to make the code as small as possible.  At present, this just turns
21647 on the @option{-mep} and @option{-mprolog-function} options.
21649 @item -mtda=@var{n}
21650 @opindex mtda
21651 Put static or global variables whose size is @var{n} bytes or less into
21652 the tiny data area that register @code{ep} points to.  The tiny data
21653 area can hold up to 256 bytes in total (128 bytes for byte references).
21655 @item -msda=@var{n}
21656 @opindex msda
21657 Put static or global variables whose size is @var{n} bytes or less into
21658 the small data area that register @code{gp} points to.  The small data
21659 area can hold up to 64 kilobytes.
21661 @item -mzda=@var{n}
21662 @opindex mzda
21663 Put static or global variables whose size is @var{n} bytes or less into
21664 the first 32 kilobytes of memory.
21666 @item -mv850
21667 @opindex mv850
21668 Specify that the target processor is the V850.
21670 @item -mv850e3v5
21671 @opindex mv850e3v5
21672 Specify that the target processor is the V850E3V5.  The preprocessor
21673 constant @samp{__v850e3v5__} is defined if this option is used.
21675 @item -mv850e2v4
21676 @opindex mv850e2v4
21677 Specify that the target processor is the V850E3V5.  This is an alias for
21678 the @option{-mv850e3v5} option.
21680 @item -mv850e2v3
21681 @opindex mv850e2v3
21682 Specify that the target processor is the V850E2V3.  The preprocessor
21683 constant @samp{__v850e2v3__} is defined if this option is used.
21685 @item -mv850e2
21686 @opindex mv850e2
21687 Specify that the target processor is the V850E2.  The preprocessor
21688 constant @samp{__v850e2__} is defined if this option is used.
21690 @item -mv850e1
21691 @opindex mv850e1
21692 Specify that the target processor is the V850E1.  The preprocessor
21693 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
21694 this option is used.
21696 @item -mv850es
21697 @opindex mv850es
21698 Specify that the target processor is the V850ES.  This is an alias for
21699 the @option{-mv850e1} option.
21701 @item -mv850e
21702 @opindex mv850e
21703 Specify that the target processor is the V850E@.  The preprocessor
21704 constant @samp{__v850e__} is defined if this option is used.
21706 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21707 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21708 are defined then a default target processor is chosen and the
21709 relevant @samp{__v850*__} preprocessor constant is defined.
21711 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
21712 defined, regardless of which processor variant is the target.
21714 @item -mdisable-callt
21715 @itemx -mno-disable-callt
21716 @opindex mdisable-callt
21717 @opindex mno-disable-callt
21718 This option suppresses generation of the @code{CALLT} instruction for the
21719 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21720 architecture.
21722 This option is enabled by default when the RH850 ABI is
21723 in use (see @option{-mrh850-abi}), and disabled by default when the
21724 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21725 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
21727 @item -mrelax
21728 @itemx -mno-relax
21729 @opindex mrelax
21730 @opindex mno-relax
21731 Pass on (or do not pass on) the @option{-mrelax} command line option
21732 to the assembler.
21734 @item -mlong-jumps
21735 @itemx -mno-long-jumps
21736 @opindex mlong-jumps
21737 @opindex mno-long-jumps
21738 Disable (or re-enable) the generation of PC-relative jump instructions.
21740 @item -msoft-float
21741 @itemx -mhard-float
21742 @opindex msoft-float
21743 @opindex mhard-float
21744 Disable (or re-enable) the generation of hardware floating point
21745 instructions.  This option is only significant when the target
21746 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21747 instructions are being generated then the C preprocessor symbol
21748 @code{__FPU_OK__} will be defined, otherwise the symbol
21749 @code{__NO_FPU__} will be defined.
21751 @item -mloop
21752 @opindex mloop
21753 Enables the use of the e3v5 LOOP instruction.  The use of this
21754 instruction is not enabled by default when the e3v5 architecture is
21755 selected because its use is still experimental.
21757 @item -mrh850-abi
21758 @itemx -mghs
21759 @opindex mrh850-abi
21760 @opindex mghs
21761 Enables support for the RH850 version of the V850 ABI.  This is the
21762 default.  With this version of the ABI the following rules apply:
21764 @itemize
21765 @item
21766 Integer sized structures and unions are returned via a memory pointer
21767 rather than a register.
21769 @item
21770 Large structures and unions (more than 8 bytes in size) are passed by
21771 value.
21773 @item
21774 Functions are aligned to 16-bit boundaries.
21776 @item
21777 The @option{-m8byte-align} command line option is supported.
21779 @item
21780 The @option{-mdisable-callt} command line option is enabled by
21781 default.  The @option{-mno-disable-callt} command line option is not
21782 supported.
21783 @end itemize
21785 When this version of the ABI is enabled the C preprocessor symbol
21786 @code{__V850_RH850_ABI__} is defined.
21788 @item -mgcc-abi
21789 @opindex mgcc-abi
21790 Enables support for the old GCC version of the V850 ABI.  With this
21791 version of the ABI the following rules apply:
21793 @itemize
21794 @item
21795 Integer sized structures and unions are returned in register @code{r10}.
21797 @item
21798 Large structures and unions (more than 8 bytes in size) are passed by
21799 reference.
21801 @item
21802 Functions are aligned to 32-bit boundaries, unless optimizing for
21803 size.
21805 @item
21806 The @option{-m8byte-align} command line option is not supported.
21808 @item
21809 The @option{-mdisable-callt} command line option is supported but not
21810 enabled by default.
21811 @end itemize
21813 When this version of the ABI is enabled the C preprocessor symbol
21814 @code{__V850_GCC_ABI__} is defined.
21816 @item -m8byte-align
21817 @itemx -mno-8byte-align
21818 @opindex m8byte-align
21819 @opindex mno-8byte-align
21820 Enables support for @code{doubles} and @code{long long} types to be
21821 aligned on 8-byte boundaries.  The default is to restrict the
21822 alignment of all objects to at most 4-bytes.  When
21823 @option{-m8byte-align} is in effect the C preprocessor symbol
21824 @code{__V850_8BYTE_ALIGN__} will be defined.
21826 @item -mbig-switch
21827 @opindex mbig-switch
21828 Generate code suitable for big switch tables.  Use this option only if
21829 the assembler/linker complain about out of range branches within a switch
21830 table.
21832 @item -mapp-regs
21833 @opindex mapp-regs
21834 This option causes r2 and r5 to be used in the code generated by
21835 the compiler.  This setting is the default.
21837 @item -mno-app-regs
21838 @opindex mno-app-regs
21839 This option causes r2 and r5 to be treated as fixed registers.
21841 @end table
21843 @node VAX Options
21844 @subsection VAX Options
21845 @cindex VAX options
21847 These @samp{-m} options are defined for the VAX:
21849 @table @gcctabopt
21850 @item -munix
21851 @opindex munix
21852 Do not output certain jump instructions (@code{aobleq} and so on)
21853 that the Unix assembler for the VAX cannot handle across long
21854 ranges.
21856 @item -mgnu
21857 @opindex mgnu
21858 Do output those jump instructions, on the assumption that the
21859 GNU assembler is being used.
21861 @item -mg
21862 @opindex mg
21863 Output code for G-format floating-point numbers instead of D-format.
21864 @end table
21866 @node VMS Options
21867 @subsection VMS Options
21869 These @samp{-m} options are defined for the VMS implementations:
21871 @table @gcctabopt
21872 @item -mvms-return-codes
21873 @opindex mvms-return-codes
21874 Return VMS condition codes from @code{main}. The default is to return POSIX-style
21875 condition (e.g.@ error) codes.
21877 @item -mdebug-main=@var{prefix}
21878 @opindex mdebug-main=@var{prefix}
21879 Flag the first routine whose name starts with @var{prefix} as the main
21880 routine for the debugger.
21882 @item -mmalloc64
21883 @opindex mmalloc64
21884 Default to 64-bit memory allocation routines.
21886 @item -mpointer-size=@var{size}
21887 @opindex -mpointer-size=@var{size}
21888 Set the default size of pointers. Possible options for @var{size} are
21889 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
21890 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
21891 The later option disables @code{pragma pointer_size}.
21892 @end table
21894 @node VxWorks Options
21895 @subsection VxWorks Options
21896 @cindex VxWorks Options
21898 The options in this section are defined for all VxWorks targets.
21899 Options specific to the target hardware are listed with the other
21900 options for that target.
21902 @table @gcctabopt
21903 @item -mrtp
21904 @opindex mrtp
21905 GCC can generate code for both VxWorks kernels and real time processes
21906 (RTPs).  This option switches from the former to the latter.  It also
21907 defines the preprocessor macro @code{__RTP__}.
21909 @item -non-static
21910 @opindex non-static
21911 Link an RTP executable against shared libraries rather than static
21912 libraries.  The options @option{-static} and @option{-shared} can
21913 also be used for RTPs (@pxref{Link Options}); @option{-static}
21914 is the default.
21916 @item -Bstatic
21917 @itemx -Bdynamic
21918 @opindex Bstatic
21919 @opindex Bdynamic
21920 These options are passed down to the linker.  They are defined for
21921 compatibility with Diab.
21923 @item -Xbind-lazy
21924 @opindex Xbind-lazy
21925 Enable lazy binding of function calls.  This option is equivalent to
21926 @option{-Wl,-z,now} and is defined for compatibility with Diab.
21928 @item -Xbind-now
21929 @opindex Xbind-now
21930 Disable lazy binding of function calls.  This option is the default and
21931 is defined for compatibility with Diab.
21932 @end table
21934 @node x86-64 Options
21935 @subsection x86-64 Options
21936 @cindex x86-64 options
21938 These are listed under @xref{i386 and x86-64 Options}.
21940 @node Xstormy16 Options
21941 @subsection Xstormy16 Options
21942 @cindex Xstormy16 Options
21944 These options are defined for Xstormy16:
21946 @table @gcctabopt
21947 @item -msim
21948 @opindex msim
21949 Choose startup files and linker script suitable for the simulator.
21950 @end table
21952 @node Xtensa Options
21953 @subsection Xtensa Options
21954 @cindex Xtensa Options
21956 These options are supported for Xtensa targets:
21958 @table @gcctabopt
21959 @item -mconst16
21960 @itemx -mno-const16
21961 @opindex mconst16
21962 @opindex mno-const16
21963 Enable or disable use of @code{CONST16} instructions for loading
21964 constant values.  The @code{CONST16} instruction is currently not a
21965 standard option from Tensilica.  When enabled, @code{CONST16}
21966 instructions are always used in place of the standard @code{L32R}
21967 instructions.  The use of @code{CONST16} is enabled by default only if
21968 the @code{L32R} instruction is not available.
21970 @item -mfused-madd
21971 @itemx -mno-fused-madd
21972 @opindex mfused-madd
21973 @opindex mno-fused-madd
21974 Enable or disable use of fused multiply/add and multiply/subtract
21975 instructions in the floating-point option.  This has no effect if the
21976 floating-point option is not also enabled.  Disabling fused multiply/add
21977 and multiply/subtract instructions forces the compiler to use separate
21978 instructions for the multiply and add/subtract operations.  This may be
21979 desirable in some cases where strict IEEE 754-compliant results are
21980 required: the fused multiply add/subtract instructions do not round the
21981 intermediate result, thereby producing results with @emph{more} bits of
21982 precision than specified by the IEEE standard.  Disabling fused multiply
21983 add/subtract instructions also ensures that the program output is not
21984 sensitive to the compiler's ability to combine multiply and add/subtract
21985 operations.
21987 @item -mserialize-volatile
21988 @itemx -mno-serialize-volatile
21989 @opindex mserialize-volatile
21990 @opindex mno-serialize-volatile
21991 When this option is enabled, GCC inserts @code{MEMW} instructions before
21992 @code{volatile} memory references to guarantee sequential consistency.
21993 The default is @option{-mserialize-volatile}.  Use
21994 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
21996 @item -mforce-no-pic
21997 @opindex mforce-no-pic
21998 For targets, like GNU/Linux, where all user-mode Xtensa code must be
21999 position-independent code (PIC), this option disables PIC for compiling
22000 kernel code.
22002 @item -mtext-section-literals
22003 @itemx -mno-text-section-literals
22004 @opindex mtext-section-literals
22005 @opindex mno-text-section-literals
22006 Control the treatment of literal pools.  The default is
22007 @option{-mno-text-section-literals}, which places literals in a separate
22008 section in the output file.  This allows the literal pool to be placed
22009 in a data RAM/ROM, and it also allows the linker to combine literal
22010 pools from separate object files to remove redundant literals and
22011 improve code size.  With @option{-mtext-section-literals}, the literals
22012 are interspersed in the text section in order to keep them as close as
22013 possible to their references.  This may be necessary for large assembly
22014 files.
22016 @item -mtarget-align
22017 @itemx -mno-target-align
22018 @opindex mtarget-align
22019 @opindex mno-target-align
22020 When this option is enabled, GCC instructs the assembler to
22021 automatically align instructions to reduce branch penalties at the
22022 expense of some code density.  The assembler attempts to widen density
22023 instructions to align branch targets and the instructions following call
22024 instructions.  If there are not enough preceding safe density
22025 instructions to align a target, no widening is performed.  The
22026 default is @option{-mtarget-align}.  These options do not affect the
22027 treatment of auto-aligned instructions like @code{LOOP}, which the
22028 assembler always aligns, either by widening density instructions or
22029 by inserting NOP instructions.
22031 @item -mlongcalls
22032 @itemx -mno-longcalls
22033 @opindex mlongcalls
22034 @opindex mno-longcalls
22035 When this option is enabled, GCC instructs the assembler to translate
22036 direct calls to indirect calls unless it can determine that the target
22037 of a direct call is in the range allowed by the call instruction.  This
22038 translation typically occurs for calls to functions in other source
22039 files.  Specifically, the assembler translates a direct @code{CALL}
22040 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22041 The default is @option{-mno-longcalls}.  This option should be used in
22042 programs where the call target can potentially be out of range.  This
22043 option is implemented in the assembler, not the compiler, so the
22044 assembly code generated by GCC still shows direct call
22045 instructions---look at the disassembled object code to see the actual
22046 instructions.  Note that the assembler uses an indirect call for
22047 every cross-file call, not just those that really are out of range.
22048 @end table
22050 @node zSeries Options
22051 @subsection zSeries Options
22052 @cindex zSeries options
22054 These are listed under @xref{S/390 and zSeries Options}.
22056 @node Code Gen Options
22057 @section Options for Code Generation Conventions
22058 @cindex code generation conventions
22059 @cindex options, code generation
22060 @cindex run-time options
22062 These machine-independent options control the interface conventions
22063 used in code generation.
22065 Most of them have both positive and negative forms; the negative form
22066 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22067 one of the forms is listed---the one that is not the default.  You
22068 can figure out the other form by either removing @samp{no-} or adding
22071 @table @gcctabopt
22072 @item -fbounds-check
22073 @opindex fbounds-check
22074 For front ends that support it, generate additional code to check that
22075 indices used to access arrays are within the declared range.  This is
22076 currently only supported by the Java and Fortran front ends, where
22077 this option defaults to true and false respectively.
22079 @item -fstack-reuse=@var{reuse-level}
22080 @opindex fstack_reuse
22081 This option controls stack space reuse for user declared local/auto variables
22082 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22083 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22084 local variables and temporaries, @samp{named_vars} enables the reuse only for
22085 user defined local variables with names, and @samp{none} disables stack reuse
22086 completely. The default value is @samp{all}. The option is needed when the
22087 program extends the lifetime of a scoped local variable or a compiler generated
22088 temporary beyond the end point defined by the language.  When a lifetime of
22089 a variable ends, and if the variable lives in memory, the optimizing compiler
22090 has the freedom to reuse its stack space with other temporaries or scoped
22091 local variables whose live range does not overlap with it. Legacy code extending
22092 local lifetime will likely to break with the stack reuse optimization.
22094 For example,
22096 @smallexample
22097    int *p;
22098    @{
22099      int local1;
22101      p = &local1;
22102      local1 = 10;
22103      ....
22104    @}
22105    @{
22106       int local2;
22107       local2 = 20;
22108       ...
22109    @}
22111    if (*p == 10)  // out of scope use of local1
22112      @{
22114      @}
22115 @end smallexample
22117 Another example:
22118 @smallexample
22120    struct A
22121    @{
22122        A(int k) : i(k), j(k) @{ @}
22123        int i;
22124        int j;
22125    @};
22127    A *ap;
22129    void foo(const A& ar)
22130    @{
22131       ap = &ar;
22132    @}
22134    void bar()
22135    @{
22136       foo(A(10)); // temp object's lifetime ends when foo returns
22138       @{
22139         A a(20);
22140         ....
22141       @}
22142       ap->i+= 10;  // ap references out of scope temp whose space
22143                    // is reused with a. What is the value of ap->i?
22144    @}
22146 @end smallexample
22148 The lifetime of a compiler generated temporary is well defined by the C++
22149 standard. When a lifetime of a temporary ends, and if the temporary lives
22150 in memory, the optimizing compiler has the freedom to reuse its stack
22151 space with other temporaries or scoped local variables whose live range
22152 does not overlap with it. However some of the legacy code relies on
22153 the behavior of older compilers in which temporaries' stack space is
22154 not reused, the aggressive stack reuse can lead to runtime errors. This
22155 option is used to control the temporary stack reuse optimization.
22157 @item -ftrapv
22158 @opindex ftrapv
22159 This option generates traps for signed overflow on addition, subtraction,
22160 multiplication operations.
22162 @item -fwrapv
22163 @opindex fwrapv
22164 This option instructs the compiler to assume that signed arithmetic
22165 overflow of addition, subtraction and multiplication wraps around
22166 using twos-complement representation.  This flag enables some optimizations
22167 and disables others.  This option is enabled by default for the Java
22168 front end, as required by the Java language specification.
22170 @item -fexceptions
22171 @opindex fexceptions
22172 Enable exception handling.  Generates extra code needed to propagate
22173 exceptions.  For some targets, this implies GCC generates frame
22174 unwind information for all functions, which can produce significant data
22175 size overhead, although it does not affect execution.  If you do not
22176 specify this option, GCC enables it by default for languages like
22177 C++ that normally require exception handling, and disables it for
22178 languages like C that do not normally require it.  However, you may need
22179 to enable this option when compiling C code that needs to interoperate
22180 properly with exception handlers written in C++.  You may also wish to
22181 disable this option if you are compiling older C++ programs that don't
22182 use exception handling.
22184 @item -fnon-call-exceptions
22185 @opindex fnon-call-exceptions
22186 Generate code that allows trapping instructions to throw exceptions.
22187 Note that this requires platform-specific runtime support that does
22188 not exist everywhere.  Moreover, it only allows @emph{trapping}
22189 instructions to throw exceptions, i.e.@: memory references or floating-point
22190 instructions.  It does not allow exceptions to be thrown from
22191 arbitrary signal handlers such as @code{SIGALRM}.
22193 @item -fdelete-dead-exceptions
22194 @opindex fdelete-dead-exceptions
22195 Consider that instructions that may throw exceptions but don't otherwise
22196 contribute to the execution of the program can be optimized away.
22197 This option is enabled by default for the Ada front end, as permitted by
22198 the Ada language specification.
22199 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22201 @item -funwind-tables
22202 @opindex funwind-tables
22203 Similar to @option{-fexceptions}, except that it just generates any needed
22204 static data, but does not affect the generated code in any other way.
22205 You normally do not need to enable this option; instead, a language processor
22206 that needs this handling enables it on your behalf.
22208 @item -fasynchronous-unwind-tables
22209 @opindex fasynchronous-unwind-tables
22210 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22211 table is exact at each instruction boundary, so it can be used for stack
22212 unwinding from asynchronous events (such as debugger or garbage collector).
22214 @item -fno-gnu-unique
22215 @opindex fno-gnu-unique
22216 On systems with recent GNU assembler and C library, the C++ compiler
22217 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22218 of template static data members and static local variables in inline
22219 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22220 is necessary to avoid problems with a library used by two different
22221 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22222 therefore disagreeing with the other one about the binding of the
22223 symbol.  But this causes @code{dlclose} to be ignored for affected
22224 DSOs; if your program relies on reinitialization of a DSO via
22225 @code{dlclose} and @code{dlopen}, you can use
22226 @option{-fno-gnu-unique}.
22228 @item -fpcc-struct-return
22229 @opindex fpcc-struct-return
22230 Return ``short'' @code{struct} and @code{union} values in memory like
22231 longer ones, rather than in registers.  This convention is less
22232 efficient, but it has the advantage of allowing intercallability between
22233 GCC-compiled files and files compiled with other compilers, particularly
22234 the Portable C Compiler (pcc).
22236 The precise convention for returning structures in memory depends
22237 on the target configuration macros.
22239 Short structures and unions are those whose size and alignment match
22240 that of some integer type.
22242 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22243 switch is not binary compatible with code compiled with the
22244 @option{-freg-struct-return} switch.
22245 Use it to conform to a non-default application binary interface.
22247 @item -freg-struct-return
22248 @opindex freg-struct-return
22249 Return @code{struct} and @code{union} values in registers when possible.
22250 This is more efficient for small structures than
22251 @option{-fpcc-struct-return}.
22253 If you specify neither @option{-fpcc-struct-return} nor
22254 @option{-freg-struct-return}, GCC defaults to whichever convention is
22255 standard for the target.  If there is no standard convention, GCC
22256 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22257 the principal compiler.  In those cases, we can choose the standard, and
22258 we chose the more efficient register return alternative.
22260 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22261 switch is not binary compatible with code compiled with the
22262 @option{-fpcc-struct-return} switch.
22263 Use it to conform to a non-default application binary interface.
22265 @item -fshort-enums
22266 @opindex fshort-enums
22267 Allocate to an @code{enum} type only as many bytes as it needs for the
22268 declared range of possible values.  Specifically, the @code{enum} type
22269 is equivalent to the smallest integer type that has enough room.
22271 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22272 code that is not binary compatible with code generated without that switch.
22273 Use it to conform to a non-default application binary interface.
22275 @item -fshort-double
22276 @opindex fshort-double
22277 Use the same size for @code{double} as for @code{float}.
22279 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22280 code that is not binary compatible with code generated without that switch.
22281 Use it to conform to a non-default application binary interface.
22283 @item -fshort-wchar
22284 @opindex fshort-wchar
22285 Override the underlying type for @samp{wchar_t} to be @samp{short
22286 unsigned int} instead of the default for the target.  This option is
22287 useful for building programs to run under WINE@.
22289 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22290 code that is not binary compatible with code generated without that switch.
22291 Use it to conform to a non-default application binary interface.
22293 @item -fno-common
22294 @opindex fno-common
22295 In C code, controls the placement of uninitialized global variables.
22296 Unix C compilers have traditionally permitted multiple definitions of
22297 such variables in different compilation units by placing the variables
22298 in a common block.
22299 This is the behavior specified by @option{-fcommon}, and is the default
22300 for GCC on most targets.
22301 On the other hand, this behavior is not required by ISO C, and on some
22302 targets may carry a speed or code size penalty on variable references.
22303 The @option{-fno-common} option specifies that the compiler should place
22304 uninitialized global variables in the data section of the object file,
22305 rather than generating them as common blocks.
22306 This has the effect that if the same variable is declared
22307 (without @code{extern}) in two different compilations,
22308 you get a multiple-definition error when you link them.
22309 In this case, you must compile with @option{-fcommon} instead.
22310 Compiling with @option{-fno-common} is useful on targets for which
22311 it provides better performance, or if you wish to verify that the
22312 program will work on other systems that always treat uninitialized
22313 variable declarations this way.
22315 @item -fno-ident
22316 @opindex fno-ident
22317 Ignore the @samp{#ident} directive.
22319 @item -finhibit-size-directive
22320 @opindex finhibit-size-directive
22321 Don't output a @code{.size} assembler directive, or anything else that
22322 would cause trouble if the function is split in the middle, and the
22323 two halves are placed at locations far apart in memory.  This option is
22324 used when compiling @file{crtstuff.c}; you should not need to use it
22325 for anything else.
22327 @item -fverbose-asm
22328 @opindex fverbose-asm
22329 Put extra commentary information in the generated assembly code to
22330 make it more readable.  This option is generally only of use to those
22331 who actually need to read the generated assembly code (perhaps while
22332 debugging the compiler itself).
22334 @option{-fno-verbose-asm}, the default, causes the
22335 extra information to be omitted and is useful when comparing two assembler
22336 files.
22338 @item -frecord-gcc-switches
22339 @opindex frecord-gcc-switches
22340 This switch causes the command line used to invoke the
22341 compiler to be recorded into the object file that is being created.
22342 This switch is only implemented on some targets and the exact format
22343 of the recording is target and binary file format dependent, but it
22344 usually takes the form of a section containing ASCII text.  This
22345 switch is related to the @option{-fverbose-asm} switch, but that
22346 switch only records information in the assembler output file as
22347 comments, so it never reaches the object file.
22348 See also @option{-grecord-gcc-switches} for another
22349 way of storing compiler options into the object file.
22351 @item -fpic
22352 @opindex fpic
22353 @cindex global offset table
22354 @cindex PIC
22355 Generate position-independent code (PIC) suitable for use in a shared
22356 library, if supported for the target machine.  Such code accesses all
22357 constant addresses through a global offset table (GOT)@.  The dynamic
22358 loader resolves the GOT entries when the program starts (the dynamic
22359 loader is not part of GCC; it is part of the operating system).  If
22360 the GOT size for the linked executable exceeds a machine-specific
22361 maximum size, you get an error message from the linker indicating that
22362 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
22363 instead.  (These maximums are 8k on the SPARC and 32k
22364 on the m68k and RS/6000.  The 386 has no such limit.)
22366 Position-independent code requires special support, and therefore works
22367 only on certain machines.  For the 386, GCC supports PIC for System V
22368 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
22369 position-independent.
22371 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22372 are defined to 1.
22374 @item -fPIC
22375 @opindex fPIC
22376 If supported for the target machine, emit position-independent code,
22377 suitable for dynamic linking and avoiding any limit on the size of the
22378 global offset table.  This option makes a difference on the m68k,
22379 PowerPC and SPARC@.
22381 Position-independent code requires special support, and therefore works
22382 only on certain machines.
22384 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22385 are defined to 2.
22387 @item -fpie
22388 @itemx -fPIE
22389 @opindex fpie
22390 @opindex fPIE
22391 These options are similar to @option{-fpic} and @option{-fPIC}, but
22392 generated position independent code can be only linked into executables.
22393 Usually these options are used when @option{-pie} GCC option is
22394 used during linking.
22396 @option{-fpie} and @option{-fPIE} both define the macros
22397 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
22398 for @option{-fpie} and 2 for @option{-fPIE}.
22400 @item -fno-jump-tables
22401 @opindex fno-jump-tables
22402 Do not use jump tables for switch statements even where it would be
22403 more efficient than other code generation strategies.  This option is
22404 of use in conjunction with @option{-fpic} or @option{-fPIC} for
22405 building code that forms part of a dynamic linker and cannot
22406 reference the address of a jump table.  On some targets, jump tables
22407 do not require a GOT and this option is not needed.
22409 @item -ffixed-@var{reg}
22410 @opindex ffixed
22411 Treat the register named @var{reg} as a fixed register; generated code
22412 should never refer to it (except perhaps as a stack pointer, frame
22413 pointer or in some other fixed role).
22415 @var{reg} must be the name of a register.  The register names accepted
22416 are machine-specific and are defined in the @code{REGISTER_NAMES}
22417 macro in the machine description macro file.
22419 This flag does not have a negative form, because it specifies a
22420 three-way choice.
22422 @item -fcall-used-@var{reg}
22423 @opindex fcall-used
22424 Treat the register named @var{reg} as an allocable register that is
22425 clobbered by function calls.  It may be allocated for temporaries or
22426 variables that do not live across a call.  Functions compiled this way
22427 do not save and restore the register @var{reg}.
22429 It is an error to use this flag with the frame pointer or stack pointer.
22430 Use of this flag for other registers that have fixed pervasive roles in
22431 the machine's execution model produces disastrous results.
22433 This flag does not have a negative form, because it specifies a
22434 three-way choice.
22436 @item -fcall-saved-@var{reg}
22437 @opindex fcall-saved
22438 Treat the register named @var{reg} as an allocable register saved by
22439 functions.  It may be allocated even for temporaries or variables that
22440 live across a call.  Functions compiled this way save and restore
22441 the register @var{reg} if they use it.
22443 It is an error to use this flag with the frame pointer or stack pointer.
22444 Use of this flag for other registers that have fixed pervasive roles in
22445 the machine's execution model produces disastrous results.
22447 A different sort of disaster results from the use of this flag for
22448 a register in which function values may be returned.
22450 This flag does not have a negative form, because it specifies a
22451 three-way choice.
22453 @item -fpack-struct[=@var{n}]
22454 @opindex fpack-struct
22455 Without a value specified, pack all structure members together without
22456 holes.  When a value is specified (which must be a small power of two), pack
22457 structure members according to this value, representing the maximum
22458 alignment (that is, objects with default alignment requirements larger than
22459 this are output potentially unaligned at the next fitting location.
22461 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
22462 code that is not binary compatible with code generated without that switch.
22463 Additionally, it makes the code suboptimal.
22464 Use it to conform to a non-default application binary interface.
22466 @item -finstrument-functions
22467 @opindex finstrument-functions
22468 Generate instrumentation calls for entry and exit to functions.  Just
22469 after function entry and just before function exit, the following
22470 profiling functions are called with the address of the current
22471 function and its call site.  (On some platforms,
22472 @code{__builtin_return_address} does not work beyond the current
22473 function, so the call site information may not be available to the
22474 profiling functions otherwise.)
22476 @smallexample
22477 void __cyg_profile_func_enter (void *this_fn,
22478                                void *call_site);
22479 void __cyg_profile_func_exit  (void *this_fn,
22480                                void *call_site);
22481 @end smallexample
22483 The first argument is the address of the start of the current function,
22484 which may be looked up exactly in the symbol table.
22486 This instrumentation is also done for functions expanded inline in other
22487 functions.  The profiling calls indicate where, conceptually, the
22488 inline function is entered and exited.  This means that addressable
22489 versions of such functions must be available.  If all your uses of a
22490 function are expanded inline, this may mean an additional expansion of
22491 code size.  If you use @samp{extern inline} in your C code, an
22492 addressable version of such functions must be provided.  (This is
22493 normally the case anyway, but if you get lucky and the optimizer always
22494 expands the functions inline, you might have gotten away without
22495 providing static copies.)
22497 A function may be given the attribute @code{no_instrument_function}, in
22498 which case this instrumentation is not done.  This can be used, for
22499 example, for the profiling functions listed above, high-priority
22500 interrupt routines, and any functions from which the profiling functions
22501 cannot safely be called (perhaps signal handlers, if the profiling
22502 routines generate output or allocate memory).
22504 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
22505 @opindex finstrument-functions-exclude-file-list
22507 Set the list of functions that are excluded from instrumentation (see
22508 the description of @code{-finstrument-functions}).  If the file that
22509 contains a function definition matches with one of @var{file}, then
22510 that function is not instrumented.  The match is done on substrings:
22511 if the @var{file} parameter is a substring of the file name, it is
22512 considered to be a match.
22514 For example:
22516 @smallexample
22517 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
22518 @end smallexample
22520 @noindent
22521 excludes any inline function defined in files whose pathnames
22522 contain @code{/bits/stl} or @code{include/sys}.
22524 If, for some reason, you want to include letter @code{','} in one of
22525 @var{sym}, write @code{'\,'}. For example,
22526 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
22527 (note the single quote surrounding the option).
22529 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
22530 @opindex finstrument-functions-exclude-function-list
22532 This is similar to @code{-finstrument-functions-exclude-file-list},
22533 but this option sets the list of function names to be excluded from
22534 instrumentation.  The function name to be matched is its user-visible
22535 name, such as @code{vector<int> blah(const vector<int> &)}, not the
22536 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
22537 match is done on substrings: if the @var{sym} parameter is a substring
22538 of the function name, it is considered to be a match.  For C99 and C++
22539 extended identifiers, the function name must be given in UTF-8, not
22540 using universal character names.
22542 @item -fstack-check
22543 @opindex fstack-check
22544 Generate code to verify that you do not go beyond the boundary of the
22545 stack.  You should specify this flag if you are running in an
22546 environment with multiple threads, but you only rarely need to specify it in
22547 a single-threaded environment since stack overflow is automatically
22548 detected on nearly all systems if there is only one stack.
22550 Note that this switch does not actually cause checking to be done; the
22551 operating system or the language runtime must do that.  The switch causes
22552 generation of code to ensure that they see the stack being extended.
22554 You can additionally specify a string parameter: @code{no} means no
22555 checking, @code{generic} means force the use of old-style checking,
22556 @code{specific} means use the best checking method and is equivalent
22557 to bare @option{-fstack-check}.
22559 Old-style checking is a generic mechanism that requires no specific
22560 target support in the compiler but comes with the following drawbacks:
22562 @enumerate
22563 @item
22564 Modified allocation strategy for large objects: they are always
22565 allocated dynamically if their size exceeds a fixed threshold.
22567 @item
22568 Fixed limit on the size of the static frame of functions: when it is
22569 topped by a particular function, stack checking is not reliable and
22570 a warning is issued by the compiler.
22572 @item
22573 Inefficiency: because of both the modified allocation strategy and the
22574 generic implementation, code performance is hampered.
22575 @end enumerate
22577 Note that old-style stack checking is also the fallback method for
22578 @code{specific} if no target support has been added in the compiler.
22580 @item -fstack-limit-register=@var{reg}
22581 @itemx -fstack-limit-symbol=@var{sym}
22582 @itemx -fno-stack-limit
22583 @opindex fstack-limit-register
22584 @opindex fstack-limit-symbol
22585 @opindex fno-stack-limit
22586 Generate code to ensure that the stack does not grow beyond a certain value,
22587 either the value of a register or the address of a symbol.  If a larger
22588 stack is required, a signal is raised at run time.  For most targets,
22589 the signal is raised before the stack overruns the boundary, so
22590 it is possible to catch the signal without taking special precautions.
22592 For instance, if the stack starts at absolute address @samp{0x80000000}
22593 and grows downwards, you can use the flags
22594 @option{-fstack-limit-symbol=__stack_limit} and
22595 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
22596 of 128KB@.  Note that this may only work with the GNU linker.
22598 @item -fsplit-stack
22599 @opindex fsplit-stack
22600 Generate code to automatically split the stack before it overflows.
22601 The resulting program has a discontiguous stack which can only
22602 overflow if the program is unable to allocate any more memory.  This
22603 is most useful when running threaded programs, as it is no longer
22604 necessary to calculate a good stack size to use for each thread.  This
22605 is currently only implemented for the i386 and x86_64 back ends running
22606 GNU/Linux.
22608 When code compiled with @option{-fsplit-stack} calls code compiled
22609 without @option{-fsplit-stack}, there may not be much stack space
22610 available for the latter code to run.  If compiling all code,
22611 including library code, with @option{-fsplit-stack} is not an option,
22612 then the linker can fix up these calls so that the code compiled
22613 without @option{-fsplit-stack} always has a large stack.  Support for
22614 this is implemented in the gold linker in GNU binutils release 2.21
22615 and later.
22617 @item -fleading-underscore
22618 @opindex fleading-underscore
22619 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
22620 change the way C symbols are represented in the object file.  One use
22621 is to help link with legacy assembly code.
22623 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
22624 generate code that is not binary compatible with code generated without that
22625 switch.  Use it to conform to a non-default application binary interface.
22626 Not all targets provide complete support for this switch.
22628 @item -ftls-model=@var{model}
22629 @opindex ftls-model
22630 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
22631 The @var{model} argument should be one of @code{global-dynamic},
22632 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
22633 Note that the choice is subject to optimization: the compiler may use
22634 a more efficient model for symbols not visible outside of the translation
22635 unit, or if @option{-fpic} is not given on the command line.
22637 The default without @option{-fpic} is @code{initial-exec}; with
22638 @option{-fpic} the default is @code{global-dynamic}.
22640 @item -fvisibility=@var{default|internal|hidden|protected}
22641 @opindex fvisibility
22642 Set the default ELF image symbol visibility to the specified option---all
22643 symbols are marked with this unless overridden within the code.
22644 Using this feature can very substantially improve linking and
22645 load times of shared object libraries, produce more optimized
22646 code, provide near-perfect API export and prevent symbol clashes.
22647 It is @strong{strongly} recommended that you use this in any shared objects
22648 you distribute.
22650 Despite the nomenclature, @code{default} always means public; i.e.,
22651 available to be linked against from outside the shared object.
22652 @code{protected} and @code{internal} are pretty useless in real-world
22653 usage so the only other commonly used option is @code{hidden}.
22654 The default if @option{-fvisibility} isn't specified is
22655 @code{default}, i.e., make every
22656 symbol public---this causes the same behavior as previous versions of
22657 GCC@.
22659 A good explanation of the benefits offered by ensuring ELF
22660 symbols have the correct visibility is given by ``How To Write
22661 Shared Libraries'' by Ulrich Drepper (which can be found at
22662 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
22663 solution made possible by this option to marking things hidden when
22664 the default is public is to make the default hidden and mark things
22665 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
22666 and @code{__attribute__ ((visibility("default")))} instead of
22667 @code{__declspec(dllexport)} you get almost identical semantics with
22668 identical syntax.  This is a great boon to those working with
22669 cross-platform projects.
22671 For those adding visibility support to existing code, you may find
22672 @samp{#pragma GCC visibility} of use.  This works by you enclosing
22673 the declarations you wish to set visibility for with (for example)
22674 @samp{#pragma GCC visibility push(hidden)} and
22675 @samp{#pragma GCC visibility pop}.
22676 Bear in mind that symbol visibility should be viewed @strong{as
22677 part of the API interface contract} and thus all new code should
22678 always specify visibility when it is not the default; i.e., declarations
22679 only for use within the local DSO should @strong{always} be marked explicitly
22680 as hidden as so to avoid PLT indirection overheads---making this
22681 abundantly clear also aids readability and self-documentation of the code.
22682 Note that due to ISO C++ specification requirements, @code{operator new} and
22683 @code{operator delete} must always be of default visibility.
22685 Be aware that headers from outside your project, in particular system
22686 headers and headers from any other library you use, may not be
22687 expecting to be compiled with visibility other than the default.  You
22688 may need to explicitly say @samp{#pragma GCC visibility push(default)}
22689 before including any such headers.
22691 @samp{extern} declarations are not affected by @option{-fvisibility}, so
22692 a lot of code can be recompiled with @option{-fvisibility=hidden} with
22693 no modifications.  However, this means that calls to @code{extern}
22694 functions with no explicit visibility use the PLT, so it is more
22695 effective to use @code{__attribute ((visibility))} and/or
22696 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
22697 declarations should be treated as hidden.
22699 Note that @option{-fvisibility} does affect C++ vague linkage
22700 entities. This means that, for instance, an exception class that is
22701 be thrown between DSOs must be explicitly marked with default
22702 visibility so that the @samp{type_info} nodes are unified between
22703 the DSOs.
22705 An overview of these techniques, their benefits and how to use them
22706 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
22708 @item -fstrict-volatile-bitfields
22709 @opindex fstrict-volatile-bitfields
22710 This option should be used if accesses to volatile bit-fields (or other
22711 structure fields, although the compiler usually honors those types
22712 anyway) should use a single access of the width of the
22713 field's type, aligned to a natural alignment if possible.  For
22714 example, targets with memory-mapped peripheral registers might require
22715 all such accesses to be 16 bits wide; with this flag you can
22716 declare all peripheral bit-fields as @code{unsigned short} (assuming short
22717 is 16 bits on these targets) to force GCC to use 16-bit accesses
22718 instead of, perhaps, a more efficient 32-bit access.
22720 If this option is disabled, the compiler uses the most efficient
22721 instruction.  In the previous example, that might be a 32-bit load
22722 instruction, even though that accesses bytes that do not contain
22723 any portion of the bit-field, or memory-mapped registers unrelated to
22724 the one being updated.
22726 In some cases, such as when the @code{packed} attribute is applied to a 
22727 structure field, it may not be possible to access the field with a single
22728 read or write that is correctly aligned for the target machine.  In this
22729 case GCC falls back to generating multiple accesses rather than code that 
22730 will fault or truncate the result at run time.
22732 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
22733 not allowed to touch non bit-field members.  It is therefore recommended
22734 to define all bits of the field's type as bit-field members.
22736 The default value of this option is determined by the application binary
22737 interface for the target processor.
22739 @item -fsync-libcalls
22740 @opindex fsync-libcalls
22741 This option controls whether any out-of-line instance of the @code{__sync}
22742 family of functions may be used to implement the C++11 @code{__atomic}
22743 family of functions.
22745 The default value of this option is enabled, thus the only useful form
22746 of the option is @option{-fno-sync-libcalls}.  This option is used in
22747 the implementation of the @file{libatomic} runtime library.
22749 @end table
22751 @c man end
22753 @node Environment Variables
22754 @section Environment Variables Affecting GCC
22755 @cindex environment variables
22757 @c man begin ENVIRONMENT
22758 This section describes several environment variables that affect how GCC
22759 operates.  Some of them work by specifying directories or prefixes to use
22760 when searching for various kinds of files.  Some are used to specify other
22761 aspects of the compilation environment.
22763 Note that you can also specify places to search using options such as
22764 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
22765 take precedence over places specified using environment variables, which
22766 in turn take precedence over those specified by the configuration of GCC@.
22767 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
22768 GNU Compiler Collection (GCC) Internals}.
22770 @table @env
22771 @item LANG
22772 @itemx LC_CTYPE
22773 @c @itemx LC_COLLATE
22774 @itemx LC_MESSAGES
22775 @c @itemx LC_MONETARY
22776 @c @itemx LC_NUMERIC
22777 @c @itemx LC_TIME
22778 @itemx LC_ALL
22779 @findex LANG
22780 @findex LC_CTYPE
22781 @c @findex LC_COLLATE
22782 @findex LC_MESSAGES
22783 @c @findex LC_MONETARY
22784 @c @findex LC_NUMERIC
22785 @c @findex LC_TIME
22786 @findex LC_ALL
22787 @cindex locale
22788 These environment variables control the way that GCC uses
22789 localization information which allows GCC to work with different
22790 national conventions.  GCC inspects the locale categories
22791 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
22792 so.  These locale categories can be set to any value supported by your
22793 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
22794 Kingdom encoded in UTF-8.
22796 The @env{LC_CTYPE} environment variable specifies character
22797 classification.  GCC uses it to determine the character boundaries in
22798 a string; this is needed for some multibyte encodings that contain quote
22799 and escape characters that are otherwise interpreted as a string
22800 end or escape.
22802 The @env{LC_MESSAGES} environment variable specifies the language to
22803 use in diagnostic messages.
22805 If the @env{LC_ALL} environment variable is set, it overrides the value
22806 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
22807 and @env{LC_MESSAGES} default to the value of the @env{LANG}
22808 environment variable.  If none of these variables are set, GCC
22809 defaults to traditional C English behavior.
22811 @item TMPDIR
22812 @findex TMPDIR
22813 If @env{TMPDIR} is set, it specifies the directory to use for temporary
22814 files.  GCC uses temporary files to hold the output of one stage of
22815 compilation which is to be used as input to the next stage: for example,
22816 the output of the preprocessor, which is the input to the compiler
22817 proper.
22819 @item GCC_COMPARE_DEBUG
22820 @findex GCC_COMPARE_DEBUG
22821 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
22822 @option{-fcompare-debug} to the compiler driver.  See the documentation
22823 of this option for more details.
22825 @item GCC_EXEC_PREFIX
22826 @findex GCC_EXEC_PREFIX
22827 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
22828 names of the subprograms executed by the compiler.  No slash is added
22829 when this prefix is combined with the name of a subprogram, but you can
22830 specify a prefix that ends with a slash if you wish.
22832 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
22833 an appropriate prefix to use based on the pathname it is invoked with.
22835 If GCC cannot find the subprogram using the specified prefix, it
22836 tries looking in the usual places for the subprogram.
22838 The default value of @env{GCC_EXEC_PREFIX} is
22839 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
22840 the installed compiler. In many cases @var{prefix} is the value
22841 of @code{prefix} when you ran the @file{configure} script.
22843 Other prefixes specified with @option{-B} take precedence over this prefix.
22845 This prefix is also used for finding files such as @file{crt0.o} that are
22846 used for linking.
22848 In addition, the prefix is used in an unusual way in finding the
22849 directories to search for header files.  For each of the standard
22850 directories whose name normally begins with @samp{/usr/local/lib/gcc}
22851 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
22852 replacing that beginning with the specified prefix to produce an
22853 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
22854 @file{foo/bar} just before it searches the standard directory 
22855 @file{/usr/local/lib/bar}.
22856 If a standard directory begins with the configured
22857 @var{prefix} then the value of @var{prefix} is replaced by
22858 @env{GCC_EXEC_PREFIX} when looking for header files.
22860 @item COMPILER_PATH
22861 @findex COMPILER_PATH
22862 The value of @env{COMPILER_PATH} is a colon-separated list of
22863 directories, much like @env{PATH}.  GCC tries the directories thus
22864 specified when searching for subprograms, if it can't find the
22865 subprograms using @env{GCC_EXEC_PREFIX}.
22867 @item LIBRARY_PATH
22868 @findex LIBRARY_PATH
22869 The value of @env{LIBRARY_PATH} is a colon-separated list of
22870 directories, much like @env{PATH}.  When configured as a native compiler,
22871 GCC tries the directories thus specified when searching for special
22872 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
22873 using GCC also uses these directories when searching for ordinary
22874 libraries for the @option{-l} option (but directories specified with
22875 @option{-L} come first).
22877 @item LANG
22878 @findex LANG
22879 @cindex locale definition
22880 This variable is used to pass locale information to the compiler.  One way in
22881 which this information is used is to determine the character set to be used
22882 when character literals, string literals and comments are parsed in C and C++.
22883 When the compiler is configured to allow multibyte characters,
22884 the following values for @env{LANG} are recognized:
22886 @table @samp
22887 @item C-JIS
22888 Recognize JIS characters.
22889 @item C-SJIS
22890 Recognize SJIS characters.
22891 @item C-EUCJP
22892 Recognize EUCJP characters.
22893 @end table
22895 If @env{LANG} is not defined, or if it has some other value, then the
22896 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
22897 recognize and translate multibyte characters.
22898 @end table
22900 @noindent
22901 Some additional environment variables affect the behavior of the
22902 preprocessor.
22904 @include cppenv.texi
22906 @c man end
22908 @node Precompiled Headers
22909 @section Using Precompiled Headers
22910 @cindex precompiled headers
22911 @cindex speed of compilation
22913 Often large projects have many header files that are included in every
22914 source file.  The time the compiler takes to process these header files
22915 over and over again can account for nearly all of the time required to
22916 build the project.  To make builds faster, GCC allows you to
22917 @dfn{precompile} a header file.
22919 To create a precompiled header file, simply compile it as you would any
22920 other file, if necessary using the @option{-x} option to make the driver
22921 treat it as a C or C++ header file.  You may want to use a
22922 tool like @command{make} to keep the precompiled header up-to-date when
22923 the headers it contains change.
22925 A precompiled header file is searched for when @code{#include} is
22926 seen in the compilation.  As it searches for the included file
22927 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
22928 compiler looks for a precompiled header in each directory just before it
22929 looks for the include file in that directory.  The name searched for is
22930 the name specified in the @code{#include} with @samp{.gch} appended.  If
22931 the precompiled header file can't be used, it is ignored.
22933 For instance, if you have @code{#include "all.h"}, and you have
22934 @file{all.h.gch} in the same directory as @file{all.h}, then the
22935 precompiled header file is used if possible, and the original
22936 header is used otherwise.
22938 Alternatively, you might decide to put the precompiled header file in a
22939 directory and use @option{-I} to ensure that directory is searched
22940 before (or instead of) the directory containing the original header.
22941 Then, if you want to check that the precompiled header file is always
22942 used, you can put a file of the same name as the original header in this
22943 directory containing an @code{#error} command.
22945 This also works with @option{-include}.  So yet another way to use
22946 precompiled headers, good for projects not designed with precompiled
22947 header files in mind, is to simply take most of the header files used by
22948 a project, include them from another header file, precompile that header
22949 file, and @option{-include} the precompiled header.  If the header files
22950 have guards against multiple inclusion, they are skipped because
22951 they've already been included (in the precompiled header).
22953 If you need to precompile the same header file for different
22954 languages, targets, or compiler options, you can instead make a
22955 @emph{directory} named like @file{all.h.gch}, and put each precompiled
22956 header in the directory, perhaps using @option{-o}.  It doesn't matter
22957 what you call the files in the directory; every precompiled header in
22958 the directory is considered.  The first precompiled header
22959 encountered in the directory that is valid for this compilation is
22960 used; they're searched in no particular order.
22962 There are many other possibilities, limited only by your imagination,
22963 good sense, and the constraints of your build system.
22965 A precompiled header file can be used only when these conditions apply:
22967 @itemize
22968 @item
22969 Only one precompiled header can be used in a particular compilation.
22971 @item
22972 A precompiled header can't be used once the first C token is seen.  You
22973 can have preprocessor directives before a precompiled header; you cannot
22974 include a precompiled header from inside another header.
22976 @item
22977 The precompiled header file must be produced for the same language as
22978 the current compilation.  You can't use a C precompiled header for a C++
22979 compilation.
22981 @item
22982 The precompiled header file must have been produced by the same compiler
22983 binary as the current compilation is using.
22985 @item
22986 Any macros defined before the precompiled header is included must
22987 either be defined in the same way as when the precompiled header was
22988 generated, or must not affect the precompiled header, which usually
22989 means that they don't appear in the precompiled header at all.
22991 The @option{-D} option is one way to define a macro before a
22992 precompiled header is included; using a @code{#define} can also do it.
22993 There are also some options that define macros implicitly, like
22994 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
22995 defined this way.
22997 @item If debugging information is output when using the precompiled
22998 header, using @option{-g} or similar, the same kind of debugging information
22999 must have been output when building the precompiled header.  However,
23000 a precompiled header built using @option{-g} can be used in a compilation
23001 when no debugging information is being output.
23003 @item The same @option{-m} options must generally be used when building
23004 and using the precompiled header.  @xref{Submodel Options},
23005 for any cases where this rule is relaxed.
23007 @item Each of the following options must be the same when building and using
23008 the precompiled header:
23010 @gccoptlist{-fexceptions}
23012 @item
23013 Some other command-line options starting with @option{-f},
23014 @option{-p}, or @option{-O} must be defined in the same way as when
23015 the precompiled header was generated.  At present, it's not clear
23016 which options are safe to change and which are not; the safest choice
23017 is to use exactly the same options when generating and using the
23018 precompiled header.  The following are known to be safe:
23020 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23021 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23022 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23023 -pedantic-errors}
23025 @end itemize
23027 For all of these except the last, the compiler automatically
23028 ignores the precompiled header if the conditions aren't met.  If you
23029 find an option combination that doesn't work and doesn't cause the
23030 precompiled header to be ignored, please consider filing a bug report,
23031 see @ref{Bugs}.
23033 If you do use differing options when generating and using the
23034 precompiled header, the actual behavior is a mixture of the
23035 behavior for the options.  For instance, if you use @option{-g} to
23036 generate the precompiled header but not when using it, you may or may
23037 not get debugging information for routines in the precompiled header.