svn merge -r 217500:218679 svn+ssh://gcc.gnu.org/svn/gcc/trunk
[official-gcc.git] / gcc / doc / invoke.texi
blobe98b2e3459f3c555ad33b913b0d5b37d29543de6
1 @c Copyright (C) 1988-2014 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2014 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified.  Also,
105 the placement of the @option{-l} option is significant.
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}.  This manual documents
112 only one of these two forms, whichever one is not the default.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
118 @menu
119 * Option Summary::      Brief list of all options, without explanations.
120 * Overall Options::     Controlling the kind of output:
121                         an executable, object files, assembler files,
122                         or preprocessed source.
123 * Invoking G++::        Compiling C++ programs.
124 * C Dialect Options::   Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127                         and Objective-C++.
128 * Language Independent Options:: Controlling how diagnostics should be
129                         formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
161 -pipe  -pass-exit-codes  @gol
162 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
171 -fhosted  -ffreestanding -fopenacc -fopenmp -fopenmp-simd @gol
172 -fms-extensions -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 @gol
193 -fno-weak  -nostdinc++ @gol
194 -fvisibility-inlines-hidden @gol
195 -fvtable-verify=@var{std|preinit|none} @gol
196 -fvtv-counts -fvtv-debug @gol
197 -fvisibility-ms-compat @gol
198 -fext-numeric-literals @gol
199 -Wabi=@var{n}  -Wconversion-null  -Wctor-dtor-privacy @gol
200 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
201 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
202 -Weffc++  -Wstrict-null-sentinel @gol
203 -Wno-non-template-friend  -Wold-style-cast @gol
204 -Woverloaded-virtual  -Wno-pmf-conversions @gol
205 -Wsign-promo}
207 @item Objective-C and Objective-C++ Language Options
208 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
209 Objective-C and Objective-C++ Dialects}.
210 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
211 -fgnu-runtime  -fnext-runtime @gol
212 -fno-nil-receivers @gol
213 -fobjc-abi-version=@var{n} @gol
214 -fobjc-call-cxx-cdtors @gol
215 -fobjc-direct-dispatch @gol
216 -fobjc-exceptions @gol
217 -fobjc-gc @gol
218 -fobjc-nilcheck @gol
219 -fobjc-std=objc1 @gol
220 -fno-local-ivars @gol
221 -fivar-visibility=@var{public|protected|private|package} @gol
222 -freplace-objc-classes @gol
223 -fzero-link @gol
224 -gen-decls @gol
225 -Wassign-intercept @gol
226 -Wno-protocol  -Wselector @gol
227 -Wstrict-selector-match @gol
228 -Wundeclared-selector}
230 @item Language Independent Options
231 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
232 @gccoptlist{-fmessage-length=@var{n}  @gol
233 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
234 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
235 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
237 @item Warning Options
238 @xref{Warning Options,,Options to Request or Suppress Warnings}.
239 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
240 -pedantic-errors @gol
241 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
242 -Waggressive-loop-optimizations -Warray-bounds @gol
243 -Wbool-compare @gol
244 -Wno-attributes -Wno-builtin-macro-redefined @gol
245 -Wc90-c99-compat -Wc99-c11-compat @gol
246 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
247 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
248 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
249 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
250 -Wdisabled-optimization -Wno-discarded-qualifiers @gol
251 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
252 -Wno-endif-labels -Werror  -Werror=* @gol
253 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
254 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
255 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
256 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
257 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
258 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
259 -Winit-self  -Winline  -Wno-int-conversion @gol
260 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
261 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
262 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
263 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args -Wmissing-braces @gol
264 -Wmissing-field-initializers -Wmissing-include-dirs @gol
265 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
266  -Wodr  -Wno-overflow  -Wopenmp-simd @gol
267 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
268 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
269 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
270 -Wredundant-decls  -Wno-return-local-addr @gol
271 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
272 -Wshift-count-negative -Wshift-count-overflow @gol
273 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
274 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
275 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
276 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
277 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
278 -Wsuggest-final-types @gol -Wsuggest-final-methods @gol
279 -Wmissing-format-attribute @gol
280 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
281 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
282 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
283 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
284 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
285 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
286 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
287 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
288 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
290 @item C and Objective-C-only Warning Options
291 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
292 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
293 -Wold-style-declaration  -Wold-style-definition @gol
294 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
295 -Wdeclaration-after-statement -Wpointer-sign}
297 @item Debugging Options
298 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
299 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
300 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
301 -fasan-shadow-offset=@var{number} -fsanitize-undefined-trap-on-error @gol
302 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
303 -fdisable-ipa-@var{pass_name} @gol
304 -fdisable-rtl-@var{pass_name} @gol
305 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
306 -fdisable-tree-@var{pass_name} @gol
307 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
308 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
309 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
310 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
311 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
312 -fdump-passes @gol
313 -fdump-statistics @gol
314 -fdump-tree-all @gol
315 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
316 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-cfg -fdump-tree-alias @gol
318 -fdump-tree-ch @gol
319 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-gimple@r{[}-raw@r{]} @gol
322 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
323 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
324 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
325 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
326 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
327 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
328 -fdump-tree-nrv -fdump-tree-vect @gol
329 -fdump-tree-sink @gol
330 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
331 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
332 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
333 -fdump-tree-vtable-verify @gol
334 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
335 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
336 -fdump-final-insns=@var{file} @gol
337 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
338 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
339 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
340 -fenable-@var{kind}-@var{pass} @gol
341 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
342 -fdebug-types-section -fmem-report-wpa @gol
343 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
344 -fopt-info @gol
345 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
346 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
347 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
348 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
349 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
350 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
351 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
352 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
353 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
354 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
355 -fdebug-prefix-map=@var{old}=@var{new} @gol
356 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
357 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
358 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
359 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
360 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
361 -print-sysroot -print-sysroot-headers-suffix @gol
362 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
364 @item Optimization Options
365 @xref{Optimize Options,,Options that Control Optimization}.
366 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
367 -falign-jumps[=@var{n}] @gol
368 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
369 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
370 -fauto-inc-dec -fbranch-probabilities @gol
371 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
372 -fbtr-bb-exclusive -fcaller-saves @gol
373 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
374 -fcompare-elim -fcprop-registers -fcrossjumping @gol
375 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
376 -fcx-limited-range @gol
377 -fdata-sections -fdce -fdelayed-branch @gol
378 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
379 -devirtualize-at-ltrans -fdse @gol
380 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
381 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
382 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
383 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
384 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
385 -fif-conversion2 -findirect-inlining @gol
386 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
387 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
388 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
389 -fira-algorithm=@var{algorithm} @gol
390 -fira-region=@var{region} -fira-hoist-pressure @gol
391 -fira-loop-pressure -fno-ira-share-save-slots @gol
392 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
393 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
394 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
395 -floop-block -floop-interchange -floop-strip-mine @gol  
396 -floop-unroll-and-jam -floop-nest-optimize @gol
397 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
398 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
399 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
400 -fmove-loop-invariants -fno-branch-count-reg @gol
401 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
402 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
403 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
404 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
405 -fomit-frame-pointer -foptimize-sibling-calls @gol
406 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
407 -fprefetch-loop-arrays -fprofile-report @gol
408 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
409 -fprofile-generate=@var{path} @gol
410 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
411 -freciprocal-math -free -frename-registers -fschedule-fusion -freorder-blocks @gol
412 -freorder-blocks-and-partition -freorder-functions @gol
413 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
414 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
415 -fsched-spec-load -fsched-spec-load-dangerous @gol
416 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
417 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
418 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
419 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
420 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
421 -fselective-scheduling -fselective-scheduling2 @gol
422 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
423 -fsemantic-interposition @gol
424 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
425 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt -fstack-protector @gol
426 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
427 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
428 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
429 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
430 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
431 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
432 -ftree-loop-if-convert-stores -ftree-loop-im @gol
433 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
434 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
435 -ftree-loop-vectorize @gol
436 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
437 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
438 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
439 -ftree-vectorize -ftree-vrp @gol
440 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
441 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
442 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
443 -fweb -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
444 --param @var{name}=@var{value}
445 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
447 @item Preprocessor Options
448 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
449 @gccoptlist{-A@var{question}=@var{answer} @gol
450 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
451 -C  -dD  -dI  -dM  -dN @gol
452 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
453 -idirafter @var{dir} @gol
454 -include @var{file}  -imacros @var{file} @gol
455 -iprefix @var{file}  -iwithprefix @var{dir} @gol
456 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
457 -imultilib @var{dir} -isysroot @var{dir} @gol
458 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
459 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
460 -remap -trigraphs  -undef  -U@var{macro}  @gol
461 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
463 @item Assembler Option
464 @xref{Assembler Options,,Passing Options to the Assembler}.
465 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
467 @item Linker Options
468 @xref{Link Options,,Options for Linking}.
469 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
470 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
471 -s  -static -static-libgcc -static-libstdc++ @gol
472 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
473 -shared -shared-libgcc  -symbolic @gol
474 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
475 -u @var{symbol} -z @var{keyword}}
477 @item Directory Options
478 @xref{Directory Options,,Options for Directory Search}.
479 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
480 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
481 --sysroot=@var{dir} --no-sysroot-suffix}
483 @item Machine Dependent Options
484 @xref{Submodel Options,,Hardware Models and Configurations}.
485 @c This list is ordered alphanumerically by subsection name.
486 @c Try and put the significant identifier (CPU or system) first,
487 @c so users have a clue at guessing where the ones they want will be.
489 @emph{AArch64 Options}
490 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
491 -mgeneral-regs-only @gol
492 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
493 -mstrict-align @gol
494 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
495 -mtls-dialect=desc  -mtls-dialect=traditional @gol
496 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
497 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
499 @emph{Adapteva Epiphany Options}
500 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
501 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
502 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
503 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
504 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
505 -msplit-vecmove-early -m1reg-@var{reg}}
507 @emph{ARC Options}
508 @gccoptlist{-mbarrel-shifter @gol
509 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
510 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
511 -mea -mno-mpy -mmul32x16 -mmul64 @gol
512 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
513 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
514 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
515 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
516 -mucb-mcount -mvolatile-cache @gol
517 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
518 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
519 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
520 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
521 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
522 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
524 @emph{ARM Options}
525 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
526 -mabi=@var{name} @gol
527 -mapcs-stack-check  -mno-apcs-stack-check @gol
528 -mapcs-float  -mno-apcs-float @gol
529 -mapcs-reentrant  -mno-apcs-reentrant @gol
530 -msched-prolog  -mno-sched-prolog @gol
531 -mlittle-endian  -mbig-endian @gol
532 -mfloat-abi=@var{name} @gol
533 -mfp16-format=@var{name}
534 -mthumb-interwork  -mno-thumb-interwork @gol
535 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
536 -mstructure-size-boundary=@var{n} @gol
537 -mabort-on-noreturn @gol
538 -mlong-calls  -mno-long-calls @gol
539 -msingle-pic-base  -mno-single-pic-base @gol
540 -mpic-register=@var{reg} @gol
541 -mnop-fun-dllimport @gol
542 -mpoke-function-name @gol
543 -mthumb  -marm @gol
544 -mtpcs-frame  -mtpcs-leaf-frame @gol
545 -mcaller-super-interworking  -mcallee-super-interworking @gol
546 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
547 -mword-relocations @gol
548 -mfix-cortex-m3-ldrd @gol
549 -munaligned-access @gol
550 -mneon-for-64bits @gol
551 -mslow-flash-data @gol
552 -masm-syntax-unified @gol
553 -mrestrict-it}
555 @emph{AVR Options}
556 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
557 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
558 -mstrict-X -mtiny-stack -Waddr-space-convert}
560 @emph{Blackfin Options}
561 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
562 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
563 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
564 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
565 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
566 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
567 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
568 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
569 -micplb}
571 @emph{C6X Options}
572 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
573 -msim -msdata=@var{sdata-type}}
575 @emph{CRIS Options}
576 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
577 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
578 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
579 -mstack-align  -mdata-align  -mconst-align @gol
580 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
581 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
582 -mmul-bug-workaround  -mno-mul-bug-workaround}
584 @emph{CR16 Options}
585 @gccoptlist{-mmac @gol
586 -mcr16cplus -mcr16c @gol
587 -msim -mint32 -mbit-ops
588 -mdata-model=@var{model}}
590 @emph{Darwin Options}
591 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
592 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
593 -client_name  -compatibility_version  -current_version @gol
594 -dead_strip @gol
595 -dependency-file  -dylib_file  -dylinker_install_name @gol
596 -dynamic  -dynamiclib  -exported_symbols_list @gol
597 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
598 -force_flat_namespace  -headerpad_max_install_names @gol
599 -iframework @gol
600 -image_base  -init  -install_name  -keep_private_externs @gol
601 -multi_module  -multiply_defined  -multiply_defined_unused @gol
602 -noall_load   -no_dead_strip_inits_and_terms @gol
603 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
604 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
605 -private_bundle  -read_only_relocs  -sectalign @gol
606 -sectobjectsymbols  -whyload  -seg1addr @gol
607 -sectcreate  -sectobjectsymbols  -sectorder @gol
608 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
609 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
610 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
611 -single_module  -static  -sub_library  -sub_umbrella @gol
612 -twolevel_namespace  -umbrella  -undefined @gol
613 -unexported_symbols_list  -weak_reference_mismatches @gol
614 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
615 -mkernel -mone-byte-bool}
617 @emph{DEC Alpha Options}
618 @gccoptlist{-mno-fp-regs  -msoft-float @gol
619 -mieee  -mieee-with-inexact  -mieee-conformant @gol
620 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
621 -mtrap-precision=@var{mode}  -mbuild-constants @gol
622 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
623 -mbwx  -mmax  -mfix  -mcix @gol
624 -mfloat-vax  -mfloat-ieee @gol
625 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
626 -msmall-text  -mlarge-text @gol
627 -mmemory-latency=@var{time}}
629 @emph{FR30 Options}
630 @gccoptlist{-msmall-model -mno-lsim}
632 @emph{FRV Options}
633 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
634 -mhard-float  -msoft-float @gol
635 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
636 -mdouble  -mno-double @gol
637 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
638 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
639 -mlinked-fp  -mlong-calls  -malign-labels @gol
640 -mlibrary-pic  -macc-4  -macc-8 @gol
641 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
642 -moptimize-membar -mno-optimize-membar @gol
643 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
644 -mvliw-branch  -mno-vliw-branch @gol
645 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
646 -mno-nested-cond-exec  -mtomcat-stats @gol
647 -mTLS -mtls @gol
648 -mcpu=@var{cpu}}
650 @emph{GNU/Linux Options}
651 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
652 -tno-android-cc -tno-android-ld}
654 @emph{H8/300 Options}
655 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
657 @emph{HPPA Options}
658 @gccoptlist{-march=@var{architecture-type} @gol
659 -mdisable-fpregs  -mdisable-indexing @gol
660 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
661 -mfixed-range=@var{register-range} @gol
662 -mjump-in-delay -mlinker-opt -mlong-calls @gol
663 -mlong-load-store  -mno-disable-fpregs @gol
664 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
665 -mno-jump-in-delay  -mno-long-load-store @gol
666 -mno-portable-runtime  -mno-soft-float @gol
667 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
668 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
669 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
670 -munix=@var{unix-std}  -nolibdld  -static  -threads}
672 @emph{i386 and x86-64 Options}
673 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
674 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
675 -mfpmath=@var{unit} @gol
676 -masm=@var{dialect}  -mno-fancy-math-387 @gol
677 -mno-fp-ret-in-387  -msoft-float @gol
678 -mno-wide-multiply  -mrtd  -malign-double @gol
679 -mpreferred-stack-boundary=@var{num} @gol
680 -mincoming-stack-boundary=@var{num} @gol
681 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
682 -mrecip -mrecip=@var{opt} @gol
683 -mvzeroupper -mprefer-avx128 @gol
684 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
685 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
686 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
687 -mclflushopt -mxsavec -mxsaves @gol
688 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
689 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mthreads @gol
690 -mno-align-stringops  -minline-all-stringops @gol
691 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
692 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
693 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
694 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
695 -mregparm=@var{num}  -msseregparm @gol
696 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
697 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
698 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
699 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
700 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
701 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
702 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
703 -mstack-protector-guard=@var{guard}}
705 @emph{i386 and x86-64 Windows Options}
706 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
707 -mnop-fun-dllimport -mthread @gol
708 -municode -mwin32 -mwindows -fno-set-stack-executable}
710 @emph{IA-64 Options}
711 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
712 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
713 -mconstant-gp  -mauto-pic  -mfused-madd @gol
714 -minline-float-divide-min-latency @gol
715 -minline-float-divide-max-throughput @gol
716 -mno-inline-float-divide @gol
717 -minline-int-divide-min-latency @gol
718 -minline-int-divide-max-throughput  @gol
719 -mno-inline-int-divide @gol
720 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
721 -mno-inline-sqrt @gol
722 -mdwarf2-asm -mearly-stop-bits @gol
723 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
724 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
725 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
726 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
727 -msched-spec-ldc -msched-spec-control-ldc @gol
728 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
729 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
730 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
731 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
733 @emph{LM32 Options}
734 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
735 -msign-extend-enabled -muser-enabled}
737 @emph{M32R/D Options}
738 @gccoptlist{-m32r2 -m32rx -m32r @gol
739 -mdebug @gol
740 -malign-loops -mno-align-loops @gol
741 -missue-rate=@var{number} @gol
742 -mbranch-cost=@var{number} @gol
743 -mmodel=@var{code-size-model-type} @gol
744 -msdata=@var{sdata-type} @gol
745 -mno-flush-func -mflush-func=@var{name} @gol
746 -mno-flush-trap -mflush-trap=@var{number} @gol
747 -G @var{num}}
749 @emph{M32C Options}
750 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
752 @emph{M680x0 Options}
753 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
754 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
755 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
756 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
757 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
758 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
759 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
760 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
761 -mxgot -mno-xgot}
763 @emph{MCore Options}
764 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
765 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
766 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
767 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
768 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
770 @emph{MeP Options}
771 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
772 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
773 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
774 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
775 -mtiny=@var{n}}
777 @emph{MicroBlaze Options}
778 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
779 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
780 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
781 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
782 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
784 @emph{MIPS Options}
785 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
786 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
787 -mips64  -mips64r2  -mips64r3  -mips64r5 @gol
788 -mips16  -mno-mips16  -mflip-mips16 @gol
789 -minterlink-compressed -mno-interlink-compressed @gol
790 -minterlink-mips16  -mno-interlink-mips16 @gol
791 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
792 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
793 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
794 -mno-float  -msingle-float  -mdouble-float @gol
795 -modd-spreg -mno-odd-spreg @gol
796 -mabs=@var{mode}  -mnan=@var{encoding} @gol
797 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
798 -mmcu -mmno-mcu @gol
799 -meva -mno-eva @gol
800 -mvirt -mno-virt @gol
801 -mxpa -mno-xpa @gol
802 -mmicromips -mno-micromips @gol
803 -mfpu=@var{fpu-type} @gol
804 -msmartmips  -mno-smartmips @gol
805 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
806 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
807 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
808 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
809 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
810 -membedded-data  -mno-embedded-data @gol
811 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
812 -mcode-readable=@var{setting} @gol
813 -msplit-addresses  -mno-split-addresses @gol
814 -mexplicit-relocs  -mno-explicit-relocs @gol
815 -mcheck-zero-division  -mno-check-zero-division @gol
816 -mdivide-traps  -mdivide-breaks @gol
817 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
818 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
819 -mfix-24k -mno-fix-24k @gol
820 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
821 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
822 -mfix-vr4120  -mno-fix-vr4120 @gol
823 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
824 -mflush-func=@var{func}  -mno-flush-func @gol
825 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
826 -mfp-exceptions -mno-fp-exceptions @gol
827 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
828 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
830 @emph{MMIX Options}
831 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
832 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
833 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
834 -mno-base-addresses  -msingle-exit  -mno-single-exit}
836 @emph{MN10300 Options}
837 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
838 -mno-am33 -mam33 -mam33-2 -mam34 @gol
839 -mtune=@var{cpu-type} @gol
840 -mreturn-pointer-on-d0 @gol
841 -mno-crt0  -mrelax -mliw -msetlb}
843 @emph{Moxie Options}
844 @gccoptlist{-meb -mel -mno-crt0}
846 @emph{MSP430 Options}
847 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
848 -mhwmult= -minrt}
850 @emph{NDS32 Options}
851 @gccoptlist{-mbig-endian -mlittle-endian @gol
852 -mreduced-regs -mfull-regs @gol
853 -mcmov -mno-cmov @gol
854 -mperf-ext -mno-perf-ext @gol
855 -mv3push -mno-v3push @gol
856 -m16bit -mno-16bit @gol
857 -mgp-direct -mno-gp-direct @gol
858 -misr-vector-size=@var{num} @gol
859 -mcache-block-size=@var{num} @gol
860 -march=@var{arch} @gol
861 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
862 -mex9 -mctor-dtor -mrelax}
864 @emph{Nios II Options}
865 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
866 -mno-bypass-cache -mbypass-cache @gol
867 -mno-cache-volatile -mcache-volatile @gol
868 -mno-fast-sw-div -mfast-sw-div @gol
869 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
870 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
871 -mcustom-fpu-cfg=@var{name} @gol
872 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
874 @emph{PDP-11 Options}
875 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
876 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
877 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
878 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
879 -mbranch-expensive  -mbranch-cheap @gol
880 -munix-asm  -mdec-asm}
882 @emph{picoChip Options}
883 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
884 -msymbol-as-address -mno-inefficient-warnings}
886 @emph{PowerPC Options}
887 See RS/6000 and PowerPC Options.
889 @emph{RL78 Options}
890 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78 @gol
891 -m64bit-doubles -m32bit-doubles}
893 @emph{RS/6000 and PowerPC Options}
894 @gccoptlist{-mcpu=@var{cpu-type} @gol
895 -mtune=@var{cpu-type} @gol
896 -mcmodel=@var{code-model} @gol
897 -mpowerpc64 @gol
898 -maltivec  -mno-altivec @gol
899 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
900 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
901 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
902 -mfprnd  -mno-fprnd @gol
903 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
904 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
905 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
906 -malign-power  -malign-natural @gol
907 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
908 -msingle-float -mdouble-float -msimple-fpu @gol
909 -mstring  -mno-string  -mupdate  -mno-update @gol
910 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
911 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
912 -mstrict-align  -mno-strict-align  -mrelocatable @gol
913 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
914 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
915 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
916 -mprioritize-restricted-insns=@var{priority} @gol
917 -msched-costly-dep=@var{dependence_type} @gol
918 -minsert-sched-nops=@var{scheme} @gol
919 -mcall-sysv  -mcall-netbsd @gol
920 -maix-struct-return  -msvr4-struct-return @gol
921 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
922 -mblock-move-inline-limit=@var{num} @gol
923 -misel -mno-isel @gol
924 -misel=yes  -misel=no @gol
925 -mspe -mno-spe @gol
926 -mspe=yes  -mspe=no @gol
927 -mpaired @gol
928 -mgen-cell-microcode -mwarn-cell-microcode @gol
929 -mvrsave -mno-vrsave @gol
930 -mmulhw -mno-mulhw @gol
931 -mdlmzb -mno-dlmzb @gol
932 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
933 -mprototype  -mno-prototype @gol
934 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
935 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
936 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
937 -mno-recip-precision @gol
938 -mveclibabi=@var{type} -mfriz -mno-friz @gol
939 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
940 -msave-toc-indirect -mno-save-toc-indirect @gol
941 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
942 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
943 -mquad-memory -mno-quad-memory @gol
944 -mquad-memory-atomic -mno-quad-memory-atomic @gol
945 -mcompat-align-parm -mno-compat-align-parm @gol
946 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
947 -mupper-regs -mno-upper-regs}
949 @emph{RX Options}
950 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
951 -mcpu=@gol
952 -mbig-endian-data -mlittle-endian-data @gol
953 -msmall-data @gol
954 -msim  -mno-sim@gol
955 -mas100-syntax -mno-as100-syntax@gol
956 -mrelax@gol
957 -mmax-constant-size=@gol
958 -mint-register=@gol
959 -mpid@gol
960 -mno-warn-multiple-fast-interrupts@gol
961 -msave-acc-in-interrupts}
963 @emph{S/390 and zSeries Options}
964 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
965 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
966 -mlong-double-64 -mlong-double-128 @gol
967 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
968 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
969 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
970 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
971 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
972 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
974 @emph{Score Options}
975 @gccoptlist{-meb -mel @gol
976 -mnhwloop @gol
977 -muls @gol
978 -mmac @gol
979 -mscore5 -mscore5u -mscore7 -mscore7d}
981 @emph{SH Options}
982 @gccoptlist{-m1  -m2  -m2e @gol
983 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
984 -m3  -m3e @gol
985 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
986 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
987 -m5-64media  -m5-64media-nofpu @gol
988 -m5-32media  -m5-32media-nofpu @gol
989 -m5-compact  -m5-compact-nofpu @gol
990 -mb  -ml  -mdalign  -mrelax @gol
991 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
992 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
993 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
994 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
995 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
996 -maccumulate-outgoing-args -minvalid-symbols @gol
997 -matomic-model=@var{atomic-model} @gol
998 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
999 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1000 -mpretend-cmove -mtas}
1002 @emph{Solaris 2 Options}
1003 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1004 -pthreads -pthread}
1006 @emph{SPARC Options}
1007 @gccoptlist{-mcpu=@var{cpu-type} @gol
1008 -mtune=@var{cpu-type} @gol
1009 -mcmodel=@var{code-model} @gol
1010 -mmemory-model=@var{mem-model} @gol
1011 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1012 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1013 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1014 -mhard-quad-float  -msoft-quad-float @gol
1015 -mstack-bias  -mno-stack-bias @gol
1016 -munaligned-doubles  -mno-unaligned-doubles @gol
1017 -muser-mode  -mno-user-mode @gol
1018 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1019 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1020 -mcbcond -mno-cbcond @gol
1021 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1022 -mfix-at697f -mfix-ut699}
1024 @emph{SPU Options}
1025 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1026 -msafe-dma -munsafe-dma @gol
1027 -mbranch-hints @gol
1028 -msmall-mem -mlarge-mem -mstdmain @gol
1029 -mfixed-range=@var{register-range} @gol
1030 -mea32 -mea64 @gol
1031 -maddress-space-conversion -mno-address-space-conversion @gol
1032 -mcache-size=@var{cache-size} @gol
1033 -matomic-updates -mno-atomic-updates}
1035 @emph{System V Options}
1036 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1038 @emph{TILE-Gx Options}
1039 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1040 -mcmodel=@var{code-model}}
1042 @emph{TILEPro Options}
1043 @gccoptlist{-mcpu=@var{cpu} -m32}
1045 @emph{V850 Options}
1046 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1047 -mprolog-function  -mno-prolog-function  -mspace @gol
1048 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1049 -mapp-regs  -mno-app-regs @gol
1050 -mdisable-callt  -mno-disable-callt @gol
1051 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1052 -mv850e -mv850 -mv850e3v5 @gol
1053 -mloop @gol
1054 -mrelax @gol
1055 -mlong-jumps @gol
1056 -msoft-float @gol
1057 -mhard-float @gol
1058 -mgcc-abi @gol
1059 -mrh850-abi @gol
1060 -mbig-switch}
1062 @emph{VAX Options}
1063 @gccoptlist{-mg  -mgnu  -munix}
1065 @emph{VMS Options}
1066 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1067 -mpointer-size=@var{size}}
1069 @emph{VxWorks Options}
1070 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1071 -Xbind-lazy  -Xbind-now}
1073 @emph{x86-64 Options}
1074 See i386 and x86-64 Options.
1076 @emph{Xstormy16 Options}
1077 @gccoptlist{-msim}
1079 @emph{Xtensa Options}
1080 @gccoptlist{-mconst16 -mno-const16 @gol
1081 -mfused-madd  -mno-fused-madd @gol
1082 -mforce-no-pic @gol
1083 -mserialize-volatile  -mno-serialize-volatile @gol
1084 -mtext-section-literals  -mno-text-section-literals @gol
1085 -mtarget-align  -mno-target-align @gol
1086 -mlongcalls  -mno-longcalls}
1088 @emph{zSeries Options}
1089 See S/390 and zSeries Options.
1091 @item Code Generation Options
1092 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1093 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1094 -ffixed-@var{reg}  -fexceptions @gol
1095 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1096 -fasynchronous-unwind-tables @gol
1097 -fno-gnu-unique @gol
1098 -finhibit-size-directive  -finstrument-functions @gol
1099 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1100 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1101 -fno-common  -fno-ident @gol
1102 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1103 -fno-jump-tables @gol
1104 -frecord-gcc-switches @gol
1105 -freg-struct-return  -fshort-enums @gol
1106 -fshort-double  -fshort-wchar @gol
1107 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1108 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1109 -fno-stack-limit -fsplit-stack @gol
1110 -fleading-underscore  -ftls-model=@var{model} @gol
1111 -fstack-reuse=@var{reuse_level} @gol
1112 -ftrapv  -fwrapv  -fbounds-check @gol
1113 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1114 @end table
1117 @node Overall Options
1118 @section Options Controlling the Kind of Output
1120 Compilation can involve up to four stages: preprocessing, compilation
1121 proper, assembly and linking, always in that order.  GCC is capable of
1122 preprocessing and compiling several files either into several
1123 assembler input files, or into one assembler input file; then each
1124 assembler input file produces an object file, and linking combines all
1125 the object files (those newly compiled, and those specified as input)
1126 into an executable file.
1128 @cindex file name suffix
1129 For any given input file, the file name suffix determines what kind of
1130 compilation is done:
1132 @table @gcctabopt
1133 @item @var{file}.c
1134 C source code that must be preprocessed.
1136 @item @var{file}.i
1137 C source code that should not be preprocessed.
1139 @item @var{file}.ii
1140 C++ source code that should not be preprocessed.
1142 @item @var{file}.m
1143 Objective-C source code.  Note that you must link with the @file{libobjc}
1144 library to make an Objective-C program work.
1146 @item @var{file}.mi
1147 Objective-C source code that should not be preprocessed.
1149 @item @var{file}.mm
1150 @itemx @var{file}.M
1151 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1152 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1153 to a literal capital M@.
1155 @item @var{file}.mii
1156 Objective-C++ source code that should not be preprocessed.
1158 @item @var{file}.h
1159 C, C++, Objective-C or Objective-C++ header file to be turned into a
1160 precompiled header (default), or C, C++ header file to be turned into an
1161 Ada spec (via the @option{-fdump-ada-spec} switch).
1163 @item @var{file}.cc
1164 @itemx @var{file}.cp
1165 @itemx @var{file}.cxx
1166 @itemx @var{file}.cpp
1167 @itemx @var{file}.CPP
1168 @itemx @var{file}.c++
1169 @itemx @var{file}.C
1170 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1171 the last two letters must both be literally @samp{x}.  Likewise,
1172 @samp{.C} refers to a literal capital C@.
1174 @item @var{file}.mm
1175 @itemx @var{file}.M
1176 Objective-C++ source code that must be preprocessed.
1178 @item @var{file}.mii
1179 Objective-C++ source code that should not be preprocessed.
1181 @item @var{file}.hh
1182 @itemx @var{file}.H
1183 @itemx @var{file}.hp
1184 @itemx @var{file}.hxx
1185 @itemx @var{file}.hpp
1186 @itemx @var{file}.HPP
1187 @itemx @var{file}.h++
1188 @itemx @var{file}.tcc
1189 C++ header file to be turned into a precompiled header or Ada spec.
1191 @item @var{file}.f
1192 @itemx @var{file}.for
1193 @itemx @var{file}.ftn
1194 Fixed form Fortran source code that should not be preprocessed.
1196 @item @var{file}.F
1197 @itemx @var{file}.FOR
1198 @itemx @var{file}.fpp
1199 @itemx @var{file}.FPP
1200 @itemx @var{file}.FTN
1201 Fixed form Fortran source code that must be preprocessed (with the traditional
1202 preprocessor).
1204 @item @var{file}.f90
1205 @itemx @var{file}.f95
1206 @itemx @var{file}.f03
1207 @itemx @var{file}.f08
1208 Free form Fortran source code that should not be preprocessed.
1210 @item @var{file}.F90
1211 @itemx @var{file}.F95
1212 @itemx @var{file}.F03
1213 @itemx @var{file}.F08
1214 Free form Fortran source code that must be preprocessed (with the
1215 traditional preprocessor).
1217 @item @var{file}.go
1218 Go source code.
1220 @c FIXME: Descriptions of Java file types.
1221 @c @var{file}.java
1222 @c @var{file}.class
1223 @c @var{file}.zip
1224 @c @var{file}.jar
1226 @item @var{file}.ads
1227 Ada source code file that contains a library unit declaration (a
1228 declaration of a package, subprogram, or generic, or a generic
1229 instantiation), or a library unit renaming declaration (a package,
1230 generic, or subprogram renaming declaration).  Such files are also
1231 called @dfn{specs}.
1233 @item @var{file}.adb
1234 Ada source code file containing a library unit body (a subprogram or
1235 package body).  Such files are also called @dfn{bodies}.
1237 @c GCC also knows about some suffixes for languages not yet included:
1238 @c Pascal:
1239 @c @var{file}.p
1240 @c @var{file}.pas
1241 @c Ratfor:
1242 @c @var{file}.r
1244 @item @var{file}.s
1245 Assembler code.
1247 @item @var{file}.S
1248 @itemx @var{file}.sx
1249 Assembler code that must be preprocessed.
1251 @item @var{other}
1252 An object file to be fed straight into linking.
1253 Any file name with no recognized suffix is treated this way.
1254 @end table
1256 @opindex x
1257 You can specify the input language explicitly with the @option{-x} option:
1259 @table @gcctabopt
1260 @item -x @var{language}
1261 Specify explicitly the @var{language} for the following input files
1262 (rather than letting the compiler choose a default based on the file
1263 name suffix).  This option applies to all following input files until
1264 the next @option{-x} option.  Possible values for @var{language} are:
1265 @smallexample
1266 c  c-header  cpp-output
1267 c++  c++-header  c++-cpp-output
1268 objective-c  objective-c-header  objective-c-cpp-output
1269 objective-c++ objective-c++-header objective-c++-cpp-output
1270 assembler  assembler-with-cpp
1272 f77  f77-cpp-input f95  f95-cpp-input
1274 java
1275 @end smallexample
1277 @item -x none
1278 Turn off any specification of a language, so that subsequent files are
1279 handled according to their file name suffixes (as they are if @option{-x}
1280 has not been used at all).
1282 @item -pass-exit-codes
1283 @opindex pass-exit-codes
1284 Normally the @command{gcc} program exits with the code of 1 if any
1285 phase of the compiler returns a non-success return code.  If you specify
1286 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1287 the numerically highest error produced by any phase returning an error
1288 indication.  The C, C++, and Fortran front ends return 4 if an internal
1289 compiler error is encountered.
1290 @end table
1292 If you only want some of the stages of compilation, you can use
1293 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1294 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1295 @command{gcc} is to stop.  Note that some combinations (for example,
1296 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1298 @table @gcctabopt
1299 @item -c
1300 @opindex c
1301 Compile or assemble the source files, but do not link.  The linking
1302 stage simply is not done.  The ultimate output is in the form of an
1303 object file for each source file.
1305 By default, the object file name for a source file is made by replacing
1306 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1308 Unrecognized input files, not requiring compilation or assembly, are
1309 ignored.
1311 @item -S
1312 @opindex S
1313 Stop after the stage of compilation proper; do not assemble.  The output
1314 is in the form of an assembler code file for each non-assembler input
1315 file specified.
1317 By default, the assembler file name for a source file is made by
1318 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1320 Input files that don't require compilation are ignored.
1322 @item -E
1323 @opindex E
1324 Stop after the preprocessing stage; do not run the compiler proper.  The
1325 output is in the form of preprocessed source code, which is sent to the
1326 standard output.
1328 Input files that don't require preprocessing are ignored.
1330 @cindex output file option
1331 @item -o @var{file}
1332 @opindex o
1333 Place output in file @var{file}.  This applies to whatever
1334 sort of output is being produced, whether it be an executable file,
1335 an object file, an assembler file or preprocessed C code.
1337 If @option{-o} is not specified, the default is to put an executable
1338 file in @file{a.out}, the object file for
1339 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1340 assembler file in @file{@var{source}.s}, a precompiled header file in
1341 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1342 standard output.
1344 @item -v
1345 @opindex v
1346 Print (on standard error output) the commands executed to run the stages
1347 of compilation.  Also print the version number of the compiler driver
1348 program and of the preprocessor and the compiler proper.
1350 @item -###
1351 @opindex ###
1352 Like @option{-v} except the commands are not executed and arguments
1353 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1354 This is useful for shell scripts to capture the driver-generated command lines.
1356 @item -pipe
1357 @opindex pipe
1358 Use pipes rather than temporary files for communication between the
1359 various stages of compilation.  This fails to work on some systems where
1360 the assembler is unable to read from a pipe; but the GNU assembler has
1361 no trouble.
1363 @item --help
1364 @opindex help
1365 Print (on the standard output) a description of the command-line options
1366 understood by @command{gcc}.  If the @option{-v} option is also specified
1367 then @option{--help} is also passed on to the various processes
1368 invoked by @command{gcc}, so that they can display the command-line options
1369 they accept.  If the @option{-Wextra} option has also been specified
1370 (prior to the @option{--help} option), then command-line options that
1371 have no documentation associated with them are also displayed.
1373 @item --target-help
1374 @opindex target-help
1375 Print (on the standard output) a description of target-specific command-line
1376 options for each tool.  For some targets extra target-specific
1377 information may also be printed.
1379 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1380 Print (on the standard output) a description of the command-line
1381 options understood by the compiler that fit into all specified classes
1382 and qualifiers.  These are the supported classes:
1384 @table @asis
1385 @item @samp{optimizers}
1386 Display all of the optimization options supported by the
1387 compiler.
1389 @item @samp{warnings}
1390 Display all of the options controlling warning messages
1391 produced by the compiler.
1393 @item @samp{target}
1394 Display target-specific options.  Unlike the
1395 @option{--target-help} option however, target-specific options of the
1396 linker and assembler are not displayed.  This is because those
1397 tools do not currently support the extended @option{--help=} syntax.
1399 @item @samp{params}
1400 Display the values recognized by the @option{--param}
1401 option.
1403 @item @var{language}
1404 Display the options supported for @var{language}, where
1405 @var{language} is the name of one of the languages supported in this
1406 version of GCC@.
1408 @item @samp{common}
1409 Display the options that are common to all languages.
1410 @end table
1412 These are the supported qualifiers:
1414 @table @asis
1415 @item @samp{undocumented}
1416 Display only those options that are undocumented.
1418 @item @samp{joined}
1419 Display options taking an argument that appears after an equal
1420 sign in the same continuous piece of text, such as:
1421 @samp{--help=target}.
1423 @item @samp{separate}
1424 Display options taking an argument that appears as a separate word
1425 following the original option, such as: @samp{-o output-file}.
1426 @end table
1428 Thus for example to display all the undocumented target-specific
1429 switches supported by the compiler, use:
1431 @smallexample
1432 --help=target,undocumented
1433 @end smallexample
1435 The sense of a qualifier can be inverted by prefixing it with the
1436 @samp{^} character, so for example to display all binary warning
1437 options (i.e., ones that are either on or off and that do not take an
1438 argument) that have a description, use:
1440 @smallexample
1441 --help=warnings,^joined,^undocumented
1442 @end smallexample
1444 The argument to @option{--help=} should not consist solely of inverted
1445 qualifiers.
1447 Combining several classes is possible, although this usually
1448 restricts the output so much that there is nothing to display.  One
1449 case where it does work, however, is when one of the classes is
1450 @var{target}.  For example, to display all the target-specific
1451 optimization options, use:
1453 @smallexample
1454 --help=target,optimizers
1455 @end smallexample
1457 The @option{--help=} option can be repeated on the command line.  Each
1458 successive use displays its requested class of options, skipping
1459 those that have already been displayed.
1461 If the @option{-Q} option appears on the command line before the
1462 @option{--help=} option, then the descriptive text displayed by
1463 @option{--help=} is changed.  Instead of describing the displayed
1464 options, an indication is given as to whether the option is enabled,
1465 disabled or set to a specific value (assuming that the compiler
1466 knows this at the point where the @option{--help=} option is used).
1468 Here is a truncated example from the ARM port of @command{gcc}:
1470 @smallexample
1471   % gcc -Q -mabi=2 --help=target -c
1472   The following options are target specific:
1473   -mabi=                                2
1474   -mabort-on-noreturn                   [disabled]
1475   -mapcs                                [disabled]
1476 @end smallexample
1478 The output is sensitive to the effects of previous command-line
1479 options, so for example it is possible to find out which optimizations
1480 are enabled at @option{-O2} by using:
1482 @smallexample
1483 -Q -O2 --help=optimizers
1484 @end smallexample
1486 Alternatively you can discover which binary optimizations are enabled
1487 by @option{-O3} by using:
1489 @smallexample
1490 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1491 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1492 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1493 @end smallexample
1495 @item -no-canonical-prefixes
1496 @opindex no-canonical-prefixes
1497 Do not expand any symbolic links, resolve references to @samp{/../}
1498 or @samp{/./}, or make the path absolute when generating a relative
1499 prefix.
1501 @item --version
1502 @opindex version
1503 Display the version number and copyrights of the invoked GCC@.
1505 @item -wrapper
1506 @opindex wrapper
1507 Invoke all subcommands under a wrapper program.  The name of the
1508 wrapper program and its parameters are passed as a comma separated
1509 list.
1511 @smallexample
1512 gcc -c t.c -wrapper gdb,--args
1513 @end smallexample
1515 @noindent
1516 This invokes all subprograms of @command{gcc} under
1517 @samp{gdb --args}, thus the invocation of @command{cc1} is
1518 @samp{gdb --args cc1 @dots{}}.
1520 @item -fplugin=@var{name}.so
1521 @opindex fplugin
1522 Load the plugin code in file @var{name}.so, assumed to be a
1523 shared object to be dlopen'd by the compiler.  The base name of
1524 the shared object file is used to identify the plugin for the
1525 purposes of argument parsing (See
1526 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1527 Each plugin should define the callback functions specified in the
1528 Plugins API.
1530 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1531 @opindex fplugin-arg
1532 Define an argument called @var{key} with a value of @var{value}
1533 for the plugin called @var{name}.
1535 @item -fdump-ada-spec@r{[}-slim@r{]}
1536 @opindex fdump-ada-spec
1537 For C and C++ source and include files, generate corresponding Ada specs.
1538 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1539 GNAT User's Guide}, which provides detailed documentation on this feature.
1541 @item -fada-spec-parent=@var{unit}
1542 @opindex fada-spec-parent
1543 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1544 Ada specs as child units of parent @var{unit}.
1546 @item -fdump-go-spec=@var{file}
1547 @opindex fdump-go-spec
1548 For input files in any language, generate corresponding Go
1549 declarations in @var{file}.  This generates Go @code{const},
1550 @code{type}, @code{var}, and @code{func} declarations which may be a
1551 useful way to start writing a Go interface to code written in some
1552 other language.
1554 @include @value{srcdir}/../libiberty/at-file.texi
1555 @end table
1557 @node Invoking G++
1558 @section Compiling C++ Programs
1560 @cindex suffixes for C++ source
1561 @cindex C++ source file suffixes
1562 C++ source files conventionally use one of the suffixes @samp{.C},
1563 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1564 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1565 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1566 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1567 files with these names and compiles them as C++ programs even if you
1568 call the compiler the same way as for compiling C programs (usually
1569 with the name @command{gcc}).
1571 @findex g++
1572 @findex c++
1573 However, the use of @command{gcc} does not add the C++ library.
1574 @command{g++} is a program that calls GCC and automatically specifies linking
1575 against the C++ library.  It treats @samp{.c},
1576 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1577 files unless @option{-x} is used.  This program is also useful when
1578 precompiling a C header file with a @samp{.h} extension for use in C++
1579 compilations.  On many systems, @command{g++} is also installed with
1580 the name @command{c++}.
1582 @cindex invoking @command{g++}
1583 When you compile C++ programs, you may specify many of the same
1584 command-line options that you use for compiling programs in any
1585 language; or command-line options meaningful for C and related
1586 languages; or options that are meaningful only for C++ programs.
1587 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1588 explanations of options for languages related to C@.
1589 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1590 explanations of options that are meaningful only for C++ programs.
1592 @node C Dialect Options
1593 @section Options Controlling C Dialect
1594 @cindex dialect options
1595 @cindex language dialect options
1596 @cindex options, dialect
1598 The following options control the dialect of C (or languages derived
1599 from C, such as C++, Objective-C and Objective-C++) that the compiler
1600 accepts:
1602 @table @gcctabopt
1603 @cindex ANSI support
1604 @cindex ISO support
1605 @item -ansi
1606 @opindex ansi
1607 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1608 equivalent to @option{-std=c++98}.
1610 This turns off certain features of GCC that are incompatible with ISO
1611 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1612 such as the @code{asm} and @code{typeof} keywords, and
1613 predefined macros such as @code{unix} and @code{vax} that identify the
1614 type of system you are using.  It also enables the undesirable and
1615 rarely used ISO trigraph feature.  For the C compiler,
1616 it disables recognition of C++ style @samp{//} comments as well as
1617 the @code{inline} keyword.
1619 The alternate keywords @code{__asm__}, @code{__extension__},
1620 @code{__inline__} and @code{__typeof__} continue to work despite
1621 @option{-ansi}.  You would not want to use them in an ISO C program, of
1622 course, but it is useful to put them in header files that might be included
1623 in compilations done with @option{-ansi}.  Alternate predefined macros
1624 such as @code{__unix__} and @code{__vax__} are also available, with or
1625 without @option{-ansi}.
1627 The @option{-ansi} option does not cause non-ISO programs to be
1628 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1629 addition to @option{-ansi}.  @xref{Warning Options}.
1631 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1632 option is used.  Some header files may notice this macro and refrain
1633 from declaring certain functions or defining certain macros that the
1634 ISO standard doesn't call for; this is to avoid interfering with any
1635 programs that might use these names for other things.
1637 Functions that are normally built in but do not have semantics
1638 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1639 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1640 built-in functions provided by GCC}, for details of the functions
1641 affected.
1643 @item -std=
1644 @opindex std
1645 Determine the language standard. @xref{Standards,,Language Standards
1646 Supported by GCC}, for details of these standard versions.  This option
1647 is currently only supported when compiling C or C++.
1649 The compiler can accept several base standards, such as @samp{c90} or
1650 @samp{c++98}, and GNU dialects of those standards, such as
1651 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1652 compiler accepts all programs following that standard plus those
1653 using GNU extensions that do not contradict it.  For example,
1654 @option{-std=c90} turns off certain features of GCC that are
1655 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1656 keywords, but not other GNU extensions that do not have a meaning in
1657 ISO C90, such as omitting the middle term of a @code{?:}
1658 expression. On the other hand, when a GNU dialect of a standard is
1659 specified, all features supported by the compiler are enabled, even when
1660 those features change the meaning of the base standard.  As a result, some
1661 strict-conforming programs may be rejected.  The particular standard
1662 is used by @option{-Wpedantic} to identify which features are GNU
1663 extensions given that version of the standard. For example
1664 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1665 comments, while @option{-std=gnu99 -Wpedantic} does not.
1667 A value for this option must be provided; possible values are
1669 @table @samp
1670 @item c90
1671 @itemx c89
1672 @itemx iso9899:1990
1673 Support all ISO C90 programs (certain GNU extensions that conflict
1674 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1676 @item iso9899:199409
1677 ISO C90 as modified in amendment 1.
1679 @item c99
1680 @itemx c9x
1681 @itemx iso9899:1999
1682 @itemx iso9899:199x
1683 ISO C99.  This standard is substantially completely supported, modulo
1684 bugs and floating-point issues
1685 (mainly but not entirely relating to optional C99 features from
1686 Annexes F and G).  See
1687 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1688 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1690 @item c11
1691 @itemx c1x
1692 @itemx iso9899:2011
1693 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1694 substantially completely supported, modulo bugs, floating-point issues
1695 (mainly but not entirely relating to optional C11 features from
1696 Annexes F and G) and the optional Annexes K (Bounds-checking
1697 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1699 @item gnu90
1700 @itemx gnu89
1701 GNU dialect of ISO C90 (including some C99 features).
1703 @item gnu99
1704 @itemx gnu9x
1705 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1707 @item gnu11
1708 @itemx gnu1x
1709 GNU dialect of ISO C11.  This is the default for C code.
1710 The name @samp{gnu1x} is deprecated.
1712 @item c++98
1713 @itemx c++03
1714 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1715 additional defect reports. Same as @option{-ansi} for C++ code.
1717 @item gnu++98
1718 @itemx gnu++03
1719 GNU dialect of @option{-std=c++98}.  This is the default for
1720 C++ code.
1722 @item c++11
1723 @itemx c++0x
1724 The 2011 ISO C++ standard plus amendments.
1725 The name @samp{c++0x} is deprecated.
1727 @item gnu++11
1728 @itemx gnu++0x
1729 GNU dialect of @option{-std=c++11}.
1730 The name @samp{gnu++0x} is deprecated.
1732 @item c++14
1733 @itemx c++1y
1734 The 2014 ISO C++ standard plus amendments.
1735 The name @samp{c++1y} is deprecated.
1737 @item gnu++14
1738 @itemx gnu++1y
1739 GNU dialect of @option{-std=c++14}.
1740 The name @samp{gnu++1y} is deprecated.
1742 @item c++1z
1743 The next revision of the ISO C++ standard, tentatively planned for
1744 2017.  Support is highly experimental, and will almost certainly
1745 change in incompatible ways in future releases.
1747 @item gnu++1z
1748 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1749 and will almost certainly change in incompatible ways in future
1750 releases.
1751 @end table
1753 @item -fgnu89-inline
1754 @opindex fgnu89-inline
1755 The option @option{-fgnu89-inline} tells GCC to use the traditional
1756 GNU semantics for @code{inline} functions when in C99 mode.
1757 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1758 is accepted and ignored by GCC versions 4.1.3 up to but not including
1759 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1760 C99 mode.  Using this option is roughly equivalent to adding the
1761 @code{gnu_inline} function attribute to all inline functions
1762 (@pxref{Function Attributes}).
1764 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1765 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1766 specifies the default behavior).  This option was first supported in
1767 GCC 4.3.  This option is not supported in @option{-std=c90} or
1768 @option{-std=gnu90} mode.
1770 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1771 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1772 in effect for @code{inline} functions.  @xref{Common Predefined
1773 Macros,,,cpp,The C Preprocessor}.
1775 @item -aux-info @var{filename}
1776 @opindex aux-info
1777 Output to the given filename prototyped declarations for all functions
1778 declared and/or defined in a translation unit, including those in header
1779 files.  This option is silently ignored in any language other than C@.
1781 Besides declarations, the file indicates, in comments, the origin of
1782 each declaration (source file and line), whether the declaration was
1783 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1784 @samp{O} for old, respectively, in the first character after the line
1785 number and the colon), and whether it came from a declaration or a
1786 definition (@samp{C} or @samp{F}, respectively, in the following
1787 character).  In the case of function definitions, a K&R-style list of
1788 arguments followed by their declarations is also provided, inside
1789 comments, after the declaration.
1791 @item -fallow-parameterless-variadic-functions
1792 @opindex fallow-parameterless-variadic-functions
1793 Accept variadic functions without named parameters.
1795 Although it is possible to define such a function, this is not very
1796 useful as it is not possible to read the arguments.  This is only
1797 supported for C as this construct is allowed by C++.
1799 @item -fno-asm
1800 @opindex fno-asm
1801 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1802 keyword, so that code can use these words as identifiers.  You can use
1803 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1804 instead.  @option{-ansi} implies @option{-fno-asm}.
1806 In C++, this switch only affects the @code{typeof} keyword, since
1807 @code{asm} and @code{inline} are standard keywords.  You may want to
1808 use the @option{-fno-gnu-keywords} flag instead, which has the same
1809 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1810 switch only affects the @code{asm} and @code{typeof} keywords, since
1811 @code{inline} is a standard keyword in ISO C99.
1813 @item -fno-builtin
1814 @itemx -fno-builtin-@var{function}
1815 @opindex fno-builtin
1816 @cindex built-in functions
1817 Don't recognize built-in functions that do not begin with
1818 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1819 functions provided by GCC}, for details of the functions affected,
1820 including those which are not built-in functions when @option{-ansi} or
1821 @option{-std} options for strict ISO C conformance are used because they
1822 do not have an ISO standard meaning.
1824 GCC normally generates special code to handle certain built-in functions
1825 more efficiently; for instance, calls to @code{alloca} may become single
1826 instructions which adjust the stack directly, and calls to @code{memcpy}
1827 may become inline copy loops.  The resulting code is often both smaller
1828 and faster, but since the function calls no longer appear as such, you
1829 cannot set a breakpoint on those calls, nor can you change the behavior
1830 of the functions by linking with a different library.  In addition,
1831 when a function is recognized as a built-in function, GCC may use
1832 information about that function to warn about problems with calls to
1833 that function, or to generate more efficient code, even if the
1834 resulting code still contains calls to that function.  For example,
1835 warnings are given with @option{-Wformat} for bad calls to
1836 @code{printf} when @code{printf} is built in and @code{strlen} is
1837 known not to modify global memory.
1839 With the @option{-fno-builtin-@var{function}} option
1840 only the built-in function @var{function} is
1841 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1842 function is named that is not built-in in this version of GCC, this
1843 option is ignored.  There is no corresponding
1844 @option{-fbuiltin-@var{function}} option; if you wish to enable
1845 built-in functions selectively when using @option{-fno-builtin} or
1846 @option{-ffreestanding}, you may define macros such as:
1848 @smallexample
1849 #define abs(n)          __builtin_abs ((n))
1850 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1851 @end smallexample
1853 @item -fhosted
1854 @opindex fhosted
1855 @cindex hosted environment
1857 Assert that compilation targets a hosted environment.  This implies
1858 @option{-fbuiltin}.  A hosted environment is one in which the
1859 entire standard library is available, and in which @code{main} has a return
1860 type of @code{int}.  Examples are nearly everything except a kernel.
1861 This is equivalent to @option{-fno-freestanding}.
1863 @item -ffreestanding
1864 @opindex ffreestanding
1865 @cindex hosted environment
1867 Assert that compilation targets a freestanding environment.  This
1868 implies @option{-fno-builtin}.  A freestanding environment
1869 is one in which the standard library may not exist, and program startup may
1870 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1871 This is equivalent to @option{-fno-hosted}.
1873 @xref{Standards,,Language Standards Supported by GCC}, for details of
1874 freestanding and hosted environments.
1876 @item -fopenacc
1877 @opindex fopenacc
1878 @cindex OpenACC accelerator programming
1879 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1880 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1881 compiler generates accelerated code according to the OpenACC Application
1882 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1883 implies @option{-pthread}, and thus is only supported on targets that
1884 have support for @option{-pthread}.
1886 @item -fopenmp
1887 @opindex fopenmp
1888 @cindex OpenMP parallel
1889 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1890 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1891 compiler generates parallel code according to the OpenMP Application
1892 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1893 implies @option{-pthread}, and thus is only supported on targets that
1894 have support for @option{-pthread}. @option{-fopenmp} implies
1895 @option{-fopenmp-simd}.
1897 @item -fopenmp-simd
1898 @opindex fopenmp-simd
1899 @cindex OpenMP SIMD
1900 @cindex SIMD
1901 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1902 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1903 are ignored.
1905 @item -fcilkplus
1906 @opindex fcilkplus
1907 @cindex Enable Cilk Plus
1908 Enable the usage of Cilk Plus language extension features for C/C++.
1909 When the option @option{-fcilkplus} is specified, enable the usage of
1910 the Cilk Plus Language extension features for C/C++.  The present
1911 implementation follows ABI version 1.2.  This is an experimental
1912 feature that is only partially complete, and whose interface may
1913 change in future versions of GCC as the official specification
1914 changes.  Currently, all features but @code{_Cilk_for} have been
1915 implemented.
1917 @item -fgnu-tm
1918 @opindex fgnu-tm
1919 When the option @option{-fgnu-tm} is specified, the compiler
1920 generates code for the Linux variant of Intel's current Transactional
1921 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1922 an experimental feature whose interface may change in future versions
1923 of GCC, as the official specification changes.  Please note that not
1924 all architectures are supported for this feature.
1926 For more information on GCC's support for transactional memory,
1927 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1928 Transactional Memory Library}.
1930 Note that the transactional memory feature is not supported with
1931 non-call exceptions (@option{-fnon-call-exceptions}).
1933 @item -fms-extensions
1934 @opindex fms-extensions
1935 Accept some non-standard constructs used in Microsoft header files.
1937 In C++ code, this allows member names in structures to be similar
1938 to previous types declarations.
1940 @smallexample
1941 typedef int UOW;
1942 struct ABC @{
1943   UOW UOW;
1945 @end smallexample
1947 Some cases of unnamed fields in structures and unions are only
1948 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1949 fields within structs/unions}, for details.
1951 Note that this option is off for all targets but i?86 and x86_64
1952 targets using ms-abi.
1953 @item -fplan9-extensions
1954 Accept some non-standard constructs used in Plan 9 code.
1956 This enables @option{-fms-extensions}, permits passing pointers to
1957 structures with anonymous fields to functions that expect pointers to
1958 elements of the type of the field, and permits referring to anonymous
1959 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1960 struct/union fields within structs/unions}, for details.  This is only
1961 supported for C, not C++.
1963 @item -trigraphs
1964 @opindex trigraphs
1965 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1966 options for strict ISO C conformance) implies @option{-trigraphs}.
1968 @cindex traditional C language
1969 @cindex C language, traditional
1970 @item -traditional
1971 @itemx -traditional-cpp
1972 @opindex traditional-cpp
1973 @opindex traditional
1974 Formerly, these options caused GCC to attempt to emulate a pre-standard
1975 C compiler.  They are now only supported with the @option{-E} switch.
1976 The preprocessor continues to support a pre-standard mode.  See the GNU
1977 CPP manual for details.
1979 @item -fcond-mismatch
1980 @opindex fcond-mismatch
1981 Allow conditional expressions with mismatched types in the second and
1982 third arguments.  The value of such an expression is void.  This option
1983 is not supported for C++.
1985 @item -flax-vector-conversions
1986 @opindex flax-vector-conversions
1987 Allow implicit conversions between vectors with differing numbers of
1988 elements and/or incompatible element types.  This option should not be
1989 used for new code.
1991 @item -funsigned-char
1992 @opindex funsigned-char
1993 Let the type @code{char} be unsigned, like @code{unsigned char}.
1995 Each kind of machine has a default for what @code{char} should
1996 be.  It is either like @code{unsigned char} by default or like
1997 @code{signed char} by default.
1999 Ideally, a portable program should always use @code{signed char} or
2000 @code{unsigned char} when it depends on the signedness of an object.
2001 But many programs have been written to use plain @code{char} and
2002 expect it to be signed, or expect it to be unsigned, depending on the
2003 machines they were written for.  This option, and its inverse, let you
2004 make such a program work with the opposite default.
2006 The type @code{char} is always a distinct type from each of
2007 @code{signed char} or @code{unsigned char}, even though its behavior
2008 is always just like one of those two.
2010 @item -fsigned-char
2011 @opindex fsigned-char
2012 Let the type @code{char} be signed, like @code{signed char}.
2014 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2015 the negative form of @option{-funsigned-char}.  Likewise, the option
2016 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2018 @item -fsigned-bitfields
2019 @itemx -funsigned-bitfields
2020 @itemx -fno-signed-bitfields
2021 @itemx -fno-unsigned-bitfields
2022 @opindex fsigned-bitfields
2023 @opindex funsigned-bitfields
2024 @opindex fno-signed-bitfields
2025 @opindex fno-unsigned-bitfields
2026 These options control whether a bit-field is signed or unsigned, when the
2027 declaration does not use either @code{signed} or @code{unsigned}.  By
2028 default, such a bit-field is signed, because this is consistent: the
2029 basic integer types such as @code{int} are signed types.
2030 @end table
2032 @node C++ Dialect Options
2033 @section Options Controlling C++ Dialect
2035 @cindex compiler options, C++
2036 @cindex C++ options, command-line
2037 @cindex options, C++
2038 This section describes the command-line options that are only meaningful
2039 for C++ programs.  You can also use most of the GNU compiler options
2040 regardless of what language your program is in.  For example, you
2041 might compile a file @code{firstClass.C} like this:
2043 @smallexample
2044 g++ -g -frepo -O -c firstClass.C
2045 @end smallexample
2047 @noindent
2048 In this example, only @option{-frepo} is an option meant
2049 only for C++ programs; you can use the other options with any
2050 language supported by GCC@.
2052 Here is a list of options that are @emph{only} for compiling C++ programs:
2054 @table @gcctabopt
2056 @item -fabi-version=@var{n}
2057 @opindex fabi-version
2058 Use version @var{n} of the C++ ABI@.  The default is version 0.
2060 Version 0 refers to the version conforming most closely to
2061 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2062 will change in different versions of G++ as ABI bugs are fixed.
2064 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2066 Version 2 is the version of the C++ ABI that first appeared in G++
2067 3.4, and was the default through G++ 4.9.
2069 Version 3 corrects an error in mangling a constant address as a
2070 template argument.
2072 Version 4, which first appeared in G++ 4.5, implements a standard
2073 mangling for vector types.
2075 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2076 attribute const/volatile on function pointer types, decltype of a
2077 plain decl, and use of a function parameter in the declaration of
2078 another parameter.
2080 Version 6, which first appeared in G++ 4.7, corrects the promotion
2081 behavior of C++11 scoped enums and the mangling of template argument
2082 packs, const/static_cast, prefix ++ and --, and a class scope function
2083 used as a template argument.
2085 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2086 builtin type and corrects the mangling of lambdas in default argument
2087 scope.
2089 Version 8, which first appeared in G++ 4.9, corrects the substitution
2090 behavior of function types with function-cv-qualifiers.
2092 See also @option{-Wabi}.
2094 @item -fabi-compat-version=@var{n}
2095 @opindex fabi-compat-version
2096 Starting with GCC 4.5, on targets that support strong aliases, G++
2097 works around mangling changes by creating an alias with the correct
2098 mangled name when defining a symbol with an incorrect mangled name.
2099 This switch specifies which ABI version to use for the alias.
2101 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2102 another ABI version is explicitly selected, this defaults to 0.
2104 The compatibility version is also set by @option{-Wabi=@var{n}}.
2106 @item -fno-access-control
2107 @opindex fno-access-control
2108 Turn off all access checking.  This switch is mainly useful for working
2109 around bugs in the access control code.
2111 @item -fcheck-new
2112 @opindex fcheck-new
2113 Check that the pointer returned by @code{operator new} is non-null
2114 before attempting to modify the storage allocated.  This check is
2115 normally unnecessary because the C++ standard specifies that
2116 @code{operator new} only returns @code{0} if it is declared
2117 @samp{throw()}, in which case the compiler always checks the
2118 return value even without this option.  In all other cases, when
2119 @code{operator new} has a non-empty exception specification, memory
2120 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2121 @samp{new (nothrow)}.
2123 @item -fconstexpr-depth=@var{n}
2124 @opindex fconstexpr-depth
2125 Set the maximum nested evaluation depth for C++11 constexpr functions
2126 to @var{n}.  A limit is needed to detect endless recursion during
2127 constant expression evaluation.  The minimum specified by the standard
2128 is 512.
2130 @item -fdeduce-init-list
2131 @opindex fdeduce-init-list
2132 Enable deduction of a template type parameter as
2133 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2135 @smallexample
2136 template <class T> auto forward(T t) -> decltype (realfn (t))
2138   return realfn (t);
2141 void f()
2143   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2145 @end smallexample
2147 This deduction was implemented as a possible extension to the
2148 originally proposed semantics for the C++11 standard, but was not part
2149 of the final standard, so it is disabled by default.  This option is
2150 deprecated, and may be removed in a future version of G++.
2152 @item -ffriend-injection
2153 @opindex ffriend-injection
2154 Inject friend functions into the enclosing namespace, so that they are
2155 visible outside the scope of the class in which they are declared.
2156 Friend functions were documented to work this way in the old Annotated
2157 C++ Reference Manual, and versions of G++ before 4.1 always worked
2158 that way.  However, in ISO C++ a friend function that is not declared
2159 in an enclosing scope can only be found using argument dependent
2160 lookup.  This option causes friends to be injected as they were in
2161 earlier releases.
2163 This option is for compatibility, and may be removed in a future
2164 release of G++.
2166 @item -fno-elide-constructors
2167 @opindex fno-elide-constructors
2168 The C++ standard allows an implementation to omit creating a temporary
2169 that is only used to initialize another object of the same type.
2170 Specifying this option disables that optimization, and forces G++ to
2171 call the copy constructor in all cases.
2173 @item -fno-enforce-eh-specs
2174 @opindex fno-enforce-eh-specs
2175 Don't generate code to check for violation of exception specifications
2176 at run time.  This option violates the C++ standard, but may be useful
2177 for reducing code size in production builds, much like defining
2178 @samp{NDEBUG}.  This does not give user code permission to throw
2179 exceptions in violation of the exception specifications; the compiler
2180 still optimizes based on the specifications, so throwing an
2181 unexpected exception results in undefined behavior at run time.
2183 @item -fextern-tls-init
2184 @itemx -fno-extern-tls-init
2185 @opindex fextern-tls-init
2186 @opindex fno-extern-tls-init
2187 The C++11 and OpenMP standards allow @samp{thread_local} and
2188 @samp{threadprivate} variables to have dynamic (runtime)
2189 initialization.  To support this, any use of such a variable goes
2190 through a wrapper function that performs any necessary initialization.
2191 When the use and definition of the variable are in the same
2192 translation unit, this overhead can be optimized away, but when the
2193 use is in a different translation unit there is significant overhead
2194 even if the variable doesn't actually need dynamic initialization.  If
2195 the programmer can be sure that no use of the variable in a
2196 non-defining TU needs to trigger dynamic initialization (either
2197 because the variable is statically initialized, or a use of the
2198 variable in the defining TU will be executed before any uses in
2199 another TU), they can avoid this overhead with the
2200 @option{-fno-extern-tls-init} option.
2202 On targets that support symbol aliases, the default is
2203 @option{-fextern-tls-init}.  On targets that do not support symbol
2204 aliases, the default is @option{-fno-extern-tls-init}.
2206 @item -ffor-scope
2207 @itemx -fno-for-scope
2208 @opindex ffor-scope
2209 @opindex fno-for-scope
2210 If @option{-ffor-scope} is specified, the scope of variables declared in
2211 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2212 as specified by the C++ standard.
2213 If @option{-fno-for-scope} is specified, the scope of variables declared in
2214 a @i{for-init-statement} extends to the end of the enclosing scope,
2215 as was the case in old versions of G++, and other (traditional)
2216 implementations of C++.
2218 If neither flag is given, the default is to follow the standard,
2219 but to allow and give a warning for old-style code that would
2220 otherwise be invalid, or have different behavior.
2222 @item -fno-gnu-keywords
2223 @opindex fno-gnu-keywords
2224 Do not recognize @code{typeof} as a keyword, so that code can use this
2225 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2226 @option{-ansi} implies @option{-fno-gnu-keywords}.
2228 @item -fno-implicit-templates
2229 @opindex fno-implicit-templates
2230 Never emit code for non-inline templates that are instantiated
2231 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2232 @xref{Template Instantiation}, for more information.
2234 @item -fno-implicit-inline-templates
2235 @opindex fno-implicit-inline-templates
2236 Don't emit code for implicit instantiations of inline templates, either.
2237 The default is to handle inlines differently so that compiles with and
2238 without optimization need the same set of explicit instantiations.
2240 @item -fno-implement-inlines
2241 @opindex fno-implement-inlines
2242 To save space, do not emit out-of-line copies of inline functions
2243 controlled by @samp{#pragma implementation}.  This causes linker
2244 errors if these functions are not inlined everywhere they are called.
2246 @item -fms-extensions
2247 @opindex fms-extensions
2248 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2249 int and getting a pointer to member function via non-standard syntax.
2251 @item -fno-nonansi-builtins
2252 @opindex fno-nonansi-builtins
2253 Disable built-in declarations of functions that are not mandated by
2254 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2255 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2257 @item -fnothrow-opt
2258 @opindex fnothrow-opt
2259 Treat a @code{throw()} exception specification as if it were a
2260 @code{noexcept} specification to reduce or eliminate the text size
2261 overhead relative to a function with no exception specification.  If
2262 the function has local variables of types with non-trivial
2263 destructors, the exception specification actually makes the
2264 function smaller because the EH cleanups for those variables can be
2265 optimized away.  The semantic effect is that an exception thrown out of
2266 a function with such an exception specification results in a call
2267 to @code{terminate} rather than @code{unexpected}.
2269 @item -fno-operator-names
2270 @opindex fno-operator-names
2271 Do not treat the operator name keywords @code{and}, @code{bitand},
2272 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2273 synonyms as keywords.
2275 @item -fno-optional-diags
2276 @opindex fno-optional-diags
2277 Disable diagnostics that the standard says a compiler does not need to
2278 issue.  Currently, the only such diagnostic issued by G++ is the one for
2279 a name having multiple meanings within a class.
2281 @item -fpermissive
2282 @opindex fpermissive
2283 Downgrade some diagnostics about nonconformant code from errors to
2284 warnings.  Thus, using @option{-fpermissive} allows some
2285 nonconforming code to compile.
2287 @item -fno-pretty-templates
2288 @opindex fno-pretty-templates
2289 When an error message refers to a specialization of a function
2290 template, the compiler normally prints the signature of the
2291 template followed by the template arguments and any typedefs or
2292 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2293 rather than @code{void f(int)}) so that it's clear which template is
2294 involved.  When an error message refers to a specialization of a class
2295 template, the compiler omits any template arguments that match
2296 the default template arguments for that template.  If either of these
2297 behaviors make it harder to understand the error message rather than
2298 easier, you can use @option{-fno-pretty-templates} to disable them.
2300 @item -frepo
2301 @opindex frepo
2302 Enable automatic template instantiation at link time.  This option also
2303 implies @option{-fno-implicit-templates}.  @xref{Template
2304 Instantiation}, for more information.
2306 @item -fno-rtti
2307 @opindex fno-rtti
2308 Disable generation of information about every class with virtual
2309 functions for use by the C++ run-time type identification features
2310 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2311 of the language, you can save some space by using this flag.  Note that
2312 exception handling uses the same information, but G++ generates it as
2313 needed. The @samp{dynamic_cast} operator can still be used for casts that
2314 do not require run-time type information, i.e.@: casts to @code{void *} or to
2315 unambiguous base classes.
2317 @item -fstats
2318 @opindex fstats
2319 Emit statistics about front-end processing at the end of the compilation.
2320 This information is generally only useful to the G++ development team.
2322 @item -fstrict-enums
2323 @opindex fstrict-enums
2324 Allow the compiler to optimize using the assumption that a value of
2325 enumerated type can only be one of the values of the enumeration (as
2326 defined in the C++ standard; basically, a value that can be
2327 represented in the minimum number of bits needed to represent all the
2328 enumerators).  This assumption may not be valid if the program uses a
2329 cast to convert an arbitrary integer value to the enumerated type.
2331 @item -ftemplate-backtrace-limit=@var{n}
2332 @opindex ftemplate-backtrace-limit
2333 Set the maximum number of template instantiation notes for a single
2334 warning or error to @var{n}.  The default value is 10.
2336 @item -ftemplate-depth=@var{n}
2337 @opindex ftemplate-depth
2338 Set the maximum instantiation depth for template classes to @var{n}.
2339 A limit on the template instantiation depth is needed to detect
2340 endless recursions during template class instantiation.  ANSI/ISO C++
2341 conforming programs must not rely on a maximum depth greater than 17
2342 (changed to 1024 in C++11).  The default value is 900, as the compiler
2343 can run out of stack space before hitting 1024 in some situations.
2345 @item -fno-threadsafe-statics
2346 @opindex fno-threadsafe-statics
2347 Do not emit the extra code to use the routines specified in the C++
2348 ABI for thread-safe initialization of local statics.  You can use this
2349 option to reduce code size slightly in code that doesn't need to be
2350 thread-safe.
2352 @item -fuse-cxa-atexit
2353 @opindex fuse-cxa-atexit
2354 Register destructors for objects with static storage duration with the
2355 @code{__cxa_atexit} function rather than the @code{atexit} function.
2356 This option is required for fully standards-compliant handling of static
2357 destructors, but only works if your C library supports
2358 @code{__cxa_atexit}.
2360 @item -fno-use-cxa-get-exception-ptr
2361 @opindex fno-use-cxa-get-exception-ptr
2362 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2363 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2364 if the runtime routine is not available.
2366 @item -fvisibility-inlines-hidden
2367 @opindex fvisibility-inlines-hidden
2368 This switch declares that the user does not attempt to compare
2369 pointers to inline functions or methods where the addresses of the two functions
2370 are taken in different shared objects.
2372 The effect of this is that GCC may, effectively, mark inline methods with
2373 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2374 appear in the export table of a DSO and do not require a PLT indirection
2375 when used within the DSO@.  Enabling this option can have a dramatic effect
2376 on load and link times of a DSO as it massively reduces the size of the
2377 dynamic export table when the library makes heavy use of templates.
2379 The behavior of this switch is not quite the same as marking the
2380 methods as hidden directly, because it does not affect static variables
2381 local to the function or cause the compiler to deduce that
2382 the function is defined in only one shared object.
2384 You may mark a method as having a visibility explicitly to negate the
2385 effect of the switch for that method.  For example, if you do want to
2386 compare pointers to a particular inline method, you might mark it as
2387 having default visibility.  Marking the enclosing class with explicit
2388 visibility has no effect.
2390 Explicitly instantiated inline methods are unaffected by this option
2391 as their linkage might otherwise cross a shared library boundary.
2392 @xref{Template Instantiation}.
2394 @item -fvisibility-ms-compat
2395 @opindex fvisibility-ms-compat
2396 This flag attempts to use visibility settings to make GCC's C++
2397 linkage model compatible with that of Microsoft Visual Studio.
2399 The flag makes these changes to GCC's linkage model:
2401 @enumerate
2402 @item
2403 It sets the default visibility to @code{hidden}, like
2404 @option{-fvisibility=hidden}.
2406 @item
2407 Types, but not their members, are not hidden by default.
2409 @item
2410 The One Definition Rule is relaxed for types without explicit
2411 visibility specifications that are defined in more than one
2412 shared object: those declarations are permitted if they are
2413 permitted when this option is not used.
2414 @end enumerate
2416 In new code it is better to use @option{-fvisibility=hidden} and
2417 export those classes that are intended to be externally visible.
2418 Unfortunately it is possible for code to rely, perhaps accidentally,
2419 on the Visual Studio behavior.
2421 Among the consequences of these changes are that static data members
2422 of the same type with the same name but defined in different shared
2423 objects are different, so changing one does not change the other;
2424 and that pointers to function members defined in different shared
2425 objects may not compare equal.  When this flag is given, it is a
2426 violation of the ODR to define types with the same name differently.
2428 @item -fvtable-verify=@var{std|preinit|none}
2429 @opindex fvtable-verify
2430 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2431 feature that verifies at runtime, for every virtual call that is made, that
2432 the vtable pointer through which the call is made is valid for the type of
2433 the object, and has not been corrupted or overwritten.  If an invalid vtable
2434 pointer is detected (at runtime), an error is reported and execution of the
2435 program is immediately halted.
2437 This option causes runtime data structures to be built, at program start up,
2438 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2439 control the timing of when these data structures are built.  In both cases the
2440 data structures are built before execution reaches 'main'.  The
2441 @option{-fvtable-verify=std} causes these data structure to be built after the
2442 shared libraries have been loaded and initialized.
2443 @option{-fvtable-verify=preinit} causes them to be built before the shared
2444 libraries have been loaded and initialized.
2446 If this option appears multiple times in the compiler line, with different
2447 values specified, 'none' will take highest priority over both 'std' and
2448 'preinit'; 'preinit' will take priority over 'std'.
2450 @item -fvtv-debug
2451 @opindex (fvtv-debug)
2452 Causes debug versions of the runtime functions for the vtable verification 
2453 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2454 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2455 compiler to keep track of which vtable pointers it found for each class, and
2456 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2457 file directory on the user's machine.
2459 Note:  This feature APPENDS data to the log file. If you want a fresh log
2460 file, be sure to delete any existing one.
2462 @item -fvtv-counts
2463 @opindex fvtv-counts
2464 This is a debugging flag.  When used in conjunction with
2465 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2466 causes the compiler to keep track of the total number of virtual calls
2467 it encountered and the number of verifications it inserted.  It also
2468 counts the number of calls to certain runtime library functions
2469 that it inserts.  This information, for each compilation unit, is written
2470 to a file named ``vtv_count_data.log'', in the dump_file directory on
2471 the user's machine.   It also counts the size of the vtable pointer sets
2472 for each class, and writes this information to ``vtv_class_set_sizes.log''
2473 in the same directory.
2475 Note:  This feature APPENDS data to the log files.  To get a fresh log
2476 files, be sure to delete any existing ones.
2478 @item -fno-weak
2479 @opindex fno-weak
2480 Do not use weak symbol support, even if it is provided by the linker.
2481 By default, G++ uses weak symbols if they are available.  This
2482 option exists only for testing, and should not be used by end-users;
2483 it results in inferior code and has no benefits.  This option may
2484 be removed in a future release of G++.
2486 @item -nostdinc++
2487 @opindex nostdinc++
2488 Do not search for header files in the standard directories specific to
2489 C++, but do still search the other standard directories.  (This option
2490 is used when building the C++ library.)
2491 @end table
2493 In addition, these optimization, warning, and code generation options
2494 have meanings only for C++ programs:
2496 @table @gcctabopt
2497 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2498 @opindex Wabi
2499 @opindex Wno-abi
2500 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2501 G++ to warn when it generates code that is probably not compatible with the
2502 vendor-neutral C++ ABI@.  Since G++ now defaults to
2503 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2504 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2505 or an older compatibility version is selected (with
2506 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2508 Although an effort has been made to warn about
2509 all such cases, there are probably some cases that are not warned about,
2510 even though G++ is generating incompatible code.  There may also be
2511 cases where warnings are emitted even though the code that is generated
2512 is compatible.
2514 You should rewrite your code to avoid these warnings if you are
2515 concerned about the fact that code generated by G++ may not be binary
2516 compatible with code generated by other compilers.
2518 @option{-Wabi} can also be used with an explicit version number to
2519 warn about compatibility with a particular @option{-fabi-version}
2520 level, e.g. @option{-Wabi=2} to warn about changes relative to
2521 @option{-fabi-version=2}.  Specifying a version number also sets
2522 @option{-fabi-compat-version=@var{n}}.
2524 The known incompatibilities in @option{-fabi-version=2} (which was the
2525 default from GCC 3.4 to 4.9) include:
2527 @itemize @bullet
2529 @item
2530 A template with a non-type template parameter of reference type was
2531 mangled incorrectly:
2532 @smallexample
2533 extern int N;
2534 template <int &> struct S @{@};
2535 void n (S<N>) @{2@}
2536 @end smallexample
2538 This was fixed in @option{-fabi-version=3}.
2540 @item
2541 SIMD vector types declared using @code{__attribute ((vector_size))} were
2542 mangled in a non-standard way that does not allow for overloading of
2543 functions taking vectors of different sizes.
2545 The mangling was changed in @option{-fabi-version=4}.
2547 @item
2548 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2549 qualifiers, and @code{decltype} of a plain declaration was folded away.
2551 These mangling issues were fixed in @option{-fabi-version=5}.
2553 @item
2554 Scoped enumerators passed as arguments to a variadic function are
2555 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2556 On most targets this does not actually affect the parameter passing
2557 ABI, as there is no way to pass an argument smaller than @samp{int}.
2559 Also, the ABI changed the mangling of template argument packs,
2560 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2561 a class scope function used as a template argument.
2563 These issues were corrected in @option{-fabi-version=6}.
2565 @item
2566 Lambdas in default argument scope were mangled incorrectly, and the
2567 ABI changed the mangling of nullptr_t.
2569 These issues were corrected in @option{-fabi-version=7}.
2571 @item
2572 When mangling a function type with function-cv-qualifiers, the
2573 un-qualified function type was incorrectly treated as a substitution
2574 candidate.
2576 This was fixed in @option{-fabi-version=8}.
2577 @end itemize
2579 It also warns about psABI-related changes.  The known psABI changes at this
2580 point include:
2582 @itemize @bullet
2584 @item
2585 For SysV/x86-64, unions with @code{long double} members are 
2586 passed in memory as specified in psABI.  For example:
2588 @smallexample
2589 union U @{
2590   long double ld;
2591   int i;
2593 @end smallexample
2595 @noindent
2596 @code{union U} is always passed in memory.
2598 @end itemize
2600 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2601 @opindex Wctor-dtor-privacy
2602 @opindex Wno-ctor-dtor-privacy
2603 Warn when a class seems unusable because all the constructors or
2604 destructors in that class are private, and it has neither friends nor
2605 public static member functions.  Also warn if there are no non-private
2606 methods, and there's at least one private member function that isn't
2607 a constructor or destructor.
2609 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2610 @opindex Wdelete-non-virtual-dtor
2611 @opindex Wno-delete-non-virtual-dtor
2612 Warn when @samp{delete} is used to destroy an instance of a class that
2613 has virtual functions and non-virtual destructor. It is unsafe to delete
2614 an instance of a derived class through a pointer to a base class if the
2615 base class does not have a virtual destructor.  This warning is enabled
2616 by @option{-Wall}.
2618 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2619 @opindex Wliteral-suffix
2620 @opindex Wno-literal-suffix
2621 Warn when a string or character literal is followed by a ud-suffix which does
2622 not begin with an underscore.  As a conforming extension, GCC treats such
2623 suffixes as separate preprocessing tokens in order to maintain backwards
2624 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2625 For example:
2627 @smallexample
2628 #define __STDC_FORMAT_MACROS
2629 #include <inttypes.h>
2630 #include <stdio.h>
2632 int main() @{
2633   int64_t i64 = 123;
2634   printf("My int64: %"PRId64"\n", i64);
2636 @end smallexample
2638 In this case, @code{PRId64} is treated as a separate preprocessing token.
2640 This warning is enabled by default.
2642 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2643 @opindex Wnarrowing
2644 @opindex Wno-narrowing
2645 Warn when a narrowing conversion prohibited by C++11 occurs within
2646 @samp{@{ @}}, e.g.
2648 @smallexample
2649 int i = @{ 2.2 @}; // error: narrowing from double to int
2650 @end smallexample
2652 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2654 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses for
2655 non-constants the diagnostic required by the standard.  Note that this
2656 does not affect the meaning of well-formed code; narrowing conversions
2657 are still considered ill-formed in SFINAE context.
2659 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2660 @opindex Wnoexcept
2661 @opindex Wno-noexcept
2662 Warn when a noexcept-expression evaluates to false because of a call
2663 to a function that does not have a non-throwing exception
2664 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2665 the compiler to never throw an exception.
2667 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2668 @opindex Wnon-virtual-dtor
2669 @opindex Wno-non-virtual-dtor
2670 Warn when a class has virtual functions and an accessible non-virtual
2671 destructor itself or in an accessible polymorphic base class, in which
2672 case it is possible but unsafe to delete an instance of a derived
2673 class through a pointer to the class itself or base class.  This
2674 warning is automatically enabled if @option{-Weffc++} is specified.
2676 @item -Wreorder @r{(C++ and Objective-C++ only)}
2677 @opindex Wreorder
2678 @opindex Wno-reorder
2679 @cindex reordering, warning
2680 @cindex warning for reordering of member initializers
2681 Warn when the order of member initializers given in the code does not
2682 match the order in which they must be executed.  For instance:
2684 @smallexample
2685 struct A @{
2686   int i;
2687   int j;
2688   A(): j (0), i (1) @{ @}
2690 @end smallexample
2692 @noindent
2693 The compiler rearranges the member initializers for @samp{i}
2694 and @samp{j} to match the declaration order of the members, emitting
2695 a warning to that effect.  This warning is enabled by @option{-Wall}.
2697 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2698 @opindex fext-numeric-literals
2699 @opindex fno-ext-numeric-literals
2700 Accept imaginary, fixed-point, or machine-defined
2701 literal number suffixes as GNU extensions.
2702 When this option is turned off these suffixes are treated
2703 as C++11 user-defined literal numeric suffixes.
2704 This is on by default for all pre-C++11 dialects and all GNU dialects:
2705 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2706 @option{-std=gnu++14}.
2707 This option is off by default
2708 for ISO C++11 onwards (@option{-std=c++11}, ...).
2709 @end table
2711 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2713 @table @gcctabopt
2714 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2715 @opindex Weffc++
2716 @opindex Wno-effc++
2717 Warn about violations of the following style guidelines from Scott Meyers'
2718 @cite{Effective C++} series of books:
2720 @itemize @bullet
2721 @item
2722 Define a copy constructor and an assignment operator for classes
2723 with dynamically-allocated memory.
2725 @item
2726 Prefer initialization to assignment in constructors.
2728 @item
2729 Have @code{operator=} return a reference to @code{*this}.
2731 @item
2732 Don't try to return a reference when you must return an object.
2734 @item
2735 Distinguish between prefix and postfix forms of increment and
2736 decrement operators.
2738 @item
2739 Never overload @code{&&}, @code{||}, or @code{,}.
2741 @end itemize
2743 This option also enables @option{-Wnon-virtual-dtor}, which is also
2744 one of the effective C++ recommendations.  However, the check is
2745 extended to warn about the lack of virtual destructor in accessible
2746 non-polymorphic bases classes too.
2748 When selecting this option, be aware that the standard library
2749 headers do not obey all of these guidelines; use @samp{grep -v}
2750 to filter out those warnings.
2752 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2753 @opindex Wstrict-null-sentinel
2754 @opindex Wno-strict-null-sentinel
2755 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2756 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2757 to @code{__null}.  Although it is a null pointer constant rather than a
2758 null pointer, it is guaranteed to be of the same size as a pointer.
2759 But this use is not portable across different compilers.
2761 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2762 @opindex Wno-non-template-friend
2763 @opindex Wnon-template-friend
2764 Disable warnings when non-templatized friend functions are declared
2765 within a template.  Since the advent of explicit template specification
2766 support in G++, if the name of the friend is an unqualified-id (i.e.,
2767 @samp{friend foo(int)}), the C++ language specification demands that the
2768 friend declare or define an ordinary, nontemplate function.  (Section
2769 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2770 could be interpreted as a particular specialization of a templatized
2771 function.  Because this non-conforming behavior is no longer the default
2772 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2773 check existing code for potential trouble spots and is on by default.
2774 This new compiler behavior can be turned off with
2775 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2776 but disables the helpful warning.
2778 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2779 @opindex Wold-style-cast
2780 @opindex Wno-old-style-cast
2781 Warn if an old-style (C-style) cast to a non-void type is used within
2782 a C++ program.  The new-style casts (@samp{dynamic_cast},
2783 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2784 less vulnerable to unintended effects and much easier to search for.
2786 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2787 @opindex Woverloaded-virtual
2788 @opindex Wno-overloaded-virtual
2789 @cindex overloaded virtual function, warning
2790 @cindex warning for overloaded virtual function
2791 Warn when a function declaration hides virtual functions from a
2792 base class.  For example, in:
2794 @smallexample
2795 struct A @{
2796   virtual void f();
2799 struct B: public A @{
2800   void f(int);
2802 @end smallexample
2804 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2805 like:
2807 @smallexample
2808 B* b;
2809 b->f();
2810 @end smallexample
2812 @noindent
2813 fails to compile.
2815 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2816 @opindex Wno-pmf-conversions
2817 @opindex Wpmf-conversions
2818 Disable the diagnostic for converting a bound pointer to member function
2819 to a plain pointer.
2821 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2822 @opindex Wsign-promo
2823 @opindex Wno-sign-promo
2824 Warn when overload resolution chooses a promotion from unsigned or
2825 enumerated type to a signed type, over a conversion to an unsigned type of
2826 the same size.  Previous versions of G++ tried to preserve
2827 unsignedness, but the standard mandates the current behavior.
2828 @end table
2830 @node Objective-C and Objective-C++ Dialect Options
2831 @section Options Controlling Objective-C and Objective-C++ Dialects
2833 @cindex compiler options, Objective-C and Objective-C++
2834 @cindex Objective-C and Objective-C++ options, command-line
2835 @cindex options, Objective-C and Objective-C++
2836 (NOTE: This manual does not describe the Objective-C and Objective-C++
2837 languages themselves.  @xref{Standards,,Language Standards
2838 Supported by GCC}, for references.)
2840 This section describes the command-line options that are only meaningful
2841 for Objective-C and Objective-C++ programs.  You can also use most of
2842 the language-independent GNU compiler options.
2843 For example, you might compile a file @code{some_class.m} like this:
2845 @smallexample
2846 gcc -g -fgnu-runtime -O -c some_class.m
2847 @end smallexample
2849 @noindent
2850 In this example, @option{-fgnu-runtime} is an option meant only for
2851 Objective-C and Objective-C++ programs; you can use the other options with
2852 any language supported by GCC@.
2854 Note that since Objective-C is an extension of the C language, Objective-C
2855 compilations may also use options specific to the C front-end (e.g.,
2856 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2857 C++-specific options (e.g., @option{-Wabi}).
2859 Here is a list of options that are @emph{only} for compiling Objective-C
2860 and Objective-C++ programs:
2862 @table @gcctabopt
2863 @item -fconstant-string-class=@var{class-name}
2864 @opindex fconstant-string-class
2865 Use @var{class-name} as the name of the class to instantiate for each
2866 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2867 class name is @code{NXConstantString} if the GNU runtime is being used, and
2868 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2869 @option{-fconstant-cfstrings} option, if also present, overrides the
2870 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2871 to be laid out as constant CoreFoundation strings.
2873 @item -fgnu-runtime
2874 @opindex fgnu-runtime
2875 Generate object code compatible with the standard GNU Objective-C
2876 runtime.  This is the default for most types of systems.
2878 @item -fnext-runtime
2879 @opindex fnext-runtime
2880 Generate output compatible with the NeXT runtime.  This is the default
2881 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2882 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2883 used.
2885 @item -fno-nil-receivers
2886 @opindex fno-nil-receivers
2887 Assume that all Objective-C message dispatches (@code{[receiver
2888 message:arg]}) in this translation unit ensure that the receiver is
2889 not @code{nil}.  This allows for more efficient entry points in the
2890 runtime to be used.  This option is only available in conjunction with
2891 the NeXT runtime and ABI version 0 or 1.
2893 @item -fobjc-abi-version=@var{n}
2894 @opindex fobjc-abi-version
2895 Use version @var{n} of the Objective-C ABI for the selected runtime.
2896 This option is currently supported only for the NeXT runtime.  In that
2897 case, Version 0 is the traditional (32-bit) ABI without support for
2898 properties and other Objective-C 2.0 additions.  Version 1 is the
2899 traditional (32-bit) ABI with support for properties and other
2900 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2901 nothing is specified, the default is Version 0 on 32-bit target
2902 machines, and Version 2 on 64-bit target machines.
2904 @item -fobjc-call-cxx-cdtors
2905 @opindex fobjc-call-cxx-cdtors
2906 For each Objective-C class, check if any of its instance variables is a
2907 C++ object with a non-trivial default constructor.  If so, synthesize a
2908 special @code{- (id) .cxx_construct} instance method which runs
2909 non-trivial default constructors on any such instance variables, in order,
2910 and then return @code{self}.  Similarly, check if any instance variable
2911 is a C++ object with a non-trivial destructor, and if so, synthesize a
2912 special @code{- (void) .cxx_destruct} method which runs
2913 all such default destructors, in reverse order.
2915 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2916 methods thusly generated only operate on instance variables
2917 declared in the current Objective-C class, and not those inherited
2918 from superclasses.  It is the responsibility of the Objective-C
2919 runtime to invoke all such methods in an object's inheritance
2920 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2921 by the runtime immediately after a new object instance is allocated;
2922 the @code{- (void) .cxx_destruct} methods are invoked immediately
2923 before the runtime deallocates an object instance.
2925 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2926 support for invoking the @code{- (id) .cxx_construct} and
2927 @code{- (void) .cxx_destruct} methods.
2929 @item -fobjc-direct-dispatch
2930 @opindex fobjc-direct-dispatch
2931 Allow fast jumps to the message dispatcher.  On Darwin this is
2932 accomplished via the comm page.
2934 @item -fobjc-exceptions
2935 @opindex fobjc-exceptions
2936 Enable syntactic support for structured exception handling in
2937 Objective-C, similar to what is offered by C++ and Java.  This option
2938 is required to use the Objective-C keywords @code{@@try},
2939 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2940 @code{@@synchronized}.  This option is available with both the GNU
2941 runtime and the NeXT runtime (but not available in conjunction with
2942 the NeXT runtime on Mac OS X 10.2 and earlier).
2944 @item -fobjc-gc
2945 @opindex fobjc-gc
2946 Enable garbage collection (GC) in Objective-C and Objective-C++
2947 programs.  This option is only available with the NeXT runtime; the
2948 GNU runtime has a different garbage collection implementation that
2949 does not require special compiler flags.
2951 @item -fobjc-nilcheck
2952 @opindex fobjc-nilcheck
2953 For the NeXT runtime with version 2 of the ABI, check for a nil
2954 receiver in method invocations before doing the actual method call.
2955 This is the default and can be disabled using
2956 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2957 checked for nil in this way no matter what this flag is set to.
2958 Currently this flag does nothing when the GNU runtime, or an older
2959 version of the NeXT runtime ABI, is used.
2961 @item -fobjc-std=objc1
2962 @opindex fobjc-std
2963 Conform to the language syntax of Objective-C 1.0, the language
2964 recognized by GCC 4.0.  This only affects the Objective-C additions to
2965 the C/C++ language; it does not affect conformance to C/C++ standards,
2966 which is controlled by the separate C/C++ dialect option flags.  When
2967 this option is used with the Objective-C or Objective-C++ compiler,
2968 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2969 This is useful if you need to make sure that your Objective-C code can
2970 be compiled with older versions of GCC@.
2972 @item -freplace-objc-classes
2973 @opindex freplace-objc-classes
2974 Emit a special marker instructing @command{ld(1)} not to statically link in
2975 the resulting object file, and allow @command{dyld(1)} to load it in at
2976 run time instead.  This is used in conjunction with the Fix-and-Continue
2977 debugging mode, where the object file in question may be recompiled and
2978 dynamically reloaded in the course of program execution, without the need
2979 to restart the program itself.  Currently, Fix-and-Continue functionality
2980 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2981 and later.
2983 @item -fzero-link
2984 @opindex fzero-link
2985 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2986 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2987 compile time) with static class references that get initialized at load time,
2988 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2989 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2990 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2991 for individual class implementations to be modified during program execution.
2992 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2993 regardless of command-line options.
2995 @item -fno-local-ivars
2996 @opindex fno-local-ivars
2997 @opindex flocal-ivars
2998 By default instance variables in Objective-C can be accessed as if
2999 they were local variables from within the methods of the class they're
3000 declared in.  This can lead to shadowing between instance variables
3001 and other variables declared either locally inside a class method or
3002 globally with the same name.  Specifying the @option{-fno-local-ivars}
3003 flag disables this behavior thus avoiding variable shadowing issues.
3005 @item -fivar-visibility=@var{public|protected|private|package}
3006 @opindex fivar-visibility
3007 Set the default instance variable visibility to the specified option
3008 so that instance variables declared outside the scope of any access
3009 modifier directives default to the specified visibility.
3011 @item -gen-decls
3012 @opindex gen-decls
3013 Dump interface declarations for all classes seen in the source file to a
3014 file named @file{@var{sourcename}.decl}.
3016 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3017 @opindex Wassign-intercept
3018 @opindex Wno-assign-intercept
3019 Warn whenever an Objective-C assignment is being intercepted by the
3020 garbage collector.
3022 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3023 @opindex Wno-protocol
3024 @opindex Wprotocol
3025 If a class is declared to implement a protocol, a warning is issued for
3026 every method in the protocol that is not implemented by the class.  The
3027 default behavior is to issue a warning for every method not explicitly
3028 implemented in the class, even if a method implementation is inherited
3029 from the superclass.  If you use the @option{-Wno-protocol} option, then
3030 methods inherited from the superclass are considered to be implemented,
3031 and no warning is issued for them.
3033 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3034 @opindex Wselector
3035 @opindex Wno-selector
3036 Warn if multiple methods of different types for the same selector are
3037 found during compilation.  The check is performed on the list of methods
3038 in the final stage of compilation.  Additionally, a check is performed
3039 for each selector appearing in a @code{@@selector(@dots{})}
3040 expression, and a corresponding method for that selector has been found
3041 during compilation.  Because these checks scan the method table only at
3042 the end of compilation, these warnings are not produced if the final
3043 stage of compilation is not reached, for example because an error is
3044 found during compilation, or because the @option{-fsyntax-only} option is
3045 being used.
3047 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3048 @opindex Wstrict-selector-match
3049 @opindex Wno-strict-selector-match
3050 Warn if multiple methods with differing argument and/or return types are
3051 found for a given selector when attempting to send a message using this
3052 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3053 is off (which is the default behavior), the compiler omits such warnings
3054 if any differences found are confined to types that share the same size
3055 and alignment.
3057 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3058 @opindex Wundeclared-selector
3059 @opindex Wno-undeclared-selector
3060 Warn if a @code{@@selector(@dots{})} expression referring to an
3061 undeclared selector is found.  A selector is considered undeclared if no
3062 method with that name has been declared before the
3063 @code{@@selector(@dots{})} expression, either explicitly in an
3064 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3065 an @code{@@implementation} section.  This option always performs its
3066 checks as soon as a @code{@@selector(@dots{})} expression is found,
3067 while @option{-Wselector} only performs its checks in the final stage of
3068 compilation.  This also enforces the coding style convention
3069 that methods and selectors must be declared before being used.
3071 @item -print-objc-runtime-info
3072 @opindex print-objc-runtime-info
3073 Generate C header describing the largest structure that is passed by
3074 value, if any.
3076 @end table
3078 @node Language Independent Options
3079 @section Options to Control Diagnostic Messages Formatting
3080 @cindex options to control diagnostics formatting
3081 @cindex diagnostic messages
3082 @cindex message formatting
3084 Traditionally, diagnostic messages have been formatted irrespective of
3085 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3086 options described below
3087 to control the formatting algorithm for diagnostic messages, 
3088 e.g.@: how many characters per line, how often source location
3089 information should be reported.  Note that some language front ends may not
3090 honor these options.
3092 @table @gcctabopt
3093 @item -fmessage-length=@var{n}
3094 @opindex fmessage-length
3095 Try to format error messages so that they fit on lines of about
3096 @var{n} characters.  If @var{n} is zero, then no line-wrapping will be
3097 done; each error message will appear on a single line.  This is the
3098 default for all front ends.
3100 @item -fdiagnostics-show-location=once
3101 @opindex fdiagnostics-show-location
3102 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3103 reporter to emit source location information @emph{once}; that is, in
3104 case the message is too long to fit on a single physical line and has to
3105 be wrapped, the source location won't be emitted (as prefix) again,
3106 over and over, in subsequent continuation lines.  This is the default
3107 behavior.
3109 @item -fdiagnostics-show-location=every-line
3110 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3111 messages reporter to emit the same source location information (as
3112 prefix) for physical lines that result from the process of breaking
3113 a message which is too long to fit on a single line.
3115 @item -fdiagnostics-color[=@var{WHEN}]
3116 @itemx -fno-diagnostics-color
3117 @opindex fdiagnostics-color
3118 @cindex highlight, color, colour
3119 @vindex GCC_COLORS @r{environment variable}
3120 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3121 or @samp{auto}.  The default depends on how the compiler has been configured,
3122 it can be any of the above @var{WHEN} options or also @samp{never}
3123 if @env{GCC_COLORS} environment variable isn't present in the environment,
3124 and @samp{auto} otherwise.
3125 @samp{auto} means to use color only when the standard error is a terminal.
3126 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3127 aliases for @option{-fdiagnostics-color=always} and
3128 @option{-fdiagnostics-color=never}, respectively.
3130 The colors are defined by the environment variable @env{GCC_COLORS}.
3131 Its value is a colon-separated list of capabilities and Select Graphic
3132 Rendition (SGR) substrings. SGR commands are interpreted by the
3133 terminal or terminal emulator.  (See the section in the documentation
3134 of your text terminal for permitted values and their meanings as
3135 character attributes.)  These substring values are integers in decimal
3136 representation and can be concatenated with semicolons.
3137 Common values to concatenate include
3138 @samp{1} for bold,
3139 @samp{4} for underline,
3140 @samp{5} for blink,
3141 @samp{7} for inverse,
3142 @samp{39} for default foreground color,
3143 @samp{30} to @samp{37} for foreground colors,
3144 @samp{90} to @samp{97} for 16-color mode foreground colors,
3145 @samp{38;5;0} to @samp{38;5;255}
3146 for 88-color and 256-color modes foreground colors,
3147 @samp{49} for default background color,
3148 @samp{40} to @samp{47} for background colors,
3149 @samp{100} to @samp{107} for 16-color mode background colors,
3150 and @samp{48;5;0} to @samp{48;5;255}
3151 for 88-color and 256-color modes background colors.
3153 The default @env{GCC_COLORS} is
3154 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3155 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3156 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3157 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3158 string disables colors.
3159 Supported capabilities are as follows.
3161 @table @code
3162 @item error=
3163 @vindex error GCC_COLORS @r{capability}
3164 SGR substring for error: markers.
3166 @item warning=
3167 @vindex warning GCC_COLORS @r{capability}
3168 SGR substring for warning: markers.
3170 @item note=
3171 @vindex note GCC_COLORS @r{capability}
3172 SGR substring for note: markers.
3174 @item caret=
3175 @vindex caret GCC_COLORS @r{capability}
3176 SGR substring for caret line.
3178 @item locus=
3179 @vindex locus GCC_COLORS @r{capability}
3180 SGR substring for location information, @samp{file:line} or
3181 @samp{file:line:column} etc.
3183 @item quote=
3184 @vindex quote GCC_COLORS @r{capability}
3185 SGR substring for information printed within quotes.
3186 @end table
3188 @item -fno-diagnostics-show-option
3189 @opindex fno-diagnostics-show-option
3190 @opindex fdiagnostics-show-option
3191 By default, each diagnostic emitted includes text indicating the
3192 command-line option that directly controls the diagnostic (if such an
3193 option is known to the diagnostic machinery).  Specifying the
3194 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3196 @item -fno-diagnostics-show-caret
3197 @opindex fno-diagnostics-show-caret
3198 @opindex fdiagnostics-show-caret
3199 By default, each diagnostic emitted includes the original source line
3200 and a caret '^' indicating the column.  This option suppresses this
3201 information.  The source line is truncated to @var{n} characters, if
3202 the @option{-fmessage-length=n} is given.  When the output is done
3203 to the terminal, the width is limited to the width given by the
3204 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3206 @end table
3208 @node Warning Options
3209 @section Options to Request or Suppress Warnings
3210 @cindex options to control warnings
3211 @cindex warning messages
3212 @cindex messages, warning
3213 @cindex suppressing warnings
3215 Warnings are diagnostic messages that report constructions that
3216 are not inherently erroneous but that are risky or suggest there
3217 may have been an error.
3219 The following language-independent options do not enable specific
3220 warnings but control the kinds of diagnostics produced by GCC@.
3222 @table @gcctabopt
3223 @cindex syntax checking
3224 @item -fsyntax-only
3225 @opindex fsyntax-only
3226 Check the code for syntax errors, but don't do anything beyond that.
3228 @item -fmax-errors=@var{n}
3229 @opindex fmax-errors
3230 Limits the maximum number of error messages to @var{n}, at which point
3231 GCC bails out rather than attempting to continue processing the source
3232 code.  If @var{n} is 0 (the default), there is no limit on the number
3233 of error messages produced.  If @option{-Wfatal-errors} is also
3234 specified, then @option{-Wfatal-errors} takes precedence over this
3235 option.
3237 @item -w
3238 @opindex w
3239 Inhibit all warning messages.
3241 @item -Werror
3242 @opindex Werror
3243 @opindex Wno-error
3244 Make all warnings into errors.
3246 @item -Werror=
3247 @opindex Werror=
3248 @opindex Wno-error=
3249 Make the specified warning into an error.  The specifier for a warning
3250 is appended; for example @option{-Werror=switch} turns the warnings
3251 controlled by @option{-Wswitch} into errors.  This switch takes a
3252 negative form, to be used to negate @option{-Werror} for specific
3253 warnings; for example @option{-Wno-error=switch} makes
3254 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3255 is in effect.
3257 The warning message for each controllable warning includes the
3258 option that controls the warning.  That option can then be used with
3259 @option{-Werror=} and @option{-Wno-error=} as described above.
3260 (Printing of the option in the warning message can be disabled using the
3261 @option{-fno-diagnostics-show-option} flag.)
3263 Note that specifying @option{-Werror=}@var{foo} automatically implies
3264 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3265 imply anything.
3267 @item -Wfatal-errors
3268 @opindex Wfatal-errors
3269 @opindex Wno-fatal-errors
3270 This option causes the compiler to abort compilation on the first error
3271 occurred rather than trying to keep going and printing further error
3272 messages.
3274 @end table
3276 You can request many specific warnings with options beginning with
3277 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3278 implicit declarations.  Each of these specific warning options also
3279 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3280 example, @option{-Wno-implicit}.  This manual lists only one of the
3281 two forms, whichever is not the default.  For further
3282 language-specific options also refer to @ref{C++ Dialect Options} and
3283 @ref{Objective-C and Objective-C++ Dialect Options}.
3285 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3286 options, such as @option{-Wunused}, which may turn on further options,
3287 such as @option{-Wunused-value}. The combined effect of positive and
3288 negative forms is that more specific options have priority over less
3289 specific ones, independently of their position in the command-line. For
3290 options of the same specificity, the last one takes effect. Options
3291 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3292 as if they appeared at the end of the command-line.
3294 When an unrecognized warning option is requested (e.g.,
3295 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3296 that the option is not recognized.  However, if the @option{-Wno-} form
3297 is used, the behavior is slightly different: no diagnostic is
3298 produced for @option{-Wno-unknown-warning} unless other diagnostics
3299 are being produced.  This allows the use of new @option{-Wno-} options
3300 with old compilers, but if something goes wrong, the compiler
3301 warns that an unrecognized option is present.
3303 @table @gcctabopt
3304 @item -Wpedantic
3305 @itemx -pedantic
3306 @opindex pedantic
3307 @opindex Wpedantic
3308 Issue all the warnings demanded by strict ISO C and ISO C++;
3309 reject all programs that use forbidden extensions, and some other
3310 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3311 version of the ISO C standard specified by any @option{-std} option used.
3313 Valid ISO C and ISO C++ programs should compile properly with or without
3314 this option (though a rare few require @option{-ansi} or a
3315 @option{-std} option specifying the required version of ISO C)@.  However,
3316 without this option, certain GNU extensions and traditional C and C++
3317 features are supported as well.  With this option, they are rejected.
3319 @option{-Wpedantic} does not cause warning messages for use of the
3320 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3321 warnings are also disabled in the expression that follows
3322 @code{__extension__}.  However, only system header files should use
3323 these escape routes; application programs should avoid them.
3324 @xref{Alternate Keywords}.
3326 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3327 C conformance.  They soon find that it does not do quite what they want:
3328 it finds some non-ISO practices, but not all---only those for which
3329 ISO C @emph{requires} a diagnostic, and some others for which
3330 diagnostics have been added.
3332 A feature to report any failure to conform to ISO C might be useful in
3333 some instances, but would require considerable additional work and would
3334 be quite different from @option{-Wpedantic}.  We don't have plans to
3335 support such a feature in the near future.
3337 Where the standard specified with @option{-std} represents a GNU
3338 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3339 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3340 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3341 where they are required by the base standard.  (It does not make sense
3342 for such warnings to be given only for features not in the specified GNU
3343 C dialect, since by definition the GNU dialects of C include all
3344 features the compiler supports with the given option, and there would be
3345 nothing to warn about.)
3347 @item -pedantic-errors
3348 @opindex pedantic-errors
3349 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3350 requires a diagnostic, in some cases where there is undefined behavior
3351 at compile-time and in some other cases that do not prevent compilation
3352 of programs that are valid according to the standard. This is not
3353 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3354 by this option and not enabled by the latter and vice versa.
3356 @item -Wall
3357 @opindex Wall
3358 @opindex Wno-all
3359 This enables all the warnings about constructions that some users
3360 consider questionable, and that are easy to avoid (or modify to
3361 prevent the warning), even in conjunction with macros.  This also
3362 enables some language-specific warnings described in @ref{C++ Dialect
3363 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3365 @option{-Wall} turns on the following warning flags:
3367 @gccoptlist{-Waddress   @gol
3368 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3369 -Wc++11-compat  @gol
3370 -Wchar-subscripts  @gol
3371 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3372 -Wimplicit-int @r{(C and Objective-C only)} @gol
3373 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3374 -Wcomment  @gol
3375 -Wformat   @gol
3376 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3377 -Wmaybe-uninitialized @gol
3378 -Wmissing-braces @r{(only for C/ObjC)} @gol
3379 -Wnonnull  @gol
3380 -Wopenmp-simd @gol
3381 -Wparentheses  @gol
3382 -Wpointer-sign  @gol
3383 -Wreorder   @gol
3384 -Wreturn-type  @gol
3385 -Wsequence-point  @gol
3386 -Wsign-compare @r{(only in C++)}  @gol
3387 -Wstrict-aliasing  @gol
3388 -Wstrict-overflow=1  @gol
3389 -Wswitch  @gol
3390 -Wtrigraphs  @gol
3391 -Wuninitialized  @gol
3392 -Wunknown-pragmas  @gol
3393 -Wunused-function  @gol
3394 -Wunused-label     @gol
3395 -Wunused-value     @gol
3396 -Wunused-variable  @gol
3397 -Wvolatile-register-var @gol
3400 Note that some warning flags are not implied by @option{-Wall}.  Some of
3401 them warn about constructions that users generally do not consider
3402 questionable, but which occasionally you might wish to check for;
3403 others warn about constructions that are necessary or hard to avoid in
3404 some cases, and there is no simple way to modify the code to suppress
3405 the warning. Some of them are enabled by @option{-Wextra} but many of
3406 them must be enabled individually.
3408 @item -Wextra
3409 @opindex W
3410 @opindex Wextra
3411 @opindex Wno-extra
3412 This enables some extra warning flags that are not enabled by
3413 @option{-Wall}. (This option used to be called @option{-W}.  The older
3414 name is still supported, but the newer name is more descriptive.)
3416 @gccoptlist{-Wclobbered  @gol
3417 -Wempty-body  @gol
3418 -Wignored-qualifiers @gol
3419 -Wmissing-field-initializers  @gol
3420 -Wmissing-parameter-type @r{(C only)}  @gol
3421 -Wold-style-declaration @r{(C only)}  @gol
3422 -Woverride-init  @gol
3423 -Wsign-compare  @gol
3424 -Wtype-limits  @gol
3425 -Wuninitialized  @gol
3426 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3427 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3430 The option @option{-Wextra} also prints warning messages for the
3431 following cases:
3433 @itemize @bullet
3435 @item
3436 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3437 @samp{>}, or @samp{>=}.
3439 @item
3440 (C++ only) An enumerator and a non-enumerator both appear in a
3441 conditional expression.
3443 @item
3444 (C++ only) Ambiguous virtual bases.
3446 @item
3447 (C++ only) Subscripting an array that has been declared @samp{register}.
3449 @item
3450 (C++ only) Taking the address of a variable that has been declared
3451 @samp{register}.
3453 @item
3454 (C++ only) A base class is not initialized in a derived class's copy
3455 constructor.
3457 @end itemize
3459 @item -Wchar-subscripts
3460 @opindex Wchar-subscripts
3461 @opindex Wno-char-subscripts
3462 Warn if an array subscript has type @code{char}.  This is a common cause
3463 of error, as programmers often forget that this type is signed on some
3464 machines.
3465 This warning is enabled by @option{-Wall}.
3467 @item -Wcomment
3468 @opindex Wcomment
3469 @opindex Wno-comment
3470 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3471 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3472 This warning is enabled by @option{-Wall}.
3474 @item -Wno-coverage-mismatch
3475 @opindex Wno-coverage-mismatch
3476 Warn if feedback profiles do not match when using the
3477 @option{-fprofile-use} option.
3478 If a source file is changed between compiling with @option{-fprofile-gen} and
3479 with @option{-fprofile-use}, the files with the profile feedback can fail
3480 to match the source file and GCC cannot use the profile feedback
3481 information.  By default, this warning is enabled and is treated as an
3482 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3483 warning or @option{-Wno-error=coverage-mismatch} can be used to
3484 disable the error.  Disabling the error for this warning can result in
3485 poorly optimized code and is useful only in the
3486 case of very minor changes such as bug fixes to an existing code-base.
3487 Completely disabling the warning is not recommended.
3489 @item -Wno-cpp
3490 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3492 Suppress warning messages emitted by @code{#warning} directives.
3494 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3495 @opindex Wdouble-promotion
3496 @opindex Wno-double-promotion
3497 Give a warning when a value of type @code{float} is implicitly
3498 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3499 floating-point unit implement @code{float} in hardware, but emulate
3500 @code{double} in software.  On such a machine, doing computations
3501 using @code{double} values is much more expensive because of the
3502 overhead required for software emulation.
3504 It is easy to accidentally do computations with @code{double} because
3505 floating-point literals are implicitly of type @code{double}.  For
3506 example, in:
3507 @smallexample
3508 @group
3509 float area(float radius)
3511    return 3.14159 * radius * radius;
3513 @end group
3514 @end smallexample
3515 the compiler performs the entire computation with @code{double}
3516 because the floating-point literal is a @code{double}.
3518 @item -Wformat
3519 @itemx -Wformat=@var{n}
3520 @opindex Wformat
3521 @opindex Wno-format
3522 @opindex ffreestanding
3523 @opindex fno-builtin
3524 @opindex Wformat=
3525 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3526 the arguments supplied have types appropriate to the format string
3527 specified, and that the conversions specified in the format string make
3528 sense.  This includes standard functions, and others specified by format
3529 attributes (@pxref{Function Attributes}), in the @code{printf},
3530 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3531 not in the C standard) families (or other target-specific families).
3532 Which functions are checked without format attributes having been
3533 specified depends on the standard version selected, and such checks of
3534 functions without the attribute specified are disabled by
3535 @option{-ffreestanding} or @option{-fno-builtin}.
3537 The formats are checked against the format features supported by GNU
3538 libc version 2.2.  These include all ISO C90 and C99 features, as well
3539 as features from the Single Unix Specification and some BSD and GNU
3540 extensions.  Other library implementations may not support all these
3541 features; GCC does not support warning about features that go beyond a
3542 particular library's limitations.  However, if @option{-Wpedantic} is used
3543 with @option{-Wformat}, warnings are given about format features not
3544 in the selected standard version (but not for @code{strfmon} formats,
3545 since those are not in any version of the C standard).  @xref{C Dialect
3546 Options,,Options Controlling C Dialect}.
3548 @table @gcctabopt
3549 @item -Wformat=1
3550 @itemx -Wformat
3551 @opindex Wformat
3552 @opindex Wformat=1
3553 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3554 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3555 @option{-Wformat} also checks for null format arguments for several
3556 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3557 aspects of this level of format checking can be disabled by the
3558 options: @option{-Wno-format-contains-nul},
3559 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3560 @option{-Wformat} is enabled by @option{-Wall}.
3562 @item -Wno-format-contains-nul
3563 @opindex Wno-format-contains-nul
3564 @opindex Wformat-contains-nul
3565 If @option{-Wformat} is specified, do not warn about format strings that
3566 contain NUL bytes.
3568 @item -Wno-format-extra-args
3569 @opindex Wno-format-extra-args
3570 @opindex Wformat-extra-args
3571 If @option{-Wformat} is specified, do not warn about excess arguments to a
3572 @code{printf} or @code{scanf} format function.  The C standard specifies
3573 that such arguments are ignored.
3575 Where the unused arguments lie between used arguments that are
3576 specified with @samp{$} operand number specifications, normally
3577 warnings are still given, since the implementation could not know what
3578 type to pass to @code{va_arg} to skip the unused arguments.  However,
3579 in the case of @code{scanf} formats, this option suppresses the
3580 warning if the unused arguments are all pointers, since the Single
3581 Unix Specification says that such unused arguments are allowed.
3583 @item -Wno-format-zero-length
3584 @opindex Wno-format-zero-length
3585 @opindex Wformat-zero-length
3586 If @option{-Wformat} is specified, do not warn about zero-length formats.
3587 The C standard specifies that zero-length formats are allowed.
3590 @item -Wformat=2
3591 @opindex Wformat=2
3592 Enable @option{-Wformat} plus additional format checks.  Currently
3593 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3594 -Wformat-signedness -Wformat-y2k}.
3596 @item -Wformat-nonliteral
3597 @opindex Wformat-nonliteral
3598 @opindex Wno-format-nonliteral
3599 If @option{-Wformat} is specified, also warn if the format string is not a
3600 string literal and so cannot be checked, unless the format function
3601 takes its format arguments as a @code{va_list}.
3603 @item -Wformat-security
3604 @opindex Wformat-security
3605 @opindex Wno-format-security
3606 If @option{-Wformat} is specified, also warn about uses of format
3607 functions that represent possible security problems.  At present, this
3608 warns about calls to @code{printf} and @code{scanf} functions where the
3609 format string is not a string literal and there are no format arguments,
3610 as in @code{printf (foo);}.  This may be a security hole if the format
3611 string came from untrusted input and contains @samp{%n}.  (This is
3612 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3613 in future warnings may be added to @option{-Wformat-security} that are not
3614 included in @option{-Wformat-nonliteral}.)
3616 @item -Wformat-signedness
3617 @opindex Wformat-signedness
3618 @opindex Wno-format-signedness
3619 If @option{-Wformat} is specified, also warn if the format string
3620 requires an unsigned argument and the argument is signed and vice versa.
3622 @item -Wformat-y2k
3623 @opindex Wformat-y2k
3624 @opindex Wno-format-y2k
3625 If @option{-Wformat} is specified, also warn about @code{strftime}
3626 formats that may yield only a two-digit year.
3627 @end table
3629 @item -Wnonnull
3630 @opindex Wnonnull
3631 @opindex Wno-nonnull
3632 Warn about passing a null pointer for arguments marked as
3633 requiring a non-null value by the @code{nonnull} function attribute.
3635 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3636 can be disabled with the @option{-Wno-nonnull} option.
3638 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3639 @opindex Winit-self
3640 @opindex Wno-init-self
3641 Warn about uninitialized variables that are initialized with themselves.
3642 Note this option can only be used with the @option{-Wuninitialized} option.
3644 For example, GCC warns about @code{i} being uninitialized in the
3645 following snippet only when @option{-Winit-self} has been specified:
3646 @smallexample
3647 @group
3648 int f()
3650   int i = i;
3651   return i;
3653 @end group
3654 @end smallexample
3656 This warning is enabled by @option{-Wall} in C++.
3658 @item -Wimplicit-int @r{(C and Objective-C only)}
3659 @opindex Wimplicit-int
3660 @opindex Wno-implicit-int
3661 Warn when a declaration does not specify a type.
3662 This warning is enabled by @option{-Wall}.
3664 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3665 @opindex Wimplicit-function-declaration
3666 @opindex Wno-implicit-function-declaration
3667 Give a warning whenever a function is used before being declared. In
3668 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3669 enabled by default and it is made into an error by
3670 @option{-pedantic-errors}. This warning is also enabled by
3671 @option{-Wall}.
3673 @item -Wimplicit @r{(C and Objective-C only)}
3674 @opindex Wimplicit
3675 @opindex Wno-implicit
3676 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3677 This warning is enabled by @option{-Wall}.
3679 @item -Wignored-qualifiers @r{(C and C++ only)}
3680 @opindex Wignored-qualifiers
3681 @opindex Wno-ignored-qualifiers
3682 Warn if the return type of a function has a type qualifier
3683 such as @code{const}.  For ISO C such a type qualifier has no effect,
3684 since the value returned by a function is not an lvalue.
3685 For C++, the warning is only emitted for scalar types or @code{void}.
3686 ISO C prohibits qualified @code{void} return types on function
3687 definitions, so such return types always receive a warning
3688 even without this option.
3690 This warning is also enabled by @option{-Wextra}.
3692 @item -Wmain
3693 @opindex Wmain
3694 @opindex Wno-main
3695 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3696 a function with external linkage, returning int, taking either zero
3697 arguments, two, or three arguments of appropriate types.  This warning
3698 is enabled by default in C++ and is enabled by either @option{-Wall}
3699 or @option{-Wpedantic}.
3701 @item -Wmissing-braces
3702 @opindex Wmissing-braces
3703 @opindex Wno-missing-braces
3704 Warn if an aggregate or union initializer is not fully bracketed.  In
3705 the following example, the initializer for @samp{a} is not fully
3706 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3707 enabled by @option{-Wall} in C.
3709 @smallexample
3710 int a[2][2] = @{ 0, 1, 2, 3 @};
3711 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3712 @end smallexample
3714 This warning is enabled by @option{-Wall}.
3716 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3717 @opindex Wmissing-include-dirs
3718 @opindex Wno-missing-include-dirs
3719 Warn if a user-supplied include directory does not exist.
3721 @item -Wparentheses
3722 @opindex Wparentheses
3723 @opindex Wno-parentheses
3724 Warn if parentheses are omitted in certain contexts, such
3725 as when there is an assignment in a context where a truth value
3726 is expected, or when operators are nested whose precedence people
3727 often get confused about.
3729 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3730 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3731 interpretation from that of ordinary mathematical notation.
3733 Also warn about constructions where there may be confusion to which
3734 @code{if} statement an @code{else} branch belongs.  Here is an example of
3735 such a case:
3737 @smallexample
3738 @group
3740   if (a)
3741     if (b)
3742       foo ();
3743   else
3744     bar ();
3746 @end group
3747 @end smallexample
3749 In C/C++, every @code{else} branch belongs to the innermost possible
3750 @code{if} statement, which in this example is @code{if (b)}.  This is
3751 often not what the programmer expected, as illustrated in the above
3752 example by indentation the programmer chose.  When there is the
3753 potential for this confusion, GCC issues a warning when this flag
3754 is specified.  To eliminate the warning, add explicit braces around
3755 the innermost @code{if} statement so there is no way the @code{else}
3756 can belong to the enclosing @code{if}.  The resulting code
3757 looks like this:
3759 @smallexample
3760 @group
3762   if (a)
3763     @{
3764       if (b)
3765         foo ();
3766       else
3767         bar ();
3768     @}
3770 @end group
3771 @end smallexample
3773 Also warn for dangerous uses of the GNU extension to
3774 @code{?:} with omitted middle operand. When the condition
3775 in the @code{?}: operator is a boolean expression, the omitted value is
3776 always 1.  Often programmers expect it to be a value computed
3777 inside the conditional expression instead.
3779 This warning is enabled by @option{-Wall}.
3781 @item -Wsequence-point
3782 @opindex Wsequence-point
3783 @opindex Wno-sequence-point
3784 Warn about code that may have undefined semantics because of violations
3785 of sequence point rules in the C and C++ standards.
3787 The C and C++ standards define the order in which expressions in a C/C++
3788 program are evaluated in terms of @dfn{sequence points}, which represent
3789 a partial ordering between the execution of parts of the program: those
3790 executed before the sequence point, and those executed after it.  These
3791 occur after the evaluation of a full expression (one which is not part
3792 of a larger expression), after the evaluation of the first operand of a
3793 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3794 function is called (but after the evaluation of its arguments and the
3795 expression denoting the called function), and in certain other places.
3796 Other than as expressed by the sequence point rules, the order of
3797 evaluation of subexpressions of an expression is not specified.  All
3798 these rules describe only a partial order rather than a total order,
3799 since, for example, if two functions are called within one expression
3800 with no sequence point between them, the order in which the functions
3801 are called is not specified.  However, the standards committee have
3802 ruled that function calls do not overlap.
3804 It is not specified when between sequence points modifications to the
3805 values of objects take effect.  Programs whose behavior depends on this
3806 have undefined behavior; the C and C++ standards specify that ``Between
3807 the previous and next sequence point an object shall have its stored
3808 value modified at most once by the evaluation of an expression.
3809 Furthermore, the prior value shall be read only to determine the value
3810 to be stored.''.  If a program breaks these rules, the results on any
3811 particular implementation are entirely unpredictable.
3813 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3814 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3815 diagnosed by this option, and it may give an occasional false positive
3816 result, but in general it has been found fairly effective at detecting
3817 this sort of problem in programs.
3819 The standard is worded confusingly, therefore there is some debate
3820 over the precise meaning of the sequence point rules in subtle cases.
3821 Links to discussions of the problem, including proposed formal
3822 definitions, may be found on the GCC readings page, at
3823 @uref{http://gcc.gnu.org/@/readings.html}.
3825 This warning is enabled by @option{-Wall} for C and C++.
3827 @item -Wno-return-local-addr
3828 @opindex Wno-return-local-addr
3829 @opindex Wreturn-local-addr
3830 Do not warn about returning a pointer (or in C++, a reference) to a
3831 variable that goes out of scope after the function returns.
3833 @item -Wreturn-type
3834 @opindex Wreturn-type
3835 @opindex Wno-return-type
3836 Warn whenever a function is defined with a return type that defaults
3837 to @code{int}.  Also warn about any @code{return} statement with no
3838 return value in a function whose return type is not @code{void}
3839 (falling off the end of the function body is considered returning
3840 without a value), and about a @code{return} statement with an
3841 expression in a function whose return type is @code{void}.
3843 For C++, a function without return type always produces a diagnostic
3844 message, even when @option{-Wno-return-type} is specified.  The only
3845 exceptions are @samp{main} and functions defined in system headers.
3847 This warning is enabled by @option{-Wall}.
3849 @item -Wshift-count-negative
3850 @opindex Wshift-count-negative
3851 @opindex Wno-shift-count-negative
3852 Warn if shift count is negative. This warning is enabled by default.
3854 @item -Wshift-count-overflow
3855 @opindex Wshift-count-overflow
3856 @opindex Wno-shift-count-overflow
3857 Warn if shift count >= width of type. This warning is enabled by default.
3859 @item -Wswitch
3860 @opindex Wswitch
3861 @opindex Wno-switch
3862 Warn whenever a @code{switch} statement has an index of enumerated type
3863 and lacks a @code{case} for one or more of the named codes of that
3864 enumeration.  (The presence of a @code{default} label prevents this
3865 warning.)  @code{case} labels outside the enumeration range also
3866 provoke warnings when this option is used (even if there is a
3867 @code{default} label).
3868 This warning is enabled by @option{-Wall}.
3870 @item -Wswitch-default
3871 @opindex Wswitch-default
3872 @opindex Wno-switch-default
3873 Warn whenever a @code{switch} statement does not have a @code{default}
3874 case.
3876 @item -Wswitch-enum
3877 @opindex Wswitch-enum
3878 @opindex Wno-switch-enum
3879 Warn whenever a @code{switch} statement has an index of enumerated type
3880 and lacks a @code{case} for one or more of the named codes of that
3881 enumeration.  @code{case} labels outside the enumeration range also
3882 provoke warnings when this option is used.  The only difference
3883 between @option{-Wswitch} and this option is that this option gives a
3884 warning about an omitted enumeration code even if there is a
3885 @code{default} label.
3887 @item -Wswitch-bool
3888 @opindex Wswitch-bool
3889 @opindex Wno-switch-bool
3890 Warn whenever a @code{switch} statement has an index of boolean type.
3891 It is possible to suppress this warning by casting the controlling
3892 expression to a type other than @code{bool}.  For example:
3893 @smallexample
3894 @group
3895 switch ((int) (a == 4))
3896   @{
3897   @dots{}
3898   @}
3899 @end group
3900 @end smallexample
3901 This warning is enabled by default for C and C++ programs.
3903 @item -Wsync-nand @r{(C and C++ only)}
3904 @opindex Wsync-nand
3905 @opindex Wno-sync-nand
3906 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3907 built-in functions are used.  These functions changed semantics in GCC 4.4.
3909 @item -Wtrigraphs
3910 @opindex Wtrigraphs
3911 @opindex Wno-trigraphs
3912 Warn if any trigraphs are encountered that might change the meaning of
3913 the program (trigraphs within comments are not warned about).
3914 This warning is enabled by @option{-Wall}.
3916 @item -Wunused-but-set-parameter
3917 @opindex Wunused-but-set-parameter
3918 @opindex Wno-unused-but-set-parameter
3919 Warn whenever a function parameter is assigned to, but otherwise unused
3920 (aside from its declaration).
3922 To suppress this warning use the @samp{unused} attribute
3923 (@pxref{Variable Attributes}).
3925 This warning is also enabled by @option{-Wunused} together with
3926 @option{-Wextra}.
3928 @item -Wunused-but-set-variable
3929 @opindex Wunused-but-set-variable
3930 @opindex Wno-unused-but-set-variable
3931 Warn whenever a local variable is assigned to, but otherwise unused
3932 (aside from its declaration).
3933 This warning is enabled by @option{-Wall}.
3935 To suppress this warning use the @samp{unused} attribute
3936 (@pxref{Variable Attributes}).
3938 This warning is also enabled by @option{-Wunused}, which is enabled
3939 by @option{-Wall}.
3941 @item -Wunused-function
3942 @opindex Wunused-function
3943 @opindex Wno-unused-function
3944 Warn whenever a static function is declared but not defined or a
3945 non-inline static function is unused.
3946 This warning is enabled by @option{-Wall}.
3948 @item -Wunused-label
3949 @opindex Wunused-label
3950 @opindex Wno-unused-label
3951 Warn whenever a label is declared but not used.
3952 This warning is enabled by @option{-Wall}.
3954 To suppress this warning use the @samp{unused} attribute
3955 (@pxref{Variable Attributes}).
3957 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3958 @opindex Wunused-local-typedefs
3959 Warn when a typedef locally defined in a function is not used.
3960 This warning is enabled by @option{-Wall}.
3962 @item -Wunused-parameter
3963 @opindex Wunused-parameter
3964 @opindex Wno-unused-parameter
3965 Warn whenever a function parameter is unused aside from its declaration.
3967 To suppress this warning use the @samp{unused} attribute
3968 (@pxref{Variable Attributes}).
3970 @item -Wno-unused-result
3971 @opindex Wunused-result
3972 @opindex Wno-unused-result
3973 Do not warn if a caller of a function marked with attribute
3974 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3975 its return value. The default is @option{-Wunused-result}.
3977 @item -Wunused-variable
3978 @opindex Wunused-variable
3979 @opindex Wno-unused-variable
3980 Warn whenever a local variable or non-constant static variable is unused
3981 aside from its declaration.
3982 This warning is enabled by @option{-Wall}.
3984 To suppress this warning use the @samp{unused} attribute
3985 (@pxref{Variable Attributes}).
3987 @item -Wunused-value
3988 @opindex Wunused-value
3989 @opindex Wno-unused-value
3990 Warn whenever a statement computes a result that is explicitly not
3991 used. To suppress this warning cast the unused expression to
3992 @samp{void}. This includes an expression-statement or the left-hand
3993 side of a comma expression that contains no side effects. For example,
3994 an expression such as @samp{x[i,j]} causes a warning, while
3995 @samp{x[(void)i,j]} does not.
3997 This warning is enabled by @option{-Wall}.
3999 @item -Wunused
4000 @opindex Wunused
4001 @opindex Wno-unused
4002 All the above @option{-Wunused} options combined.
4004 In order to get a warning about an unused function parameter, you must
4005 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4006 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4008 @item -Wuninitialized
4009 @opindex Wuninitialized
4010 @opindex Wno-uninitialized
4011 Warn if an automatic variable is used without first being initialized
4012 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4013 warn if a non-static reference or non-static @samp{const} member
4014 appears in a class without constructors.
4016 If you want to warn about code that uses the uninitialized value of the
4017 variable in its own initializer, use the @option{-Winit-self} option.
4019 These warnings occur for individual uninitialized or clobbered
4020 elements of structure, union or array variables as well as for
4021 variables that are uninitialized or clobbered as a whole.  They do
4022 not occur for variables or elements declared @code{volatile}.  Because
4023 these warnings depend on optimization, the exact variables or elements
4024 for which there are warnings depends on the precise optimization
4025 options and version of GCC used.
4027 Note that there may be no warning about a variable that is used only
4028 to compute a value that itself is never used, because such
4029 computations may be deleted by data flow analysis before the warnings
4030 are printed.
4032 @item -Wmaybe-uninitialized
4033 @opindex Wmaybe-uninitialized
4034 @opindex Wno-maybe-uninitialized
4035 For an automatic variable, if there exists a path from the function
4036 entry to a use of the variable that is initialized, but there exist
4037 some other paths for which the variable is not initialized, the compiler
4038 emits a warning if it cannot prove the uninitialized paths are not
4039 executed at run time. These warnings are made optional because GCC is
4040 not smart enough to see all the reasons why the code might be correct
4041 in spite of appearing to have an error.  Here is one example of how
4042 this can happen:
4044 @smallexample
4045 @group
4047   int x;
4048   switch (y)
4049     @{
4050     case 1: x = 1;
4051       break;
4052     case 2: x = 4;
4053       break;
4054     case 3: x = 5;
4055     @}
4056   foo (x);
4058 @end group
4059 @end smallexample
4061 @noindent
4062 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4063 always initialized, but GCC doesn't know this. To suppress the
4064 warning, you need to provide a default case with assert(0) or
4065 similar code.
4067 @cindex @code{longjmp} warnings
4068 This option also warns when a non-volatile automatic variable might be
4069 changed by a call to @code{longjmp}.  These warnings as well are possible
4070 only in optimizing compilation.
4072 The compiler sees only the calls to @code{setjmp}.  It cannot know
4073 where @code{longjmp} will be called; in fact, a signal handler could
4074 call it at any point in the code.  As a result, you may get a warning
4075 even when there is in fact no problem because @code{longjmp} cannot
4076 in fact be called at the place that would cause a problem.
4078 Some spurious warnings can be avoided if you declare all the functions
4079 you use that never return as @code{noreturn}.  @xref{Function
4080 Attributes}.
4082 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4084 @item -Wunknown-pragmas
4085 @opindex Wunknown-pragmas
4086 @opindex Wno-unknown-pragmas
4087 @cindex warning for unknown pragmas
4088 @cindex unknown pragmas, warning
4089 @cindex pragmas, warning of unknown
4090 Warn when a @code{#pragma} directive is encountered that is not understood by 
4091 GCC@.  If this command-line option is used, warnings are even issued
4092 for unknown pragmas in system header files.  This is not the case if
4093 the warnings are only enabled by the @option{-Wall} command-line option.
4095 @item -Wno-pragmas
4096 @opindex Wno-pragmas
4097 @opindex Wpragmas
4098 Do not warn about misuses of pragmas, such as incorrect parameters,
4099 invalid syntax, or conflicts between pragmas.  See also
4100 @option{-Wunknown-pragmas}.
4102 @item -Wstrict-aliasing
4103 @opindex Wstrict-aliasing
4104 @opindex Wno-strict-aliasing
4105 This option is only active when @option{-fstrict-aliasing} is active.
4106 It warns about code that might break the strict aliasing rules that the
4107 compiler is using for optimization.  The warning does not catch all
4108 cases, but does attempt to catch the more common pitfalls.  It is
4109 included in @option{-Wall}.
4110 It is equivalent to @option{-Wstrict-aliasing=3}
4112 @item -Wstrict-aliasing=n
4113 @opindex Wstrict-aliasing=n
4114 This option is only active when @option{-fstrict-aliasing} is active.
4115 It warns about code that might break the strict aliasing rules that the
4116 compiler is using for optimization.
4117 Higher levels correspond to higher accuracy (fewer false positives).
4118 Higher levels also correspond to more effort, similar to the way @option{-O} 
4119 works.
4120 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4122 Level 1: Most aggressive, quick, least accurate.
4123 Possibly useful when higher levels
4124 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4125 false negatives.  However, it has many false positives.
4126 Warns for all pointer conversions between possibly incompatible types,
4127 even if never dereferenced.  Runs in the front end only.
4129 Level 2: Aggressive, quick, not too precise.
4130 May still have many false positives (not as many as level 1 though),
4131 and few false negatives (but possibly more than level 1).
4132 Unlike level 1, it only warns when an address is taken.  Warns about
4133 incomplete types.  Runs in the front end only.
4135 Level 3 (default for @option{-Wstrict-aliasing}):
4136 Should have very few false positives and few false
4137 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4138 Takes care of the common pun+dereference pattern in the front end:
4139 @code{*(int*)&some_float}.
4140 If optimization is enabled, it also runs in the back end, where it deals
4141 with multiple statement cases using flow-sensitive points-to information.
4142 Only warns when the converted pointer is dereferenced.
4143 Does not warn about incomplete types.
4145 @item -Wstrict-overflow
4146 @itemx -Wstrict-overflow=@var{n}
4147 @opindex Wstrict-overflow
4148 @opindex Wno-strict-overflow
4149 This option is only active when @option{-fstrict-overflow} is active.
4150 It warns about cases where the compiler optimizes based on the
4151 assumption that signed overflow does not occur.  Note that it does not
4152 warn about all cases where the code might overflow: it only warns
4153 about cases where the compiler implements some optimization.  Thus
4154 this warning depends on the optimization level.
4156 An optimization that assumes that signed overflow does not occur is
4157 perfectly safe if the values of the variables involved are such that
4158 overflow never does, in fact, occur.  Therefore this warning can
4159 easily give a false positive: a warning about code that is not
4160 actually a problem.  To help focus on important issues, several
4161 warning levels are defined.  No warnings are issued for the use of
4162 undefined signed overflow when estimating how many iterations a loop
4163 requires, in particular when determining whether a loop will be
4164 executed at all.
4166 @table @gcctabopt
4167 @item -Wstrict-overflow=1
4168 Warn about cases that are both questionable and easy to avoid.  For
4169 example,  with @option{-fstrict-overflow}, the compiler simplifies
4170 @code{x + 1 > x} to @code{1}.  This level of
4171 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4172 are not, and must be explicitly requested.
4174 @item -Wstrict-overflow=2
4175 Also warn about other cases where a comparison is simplified to a
4176 constant.  For example: @code{abs (x) >= 0}.  This can only be
4177 simplified when @option{-fstrict-overflow} is in effect, because
4178 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4179 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4180 @option{-Wstrict-overflow=2}.
4182 @item -Wstrict-overflow=3
4183 Also warn about other cases where a comparison is simplified.  For
4184 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4186 @item -Wstrict-overflow=4
4187 Also warn about other simplifications not covered by the above cases.
4188 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4190 @item -Wstrict-overflow=5
4191 Also warn about cases where the compiler reduces the magnitude of a
4192 constant involved in a comparison.  For example: @code{x + 2 > y} is
4193 simplified to @code{x + 1 >= y}.  This is reported only at the
4194 highest warning level because this simplification applies to many
4195 comparisons, so this warning level gives a very large number of
4196 false positives.
4197 @end table
4199 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4200 @opindex Wsuggest-attribute=
4201 @opindex Wno-suggest-attribute=
4202 Warn for cases where adding an attribute may be beneficial. The
4203 attributes currently supported are listed below.
4205 @table @gcctabopt
4206 @item -Wsuggest-attribute=pure
4207 @itemx -Wsuggest-attribute=const
4208 @itemx -Wsuggest-attribute=noreturn
4209 @opindex Wsuggest-attribute=pure
4210 @opindex Wno-suggest-attribute=pure
4211 @opindex Wsuggest-attribute=const
4212 @opindex Wno-suggest-attribute=const
4213 @opindex Wsuggest-attribute=noreturn
4214 @opindex Wno-suggest-attribute=noreturn
4216 Warn about functions that might be candidates for attributes
4217 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4218 functions visible in other compilation units or (in the case of @code{pure} and
4219 @code{const}) if it cannot prove that the function returns normally. A function
4220 returns normally if it doesn't contain an infinite loop or return abnormally
4221 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4222 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4223 higher.  Higher optimization levels improve the accuracy of the analysis.
4225 @item -Wsuggest-attribute=format
4226 @itemx -Wmissing-format-attribute
4227 @opindex Wsuggest-attribute=format
4228 @opindex Wmissing-format-attribute
4229 @opindex Wno-suggest-attribute=format
4230 @opindex Wno-missing-format-attribute
4231 @opindex Wformat
4232 @opindex Wno-format
4234 Warn about function pointers that might be candidates for @code{format}
4235 attributes.  Note these are only possible candidates, not absolute ones.
4236 GCC guesses that function pointers with @code{format} attributes that
4237 are used in assignment, initialization, parameter passing or return
4238 statements should have a corresponding @code{format} attribute in the
4239 resulting type.  I.e.@: the left-hand side of the assignment or
4240 initialization, the type of the parameter variable, or the return type
4241 of the containing function respectively should also have a @code{format}
4242 attribute to avoid the warning.
4244 GCC also warns about function definitions that might be
4245 candidates for @code{format} attributes.  Again, these are only
4246 possible candidates.  GCC guesses that @code{format} attributes
4247 might be appropriate for any function that calls a function like
4248 @code{vprintf} or @code{vscanf}, but this might not always be the
4249 case, and some functions for which @code{format} attributes are
4250 appropriate may not be detected.
4251 @end table
4253 @item -Wsuggest-final-types
4254 @opindex Wno-suggest-final-types
4255 @opindex Wsuggest-final-types
4256 Warn about types with virtual methods where code quality would be improved
4257 if the type was declared with the C++11 final specifier, or, if possible,
4258 declared in an anonymous namespace. This allows GCC to more aggressively
4259 devirtualize the polymorphic calls. This warning is more effective with link
4260 time optimization, where the information about the class hierarchy graph is
4261 more complete.
4263 @item -Wsuggest-final-methods
4264 @opindex Wno-suggest-final-methods
4265 @opindex Wsuggest-final-methods
4266 Warn about virtual methods where code quality would be improved if the method
4267 was declared with the C++11 final specifier, or, if possible, its type was
4268 declared in an anonymous namespace or with the final specifier. This warning is
4269 more effective with link time optimization, where the information about the
4270 class hierarchy graph is more complete. It is recommended to first consider
4271 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4272 annotations.
4274 @item -Warray-bounds
4275 @opindex Wno-array-bounds
4276 @opindex Warray-bounds
4277 This option is only active when @option{-ftree-vrp} is active
4278 (default for @option{-O2} and above). It warns about subscripts to arrays
4279 that are always out of bounds. This warning is enabled by @option{-Wall}.
4281 @item -Wbool-compare
4282 @opindex Wno-bool-compare
4283 @opindex Wbool-compare
4284 Warn about boolean expression compared with an integer value different from
4285 @code{true}/@code{false}.  For instance, the following comparison is
4286 always false:
4287 @smallexample
4288 int n = 5;
4289 @dots{}
4290 if ((n > 1) == 2) @{ @dots{} @}
4291 @end smallexample
4292 This warning is enabled by @option{-Wall}.
4294 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4295 @opindex Wno-discarded-qualifiers
4296 @opindex Wdiscarded-qualifiers
4297 Do not warn if type qualifiers on pointers are being discarded.
4298 Typically, the compiler will warn if a @code{const char *} variable is
4299 passed to a function that takes @code{char *} parameter.  This option
4300 can be used to suppress such a warning.
4302 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4303 @opindex Wno-incompatible-pointer-types
4304 @opindex Wincompatible-pointer-types
4305 Do not warn when there is a conversion between pointers that have incompatible
4306 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4307 which warns for pointer argument passing or assignment with different
4308 signedness.
4310 @item -Wno-int-conversion @r{(C and Objective-C only)}
4311 @opindex Wno-int-conversion
4312 @opindex Wint-conversion
4313 Do not warn about incompatible integer to pointer and pointer to integer
4314 conversions.  This warning is about implicit conversions; for explicit
4315 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4316 @option{-Wno-pointer-to-int-cast} may be used.
4318 @item -Wno-div-by-zero
4319 @opindex Wno-div-by-zero
4320 @opindex Wdiv-by-zero
4321 Do not warn about compile-time integer division by zero.  Floating-point
4322 division by zero is not warned about, as it can be a legitimate way of
4323 obtaining infinities and NaNs.
4325 @item -Wsystem-headers
4326 @opindex Wsystem-headers
4327 @opindex Wno-system-headers
4328 @cindex warnings from system headers
4329 @cindex system headers, warnings from
4330 Print warning messages for constructs found in system header files.
4331 Warnings from system headers are normally suppressed, on the assumption
4332 that they usually do not indicate real problems and would only make the
4333 compiler output harder to read.  Using this command-line option tells
4334 GCC to emit warnings from system headers as if they occurred in user
4335 code.  However, note that using @option{-Wall} in conjunction with this
4336 option does @emph{not} warn about unknown pragmas in system
4337 headers---for that, @option{-Wunknown-pragmas} must also be used.
4339 @item -Wtrampolines
4340 @opindex Wtrampolines
4341 @opindex Wno-trampolines
4342 Warn about trampolines generated for pointers to nested functions.
4343 A trampoline is a small piece of data or code that is created at run
4344 time on the stack when the address of a nested function is taken, and is
4345 used to call the nested function indirectly.  For some targets, it is
4346 made up of data only and thus requires no special treatment.  But, for
4347 most targets, it is made up of code and thus requires the stack to be
4348 made executable in order for the program to work properly.
4350 @item -Wfloat-equal
4351 @opindex Wfloat-equal
4352 @opindex Wno-float-equal
4353 Warn if floating-point values are used in equality comparisons.
4355 The idea behind this is that sometimes it is convenient (for the
4356 programmer) to consider floating-point values as approximations to
4357 infinitely precise real numbers.  If you are doing this, then you need
4358 to compute (by analyzing the code, or in some other way) the maximum or
4359 likely maximum error that the computation introduces, and allow for it
4360 when performing comparisons (and when producing output, but that's a
4361 different problem).  In particular, instead of testing for equality, you
4362 should check to see whether the two values have ranges that overlap; and
4363 this is done with the relational operators, so equality comparisons are
4364 probably mistaken.
4366 @item -Wtraditional @r{(C and Objective-C only)}
4367 @opindex Wtraditional
4368 @opindex Wno-traditional
4369 Warn about certain constructs that behave differently in traditional and
4370 ISO C@.  Also warn about ISO C constructs that have no traditional C
4371 equivalent, and/or problematic constructs that should be avoided.
4373 @itemize @bullet
4374 @item
4375 Macro parameters that appear within string literals in the macro body.
4376 In traditional C macro replacement takes place within string literals,
4377 but in ISO C it does not.
4379 @item
4380 In traditional C, some preprocessor directives did not exist.
4381 Traditional preprocessors only considered a line to be a directive
4382 if the @samp{#} appeared in column 1 on the line.  Therefore
4383 @option{-Wtraditional} warns about directives that traditional C
4384 understands but ignores because the @samp{#} does not appear as the
4385 first character on the line.  It also suggests you hide directives like
4386 @samp{#pragma} not understood by traditional C by indenting them.  Some
4387 traditional implementations do not recognize @samp{#elif}, so this option
4388 suggests avoiding it altogether.
4390 @item
4391 A function-like macro that appears without arguments.
4393 @item
4394 The unary plus operator.
4396 @item
4397 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4398 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4399 constants.)  Note, these suffixes appear in macros defined in the system
4400 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4401 Use of these macros in user code might normally lead to spurious
4402 warnings, however GCC's integrated preprocessor has enough context to
4403 avoid warning in these cases.
4405 @item
4406 A function declared external in one block and then used after the end of
4407 the block.
4409 @item
4410 A @code{switch} statement has an operand of type @code{long}.
4412 @item
4413 A non-@code{static} function declaration follows a @code{static} one.
4414 This construct is not accepted by some traditional C compilers.
4416 @item
4417 The ISO type of an integer constant has a different width or
4418 signedness from its traditional type.  This warning is only issued if
4419 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4420 typically represent bit patterns, are not warned about.
4422 @item
4423 Usage of ISO string concatenation is detected.
4425 @item
4426 Initialization of automatic aggregates.
4428 @item
4429 Identifier conflicts with labels.  Traditional C lacks a separate
4430 namespace for labels.
4432 @item
4433 Initialization of unions.  If the initializer is zero, the warning is
4434 omitted.  This is done under the assumption that the zero initializer in
4435 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4436 initializer warnings and relies on default initialization to zero in the
4437 traditional C case.
4439 @item
4440 Conversions by prototypes between fixed/floating-point values and vice
4441 versa.  The absence of these prototypes when compiling with traditional
4442 C causes serious problems.  This is a subset of the possible
4443 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4445 @item
4446 Use of ISO C style function definitions.  This warning intentionally is
4447 @emph{not} issued for prototype declarations or variadic functions
4448 because these ISO C features appear in your code when using
4449 libiberty's traditional C compatibility macros, @code{PARAMS} and
4450 @code{VPARAMS}.  This warning is also bypassed for nested functions
4451 because that feature is already a GCC extension and thus not relevant to
4452 traditional C compatibility.
4453 @end itemize
4455 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4456 @opindex Wtraditional-conversion
4457 @opindex Wno-traditional-conversion
4458 Warn if a prototype causes a type conversion that is different from what
4459 would happen to the same argument in the absence of a prototype.  This
4460 includes conversions of fixed point to floating and vice versa, and
4461 conversions changing the width or signedness of a fixed-point argument
4462 except when the same as the default promotion.
4464 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4465 @opindex Wdeclaration-after-statement
4466 @opindex Wno-declaration-after-statement
4467 Warn when a declaration is found after a statement in a block.  This
4468 construct, known from C++, was introduced with ISO C99 and is by default
4469 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4470 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4472 @item -Wundef
4473 @opindex Wundef
4474 @opindex Wno-undef
4475 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4477 @item -Wno-endif-labels
4478 @opindex Wno-endif-labels
4479 @opindex Wendif-labels
4480 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4482 @item -Wshadow
4483 @opindex Wshadow
4484 @opindex Wno-shadow
4485 Warn whenever a local variable or type declaration shadows another
4486 variable, parameter, type, class member (in C++), or instance variable
4487 (in Objective-C) or whenever a built-in function is shadowed. Note
4488 that in C++, the compiler warns if a local variable shadows an
4489 explicit typedef, but not if it shadows a struct/class/enum.
4491 @item -Wno-shadow-ivar @r{(Objective-C only)}
4492 @opindex Wno-shadow-ivar
4493 @opindex Wshadow-ivar
4494 Do not warn whenever a local variable shadows an instance variable in an
4495 Objective-C method.
4497 @item -Wlarger-than=@var{len}
4498 @opindex Wlarger-than=@var{len}
4499 @opindex Wlarger-than-@var{len}
4500 Warn whenever an object of larger than @var{len} bytes is defined.
4502 @item -Wframe-larger-than=@var{len}
4503 @opindex Wframe-larger-than
4504 Warn if the size of a function frame is larger than @var{len} bytes.
4505 The computation done to determine the stack frame size is approximate
4506 and not conservative.
4507 The actual requirements may be somewhat greater than @var{len}
4508 even if you do not get a warning.  In addition, any space allocated
4509 via @code{alloca}, variable-length arrays, or related constructs
4510 is not included by the compiler when determining
4511 whether or not to issue a warning.
4513 @item -Wno-free-nonheap-object
4514 @opindex Wno-free-nonheap-object
4515 @opindex Wfree-nonheap-object
4516 Do not warn when attempting to free an object that was not allocated
4517 on the heap.
4519 @item -Wstack-usage=@var{len}
4520 @opindex Wstack-usage
4521 Warn if the stack usage of a function might be larger than @var{len} bytes.
4522 The computation done to determine the stack usage is conservative.
4523 Any space allocated via @code{alloca}, variable-length arrays, or related
4524 constructs is included by the compiler when determining whether or not to
4525 issue a warning.
4527 The message is in keeping with the output of @option{-fstack-usage}.
4529 @itemize
4530 @item
4531 If the stack usage is fully static but exceeds the specified amount, it's:
4533 @smallexample
4534   warning: stack usage is 1120 bytes
4535 @end smallexample
4536 @item
4537 If the stack usage is (partly) dynamic but bounded, it's:
4539 @smallexample
4540   warning: stack usage might be 1648 bytes
4541 @end smallexample
4542 @item
4543 If the stack usage is (partly) dynamic and not bounded, it's:
4545 @smallexample
4546   warning: stack usage might be unbounded
4547 @end smallexample
4548 @end itemize
4550 @item -Wunsafe-loop-optimizations
4551 @opindex Wunsafe-loop-optimizations
4552 @opindex Wno-unsafe-loop-optimizations
4553 Warn if the loop cannot be optimized because the compiler cannot
4554 assume anything on the bounds of the loop indices.  With
4555 @option{-funsafe-loop-optimizations} warn if the compiler makes
4556 such assumptions.
4558 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4559 @opindex Wno-pedantic-ms-format
4560 @opindex Wpedantic-ms-format
4561 When used in combination with @option{-Wformat}
4562 and @option{-pedantic} without GNU extensions, this option
4563 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4564 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4565 which depend on the MS runtime.
4567 @item -Wpointer-arith
4568 @opindex Wpointer-arith
4569 @opindex Wno-pointer-arith
4570 Warn about anything that depends on the ``size of'' a function type or
4571 of @code{void}.  GNU C assigns these types a size of 1, for
4572 convenience in calculations with @code{void *} pointers and pointers
4573 to functions.  In C++, warn also when an arithmetic operation involves
4574 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4576 @item -Wtype-limits
4577 @opindex Wtype-limits
4578 @opindex Wno-type-limits
4579 Warn if a comparison is always true or always false due to the limited
4580 range of the data type, but do not warn for constant expressions.  For
4581 example, warn if an unsigned variable is compared against zero with
4582 @samp{<} or @samp{>=}.  This warning is also enabled by
4583 @option{-Wextra}.
4585 @item -Wbad-function-cast @r{(C and Objective-C only)}
4586 @opindex Wbad-function-cast
4587 @opindex Wno-bad-function-cast
4588 Warn whenever a function call is cast to a non-matching type.
4589 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4591 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4592 @opindex Wc90-c99-compat
4593 @opindex Wno-c90-c99-compat
4594 Warn about features not present in ISO C90, but present in ISO C99.
4595 For instance, warn about use of variable length arrays, @code{long long}
4596 type, @code{bool} type, compound literals, designated initializers, and so
4597 on.  This option is independent of the standards mode.  Warnings are disabled
4598 in the expression that follows @code{__extension__}.
4600 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4601 @opindex Wc99-c11-compat
4602 @opindex Wno-c99-c11-compat
4603 Warn about features not present in ISO C99, but present in ISO C11.
4604 For instance, warn about use of anonymous structures and unions,
4605 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4606 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4607 and so on.  This option is independent of the standards mode.  Warnings are
4608 disabled in the expression that follows @code{__extension__}.
4610 @item -Wc++-compat @r{(C and Objective-C only)}
4611 Warn about ISO C constructs that are outside of the common subset of
4612 ISO C and ISO C++, e.g.@: request for implicit conversion from
4613 @code{void *} to a pointer to non-@code{void} type.
4615 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4616 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4617 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4618 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4619 enabled by @option{-Wall}.
4621 @item -Wcast-qual
4622 @opindex Wcast-qual
4623 @opindex Wno-cast-qual
4624 Warn whenever a pointer is cast so as to remove a type qualifier from
4625 the target type.  For example, warn if a @code{const char *} is cast
4626 to an ordinary @code{char *}.
4628 Also warn when making a cast that introduces a type qualifier in an
4629 unsafe way.  For example, casting @code{char **} to @code{const char **}
4630 is unsafe, as in this example:
4632 @smallexample
4633   /* p is char ** value.  */
4634   const char **q = (const char **) p;
4635   /* Assignment of readonly string to const char * is OK.  */
4636   *q = "string";
4637   /* Now char** pointer points to read-only memory.  */
4638   **p = 'b';
4639 @end smallexample
4641 @item -Wcast-align
4642 @opindex Wcast-align
4643 @opindex Wno-cast-align
4644 Warn whenever a pointer is cast such that the required alignment of the
4645 target is increased.  For example, warn if a @code{char *} is cast to
4646 an @code{int *} on machines where integers can only be accessed at
4647 two- or four-byte boundaries.
4649 @item -Wwrite-strings
4650 @opindex Wwrite-strings
4651 @opindex Wno-write-strings
4652 When compiling C, give string constants the type @code{const
4653 char[@var{length}]} so that copying the address of one into a
4654 non-@code{const} @code{char *} pointer produces a warning.  These
4655 warnings help you find at compile time code that can try to write
4656 into a string constant, but only if you have been very careful about
4657 using @code{const} in declarations and prototypes.  Otherwise, it is
4658 just a nuisance. This is why we did not make @option{-Wall} request
4659 these warnings.
4661 When compiling C++, warn about the deprecated conversion from string
4662 literals to @code{char *}.  This warning is enabled by default for C++
4663 programs.
4665 @item -Wclobbered
4666 @opindex Wclobbered
4667 @opindex Wno-clobbered
4668 Warn for variables that might be changed by @samp{longjmp} or
4669 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4671 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4672 @opindex Wconditionally-supported
4673 @opindex Wno-conditionally-supported
4674 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4676 @item -Wconversion
4677 @opindex Wconversion
4678 @opindex Wno-conversion
4679 Warn for implicit conversions that may alter a value. This includes
4680 conversions between real and integer, like @code{abs (x)} when
4681 @code{x} is @code{double}; conversions between signed and unsigned,
4682 like @code{unsigned ui = -1}; and conversions to smaller types, like
4683 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4684 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4685 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4686 conversions between signed and unsigned integers can be disabled by
4687 using @option{-Wno-sign-conversion}.
4689 For C++, also warn for confusing overload resolution for user-defined
4690 conversions; and conversions that never use a type conversion
4691 operator: conversions to @code{void}, the same type, a base class or a
4692 reference to them. Warnings about conversions between signed and
4693 unsigned integers are disabled by default in C++ unless
4694 @option{-Wsign-conversion} is explicitly enabled.
4696 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4697 @opindex Wconversion-null
4698 @opindex Wno-conversion-null
4699 Do not warn for conversions between @code{NULL} and non-pointer
4700 types. @option{-Wconversion-null} is enabled by default.
4702 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4703 @opindex Wzero-as-null-pointer-constant
4704 @opindex Wno-zero-as-null-pointer-constant
4705 Warn when a literal '0' is used as null pointer constant.  This can
4706 be useful to facilitate the conversion to @code{nullptr} in C++11.
4708 @item -Wdate-time
4709 @opindex Wdate-time
4710 @opindex Wno-date-time
4711 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4712 are encountered as they might prevent bit-wise-identical reproducible
4713 compilations.
4715 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4716 @opindex Wdelete-incomplete
4717 @opindex Wno-delete-incomplete
4718 Warn when deleting a pointer to incomplete type, which may cause
4719 undefined behavior at runtime.  This warning is enabled by default.
4721 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4722 @opindex Wuseless-cast
4723 @opindex Wno-useless-cast
4724 Warn when an expression is casted to its own type.
4726 @item -Wempty-body
4727 @opindex Wempty-body
4728 @opindex Wno-empty-body
4729 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4730 while} statement.  This warning is also enabled by @option{-Wextra}.
4732 @item -Wenum-compare
4733 @opindex Wenum-compare
4734 @opindex Wno-enum-compare
4735 Warn about a comparison between values of different enumerated types.
4736 In C++ enumeral mismatches in conditional expressions are also
4737 diagnosed and the warning is enabled by default.  In C this warning is 
4738 enabled by @option{-Wall}.
4740 @item -Wjump-misses-init @r{(C, Objective-C only)}
4741 @opindex Wjump-misses-init
4742 @opindex Wno-jump-misses-init
4743 Warn if a @code{goto} statement or a @code{switch} statement jumps
4744 forward across the initialization of a variable, or jumps backward to a
4745 label after the variable has been initialized.  This only warns about
4746 variables that are initialized when they are declared.  This warning is
4747 only supported for C and Objective-C; in C++ this sort of branch is an
4748 error in any case.
4750 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4751 can be disabled with the @option{-Wno-jump-misses-init} option.
4753 @item -Wsign-compare
4754 @opindex Wsign-compare
4755 @opindex Wno-sign-compare
4756 @cindex warning for comparison of signed and unsigned values
4757 @cindex comparison of signed and unsigned values, warning
4758 @cindex signed and unsigned values, comparison warning
4759 Warn when a comparison between signed and unsigned values could produce
4760 an incorrect result when the signed value is converted to unsigned.
4761 This warning is also enabled by @option{-Wextra}; to get the other warnings
4762 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4764 @item -Wsign-conversion
4765 @opindex Wsign-conversion
4766 @opindex Wno-sign-conversion
4767 Warn for implicit conversions that may change the sign of an integer
4768 value, like assigning a signed integer expression to an unsigned
4769 integer variable. An explicit cast silences the warning. In C, this
4770 option is enabled also by @option{-Wconversion}.
4772 @item -Wfloat-conversion
4773 @opindex Wfloat-conversion
4774 @opindex Wno-float-conversion
4775 Warn for implicit conversions that reduce the precision of a real value.
4776 This includes conversions from real to integer, and from higher precision
4777 real to lower precision real values.  This option is also enabled by
4778 @option{-Wconversion}.
4780 @item -Wsizeof-pointer-memaccess
4781 @opindex Wsizeof-pointer-memaccess
4782 @opindex Wno-sizeof-pointer-memaccess
4783 Warn for suspicious length parameters to certain string and memory built-in
4784 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4785 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4786 but a pointer, and suggests a possible fix, or about
4787 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4788 @option{-Wall}.
4790 @item -Wsizeof-array-argument
4791 @opindex Wsizeof-array-argument
4792 @opindex Wno-sizeof-array-argument
4793 Warn when the @code{sizeof} operator is applied to a parameter that is
4794 declared as an array in a function definition.  This warning is enabled by
4795 default for C and C++ programs.
4797 @item -Wmemset-transposed-args
4798 @opindex Wmemset-transposed-args
4799 @opindex Wno-memset-transposed-args
4800 Warn for suspicious calls to the @code{memset} built-in function, if the
4801 second argument is not zero and the third argument is zero.  This warns e.g.@
4802 about @code{memset (buf, sizeof buf, 0)} where most probably
4803 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4804 is only emitted if the third argument is literal zero, if it is some expression
4805 that is folded to zero, or e.g. a cast of zero to some type etc., it
4806 is far less likely that user has mistakenly exchanged the arguments and
4807 no warning is emitted.  This warning is enabled by @option{-Wall}.
4809 @item -Waddress
4810 @opindex Waddress
4811 @opindex Wno-address
4812 Warn about suspicious uses of memory addresses. These include using
4813 the address of a function in a conditional expression, such as
4814 @code{void func(void); if (func)}, and comparisons against the memory
4815 address of a string literal, such as @code{if (x == "abc")}.  Such
4816 uses typically indicate a programmer error: the address of a function
4817 always evaluates to true, so their use in a conditional usually
4818 indicate that the programmer forgot the parentheses in a function
4819 call; and comparisons against string literals result in unspecified
4820 behavior and are not portable in C, so they usually indicate that the
4821 programmer intended to use @code{strcmp}.  This warning is enabled by
4822 @option{-Wall}.
4824 @item -Wlogical-op
4825 @opindex Wlogical-op
4826 @opindex Wno-logical-op
4827 Warn about suspicious uses of logical operators in expressions.
4828 This includes using logical operators in contexts where a
4829 bit-wise operator is likely to be expected.
4831 @item -Wlogical-not-parentheses
4832 @opindex Wlogical-not-parentheses
4833 @opindex Wno-logical-not-parentheses
4834 Warn about logical not used on the left hand side operand of a comparison.
4835 This option does not warn if the RHS operand is of a boolean type.  Its
4836 purpose is to detect suspicious code like the following:
4837 @smallexample
4838 int a;
4839 @dots{}
4840 if (!a > 1) @{ @dots{} @}
4841 @end smallexample
4843 It is possible to suppress the warning by wrapping the LHS into
4844 parentheses:
4845 @smallexample
4846 if ((!a) > 1) @{ @dots{} @}
4847 @end smallexample
4849 This warning is enabled by @option{-Wall}.
4851 @item -Waggregate-return
4852 @opindex Waggregate-return
4853 @opindex Wno-aggregate-return
4854 Warn if any functions that return structures or unions are defined or
4855 called.  (In languages where you can return an array, this also elicits
4856 a warning.)
4858 @item -Wno-aggressive-loop-optimizations
4859 @opindex Wno-aggressive-loop-optimizations
4860 @opindex Waggressive-loop-optimizations
4861 Warn if in a loop with constant number of iterations the compiler detects
4862 undefined behavior in some statement during one or more of the iterations.
4864 @item -Wno-attributes
4865 @opindex Wno-attributes
4866 @opindex Wattributes
4867 Do not warn if an unexpected @code{__attribute__} is used, such as
4868 unrecognized attributes, function attributes applied to variables,
4869 etc.  This does not stop errors for incorrect use of supported
4870 attributes.
4872 @item -Wno-builtin-macro-redefined
4873 @opindex Wno-builtin-macro-redefined
4874 @opindex Wbuiltin-macro-redefined
4875 Do not warn if certain built-in macros are redefined.  This suppresses
4876 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4877 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4879 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4880 @opindex Wstrict-prototypes
4881 @opindex Wno-strict-prototypes
4882 Warn if a function is declared or defined without specifying the
4883 argument types.  (An old-style function definition is permitted without
4884 a warning if preceded by a declaration that specifies the argument
4885 types.)
4887 @item -Wold-style-declaration @r{(C and Objective-C only)}
4888 @opindex Wold-style-declaration
4889 @opindex Wno-old-style-declaration
4890 Warn for obsolescent usages, according to the C Standard, in a
4891 declaration. For example, warn if storage-class specifiers like
4892 @code{static} are not the first things in a declaration.  This warning
4893 is also enabled by @option{-Wextra}.
4895 @item -Wold-style-definition @r{(C and Objective-C only)}
4896 @opindex Wold-style-definition
4897 @opindex Wno-old-style-definition
4898 Warn if an old-style function definition is used.  A warning is given
4899 even if there is a previous prototype.
4901 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4902 @opindex Wmissing-parameter-type
4903 @opindex Wno-missing-parameter-type
4904 A function parameter is declared without a type specifier in K&R-style
4905 functions:
4907 @smallexample
4908 void foo(bar) @{ @}
4909 @end smallexample
4911 This warning is also enabled by @option{-Wextra}.
4913 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4914 @opindex Wmissing-prototypes
4915 @opindex Wno-missing-prototypes
4916 Warn if a global function is defined without a previous prototype
4917 declaration.  This warning is issued even if the definition itself
4918 provides a prototype.  Use this option to detect global functions
4919 that do not have a matching prototype declaration in a header file.
4920 This option is not valid for C++ because all function declarations
4921 provide prototypes and a non-matching declaration will declare an
4922 overload rather than conflict with an earlier declaration.
4923 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4925 @item -Wmissing-declarations
4926 @opindex Wmissing-declarations
4927 @opindex Wno-missing-declarations
4928 Warn if a global function is defined without a previous declaration.
4929 Do so even if the definition itself provides a prototype.
4930 Use this option to detect global functions that are not declared in
4931 header files.  In C, no warnings are issued for functions with previous
4932 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4933 missing prototypes.  In C++, no warnings are issued for function templates,
4934 or for inline functions, or for functions in anonymous namespaces.
4936 @item -Wmissing-field-initializers
4937 @opindex Wmissing-field-initializers
4938 @opindex Wno-missing-field-initializers
4939 @opindex W
4940 @opindex Wextra
4941 @opindex Wno-extra
4942 Warn if a structure's initializer has some fields missing.  For
4943 example, the following code causes such a warning, because
4944 @code{x.h} is implicitly zero:
4946 @smallexample
4947 struct s @{ int f, g, h; @};
4948 struct s x = @{ 3, 4 @};
4949 @end smallexample
4951 This option does not warn about designated initializers, so the following
4952 modification does not trigger a warning:
4954 @smallexample
4955 struct s @{ int f, g, h; @};
4956 struct s x = @{ .f = 3, .g = 4 @};
4957 @end smallexample
4959 In C++ this option does not warn either about the empty @{ @}
4960 initializer, for example:
4962 @smallexample
4963 struct s @{ int f, g, h; @};
4964 s x = @{ @};
4965 @end smallexample
4967 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4968 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4970 @item -Wno-multichar
4971 @opindex Wno-multichar
4972 @opindex Wmultichar
4973 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4974 Usually they indicate a typo in the user's code, as they have
4975 implementation-defined values, and should not be used in portable code.
4977 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
4978 @opindex Wnormalized=
4979 @opindex Wnormalized
4980 @opindex Wno-normalized
4981 @cindex NFC
4982 @cindex NFKC
4983 @cindex character set, input normalization
4984 In ISO C and ISO C++, two identifiers are different if they are
4985 different sequences of characters.  However, sometimes when characters
4986 outside the basic ASCII character set are used, you can have two
4987 different character sequences that look the same.  To avoid confusion,
4988 the ISO 10646 standard sets out some @dfn{normalization rules} which
4989 when applied ensure that two sequences that look the same are turned into
4990 the same sequence.  GCC can warn you if you are using identifiers that
4991 have not been normalized; this option controls that warning.
4993 There are four levels of warning supported by GCC@.  The default is
4994 @option{-Wnormalized=nfc}, which warns about any identifier that is
4995 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4996 recommended form for most uses.  It is equivalent to
4997 @option{-Wnormalized}.
4999 Unfortunately, there are some characters allowed in identifiers by
5000 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5001 identifiers.  That is, there's no way to use these symbols in portable
5002 ISO C or C++ and have all your identifiers in NFC@.
5003 @option{-Wnormalized=id} suppresses the warning for these characters.
5004 It is hoped that future versions of the standards involved will correct
5005 this, which is why this option is not the default.
5007 You can switch the warning off for all characters by writing
5008 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5009 only do this if you are using some other normalization scheme (like
5010 ``D''), because otherwise you can easily create bugs that are
5011 literally impossible to see.
5013 Some characters in ISO 10646 have distinct meanings but look identical
5014 in some fonts or display methodologies, especially once formatting has
5015 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5016 LETTER N'', displays just like a regular @code{n} that has been
5017 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5018 normalization scheme to convert all these into a standard form as
5019 well, and GCC warns if your code is not in NFKC if you use
5020 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5021 about every identifier that contains the letter O because it might be
5022 confused with the digit 0, and so is not the default, but may be
5023 useful as a local coding convention if the programming environment 
5024 cannot be fixed to display these characters distinctly.
5026 @item -Wno-deprecated
5027 @opindex Wno-deprecated
5028 @opindex Wdeprecated
5029 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5031 @item -Wno-deprecated-declarations
5032 @opindex Wno-deprecated-declarations
5033 @opindex Wdeprecated-declarations
5034 Do not warn about uses of functions (@pxref{Function Attributes}),
5035 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5036 Attributes}) marked as deprecated by using the @code{deprecated}
5037 attribute.
5039 @item -Wno-overflow
5040 @opindex Wno-overflow
5041 @opindex Woverflow
5042 Do not warn about compile-time overflow in constant expressions.
5044 @item -Wno-odr
5045 @opindex Wno-odr
5046 @opindex Wodr
5047 Warn about One Definition Rule violations during link-time optimization.
5048 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5050 @item -Wopenmp-simd
5051 @opindex Wopenm-simd
5052 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5053 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
5054 be used to relax the cost model.
5056 @item -Woverride-init @r{(C and Objective-C only)}
5057 @opindex Woverride-init
5058 @opindex Wno-override-init
5059 @opindex W
5060 @opindex Wextra
5061 @opindex Wno-extra
5062 Warn if an initialized field without side effects is overridden when
5063 using designated initializers (@pxref{Designated Inits, , Designated
5064 Initializers}).
5066 This warning is included in @option{-Wextra}.  To get other
5067 @option{-Wextra} warnings without this one, use @option{-Wextra
5068 -Wno-override-init}.
5070 @item -Wpacked
5071 @opindex Wpacked
5072 @opindex Wno-packed
5073 Warn if a structure is given the packed attribute, but the packed
5074 attribute has no effect on the layout or size of the structure.
5075 Such structures may be mis-aligned for little benefit.  For
5076 instance, in this code, the variable @code{f.x} in @code{struct bar}
5077 is misaligned even though @code{struct bar} does not itself
5078 have the packed attribute:
5080 @smallexample
5081 @group
5082 struct foo @{
5083   int x;
5084   char a, b, c, d;
5085 @} __attribute__((packed));
5086 struct bar @{
5087   char z;
5088   struct foo f;
5090 @end group
5091 @end smallexample
5093 @item -Wpacked-bitfield-compat
5094 @opindex Wpacked-bitfield-compat
5095 @opindex Wno-packed-bitfield-compat
5096 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5097 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5098 the change can lead to differences in the structure layout.  GCC
5099 informs you when the offset of such a field has changed in GCC 4.4.
5100 For example there is no longer a 4-bit padding between field @code{a}
5101 and @code{b} in this structure:
5103 @smallexample
5104 struct foo
5106   char a:4;
5107   char b:8;
5108 @} __attribute__ ((packed));
5109 @end smallexample
5111 This warning is enabled by default.  Use
5112 @option{-Wno-packed-bitfield-compat} to disable this warning.
5114 @item -Wpadded
5115 @opindex Wpadded
5116 @opindex Wno-padded
5117 Warn if padding is included in a structure, either to align an element
5118 of the structure or to align the whole structure.  Sometimes when this
5119 happens it is possible to rearrange the fields of the structure to
5120 reduce the padding and so make the structure smaller.
5122 @item -Wredundant-decls
5123 @opindex Wredundant-decls
5124 @opindex Wno-redundant-decls
5125 Warn if anything is declared more than once in the same scope, even in
5126 cases where multiple declaration is valid and changes nothing.
5128 @item -Wnested-externs @r{(C and Objective-C only)}
5129 @opindex Wnested-externs
5130 @opindex Wno-nested-externs
5131 Warn if an @code{extern} declaration is encountered within a function.
5133 @item -Wno-inherited-variadic-ctor
5134 @opindex Winherited-variadic-ctor
5135 @opindex Wno-inherited-variadic-ctor
5136 Suppress warnings about use of C++11 inheriting constructors when the
5137 base class inherited from has a C variadic constructor; the warning is
5138 on by default because the ellipsis is not inherited.
5140 @item -Winline
5141 @opindex Winline
5142 @opindex Wno-inline
5143 Warn if a function that is declared as inline cannot be inlined.
5144 Even with this option, the compiler does not warn about failures to
5145 inline functions declared in system headers.
5147 The compiler uses a variety of heuristics to determine whether or not
5148 to inline a function.  For example, the compiler takes into account
5149 the size of the function being inlined and the amount of inlining
5150 that has already been done in the current function.  Therefore,
5151 seemingly insignificant changes in the source program can cause the
5152 warnings produced by @option{-Winline} to appear or disappear.
5154 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5155 @opindex Wno-invalid-offsetof
5156 @opindex Winvalid-offsetof
5157 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
5158 type.  According to the 2014 ISO C++ standard, applying @samp{offsetof}
5159 to a non-standard-layout type is undefined.  In existing C++ implementations,
5160 however, @samp{offsetof} typically gives meaningful results.
5161 This flag is for users who are aware that they are
5162 writing nonportable code and who have deliberately chosen to ignore the
5163 warning about it.
5165 The restrictions on @samp{offsetof} may be relaxed in a future version
5166 of the C++ standard.
5168 @item -Wno-int-to-pointer-cast
5169 @opindex Wno-int-to-pointer-cast
5170 @opindex Wint-to-pointer-cast
5171 Suppress warnings from casts to pointer type of an integer of a
5172 different size. In C++, casting to a pointer type of smaller size is
5173 an error. @option{Wint-to-pointer-cast} is enabled by default.
5176 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5177 @opindex Wno-pointer-to-int-cast
5178 @opindex Wpointer-to-int-cast
5179 Suppress warnings from casts from a pointer to an integer type of a
5180 different size.
5182 @item -Winvalid-pch
5183 @opindex Winvalid-pch
5184 @opindex Wno-invalid-pch
5185 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5186 the search path but can't be used.
5188 @item -Wlong-long
5189 @opindex Wlong-long
5190 @opindex Wno-long-long
5191 Warn if @samp{long long} type is used.  This is enabled by either
5192 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5193 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5195 @item -Wvariadic-macros
5196 @opindex Wvariadic-macros
5197 @opindex Wno-variadic-macros
5198 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5199 alternate syntax is used in ISO C99 mode.  This is enabled by either
5200 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5201 messages, use @option{-Wno-variadic-macros}.
5203 @item -Wvarargs
5204 @opindex Wvarargs
5205 @opindex Wno-varargs
5206 Warn upon questionable usage of the macros used to handle variable
5207 arguments like @samp{va_start}.  This is default.  To inhibit the
5208 warning messages, use @option{-Wno-varargs}.
5210 @item -Wvector-operation-performance
5211 @opindex Wvector-operation-performance
5212 @opindex Wno-vector-operation-performance
5213 Warn if vector operation is not implemented via SIMD capabilities of the
5214 architecture.  Mainly useful for the performance tuning.
5215 Vector operation can be implemented @code{piecewise}, which means that the
5216 scalar operation is performed on every vector element; 
5217 @code{in parallel}, which means that the vector operation is implemented
5218 using scalars of wider type, which normally is more performance efficient;
5219 and @code{as a single scalar}, which means that vector fits into a
5220 scalar type.
5222 @item -Wno-virtual-move-assign
5223 @opindex Wvirtual-move-assign
5224 @opindex Wno-virtual-move-assign
5225 Suppress warnings about inheriting from a virtual base with a
5226 non-trivial C++11 move assignment operator.  This is dangerous because
5227 if the virtual base is reachable along more than one path, it will be
5228 moved multiple times, which can mean both objects end up in the
5229 moved-from state.  If the move assignment operator is written to avoid
5230 moving from a moved-from object, this warning can be disabled.
5232 @item -Wvla
5233 @opindex Wvla
5234 @opindex Wno-vla
5235 Warn if variable length array is used in the code.
5236 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5237 the variable length array.
5239 @item -Wvolatile-register-var
5240 @opindex Wvolatile-register-var
5241 @opindex Wno-volatile-register-var
5242 Warn if a register variable is declared volatile.  The volatile
5243 modifier does not inhibit all optimizations that may eliminate reads
5244 and/or writes to register variables.  This warning is enabled by
5245 @option{-Wall}.
5247 @item -Wdisabled-optimization
5248 @opindex Wdisabled-optimization
5249 @opindex Wno-disabled-optimization
5250 Warn if a requested optimization pass is disabled.  This warning does
5251 not generally indicate that there is anything wrong with your code; it
5252 merely indicates that GCC's optimizers are unable to handle the code
5253 effectively.  Often, the problem is that your code is too big or too
5254 complex; GCC refuses to optimize programs when the optimization
5255 itself is likely to take inordinate amounts of time.
5257 @item -Wpointer-sign @r{(C and Objective-C only)}
5258 @opindex Wpointer-sign
5259 @opindex Wno-pointer-sign
5260 Warn for pointer argument passing or assignment with different signedness.
5261 This option is only supported for C and Objective-C@.  It is implied by
5262 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5263 @option{-Wno-pointer-sign}.
5265 @item -Wstack-protector
5266 @opindex Wstack-protector
5267 @opindex Wno-stack-protector
5268 This option is only active when @option{-fstack-protector} is active.  It
5269 warns about functions that are not protected against stack smashing.
5271 @item -Woverlength-strings
5272 @opindex Woverlength-strings
5273 @opindex Wno-overlength-strings
5274 Warn about string constants that are longer than the ``minimum
5275 maximum'' length specified in the C standard.  Modern compilers
5276 generally allow string constants that are much longer than the
5277 standard's minimum limit, but very portable programs should avoid
5278 using longer strings.
5280 The limit applies @emph{after} string constant concatenation, and does
5281 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5282 C99, it was raised to 4095.  C++98 does not specify a normative
5283 minimum maximum, so we do not diagnose overlength strings in C++@.
5285 This option is implied by @option{-Wpedantic}, and can be disabled with
5286 @option{-Wno-overlength-strings}.
5288 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5289 @opindex Wunsuffixed-float-constants
5291 Issue a warning for any floating constant that does not have
5292 a suffix.  When used together with @option{-Wsystem-headers} it
5293 warns about such constants in system header files.  This can be useful
5294 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5295 from the decimal floating-point extension to C99.
5297 @item -Wno-designated-init @r{(C and Objective-C only)}
5298 Suppress warnings when a positional initializer is used to initialize
5299 a structure that has been marked with the @code{designated_init}
5300 attribute.
5302 @end table
5304 @node Debugging Options
5305 @section Options for Debugging Your Program or GCC
5306 @cindex options, debugging
5307 @cindex debugging information options
5309 GCC has various special options that are used for debugging
5310 either your program or GCC:
5312 @table @gcctabopt
5313 @item -g
5314 @opindex g
5315 Produce debugging information in the operating system's native format
5316 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5317 information.
5319 On most systems that use stabs format, @option{-g} enables use of extra
5320 debugging information that only GDB can use; this extra information
5321 makes debugging work better in GDB but probably makes other debuggers
5322 crash or
5323 refuse to read the program.  If you want to control for certain whether
5324 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5325 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5327 GCC allows you to use @option{-g} with
5328 @option{-O}.  The shortcuts taken by optimized code may occasionally
5329 produce surprising results: some variables you declared may not exist
5330 at all; flow of control may briefly move where you did not expect it;
5331 some statements may not be executed because they compute constant
5332 results or their values are already at hand; some statements may
5333 execute in different places because they have been moved out of loops.
5335 Nevertheless it proves possible to debug optimized output.  This makes
5336 it reasonable to use the optimizer for programs that might have bugs.
5338 The following options are useful when GCC is generated with the
5339 capability for more than one debugging format.
5341 @item -gsplit-dwarf
5342 @opindex gsplit-dwarf
5343 Separate as much dwarf debugging information as possible into a
5344 separate output file with the extension .dwo.  This option allows
5345 the build system to avoid linking files with debug information.  To
5346 be useful, this option requires a debugger capable of reading .dwo
5347 files.
5349 @item -ggdb
5350 @opindex ggdb
5351 Produce debugging information for use by GDB@.  This means to use the
5352 most expressive format available (DWARF 2, stabs, or the native format
5353 if neither of those are supported), including GDB extensions if at all
5354 possible.
5356 @item -gpubnames
5357 @opindex gpubnames
5358 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5360 @item -ggnu-pubnames
5361 @opindex ggnu-pubnames
5362 Generate .debug_pubnames and .debug_pubtypes sections in a format
5363 suitable for conversion into a GDB@ index.  This option is only useful
5364 with a linker that can produce GDB@ index version 7.
5366 @item -gstabs
5367 @opindex gstabs
5368 Produce debugging information in stabs format (if that is supported),
5369 without GDB extensions.  This is the format used by DBX on most BSD
5370 systems.  On MIPS, Alpha and System V Release 4 systems this option
5371 produces stabs debugging output that is not understood by DBX or SDB@.
5372 On System V Release 4 systems this option requires the GNU assembler.
5374 @item -feliminate-unused-debug-symbols
5375 @opindex feliminate-unused-debug-symbols
5376 Produce debugging information in stabs format (if that is supported),
5377 for only symbols that are actually used.
5379 @item -femit-class-debug-always
5380 Instead of emitting debugging information for a C++ class in only one
5381 object file, emit it in all object files using the class.  This option
5382 should be used only with debuggers that are unable to handle the way GCC
5383 normally emits debugging information for classes because using this
5384 option increases the size of debugging information by as much as a
5385 factor of two.
5387 @item -fdebug-types-section
5388 @opindex fdebug-types-section
5389 @opindex fno-debug-types-section
5390 When using DWARF Version 4 or higher, type DIEs can be put into
5391 their own @code{.debug_types} section instead of making them part of the
5392 @code{.debug_info} section.  It is more efficient to put them in a separate
5393 comdat sections since the linker can then remove duplicates.
5394 But not all DWARF consumers support @code{.debug_types} sections yet
5395 and on some objects @code{.debug_types} produces larger instead of smaller
5396 debugging information.
5398 @item -gstabs+
5399 @opindex gstabs+
5400 Produce debugging information in stabs format (if that is supported),
5401 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5402 use of these extensions is likely to make other debuggers crash or
5403 refuse to read the program.
5405 @item -gcoff
5406 @opindex gcoff
5407 Produce debugging information in COFF format (if that is supported).
5408 This is the format used by SDB on most System V systems prior to
5409 System V Release 4.
5411 @item -gxcoff
5412 @opindex gxcoff
5413 Produce debugging information in XCOFF format (if that is supported).
5414 This is the format used by the DBX debugger on IBM RS/6000 systems.
5416 @item -gxcoff+
5417 @opindex gxcoff+
5418 Produce debugging information in XCOFF format (if that is supported),
5419 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5420 use of these extensions is likely to make other debuggers crash or
5421 refuse to read the program, and may cause assemblers other than the GNU
5422 assembler (GAS) to fail with an error.
5424 @item -gdwarf-@var{version}
5425 @opindex gdwarf-@var{version}
5426 Produce debugging information in DWARF format (if that is supported).
5427 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5428 for most targets is 4.  DWARF Version 5 is only experimental.
5430 Note that with DWARF Version 2, some ports require and always
5431 use some non-conflicting DWARF 3 extensions in the unwind tables.
5433 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5434 for maximum benefit.
5436 @item -grecord-gcc-switches
5437 @opindex grecord-gcc-switches
5438 This switch causes the command-line options used to invoke the
5439 compiler that may affect code generation to be appended to the
5440 DW_AT_producer attribute in DWARF debugging information.  The options
5441 are concatenated with spaces separating them from each other and from
5442 the compiler version.  See also @option{-frecord-gcc-switches} for another
5443 way of storing compiler options into the object file.  This is the default.
5445 @item -gno-record-gcc-switches
5446 @opindex gno-record-gcc-switches
5447 Disallow appending command-line options to the DW_AT_producer attribute
5448 in DWARF debugging information.
5450 @item -gstrict-dwarf
5451 @opindex gstrict-dwarf
5452 Disallow using extensions of later DWARF standard version than selected
5453 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5454 DWARF extensions from later standard versions is allowed.
5456 @item -gno-strict-dwarf
5457 @opindex gno-strict-dwarf
5458 Allow using extensions of later DWARF standard version than selected with
5459 @option{-gdwarf-@var{version}}.
5461 @item -gz@r{[}=@var{type}@r{]}
5462 @opindex gz
5463 Produce compressed debug sections in DWARF format, if that is supported.
5464 If @var{type} is not given, the default type depends on the capabilities
5465 of the assembler and linker used.  @var{type} may be one of
5466 @option{none} (don't compress debug sections), @option{zlib} (use zlib
5467 compression in ELF gABI format), or @option{zlib-gnu} (use zlib
5468 compression in traditional GNU format).  If the linker doesn't support
5469 writing compressed debug sections, the option is rejected.  Otherwise,
5470 if the assembler does not support them, @option{-gz} is silently ignored
5471 when producing object files.
5473 @item -gvms
5474 @opindex gvms
5475 Produce debugging information in Alpha/VMS debug format (if that is
5476 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5478 @item -g@var{level}
5479 @itemx -ggdb@var{level}
5480 @itemx -gstabs@var{level}
5481 @itemx -gcoff@var{level}
5482 @itemx -gxcoff@var{level}
5483 @itemx -gvms@var{level}
5484 Request debugging information and also use @var{level} to specify how
5485 much information.  The default level is 2.
5487 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5488 @option{-g}.
5490 Level 1 produces minimal information, enough for making backtraces in
5491 parts of the program that you don't plan to debug.  This includes
5492 descriptions of functions and external variables, and line number
5493 tables, but no information about local variables.
5495 Level 3 includes extra information, such as all the macro definitions
5496 present in the program.  Some debuggers support macro expansion when
5497 you use @option{-g3}.
5499 @option{-gdwarf-2} does not accept a concatenated debug level, because
5500 GCC used to support an option @option{-gdwarf} that meant to generate
5501 debug information in version 1 of the DWARF format (which is very
5502 different from version 2), and it would have been too confusing.  That
5503 debug format is long obsolete, but the option cannot be changed now.
5504 Instead use an additional @option{-g@var{level}} option to change the
5505 debug level for DWARF.
5507 @item -gtoggle
5508 @opindex gtoggle
5509 Turn off generation of debug info, if leaving out this option
5510 generates it, or turn it on at level 2 otherwise.  The position of this
5511 argument in the command line does not matter; it takes effect after all
5512 other options are processed, and it does so only once, no matter how
5513 many times it is given.  This is mainly intended to be used with
5514 @option{-fcompare-debug}.
5516 @item -fsanitize=address
5517 @opindex fsanitize=address
5518 Enable AddressSanitizer, a fast memory error detector.
5519 Memory access instructions will be instrumented to detect
5520 out-of-bounds and use-after-free bugs.
5521 See @uref{http://code.google.com/p/address-sanitizer/} for
5522 more details.  The run-time behavior can be influenced using the
5523 @env{ASAN_OPTIONS} environment variable; see
5524 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5525 a list of supported options.
5527 @item -fsanitize=kernel-address
5528 @opindex fsanitize=kernel-address
5529 Enable AddressSanitizer for Linux kernel.
5530 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5532 @item -fsanitize=thread
5533 @opindex fsanitize=thread
5534 Enable ThreadSanitizer, a fast data race detector.
5535 Memory access instructions will be instrumented to detect
5536 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5537 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5538 environment variable; see
5539 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5540 supported options.
5542 @item -fsanitize=leak
5543 @opindex fsanitize=leak
5544 Enable LeakSanitizer, a memory leak detector.
5545 This option only matters for linking of executables and if neither
5546 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5547 case it will link the executable against a library that overrides @code{malloc}
5548 and other allocator functions.  See
5549 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5550 details.  The run-time behavior can be influenced using the
5551 @env{LSAN_OPTIONS} environment variable.
5553 @item -fsanitize=undefined
5554 @opindex fsanitize=undefined
5555 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5556 Various computations will be instrumented to detect undefined behavior
5557 at runtime.  Current suboptions are:
5559 @table @gcctabopt
5561 @item -fsanitize=shift
5562 @opindex fsanitize=shift
5563 This option enables checking that the result of a shift operation is
5564 not undefined.  Note that what exactly is considered undefined differs
5565 slightly between C and C++, as well as between ISO C90 and C99, etc.
5567 @item -fsanitize=integer-divide-by-zero
5568 @opindex fsanitize=integer-divide-by-zero
5569 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5571 @item -fsanitize=unreachable
5572 @opindex fsanitize=unreachable
5573 With this option, the compiler will turn the @code{__builtin_unreachable}
5574 call into a diagnostics message call instead.  When reaching the
5575 @code{__builtin_unreachable} call, the behavior is undefined.
5577 @item -fsanitize=vla-bound
5578 @opindex fsanitize=vla-bound
5579 This option instructs the compiler to check that the size of a variable
5580 length array is positive.  This option does not have any effect in
5581 @option{-std=c++14} mode, as the standard requires the exception be thrown
5582 instead.
5584 @item -fsanitize=null
5585 @opindex fsanitize=null
5586 This option enables pointer checking.  Particularly, the application
5587 built with this option turned on will issue an error message when it
5588 tries to dereference a NULL pointer, or if a reference (possibly an
5589 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5590 on an object pointed by a NULL pointer.
5592 @item -fsanitize=return
5593 @opindex fsanitize=return
5594 This option enables return statement checking.  Programs
5595 built with this option turned on will issue an error message
5596 when the end of a non-void function is reached without actually
5597 returning a value.  This option works in C++ only.
5599 @item -fsanitize=signed-integer-overflow
5600 @opindex fsanitize=signed-integer-overflow
5601 This option enables signed integer overflow checking.  We check that
5602 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5603 does not overflow in the signed arithmetics.  Note, integer promotion
5604 rules must be taken into account.  That is, the following is not an
5605 overflow:
5606 @smallexample
5607 signed char a = SCHAR_MAX;
5608 a++;
5609 @end smallexample
5611 @item -fsanitize=bounds
5612 @opindex fsanitize=bounds
5613 This option enables instrumentation of array bounds.  Various out of bounds
5614 accesses are detected.  Flexible array members and initializers of variables
5615 with static storage are not instrumented.
5617 @item -fsanitize=alignment
5618 @opindex fsanitize=alignment
5620 This option enables checking of alignment of pointers when they are
5621 dereferenced, or when a reference is bound to insufficiently aligned target,
5622 or when a method or constructor is invoked on insufficiently aligned object.
5624 @item -fsanitize=object-size
5625 @opindex fsanitize=object-size
5626 This option enables instrumentation of memory references using the
5627 @code{__builtin_object_size} function.  Various out of bounds pointer
5628 accesses are detected.
5630 @item -fsanitize=float-divide-by-zero
5631 @opindex fsanitize=float-divide-by-zero
5632 Detect floating-point division by zero.  Unlike other similar options,
5633 @option{-fsanitize=float-divide-by-zero} is not enabled by
5634 @option{-fsanitize=undefined}, since floating-point division by zero can
5635 be a legitimate way of obtaining infinities and NaNs.
5637 @item -fsanitize=float-cast-overflow
5638 @opindex fsanitize=float-cast-overflow
5639 This option enables floating-point type to integer conversion checking.
5640 We check that the result of the conversion does not overflow.
5641 This option does not work well with @code{FE_INVALID} exceptions enabled.
5643 @item -fsanitize=nonnull-attribute
5644 @opindex fsanitize=nonnull-attribute
5646 This option enables instrumentation of calls, checking whether null values
5647 are not passed to arguments marked as requiring a non-null value by the
5648 @code{nonnull} function attribute.
5650 @item -fsanitize=returns-nonnull-attribute
5651 @opindex fsanitize=returns-nonnull-attribute
5653 This option enables instrumentation of return statements in functions
5654 marked with @code{returns_nonnull} function attribute, to detect returning
5655 of null values from such functions.
5657 @item -fsanitize=bool
5658 @opindex fsanitize=bool
5660 This option enables instrumentation of loads from bool.  If a value other
5661 than 0/1 is loaded, a run-time error is issued.
5663 @item -fsanitize=enum
5664 @opindex fsanitize=enum
5666 This option enables instrumentation of loads from an enum type.  If
5667 a value outside the range of values for the enum type is loaded,
5668 a run-time error is issued.
5670 @end table
5672 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5673 @option{-fsanitize=undefined} gives a diagnostic message.
5674 This currently works only for the C family of languages.
5676 @item -fasan-shadow-offset=@var{number}
5677 @opindex fasan-shadow-offset
5678 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5679 It is useful for experimenting with different shadow memory layouts in
5680 Kernel AddressSanitizer.
5682 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5683 @opindex fsanitize-recover
5684 @opindex fno-sanitize-recover
5685 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5686 mentioned in comma-separated list of @var{opts}.  Enabling this option
5687 for a sanitizer component would cause it to attempt to continue
5688 running the program as if no error happened.  This means multiple
5689 runtime errors can be reported in a single program run, and the exit
5690 code of the program may indicate success even when errors
5691 have been reported.  The @option{-fno-sanitize-recover=} can be used to alter
5692 this behavior, only the first detected error will be reported
5693 and program will exit after that with non-zero exit code.
5695 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5696 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5697 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5698 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5700 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5701 @option{-fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5702 Similarly @option{-fno-sanitize-recover} is equivalent to
5703 @option{-fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5705 @item -fsanitize-undefined-trap-on-error
5706 @opindex fsanitize-undefined-trap-on-error
5707 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5708 report undefined behavior using @code{__builtin_trap ()} rather than
5709 a @code{libubsan} library routine.  The advantage of this is that the
5710 @code{libubsan} library is not needed and will not be linked in, so this
5711 is usable even for use in freestanding environments.
5713 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5714 @opindex fdump-final-insns
5715 Dump the final internal representation (RTL) to @var{file}.  If the
5716 optional argument is omitted (or if @var{file} is @code{.}), the name
5717 of the dump file is determined by appending @code{.gkd} to the
5718 compilation output file name.
5720 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5721 @opindex fcompare-debug
5722 @opindex fno-compare-debug
5723 If no error occurs during compilation, run the compiler a second time,
5724 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5725 passed to the second compilation.  Dump the final internal
5726 representation in both compilations, and print an error if they differ.
5728 If the equal sign is omitted, the default @option{-gtoggle} is used.
5730 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5731 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5732 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5733 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5734 is used.
5736 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5737 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5738 of the final representation and the second compilation, preventing even
5739 @env{GCC_COMPARE_DEBUG} from taking effect.
5741 To verify full coverage during @option{-fcompare-debug} testing, set
5742 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5743 which GCC rejects as an invalid option in any actual compilation
5744 (rather than preprocessing, assembly or linking).  To get just a
5745 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5746 not overridden} will do.
5748 @item -fcompare-debug-second
5749 @opindex fcompare-debug-second
5750 This option is implicitly passed to the compiler for the second
5751 compilation requested by @option{-fcompare-debug}, along with options to
5752 silence warnings, and omitting other options that would cause
5753 side-effect compiler outputs to files or to the standard output.  Dump
5754 files and preserved temporary files are renamed so as to contain the
5755 @code{.gk} additional extension during the second compilation, to avoid
5756 overwriting those generated by the first.
5758 When this option is passed to the compiler driver, it causes the
5759 @emph{first} compilation to be skipped, which makes it useful for little
5760 other than debugging the compiler proper.
5762 @item -feliminate-dwarf2-dups
5763 @opindex feliminate-dwarf2-dups
5764 Compress DWARF 2 debugging information by eliminating duplicated
5765 information about each symbol.  This option only makes sense when
5766 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5768 @item -femit-struct-debug-baseonly
5769 @opindex femit-struct-debug-baseonly
5770 Emit debug information for struct-like types
5771 only when the base name of the compilation source file
5772 matches the base name of file in which the struct is defined.
5774 This option substantially reduces the size of debugging information,
5775 but at significant potential loss in type information to the debugger.
5776 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5777 See @option{-femit-struct-debug-detailed} for more detailed control.
5779 This option works only with DWARF 2.
5781 @item -femit-struct-debug-reduced
5782 @opindex femit-struct-debug-reduced
5783 Emit debug information for struct-like types
5784 only when the base name of the compilation source file
5785 matches the base name of file in which the type is defined,
5786 unless the struct is a template or defined in a system header.
5788 This option significantly reduces the size of debugging information,
5789 with some potential loss in type information to the debugger.
5790 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5791 See @option{-femit-struct-debug-detailed} for more detailed control.
5793 This option works only with DWARF 2.
5795 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5796 Specify the struct-like types
5797 for which the compiler generates debug information.
5798 The intent is to reduce duplicate struct debug information
5799 between different object files within the same program.
5801 This option is a detailed version of
5802 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5803 which serves for most needs.
5805 A specification has the syntax@*
5806 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5808 The optional first word limits the specification to
5809 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5810 A struct type is used directly when it is the type of a variable, member.
5811 Indirect uses arise through pointers to structs.
5812 That is, when use of an incomplete struct is valid, the use is indirect.
5813 An example is
5814 @samp{struct one direct; struct two * indirect;}.
5816 The optional second word limits the specification to
5817 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5818 Generic structs are a bit complicated to explain.
5819 For C++, these are non-explicit specializations of template classes,
5820 or non-template classes within the above.
5821 Other programming languages have generics,
5822 but @option{-femit-struct-debug-detailed} does not yet implement them.
5824 The third word specifies the source files for those
5825 structs for which the compiler should emit debug information.
5826 The values @samp{none} and @samp{any} have the normal meaning.
5827 The value @samp{base} means that
5828 the base of name of the file in which the type declaration appears
5829 must match the base of the name of the main compilation file.
5830 In practice, this means that when compiling @file{foo.c}, debug information
5831 is generated for types declared in that file and @file{foo.h},
5832 but not other header files.
5833 The value @samp{sys} means those types satisfying @samp{base}
5834 or declared in system or compiler headers.
5836 You may need to experiment to determine the best settings for your application.
5838 The default is @option{-femit-struct-debug-detailed=all}.
5840 This option works only with DWARF 2.
5842 @item -fno-merge-debug-strings
5843 @opindex fmerge-debug-strings
5844 @opindex fno-merge-debug-strings
5845 Direct the linker to not merge together strings in the debugging
5846 information that are identical in different object files.  Merging is
5847 not supported by all assemblers or linkers.  Merging decreases the size
5848 of the debug information in the output file at the cost of increasing
5849 link processing time.  Merging is enabled by default.
5851 @item -fdebug-prefix-map=@var{old}=@var{new}
5852 @opindex fdebug-prefix-map
5853 When compiling files in directory @file{@var{old}}, record debugging
5854 information describing them as in @file{@var{new}} instead.
5856 @item -fno-dwarf2-cfi-asm
5857 @opindex fdwarf2-cfi-asm
5858 @opindex fno-dwarf2-cfi-asm
5859 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5860 instead of using GAS @code{.cfi_*} directives.
5862 @cindex @command{prof}
5863 @item -p
5864 @opindex p
5865 Generate extra code to write profile information suitable for the
5866 analysis program @command{prof}.  You must use this option when compiling
5867 the source files you want data about, and you must also use it when
5868 linking.
5870 @cindex @command{gprof}
5871 @item -pg
5872 @opindex pg
5873 Generate extra code to write profile information suitable for the
5874 analysis program @command{gprof}.  You must use this option when compiling
5875 the source files you want data about, and you must also use it when
5876 linking.
5878 @item -Q
5879 @opindex Q
5880 Makes the compiler print out each function name as it is compiled, and
5881 print some statistics about each pass when it finishes.
5883 @item -ftime-report
5884 @opindex ftime-report
5885 Makes the compiler print some statistics about the time consumed by each
5886 pass when it finishes.
5888 @item -fmem-report
5889 @opindex fmem-report
5890 Makes the compiler print some statistics about permanent memory
5891 allocation when it finishes.
5893 @item -fmem-report-wpa
5894 @opindex fmem-report-wpa
5895 Makes the compiler print some statistics about permanent memory
5896 allocation for the WPA phase only.
5898 @item -fpre-ipa-mem-report
5899 @opindex fpre-ipa-mem-report
5900 @item -fpost-ipa-mem-report
5901 @opindex fpost-ipa-mem-report
5902 Makes the compiler print some statistics about permanent memory
5903 allocation before or after interprocedural optimization.
5905 @item -fprofile-report
5906 @opindex fprofile-report
5907 Makes the compiler print some statistics about consistency of the
5908 (estimated) profile and effect of individual passes.
5910 @item -fstack-usage
5911 @opindex fstack-usage
5912 Makes the compiler output stack usage information for the program, on a
5913 per-function basis.  The filename for the dump is made by appending
5914 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5915 the output file, if explicitly specified and it is not an executable,
5916 otherwise it is the basename of the source file.  An entry is made up
5917 of three fields:
5919 @itemize
5920 @item
5921 The name of the function.
5922 @item
5923 A number of bytes.
5924 @item
5925 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5926 @end itemize
5928 The qualifier @code{static} means that the function manipulates the stack
5929 statically: a fixed number of bytes are allocated for the frame on function
5930 entry and released on function exit; no stack adjustments are otherwise made
5931 in the function.  The second field is this fixed number of bytes.
5933 The qualifier @code{dynamic} means that the function manipulates the stack
5934 dynamically: in addition to the static allocation described above, stack
5935 adjustments are made in the body of the function, for example to push/pop
5936 arguments around function calls.  If the qualifier @code{bounded} is also
5937 present, the amount of these adjustments is bounded at compile time and
5938 the second field is an upper bound of the total amount of stack used by
5939 the function.  If it is not present, the amount of these adjustments is
5940 not bounded at compile time and the second field only represents the
5941 bounded part.
5943 @item -fprofile-arcs
5944 @opindex fprofile-arcs
5945 Add code so that program flow @dfn{arcs} are instrumented.  During
5946 execution the program records how many times each branch and call is
5947 executed and how many times it is taken or returns.  When the compiled
5948 program exits it saves this data to a file called
5949 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5950 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5951 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5952 @var{auxname} is generated from the name of the output file, if
5953 explicitly specified and it is not the final executable, otherwise it is
5954 the basename of the source file.  In both cases any suffix is removed
5955 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5956 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5957 @xref{Cross-profiling}.
5959 @cindex @command{gcov}
5960 @item --coverage
5961 @opindex coverage
5963 This option is used to compile and link code instrumented for coverage
5964 analysis.  The option is a synonym for @option{-fprofile-arcs}
5965 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5966 linking).  See the documentation for those options for more details.
5968 @itemize
5970 @item
5971 Compile the source files with @option{-fprofile-arcs} plus optimization
5972 and code generation options.  For test coverage analysis, use the
5973 additional @option{-ftest-coverage} option.  You do not need to profile
5974 every source file in a program.
5976 @item
5977 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5978 (the latter implies the former).
5980 @item
5981 Run the program on a representative workload to generate the arc profile
5982 information.  This may be repeated any number of times.  You can run
5983 concurrent instances of your program, and provided that the file system
5984 supports locking, the data files will be correctly updated.  Also
5985 @code{fork} calls are detected and correctly handled (double counting
5986 will not happen).
5988 @item
5989 For profile-directed optimizations, compile the source files again with
5990 the same optimization and code generation options plus
5991 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5992 Control Optimization}).
5994 @item
5995 For test coverage analysis, use @command{gcov} to produce human readable
5996 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5997 @command{gcov} documentation for further information.
5999 @end itemize
6001 With @option{-fprofile-arcs}, for each function of your program GCC
6002 creates a program flow graph, then finds a spanning tree for the graph.
6003 Only arcs that are not on the spanning tree have to be instrumented: the
6004 compiler adds code to count the number of times that these arcs are
6005 executed.  When an arc is the only exit or only entrance to a block, the
6006 instrumentation code can be added to the block; otherwise, a new basic
6007 block must be created to hold the instrumentation code.
6009 @need 2000
6010 @item -ftest-coverage
6011 @opindex ftest-coverage
6012 Produce a notes file that the @command{gcov} code-coverage utility
6013 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6014 show program coverage.  Each source file's note file is called
6015 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6016 above for a description of @var{auxname} and instructions on how to
6017 generate test coverage data.  Coverage data matches the source files
6018 more closely if you do not optimize.
6020 @item -fdbg-cnt-list
6021 @opindex fdbg-cnt-list
6022 Print the name and the counter upper bound for all debug counters.
6025 @item -fdbg-cnt=@var{counter-value-list}
6026 @opindex fdbg-cnt
6027 Set the internal debug counter upper bound.  @var{counter-value-list}
6028 is a comma-separated list of @var{name}:@var{value} pairs
6029 which sets the upper bound of each debug counter @var{name} to @var{value}.
6030 All debug counters have the initial upper bound of @code{UINT_MAX};
6031 thus @code{dbg_cnt()} returns true always unless the upper bound
6032 is set by this option.
6033 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6034 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6036 @item -fenable-@var{kind}-@var{pass}
6037 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6038 @opindex fdisable-
6039 @opindex fenable-
6041 This is a set of options that are used to explicitly disable/enable
6042 optimization passes.  These options are intended for use for debugging GCC.
6043 Compiler users should use regular options for enabling/disabling
6044 passes instead.
6046 @table @gcctabopt
6048 @item -fdisable-ipa-@var{pass}
6049 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6050 statically invoked in the compiler multiple times, the pass name should be
6051 appended with a sequential number starting from 1.
6053 @item -fdisable-rtl-@var{pass}
6054 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6055 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6056 statically invoked in the compiler multiple times, the pass name should be
6057 appended with a sequential number starting from 1.  @var{range-list} is a 
6058 comma-separated list of function ranges or assembler names.  Each range is a number
6059 pair separated by a colon.  The range is inclusive in both ends.  If the range
6060 is trivial, the number pair can be simplified as a single number.  If the
6061 function's call graph node's @var{uid} falls within one of the specified ranges,
6062 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6063 function header of a dump file, and the pass names can be dumped by using
6064 option @option{-fdump-passes}.
6066 @item -fdisable-tree-@var{pass}
6067 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6068 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6069 option arguments.
6071 @item -fenable-ipa-@var{pass}
6072 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6073 statically invoked in the compiler multiple times, the pass name should be
6074 appended with a sequential number starting from 1.
6076 @item -fenable-rtl-@var{pass}
6077 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6078 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6079 description and examples.
6081 @item -fenable-tree-@var{pass}
6082 @itemx -fenable-tree-@var{pass}=@var{range-list}
6083 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6084 of option arguments.
6086 @end table
6088 Here are some examples showing uses of these options.
6090 @smallexample
6092 # disable ccp1 for all functions
6093    -fdisable-tree-ccp1
6094 # disable complete unroll for function whose cgraph node uid is 1
6095    -fenable-tree-cunroll=1
6096 # disable gcse2 for functions at the following ranges [1,1],
6097 # [300,400], and [400,1000]
6098 # disable gcse2 for functions foo and foo2
6099    -fdisable-rtl-gcse2=foo,foo2
6100 # disable early inlining
6101    -fdisable-tree-einline
6102 # disable ipa inlining
6103    -fdisable-ipa-inline
6104 # enable tree full unroll
6105    -fenable-tree-unroll
6107 @end smallexample
6109 @item -d@var{letters}
6110 @itemx -fdump-rtl-@var{pass}
6111 @itemx -fdump-rtl-@var{pass}=@var{filename}
6112 @opindex d
6113 @opindex fdump-rtl-@var{pass}
6114 Says to make debugging dumps during compilation at times specified by
6115 @var{letters}.  This is used for debugging the RTL-based passes of the
6116 compiler.  The file names for most of the dumps are made by appending
6117 a pass number and a word to the @var{dumpname}, and the files are
6118 created in the directory of the output file. In case of
6119 @option{=@var{filename}} option, the dump is output on the given file
6120 instead of the pass numbered dump files. Note that the pass number is
6121 computed statically as passes get registered into the pass manager.
6122 Thus the numbering is not related to the dynamic order of execution of
6123 passes.  In particular, a pass installed by a plugin could have a
6124 number over 200 even if it executed quite early.  @var{dumpname} is
6125 generated from the name of the output file, if explicitly specified
6126 and it is not an executable, otherwise it is the basename of the
6127 source file. These switches may have different effects when
6128 @option{-E} is used for preprocessing.
6130 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6131 @option{-d} option @var{letters}.  Here are the possible
6132 letters for use in @var{pass} and @var{letters}, and their meanings:
6134 @table @gcctabopt
6136 @item -fdump-rtl-alignments
6137 @opindex fdump-rtl-alignments
6138 Dump after branch alignments have been computed.
6140 @item -fdump-rtl-asmcons
6141 @opindex fdump-rtl-asmcons
6142 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6144 @item -fdump-rtl-auto_inc_dec
6145 @opindex fdump-rtl-auto_inc_dec
6146 Dump after auto-inc-dec discovery.  This pass is only run on
6147 architectures that have auto inc or auto dec instructions.
6149 @item -fdump-rtl-barriers
6150 @opindex fdump-rtl-barriers
6151 Dump after cleaning up the barrier instructions.
6153 @item -fdump-rtl-bbpart
6154 @opindex fdump-rtl-bbpart
6155 Dump after partitioning hot and cold basic blocks.
6157 @item -fdump-rtl-bbro
6158 @opindex fdump-rtl-bbro
6159 Dump after block reordering.
6161 @item -fdump-rtl-btl1
6162 @itemx -fdump-rtl-btl2
6163 @opindex fdump-rtl-btl2
6164 @opindex fdump-rtl-btl2
6165 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6166 after the two branch
6167 target load optimization passes.
6169 @item -fdump-rtl-bypass
6170 @opindex fdump-rtl-bypass
6171 Dump after jump bypassing and control flow optimizations.
6173 @item -fdump-rtl-combine
6174 @opindex fdump-rtl-combine
6175 Dump after the RTL instruction combination pass.
6177 @item -fdump-rtl-compgotos
6178 @opindex fdump-rtl-compgotos
6179 Dump after duplicating the computed gotos.
6181 @item -fdump-rtl-ce1
6182 @itemx -fdump-rtl-ce2
6183 @itemx -fdump-rtl-ce3
6184 @opindex fdump-rtl-ce1
6185 @opindex fdump-rtl-ce2
6186 @opindex fdump-rtl-ce3
6187 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6188 @option{-fdump-rtl-ce3} enable dumping after the three
6189 if conversion passes.
6191 @item -fdump-rtl-cprop_hardreg
6192 @opindex fdump-rtl-cprop_hardreg
6193 Dump after hard register copy propagation.
6195 @item -fdump-rtl-csa
6196 @opindex fdump-rtl-csa
6197 Dump after combining stack adjustments.
6199 @item -fdump-rtl-cse1
6200 @itemx -fdump-rtl-cse2
6201 @opindex fdump-rtl-cse1
6202 @opindex fdump-rtl-cse2
6203 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6204 the two common subexpression elimination passes.
6206 @item -fdump-rtl-dce
6207 @opindex fdump-rtl-dce
6208 Dump after the standalone dead code elimination passes.
6210 @item -fdump-rtl-dbr
6211 @opindex fdump-rtl-dbr
6212 Dump after delayed branch scheduling.
6214 @item -fdump-rtl-dce1
6215 @itemx -fdump-rtl-dce2
6216 @opindex fdump-rtl-dce1
6217 @opindex fdump-rtl-dce2
6218 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6219 the two dead store elimination passes.
6221 @item -fdump-rtl-eh
6222 @opindex fdump-rtl-eh
6223 Dump after finalization of EH handling code.
6225 @item -fdump-rtl-eh_ranges
6226 @opindex fdump-rtl-eh_ranges
6227 Dump after conversion of EH handling range regions.
6229 @item -fdump-rtl-expand
6230 @opindex fdump-rtl-expand
6231 Dump after RTL generation.
6233 @item -fdump-rtl-fwprop1
6234 @itemx -fdump-rtl-fwprop2
6235 @opindex fdump-rtl-fwprop1
6236 @opindex fdump-rtl-fwprop2
6237 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6238 dumping after the two forward propagation passes.
6240 @item -fdump-rtl-gcse1
6241 @itemx -fdump-rtl-gcse2
6242 @opindex fdump-rtl-gcse1
6243 @opindex fdump-rtl-gcse2
6244 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6245 after global common subexpression elimination.
6247 @item -fdump-rtl-init-regs
6248 @opindex fdump-rtl-init-regs
6249 Dump after the initialization of the registers.
6251 @item -fdump-rtl-initvals
6252 @opindex fdump-rtl-initvals
6253 Dump after the computation of the initial value sets.
6255 @item -fdump-rtl-into_cfglayout
6256 @opindex fdump-rtl-into_cfglayout
6257 Dump after converting to cfglayout mode.
6259 @item -fdump-rtl-ira
6260 @opindex fdump-rtl-ira
6261 Dump after iterated register allocation.
6263 @item -fdump-rtl-jump
6264 @opindex fdump-rtl-jump
6265 Dump after the second jump optimization.
6267 @item -fdump-rtl-loop2
6268 @opindex fdump-rtl-loop2
6269 @option{-fdump-rtl-loop2} enables dumping after the rtl
6270 loop optimization passes.
6272 @item -fdump-rtl-mach
6273 @opindex fdump-rtl-mach
6274 Dump after performing the machine dependent reorganization pass, if that
6275 pass exists.
6277 @item -fdump-rtl-mode_sw
6278 @opindex fdump-rtl-mode_sw
6279 Dump after removing redundant mode switches.
6281 @item -fdump-rtl-rnreg
6282 @opindex fdump-rtl-rnreg
6283 Dump after register renumbering.
6285 @item -fdump-rtl-outof_cfglayout
6286 @opindex fdump-rtl-outof_cfglayout
6287 Dump after converting from cfglayout mode.
6289 @item -fdump-rtl-peephole2
6290 @opindex fdump-rtl-peephole2
6291 Dump after the peephole pass.
6293 @item -fdump-rtl-postreload
6294 @opindex fdump-rtl-postreload
6295 Dump after post-reload optimizations.
6297 @item -fdump-rtl-pro_and_epilogue
6298 @opindex fdump-rtl-pro_and_epilogue
6299 Dump after generating the function prologues and epilogues.
6301 @item -fdump-rtl-sched1
6302 @itemx -fdump-rtl-sched2
6303 @opindex fdump-rtl-sched1
6304 @opindex fdump-rtl-sched2
6305 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6306 after the basic block scheduling passes.
6308 @item -fdump-rtl-ree
6309 @opindex fdump-rtl-ree
6310 Dump after sign/zero extension elimination.
6312 @item -fdump-rtl-seqabstr
6313 @opindex fdump-rtl-seqabstr
6314 Dump after common sequence discovery.
6316 @item -fdump-rtl-shorten
6317 @opindex fdump-rtl-shorten
6318 Dump after shortening branches.
6320 @item -fdump-rtl-sibling
6321 @opindex fdump-rtl-sibling
6322 Dump after sibling call optimizations.
6324 @item -fdump-rtl-split1
6325 @itemx -fdump-rtl-split2
6326 @itemx -fdump-rtl-split3
6327 @itemx -fdump-rtl-split4
6328 @itemx -fdump-rtl-split5
6329 @opindex fdump-rtl-split1
6330 @opindex fdump-rtl-split2
6331 @opindex fdump-rtl-split3
6332 @opindex fdump-rtl-split4
6333 @opindex fdump-rtl-split5
6334 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6335 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6336 @option{-fdump-rtl-split5} enable dumping after five rounds of
6337 instruction splitting.
6339 @item -fdump-rtl-sms
6340 @opindex fdump-rtl-sms
6341 Dump after modulo scheduling.  This pass is only run on some
6342 architectures.
6344 @item -fdump-rtl-stack
6345 @opindex fdump-rtl-stack
6346 Dump after conversion from GCC's ``flat register file'' registers to the
6347 x87's stack-like registers.  This pass is only run on x86 variants.
6349 @item -fdump-rtl-subreg1
6350 @itemx -fdump-rtl-subreg2
6351 @opindex fdump-rtl-subreg1
6352 @opindex fdump-rtl-subreg2
6353 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6354 the two subreg expansion passes.
6356 @item -fdump-rtl-unshare
6357 @opindex fdump-rtl-unshare
6358 Dump after all rtl has been unshared.
6360 @item -fdump-rtl-vartrack
6361 @opindex fdump-rtl-vartrack
6362 Dump after variable tracking.
6364 @item -fdump-rtl-vregs
6365 @opindex fdump-rtl-vregs
6366 Dump after converting virtual registers to hard registers.
6368 @item -fdump-rtl-web
6369 @opindex fdump-rtl-web
6370 Dump after live range splitting.
6372 @item -fdump-rtl-regclass
6373 @itemx -fdump-rtl-subregs_of_mode_init
6374 @itemx -fdump-rtl-subregs_of_mode_finish
6375 @itemx -fdump-rtl-dfinit
6376 @itemx -fdump-rtl-dfinish
6377 @opindex fdump-rtl-regclass
6378 @opindex fdump-rtl-subregs_of_mode_init
6379 @opindex fdump-rtl-subregs_of_mode_finish
6380 @opindex fdump-rtl-dfinit
6381 @opindex fdump-rtl-dfinish
6382 These dumps are defined but always produce empty files.
6384 @item -da
6385 @itemx -fdump-rtl-all
6386 @opindex da
6387 @opindex fdump-rtl-all
6388 Produce all the dumps listed above.
6390 @item -dA
6391 @opindex dA
6392 Annotate the assembler output with miscellaneous debugging information.
6394 @item -dD
6395 @opindex dD
6396 Dump all macro definitions, at the end of preprocessing, in addition to
6397 normal output.
6399 @item -dH
6400 @opindex dH
6401 Produce a core dump whenever an error occurs.
6403 @item -dp
6404 @opindex dp
6405 Annotate the assembler output with a comment indicating which
6406 pattern and alternative is used.  The length of each instruction is
6407 also printed.
6409 @item -dP
6410 @opindex dP
6411 Dump the RTL in the assembler output as a comment before each instruction.
6412 Also turns on @option{-dp} annotation.
6414 @item -dx
6415 @opindex dx
6416 Just generate RTL for a function instead of compiling it.  Usually used
6417 with @option{-fdump-rtl-expand}.
6418 @end table
6420 @item -fdump-noaddr
6421 @opindex fdump-noaddr
6422 When doing debugging dumps, suppress address output.  This makes it more
6423 feasible to use diff on debugging dumps for compiler invocations with
6424 different compiler binaries and/or different
6425 text / bss / data / heap / stack / dso start locations.
6427 @item -freport-bug
6428 @opindex freport-bug
6429 Collect and dump debug information into temporary file if ICE in C/C++
6430 compiler occured.
6432 @item -fdump-unnumbered
6433 @opindex fdump-unnumbered
6434 When doing debugging dumps, suppress instruction numbers and address output.
6435 This makes it more feasible to use diff on debugging dumps for compiler
6436 invocations with different options, in particular with and without
6437 @option{-g}.
6439 @item -fdump-unnumbered-links
6440 @opindex fdump-unnumbered-links
6441 When doing debugging dumps (see @option{-d} option above), suppress
6442 instruction numbers for the links to the previous and next instructions
6443 in a sequence.
6445 @item -fdump-translation-unit @r{(C++ only)}
6446 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6447 @opindex fdump-translation-unit
6448 Dump a representation of the tree structure for the entire translation
6449 unit to a file.  The file name is made by appending @file{.tu} to the
6450 source file name, and the file is created in the same directory as the
6451 output file.  If the @samp{-@var{options}} form is used, @var{options}
6452 controls the details of the dump as described for the
6453 @option{-fdump-tree} options.
6455 @item -fdump-class-hierarchy @r{(C++ only)}
6456 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6457 @opindex fdump-class-hierarchy
6458 Dump a representation of each class's hierarchy and virtual function
6459 table layout to a file.  The file name is made by appending
6460 @file{.class} to the source file name, and the file is created in the
6461 same directory as the output file.  If the @samp{-@var{options}} form
6462 is used, @var{options} controls the details of the dump as described
6463 for the @option{-fdump-tree} options.
6465 @item -fdump-ipa-@var{switch}
6466 @opindex fdump-ipa
6467 Control the dumping at various stages of inter-procedural analysis
6468 language tree to a file.  The file name is generated by appending a
6469 switch specific suffix to the source file name, and the file is created
6470 in the same directory as the output file.  The following dumps are
6471 possible:
6473 @table @samp
6474 @item all
6475 Enables all inter-procedural analysis dumps.
6477 @item cgraph
6478 Dumps information about call-graph optimization, unused function removal,
6479 and inlining decisions.
6481 @item inline
6482 Dump after function inlining.
6484 @end table
6486 @item -fdump-passes
6487 @opindex fdump-passes
6488 Dump the list of optimization passes that are turned on and off by
6489 the current command-line options.
6491 @item -fdump-statistics-@var{option}
6492 @opindex fdump-statistics
6493 Enable and control dumping of pass statistics in a separate file.  The
6494 file name is generated by appending a suffix ending in
6495 @samp{.statistics} to the source file name, and the file is created in
6496 the same directory as the output file.  If the @samp{-@var{option}}
6497 form is used, @samp{-stats} causes counters to be summed over the
6498 whole compilation unit while @samp{-details} dumps every event as
6499 the passes generate them.  The default with no option is to sum
6500 counters for each function compiled.
6502 @item -fdump-tree-@var{switch}
6503 @itemx -fdump-tree-@var{switch}-@var{options}
6504 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6505 @opindex fdump-tree
6506 Control the dumping at various stages of processing the intermediate
6507 language tree to a file.  The file name is generated by appending a
6508 switch-specific suffix to the source file name, and the file is
6509 created in the same directory as the output file. In case of
6510 @option{=@var{filename}} option, the dump is output on the given file
6511 instead of the auto named dump files.  If the @samp{-@var{options}}
6512 form is used, @var{options} is a list of @samp{-} separated options
6513 which control the details of the dump.  Not all options are applicable
6514 to all dumps; those that are not meaningful are ignored.  The
6515 following options are available
6517 @table @samp
6518 @item address
6519 Print the address of each node.  Usually this is not meaningful as it
6520 changes according to the environment and source file.  Its primary use
6521 is for tying up a dump file with a debug environment.
6522 @item asmname
6523 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6524 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6525 use working backward from mangled names in the assembly file.
6526 @item slim
6527 When dumping front-end intermediate representations, inhibit dumping
6528 of members of a scope or body of a function merely because that scope
6529 has been reached.  Only dump such items when they are directly reachable
6530 by some other path.
6532 When dumping pretty-printed trees, this option inhibits dumping the
6533 bodies of control structures.
6535 When dumping RTL, print the RTL in slim (condensed) form instead of
6536 the default LISP-like representation.
6537 @item raw
6538 Print a raw representation of the tree.  By default, trees are
6539 pretty-printed into a C-like representation.
6540 @item details
6541 Enable more detailed dumps (not honored by every dump option). Also
6542 include information from the optimization passes.
6543 @item stats
6544 Enable dumping various statistics about the pass (not honored by every dump
6545 option).
6546 @item blocks
6547 Enable showing basic block boundaries (disabled in raw dumps).
6548 @item graph
6549 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6550 dump a representation of the control flow graph suitable for viewing with
6551 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6552 the file is pretty-printed as a subgraph, so that GraphViz can render them
6553 all in a single plot.
6555 This option currently only works for RTL dumps, and the RTL is always
6556 dumped in slim form.
6557 @item vops
6558 Enable showing virtual operands for every statement.
6559 @item lineno
6560 Enable showing line numbers for statements.
6561 @item uid
6562 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6563 @item verbose
6564 Enable showing the tree dump for each statement.
6565 @item eh
6566 Enable showing the EH region number holding each statement.
6567 @item scev
6568 Enable showing scalar evolution analysis details.
6569 @item optimized
6570 Enable showing optimization information (only available in certain
6571 passes).
6572 @item missed
6573 Enable showing missed optimization information (only available in certain
6574 passes).
6575 @item note
6576 Enable other detailed optimization information (only available in
6577 certain passes).
6578 @item =@var{filename}
6579 Instead of an auto named dump file, output into the given file
6580 name. The file names @file{stdout} and @file{stderr} are treated
6581 specially and are considered already open standard streams. For
6582 example,
6584 @smallexample
6585 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6586      -fdump-tree-pre=stderr file.c
6587 @end smallexample
6589 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6590 output on to @file{stderr}. If two conflicting dump filenames are
6591 given for the same pass, then the latter option overrides the earlier
6592 one.
6594 @item all
6595 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6596 and @option{lineno}.
6598 @item optall
6599 Turn on all optimization options, i.e., @option{optimized},
6600 @option{missed}, and @option{note}.
6601 @end table
6603 The following tree dumps are possible:
6604 @table @samp
6606 @item original
6607 @opindex fdump-tree-original
6608 Dump before any tree based optimization, to @file{@var{file}.original}.
6610 @item optimized
6611 @opindex fdump-tree-optimized
6612 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6614 @item gimple
6615 @opindex fdump-tree-gimple
6616 Dump each function before and after the gimplification pass to a file.  The
6617 file name is made by appending @file{.gimple} to the source file name.
6619 @item cfg
6620 @opindex fdump-tree-cfg
6621 Dump the control flow graph of each function to a file.  The file name is
6622 made by appending @file{.cfg} to the source file name.
6624 @item ch
6625 @opindex fdump-tree-ch
6626 Dump each function after copying loop headers.  The file name is made by
6627 appending @file{.ch} to the source file name.
6629 @item ssa
6630 @opindex fdump-tree-ssa
6631 Dump SSA related information to a file.  The file name is made by appending
6632 @file{.ssa} to the source file name.
6634 @item alias
6635 @opindex fdump-tree-alias
6636 Dump aliasing information for each function.  The file name is made by
6637 appending @file{.alias} to the source file name.
6639 @item ccp
6640 @opindex fdump-tree-ccp
6641 Dump each function after CCP@.  The file name is made by appending
6642 @file{.ccp} to the source file name.
6644 @item storeccp
6645 @opindex fdump-tree-storeccp
6646 Dump each function after STORE-CCP@.  The file name is made by appending
6647 @file{.storeccp} to the source file name.
6649 @item pre
6650 @opindex fdump-tree-pre
6651 Dump trees after partial redundancy elimination.  The file name is made
6652 by appending @file{.pre} to the source file name.
6654 @item fre
6655 @opindex fdump-tree-fre
6656 Dump trees after full redundancy elimination.  The file name is made
6657 by appending @file{.fre} to the source file name.
6659 @item copyprop
6660 @opindex fdump-tree-copyprop
6661 Dump trees after copy propagation.  The file name is made
6662 by appending @file{.copyprop} to the source file name.
6664 @item store_copyprop
6665 @opindex fdump-tree-store_copyprop
6666 Dump trees after store copy-propagation.  The file name is made
6667 by appending @file{.store_copyprop} to the source file name.
6669 @item dce
6670 @opindex fdump-tree-dce
6671 Dump each function after dead code elimination.  The file name is made by
6672 appending @file{.dce} to the source file name.
6674 @item sra
6675 @opindex fdump-tree-sra
6676 Dump each function after performing scalar replacement of aggregates.  The
6677 file name is made by appending @file{.sra} to the source file name.
6679 @item sink
6680 @opindex fdump-tree-sink
6681 Dump each function after performing code sinking.  The file name is made
6682 by appending @file{.sink} to the source file name.
6684 @item dom
6685 @opindex fdump-tree-dom
6686 Dump each function after applying dominator tree optimizations.  The file
6687 name is made by appending @file{.dom} to the source file name.
6689 @item dse
6690 @opindex fdump-tree-dse
6691 Dump each function after applying dead store elimination.  The file
6692 name is made by appending @file{.dse} to the source file name.
6694 @item phiopt
6695 @opindex fdump-tree-phiopt
6696 Dump each function after optimizing PHI nodes into straightline code.  The file
6697 name is made by appending @file{.phiopt} to the source file name.
6699 @item forwprop
6700 @opindex fdump-tree-forwprop
6701 Dump each function after forward propagating single use variables.  The file
6702 name is made by appending @file{.forwprop} to the source file name.
6704 @item copyrename
6705 @opindex fdump-tree-copyrename
6706 Dump each function after applying the copy rename optimization.  The file
6707 name is made by appending @file{.copyrename} to the source file name.
6709 @item nrv
6710 @opindex fdump-tree-nrv
6711 Dump each function after applying the named return value optimization on
6712 generic trees.  The file name is made by appending @file{.nrv} to the source
6713 file name.
6715 @item vect
6716 @opindex fdump-tree-vect
6717 Dump each function after applying vectorization of loops.  The file name is
6718 made by appending @file{.vect} to the source file name.
6720 @item slp
6721 @opindex fdump-tree-slp
6722 Dump each function after applying vectorization of basic blocks.  The file name
6723 is made by appending @file{.slp} to the source file name.
6725 @item vrp
6726 @opindex fdump-tree-vrp
6727 Dump each function after Value Range Propagation (VRP).  The file name
6728 is made by appending @file{.vrp} to the source file name.
6730 @item all
6731 @opindex fdump-tree-all
6732 Enable all the available tree dumps with the flags provided in this option.
6733 @end table
6735 @item -fopt-info
6736 @itemx -fopt-info-@var{options}
6737 @itemx -fopt-info-@var{options}=@var{filename}
6738 @opindex fopt-info
6739 Controls optimization dumps from various optimization passes. If the
6740 @samp{-@var{options}} form is used, @var{options} is a list of
6741 @samp{-} separated options to select the dump details and
6742 optimizations.  If @var{options} is not specified, it defaults to
6743 @option{optimized} for details and @option{optall} for optimization
6744 groups. If the @var{filename} is not specified, it defaults to
6745 @file{stderr}. Note that the output @var{filename} will be overwritten
6746 in case of multiple translation units. If a combined output from
6747 multiple translation units is desired, @file{stderr} should be used
6748 instead.
6750 The options can be divided into two groups, 1) options describing the
6751 verbosity of the dump, and 2) options describing which optimizations
6752 should be included. The options from both the groups can be freely
6753 mixed as they are non-overlapping. However, in case of any conflicts,
6754 the latter options override the earlier options on the command
6755 line. Though multiple -fopt-info options are accepted, only one of
6756 them can have @option{=filename}. If other filenames are provided then
6757 all but the first one are ignored.
6759 The dump verbosity has the following options
6761 @table @samp
6762 @item optimized
6763 Print information when an optimization is successfully applied. It is
6764 up to a pass to decide which information is relevant. For example, the
6765 vectorizer passes print the source location of loops which got
6766 successfully vectorized.
6767 @item missed
6768 Print information about missed optimizations. Individual passes
6769 control which information to include in the output. For example,
6771 @smallexample
6772 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6773 @end smallexample
6775 will print information about missed optimization opportunities from
6776 vectorization passes on stderr.
6777 @item note
6778 Print verbose information about optimizations, such as certain
6779 transformations, more detailed messages about decisions etc.
6780 @item all
6781 Print detailed optimization information. This includes
6782 @var{optimized}, @var{missed}, and @var{note}.
6783 @end table
6785 The second set of options describes a group of optimizations and may
6786 include one or more of the following.
6788 @table @samp
6789 @item ipa
6790 Enable dumps from all interprocedural optimizations.
6791 @item loop
6792 Enable dumps from all loop optimizations.
6793 @item inline
6794 Enable dumps from all inlining optimizations.
6795 @item vec
6796 Enable dumps from all vectorization optimizations.
6797 @item optall
6798 Enable dumps from all optimizations. This is a superset of
6799 the optimization groups listed above.
6800 @end table
6802 For example,
6803 @smallexample
6804 gcc -O3 -fopt-info-missed=missed.all
6805 @end smallexample
6807 outputs missed optimization report from all the passes into
6808 @file{missed.all}.
6810 As another example,
6811 @smallexample
6812 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6813 @end smallexample
6815 will output information about missed optimizations as well as
6816 optimized locations from all the inlining passes into
6817 @file{inline.txt}.
6819 If the @var{filename} is provided, then the dumps from all the
6820 applicable optimizations are concatenated into the @file{filename}.
6821 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6822 omitted, it defaults to @option{all-optall}, which means dump all
6823 available optimization info from all the passes. In the following
6824 example, all optimization info is output on to @file{stderr}.
6826 @smallexample
6827 gcc -O3 -fopt-info
6828 @end smallexample
6830 Note that @option{-fopt-info-vec-missed} behaves the same as
6831 @option{-fopt-info-missed-vec}.
6833 As another example, consider
6835 @smallexample
6836 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6837 @end smallexample
6839 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6840 in conflict since only one output file is allowed. In this case, only
6841 the first option takes effect and the subsequent options are
6842 ignored. Thus only the @file{vec.miss} is produced which contains
6843 dumps from the vectorizer about missed opportunities.
6845 @item -frandom-seed=@var{number}
6846 @opindex frandom-seed
6847 This option provides a seed that GCC uses in place of
6848 random numbers in generating certain symbol names
6849 that have to be different in every compiled file.  It is also used to
6850 place unique stamps in coverage data files and the object files that
6851 produce them.  You can use the @option{-frandom-seed} option to produce
6852 reproducibly identical object files.
6854 The @var{number} should be different for every file you compile.
6856 @item -fsched-verbose=@var{n}
6857 @opindex fsched-verbose
6858 On targets that use instruction scheduling, this option controls the
6859 amount of debugging output the scheduler prints.  This information is
6860 written to standard error, unless @option{-fdump-rtl-sched1} or
6861 @option{-fdump-rtl-sched2} is specified, in which case it is output
6862 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6863 respectively.  However for @var{n} greater than nine, the output is
6864 always printed to standard error.
6866 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6867 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6868 For @var{n} greater than one, it also output basic block probabilities,
6869 detailed ready list information and unit/insn info.  For @var{n} greater
6870 than two, it includes RTL at abort point, control-flow and regions info.
6871 And for @var{n} over four, @option{-fsched-verbose} also includes
6872 dependence info.
6874 @item -save-temps
6875 @itemx -save-temps=cwd
6876 @opindex save-temps
6877 Store the usual ``temporary'' intermediate files permanently; place them
6878 in the current directory and name them based on the source file.  Thus,
6879 compiling @file{foo.c} with @option{-c -save-temps} produces files
6880 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6881 preprocessed @file{foo.i} output file even though the compiler now
6882 normally uses an integrated preprocessor.
6884 When used in combination with the @option{-x} command-line option,
6885 @option{-save-temps} is sensible enough to avoid over writing an
6886 input source file with the same extension as an intermediate file.
6887 The corresponding intermediate file may be obtained by renaming the
6888 source file before using @option{-save-temps}.
6890 If you invoke GCC in parallel, compiling several different source
6891 files that share a common base name in different subdirectories or the
6892 same source file compiled for multiple output destinations, it is
6893 likely that the different parallel compilers will interfere with each
6894 other, and overwrite the temporary files.  For instance:
6896 @smallexample
6897 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6898 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6899 @end smallexample
6901 may result in @file{foo.i} and @file{foo.o} being written to
6902 simultaneously by both compilers.
6904 @item -save-temps=obj
6905 @opindex save-temps=obj
6906 Store the usual ``temporary'' intermediate files permanently.  If the
6907 @option{-o} option is used, the temporary files are based on the
6908 object file.  If the @option{-o} option is not used, the
6909 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6911 For example:
6913 @smallexample
6914 gcc -save-temps=obj -c foo.c
6915 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6916 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6917 @end smallexample
6919 @noindent
6920 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6921 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6922 @file{dir2/yfoobar.o}.
6924 @item -time@r{[}=@var{file}@r{]}
6925 @opindex time
6926 Report the CPU time taken by each subprocess in the compilation
6927 sequence.  For C source files, this is the compiler proper and assembler
6928 (plus the linker if linking is done).
6930 Without the specification of an output file, the output looks like this:
6932 @smallexample
6933 # cc1 0.12 0.01
6934 # as 0.00 0.01
6935 @end smallexample
6937 The first number on each line is the ``user time'', that is time spent
6938 executing the program itself.  The second number is ``system time'',
6939 time spent executing operating system routines on behalf of the program.
6940 Both numbers are in seconds.
6942 With the specification of an output file, the output is appended to the
6943 named file, and it looks like this:
6945 @smallexample
6946 0.12 0.01 cc1 @var{options}
6947 0.00 0.01 as @var{options}
6948 @end smallexample
6950 The ``user time'' and the ``system time'' are moved before the program
6951 name, and the options passed to the program are displayed, so that one
6952 can later tell what file was being compiled, and with which options.
6954 @item -fvar-tracking
6955 @opindex fvar-tracking
6956 Run variable tracking pass.  It computes where variables are stored at each
6957 position in code.  Better debugging information is then generated
6958 (if the debugging information format supports this information).
6960 It is enabled by default when compiling with optimization (@option{-Os},
6961 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6962 the debug info format supports it.
6964 @item -fvar-tracking-assignments
6965 @opindex fvar-tracking-assignments
6966 @opindex fno-var-tracking-assignments
6967 Annotate assignments to user variables early in the compilation and
6968 attempt to carry the annotations over throughout the compilation all the
6969 way to the end, in an attempt to improve debug information while
6970 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6972 It can be enabled even if var-tracking is disabled, in which case
6973 annotations are created and maintained, but discarded at the end.
6975 @item -fvar-tracking-assignments-toggle
6976 @opindex fvar-tracking-assignments-toggle
6977 @opindex fno-var-tracking-assignments-toggle
6978 Toggle @option{-fvar-tracking-assignments}, in the same way that
6979 @option{-gtoggle} toggles @option{-g}.
6981 @item -print-file-name=@var{library}
6982 @opindex print-file-name
6983 Print the full absolute name of the library file @var{library} that
6984 would be used when linking---and don't do anything else.  With this
6985 option, GCC does not compile or link anything; it just prints the
6986 file name.
6988 @item -print-multi-directory
6989 @opindex print-multi-directory
6990 Print the directory name corresponding to the multilib selected by any
6991 other switches present in the command line.  This directory is supposed
6992 to exist in @env{GCC_EXEC_PREFIX}.
6994 @item -print-multi-lib
6995 @opindex print-multi-lib
6996 Print the mapping from multilib directory names to compiler switches
6997 that enable them.  The directory name is separated from the switches by
6998 @samp{;}, and each switch starts with an @samp{@@} instead of the
6999 @samp{-}, without spaces between multiple switches.  This is supposed to
7000 ease shell processing.
7002 @item -print-multi-os-directory
7003 @opindex print-multi-os-directory
7004 Print the path to OS libraries for the selected
7005 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7006 present in the @file{lib} subdirectory and no multilibs are used, this is
7007 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7008 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7009 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7010 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7012 @item -print-multiarch
7013 @opindex print-multiarch
7014 Print the path to OS libraries for the selected multiarch,
7015 relative to some @file{lib} subdirectory.
7017 @item -print-prog-name=@var{program}
7018 @opindex print-prog-name
7019 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
7021 @item -print-libgcc-file-name
7022 @opindex print-libgcc-file-name
7023 Same as @option{-print-file-name=libgcc.a}.
7025 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7026 but you do want to link with @file{libgcc.a}.  You can do:
7028 @smallexample
7029 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7030 @end smallexample
7032 @item -print-search-dirs
7033 @opindex print-search-dirs
7034 Print the name of the configured installation directory and a list of
7035 program and library directories @command{gcc} searches---and don't do anything else.
7037 This is useful when @command{gcc} prints the error message
7038 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7039 To resolve this you either need to put @file{cpp0} and the other compiler
7040 components where @command{gcc} expects to find them, or you can set the environment
7041 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7042 Don't forget the trailing @samp{/}.
7043 @xref{Environment Variables}.
7045 @item -print-sysroot
7046 @opindex print-sysroot
7047 Print the target sysroot directory that is used during
7048 compilation.  This is the target sysroot specified either at configure
7049 time or using the @option{--sysroot} option, possibly with an extra
7050 suffix that depends on compilation options.  If no target sysroot is
7051 specified, the option prints nothing.
7053 @item -print-sysroot-headers-suffix
7054 @opindex print-sysroot-headers-suffix
7055 Print the suffix added to the target sysroot when searching for
7056 headers, or give an error if the compiler is not configured with such
7057 a suffix---and don't do anything else.
7059 @item -dumpmachine
7060 @opindex dumpmachine
7061 Print the compiler's target machine (for example,
7062 @samp{i686-pc-linux-gnu})---and don't do anything else.
7064 @item -dumpversion
7065 @opindex dumpversion
7066 Print the compiler version (for example, @samp{3.0})---and don't do
7067 anything else.
7069 @item -dumpspecs
7070 @opindex dumpspecs
7071 Print the compiler's built-in specs---and don't do anything else.  (This
7072 is used when GCC itself is being built.)  @xref{Spec Files}.
7074 @item -fno-eliminate-unused-debug-types
7075 @opindex feliminate-unused-debug-types
7076 @opindex fno-eliminate-unused-debug-types
7077 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7078 output for types that are nowhere used in the source file being compiled.
7079 Sometimes it is useful to have GCC emit debugging
7080 information for all types declared in a compilation
7081 unit, regardless of whether or not they are actually used
7082 in that compilation unit, for example 
7083 if, in the debugger, you want to cast a value to a type that is
7084 not actually used in your program (but is declared).  More often,
7085 however, this results in a significant amount of wasted space.
7086 @end table
7088 @node Optimize Options
7089 @section Options That Control Optimization
7090 @cindex optimize options
7091 @cindex options, optimization
7093 These options control various sorts of optimizations.
7095 Without any optimization option, the compiler's goal is to reduce the
7096 cost of compilation and to make debugging produce the expected
7097 results.  Statements are independent: if you stop the program with a
7098 breakpoint between statements, you can then assign a new value to any
7099 variable or change the program counter to any other statement in the
7100 function and get exactly the results you expect from the source
7101 code.
7103 Turning on optimization flags makes the compiler attempt to improve
7104 the performance and/or code size at the expense of compilation time
7105 and possibly the ability to debug the program.
7107 The compiler performs optimization based on the knowledge it has of the
7108 program.  Compiling multiple files at once to a single output file mode allows
7109 the compiler to use information gained from all of the files when compiling
7110 each of them.
7112 Not all optimizations are controlled directly by a flag.  Only
7113 optimizations that have a flag are listed in this section.
7115 Most optimizations are only enabled if an @option{-O} level is set on
7116 the command line.  Otherwise they are disabled, even if individual
7117 optimization flags are specified.
7119 Depending on the target and how GCC was configured, a slightly different
7120 set of optimizations may be enabled at each @option{-O} level than
7121 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7122 to find out the exact set of optimizations that are enabled at each level.
7123 @xref{Overall Options}, for examples.
7125 @table @gcctabopt
7126 @item -O
7127 @itemx -O1
7128 @opindex O
7129 @opindex O1
7130 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7131 more memory for a large function.
7133 With @option{-O}, the compiler tries to reduce code size and execution
7134 time, without performing any optimizations that take a great deal of
7135 compilation time.
7137 @option{-O} turns on the following optimization flags:
7138 @gccoptlist{
7139 -fauto-inc-dec @gol
7140 -fbranch-count-reg @gol
7141 -fcombine-stack-adjustments @gol
7142 -fcompare-elim @gol
7143 -fcprop-registers @gol
7144 -fdce @gol
7145 -fdefer-pop @gol
7146 -fdelayed-branch @gol
7147 -fdse @gol
7148 -fforward-propagate @gol
7149 -fguess-branch-probability @gol
7150 -fif-conversion2 @gol
7151 -fif-conversion @gol
7152 -finline-functions-called-once @gol
7153 -fipa-pure-const @gol
7154 -fipa-profile @gol
7155 -fipa-reference @gol
7156 -fmerge-constants @gol
7157 -fmove-loop-invariants @gol
7158 -fshrink-wrap @gol
7159 -fsplit-wide-types @gol
7160 -ftree-bit-ccp @gol
7161 -ftree-ccp @gol
7162 -fssa-phiopt @gol
7163 -ftree-ch @gol
7164 -ftree-copy-prop @gol
7165 -ftree-copyrename @gol
7166 -ftree-dce @gol
7167 -ftree-dominator-opts @gol
7168 -ftree-dse @gol
7169 -ftree-forwprop @gol
7170 -ftree-fre @gol
7171 -ftree-phiprop @gol
7172 -ftree-sink @gol
7173 -ftree-slsr @gol
7174 -ftree-sra @gol
7175 -ftree-pta @gol
7176 -ftree-ter @gol
7177 -funit-at-a-time}
7179 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7180 where doing so does not interfere with debugging.
7182 @item -O2
7183 @opindex O2
7184 Optimize even more.  GCC performs nearly all supported optimizations
7185 that do not involve a space-speed tradeoff.
7186 As compared to @option{-O}, this option increases both compilation time
7187 and the performance of the generated code.
7189 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7190 also turns on the following optimization flags:
7191 @gccoptlist{-fthread-jumps @gol
7192 -falign-functions  -falign-jumps @gol
7193 -falign-loops  -falign-labels @gol
7194 -fcaller-saves @gol
7195 -fcrossjumping @gol
7196 -fcse-follow-jumps  -fcse-skip-blocks @gol
7197 -fdelete-null-pointer-checks @gol
7198 -fdevirtualize -fdevirtualize-speculatively @gol
7199 -fexpensive-optimizations @gol
7200 -fgcse  -fgcse-lm  @gol
7201 -fhoist-adjacent-loads @gol
7202 -finline-small-functions @gol
7203 -findirect-inlining @gol
7204 -fipa-cp @gol
7205 -fipa-sra @gol
7206 -fipa-icf @gol
7207 -fisolate-erroneous-paths-dereference @gol
7208 -flra-remat @gol
7209 -foptimize-sibling-calls @gol
7210 -foptimize-strlen @gol
7211 -fpartial-inlining @gol
7212 -fpeephole2 @gol
7213 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7214 -frerun-cse-after-loop  @gol
7215 -fsched-interblock  -fsched-spec @gol
7216 -fschedule-insns  -fschedule-insns2 @gol
7217 -fstrict-aliasing -fstrict-overflow @gol
7218 -ftree-builtin-call-dce @gol
7219 -ftree-switch-conversion -ftree-tail-merge @gol
7220 -ftree-pre @gol
7221 -ftree-vrp @gol
7222 -fipa-ra}
7224 Please note the warning under @option{-fgcse} about
7225 invoking @option{-O2} on programs that use computed gotos.
7227 @item -O3
7228 @opindex O3
7229 Optimize yet more.  @option{-O3} turns on all optimizations specified
7230 by @option{-O2} and also turns on the @option{-finline-functions},
7231 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7232 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7233 @option{-ftree-loop-distribute-patterns},
7234 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7235 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7237 @item -O0
7238 @opindex O0
7239 Reduce compilation time and make debugging produce the expected
7240 results.  This is the default.
7242 @item -Os
7243 @opindex Os
7244 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7245 do not typically increase code size.  It also performs further
7246 optimizations designed to reduce code size.
7248 @option{-Os} disables the following optimization flags:
7249 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7250 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7251 -fprefetch-loop-arrays}
7253 @item -Ofast
7254 @opindex Ofast
7255 Disregard strict standards compliance.  @option{-Ofast} enables all
7256 @option{-O3} optimizations.  It also enables optimizations that are not
7257 valid for all standard-compliant programs.
7258 It turns on @option{-ffast-math} and the Fortran-specific
7259 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7261 @item -Og
7262 @opindex Og
7263 Optimize debugging experience.  @option{-Og} enables optimizations
7264 that do not interfere with debugging. It should be the optimization
7265 level of choice for the standard edit-compile-debug cycle, offering
7266 a reasonable level of optimization while maintaining fast compilation
7267 and a good debugging experience.
7269 If you use multiple @option{-O} options, with or without level numbers,
7270 the last such option is the one that is effective.
7271 @end table
7273 Options of the form @option{-f@var{flag}} specify machine-independent
7274 flags.  Most flags have both positive and negative forms; the negative
7275 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7276 below, only one of the forms is listed---the one you typically 
7277 use.  You can figure out the other form by either removing @samp{no-}
7278 or adding it.
7280 The following options control specific optimizations.  They are either
7281 activated by @option{-O} options or are related to ones that are.  You
7282 can use the following flags in the rare cases when ``fine-tuning'' of
7283 optimizations to be performed is desired.
7285 @table @gcctabopt
7286 @item -fno-defer-pop
7287 @opindex fno-defer-pop
7288 Always pop the arguments to each function call as soon as that function
7289 returns.  For machines that must pop arguments after a function call,
7290 the compiler normally lets arguments accumulate on the stack for several
7291 function calls and pops them all at once.
7293 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7295 @item -fforward-propagate
7296 @opindex fforward-propagate
7297 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7298 instructions and checks if the result can be simplified.  If loop unrolling
7299 is active, two passes are performed and the second is scheduled after
7300 loop unrolling.
7302 This option is enabled by default at optimization levels @option{-O},
7303 @option{-O2}, @option{-O3}, @option{-Os}.
7305 @item -ffp-contract=@var{style}
7306 @opindex ffp-contract
7307 @option{-ffp-contract=off} disables floating-point expression contraction.
7308 @option{-ffp-contract=fast} enables floating-point expression contraction
7309 such as forming of fused multiply-add operations if the target has
7310 native support for them.
7311 @option{-ffp-contract=on} enables floating-point expression contraction
7312 if allowed by the language standard.  This is currently not implemented
7313 and treated equal to @option{-ffp-contract=off}.
7315 The default is @option{-ffp-contract=fast}.
7317 @item -fomit-frame-pointer
7318 @opindex fomit-frame-pointer
7319 Don't keep the frame pointer in a register for functions that
7320 don't need one.  This avoids the instructions to save, set up and
7321 restore frame pointers; it also makes an extra register available
7322 in many functions.  @strong{It also makes debugging impossible on
7323 some machines.}
7325 On some machines, such as the VAX, this flag has no effect, because
7326 the standard calling sequence automatically handles the frame pointer
7327 and nothing is saved by pretending it doesn't exist.  The
7328 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7329 whether a target machine supports this flag.  @xref{Registers,,Register
7330 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7332 Starting with GCC version 4.6, the default setting (when not optimizing for
7333 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7334 @option{-fomit-frame-pointer}.  The default can be reverted to
7335 @option{-fno-omit-frame-pointer} by configuring GCC with the
7336 @option{--enable-frame-pointer} configure option.
7338 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7340 @item -foptimize-sibling-calls
7341 @opindex foptimize-sibling-calls
7342 Optimize sibling and tail recursive calls.
7344 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7346 @item -foptimize-strlen
7347 @opindex foptimize-strlen
7348 Optimize various standard C string functions (e.g. @code{strlen},
7349 @code{strchr} or @code{strcpy}) and
7350 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7352 Enabled at levels @option{-O2}, @option{-O3}.
7354 @item -fno-inline
7355 @opindex fno-inline
7356 Do not expand any functions inline apart from those marked with
7357 the @code{always_inline} attribute.  This is the default when not
7358 optimizing.
7360 Single functions can be exempted from inlining by marking them
7361 with the @code{noinline} attribute.
7363 @item -finline-small-functions
7364 @opindex finline-small-functions
7365 Integrate functions into their callers when their body is smaller than expected
7366 function call code (so overall size of program gets smaller).  The compiler
7367 heuristically decides which functions are simple enough to be worth integrating
7368 in this way.  This inlining applies to all functions, even those not declared
7369 inline.
7371 Enabled at level @option{-O2}.
7373 @item -findirect-inlining
7374 @opindex findirect-inlining
7375 Inline also indirect calls that are discovered to be known at compile
7376 time thanks to previous inlining.  This option has any effect only
7377 when inlining itself is turned on by the @option{-finline-functions}
7378 or @option{-finline-small-functions} options.
7380 Enabled at level @option{-O2}.
7382 @item -finline-functions
7383 @opindex finline-functions
7384 Consider all functions for inlining, even if they are not declared inline.
7385 The compiler heuristically decides which functions are worth integrating
7386 in this way.
7388 If all calls to a given function are integrated, and the function is
7389 declared @code{static}, then the function is normally not output as
7390 assembler code in its own right.
7392 Enabled at level @option{-O3}.
7394 @item -finline-functions-called-once
7395 @opindex finline-functions-called-once
7396 Consider all @code{static} functions called once for inlining into their
7397 caller even if they are not marked @code{inline}.  If a call to a given
7398 function is integrated, then the function is not output as assembler code
7399 in its own right.
7401 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7403 @item -fearly-inlining
7404 @opindex fearly-inlining
7405 Inline functions marked by @code{always_inline} and functions whose body seems
7406 smaller than the function call overhead early before doing
7407 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7408 makes profiling significantly cheaper and usually inlining faster on programs
7409 having large chains of nested wrapper functions.
7411 Enabled by default.
7413 @item -fipa-sra
7414 @opindex fipa-sra
7415 Perform interprocedural scalar replacement of aggregates, removal of
7416 unused parameters and replacement of parameters passed by reference
7417 by parameters passed by value.
7419 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7421 @item -finline-limit=@var{n}
7422 @opindex finline-limit
7423 By default, GCC limits the size of functions that can be inlined.  This flag
7424 allows coarse control of this limit.  @var{n} is the size of functions that
7425 can be inlined in number of pseudo instructions.
7427 Inlining is actually controlled by a number of parameters, which may be
7428 specified individually by using @option{--param @var{name}=@var{value}}.
7429 The @option{-finline-limit=@var{n}} option sets some of these parameters
7430 as follows:
7432 @table @gcctabopt
7433 @item max-inline-insns-single
7434 is set to @var{n}/2.
7435 @item max-inline-insns-auto
7436 is set to @var{n}/2.
7437 @end table
7439 See below for a documentation of the individual
7440 parameters controlling inlining and for the defaults of these parameters.
7442 @emph{Note:} there may be no value to @option{-finline-limit} that results
7443 in default behavior.
7445 @emph{Note:} pseudo instruction represents, in this particular context, an
7446 abstract measurement of function's size.  In no way does it represent a count
7447 of assembly instructions and as such its exact meaning might change from one
7448 release to an another.
7450 @item -fno-keep-inline-dllexport
7451 @opindex -fno-keep-inline-dllexport
7452 This is a more fine-grained version of @option{-fkeep-inline-functions},
7453 which applies only to functions that are declared using the @code{dllexport}
7454 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7455 Functions}.)
7457 @item -fkeep-inline-functions
7458 @opindex fkeep-inline-functions
7459 In C, emit @code{static} functions that are declared @code{inline}
7460 into the object file, even if the function has been inlined into all
7461 of its callers.  This switch does not affect functions using the
7462 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7463 inline functions into the object file.
7465 @item -fkeep-static-consts
7466 @opindex fkeep-static-consts
7467 Emit variables declared @code{static const} when optimization isn't turned
7468 on, even if the variables aren't referenced.
7470 GCC enables this option by default.  If you want to force the compiler to
7471 check if a variable is referenced, regardless of whether or not
7472 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7474 @item -fmerge-constants
7475 @opindex fmerge-constants
7476 Attempt to merge identical constants (string constants and floating-point
7477 constants) across compilation units.
7479 This option is the default for optimized compilation if the assembler and
7480 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7481 behavior.
7483 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7485 @item -fmerge-all-constants
7486 @opindex fmerge-all-constants
7487 Attempt to merge identical constants and identical variables.
7489 This option implies @option{-fmerge-constants}.  In addition to
7490 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7491 arrays or initialized constant variables with integral or floating-point
7492 types.  Languages like C or C++ require each variable, including multiple
7493 instances of the same variable in recursive calls, to have distinct locations,
7494 so using this option results in non-conforming
7495 behavior.
7497 @item -fmodulo-sched
7498 @opindex fmodulo-sched
7499 Perform swing modulo scheduling immediately before the first scheduling
7500 pass.  This pass looks at innermost loops and reorders their
7501 instructions by overlapping different iterations.
7503 @item -fmodulo-sched-allow-regmoves
7504 @opindex fmodulo-sched-allow-regmoves
7505 Perform more aggressive SMS-based modulo scheduling with register moves
7506 allowed.  By setting this flag certain anti-dependences edges are
7507 deleted, which triggers the generation of reg-moves based on the
7508 life-range analysis.  This option is effective only with
7509 @option{-fmodulo-sched} enabled.
7511 @item -fno-branch-count-reg
7512 @opindex fno-branch-count-reg
7513 Do not use ``decrement and branch'' instructions on a count register,
7514 but instead generate a sequence of instructions that decrement a
7515 register, compare it against zero, then branch based upon the result.
7516 This option is only meaningful on architectures that support such
7517 instructions, which include x86, PowerPC, IA-64 and S/390.
7519 Enabled by default at @option{-O1} and higher.
7521 The default is @option{-fbranch-count-reg}.
7523 @item -fno-function-cse
7524 @opindex fno-function-cse
7525 Do not put function addresses in registers; make each instruction that
7526 calls a constant function contain the function's address explicitly.
7528 This option results in less efficient code, but some strange hacks
7529 that alter the assembler output may be confused by the optimizations
7530 performed when this option is not used.
7532 The default is @option{-ffunction-cse}
7534 @item -fno-zero-initialized-in-bss
7535 @opindex fno-zero-initialized-in-bss
7536 If the target supports a BSS section, GCC by default puts variables that
7537 are initialized to zero into BSS@.  This can save space in the resulting
7538 code.
7540 This option turns off this behavior because some programs explicitly
7541 rely on variables going to the data section---e.g., so that the
7542 resulting executable can find the beginning of that section and/or make
7543 assumptions based on that.
7545 The default is @option{-fzero-initialized-in-bss}.
7547 @item -fthread-jumps
7548 @opindex fthread-jumps
7549 Perform optimizations that check to see if a jump branches to a
7550 location where another comparison subsumed by the first is found.  If
7551 so, the first branch is redirected to either the destination of the
7552 second branch or a point immediately following it, depending on whether
7553 the condition is known to be true or false.
7555 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7557 @item -fsplit-wide-types
7558 @opindex fsplit-wide-types
7559 When using a type that occupies multiple registers, such as @code{long
7560 long} on a 32-bit system, split the registers apart and allocate them
7561 independently.  This normally generates better code for those types,
7562 but may make debugging more difficult.
7564 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7565 @option{-Os}.
7567 @item -fcse-follow-jumps
7568 @opindex fcse-follow-jumps
7569 In common subexpression elimination (CSE), scan through jump instructions
7570 when the target of the jump is not reached by any other path.  For
7571 example, when CSE encounters an @code{if} statement with an
7572 @code{else} clause, CSE follows the jump when the condition
7573 tested is false.
7575 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7577 @item -fcse-skip-blocks
7578 @opindex fcse-skip-blocks
7579 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7580 follow jumps that conditionally skip over blocks.  When CSE
7581 encounters a simple @code{if} statement with no else clause,
7582 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7583 body of the @code{if}.
7585 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7587 @item -frerun-cse-after-loop
7588 @opindex frerun-cse-after-loop
7589 Re-run common subexpression elimination after loop optimizations are
7590 performed.
7592 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7594 @item -fgcse
7595 @opindex fgcse
7596 Perform a global common subexpression elimination pass.
7597 This pass also performs global constant and copy propagation.
7599 @emph{Note:} When compiling a program using computed gotos, a GCC
7600 extension, you may get better run-time performance if you disable
7601 the global common subexpression elimination pass by adding
7602 @option{-fno-gcse} to the command line.
7604 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7606 @item -fgcse-lm
7607 @opindex fgcse-lm
7608 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7609 attempts to move loads that are only killed by stores into themselves.  This
7610 allows a loop containing a load/store sequence to be changed to a load outside
7611 the loop, and a copy/store within the loop.
7613 Enabled by default when @option{-fgcse} is enabled.
7615 @item -fgcse-sm
7616 @opindex fgcse-sm
7617 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7618 global common subexpression elimination.  This pass attempts to move
7619 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7620 loops containing a load/store sequence can be changed to a load before
7621 the loop and a store after the loop.
7623 Not enabled at any optimization level.
7625 @item -fgcse-las
7626 @opindex fgcse-las
7627 When @option{-fgcse-las} is enabled, the global common subexpression
7628 elimination pass eliminates redundant loads that come after stores to the
7629 same memory location (both partial and full redundancies).
7631 Not enabled at any optimization level.
7633 @item -fgcse-after-reload
7634 @opindex fgcse-after-reload
7635 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7636 pass is performed after reload.  The purpose of this pass is to clean up
7637 redundant spilling.
7639 @item -faggressive-loop-optimizations
7640 @opindex faggressive-loop-optimizations
7641 This option tells the loop optimizer to use language constraints to
7642 derive bounds for the number of iterations of a loop.  This assumes that
7643 loop code does not invoke undefined behavior by for example causing signed
7644 integer overflows or out-of-bound array accesses.  The bounds for the
7645 number of iterations of a loop are used to guide loop unrolling and peeling
7646 and loop exit test optimizations.
7647 This option is enabled by default.
7649 @item -funsafe-loop-optimizations
7650 @opindex funsafe-loop-optimizations
7651 This option tells the loop optimizer to assume that loop indices do not
7652 overflow, and that loops with nontrivial exit condition are not
7653 infinite.  This enables a wider range of loop optimizations even if
7654 the loop optimizer itself cannot prove that these assumptions are valid.
7655 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7656 if it finds this kind of loop.
7658 @item -fcrossjumping
7659 @opindex fcrossjumping
7660 Perform cross-jumping transformation.
7661 This transformation unifies equivalent code and saves code size.  The
7662 resulting code may or may not perform better than without cross-jumping.
7664 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7666 @item -fauto-inc-dec
7667 @opindex fauto-inc-dec
7668 Combine increments or decrements of addresses with memory accesses.
7669 This pass is always skipped on architectures that do not have
7670 instructions to support this.  Enabled by default at @option{-O} and
7671 higher on architectures that support this.
7673 @item -fdce
7674 @opindex fdce
7675 Perform dead code elimination (DCE) on RTL@.
7676 Enabled by default at @option{-O} and higher.
7678 @item -fdse
7679 @opindex fdse
7680 Perform dead store elimination (DSE) on RTL@.
7681 Enabled by default at @option{-O} and higher.
7683 @item -fif-conversion
7684 @opindex fif-conversion
7685 Attempt to transform conditional jumps into branch-less equivalents.  This
7686 includes use of conditional moves, min, max, set flags and abs instructions, and
7687 some tricks doable by standard arithmetics.  The use of conditional execution
7688 on chips where it is available is controlled by @code{if-conversion2}.
7690 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7692 @item -fif-conversion2
7693 @opindex fif-conversion2
7694 Use conditional execution (where available) to transform conditional jumps into
7695 branch-less equivalents.
7697 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7699 @item -fdeclone-ctor-dtor
7700 @opindex fdeclone-ctor-dtor
7701 The C++ ABI requires multiple entry points for constructors and
7702 destructors: one for a base subobject, one for a complete object, and
7703 one for a virtual destructor that calls operator delete afterwards.
7704 For a hierarchy with virtual bases, the base and complete variants are
7705 clones, which means two copies of the function.  With this option, the
7706 base and complete variants are changed to be thunks that call a common
7707 implementation.
7709 Enabled by @option{-Os}.
7711 @item -fdelete-null-pointer-checks
7712 @opindex fdelete-null-pointer-checks
7713 Assume that programs cannot safely dereference null pointers, and that
7714 no code or data element resides there.  This enables simple constant
7715 folding optimizations at all optimization levels.  In addition, other
7716 optimization passes in GCC use this flag to control global dataflow
7717 analyses that eliminate useless checks for null pointers; these assume
7718 that if a pointer is checked after it has already been dereferenced,
7719 it cannot be null.
7721 Note however that in some environments this assumption is not true.
7722 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7723 for programs that depend on that behavior.
7725 Some targets, especially embedded ones, disable this option at all levels.
7726 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7727 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7728 are enabled independently at different optimization levels.
7730 @item -fdevirtualize
7731 @opindex fdevirtualize
7732 Attempt to convert calls to virtual functions to direct calls.  This
7733 is done both within a procedure and interprocedurally as part of
7734 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7735 propagation (@option{-fipa-cp}).
7736 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7738 @item -fdevirtualize-speculatively
7739 @opindex fdevirtualize-speculatively
7740 Attempt to convert calls to virtual functions to speculative direct calls.
7741 Based on the analysis of the type inheritance graph, determine for a given call
7742 the set of likely targets. If the set is small, preferably of size 1, change
7743 the call into an conditional deciding on direct and indirect call.  The
7744 speculative calls enable more optimizations, such as inlining.  When they seem
7745 useless after further optimization, they are converted back into original form.
7747 @item -fdevirtualize-at-ltrans
7748 @opindex fdevirtualize-at-ltrans
7749 Perform extra streaming needed for agressive devirtualization during LTO local
7750 transformation stage. This option enables more devirtualization but
7751 significantly increases the size of streamed data. For this reason it is
7752 disabled by default.
7754 @item -fexpensive-optimizations
7755 @opindex fexpensive-optimizations
7756 Perform a number of minor optimizations that are relatively expensive.
7758 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7760 @item -free
7761 @opindex free
7762 Attempt to remove redundant extension instructions.  This is especially
7763 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7764 registers after writing to their lower 32-bit half.
7766 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7767 @option{-O3}, @option{-Os}.
7769 @item -flive-range-shrinkage
7770 @opindex flive-range-shrinkage
7771 Attempt to decrease register pressure through register live range
7772 shrinkage.  This is helpful for fast processors with small or moderate
7773 size register sets.
7775 @item -fira-algorithm=@var{algorithm}
7776 Use the specified coloring algorithm for the integrated register
7777 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7778 specifies Chow's priority coloring, or @samp{CB}, which specifies
7779 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7780 for all architectures, but for those targets that do support it, it is
7781 the default because it generates better code.
7783 @item -fira-region=@var{region}
7784 Use specified regions for the integrated register allocator.  The
7785 @var{region} argument should be one of the following:
7787 @table @samp
7789 @item all
7790 Use all loops as register allocation regions.
7791 This can give the best results for machines with a small and/or
7792 irregular register set.
7794 @item mixed
7795 Use all loops except for loops with small register pressure 
7796 as the regions.  This value usually gives
7797 the best results in most cases and for most architectures,
7798 and is enabled by default when compiling with optimization for speed
7799 (@option{-O}, @option{-O2}, @dots{}).
7801 @item one
7802 Use all functions as a single region.  
7803 This typically results in the smallest code size, and is enabled by default for
7804 @option{-Os} or @option{-O0}.
7806 @end table
7808 @item -fira-hoist-pressure
7809 @opindex fira-hoist-pressure
7810 Use IRA to evaluate register pressure in the code hoisting pass for
7811 decisions to hoist expressions.  This option usually results in smaller
7812 code, but it can slow the compiler down.
7814 This option is enabled at level @option{-Os} for all targets.
7816 @item -fira-loop-pressure
7817 @opindex fira-loop-pressure
7818 Use IRA to evaluate register pressure in loops for decisions to move
7819 loop invariants.  This option usually results in generation
7820 of faster and smaller code on machines with large register files (>= 32
7821 registers), but it can slow the compiler down.
7823 This option is enabled at level @option{-O3} for some targets.
7825 @item -fno-ira-share-save-slots
7826 @opindex fno-ira-share-save-slots
7827 Disable sharing of stack slots used for saving call-used hard
7828 registers living through a call.  Each hard register gets a
7829 separate stack slot, and as a result function stack frames are
7830 larger.
7832 @item -fno-ira-share-spill-slots
7833 @opindex fno-ira-share-spill-slots
7834 Disable sharing of stack slots allocated for pseudo-registers.  Each
7835 pseudo-register that does not get a hard register gets a separate
7836 stack slot, and as a result function stack frames are larger.
7838 @item -fira-verbose=@var{n}
7839 @opindex fira-verbose
7840 Control the verbosity of the dump file for the integrated register allocator.
7841 The default value is 5.  If the value @var{n} is greater or equal to 10,
7842 the dump output is sent to stderr using the same format as @var{n} minus 10.
7844 @item -flra-remat
7845 @opindex fcaller-saves
7846 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7847 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7848 values if it is profitable.
7850 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7852 @item -fdelayed-branch
7853 @opindex fdelayed-branch
7854 If supported for the target machine, attempt to reorder instructions
7855 to exploit instruction slots available after delayed branch
7856 instructions.
7858 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7860 @item -fschedule-insns
7861 @opindex fschedule-insns
7862 If supported for the target machine, attempt to reorder instructions to
7863 eliminate execution stalls due to required data being unavailable.  This
7864 helps machines that have slow floating point or memory load instructions
7865 by allowing other instructions to be issued until the result of the load
7866 or floating-point instruction is required.
7868 Enabled at levels @option{-O2}, @option{-O3}.
7870 @item -fschedule-insns2
7871 @opindex fschedule-insns2
7872 Similar to @option{-fschedule-insns}, but requests an additional pass of
7873 instruction scheduling after register allocation has been done.  This is
7874 especially useful on machines with a relatively small number of
7875 registers and where memory load instructions take more than one cycle.
7877 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7879 @item -fno-sched-interblock
7880 @opindex fno-sched-interblock
7881 Don't schedule instructions across basic blocks.  This is normally
7882 enabled by default when scheduling before register allocation, i.e.@:
7883 with @option{-fschedule-insns} or at @option{-O2} or higher.
7885 @item -fno-sched-spec
7886 @opindex fno-sched-spec
7887 Don't allow speculative motion of non-load instructions.  This is normally
7888 enabled by default when scheduling before register allocation, i.e.@:
7889 with @option{-fschedule-insns} or at @option{-O2} or higher.
7891 @item -fsched-pressure
7892 @opindex fsched-pressure
7893 Enable register pressure sensitive insn scheduling before register
7894 allocation.  This only makes sense when scheduling before register
7895 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7896 @option{-O2} or higher.  Usage of this option can improve the
7897 generated code and decrease its size by preventing register pressure
7898 increase above the number of available hard registers and subsequent
7899 spills in register allocation.
7901 @item -fsched-spec-load
7902 @opindex fsched-spec-load
7903 Allow speculative motion of some load instructions.  This only makes
7904 sense when scheduling before register allocation, i.e.@: with
7905 @option{-fschedule-insns} or at @option{-O2} or higher.
7907 @item -fsched-spec-load-dangerous
7908 @opindex fsched-spec-load-dangerous
7909 Allow speculative motion of more load instructions.  This only makes
7910 sense when scheduling before register allocation, i.e.@: with
7911 @option{-fschedule-insns} or at @option{-O2} or higher.
7913 @item -fsched-stalled-insns
7914 @itemx -fsched-stalled-insns=@var{n}
7915 @opindex fsched-stalled-insns
7916 Define how many insns (if any) can be moved prematurely from the queue
7917 of stalled insns into the ready list during the second scheduling pass.
7918 @option{-fno-sched-stalled-insns} means that no insns are moved
7919 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7920 on how many queued insns can be moved prematurely.
7921 @option{-fsched-stalled-insns} without a value is equivalent to
7922 @option{-fsched-stalled-insns=1}.
7924 @item -fsched-stalled-insns-dep
7925 @itemx -fsched-stalled-insns-dep=@var{n}
7926 @opindex fsched-stalled-insns-dep
7927 Define how many insn groups (cycles) are examined for a dependency
7928 on a stalled insn that is a candidate for premature removal from the queue
7929 of stalled insns.  This has an effect only during the second scheduling pass,
7930 and only if @option{-fsched-stalled-insns} is used.
7931 @option{-fno-sched-stalled-insns-dep} is equivalent to
7932 @option{-fsched-stalled-insns-dep=0}.
7933 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7934 @option{-fsched-stalled-insns-dep=1}.
7936 @item -fsched2-use-superblocks
7937 @opindex fsched2-use-superblocks
7938 When scheduling after register allocation, use superblock scheduling.
7939 This allows motion across basic block boundaries,
7940 resulting in faster schedules.  This option is experimental, as not all machine
7941 descriptions used by GCC model the CPU closely enough to avoid unreliable
7942 results from the algorithm.
7944 This only makes sense when scheduling after register allocation, i.e.@: with
7945 @option{-fschedule-insns2} or at @option{-O2} or higher.
7947 @item -fsched-group-heuristic
7948 @opindex fsched-group-heuristic
7949 Enable the group heuristic in the scheduler.  This heuristic favors
7950 the instruction that belongs to a schedule group.  This is enabled
7951 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7952 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7954 @item -fsched-critical-path-heuristic
7955 @opindex fsched-critical-path-heuristic
7956 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7957 instructions on the critical path.  This is enabled by default when
7958 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7959 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7961 @item -fsched-spec-insn-heuristic
7962 @opindex fsched-spec-insn-heuristic
7963 Enable the speculative instruction heuristic in the scheduler.  This
7964 heuristic favors speculative instructions with greater dependency weakness.
7965 This is enabled by default when scheduling is enabled, i.e.@:
7966 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7967 or at @option{-O2} or higher.
7969 @item -fsched-rank-heuristic
7970 @opindex fsched-rank-heuristic
7971 Enable the rank heuristic in the scheduler.  This heuristic favors
7972 the instruction belonging to a basic block with greater size or frequency.
7973 This is enabled by default when scheduling is enabled, i.e.@:
7974 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7975 at @option{-O2} or higher.
7977 @item -fsched-last-insn-heuristic
7978 @opindex fsched-last-insn-heuristic
7979 Enable the last-instruction heuristic in the scheduler.  This heuristic
7980 favors the instruction that is less dependent on the last instruction
7981 scheduled.  This is enabled by default when scheduling is enabled,
7982 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7983 at @option{-O2} or higher.
7985 @item -fsched-dep-count-heuristic
7986 @opindex fsched-dep-count-heuristic
7987 Enable the dependent-count heuristic in the scheduler.  This heuristic
7988 favors the instruction that has more instructions depending on it.
7989 This is enabled by default when scheduling is enabled, i.e.@:
7990 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7991 at @option{-O2} or higher.
7993 @item -freschedule-modulo-scheduled-loops
7994 @opindex freschedule-modulo-scheduled-loops
7995 Modulo scheduling is performed before traditional scheduling.  If a loop
7996 is modulo scheduled, later scheduling passes may change its schedule.  
7997 Use this option to control that behavior.
7999 @item -fselective-scheduling
8000 @opindex fselective-scheduling
8001 Schedule instructions using selective scheduling algorithm.  Selective
8002 scheduling runs instead of the first scheduler pass.
8004 @item -fselective-scheduling2
8005 @opindex fselective-scheduling2
8006 Schedule instructions using selective scheduling algorithm.  Selective
8007 scheduling runs instead of the second scheduler pass.
8009 @item -fsel-sched-pipelining
8010 @opindex fsel-sched-pipelining
8011 Enable software pipelining of innermost loops during selective scheduling.
8012 This option has no effect unless one of @option{-fselective-scheduling} or
8013 @option{-fselective-scheduling2} is turned on.
8015 @item -fsel-sched-pipelining-outer-loops
8016 @opindex fsel-sched-pipelining-outer-loops
8017 When pipelining loops during selective scheduling, also pipeline outer loops.
8018 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8020 @item -fsemantic-interposition
8021 @opindex fsemantic-interposition
8022 Some object formats, like ELF, allow interposing of symbols by dynamic linker.
8023 This means that for symbols exported from the DSO compiler can not perform
8024 inter-procedural propagation, inlining and other optimizations in anticipation
8025 that the function or variable in question may change. While this feature is
8026 useful, for example, to rewrite memory allocation functions by a debugging
8027 implementation, it is expensive in the terms of code quality.
8028 With @option{-fno-semantic-inteposition} compiler assumest that if interposition
8029 happens for functions the overwritting function will have
8030 precisely same semantics (and side effects). Similarly if interposition happens
8031 for variables, the constructor of the variable will be the same. The flag
8032 has no effect for functions explicitly declared inline, where
8033 interposition changing semantic is never allowed and for symbols explicitly
8034 declared weak.
8036 @item -fshrink-wrap
8037 @opindex fshrink-wrap
8038 Emit function prologues only before parts of the function that need it,
8039 rather than at the top of the function.  This flag is enabled by default at
8040 @option{-O} and higher.
8042 @item -fcaller-saves
8043 @opindex fcaller-saves
8044 Enable allocation of values to registers that are clobbered by
8045 function calls, by emitting extra instructions to save and restore the
8046 registers around such calls.  Such allocation is done only when it
8047 seems to result in better code.
8049 This option is always enabled by default on certain machines, usually
8050 those which have no call-preserved registers to use instead.
8052 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8054 @item -fcombine-stack-adjustments
8055 @opindex fcombine-stack-adjustments
8056 Tracks stack adjustments (pushes and pops) and stack memory references
8057 and then tries to find ways to combine them.
8059 Enabled by default at @option{-O1} and higher.
8061 @item -fipa-ra
8062 Use caller save registers for allocation if those registers are not used by
8063 any called function.  In that case it is not necessary to save and restore
8064 them around calls.  This is only possible if called functions are part of
8065 same compilation unit as current function and they are compiled before it.
8067 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8069 @item -fconserve-stack
8070 @opindex fconserve-stack
8071 Attempt to minimize stack usage.  The compiler attempts to use less
8072 stack space, even if that makes the program slower.  This option
8073 implies setting the @option{large-stack-frame} parameter to 100
8074 and the @option{large-stack-frame-growth} parameter to 400.
8076 @item -ftree-reassoc
8077 @opindex ftree-reassoc
8078 Perform reassociation on trees.  This flag is enabled by default
8079 at @option{-O} and higher.
8081 @item -ftree-pre
8082 @opindex ftree-pre
8083 Perform partial redundancy elimination (PRE) on trees.  This flag is
8084 enabled by default at @option{-O2} and @option{-O3}.
8086 @item -ftree-partial-pre
8087 @opindex ftree-partial-pre
8088 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8089 enabled by default at @option{-O3}.
8091 @item -ftree-forwprop
8092 @opindex ftree-forwprop
8093 Perform forward propagation on trees.  This flag is enabled by default
8094 at @option{-O} and higher.
8096 @item -ftree-fre
8097 @opindex ftree-fre
8098 Perform full redundancy elimination (FRE) on trees.  The difference
8099 between FRE and PRE is that FRE only considers expressions
8100 that are computed on all paths leading to the redundant computation.
8101 This analysis is faster than PRE, though it exposes fewer redundancies.
8102 This flag is enabled by default at @option{-O} and higher.
8104 @item -ftree-phiprop
8105 @opindex ftree-phiprop
8106 Perform hoisting of loads from conditional pointers on trees.  This
8107 pass is enabled by default at @option{-O} and higher.
8109 @item -fhoist-adjacent-loads
8110 @opindex hoist-adjacent-loads
8111 Speculatively hoist loads from both branches of an if-then-else if the
8112 loads are from adjacent locations in the same structure and the target
8113 architecture has a conditional move instruction.  This flag is enabled
8114 by default at @option{-O2} and higher.
8116 @item -ftree-copy-prop
8117 @opindex ftree-copy-prop
8118 Perform copy propagation on trees.  This pass eliminates unnecessary
8119 copy operations.  This flag is enabled by default at @option{-O} and
8120 higher.
8122 @item -fipa-pure-const
8123 @opindex fipa-pure-const
8124 Discover which functions are pure or constant.
8125 Enabled by default at @option{-O} and higher.
8127 @item -fipa-reference
8128 @opindex fipa-reference
8129 Discover which static variables do not escape the
8130 compilation unit.
8131 Enabled by default at @option{-O} and higher.
8133 @item -fipa-pta
8134 @opindex fipa-pta
8135 Perform interprocedural pointer analysis and interprocedural modification
8136 and reference analysis.  This option can cause excessive memory and
8137 compile-time usage on large compilation units.  It is not enabled by
8138 default at any optimization level.
8140 @item -fipa-profile
8141 @opindex fipa-profile
8142 Perform interprocedural profile propagation.  The functions called only from
8143 cold functions are marked as cold. Also functions executed once (such as
8144 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8145 functions and loop less parts of functions executed once are then optimized for
8146 size.
8147 Enabled by default at @option{-O} and higher.
8149 @item -fipa-cp
8150 @opindex fipa-cp
8151 Perform interprocedural constant propagation.
8152 This optimization analyzes the program to determine when values passed
8153 to functions are constants and then optimizes accordingly.
8154 This optimization can substantially increase performance
8155 if the application has constants passed to functions.
8156 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8158 @item -fipa-cp-clone
8159 @opindex fipa-cp-clone
8160 Perform function cloning to make interprocedural constant propagation stronger.
8161 When enabled, interprocedural constant propagation performs function cloning
8162 when externally visible function can be called with constant arguments.
8163 Because this optimization can create multiple copies of functions,
8164 it may significantly increase code size
8165 (see @option{--param ipcp-unit-growth=@var{value}}).
8166 This flag is enabled by default at @option{-O3}.
8168 @item -fipa-icf
8169 @opindex fipa-icf
8170 Perform Identical Code Folding for functions and read-only variables.
8171 The optimization reduces code size and may disturb unwind stacks by replacing
8172 a function by equivalent one with a different name. The optimization works
8173 more effectively with link time optimization enabled.
8175 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8176 works on different levels and thus the optimizations are not same - there are
8177 equivalences that are found only by GCC and equivalences found only by Gold.
8179 This flag is enabled by default at @option{-O2} and @option{-Os}.
8181 @item -fisolate-erroneous-paths-dereference
8182 Detect paths which trigger erroneous or undefined behaviour due to
8183 dereferencing a NULL pointer.  Isolate those paths from the main control
8184 flow and turn the statement with erroneous or undefined behaviour into a trap.
8186 @item -fisolate-erroneous-paths-attribute
8187 Detect paths which trigger erroneous or undefined behaviour due a NULL value
8188 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
8189 attribute.  Isolate those paths from the main control flow and turn the
8190 statement with erroneous or undefined behaviour into a trap.  This is not
8191 currently enabled, but may be enabled by @code{-O2} in the future.
8193 @item -ftree-sink
8194 @opindex ftree-sink
8195 Perform forward store motion  on trees.  This flag is
8196 enabled by default at @option{-O} and higher.
8198 @item -ftree-bit-ccp
8199 @opindex ftree-bit-ccp
8200 Perform sparse conditional bit constant propagation on trees and propagate
8201 pointer alignment information.
8202 This pass only operates on local scalar variables and is enabled by default
8203 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8205 @item -ftree-ccp
8206 @opindex ftree-ccp
8207 Perform sparse conditional constant propagation (CCP) on trees.  This
8208 pass only operates on local scalar variables and is enabled by default
8209 at @option{-O} and higher.
8211 @item -fssa-phiopt
8212 @opindex fssa-phiopt
8213 Perform pattern matching on SSA PHI nodes to optimize conditional
8214 code.  This pass is enabled by default at @option{-O} and higher.
8216 @item -ftree-switch-conversion
8217 Perform conversion of simple initializations in a switch to
8218 initializations from a scalar array.  This flag is enabled by default
8219 at @option{-O2} and higher.
8221 @item -ftree-tail-merge
8222 Look for identical code sequences.  When found, replace one with a jump to the
8223 other.  This optimization is known as tail merging or cross jumping.  This flag
8224 is enabled by default at @option{-O2} and higher.  The compilation time
8225 in this pass can
8226 be limited using @option{max-tail-merge-comparisons} parameter and
8227 @option{max-tail-merge-iterations} parameter.
8229 @item -ftree-dce
8230 @opindex ftree-dce
8231 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8232 default at @option{-O} and higher.
8234 @item -ftree-builtin-call-dce
8235 @opindex ftree-builtin-call-dce
8236 Perform conditional dead code elimination (DCE) for calls to built-in functions
8237 that may set @code{errno} but are otherwise side-effect free.  This flag is
8238 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8239 specified.
8241 @item -ftree-dominator-opts
8242 @opindex ftree-dominator-opts
8243 Perform a variety of simple scalar cleanups (constant/copy
8244 propagation, redundancy elimination, range propagation and expression
8245 simplification) based on a dominator tree traversal.  This also
8246 performs jump threading (to reduce jumps to jumps). This flag is
8247 enabled by default at @option{-O} and higher.
8249 @item -ftree-dse
8250 @opindex ftree-dse
8251 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8252 a memory location that is later overwritten by another store without
8253 any intervening loads.  In this case the earlier store can be deleted.  This
8254 flag is enabled by default at @option{-O} and higher.
8256 @item -ftree-ch
8257 @opindex ftree-ch
8258 Perform loop header copying on trees.  This is beneficial since it increases
8259 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8260 is enabled by default at @option{-O} and higher.  It is not enabled
8261 for @option{-Os}, since it usually increases code size.
8263 @item -ftree-loop-optimize
8264 @opindex ftree-loop-optimize
8265 Perform loop optimizations on trees.  This flag is enabled by default
8266 at @option{-O} and higher.
8268 @item -ftree-loop-linear
8269 @opindex ftree-loop-linear
8270 Perform loop interchange transformations on tree.  Same as
8271 @option{-floop-interchange}.  To use this code transformation, GCC has
8272 to be configured with @option{--with-isl} to enable the Graphite loop
8273 transformation infrastructure.
8275 @item -floop-interchange
8276 @opindex floop-interchange
8277 Perform loop interchange transformations on loops.  Interchanging two
8278 nested loops switches the inner and outer loops.  For example, given a
8279 loop like:
8280 @smallexample
8281 DO J = 1, M
8282   DO I = 1, N
8283     A(J, I) = A(J, I) * C
8284   ENDDO
8285 ENDDO
8286 @end smallexample
8287 loop interchange transforms the loop as if it were written:
8288 @smallexample
8289 DO I = 1, N
8290   DO J = 1, M
8291     A(J, I) = A(J, I) * C
8292   ENDDO
8293 ENDDO
8294 @end smallexample
8295 which can be beneficial when @code{N} is larger than the caches,
8296 because in Fortran, the elements of an array are stored in memory
8297 contiguously by column, and the original loop iterates over rows,
8298 potentially creating at each access a cache miss.  This optimization
8299 applies to all the languages supported by GCC and is not limited to
8300 Fortran.  To use this code transformation, GCC has to be configured
8301 with @option{--with-isl} to enable the Graphite loop transformation
8302 infrastructure.
8304 @item -floop-strip-mine
8305 @opindex floop-strip-mine
8306 Perform loop strip mining transformations on loops.  Strip mining
8307 splits a loop into two nested loops.  The outer loop has strides
8308 equal to the strip size and the inner loop has strides of the
8309 original loop within a strip.  The strip length can be changed
8310 using the @option{loop-block-tile-size} parameter.  For example,
8311 given a loop like:
8312 @smallexample
8313 DO I = 1, N
8314   A(I) = A(I) + C
8315 ENDDO
8316 @end smallexample
8317 loop strip mining transforms the loop as if it were written:
8318 @smallexample
8319 DO II = 1, N, 51
8320   DO I = II, min (II + 50, N)
8321     A(I) = A(I) + C
8322   ENDDO
8323 ENDDO
8324 @end smallexample
8325 This optimization applies to all the languages supported by GCC and is
8326 not limited to Fortran.  To use this code transformation, GCC has to
8327 be configured with @option{--with-isl} to enable the Graphite loop
8328 transformation infrastructure.
8330 @item -floop-block
8331 @opindex floop-block
8332 Perform loop blocking transformations on loops.  Blocking strip mines
8333 each loop in the loop nest such that the memory accesses of the
8334 element loops fit inside caches.  The strip length can be changed
8335 using the @option{loop-block-tile-size} parameter.  For example, given
8336 a loop like:
8337 @smallexample
8338 DO I = 1, N
8339   DO J = 1, M
8340     A(J, I) = B(I) + C(J)
8341   ENDDO
8342 ENDDO
8343 @end smallexample
8344 loop blocking transforms the loop as if it were written:
8345 @smallexample
8346 DO II = 1, N, 51
8347   DO JJ = 1, M, 51
8348     DO I = II, min (II + 50, N)
8349       DO J = JJ, min (JJ + 50, M)
8350         A(J, I) = B(I) + C(J)
8351       ENDDO
8352     ENDDO
8353   ENDDO
8354 ENDDO
8355 @end smallexample
8356 which can be beneficial when @code{M} is larger than the caches,
8357 because the innermost loop iterates over a smaller amount of data
8358 which can be kept in the caches.  This optimization applies to all the
8359 languages supported by GCC and is not limited to Fortran.  To use this
8360 code transformation, GCC has to be configured with @option{--with-isl}
8361 to enable the Graphite loop transformation infrastructure.
8363 @item -fgraphite-identity
8364 @opindex fgraphite-identity
8365 Enable the identity transformation for graphite.  For every SCoP we generate
8366 the polyhedral representation and transform it back to gimple.  Using
8367 @option{-fgraphite-identity} we can check the costs or benefits of the
8368 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8369 are also performed by the code generator ISL, like index splitting and
8370 dead code elimination in loops.
8372 @item -floop-nest-optimize
8373 @opindex floop-nest-optimize
8374 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8375 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8376 structure optimized for data-locality and parallelism.  This option
8377 is experimental.
8379 @item -floop-unroll-and-jam
8380 @opindex floop-unroll-and-jam
8381 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8382 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8383 The unrolled dimension (counting from the most inner one) can be changed 
8384 using the @option{loop-unroll-jam-depth} parameter.                 .
8386 @item -floop-parallelize-all
8387 @opindex floop-parallelize-all
8388 Use the Graphite data dependence analysis to identify loops that can
8389 be parallelized.  Parallelize all the loops that can be analyzed to
8390 not contain loop carried dependences without checking that it is
8391 profitable to parallelize the loops.
8393 @item -fcheck-data-deps
8394 @opindex fcheck-data-deps
8395 Compare the results of several data dependence analyzers.  This option
8396 is used for debugging the data dependence analyzers.
8398 @item -ftree-loop-if-convert
8399 Attempt to transform conditional jumps in the innermost loops to
8400 branch-less equivalents.  The intent is to remove control-flow from
8401 the innermost loops in order to improve the ability of the
8402 vectorization pass to handle these loops.  This is enabled by default
8403 if vectorization is enabled.
8405 @item -ftree-loop-if-convert-stores
8406 Attempt to also if-convert conditional jumps containing memory writes.
8407 This transformation can be unsafe for multi-threaded programs as it
8408 transforms conditional memory writes into unconditional memory writes.
8409 For example,
8410 @smallexample
8411 for (i = 0; i < N; i++)
8412   if (cond)
8413     A[i] = expr;
8414 @end smallexample
8415 is transformed to
8416 @smallexample
8417 for (i = 0; i < N; i++)
8418   A[i] = cond ? expr : A[i];
8419 @end smallexample
8420 potentially producing data races.
8422 @item -ftree-loop-distribution
8423 Perform loop distribution.  This flag can improve cache performance on
8424 big loop bodies and allow further loop optimizations, like
8425 parallelization or vectorization, to take place.  For example, the loop
8426 @smallexample
8427 DO I = 1, N
8428   A(I) = B(I) + C
8429   D(I) = E(I) * F
8430 ENDDO
8431 @end smallexample
8432 is transformed to
8433 @smallexample
8434 DO I = 1, N
8435    A(I) = B(I) + C
8436 ENDDO
8437 DO I = 1, N
8438    D(I) = E(I) * F
8439 ENDDO
8440 @end smallexample
8442 @item -ftree-loop-distribute-patterns
8443 Perform loop distribution of patterns that can be code generated with
8444 calls to a library.  This flag is enabled by default at @option{-O3}.
8446 This pass distributes the initialization loops and generates a call to
8447 memset zero.  For example, the loop
8448 @smallexample
8449 DO I = 1, N
8450   A(I) = 0
8451   B(I) = A(I) + I
8452 ENDDO
8453 @end smallexample
8454 is transformed to
8455 @smallexample
8456 DO I = 1, N
8457    A(I) = 0
8458 ENDDO
8459 DO I = 1, N
8460    B(I) = A(I) + I
8461 ENDDO
8462 @end smallexample
8463 and the initialization loop is transformed into a call to memset zero.
8465 @item -ftree-loop-im
8466 @opindex ftree-loop-im
8467 Perform loop invariant motion on trees.  This pass moves only invariants that
8468 are hard to handle at RTL level (function calls, operations that expand to
8469 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8470 operands of conditions that are invariant out of the loop, so that we can use
8471 just trivial invariantness analysis in loop unswitching.  The pass also includes
8472 store motion.
8474 @item -ftree-loop-ivcanon
8475 @opindex ftree-loop-ivcanon
8476 Create a canonical counter for number of iterations in loops for which
8477 determining number of iterations requires complicated analysis.  Later
8478 optimizations then may determine the number easily.  Useful especially
8479 in connection with unrolling.
8481 @item -fivopts
8482 @opindex fivopts
8483 Perform induction variable optimizations (strength reduction, induction
8484 variable merging and induction variable elimination) on trees.
8486 @item -ftree-parallelize-loops=n
8487 @opindex ftree-parallelize-loops
8488 Parallelize loops, i.e., split their iteration space to run in n threads.
8489 This is only possible for loops whose iterations are independent
8490 and can be arbitrarily reordered.  The optimization is only
8491 profitable on multiprocessor machines, for loops that are CPU-intensive,
8492 rather than constrained e.g.@: by memory bandwidth.  This option
8493 implies @option{-pthread}, and thus is only supported on targets
8494 that have support for @option{-pthread}.
8496 @item -ftree-pta
8497 @opindex ftree-pta
8498 Perform function-local points-to analysis on trees.  This flag is
8499 enabled by default at @option{-O} and higher.
8501 @item -ftree-sra
8502 @opindex ftree-sra
8503 Perform scalar replacement of aggregates.  This pass replaces structure
8504 references with scalars to prevent committing structures to memory too
8505 early.  This flag is enabled by default at @option{-O} and higher.
8507 @item -ftree-copyrename
8508 @opindex ftree-copyrename
8509 Perform copy renaming on trees.  This pass attempts to rename compiler
8510 temporaries to other variables at copy locations, usually resulting in
8511 variable names which more closely resemble the original variables.  This flag
8512 is enabled by default at @option{-O} and higher.
8514 @item -ftree-coalesce-inlined-vars
8515 @opindex ftree-coalesce-inlined-vars
8516 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8517 combine small user-defined variables too, but only if they were inlined
8518 from other functions.  It is a more limited form of
8519 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8520 inlined variables, but it will keep variables of the inlined-into
8521 function apart from each other, such that they are more likely to
8522 contain the expected values in a debugging session.  This was the
8523 default in GCC versions older than 4.7.
8525 @item -ftree-coalesce-vars
8526 @opindex ftree-coalesce-vars
8527 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8528 combine small user-defined variables too, instead of just compiler
8529 temporaries.  This may severely limit the ability to debug an optimized
8530 program compiled with @option{-fno-var-tracking-assignments}.  In the
8531 negated form, this flag prevents SSA coalescing of user variables,
8532 including inlined ones.  This option is enabled by default.
8534 @item -ftree-ter
8535 @opindex ftree-ter
8536 Perform temporary expression replacement during the SSA->normal phase.  Single
8537 use/single def temporaries are replaced at their use location with their
8538 defining expression.  This results in non-GIMPLE code, but gives the expanders
8539 much more complex trees to work on resulting in better RTL generation.  This is
8540 enabled by default at @option{-O} and higher.
8542 @item -ftree-slsr
8543 @opindex ftree-slsr
8544 Perform straight-line strength reduction on trees.  This recognizes related
8545 expressions involving multiplications and replaces them by less expensive
8546 calculations when possible.  This is enabled by default at @option{-O} and
8547 higher.
8549 @item -ftree-vectorize
8550 @opindex ftree-vectorize
8551 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8552 and @option{-ftree-slp-vectorize} if not explicitly specified.
8554 @item -ftree-loop-vectorize
8555 @opindex ftree-loop-vectorize
8556 Perform loop vectorization on trees. This flag is enabled by default at
8557 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8559 @item -ftree-slp-vectorize
8560 @opindex ftree-slp-vectorize
8561 Perform basic block vectorization on trees. This flag is enabled by default at
8562 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8564 @item -fvect-cost-model=@var{model}
8565 @opindex fvect-cost-model
8566 Alter the cost model used for vectorization.  The @var{model} argument
8567 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8568 With the @code{unlimited} model the vectorized code-path is assumed
8569 to be profitable while with the @code{dynamic} model a runtime check
8570 will guard the vectorized code-path to enable it only for iteration
8571 counts that will likely execute faster than when executing the original
8572 scalar loop.  The @code{cheap} model will disable vectorization of
8573 loops where doing so would be cost prohibitive for example due to
8574 required runtime checks for data dependence or alignment but otherwise
8575 is equal to the @code{dynamic} model.
8576 The default cost model depends on other optimization flags and is
8577 either @code{dynamic} or @code{cheap}.
8579 @item -fsimd-cost-model=@var{model}
8580 @opindex fsimd-cost-model
8581 Alter the cost model used for vectorization of loops marked with the OpenMP
8582 or Cilk Plus simd directive.  The @var{model} argument should be one of
8583 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8584 have the same meaning as described in @option{-fvect-cost-model} and by
8585 default a cost model defined with @option{-fvect-cost-model} is used.
8587 @item -ftree-vrp
8588 @opindex ftree-vrp
8589 Perform Value Range Propagation on trees.  This is similar to the
8590 constant propagation pass, but instead of values, ranges of values are
8591 propagated.  This allows the optimizers to remove unnecessary range
8592 checks like array bound checks and null pointer checks.  This is
8593 enabled by default at @option{-O2} and higher.  Null pointer check
8594 elimination is only done if @option{-fdelete-null-pointer-checks} is
8595 enabled.
8597 @item -ftracer
8598 @opindex ftracer
8599 Perform tail duplication to enlarge superblock size.  This transformation
8600 simplifies the control flow of the function allowing other optimizations to do
8601 a better job.
8603 @item -funroll-loops
8604 @opindex funroll-loops
8605 Unroll loops whose number of iterations can be determined at compile
8606 time or upon entry to the loop.  @option{-funroll-loops} implies
8607 @option{-frerun-cse-after-loop}.  This option makes code larger,
8608 and may or may not make it run faster.
8610 @item -funroll-all-loops
8611 @opindex funroll-all-loops
8612 Unroll all loops, even if their number of iterations is uncertain when
8613 the loop is entered.  This usually makes programs run more slowly.
8614 @option{-funroll-all-loops} implies the same options as
8615 @option{-funroll-loops},
8617 @item -fsplit-ivs-in-unroller
8618 @opindex fsplit-ivs-in-unroller
8619 Enables expression of values of induction variables in later iterations
8620 of the unrolled loop using the value in the first iteration.  This breaks
8621 long dependency chains, thus improving efficiency of the scheduling passes.
8623 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8624 same effect.  However, that is not reliable in cases where the loop body
8625 is more complicated than a single basic block.  It also does not work at all
8626 on some architectures due to restrictions in the CSE pass.
8628 This optimization is enabled by default.
8630 @item -fvariable-expansion-in-unroller
8631 @opindex fvariable-expansion-in-unroller
8632 With this option, the compiler creates multiple copies of some
8633 local variables when unrolling a loop, which can result in superior code.
8635 @item -fpartial-inlining
8636 @opindex fpartial-inlining
8637 Inline parts of functions.  This option has any effect only
8638 when inlining itself is turned on by the @option{-finline-functions}
8639 or @option{-finline-small-functions} options.
8641 Enabled at level @option{-O2}.
8643 @item -fpredictive-commoning
8644 @opindex fpredictive-commoning
8645 Perform predictive commoning optimization, i.e., reusing computations
8646 (especially memory loads and stores) performed in previous
8647 iterations of loops.
8649 This option is enabled at level @option{-O3}.
8651 @item -fprefetch-loop-arrays
8652 @opindex fprefetch-loop-arrays
8653 If supported by the target machine, generate instructions to prefetch
8654 memory to improve the performance of loops that access large arrays.
8656 This option may generate better or worse code; results are highly
8657 dependent on the structure of loops within the source code.
8659 Disabled at level @option{-Os}.
8661 @item -fno-peephole
8662 @itemx -fno-peephole2
8663 @opindex fno-peephole
8664 @opindex fno-peephole2
8665 Disable any machine-specific peephole optimizations.  The difference
8666 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8667 are implemented in the compiler; some targets use one, some use the
8668 other, a few use both.
8670 @option{-fpeephole} is enabled by default.
8671 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8673 @item -fno-guess-branch-probability
8674 @opindex fno-guess-branch-probability
8675 Do not guess branch probabilities using heuristics.
8677 GCC uses heuristics to guess branch probabilities if they are
8678 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8679 heuristics are based on the control flow graph.  If some branch probabilities
8680 are specified by @samp{__builtin_expect}, then the heuristics are
8681 used to guess branch probabilities for the rest of the control flow graph,
8682 taking the @samp{__builtin_expect} info into account.  The interactions
8683 between the heuristics and @samp{__builtin_expect} can be complex, and in
8684 some cases, it may be useful to disable the heuristics so that the effects
8685 of @samp{__builtin_expect} are easier to understand.
8687 The default is @option{-fguess-branch-probability} at levels
8688 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8690 @item -freorder-blocks
8691 @opindex freorder-blocks
8692 Reorder basic blocks in the compiled function in order to reduce number of
8693 taken branches and improve code locality.
8695 Enabled at levels @option{-O2}, @option{-O3}.
8697 @item -freorder-blocks-and-partition
8698 @opindex freorder-blocks-and-partition
8699 In addition to reordering basic blocks in the compiled function, in order
8700 to reduce number of taken branches, partitions hot and cold basic blocks
8701 into separate sections of the assembly and .o files, to improve
8702 paging and cache locality performance.
8704 This optimization is automatically turned off in the presence of
8705 exception handling, for linkonce sections, for functions with a user-defined
8706 section attribute and on any architecture that does not support named
8707 sections.
8709 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8711 @item -freorder-functions
8712 @opindex freorder-functions
8713 Reorder functions in the object file in order to
8714 improve code locality.  This is implemented by using special
8715 subsections @code{.text.hot} for most frequently executed functions and
8716 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8717 the linker so object file format must support named sections and linker must
8718 place them in a reasonable way.
8720 Also profile feedback must be available to make this option effective.  See
8721 @option{-fprofile-arcs} for details.
8723 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8725 @item -fstrict-aliasing
8726 @opindex fstrict-aliasing
8727 Allow the compiler to assume the strictest aliasing rules applicable to
8728 the language being compiled.  For C (and C++), this activates
8729 optimizations based on the type of expressions.  In particular, an
8730 object of one type is assumed never to reside at the same address as an
8731 object of a different type, unless the types are almost the same.  For
8732 example, an @code{unsigned int} can alias an @code{int}, but not a
8733 @code{void*} or a @code{double}.  A character type may alias any other
8734 type.
8736 @anchor{Type-punning}Pay special attention to code like this:
8737 @smallexample
8738 union a_union @{
8739   int i;
8740   double d;
8743 int f() @{
8744   union a_union t;
8745   t.d = 3.0;
8746   return t.i;
8748 @end smallexample
8749 The practice of reading from a different union member than the one most
8750 recently written to (called ``type-punning'') is common.  Even with
8751 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8752 is accessed through the union type.  So, the code above works as
8753 expected.  @xref{Structures unions enumerations and bit-fields
8754 implementation}.  However, this code might not:
8755 @smallexample
8756 int f() @{
8757   union a_union t;
8758   int* ip;
8759   t.d = 3.0;
8760   ip = &t.i;
8761   return *ip;
8763 @end smallexample
8765 Similarly, access by taking the address, casting the resulting pointer
8766 and dereferencing the result has undefined behavior, even if the cast
8767 uses a union type, e.g.:
8768 @smallexample
8769 int f() @{
8770   double d = 3.0;
8771   return ((union a_union *) &d)->i;
8773 @end smallexample
8775 The @option{-fstrict-aliasing} option is enabled at levels
8776 @option{-O2}, @option{-O3}, @option{-Os}.
8778 @item -fstrict-overflow
8779 @opindex fstrict-overflow
8780 Allow the compiler to assume strict signed overflow rules, depending
8781 on the language being compiled.  For C (and C++) this means that
8782 overflow when doing arithmetic with signed numbers is undefined, which
8783 means that the compiler may assume that it does not happen.  This
8784 permits various optimizations.  For example, the compiler assumes
8785 that an expression like @code{i + 10 > i} is always true for
8786 signed @code{i}.  This assumption is only valid if signed overflow is
8787 undefined, as the expression is false if @code{i + 10} overflows when
8788 using twos complement arithmetic.  When this option is in effect any
8789 attempt to determine whether an operation on signed numbers 
8790 overflows must be written carefully to not actually involve overflow.
8792 This option also allows the compiler to assume strict pointer
8793 semantics: given a pointer to an object, if adding an offset to that
8794 pointer does not produce a pointer to the same object, the addition is
8795 undefined.  This permits the compiler to conclude that @code{p + u >
8796 p} is always true for a pointer @code{p} and unsigned integer
8797 @code{u}.  This assumption is only valid because pointer wraparound is
8798 undefined, as the expression is false if @code{p + u} overflows using
8799 twos complement arithmetic.
8801 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8802 that integer signed overflow is fully defined: it wraps.  When
8803 @option{-fwrapv} is used, there is no difference between
8804 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8805 integers.  With @option{-fwrapv} certain types of overflow are
8806 permitted.  For example, if the compiler gets an overflow when doing
8807 arithmetic on constants, the overflowed value can still be used with
8808 @option{-fwrapv}, but not otherwise.
8810 The @option{-fstrict-overflow} option is enabled at levels
8811 @option{-O2}, @option{-O3}, @option{-Os}.
8813 @item -falign-functions
8814 @itemx -falign-functions=@var{n}
8815 @opindex falign-functions
8816 Align the start of functions to the next power-of-two greater than
8817 @var{n}, skipping up to @var{n} bytes.  For instance,
8818 @option{-falign-functions=32} aligns functions to the next 32-byte
8819 boundary, but @option{-falign-functions=24} aligns to the next
8820 32-byte boundary only if this can be done by skipping 23 bytes or less.
8822 @option{-fno-align-functions} and @option{-falign-functions=1} are
8823 equivalent and mean that functions are not aligned.
8825 Some assemblers only support this flag when @var{n} is a power of two;
8826 in that case, it is rounded up.
8828 If @var{n} is not specified or is zero, use a machine-dependent default.
8830 Enabled at levels @option{-O2}, @option{-O3}.
8832 @item -falign-labels
8833 @itemx -falign-labels=@var{n}
8834 @opindex falign-labels
8835 Align all branch targets to a power-of-two boundary, skipping up to
8836 @var{n} bytes like @option{-falign-functions}.  This option can easily
8837 make code slower, because it must insert dummy operations for when the
8838 branch target is reached in the usual flow of the code.
8840 @option{-fno-align-labels} and @option{-falign-labels=1} are
8841 equivalent and mean that labels are not aligned.
8843 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8844 are greater than this value, then their values are used instead.
8846 If @var{n} is not specified or is zero, use a machine-dependent default
8847 which is very likely to be @samp{1}, meaning no alignment.
8849 Enabled at levels @option{-O2}, @option{-O3}.
8851 @item -falign-loops
8852 @itemx -falign-loops=@var{n}
8853 @opindex falign-loops
8854 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8855 like @option{-falign-functions}.  If the loops are
8856 executed many times, this makes up for any execution of the dummy
8857 operations.
8859 @option{-fno-align-loops} and @option{-falign-loops=1} are
8860 equivalent and mean that loops are not aligned.
8862 If @var{n} is not specified or is zero, use a machine-dependent default.
8864 Enabled at levels @option{-O2}, @option{-O3}.
8866 @item -falign-jumps
8867 @itemx -falign-jumps=@var{n}
8868 @opindex falign-jumps
8869 Align branch targets to a power-of-two boundary, for branch targets
8870 where the targets can only be reached by jumping, skipping up to @var{n}
8871 bytes like @option{-falign-functions}.  In this case, no dummy operations
8872 need be executed.
8874 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8875 equivalent and mean that loops are not aligned.
8877 If @var{n} is not specified or is zero, use a machine-dependent default.
8879 Enabled at levels @option{-O2}, @option{-O3}.
8881 @item -funit-at-a-time
8882 @opindex funit-at-a-time
8883 This option is left for compatibility reasons. @option{-funit-at-a-time}
8884 has no effect, while @option{-fno-unit-at-a-time} implies
8885 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8887 Enabled by default.
8889 @item -fno-toplevel-reorder
8890 @opindex fno-toplevel-reorder
8891 Do not reorder top-level functions, variables, and @code{asm}
8892 statements.  Output them in the same order that they appear in the
8893 input file.  When this option is used, unreferenced static variables
8894 are not removed.  This option is intended to support existing code
8895 that relies on a particular ordering.  For new code, it is better to
8896 use attributes when possible.
8898 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8899 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8900 targets.
8902 @item -fweb
8903 @opindex fweb
8904 Constructs webs as commonly used for register allocation purposes and assign
8905 each web individual pseudo register.  This allows the register allocation pass
8906 to operate on pseudos directly, but also strengthens several other optimization
8907 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8908 however, make debugging impossible, since variables no longer stay in a
8909 ``home register''.
8911 Enabled by default with @option{-funroll-loops}.
8913 @item -fwhole-program
8914 @opindex fwhole-program
8915 Assume that the current compilation unit represents the whole program being
8916 compiled.  All public functions and variables with the exception of @code{main}
8917 and those merged by attribute @code{externally_visible} become static functions
8918 and in effect are optimized more aggressively by interprocedural optimizers.
8920 This option should not be used in combination with @code{-flto}.
8921 Instead relying on a linker plugin should provide safer and more precise
8922 information.
8924 @item -flto[=@var{n}]
8925 @opindex flto
8926 This option runs the standard link-time optimizer.  When invoked
8927 with source code, it generates GIMPLE (one of GCC's internal
8928 representations) and writes it to special ELF sections in the object
8929 file.  When the object files are linked together, all the function
8930 bodies are read from these ELF sections and instantiated as if they
8931 had been part of the same translation unit.
8933 To use the link-time optimizer, @option{-flto} and optimization
8934 options should be specified at compile time and during the final link.
8935 For example:
8937 @smallexample
8938 gcc -c -O2 -flto foo.c
8939 gcc -c -O2 -flto bar.c
8940 gcc -o myprog -flto -O2 foo.o bar.o
8941 @end smallexample
8943 The first two invocations to GCC save a bytecode representation
8944 of GIMPLE into special ELF sections inside @file{foo.o} and
8945 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8946 @file{foo.o} and @file{bar.o}, merges the two files into a single
8947 internal image, and compiles the result as usual.  Since both
8948 @file{foo.o} and @file{bar.o} are merged into a single image, this
8949 causes all the interprocedural analyses and optimizations in GCC to
8950 work across the two files as if they were a single one.  This means,
8951 for example, that the inliner is able to inline functions in
8952 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8954 Another (simpler) way to enable link-time optimization is:
8956 @smallexample
8957 gcc -o myprog -flto -O2 foo.c bar.c
8958 @end smallexample
8960 The above generates bytecode for @file{foo.c} and @file{bar.c},
8961 merges them together into a single GIMPLE representation and optimizes
8962 them as usual to produce @file{myprog}.
8964 The only important thing to keep in mind is that to enable link-time
8965 optimizations you need to use the GCC driver to perform the link-step.
8966 GCC then automatically performs link-time optimization if any of the
8967 objects involved were compiled with the @option{-flto}.  You generally
8968 should specify the optimization options to be used for link-time
8969 optimization though GCC will try to be clever at guessing an
8970 optimization level to use from the options used at compile-time
8971 if you fail to specify one at link-time.  You can always override
8972 the automatic decision to do link-time optimization at link-time
8973 by passing @option{-fno-lto} to the link command.
8975 To make whole program optimization effective, it is necessary to make
8976 certain whole program assumptions.  The compiler needs to know
8977 what functions and variables can be accessed by libraries and runtime
8978 outside of the link-time optimized unit.  When supported by the linker,
8979 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8980 to the compiler about used and externally visible symbols.  When
8981 the linker plugin is not available, @option{-fwhole-program} should be
8982 used to allow the compiler to make these assumptions, which leads
8983 to more aggressive optimization decisions.
8985 When @option{-fuse-linker-plugin} is not enabled then, when a file is
8986 compiled with @option{-flto}, the generated object file is larger than
8987 a regular object file because it contains GIMPLE bytecodes and the usual
8988 final code (see @option{-ffat-lto-objects}.  This means that
8989 object files with LTO information can be linked as normal object
8990 files; if @option{-fno-lto} is passed to the linker, no
8991 interprocedural optimizations are applied.  Note that when
8992 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
8993 but you cannot perform a regular, non-LTO link on them.
8995 Additionally, the optimization flags used to compile individual files
8996 are not necessarily related to those used at link time.  For instance,
8998 @smallexample
8999 gcc -c -O0 -ffat-lto-objects -flto foo.c
9000 gcc -c -O0 -ffat-lto-objects -flto bar.c
9001 gcc -o myprog -O3 foo.o bar.o
9002 @end smallexample
9004 This produces individual object files with unoptimized assembler
9005 code, but the resulting binary @file{myprog} is optimized at
9006 @option{-O3}.  If, instead, the final binary is generated with
9007 @option{-fno-lto}, then @file{myprog} is not optimized.
9009 When producing the final binary, GCC only
9010 applies link-time optimizations to those files that contain bytecode.
9011 Therefore, you can mix and match object files and libraries with
9012 GIMPLE bytecodes and final object code.  GCC automatically selects
9013 which files to optimize in LTO mode and which files to link without
9014 further processing.
9016 There are some code generation flags preserved by GCC when
9017 generating bytecodes, as they need to be used during the final link
9018 stage.  Generally options specified at link-time override those
9019 specified at compile-time.
9021 If you do not specify an optimization level option @option{-O} at
9022 link-time then GCC will compute one based on the optimization levels
9023 used when compiling the object files.  The highest optimization
9024 level will win here.
9026 Currently, the following options and their setting are take from
9027 the first object file that explicitely specified it: 
9028 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9029 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9030 and all the @option{-m} target flags.
9032 Certain ABI changing flags are required to match in all compilation-units
9033 and trying to override this at link-time with a conflicting value
9034 is ignored.  This includes options such as @option{-freg-struct-return}
9035 and @option{-fpcc-struct-return}. 
9037 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9038 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9039 are passed through to the link stage and merged conservatively for
9040 conflicting translation units.  Specifically
9041 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9042 precedence and for example @option{-ffp-contract=off} takes precedence
9043 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9045 It is recommended that you compile all the files participating in the
9046 same link with the same options and also specify those options at
9047 link time.
9049 If LTO encounters objects with C linkage declared with incompatible
9050 types in separate translation units to be linked together (undefined
9051 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9052 issued.  The behavior is still undefined at run time.  Similar
9053 diagnostics may be raised for other languages.
9055 Another feature of LTO is that it is possible to apply interprocedural
9056 optimizations on files written in different languages:
9058 @smallexample
9059 gcc -c -flto foo.c
9060 g++ -c -flto bar.cc
9061 gfortran -c -flto baz.f90
9062 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9063 @end smallexample
9065 Notice that the final link is done with @command{g++} to get the C++
9066 runtime libraries and @option{-lgfortran} is added to get the Fortran
9067 runtime libraries.  In general, when mixing languages in LTO mode, you
9068 should use the same link command options as when mixing languages in a
9069 regular (non-LTO) compilation.
9071 If object files containing GIMPLE bytecode are stored in a library archive, say
9072 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9073 are using a linker with plugin support.  To create static libraries suitable
9074 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9075 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
9076 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9077 and @command{nm} have been compiled with plugin support.  At link time, use the the
9078 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9079 the LTO optimization process:
9081 @smallexample
9082 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9083 @end smallexample
9085 With the linker plugin enabled, the linker extracts the needed
9086 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9087 to make them part of the aggregated GIMPLE image to be optimized.
9089 If you are not using a linker with plugin support and/or do not
9090 enable the linker plugin, then the objects inside @file{libfoo.a}
9091 are extracted and linked as usual, but they do not participate
9092 in the LTO optimization process.  In order to make a static library suitable
9093 for both LTO optimization and usual linkage, compile its object files with
9094 @option{-flto} @code{-ffat-lto-objects}.
9096 Link-time optimizations do not require the presence of the whole program to
9097 operate.  If the program does not require any symbols to be exported, it is
9098 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9099 the interprocedural optimizers to use more aggressive assumptions which may
9100 lead to improved optimization opportunities.
9101 Use of @option{-fwhole-program} is not needed when linker plugin is
9102 active (see @option{-fuse-linker-plugin}).
9104 The current implementation of LTO makes no
9105 attempt to generate bytecode that is portable between different
9106 types of hosts.  The bytecode files are versioned and there is a
9107 strict version check, so bytecode files generated in one version of
9108 GCC will not work with an older or newer version of GCC.
9110 Link-time optimization does not work well with generation of debugging
9111 information.  Combining @option{-flto} with
9112 @option{-g} is currently experimental and expected to produce unexpected
9113 results.
9115 If you specify the optional @var{n}, the optimization and code
9116 generation done at link time is executed in parallel using @var{n}
9117 parallel jobs by utilizing an installed @command{make} program.  The
9118 environment variable @env{MAKE} may be used to override the program
9119 used.  The default value for @var{n} is 1.
9121 You can also specify @option{-flto=jobserver} to use GNU make's
9122 job server mode to determine the number of parallel jobs. This
9123 is useful when the Makefile calling GCC is already executing in parallel.
9124 You must prepend a @samp{+} to the command recipe in the parent Makefile
9125 for this to work.  This option likely only works if @env{MAKE} is
9126 GNU make.
9128 @item -flto-partition=@var{alg}
9129 @opindex flto-partition
9130 Specify the partitioning algorithm used by the link-time optimizer.
9131 The value is either @code{1to1} to specify a partitioning mirroring
9132 the original source files or @code{balanced} to specify partitioning
9133 into equally sized chunks (whenever possible) or @code{max} to create
9134 new partition for every symbol where possible.  Specifying @code{none}
9135 as an algorithm disables partitioning and streaming completely. 
9136 The default value is @code{balanced}. While @code{1to1} can be used
9137 as an workaround for various code ordering issues, the @code{max}
9138 partitioning is intended for internal testing only.
9139 The value @code{one} specifies that exactly one partition should be
9140 used while the value @code{none} bypasses partitioning and executes
9141 the link-time optimization step directly from the WPA phase.
9143 @item -flto-odr-type-merging
9144 @opindex flto-odr-type-merging
9145 Enable streaming of mangled types names of C++ types and their unification
9146 at linktime.  This increases size of LTO object files, but enable
9147 diagnostics about One Definition Rule violations.
9149 @item -flto-compression-level=@var{n}
9150 This option specifies the level of compression used for intermediate
9151 language written to LTO object files, and is only meaningful in
9152 conjunction with LTO mode (@option{-flto}).  Valid
9153 values are 0 (no compression) to 9 (maximum compression).  Values
9154 outside this range are clamped to either 0 or 9.  If the option is not
9155 given, a default balanced compression setting is used.
9157 @item -flto-report
9158 Prints a report with internal details on the workings of the link-time
9159 optimizer.  The contents of this report vary from version to version.
9160 It is meant to be useful to GCC developers when processing object
9161 files in LTO mode (via @option{-flto}).
9163 Disabled by default.
9165 @item -flto-report-wpa
9166 Like @option{-flto-report}, but only print for the WPA phase of Link
9167 Time Optimization.
9169 @item -fuse-linker-plugin
9170 Enables the use of a linker plugin during link-time optimization.  This
9171 option relies on plugin support in the linker, which is available in gold
9172 or in GNU ld 2.21 or newer.
9174 This option enables the extraction of object files with GIMPLE bytecode out
9175 of library archives. This improves the quality of optimization by exposing
9176 more code to the link-time optimizer.  This information specifies what
9177 symbols can be accessed externally (by non-LTO object or during dynamic
9178 linking).  Resulting code quality improvements on binaries (and shared
9179 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
9180 See @option{-flto} for a description of the effect of this flag and how to
9181 use it.
9183 This option is enabled by default when LTO support in GCC is enabled
9184 and GCC was configured for use with
9185 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9187 @item -ffat-lto-objects
9188 @opindex ffat-lto-objects
9189 Fat LTO objects are object files that contain both the intermediate language
9190 and the object code. This makes them usable for both LTO linking and normal
9191 linking. This option is effective only when compiling with @option{-flto}
9192 and is ignored at link time.
9194 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9195 requires the complete toolchain to be aware of LTO. It requires a linker with
9196 linker plugin support for basic functionality.  Additionally,
9197 @command{nm}, @command{ar} and @command{ranlib}
9198 need to support linker plugins to allow a full-featured build environment
9199 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9200 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9201 to these tools. With non fat LTO makefiles need to be modified to use them.
9203 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9204 support.
9206 @item -fcompare-elim
9207 @opindex fcompare-elim
9208 After register allocation and post-register allocation instruction splitting,
9209 identify arithmetic instructions that compute processor flags similar to a
9210 comparison operation based on that arithmetic.  If possible, eliminate the
9211 explicit comparison operation.
9213 This pass only applies to certain targets that cannot explicitly represent
9214 the comparison operation before register allocation is complete.
9216 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9218 @item -fuse-ld=bfd
9219 @opindex fuse-ld=bfd
9220 Use the @command{bfd} linker instead of the default linker.
9222 @item -fuse-ld=gold
9223 @opindex fuse-ld=gold
9224 Use the @command{gold} linker instead of the default linker.
9226 @item -fcprop-registers
9227 @opindex fcprop-registers
9228 After register allocation and post-register allocation instruction splitting,
9229 perform a copy-propagation pass to try to reduce scheduling dependencies
9230 and occasionally eliminate the copy.
9232 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9234 @item -fprofile-correction
9235 @opindex fprofile-correction
9236 Profiles collected using an instrumented binary for multi-threaded programs may
9237 be inconsistent due to missed counter updates. When this option is specified,
9238 GCC uses heuristics to correct or smooth out such inconsistencies. By
9239 default, GCC emits an error message when an inconsistent profile is detected.
9241 @item -fprofile-dir=@var{path}
9242 @opindex fprofile-dir
9244 Set the directory to search for the profile data files in to @var{path}.
9245 This option affects only the profile data generated by
9246 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9247 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9248 and its related options.  Both absolute and relative paths can be used.
9249 By default, GCC uses the current directory as @var{path}, thus the
9250 profile data file appears in the same directory as the object file.
9252 @item -fprofile-generate
9253 @itemx -fprofile-generate=@var{path}
9254 @opindex fprofile-generate
9256 Enable options usually used for instrumenting application to produce
9257 profile useful for later recompilation with profile feedback based
9258 optimization.  You must use @option{-fprofile-generate} both when
9259 compiling and when linking your program.
9261 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
9263 If @var{path} is specified, GCC looks at the @var{path} to find
9264 the profile feedback data files. See @option{-fprofile-dir}.
9266 @item -fprofile-use
9267 @itemx -fprofile-use=@var{path}
9268 @opindex fprofile-use
9269 Enable profile feedback directed optimizations, and optimizations
9270 generally profitable only with profile feedback available.
9272 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9273 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9274 @code{ftree-loop-distribute-patterns}
9276 By default, GCC emits an error message if the feedback profiles do not
9277 match the source code.  This error can be turned into a warning by using
9278 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9279 code.
9281 If @var{path} is specified, GCC looks at the @var{path} to find
9282 the profile feedback data files. See @option{-fprofile-dir}.
9284 @item -fauto-profile
9285 @itemx -fauto-profile=@var{path}
9286 @opindex fauto-profile
9287 Enable sampling based feedback directed optimizations, and optimizations
9288 generally profitable only with profile feedback available.
9290 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9291 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9292 @code{-finline-functions}, @code{-fipa-cp}, @code{-fipa-cp-clone},
9293 @code{-fpredictive-commoning}, @code{-funswitch-loops},
9294 @code{-fgcse-after-reload}, @code{-ftree-loop-distribute-patterns},
9296 If @var{path} is specified, GCC looks at the @var{path} to find
9297 the profile feedback data files.
9299 In order to collect AutoFDO profile, you need to have:
9301 1. A linux system with linux perf support
9302 2. (optional) An Intel processor with last branch record (LBR) support. This is
9303    to guarantee accurate instruction level profile, which is important for
9304    AutoFDO performance.
9306 To collect the profile, first use linux perf to collect raw profile
9307 (see @uref{https://perf.wiki.kernel.org/}).
9309 E.g.
9310 @code{perf record -e br_inst_retired:near_taken -b -o perf.data -- your_program}
9312 Then use create_gcov tool, which takes raw profile and unstripped binary to
9313 generate AutoFDO profile that can be used by GCC.
9314 (see @uref{https://github.com/google/autofdo}).
9316 E.g.
9317 @code{create_gcov --binary=your_program.unstripped --profile=perf.data --gcov=profile.afdo}
9318 @end table
9320 The following options control compiler behavior regarding floating-point 
9321 arithmetic.  These options trade off between speed and
9322 correctness.  All must be specifically enabled.
9324 @table @gcctabopt
9325 @item -ffloat-store
9326 @opindex ffloat-store
9327 Do not store floating-point variables in registers, and inhibit other
9328 options that might change whether a floating-point value is taken from a
9329 register or memory.
9331 @cindex floating-point precision
9332 This option prevents undesirable excess precision on machines such as
9333 the 68000 where the floating registers (of the 68881) keep more
9334 precision than a @code{double} is supposed to have.  Similarly for the
9335 x86 architecture.  For most programs, the excess precision does only
9336 good, but a few programs rely on the precise definition of IEEE floating
9337 point.  Use @option{-ffloat-store} for such programs, after modifying
9338 them to store all pertinent intermediate computations into variables.
9340 @item -fexcess-precision=@var{style}
9341 @opindex fexcess-precision
9342 This option allows further control over excess precision on machines
9343 where floating-point registers have more precision than the IEEE
9344 @code{float} and @code{double} types and the processor does not
9345 support operations rounding to those types.  By default,
9346 @option{-fexcess-precision=fast} is in effect; this means that
9347 operations are carried out in the precision of the registers and that
9348 it is unpredictable when rounding to the types specified in the source
9349 code takes place.  When compiling C, if
9350 @option{-fexcess-precision=standard} is specified then excess
9351 precision follows the rules specified in ISO C99; in particular,
9352 both casts and assignments cause values to be rounded to their
9353 semantic types (whereas @option{-ffloat-store} only affects
9354 assignments).  This option is enabled by default for C if a strict
9355 conformance option such as @option{-std=c99} is used.
9357 @opindex mfpmath
9358 @option{-fexcess-precision=standard} is not implemented for languages
9359 other than C, and has no effect if
9360 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9361 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9362 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9363 semantics apply without excess precision, and in the latter, rounding
9364 is unpredictable.
9366 @item -ffast-math
9367 @opindex ffast-math
9368 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9369 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9370 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9372 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9374 This option is not turned on by any @option{-O} option besides
9375 @option{-Ofast} since it can result in incorrect output for programs
9376 that depend on an exact implementation of IEEE or ISO rules/specifications
9377 for math functions. It may, however, yield faster code for programs
9378 that do not require the guarantees of these specifications.
9380 @item -fno-math-errno
9381 @opindex fno-math-errno
9382 Do not set @code{errno} after calling math functions that are executed
9383 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9384 IEEE exceptions for math error handling may want to use this flag
9385 for speed while maintaining IEEE arithmetic compatibility.
9387 This option is not turned on by any @option{-O} option since
9388 it can result in incorrect output for programs that depend on
9389 an exact implementation of IEEE or ISO rules/specifications for
9390 math functions. It may, however, yield faster code for programs
9391 that do not require the guarantees of these specifications.
9393 The default is @option{-fmath-errno}.
9395 On Darwin systems, the math library never sets @code{errno}.  There is
9396 therefore no reason for the compiler to consider the possibility that
9397 it might, and @option{-fno-math-errno} is the default.
9399 @item -funsafe-math-optimizations
9400 @opindex funsafe-math-optimizations
9402 Allow optimizations for floating-point arithmetic that (a) assume
9403 that arguments and results are valid and (b) may violate IEEE or
9404 ANSI standards.  When used at link-time, it may include libraries
9405 or startup files that change the default FPU control word or other
9406 similar optimizations.
9408 This option is not turned on by any @option{-O} option since
9409 it can result in incorrect output for programs that depend on
9410 an exact implementation of IEEE or ISO rules/specifications for
9411 math functions. It may, however, yield faster code for programs
9412 that do not require the guarantees of these specifications.
9413 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9414 @option{-fassociative-math} and @option{-freciprocal-math}.
9416 The default is @option{-fno-unsafe-math-optimizations}.
9418 @item -fassociative-math
9419 @opindex fassociative-math
9421 Allow re-association of operands in series of floating-point operations.
9422 This violates the ISO C and C++ language standard by possibly changing
9423 computation result.  NOTE: re-ordering may change the sign of zero as
9424 well as ignore NaNs and inhibit or create underflow or overflow (and
9425 thus cannot be used on code that relies on rounding behavior like
9426 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9427 and thus may not be used when ordered comparisons are required.
9428 This option requires that both @option{-fno-signed-zeros} and
9429 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9430 much sense with @option{-frounding-math}. For Fortran the option
9431 is automatically enabled when both @option{-fno-signed-zeros} and
9432 @option{-fno-trapping-math} are in effect.
9434 The default is @option{-fno-associative-math}.
9436 @item -freciprocal-math
9437 @opindex freciprocal-math
9439 Allow the reciprocal of a value to be used instead of dividing by
9440 the value if this enables optimizations.  For example @code{x / y}
9441 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9442 is subject to common subexpression elimination.  Note that this loses
9443 precision and increases the number of flops operating on the value.
9445 The default is @option{-fno-reciprocal-math}.
9447 @item -ffinite-math-only
9448 @opindex ffinite-math-only
9449 Allow optimizations for floating-point arithmetic that assume
9450 that arguments and results are not NaNs or +-Infs.
9452 This option is not turned on by any @option{-O} option since
9453 it can result in incorrect output for programs that depend on
9454 an exact implementation of IEEE or ISO rules/specifications for
9455 math functions. It may, however, yield faster code for programs
9456 that do not require the guarantees of these specifications.
9458 The default is @option{-fno-finite-math-only}.
9460 @item -fno-signed-zeros
9461 @opindex fno-signed-zeros
9462 Allow optimizations for floating-point arithmetic that ignore the
9463 signedness of zero.  IEEE arithmetic specifies the behavior of
9464 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9465 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9466 This option implies that the sign of a zero result isn't significant.
9468 The default is @option{-fsigned-zeros}.
9470 @item -fno-trapping-math
9471 @opindex fno-trapping-math
9472 Compile code assuming that floating-point operations cannot generate
9473 user-visible traps.  These traps include division by zero, overflow,
9474 underflow, inexact result and invalid operation.  This option requires
9475 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9476 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9478 This option should never be turned on by any @option{-O} option since
9479 it can result in incorrect output for programs that depend on
9480 an exact implementation of IEEE or ISO rules/specifications for
9481 math functions.
9483 The default is @option{-ftrapping-math}.
9485 @item -frounding-math
9486 @opindex frounding-math
9487 Disable transformations and optimizations that assume default floating-point
9488 rounding behavior.  This is round-to-zero for all floating point
9489 to integer conversions, and round-to-nearest for all other arithmetic
9490 truncations.  This option should be specified for programs that change
9491 the FP rounding mode dynamically, or that may be executed with a
9492 non-default rounding mode.  This option disables constant folding of
9493 floating-point expressions at compile time (which may be affected by
9494 rounding mode) and arithmetic transformations that are unsafe in the
9495 presence of sign-dependent rounding modes.
9497 The default is @option{-fno-rounding-math}.
9499 This option is experimental and does not currently guarantee to
9500 disable all GCC optimizations that are affected by rounding mode.
9501 Future versions of GCC may provide finer control of this setting
9502 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9503 will be used to specify the default state for @code{FENV_ACCESS}.
9505 @item -fsignaling-nans
9506 @opindex fsignaling-nans
9507 Compile code assuming that IEEE signaling NaNs may generate user-visible
9508 traps during floating-point operations.  Setting this option disables
9509 optimizations that may change the number of exceptions visible with
9510 signaling NaNs.  This option implies @option{-ftrapping-math}.
9512 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9513 be defined.
9515 The default is @option{-fno-signaling-nans}.
9517 This option is experimental and does not currently guarantee to
9518 disable all GCC optimizations that affect signaling NaN behavior.
9520 @item -fsingle-precision-constant
9521 @opindex fsingle-precision-constant
9522 Treat floating-point constants as single precision instead of
9523 implicitly converting them to double-precision constants.
9525 @item -fcx-limited-range
9526 @opindex fcx-limited-range
9527 When enabled, this option states that a range reduction step is not
9528 needed when performing complex division.  Also, there is no checking
9529 whether the result of a complex multiplication or division is @code{NaN
9530 + I*NaN}, with an attempt to rescue the situation in that case.  The
9531 default is @option{-fno-cx-limited-range}, but is enabled by
9532 @option{-ffast-math}.
9534 This option controls the default setting of the ISO C99
9535 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9536 all languages.
9538 @item -fcx-fortran-rules
9539 @opindex fcx-fortran-rules
9540 Complex multiplication and division follow Fortran rules.  Range
9541 reduction is done as part of complex division, but there is no checking
9542 whether the result of a complex multiplication or division is @code{NaN
9543 + I*NaN}, with an attempt to rescue the situation in that case.
9545 The default is @option{-fno-cx-fortran-rules}.
9547 @end table
9549 The following options control optimizations that may improve
9550 performance, but are not enabled by any @option{-O} options.  This
9551 section includes experimental options that may produce broken code.
9553 @table @gcctabopt
9554 @item -fbranch-probabilities
9555 @opindex fbranch-probabilities
9556 After running a program compiled with @option{-fprofile-arcs}
9557 (@pxref{Debugging Options,, Options for Debugging Your Program or
9558 @command{gcc}}), you can compile it a second time using
9559 @option{-fbranch-probabilities}, to improve optimizations based on
9560 the number of times each branch was taken.  When a program
9561 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9562 counts to a file called @file{@var{sourcename}.gcda} for each source
9563 file.  The information in this data file is very dependent on the
9564 structure of the generated code, so you must use the same source code
9565 and the same optimization options for both compilations.
9567 With @option{-fbranch-probabilities}, GCC puts a
9568 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9569 These can be used to improve optimization.  Currently, they are only
9570 used in one place: in @file{reorg.c}, instead of guessing which path a
9571 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9572 exactly determine which path is taken more often.
9574 @item -fprofile-values
9575 @opindex fprofile-values
9576 If combined with @option{-fprofile-arcs}, it adds code so that some
9577 data about values of expressions in the program is gathered.
9579 With @option{-fbranch-probabilities}, it reads back the data gathered
9580 from profiling values of expressions for usage in optimizations.
9582 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9584 @item -fprofile-reorder-functions
9585 @opindex fprofile-reorder-functions
9586 Function reordering based on profile instrumentation collects
9587 first time of execution of a function and orders these functions
9588 in ascending order.
9590 Enabled with @option{-fprofile-use}.
9592 @item -fvpt
9593 @opindex fvpt
9594 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9595 to add code to gather information about values of expressions.
9597 With @option{-fbranch-probabilities}, it reads back the data gathered
9598 and actually performs the optimizations based on them.
9599 Currently the optimizations include specialization of division operations
9600 using the knowledge about the value of the denominator.
9602 @item -frename-registers
9603 @opindex frename-registers
9604 Attempt to avoid false dependencies in scheduled code by making use
9605 of registers left over after register allocation.  This optimization
9606 most benefits processors with lots of registers.  Depending on the
9607 debug information format adopted by the target, however, it can
9608 make debugging impossible, since variables no longer stay in
9609 a ``home register''.
9611 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9613 @item -fschedule-fusion
9614 @opindex fschedule-fusion
9615 Performs a target dependent pass over the instruction stream to schedule
9616 instructions of same type together because target machine can execute them
9617 more efficiently if they are adjacent to each other in the instruction flow.
9619 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9621 @item -ftracer
9622 @opindex ftracer
9623 Perform tail duplication to enlarge superblock size.  This transformation
9624 simplifies the control flow of the function allowing other optimizations to do
9625 a better job.
9627 Enabled with @option{-fprofile-use}.
9629 @item -funroll-loops
9630 @opindex funroll-loops
9631 Unroll loops whose number of iterations can be determined at compile time or
9632 upon entry to the loop.  @option{-funroll-loops} implies
9633 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9634 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9635 a small constant number of iterations).  This option makes code larger, and may
9636 or may not make it run faster.
9638 Enabled with @option{-fprofile-use}.
9640 @item -funroll-all-loops
9641 @opindex funroll-all-loops
9642 Unroll all loops, even if their number of iterations is uncertain when
9643 the loop is entered.  This usually makes programs run more slowly.
9644 @option{-funroll-all-loops} implies the same options as
9645 @option{-funroll-loops}.
9647 @item -fpeel-loops
9648 @opindex fpeel-loops
9649 Peels loops for which there is enough information that they do not
9650 roll much (from profile feedback).  It also turns on complete loop peeling
9651 (i.e.@: complete removal of loops with small constant number of iterations).
9653 Enabled with @option{-fprofile-use}.
9655 @item -fmove-loop-invariants
9656 @opindex fmove-loop-invariants
9657 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9658 at level @option{-O1}
9660 @item -funswitch-loops
9661 @opindex funswitch-loops
9662 Move branches with loop invariant conditions out of the loop, with duplicates
9663 of the loop on both branches (modified according to result of the condition).
9665 @item -ffunction-sections
9666 @itemx -fdata-sections
9667 @opindex ffunction-sections
9668 @opindex fdata-sections
9669 Place each function or data item into its own section in the output
9670 file if the target supports arbitrary sections.  The name of the
9671 function or the name of the data item determines the section's name
9672 in the output file.
9674 Use these options on systems where the linker can perform optimizations
9675 to improve locality of reference in the instruction space.  Most systems
9676 using the ELF object format and SPARC processors running Solaris 2 have
9677 linkers with such optimizations.  AIX may have these optimizations in
9678 the future.
9680 Only use these options when there are significant benefits from doing
9681 so.  When you specify these options, the assembler and linker
9682 create larger object and executable files and are also slower.
9683 You cannot use @code{gprof} on all systems if you
9684 specify this option, and you may have problems with debugging if
9685 you specify both this option and @option{-g}.
9687 @item -fbranch-target-load-optimize
9688 @opindex fbranch-target-load-optimize
9689 Perform branch target register load optimization before prologue / epilogue
9690 threading.
9691 The use of target registers can typically be exposed only during reload,
9692 thus hoisting loads out of loops and doing inter-block scheduling needs
9693 a separate optimization pass.
9695 @item -fbranch-target-load-optimize2
9696 @opindex fbranch-target-load-optimize2
9697 Perform branch target register load optimization after prologue / epilogue
9698 threading.
9700 @item -fbtr-bb-exclusive
9701 @opindex fbtr-bb-exclusive
9702 When performing branch target register load optimization, don't reuse
9703 branch target registers within any basic block.
9705 @item -fstack-protector
9706 @opindex fstack-protector
9707 Emit extra code to check for buffer overflows, such as stack smashing
9708 attacks.  This is done by adding a guard variable to functions with
9709 vulnerable objects.  This includes functions that call @code{alloca}, and
9710 functions with buffers larger than 8 bytes.  The guards are initialized
9711 when a function is entered and then checked when the function exits.
9712 If a guard check fails, an error message is printed and the program exits.
9714 @item -fstack-protector-all
9715 @opindex fstack-protector-all
9716 Like @option{-fstack-protector} except that all functions are protected.
9718 @item -fstack-protector-strong
9719 @opindex fstack-protector-strong
9720 Like @option{-fstack-protector} but includes additional functions to
9721 be protected --- those that have local array definitions, or have
9722 references to local frame addresses.
9724 @item -fsection-anchors
9725 @opindex fsection-anchors
9726 Try to reduce the number of symbolic address calculations by using
9727 shared ``anchor'' symbols to address nearby objects.  This transformation
9728 can help to reduce the number of GOT entries and GOT accesses on some
9729 targets.
9731 For example, the implementation of the following function @code{foo}:
9733 @smallexample
9734 static int a, b, c;
9735 int foo (void) @{ return a + b + c; @}
9736 @end smallexample
9738 @noindent
9739 usually calculates the addresses of all three variables, but if you
9740 compile it with @option{-fsection-anchors}, it accesses the variables
9741 from a common anchor point instead.  The effect is similar to the
9742 following pseudocode (which isn't valid C):
9744 @smallexample
9745 int foo (void)
9747   register int *xr = &x;
9748   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9750 @end smallexample
9752 Not all targets support this option.
9754 @item --param @var{name}=@var{value}
9755 @opindex param
9756 In some places, GCC uses various constants to control the amount of
9757 optimization that is done.  For example, GCC does not inline functions
9758 that contain more than a certain number of instructions.  You can
9759 control some of these constants on the command line using the
9760 @option{--param} option.
9762 The names of specific parameters, and the meaning of the values, are
9763 tied to the internals of the compiler, and are subject to change
9764 without notice in future releases.
9766 In each case, the @var{value} is an integer.  The allowable choices for
9767 @var{name} are:
9769 @table @gcctabopt
9770 @item predictable-branch-outcome
9771 When branch is predicted to be taken with probability lower than this threshold
9772 (in percent), then it is considered well predictable. The default is 10.
9774 @item max-crossjump-edges
9775 The maximum number of incoming edges to consider for cross-jumping.
9776 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9777 the number of edges incoming to each block.  Increasing values mean
9778 more aggressive optimization, making the compilation time increase with
9779 probably small improvement in executable size.
9781 @item min-crossjump-insns
9782 The minimum number of instructions that must be matched at the end
9783 of two blocks before cross-jumping is performed on them.  This
9784 value is ignored in the case where all instructions in the block being
9785 cross-jumped from are matched.  The default value is 5.
9787 @item max-grow-copy-bb-insns
9788 The maximum code size expansion factor when copying basic blocks
9789 instead of jumping.  The expansion is relative to a jump instruction.
9790 The default value is 8.
9792 @item max-goto-duplication-insns
9793 The maximum number of instructions to duplicate to a block that jumps
9794 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9795 passes, GCC factors computed gotos early in the compilation process,
9796 and unfactors them as late as possible.  Only computed jumps at the
9797 end of a basic blocks with no more than max-goto-duplication-insns are
9798 unfactored.  The default value is 8.
9800 @item max-delay-slot-insn-search
9801 The maximum number of instructions to consider when looking for an
9802 instruction to fill a delay slot.  If more than this arbitrary number of
9803 instructions are searched, the time savings from filling the delay slot
9804 are minimal, so stop searching.  Increasing values mean more
9805 aggressive optimization, making the compilation time increase with probably
9806 small improvement in execution time.
9808 @item max-delay-slot-live-search
9809 When trying to fill delay slots, the maximum number of instructions to
9810 consider when searching for a block with valid live register
9811 information.  Increasing this arbitrarily chosen value means more
9812 aggressive optimization, increasing the compilation time.  This parameter
9813 should be removed when the delay slot code is rewritten to maintain the
9814 control-flow graph.
9816 @item max-gcse-memory
9817 The approximate maximum amount of memory that can be allocated in
9818 order to perform the global common subexpression elimination
9819 optimization.  If more memory than specified is required, the
9820 optimization is not done.
9822 @item max-gcse-insertion-ratio
9823 If the ratio of expression insertions to deletions is larger than this value
9824 for any expression, then RTL PRE inserts or removes the expression and thus
9825 leaves partially redundant computations in the instruction stream.  The default value is 20.
9827 @item max-pending-list-length
9828 The maximum number of pending dependencies scheduling allows
9829 before flushing the current state and starting over.  Large functions
9830 with few branches or calls can create excessively large lists which
9831 needlessly consume memory and resources.
9833 @item max-modulo-backtrack-attempts
9834 The maximum number of backtrack attempts the scheduler should make
9835 when modulo scheduling a loop.  Larger values can exponentially increase
9836 compilation time.
9838 @item max-inline-insns-single
9839 Several parameters control the tree inliner used in GCC@.
9840 This number sets the maximum number of instructions (counted in GCC's
9841 internal representation) in a single function that the tree inliner
9842 considers for inlining.  This only affects functions declared
9843 inline and methods implemented in a class declaration (C++).
9844 The default value is 400.
9846 @item max-inline-insns-auto
9847 When you use @option{-finline-functions} (included in @option{-O3}),
9848 a lot of functions that would otherwise not be considered for inlining
9849 by the compiler are investigated.  To those functions, a different
9850 (more restrictive) limit compared to functions declared inline can
9851 be applied.
9852 The default value is 40.
9854 @item inline-min-speedup
9855 When estimated performance improvement of caller + callee runtime exceeds this
9856 threshold (in precent), the function can be inlined regardless the limit on
9857 @option{--param max-inline-insns-single} and @option{--param
9858 max-inline-insns-auto}.
9860 @item large-function-insns
9861 The limit specifying really large functions.  For functions larger than this
9862 limit after inlining, inlining is constrained by
9863 @option{--param large-function-growth}.  This parameter is useful primarily
9864 to avoid extreme compilation time caused by non-linear algorithms used by the
9865 back end.
9866 The default value is 2700.
9868 @item large-function-growth
9869 Specifies maximal growth of large function caused by inlining in percents.
9870 The default value is 100 which limits large function growth to 2.0 times
9871 the original size.
9873 @item large-unit-insns
9874 The limit specifying large translation unit.  Growth caused by inlining of
9875 units larger than this limit is limited by @option{--param inline-unit-growth}.
9876 For small units this might be too tight.
9877 For example, consider a unit consisting of function A
9878 that is inline and B that just calls A three times.  If B is small relative to
9879 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9880 large units consisting of small inlineable functions, however, the overall unit
9881 growth limit is needed to avoid exponential explosion of code size.  Thus for
9882 smaller units, the size is increased to @option{--param large-unit-insns}
9883 before applying @option{--param inline-unit-growth}.  The default is 10000.
9885 @item inline-unit-growth
9886 Specifies maximal overall growth of the compilation unit caused by inlining.
9887 The default value is 30 which limits unit growth to 1.3 times the original
9888 size. Cold functions (either marked cold via an attribute or by profile
9889 feedback) are not accounted into the unit size.
9891 @item ipcp-unit-growth
9892 Specifies maximal overall growth of the compilation unit caused by
9893 interprocedural constant propagation.  The default value is 10 which limits
9894 unit growth to 1.1 times the original size.
9896 @item large-stack-frame
9897 The limit specifying large stack frames.  While inlining the algorithm is trying
9898 to not grow past this limit too much.  The default value is 256 bytes.
9900 @item large-stack-frame-growth
9901 Specifies maximal growth of large stack frames caused by inlining in percents.
9902 The default value is 1000 which limits large stack frame growth to 11 times
9903 the original size.
9905 @item max-inline-insns-recursive
9906 @itemx max-inline-insns-recursive-auto
9907 Specifies the maximum number of instructions an out-of-line copy of a
9908 self-recursive inline
9909 function can grow into by performing recursive inlining.
9911 For functions declared inline, @option{--param max-inline-insns-recursive} is
9912 taken into account.  For functions not declared inline, recursive inlining
9913 happens only when @option{-finline-functions} (included in @option{-O3}) is
9914 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9915 default value is 450.
9917 @item max-inline-recursive-depth
9918 @itemx max-inline-recursive-depth-auto
9919 Specifies the maximum recursion depth used for recursive inlining.
9921 For functions declared inline, @option{--param max-inline-recursive-depth} is
9922 taken into account.  For functions not declared inline, recursive inlining
9923 happens only when @option{-finline-functions} (included in @option{-O3}) is
9924 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9925 default value is 8.
9927 @item min-inline-recursive-probability
9928 Recursive inlining is profitable only for function having deep recursion
9929 in average and can hurt for function having little recursion depth by
9930 increasing the prologue size or complexity of function body to other
9931 optimizers.
9933 When profile feedback is available (see @option{-fprofile-generate}) the actual
9934 recursion depth can be guessed from probability that function recurses via a
9935 given call expression.  This parameter limits inlining only to call expressions
9936 whose probability exceeds the given threshold (in percents).
9937 The default value is 10.
9939 @item early-inlining-insns
9940 Specify growth that the early inliner can make.  In effect it increases
9941 the amount of inlining for code having a large abstraction penalty.
9942 The default value is 10.
9944 @item max-early-inliner-iterations
9945 @itemx max-early-inliner-iterations
9946 Limit of iterations of the early inliner.  This basically bounds
9947 the number of nested indirect calls the early inliner can resolve.
9948 Deeper chains are still handled by late inlining.
9950 @item comdat-sharing-probability
9951 @itemx comdat-sharing-probability
9952 Probability (in percent) that C++ inline function with comdat visibility
9953 are shared across multiple compilation units.  The default value is 20.
9955 @item profile-func-internal-id
9956 @itemx profile-func-internal-id
9957 A parameter to control whether to use function internal id in profile
9958 database lookup. If the value is 0, the compiler will use id that
9959 is based on function assembler name and filename, which makes old profile
9960 data more tolerant to source changes such as function reordering etc.
9961 The default value is 0.
9963 @item min-vect-loop-bound
9964 The minimum number of iterations under which loops are not vectorized
9965 when @option{-ftree-vectorize} is used.  The number of iterations after
9966 vectorization needs to be greater than the value specified by this option
9967 to allow vectorization.  The default value is 0.
9969 @item gcse-cost-distance-ratio
9970 Scaling factor in calculation of maximum distance an expression
9971 can be moved by GCSE optimizations.  This is currently supported only in the
9972 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9973 is with simple expressions, i.e., the expressions that have cost
9974 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9975 hoisting of simple expressions.  The default value is 10.
9977 @item gcse-unrestricted-cost
9978 Cost, roughly measured as the cost of a single typical machine
9979 instruction, at which GCSE optimizations do not constrain
9980 the distance an expression can travel.  This is currently
9981 supported only in the code hoisting pass.  The lesser the cost,
9982 the more aggressive code hoisting is.  Specifying 0 
9983 allows all expressions to travel unrestricted distances.
9984 The default value is 3.
9986 @item max-hoist-depth
9987 The depth of search in the dominator tree for expressions to hoist.
9988 This is used to avoid quadratic behavior in hoisting algorithm.
9989 The value of 0 does not limit on the search, but may slow down compilation
9990 of huge functions.  The default value is 30.
9992 @item max-tail-merge-comparisons
9993 The maximum amount of similar bbs to compare a bb with.  This is used to
9994 avoid quadratic behavior in tree tail merging.  The default value is 10.
9996 @item max-tail-merge-iterations
9997 The maximum amount of iterations of the pass over the function.  This is used to
9998 limit compilation time in tree tail merging.  The default value is 2.
10000 @item max-unrolled-insns
10001 The maximum number of instructions that a loop may have to be unrolled.
10002 If a loop is unrolled, this parameter also determines how many times
10003 the loop code is unrolled.
10005 @item max-average-unrolled-insns
10006 The maximum number of instructions biased by probabilities of their execution
10007 that a loop may have to be unrolled.  If a loop is unrolled,
10008 this parameter also determines how many times the loop code is unrolled.
10010 @item max-unroll-times
10011 The maximum number of unrollings of a single loop.
10013 @item max-peeled-insns
10014 The maximum number of instructions that a loop may have to be peeled.
10015 If a loop is peeled, this parameter also determines how many times
10016 the loop code is peeled.
10018 @item max-peel-times
10019 The maximum number of peelings of a single loop.
10021 @item max-peel-branches
10022 The maximum number of branches on the hot path through the peeled sequence.
10024 @item max-completely-peeled-insns
10025 The maximum number of insns of a completely peeled loop.
10027 @item max-completely-peel-times
10028 The maximum number of iterations of a loop to be suitable for complete peeling.
10030 @item max-completely-peel-loop-nest-depth
10031 The maximum depth of a loop nest suitable for complete peeling.
10033 @item max-unswitch-insns
10034 The maximum number of insns of an unswitched loop.
10036 @item max-unswitch-level
10037 The maximum number of branches unswitched in a single loop.
10039 @item lim-expensive
10040 The minimum cost of an expensive expression in the loop invariant motion.
10042 @item iv-consider-all-candidates-bound
10043 Bound on number of candidates for induction variables, below which
10044 all candidates are considered for each use in induction variable
10045 optimizations.  If there are more candidates than this,
10046 only the most relevant ones are considered to avoid quadratic time complexity.
10048 @item iv-max-considered-uses
10049 The induction variable optimizations give up on loops that contain more
10050 induction variable uses.
10052 @item iv-always-prune-cand-set-bound
10053 If the number of candidates in the set is smaller than this value,
10054 always try to remove unnecessary ivs from the set
10055 when adding a new one.
10057 @item scev-max-expr-size
10058 Bound on size of expressions used in the scalar evolutions analyzer.
10059 Large expressions slow the analyzer.
10061 @item scev-max-expr-complexity
10062 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10063 Complex expressions slow the analyzer.
10065 @item omega-max-vars
10066 The maximum number of variables in an Omega constraint system.
10067 The default value is 128.
10069 @item omega-max-geqs
10070 The maximum number of inequalities in an Omega constraint system.
10071 The default value is 256.
10073 @item omega-max-eqs
10074 The maximum number of equalities in an Omega constraint system.
10075 The default value is 128.
10077 @item omega-max-wild-cards
10078 The maximum number of wildcard variables that the Omega solver is
10079 able to insert.  The default value is 18.
10081 @item omega-hash-table-size
10082 The size of the hash table in the Omega solver.  The default value is
10083 550.
10085 @item omega-max-keys
10086 The maximal number of keys used by the Omega solver.  The default
10087 value is 500.
10089 @item omega-eliminate-redundant-constraints
10090 When set to 1, use expensive methods to eliminate all redundant
10091 constraints.  The default value is 0.
10093 @item vect-max-version-for-alignment-checks
10094 The maximum number of run-time checks that can be performed when
10095 doing loop versioning for alignment in the vectorizer.
10097 @item vect-max-version-for-alias-checks
10098 The maximum number of run-time checks that can be performed when
10099 doing loop versioning for alias in the vectorizer.
10101 @item vect-max-peeling-for-alignment
10102 The maximum number of loop peels to enhance access alignment
10103 for vectorizer. Value -1 means 'no limit'.
10105 @item max-iterations-to-track
10106 The maximum number of iterations of a loop the brute-force algorithm
10107 for analysis of the number of iterations of the loop tries to evaluate.
10109 @item hot-bb-count-ws-permille
10110 A basic block profile count is considered hot if it contributes to 
10111 the given permillage (i.e. 0...1000) of the entire profiled execution.
10113 @item hot-bb-frequency-fraction
10114 Select fraction of the entry block frequency of executions of basic block in
10115 function given basic block needs to have to be considered hot.
10117 @item max-predicted-iterations
10118 The maximum number of loop iterations we predict statically.  This is useful
10119 in cases where a function contains a single loop with known bound and
10120 another loop with unknown bound.
10121 The known number of iterations is predicted correctly, while
10122 the unknown number of iterations average to roughly 10.  This means that the
10123 loop without bounds appears artificially cold relative to the other one.
10125 @item builtin-expect-probability
10126 Control the probability of the expression having the specified value. This
10127 parameter takes a percentage (i.e. 0 ... 100) as input.
10128 The default probability of 90 is obtained empirically.
10130 @item align-threshold
10132 Select fraction of the maximal frequency of executions of a basic block in
10133 a function to align the basic block.
10135 @item align-loop-iterations
10137 A loop expected to iterate at least the selected number of iterations is
10138 aligned.
10140 @item tracer-dynamic-coverage
10141 @itemx tracer-dynamic-coverage-feedback
10143 This value is used to limit superblock formation once the given percentage of
10144 executed instructions is covered.  This limits unnecessary code size
10145 expansion.
10147 The @option{tracer-dynamic-coverage-feedback} is used only when profile
10148 feedback is available.  The real profiles (as opposed to statically estimated
10149 ones) are much less balanced allowing the threshold to be larger value.
10151 @item tracer-max-code-growth
10152 Stop tail duplication once code growth has reached given percentage.  This is
10153 a rather artificial limit, as most of the duplicates are eliminated later in
10154 cross jumping, so it may be set to much higher values than is the desired code
10155 growth.
10157 @item tracer-min-branch-ratio
10159 Stop reverse growth when the reverse probability of best edge is less than this
10160 threshold (in percent).
10162 @item tracer-min-branch-ratio
10163 @itemx tracer-min-branch-ratio-feedback
10165 Stop forward growth if the best edge has probability lower than this
10166 threshold.
10168 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10169 compilation for profile feedback and one for compilation without.  The value
10170 for compilation with profile feedback needs to be more conservative (higher) in
10171 order to make tracer effective.
10173 @item max-cse-path-length
10175 The maximum number of basic blocks on path that CSE considers.
10176 The default is 10.
10178 @item max-cse-insns
10179 The maximum number of instructions CSE processes before flushing.
10180 The default is 1000.
10182 @item ggc-min-expand
10184 GCC uses a garbage collector to manage its own memory allocation.  This
10185 parameter specifies the minimum percentage by which the garbage
10186 collector's heap should be allowed to expand between collections.
10187 Tuning this may improve compilation speed; it has no effect on code
10188 generation.
10190 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10191 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10192 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10193 GCC is not able to calculate RAM on a particular platform, the lower
10194 bound of 30% is used.  Setting this parameter and
10195 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10196 every opportunity.  This is extremely slow, but can be useful for
10197 debugging.
10199 @item ggc-min-heapsize
10201 Minimum size of the garbage collector's heap before it begins bothering
10202 to collect garbage.  The first collection occurs after the heap expands
10203 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10204 tuning this may improve compilation speed, and has no effect on code
10205 generation.
10207 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10208 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10209 with a lower bound of 4096 (four megabytes) and an upper bound of
10210 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10211 particular platform, the lower bound is used.  Setting this parameter
10212 very large effectively disables garbage collection.  Setting this
10213 parameter and @option{ggc-min-expand} to zero causes a full collection
10214 to occur at every opportunity.
10216 @item max-reload-search-insns
10217 The maximum number of instruction reload should look backward for equivalent
10218 register.  Increasing values mean more aggressive optimization, making the
10219 compilation time increase with probably slightly better performance.
10220 The default value is 100.
10222 @item max-cselib-memory-locations
10223 The maximum number of memory locations cselib should take into account.
10224 Increasing values mean more aggressive optimization, making the compilation time
10225 increase with probably slightly better performance.  The default value is 500.
10227 @item reorder-blocks-duplicate
10228 @itemx reorder-blocks-duplicate-feedback
10230 Used by the basic block reordering pass to decide whether to use unconditional
10231 branch or duplicate the code on its destination.  Code is duplicated when its
10232 estimated size is smaller than this value multiplied by the estimated size of
10233 unconditional jump in the hot spots of the program.
10235 The @option{reorder-block-duplicate-feedback} is used only when profile
10236 feedback is available.  It may be set to higher values than
10237 @option{reorder-block-duplicate} since information about the hot spots is more
10238 accurate.
10240 @item max-sched-ready-insns
10241 The maximum number of instructions ready to be issued the scheduler should
10242 consider at any given time during the first scheduling pass.  Increasing
10243 values mean more thorough searches, making the compilation time increase
10244 with probably little benefit.  The default value is 100.
10246 @item max-sched-region-blocks
10247 The maximum number of blocks in a region to be considered for
10248 interblock scheduling.  The default value is 10.
10250 @item max-pipeline-region-blocks
10251 The maximum number of blocks in a region to be considered for
10252 pipelining in the selective scheduler.  The default value is 15.
10254 @item max-sched-region-insns
10255 The maximum number of insns in a region to be considered for
10256 interblock scheduling.  The default value is 100.
10258 @item max-pipeline-region-insns
10259 The maximum number of insns in a region to be considered for
10260 pipelining in the selective scheduler.  The default value is 200.
10262 @item min-spec-prob
10263 The minimum probability (in percents) of reaching a source block
10264 for interblock speculative scheduling.  The default value is 40.
10266 @item max-sched-extend-regions-iters
10267 The maximum number of iterations through CFG to extend regions.
10268 A value of 0 (the default) disables region extensions.
10270 @item max-sched-insn-conflict-delay
10271 The maximum conflict delay for an insn to be considered for speculative motion.
10272 The default value is 3.
10274 @item sched-spec-prob-cutoff
10275 The minimal probability of speculation success (in percents), so that
10276 speculative insns are scheduled.
10277 The default value is 40.
10279 @item sched-spec-state-edge-prob-cutoff
10280 The minimum probability an edge must have for the scheduler to save its
10281 state across it.
10282 The default value is 10.
10284 @item sched-mem-true-dep-cost
10285 Minimal distance (in CPU cycles) between store and load targeting same
10286 memory locations.  The default value is 1.
10288 @item selsched-max-lookahead
10289 The maximum size of the lookahead window of selective scheduling.  It is a
10290 depth of search for available instructions.
10291 The default value is 50.
10293 @item selsched-max-sched-times
10294 The maximum number of times that an instruction is scheduled during
10295 selective scheduling.  This is the limit on the number of iterations
10296 through which the instruction may be pipelined.  The default value is 2.
10298 @item selsched-max-insns-to-rename
10299 The maximum number of best instructions in the ready list that are considered
10300 for renaming in the selective scheduler.  The default value is 2.
10302 @item sms-min-sc
10303 The minimum value of stage count that swing modulo scheduler
10304 generates.  The default value is 2.
10306 @item max-last-value-rtl
10307 The maximum size measured as number of RTLs that can be recorded in an expression
10308 in combiner for a pseudo register as last known value of that register.  The default
10309 is 10000.
10311 @item max-combine-insns
10312 The maximum number of instructions the RTL combiner tries to combine.
10313 The default value is 2 at @option{-Og} and 4 otherwise.
10315 @item integer-share-limit
10316 Small integer constants can use a shared data structure, reducing the
10317 compiler's memory usage and increasing its speed.  This sets the maximum
10318 value of a shared integer constant.  The default value is 256.
10320 @item ssp-buffer-size
10321 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10322 protection when @option{-fstack-protection} is used.
10324 @item min-size-for-stack-sharing
10325 The minimum size of variables taking part in stack slot sharing when not
10326 optimizing. The default value is 32.
10328 @item max-jump-thread-duplication-stmts
10329 Maximum number of statements allowed in a block that needs to be
10330 duplicated when threading jumps.
10332 @item max-fields-for-field-sensitive
10333 Maximum number of fields in a structure treated in
10334 a field sensitive manner during pointer analysis.  The default is zero
10335 for @option{-O0} and @option{-O1},
10336 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10338 @item prefetch-latency
10339 Estimate on average number of instructions that are executed before
10340 prefetch finishes.  The distance prefetched ahead is proportional
10341 to this constant.  Increasing this number may also lead to less
10342 streams being prefetched (see @option{simultaneous-prefetches}).
10344 @item simultaneous-prefetches
10345 Maximum number of prefetches that can run at the same time.
10347 @item l1-cache-line-size
10348 The size of cache line in L1 cache, in bytes.
10350 @item l1-cache-size
10351 The size of L1 cache, in kilobytes.
10353 @item l2-cache-size
10354 The size of L2 cache, in kilobytes.
10356 @item min-insn-to-prefetch-ratio
10357 The minimum ratio between the number of instructions and the
10358 number of prefetches to enable prefetching in a loop.
10360 @item prefetch-min-insn-to-mem-ratio
10361 The minimum ratio between the number of instructions and the
10362 number of memory references to enable prefetching in a loop.
10364 @item use-canonical-types
10365 Whether the compiler should use the ``canonical'' type system.  By
10366 default, this should always be 1, which uses a more efficient internal
10367 mechanism for comparing types in C++ and Objective-C++.  However, if
10368 bugs in the canonical type system are causing compilation failures,
10369 set this value to 0 to disable canonical types.
10371 @item switch-conversion-max-branch-ratio
10372 Switch initialization conversion refuses to create arrays that are
10373 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10374 branches in the switch.
10376 @item max-partial-antic-length
10377 Maximum length of the partial antic set computed during the tree
10378 partial redundancy elimination optimization (@option{-ftree-pre}) when
10379 optimizing at @option{-O3} and above.  For some sorts of source code
10380 the enhanced partial redundancy elimination optimization can run away,
10381 consuming all of the memory available on the host machine.  This
10382 parameter sets a limit on the length of the sets that are computed,
10383 which prevents the runaway behavior.  Setting a value of 0 for
10384 this parameter allows an unlimited set length.
10386 @item sccvn-max-scc-size
10387 Maximum size of a strongly connected component (SCC) during SCCVN
10388 processing.  If this limit is hit, SCCVN processing for the whole
10389 function is not done and optimizations depending on it are
10390 disabled.  The default maximum SCC size is 10000.
10392 @item sccvn-max-alias-queries-per-access
10393 Maximum number of alias-oracle queries we perform when looking for
10394 redundancies for loads and stores.  If this limit is hit the search
10395 is aborted and the load or store is not considered redundant.  The
10396 number of queries is algorithmically limited to the number of
10397 stores on all paths from the load to the function entry.
10398 The default maxmimum number of queries is 1000.
10400 @item ira-max-loops-num
10401 IRA uses regional register allocation by default.  If a function
10402 contains more loops than the number given by this parameter, only at most
10403 the given number of the most frequently-executed loops form regions
10404 for regional register allocation.  The default value of the
10405 parameter is 100.
10407 @item ira-max-conflict-table-size 
10408 Although IRA uses a sophisticated algorithm to compress the conflict
10409 table, the table can still require excessive amounts of memory for
10410 huge functions.  If the conflict table for a function could be more
10411 than the size in MB given by this parameter, the register allocator
10412 instead uses a faster, simpler, and lower-quality
10413 algorithm that does not require building a pseudo-register conflict table.  
10414 The default value of the parameter is 2000.
10416 @item ira-loop-reserved-regs
10417 IRA can be used to evaluate more accurate register pressure in loops
10418 for decisions to move loop invariants (see @option{-O3}).  The number
10419 of available registers reserved for some other purposes is given
10420 by this parameter.  The default value of the parameter is 2, which is
10421 the minimal number of registers needed by typical instructions.
10422 This value is the best found from numerous experiments.
10424 @item loop-invariant-max-bbs-in-loop
10425 Loop invariant motion can be very expensive, both in compilation time and
10426 in amount of needed compile-time memory, with very large loops.  Loops
10427 with more basic blocks than this parameter won't have loop invariant
10428 motion optimization performed on them.  The default value of the
10429 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10431 @item loop-max-datarefs-for-datadeps
10432 Building data dapendencies is expensive for very large loops.  This
10433 parameter limits the number of data references in loops that are
10434 considered for data dependence analysis.  These large loops are no
10435 handled by the optimizations using loop data dependencies.
10436 The default value is 1000.
10438 @item max-vartrack-size
10439 Sets a maximum number of hash table slots to use during variable
10440 tracking dataflow analysis of any function.  If this limit is exceeded
10441 with variable tracking at assignments enabled, analysis for that
10442 function is retried without it, after removing all debug insns from
10443 the function.  If the limit is exceeded even without debug insns, var
10444 tracking analysis is completely disabled for the function.  Setting
10445 the parameter to zero makes it unlimited.
10447 @item max-vartrack-expr-depth
10448 Sets a maximum number of recursion levels when attempting to map
10449 variable names or debug temporaries to value expressions.  This trades
10450 compilation time for more complete debug information.  If this is set too
10451 low, value expressions that are available and could be represented in
10452 debug information may end up not being used; setting this higher may
10453 enable the compiler to find more complex debug expressions, but compile
10454 time and memory use may grow.  The default is 12.
10456 @item min-nondebug-insn-uid
10457 Use uids starting at this parameter for nondebug insns.  The range below
10458 the parameter is reserved exclusively for debug insns created by
10459 @option{-fvar-tracking-assignments}, but debug insns may get
10460 (non-overlapping) uids above it if the reserved range is exhausted.
10462 @item ipa-sra-ptr-growth-factor
10463 IPA-SRA replaces a pointer to an aggregate with one or more new
10464 parameters only when their cumulative size is less or equal to
10465 @option{ipa-sra-ptr-growth-factor} times the size of the original
10466 pointer parameter.
10468 @item sra-max-scalarization-size-Ospeed
10469 @item sra-max-scalarization-size-Osize
10470 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10471 replace scalar parts of aggregates with uses of independent scalar
10472 variables.  These parameters control the maximum size, in storage units,
10473 of aggregate which will be considered for replacement when compiling for
10474 speed
10475 (@option{sra-max-scalarization-size-Ospeed}) or size
10476 (@option{sra-max-scalarization-size-Osize}) respectively.
10478 @item tm-max-aggregate-size
10479 When making copies of thread-local variables in a transaction, this
10480 parameter specifies the size in bytes after which variables are
10481 saved with the logging functions as opposed to save/restore code
10482 sequence pairs.  This option only applies when using
10483 @option{-fgnu-tm}.
10485 @item graphite-max-nb-scop-params
10486 To avoid exponential effects in the Graphite loop transforms, the
10487 number of parameters in a Static Control Part (SCoP) is bounded.  The
10488 default value is 10 parameters.  A variable whose value is unknown at
10489 compilation time and defined outside a SCoP is a parameter of the SCoP.
10491 @item graphite-max-bbs-per-function
10492 To avoid exponential effects in the detection of SCoPs, the size of
10493 the functions analyzed by Graphite is bounded.  The default value is
10494 100 basic blocks.
10496 @item loop-block-tile-size
10497 Loop blocking or strip mining transforms, enabled with
10498 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10499 loop in the loop nest by a given number of iterations.  The strip
10500 length can be changed using the @option{loop-block-tile-size}
10501 parameter.  The default value is 51 iterations.
10503 @item loop-unroll-jam-size
10504 Specify the unroll factor for the @option{-floop-unroll-and-jam}.  The 
10505 default value is 4.
10507 @item loop-unroll-jam-depth
10508 Specify the dimension to be unrolled (counting from the most inner loop)
10509 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10511 @item ipa-cp-value-list-size
10512 IPA-CP attempts to track all possible values and types passed to a function's
10513 parameter in order to propagate them and perform devirtualization.
10514 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10515 stores per one formal parameter of a function.
10517 @item ipa-cp-eval-threshold
10518 IPA-CP calculates its own score of cloning profitability heuristics
10519 and performs those cloning opportunities with scores that exceed
10520 @option{ipa-cp-eval-threshold}.
10522 @item ipa-max-agg-items
10523 IPA-CP is also capable to propagate a number of scalar values passed
10524 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10525 number of such values per one parameter.
10527 @item ipa-cp-loop-hint-bonus
10528 When IPA-CP determines that a cloning candidate would make the number
10529 of iterations of a loop known, it adds a bonus of
10530 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10531 the candidate.
10533 @item ipa-cp-array-index-hint-bonus
10534 When IPA-CP determines that a cloning candidate would make the index of
10535 an array access known, it adds a bonus of
10536 @option{ipa-cp-array-index-hint-bonus} to the profitability
10537 score of the candidate.
10539 @item ipa-max-aa-steps
10540 During its analysis of function bodies, IPA-CP employs alias analysis
10541 in order to track values pointed to by function parameters.  In order
10542 not spend too much time analyzing huge functions, it will give up and
10543 consider all memory clobbered after examining
10544 @option{ipa-max-aa-steps} statements modifying memory.
10546 @item lto-partitions
10547 Specify desired number of partitions produced during WHOPR compilation.
10548 The number of partitions should exceed the number of CPUs used for compilation.
10549 The default value is 32.
10551 @item lto-minpartition
10552 Size of minimal partition for WHOPR (in estimated instructions).
10553 This prevents expenses of splitting very small programs into too many
10554 partitions.
10556 @item cxx-max-namespaces-for-diagnostic-help
10557 The maximum number of namespaces to consult for suggestions when C++
10558 name lookup fails for an identifier.  The default is 1000.
10560 @item sink-frequency-threshold
10561 The maximum relative execution frequency (in percents) of the target block
10562 relative to a statement's original block to allow statement sinking of a
10563 statement.  Larger numbers result in more aggressive statement sinking.
10564 The default value is 75.  A small positive adjustment is applied for
10565 statements with memory operands as those are even more profitable so sink.
10567 @item max-stores-to-sink
10568 The maximum number of conditional stores paires that can be sunk.  Set to 0
10569 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10570 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10572 @item allow-store-data-races
10573 Allow optimizers to introduce new data races on stores.
10574 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10575 at optimization level @option{-Ofast}.
10577 @item case-values-threshold
10578 The smallest number of different values for which it is best to use a
10579 jump-table instead of a tree of conditional branches.  If the value is
10580 0, use the default for the machine.  The default is 0.
10582 @item tree-reassoc-width
10583 Set the maximum number of instructions executed in parallel in
10584 reassociated tree. This parameter overrides target dependent
10585 heuristics used by default if has non zero value.
10587 @item sched-pressure-algorithm
10588 Choose between the two available implementations of
10589 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10590 and is the more likely to prevent instructions from being reordered.
10591 Algorithm 2 was designed to be a compromise between the relatively
10592 conservative approach taken by algorithm 1 and the rather aggressive
10593 approach taken by the default scheduler.  It relies more heavily on
10594 having a regular register file and accurate register pressure classes.
10595 See @file{haifa-sched.c} in the GCC sources for more details.
10597 The default choice depends on the target.
10599 @item max-slsr-cand-scan
10600 Set the maximum number of existing candidates that will be considered when
10601 seeking a basis for a new straight-line strength reduction candidate.
10603 @item asan-globals
10604 Enable buffer overflow detection for global objects.  This kind
10605 of protection is enabled by default if you are using
10606 @option{-fsanitize=address} option.
10607 To disable global objects protection use @option{--param asan-globals=0}.
10609 @item asan-stack
10610 Enable buffer overflow detection for stack objects.  This kind of
10611 protection is enabled by default when using@option{-fsanitize=address}.
10612 To disable stack protection use @option{--param asan-stack=0} option.
10614 @item asan-instrument-reads
10615 Enable buffer overflow detection for memory reads.  This kind of
10616 protection is enabled by default when using @option{-fsanitize=address}.
10617 To disable memory reads protection use
10618 @option{--param asan-instrument-reads=0}.
10620 @item asan-instrument-writes
10621 Enable buffer overflow detection for memory writes.  This kind of
10622 protection is enabled by default when using @option{-fsanitize=address}.
10623 To disable memory writes protection use
10624 @option{--param asan-instrument-writes=0} option.
10626 @item asan-memintrin
10627 Enable detection for built-in functions.  This kind of protection
10628 is enabled by default when using @option{-fsanitize=address}.
10629 To disable built-in functions protection use
10630 @option{--param asan-memintrin=0}.
10632 @item asan-use-after-return
10633 Enable detection of use-after-return.  This kind of protection
10634 is enabled by default when using @option{-fsanitize=address} option.
10635 To disable use-after-return detection use 
10636 @option{--param asan-use-after-return=0}.
10638 @item asan-instrumentation-with-call-threshold
10639 If number of memory accesses in function being instrumented
10640 is greater or equal to this number, use callbacks instead of inline checks.
10641 E.g. to disable inline code use
10642 @option{--param asan-instrumentation-with-call-threshold=0}.
10644 @item chkp-max-ctor-size
10645 Static constructors generated by Pointer Bounds Checker may become very
10646 large and significantly increase compile time at optimization level
10647 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10648 in a single generated constructor.  Default value is 5000.
10650 @item max-fsm-thread-path-insns
10651 Maximum number of instructions to copy when duplicating blocks on a
10652 finite state automaton jump thread path.  The default is 100.
10654 @item max-fsm-thread-length
10655 Maximum number of basic blocks on a finite state automaton jump thread
10656 path.  The default is 10.
10658 @item max-fsm-thread-paths
10659 Maximum number of new jump thread paths to create for a finite state
10660 automaton.  The default is 50.
10662 @end table
10663 @end table
10665 @node Preprocessor Options
10666 @section Options Controlling the Preprocessor
10667 @cindex preprocessor options
10668 @cindex options, preprocessor
10670 These options control the C preprocessor, which is run on each C source
10671 file before actual compilation.
10673 If you use the @option{-E} option, nothing is done except preprocessing.
10674 Some of these options make sense only together with @option{-E} because
10675 they cause the preprocessor output to be unsuitable for actual
10676 compilation.
10678 @table @gcctabopt
10679 @item -Wp,@var{option}
10680 @opindex Wp
10681 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10682 and pass @var{option} directly through to the preprocessor.  If
10683 @var{option} contains commas, it is split into multiple options at the
10684 commas.  However, many options are modified, translated or interpreted
10685 by the compiler driver before being passed to the preprocessor, and
10686 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10687 interface is undocumented and subject to change, so whenever possible
10688 you should avoid using @option{-Wp} and let the driver handle the
10689 options instead.
10691 @item -Xpreprocessor @var{option}
10692 @opindex Xpreprocessor
10693 Pass @var{option} as an option to the preprocessor.  You can use this to
10694 supply system-specific preprocessor options that GCC does not 
10695 recognize.
10697 If you want to pass an option that takes an argument, you must use
10698 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10700 @item -no-integrated-cpp
10701 @opindex no-integrated-cpp
10702 Perform preprocessing as a separate pass before compilation.
10703 By default, GCC performs preprocessing as an integrated part of
10704 input tokenization and parsing.
10705 If this option is provided, the appropriate language front end
10706 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10707 and Objective-C, respectively) is instead invoked twice,
10708 once for preprocessing only and once for actual compilation
10709 of the preprocessed input.
10710 This option may be useful in conjunction with the @option{-B} or
10711 @option{-wrapper} options to specify an alternate preprocessor or
10712 perform additional processing of the program source between
10713 normal preprocessing and compilation.
10714 @end table
10716 @include cppopts.texi
10718 @node Assembler Options
10719 @section Passing Options to the Assembler
10721 @c prevent bad page break with this line
10722 You can pass options to the assembler.
10724 @table @gcctabopt
10725 @item -Wa,@var{option}
10726 @opindex Wa
10727 Pass @var{option} as an option to the assembler.  If @var{option}
10728 contains commas, it is split into multiple options at the commas.
10730 @item -Xassembler @var{option}
10731 @opindex Xassembler
10732 Pass @var{option} as an option to the assembler.  You can use this to
10733 supply system-specific assembler options that GCC does not
10734 recognize.
10736 If you want to pass an option that takes an argument, you must use
10737 @option{-Xassembler} twice, once for the option and once for the argument.
10739 @end table
10741 @node Link Options
10742 @section Options for Linking
10743 @cindex link options
10744 @cindex options, linking
10746 These options come into play when the compiler links object files into
10747 an executable output file.  They are meaningless if the compiler is
10748 not doing a link step.
10750 @table @gcctabopt
10751 @cindex file names
10752 @item @var{object-file-name}
10753 A file name that does not end in a special recognized suffix is
10754 considered to name an object file or library.  (Object files are
10755 distinguished from libraries by the linker according to the file
10756 contents.)  If linking is done, these object files are used as input
10757 to the linker.
10759 @item -c
10760 @itemx -S
10761 @itemx -E
10762 @opindex c
10763 @opindex S
10764 @opindex E
10765 If any of these options is used, then the linker is not run, and
10766 object file names should not be used as arguments.  @xref{Overall
10767 Options}.
10769 @cindex Libraries
10770 @item -l@var{library}
10771 @itemx -l @var{library}
10772 @opindex l
10773 Search the library named @var{library} when linking.  (The second
10774 alternative with the library as a separate argument is only for
10775 POSIX compliance and is not recommended.)
10777 It makes a difference where in the command you write this option; the
10778 linker searches and processes libraries and object files in the order they
10779 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10780 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10781 to functions in @samp{z}, those functions may not be loaded.
10783 The linker searches a standard list of directories for the library,
10784 which is actually a file named @file{lib@var{library}.a}.  The linker
10785 then uses this file as if it had been specified precisely by name.
10787 The directories searched include several standard system directories
10788 plus any that you specify with @option{-L}.
10790 Normally the files found this way are library files---archive files
10791 whose members are object files.  The linker handles an archive file by
10792 scanning through it for members which define symbols that have so far
10793 been referenced but not defined.  But if the file that is found is an
10794 ordinary object file, it is linked in the usual fashion.  The only
10795 difference between using an @option{-l} option and specifying a file name
10796 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10797 and searches several directories.
10799 @item -lobjc
10800 @opindex lobjc
10801 You need this special case of the @option{-l} option in order to
10802 link an Objective-C or Objective-C++ program.
10804 @item -nostartfiles
10805 @opindex nostartfiles
10806 Do not use the standard system startup files when linking.
10807 The standard system libraries are used normally, unless @option{-nostdlib}
10808 or @option{-nodefaultlibs} is used.
10810 @item -nodefaultlibs
10811 @opindex nodefaultlibs
10812 Do not use the standard system libraries when linking.
10813 Only the libraries you specify are passed to the linker, and options
10814 specifying linkage of the system libraries, such as @code{-static-libgcc}
10815 or @code{-shared-libgcc}, are ignored.  
10816 The standard startup files are used normally, unless @option{-nostartfiles}
10817 is used.  
10819 The compiler may generate calls to @code{memcmp},
10820 @code{memset}, @code{memcpy} and @code{memmove}.
10821 These entries are usually resolved by entries in
10822 libc.  These entry points should be supplied through some other
10823 mechanism when this option is specified.
10825 @item -nostdlib
10826 @opindex nostdlib
10827 Do not use the standard system startup files or libraries when linking.
10828 No startup files and only the libraries you specify are passed to
10829 the linker, and options specifying linkage of the system libraries, such as
10830 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10832 The compiler may generate calls to @code{memcmp}, @code{memset},
10833 @code{memcpy} and @code{memmove}.
10834 These entries are usually resolved by entries in
10835 libc.  These entry points should be supplied through some other
10836 mechanism when this option is specified.
10838 @cindex @option{-lgcc}, use with @option{-nostdlib}
10839 @cindex @option{-nostdlib} and unresolved references
10840 @cindex unresolved references and @option{-nostdlib}
10841 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10842 @cindex @option{-nodefaultlibs} and unresolved references
10843 @cindex unresolved references and @option{-nodefaultlibs}
10844 One of the standard libraries bypassed by @option{-nostdlib} and
10845 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10846 which GCC uses to overcome shortcomings of particular machines, or special
10847 needs for some languages.
10848 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10849 Collection (GCC) Internals},
10850 for more discussion of @file{libgcc.a}.)
10851 In most cases, you need @file{libgcc.a} even when you want to avoid
10852 other standard libraries.  In other words, when you specify @option{-nostdlib}
10853 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10854 This ensures that you have no unresolved references to internal GCC
10855 library subroutines.
10856 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10857 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10858 GNU Compiler Collection (GCC) Internals}.)
10860 @item -pie
10861 @opindex pie
10862 Produce a position independent executable on targets that support it.
10863 For predictable results, you must also specify the same set of options
10864 used for compilation (@option{-fpie}, @option{-fPIE},
10865 or model suboptions) when you specify this linker option.
10867 @item -rdynamic
10868 @opindex rdynamic
10869 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10870 that support it. This instructs the linker to add all symbols, not
10871 only used ones, to the dynamic symbol table. This option is needed
10872 for some uses of @code{dlopen} or to allow obtaining backtraces
10873 from within a program.
10875 @item -s
10876 @opindex s
10877 Remove all symbol table and relocation information from the executable.
10879 @item -static
10880 @opindex static
10881 On systems that support dynamic linking, this prevents linking with the shared
10882 libraries.  On other systems, this option has no effect.
10884 @item -shared
10885 @opindex shared
10886 Produce a shared object which can then be linked with other objects to
10887 form an executable.  Not all systems support this option.  For predictable
10888 results, you must also specify the same set of options used for compilation
10889 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10890 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10891 needs to build supplementary stub code for constructors to work.  On
10892 multi-libbed systems, @samp{gcc -shared} must select the correct support
10893 libraries to link against.  Failing to supply the correct flags may lead
10894 to subtle defects.  Supplying them in cases where they are not necessary
10895 is innocuous.}
10897 @item -shared-libgcc
10898 @itemx -static-libgcc
10899 @opindex shared-libgcc
10900 @opindex static-libgcc
10901 On systems that provide @file{libgcc} as a shared library, these options
10902 force the use of either the shared or static version, respectively.
10903 If no shared version of @file{libgcc} was built when the compiler was
10904 configured, these options have no effect.
10906 There are several situations in which an application should use the
10907 shared @file{libgcc} instead of the static version.  The most common
10908 of these is when the application wishes to throw and catch exceptions
10909 across different shared libraries.  In that case, each of the libraries
10910 as well as the application itself should use the shared @file{libgcc}.
10912 Therefore, the G++ and GCJ drivers automatically add
10913 @option{-shared-libgcc} whenever you build a shared library or a main
10914 executable, because C++ and Java programs typically use exceptions, so
10915 this is the right thing to do.
10917 If, instead, you use the GCC driver to create shared libraries, you may
10918 find that they are not always linked with the shared @file{libgcc}.
10919 If GCC finds, at its configuration time, that you have a non-GNU linker
10920 or a GNU linker that does not support option @option{--eh-frame-hdr},
10921 it links the shared version of @file{libgcc} into shared libraries
10922 by default.  Otherwise, it takes advantage of the linker and optimizes
10923 away the linking with the shared version of @file{libgcc}, linking with
10924 the static version of libgcc by default.  This allows exceptions to
10925 propagate through such shared libraries, without incurring relocation
10926 costs at library load time.
10928 However, if a library or main executable is supposed to throw or catch
10929 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10930 for the languages used in the program, or using the option
10931 @option{-shared-libgcc}, such that it is linked with the shared
10932 @file{libgcc}.
10934 @item -static-libasan
10935 @opindex static-libasan
10936 When the @option{-fsanitize=address} option is used to link a program,
10937 the GCC driver automatically links against @option{libasan}.  If
10938 @file{libasan} is available as a shared library, and the @option{-static}
10939 option is not used, then this links against the shared version of
10940 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10941 driver to link @file{libasan} statically, without necessarily linking
10942 other libraries statically.
10944 @item -static-libtsan
10945 @opindex static-libtsan
10946 When the @option{-fsanitize=thread} option is used to link a program,
10947 the GCC driver automatically links against @option{libtsan}.  If
10948 @file{libtsan} is available as a shared library, and the @option{-static}
10949 option is not used, then this links against the shared version of
10950 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10951 driver to link @file{libtsan} statically, without necessarily linking
10952 other libraries statically.
10954 @item -static-liblsan
10955 @opindex static-liblsan
10956 When the @option{-fsanitize=leak} option is used to link a program,
10957 the GCC driver automatically links against @option{liblsan}.  If
10958 @file{liblsan} is available as a shared library, and the @option{-static}
10959 option is not used, then this links against the shared version of
10960 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10961 driver to link @file{liblsan} statically, without necessarily linking
10962 other libraries statically.
10964 @item -static-libubsan
10965 @opindex static-libubsan
10966 When the @option{-fsanitize=undefined} option is used to link a program,
10967 the GCC driver automatically links against @option{libubsan}.  If
10968 @file{libubsan} is available as a shared library, and the @option{-static}
10969 option is not used, then this links against the shared version of
10970 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10971 driver to link @file{libubsan} statically, without necessarily linking
10972 other libraries statically.
10974 @item -static-libstdc++
10975 @opindex static-libstdc++
10976 When the @command{g++} program is used to link a C++ program, it
10977 normally automatically links against @option{libstdc++}.  If
10978 @file{libstdc++} is available as a shared library, and the
10979 @option{-static} option is not used, then this links against the
10980 shared version of @file{libstdc++}.  That is normally fine.  However, it
10981 is sometimes useful to freeze the version of @file{libstdc++} used by
10982 the program without going all the way to a fully static link.  The
10983 @option{-static-libstdc++} option directs the @command{g++} driver to
10984 link @file{libstdc++} statically, without necessarily linking other
10985 libraries statically.
10987 @item -symbolic
10988 @opindex symbolic
10989 Bind references to global symbols when building a shared object.  Warn
10990 about any unresolved references (unless overridden by the link editor
10991 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10992 this option.
10994 @item -T @var{script}
10995 @opindex T
10996 @cindex linker script
10997 Use @var{script} as the linker script.  This option is supported by most
10998 systems using the GNU linker.  On some targets, such as bare-board
10999 targets without an operating system, the @option{-T} option may be required
11000 when linking to avoid references to undefined symbols.
11002 @item -Xlinker @var{option}
11003 @opindex Xlinker
11004 Pass @var{option} as an option to the linker.  You can use this to
11005 supply system-specific linker options that GCC does not recognize.
11007 If you want to pass an option that takes a separate argument, you must use
11008 @option{-Xlinker} twice, once for the option and once for the argument.
11009 For example, to pass @option{-assert definitions}, you must write
11010 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11011 @option{-Xlinker "-assert definitions"}, because this passes the entire
11012 string as a single argument, which is not what the linker expects.
11014 When using the GNU linker, it is usually more convenient to pass
11015 arguments to linker options using the @option{@var{option}=@var{value}}
11016 syntax than as separate arguments.  For example, you can specify
11017 @option{-Xlinker -Map=output.map} rather than
11018 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11019 this syntax for command-line options.
11021 @item -Wl,@var{option}
11022 @opindex Wl
11023 Pass @var{option} as an option to the linker.  If @var{option} contains
11024 commas, it is split into multiple options at the commas.  You can use this
11025 syntax to pass an argument to the option.
11026 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11027 linker.  When using the GNU linker, you can also get the same effect with
11028 @option{-Wl,-Map=output.map}.
11030 @item -u @var{symbol}
11031 @opindex u
11032 Pretend the symbol @var{symbol} is undefined, to force linking of
11033 library modules to define it.  You can use @option{-u} multiple times with
11034 different symbols to force loading of additional library modules.
11036 @item -z @var{keyword}
11037 @opindex z
11038 @option{-z} is passed directly on to the linker along with the keyword
11039 @var{keyword}. See the section in the documentation of your linker for
11040 permitted values and their meanings.
11041 @end table
11043 @node Directory Options
11044 @section Options for Directory Search
11045 @cindex directory options
11046 @cindex options, directory search
11047 @cindex search path
11049 These options specify directories to search for header files, for
11050 libraries and for parts of the compiler:
11052 @table @gcctabopt
11053 @item -I@var{dir}
11054 @opindex I
11055 Add the directory @var{dir} to the head of the list of directories to be
11056 searched for header files.  This can be used to override a system header
11057 file, substituting your own version, since these directories are
11058 searched before the system header file directories.  However, you should
11059 not use this option to add directories that contain vendor-supplied
11060 system header files (use @option{-isystem} for that).  If you use more than
11061 one @option{-I} option, the directories are scanned in left-to-right
11062 order; the standard system directories come after.
11064 If a standard system include directory, or a directory specified with
11065 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11066 option is ignored.  The directory is still searched but as a
11067 system directory at its normal position in the system include chain.
11068 This is to ensure that GCC's procedure to fix buggy system headers and
11069 the ordering for the @code{include_next} directive are not inadvertently changed.
11070 If you really need to change the search order for system directories,
11071 use the @option{-nostdinc} and/or @option{-isystem} options.
11073 @item -iplugindir=@var{dir}
11074 @opindex iplugindir=
11075 Set the directory to search for plugins that are passed
11076 by @option{-fplugin=@var{name}} instead of
11077 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11078 to be used by the user, but only passed by the driver.
11080 @item -iquote@var{dir}
11081 @opindex iquote
11082 Add the directory @var{dir} to the head of the list of directories to
11083 be searched for header files only for the case of @samp{#include
11084 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
11085 otherwise just like @option{-I}.
11087 @item -L@var{dir}
11088 @opindex L
11089 Add directory @var{dir} to the list of directories to be searched
11090 for @option{-l}.
11092 @item -B@var{prefix}
11093 @opindex B
11094 This option specifies where to find the executables, libraries,
11095 include files, and data files of the compiler itself.
11097 The compiler driver program runs one or more of the subprograms
11098 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11099 @var{prefix} as a prefix for each program it tries to run, both with and
11100 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11102 For each subprogram to be run, the compiler driver first tries the
11103 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11104 is not specified, the driver tries two standard prefixes, 
11105 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11106 those results in a file name that is found, the unmodified program
11107 name is searched for using the directories specified in your
11108 @env{PATH} environment variable.
11110 The compiler checks to see if the path provided by the @option{-B}
11111 refers to a directory, and if necessary it adds a directory
11112 separator character at the end of the path.
11114 @option{-B} prefixes that effectively specify directory names also apply
11115 to libraries in the linker, because the compiler translates these
11116 options into @option{-L} options for the linker.  They also apply to
11117 include files in the preprocessor, because the compiler translates these
11118 options into @option{-isystem} options for the preprocessor.  In this case,
11119 the compiler appends @samp{include} to the prefix.
11121 The runtime support file @file{libgcc.a} can also be searched for using
11122 the @option{-B} prefix, if needed.  If it is not found there, the two
11123 standard prefixes above are tried, and that is all.  The file is left
11124 out of the link if it is not found by those means.
11126 Another way to specify a prefix much like the @option{-B} prefix is to use
11127 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11128 Variables}.
11130 As a special kludge, if the path provided by @option{-B} is
11131 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11132 9, then it is replaced by @file{[dir/]include}.  This is to help
11133 with boot-strapping the compiler.
11135 @item -specs=@var{file}
11136 @opindex specs
11137 Process @var{file} after the compiler reads in the standard @file{specs}
11138 file, in order to override the defaults which the @command{gcc} driver
11139 program uses when determining what switches to pass to @command{cc1},
11140 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11141 @option{-specs=@var{file}} can be specified on the command line, and they
11142 are processed in order, from left to right.
11144 @item --sysroot=@var{dir}
11145 @opindex sysroot
11146 Use @var{dir} as the logical root directory for headers and libraries.
11147 For example, if the compiler normally searches for headers in
11148 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11149 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11151 If you use both this option and the @option{-isysroot} option, then
11152 the @option{--sysroot} option applies to libraries, but the
11153 @option{-isysroot} option applies to header files.
11155 The GNU linker (beginning with version 2.16) has the necessary support
11156 for this option.  If your linker does not support this option, the
11157 header file aspect of @option{--sysroot} still works, but the
11158 library aspect does not.
11160 @item --no-sysroot-suffix
11161 @opindex no-sysroot-suffix
11162 For some targets, a suffix is added to the root directory specified
11163 with @option{--sysroot}, depending on the other options used, so that
11164 headers may for example be found in
11165 @file{@var{dir}/@var{suffix}/usr/include} instead of
11166 @file{@var{dir}/usr/include}.  This option disables the addition of
11167 such a suffix.
11169 @item -I-
11170 @opindex I-
11171 This option has been deprecated.  Please use @option{-iquote} instead for
11172 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
11173 Any directories you specify with @option{-I} options before the @option{-I-}
11174 option are searched only for the case of @samp{#include "@var{file}"};
11175 they are not searched for @samp{#include <@var{file}>}.
11177 If additional directories are specified with @option{-I} options after
11178 the @option{-I-}, these directories are searched for all @samp{#include}
11179 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11180 this way.)
11182 In addition, the @option{-I-} option inhibits the use of the current
11183 directory (where the current input file came from) as the first search
11184 directory for @samp{#include "@var{file}"}.  There is no way to
11185 override this effect of @option{-I-}.  With @option{-I.} you can specify
11186 searching the directory that is current when the compiler is
11187 invoked.  That is not exactly the same as what the preprocessor does
11188 by default, but it is often satisfactory.
11190 @option{-I-} does not inhibit the use of the standard system directories
11191 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11192 independent.
11193 @end table
11195 @c man end
11197 @node Spec Files
11198 @section Specifying subprocesses and the switches to pass to them
11199 @cindex Spec Files
11201 @command{gcc} is a driver program.  It performs its job by invoking a
11202 sequence of other programs to do the work of compiling, assembling and
11203 linking.  GCC interprets its command-line parameters and uses these to
11204 deduce which programs it should invoke, and which command-line options
11205 it ought to place on their command lines.  This behavior is controlled
11206 by @dfn{spec strings}.  In most cases there is one spec string for each
11207 program that GCC can invoke, but a few programs have multiple spec
11208 strings to control their behavior.  The spec strings built into GCC can
11209 be overridden by using the @option{-specs=} command-line switch to specify
11210 a spec file.
11212 @dfn{Spec files} are plaintext files that are used to construct spec
11213 strings.  They consist of a sequence of directives separated by blank
11214 lines.  The type of directive is determined by the first non-whitespace
11215 character on the line, which can be one of the following:
11217 @table @code
11218 @item %@var{command}
11219 Issues a @var{command} to the spec file processor.  The commands that can
11220 appear here are:
11222 @table @code
11223 @item %include <@var{file}>
11224 @cindex @code{%include}
11225 Search for @var{file} and insert its text at the current point in the
11226 specs file.
11228 @item %include_noerr <@var{file}>
11229 @cindex @code{%include_noerr}
11230 Just like @samp{%include}, but do not generate an error message if the include
11231 file cannot be found.
11233 @item %rename @var{old_name} @var{new_name}
11234 @cindex @code{%rename}
11235 Rename the spec string @var{old_name} to @var{new_name}.
11237 @end table
11239 @item *[@var{spec_name}]:
11240 This tells the compiler to create, override or delete the named spec
11241 string.  All lines after this directive up to the next directive or
11242 blank line are considered to be the text for the spec string.  If this
11243 results in an empty string then the spec is deleted.  (Or, if the
11244 spec did not exist, then nothing happens.)  Otherwise, if the spec
11245 does not currently exist a new spec is created.  If the spec does
11246 exist then its contents are overridden by the text of this
11247 directive, unless the first character of that text is the @samp{+}
11248 character, in which case the text is appended to the spec.
11250 @item [@var{suffix}]:
11251 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11252 and up to the next directive or blank line are considered to make up the
11253 spec string for the indicated suffix.  When the compiler encounters an
11254 input file with the named suffix, it processes the spec string in
11255 order to work out how to compile that file.  For example:
11257 @smallexample
11258 .ZZ:
11259 z-compile -input %i
11260 @end smallexample
11262 This says that any input file whose name ends in @samp{.ZZ} should be
11263 passed to the program @samp{z-compile}, which should be invoked with the
11264 command-line switch @option{-input} and with the result of performing the
11265 @samp{%i} substitution.  (See below.)
11267 As an alternative to providing a spec string, the text following a
11268 suffix directive can be one of the following:
11270 @table @code
11271 @item @@@var{language}
11272 This says that the suffix is an alias for a known @var{language}.  This is
11273 similar to using the @option{-x} command-line switch to GCC to specify a
11274 language explicitly.  For example:
11276 @smallexample
11277 .ZZ:
11278 @@c++
11279 @end smallexample
11281 Says that .ZZ files are, in fact, C++ source files.
11283 @item #@var{name}
11284 This causes an error messages saying:
11286 @smallexample
11287 @var{name} compiler not installed on this system.
11288 @end smallexample
11289 @end table
11291 GCC already has an extensive list of suffixes built into it.
11292 This directive adds an entry to the end of the list of suffixes, but
11293 since the list is searched from the end backwards, it is effectively
11294 possible to override earlier entries using this technique.
11296 @end table
11298 GCC has the following spec strings built into it.  Spec files can
11299 override these strings or create their own.  Note that individual
11300 targets can also add their own spec strings to this list.
11302 @smallexample
11303 asm          Options to pass to the assembler
11304 asm_final    Options to pass to the assembler post-processor
11305 cpp          Options to pass to the C preprocessor
11306 cc1          Options to pass to the C compiler
11307 cc1plus      Options to pass to the C++ compiler
11308 endfile      Object files to include at the end of the link
11309 link         Options to pass to the linker
11310 lib          Libraries to include on the command line to the linker
11311 libgcc       Decides which GCC support library to pass to the linker
11312 linker       Sets the name of the linker
11313 predefines   Defines to be passed to the C preprocessor
11314 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11315              by default
11316 startfile    Object files to include at the start of the link
11317 @end smallexample
11319 Here is a small example of a spec file:
11321 @smallexample
11322 %rename lib                 old_lib
11324 *lib:
11325 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11326 @end smallexample
11328 This example renames the spec called @samp{lib} to @samp{old_lib} and
11329 then overrides the previous definition of @samp{lib} with a new one.
11330 The new definition adds in some extra command-line options before
11331 including the text of the old definition.
11333 @dfn{Spec strings} are a list of command-line options to be passed to their
11334 corresponding program.  In addition, the spec strings can contain
11335 @samp{%}-prefixed sequences to substitute variable text or to
11336 conditionally insert text into the command line.  Using these constructs
11337 it is possible to generate quite complex command lines.
11339 Here is a table of all defined @samp{%}-sequences for spec
11340 strings.  Note that spaces are not generated automatically around the
11341 results of expanding these sequences.  Therefore you can concatenate them
11342 together or combine them with constant text in a single argument.
11344 @table @code
11345 @item %%
11346 Substitute one @samp{%} into the program name or argument.
11348 @item %i
11349 Substitute the name of the input file being processed.
11351 @item %b
11352 Substitute the basename of the input file being processed.
11353 This is the substring up to (and not including) the last period
11354 and not including the directory.
11356 @item %B
11357 This is the same as @samp{%b}, but include the file suffix (text after
11358 the last period).
11360 @item %d
11361 Marks the argument containing or following the @samp{%d} as a
11362 temporary file name, so that that file is deleted if GCC exits
11363 successfully.  Unlike @samp{%g}, this contributes no text to the
11364 argument.
11366 @item %g@var{suffix}
11367 Substitute a file name that has suffix @var{suffix} and is chosen
11368 once per compilation, and mark the argument in the same way as
11369 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11370 name is now chosen in a way that is hard to predict even when previously
11371 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11372 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11373 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11374 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11375 was simply substituted with a file name chosen once per compilation,
11376 without regard to any appended suffix (which was therefore treated
11377 just like ordinary text), making such attacks more likely to succeed.
11379 @item %u@var{suffix}
11380 Like @samp{%g}, but generates a new temporary file name
11381 each time it appears instead of once per compilation.
11383 @item %U@var{suffix}
11384 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11385 new one if there is no such last file name.  In the absence of any
11386 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11387 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11388 involves the generation of two distinct file names, one
11389 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11390 simply substituted with a file name chosen for the previous @samp{%u},
11391 without regard to any appended suffix.
11393 @item %j@var{suffix}
11394 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11395 writable, and if @option{-save-temps} is not used; 
11396 otherwise, substitute the name
11397 of a temporary file, just like @samp{%u}.  This temporary file is not
11398 meant for communication between processes, but rather as a junk
11399 disposal mechanism.
11401 @item %|@var{suffix}
11402 @itemx %m@var{suffix}
11403 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11404 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11405 all.  These are the two most common ways to instruct a program that it
11406 should read from standard input or write to standard output.  If you
11407 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11408 construct: see for example @file{f/lang-specs.h}.
11410 @item %.@var{SUFFIX}
11411 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11412 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11413 terminated by the next space or %.
11415 @item %w
11416 Marks the argument containing or following the @samp{%w} as the
11417 designated output file of this compilation.  This puts the argument
11418 into the sequence of arguments that @samp{%o} substitutes.
11420 @item %o
11421 Substitutes the names of all the output files, with spaces
11422 automatically placed around them.  You should write spaces
11423 around the @samp{%o} as well or the results are undefined.
11424 @samp{%o} is for use in the specs for running the linker.
11425 Input files whose names have no recognized suffix are not compiled
11426 at all, but they are included among the output files, so they are
11427 linked.
11429 @item %O
11430 Substitutes the suffix for object files.  Note that this is
11431 handled specially when it immediately follows @samp{%g, %u, or %U},
11432 because of the need for those to form complete file names.  The
11433 handling is such that @samp{%O} is treated exactly as if it had already
11434 been substituted, except that @samp{%g, %u, and %U} do not currently
11435 support additional @var{suffix} characters following @samp{%O} as they do
11436 following, for example, @samp{.o}.
11438 @item %p
11439 Substitutes the standard macro predefinitions for the
11440 current target machine.  Use this when running @code{cpp}.
11442 @item %P
11443 Like @samp{%p}, but puts @samp{__} before and after the name of each
11444 predefined macro, except for macros that start with @samp{__} or with
11445 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11448 @item %I
11449 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11450 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11451 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11452 and @option{-imultilib} as necessary.
11454 @item %s
11455 Current argument is the name of a library or startup file of some sort.
11456 Search for that file in a standard list of directories and substitute
11457 the full name found.  The current working directory is included in the
11458 list of directories scanned.
11460 @item %T
11461 Current argument is the name of a linker script.  Search for that file
11462 in the current list of directories to scan for libraries. If the file
11463 is located insert a @option{--script} option into the command line
11464 followed by the full path name found.  If the file is not found then
11465 generate an error message.  Note: the current working directory is not
11466 searched.
11468 @item %e@var{str}
11469 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11470 Use this when inconsistent options are detected.
11472 @item %(@var{name})
11473 Substitute the contents of spec string @var{name} at this point.
11475 @item %x@{@var{option}@}
11476 Accumulate an option for @samp{%X}.
11478 @item %X
11479 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11480 spec string.
11482 @item %Y
11483 Output the accumulated assembler options specified by @option{-Wa}.
11485 @item %Z
11486 Output the accumulated preprocessor options specified by @option{-Wp}.
11488 @item %a
11489 Process the @code{asm} spec.  This is used to compute the
11490 switches to be passed to the assembler.
11492 @item %A
11493 Process the @code{asm_final} spec.  This is a spec string for
11494 passing switches to an assembler post-processor, if such a program is
11495 needed.
11497 @item %l
11498 Process the @code{link} spec.  This is the spec for computing the
11499 command line passed to the linker.  Typically it makes use of the
11500 @samp{%L %G %S %D and %E} sequences.
11502 @item %D
11503 Dump out a @option{-L} option for each directory that GCC believes might
11504 contain startup files.  If the target supports multilibs then the
11505 current multilib directory is prepended to each of these paths.
11507 @item %L
11508 Process the @code{lib} spec.  This is a spec string for deciding which
11509 libraries are included on the command line to the linker.
11511 @item %G
11512 Process the @code{libgcc} spec.  This is a spec string for deciding
11513 which GCC support library is included on the command line to the linker.
11515 @item %S
11516 Process the @code{startfile} spec.  This is a spec for deciding which
11517 object files are the first ones passed to the linker.  Typically
11518 this might be a file named @file{crt0.o}.
11520 @item %E
11521 Process the @code{endfile} spec.  This is a spec string that specifies
11522 the last object files that are passed to the linker.
11524 @item %C
11525 Process the @code{cpp} spec.  This is used to construct the arguments
11526 to be passed to the C preprocessor.
11528 @item %1
11529 Process the @code{cc1} spec.  This is used to construct the options to be
11530 passed to the actual C compiler (@samp{cc1}).
11532 @item %2
11533 Process the @code{cc1plus} spec.  This is used to construct the options to be
11534 passed to the actual C++ compiler (@samp{cc1plus}).
11536 @item %*
11537 Substitute the variable part of a matched option.  See below.
11538 Note that each comma in the substituted string is replaced by
11539 a single space.
11541 @item %<@code{S}
11542 Remove all occurrences of @code{-S} from the command line.  Note---this
11543 command is position dependent.  @samp{%} commands in the spec string
11544 before this one see @code{-S}, @samp{%} commands in the spec string
11545 after this one do not.
11547 @item %:@var{function}(@var{args})
11548 Call the named function @var{function}, passing it @var{args}.
11549 @var{args} is first processed as a nested spec string, then split
11550 into an argument vector in the usual fashion.  The function returns
11551 a string which is processed as if it had appeared literally as part
11552 of the current spec.
11554 The following built-in spec functions are provided:
11556 @table @code
11557 @item @code{getenv}
11558 The @code{getenv} spec function takes two arguments: an environment
11559 variable name and a string.  If the environment variable is not
11560 defined, a fatal error is issued.  Otherwise, the return value is the
11561 value of the environment variable concatenated with the string.  For
11562 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11564 @smallexample
11565 %:getenv(TOPDIR /include)
11566 @end smallexample
11568 expands to @file{/path/to/top/include}.
11570 @item @code{if-exists}
11571 The @code{if-exists} spec function takes one argument, an absolute
11572 pathname to a file.  If the file exists, @code{if-exists} returns the
11573 pathname.  Here is a small example of its usage:
11575 @smallexample
11576 *startfile:
11577 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11578 @end smallexample
11580 @item @code{if-exists-else}
11581 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11582 spec function, except that it takes two arguments.  The first argument is
11583 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11584 returns the pathname.  If it does not exist, it returns the second argument.
11585 This way, @code{if-exists-else} can be used to select one file or another,
11586 based on the existence of the first.  Here is a small example of its usage:
11588 @smallexample
11589 *startfile:
11590 crt0%O%s %:if-exists(crti%O%s) \
11591 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11592 @end smallexample
11594 @item @code{replace-outfile}
11595 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11596 first argument in the outfiles array and replaces it with the second argument.  Here
11597 is a small example of its usage:
11599 @smallexample
11600 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11601 @end smallexample
11603 @item @code{remove-outfile}
11604 The @code{remove-outfile} spec function takes one argument.  It looks for the
11605 first argument in the outfiles array and removes it.  Here is a small example
11606 its usage:
11608 @smallexample
11609 %:remove-outfile(-lm)
11610 @end smallexample
11612 @item @code{pass-through-libs}
11613 The @code{pass-through-libs} spec function takes any number of arguments.  It
11614 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11615 assumes are the names of linker input library archive files) and returns a
11616 result containing all the found arguments each prepended by
11617 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11618 intended to be passed to the LTO linker plugin.
11620 @smallexample
11621 %:pass-through-libs(%G %L %G)
11622 @end smallexample
11624 @item @code{print-asm-header}
11625 The @code{print-asm-header} function takes no arguments and simply
11626 prints a banner like:
11628 @smallexample
11629 Assembler options
11630 =================
11632 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11633 @end smallexample
11635 It is used to separate compiler options from assembler options
11636 in the @option{--target-help} output.
11637 @end table
11639 @item %@{@code{S}@}
11640 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11641 If that switch is not specified, this substitutes nothing.  Note that
11642 the leading dash is omitted when specifying this option, and it is
11643 automatically inserted if the substitution is performed.  Thus the spec
11644 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11645 and outputs the command-line option @option{-foo}.
11647 @item %W@{@code{S}@}
11648 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11649 deleted on failure.
11651 @item %@{@code{S}*@}
11652 Substitutes all the switches specified to GCC whose names start
11653 with @code{-S}, but which also take an argument.  This is used for
11654 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11655 GCC considers @option{-o foo} as being
11656 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11657 text, including the space.  Thus two arguments are generated.
11659 @item %@{@code{S}*&@code{T}*@}
11660 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11661 (the order of @code{S} and @code{T} in the spec is not significant).
11662 There can be any number of ampersand-separated variables; for each the
11663 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11665 @item %@{@code{S}:@code{X}@}
11666 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11668 @item %@{!@code{S}:@code{X}@}
11669 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11671 @item %@{@code{S}*:@code{X}@}
11672 Substitutes @code{X} if one or more switches whose names start with
11673 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11674 once, no matter how many such switches appeared.  However, if @code{%*}
11675 appears somewhere in @code{X}, then @code{X} is substituted once
11676 for each matching switch, with the @code{%*} replaced by the part of
11677 that switch matching the @code{*}.
11679 If @code{%*} appears as the last part of a spec sequence then a space
11680 will be added after the end of the last substitution.  If there is more
11681 text in the sequence however then a space will not be generated.  This
11682 allows the @code{%*} substitution to be used as part of a larger
11683 string.  For example, a spec string like this:
11685 @smallexample
11686 %@{mcu=*:--script=%*/memory.ld@}
11687 @end smallexample
11689 when matching an option like @code{-mcu=newchip} will produce:
11691 @smallexample
11692 --script=newchip/memory.ld
11693 @end smallexample
11695 @item %@{.@code{S}:@code{X}@}
11696 Substitutes @code{X}, if processing a file with suffix @code{S}.
11698 @item %@{!.@code{S}:@code{X}@}
11699 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11701 @item %@{,@code{S}:@code{X}@}
11702 Substitutes @code{X}, if processing a file for language @code{S}.
11704 @item %@{!,@code{S}:@code{X}@}
11705 Substitutes @code{X}, if not processing a file for language @code{S}.
11707 @item %@{@code{S}|@code{P}:@code{X}@}
11708 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11709 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11710 @code{*} sequences as well, although they have a stronger binding than
11711 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11712 alternatives must be starred, and only the first matching alternative
11713 is substituted.
11715 For example, a spec string like this:
11717 @smallexample
11718 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11719 @end smallexample
11721 @noindent
11722 outputs the following command-line options from the following input
11723 command-line options:
11725 @smallexample
11726 fred.c        -foo -baz
11727 jim.d         -bar -boggle
11728 -d fred.c     -foo -baz -boggle
11729 -d jim.d      -bar -baz -boggle
11730 @end smallexample
11732 @item %@{S:X; T:Y; :D@}
11734 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11735 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11736 be as many clauses as you need.  This may be combined with @code{.},
11737 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11740 @end table
11742 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11743 construct may contain other nested @samp{%} constructs or spaces, or
11744 even newlines.  They are processed as usual, as described above.
11745 Trailing white space in @code{X} is ignored.  White space may also
11746 appear anywhere on the left side of the colon in these constructs,
11747 except between @code{.} or @code{*} and the corresponding word.
11749 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11750 handled specifically in these constructs.  If another value of
11751 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11752 @option{-W} switch is found later in the command line, the earlier
11753 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11754 just one letter, which passes all matching options.
11756 The character @samp{|} at the beginning of the predicate text is used to
11757 indicate that a command should be piped to the following command, but
11758 only if @option{-pipe} is specified.
11760 It is built into GCC which switches take arguments and which do not.
11761 (You might think it would be useful to generalize this to allow each
11762 compiler's spec to say which switches take arguments.  But this cannot
11763 be done in a consistent fashion.  GCC cannot even decide which input
11764 files have been specified without knowing which switches take arguments,
11765 and it must know which input files to compile in order to tell which
11766 compilers to run).
11768 GCC also knows implicitly that arguments starting in @option{-l} are to be
11769 treated as compiler output files, and passed to the linker in their
11770 proper position among the other output files.
11772 @c man begin OPTIONS
11774 @node Target Options
11775 @section Specifying Target Machine and Compiler Version
11776 @cindex target options
11777 @cindex cross compiling
11778 @cindex specifying machine version
11779 @cindex specifying compiler version and target machine
11780 @cindex compiler version, specifying
11781 @cindex target machine, specifying
11783 The usual way to run GCC is to run the executable called @command{gcc}, or
11784 @command{@var{machine}-gcc} when cross-compiling, or
11785 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11786 one that was installed last.
11788 @node Submodel Options
11789 @section Hardware Models and Configurations
11790 @cindex submodel options
11791 @cindex specifying hardware config
11792 @cindex hardware models and configurations, specifying
11793 @cindex machine dependent options
11795 Each target machine types can have its own
11796 special options, starting with @samp{-m}, to choose among various
11797 hardware models or configurations---for example, 68010 vs 68020,
11798 floating coprocessor or none.  A single installed version of the
11799 compiler can compile for any model or configuration, according to the
11800 options specified.
11802 Some configurations of the compiler also support additional special
11803 options, usually for compatibility with other compilers on the same
11804 platform.
11806 @c This list is ordered alphanumerically by subsection name.
11807 @c It should be the same order and spelling as these options are listed
11808 @c in Machine Dependent Options
11810 @menu
11811 * AArch64 Options::
11812 * Adapteva Epiphany Options::
11813 * ARC Options::
11814 * ARM Options::
11815 * AVR Options::
11816 * Blackfin Options::
11817 * C6X Options::
11818 * CRIS Options::
11819 * CR16 Options::
11820 * Darwin Options::
11821 * DEC Alpha Options::
11822 * FR30 Options::
11823 * FRV Options::
11824 * GNU/Linux Options::
11825 * H8/300 Options::
11826 * HPPA Options::
11827 * i386 and x86-64 Options::
11828 * i386 and x86-64 Windows Options::
11829 * IA-64 Options::
11830 * LM32 Options::
11831 * M32C Options::
11832 * M32R/D Options::
11833 * M680x0 Options::
11834 * MCore Options::
11835 * MeP Options::
11836 * MicroBlaze Options::
11837 * MIPS Options::
11838 * MMIX Options::
11839 * MN10300 Options::
11840 * Moxie Options::
11841 * MSP430 Options::
11842 * NDS32 Options::
11843 * Nios II Options::
11844 * PDP-11 Options::
11845 * picoChip Options::
11846 * PowerPC Options::
11847 * RL78 Options::
11848 * RS/6000 and PowerPC Options::
11849 * RX Options::
11850 * S/390 and zSeries Options::
11851 * Score Options::
11852 * SH Options::
11853 * Solaris 2 Options::
11854 * SPARC Options::
11855 * SPU Options::
11856 * System V Options::
11857 * TILE-Gx Options::
11858 * TILEPro Options::
11859 * V850 Options::
11860 * VAX Options::
11861 * VMS Options::
11862 * VxWorks Options::
11863 * x86-64 Options::
11864 * Xstormy16 Options::
11865 * Xtensa Options::
11866 * zSeries Options::
11867 @end menu
11869 @node AArch64 Options
11870 @subsection AArch64 Options
11871 @cindex AArch64 Options
11873 These options are defined for AArch64 implementations:
11875 @table @gcctabopt
11877 @item -mabi=@var{name}
11878 @opindex mabi
11879 Generate code for the specified data model.  Permissible values
11880 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11881 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11882 but long int and pointer are 64-bit.
11884 The default depends on the specific target configuration.  Note that
11885 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11886 entire program with the same ABI, and link with a compatible set of libraries.
11888 @item -mbig-endian
11889 @opindex mbig-endian
11890 Generate big-endian code.  This is the default when GCC is configured for an
11891 @samp{aarch64_be-*-*} target.
11893 @item -mgeneral-regs-only
11894 @opindex mgeneral-regs-only
11895 Generate code which uses only the general registers.
11897 @item -mlittle-endian
11898 @opindex mlittle-endian
11899 Generate little-endian code.  This is the default when GCC is configured for an
11900 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11902 @item -mcmodel=tiny
11903 @opindex mcmodel=tiny
11904 Generate code for the tiny code model.  The program and its statically defined
11905 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11906 be statically or dynamically linked.  This model is not fully implemented and
11907 mostly treated as @samp{small}.
11909 @item -mcmodel=small
11910 @opindex mcmodel=small
11911 Generate code for the small code model.  The program and its statically defined
11912 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11913 be statically or dynamically linked.  This is the default code model.
11915 @item -mcmodel=large
11916 @opindex mcmodel=large
11917 Generate code for the large code model.  This makes no assumptions about
11918 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11919 statically linked only.
11921 @item -mstrict-align
11922 @opindex mstrict-align
11923 Do not assume that unaligned memory references will be handled by the system.
11925 @item -momit-leaf-frame-pointer
11926 @itemx -mno-omit-leaf-frame-pointer
11927 @opindex momit-leaf-frame-pointer
11928 @opindex mno-omit-leaf-frame-pointer
11929 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11930 default.
11932 @item -mtls-dialect=desc
11933 @opindex mtls-dialect=desc
11934 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11935 of TLS variables.  This is the default.
11937 @item -mtls-dialect=traditional
11938 @opindex mtls-dialect=traditional
11939 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11940 of TLS variables.
11942 @item -mfix-cortex-a53-835769
11943 @itemx -mno-fix-cortex-a53-835769
11944 @opindex -mfix-cortex-a53-835769
11945 @opindex -mno-fix-cortex-a53-835769
11946 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
11947 This will involve inserting a NOP instruction between memory instructions and
11948 64-bit integer multiply-accumulate instructions.
11950 @item -march=@var{name}
11951 @opindex march
11952 Specify the name of the target architecture, optionally suffixed by one or
11953 more feature modifiers.  This option has the form
11954 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11955 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11956 values for @var{feature} are documented in the sub-section below.
11958 Where conflicting feature modifiers are specified, the right-most feature is
11959 used.
11961 GCC uses this name to determine what kind of instructions it can emit when
11962 generating assembly code.
11964 Where @option{-march} is specified without either of @option{-mtune}
11965 or @option{-mcpu} also being specified, the code will be tuned to perform
11966 well across a range of target processors implementing the target
11967 architecture.
11969 @item -mtune=@var{name}
11970 @opindex mtune
11971 Specify the name of the target processor for which GCC should tune the
11972 performance of the code.  Permissible values for this option are:
11973 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{thunderx}.
11975 Additionally, this option can specify that GCC should tune the performance
11976 of the code for a big.LITTLE system.  The only permissible value is
11977 @samp{cortex-a57.cortex-a53}.
11979 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
11980 are specified, the code will be tuned to perform well across a range
11981 of target processors.
11983 This option cannot be suffixed by feature modifiers.
11985 @item -mcpu=@var{name}
11986 @opindex mcpu
11987 Specify the name of the target processor, optionally suffixed by one or more
11988 feature modifiers.  This option has the form
11989 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11990 permissible values for @var{cpu} are the same as those available for
11991 @option{-mtune}.
11993 The permissible values for @var{feature} are documented in the sub-section
11994 below.
11996 Where conflicting feature modifiers are specified, the right-most feature is
11997 used.
11999 GCC uses this name to determine what kind of instructions it can emit when
12000 generating assembly code (as if by @option{-march}) and to determine
12001 the target processor for which to tune for performance (as if
12002 by @option{-mtune}).  Where this option is used in conjunction
12003 with @option{-march} or @option{-mtune}, those options take precedence
12004 over the appropriate part of this option.
12005 @end table
12007 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
12008 @cindex @option{-march} feature modifiers
12009 @cindex @option{-mcpu} feature modifiers
12010 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
12011 the following:
12013 @table @samp
12014 @item crc
12015 Enable CRC extension.
12016 @item crypto
12017 Enable Crypto extension.  This implies Advanced SIMD is enabled.
12018 @item fp
12019 Enable floating-point instructions.
12020 @item simd
12021 Enable Advanced SIMD instructions.  This implies floating-point instructions
12022 are enabled.  This is the default for all current possible values for options
12023 @option{-march} and @option{-mcpu=}.
12024 @end table
12026 @node Adapteva Epiphany Options
12027 @subsection Adapteva Epiphany Options
12029 These @samp{-m} options are defined for Adapteva Epiphany:
12031 @table @gcctabopt
12032 @item -mhalf-reg-file
12033 @opindex mhalf-reg-file
12034 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12035 That allows code to run on hardware variants that lack these registers.
12037 @item -mprefer-short-insn-regs
12038 @opindex mprefer-short-insn-regs
12039 Preferrentially allocate registers that allow short instruction generation.
12040 This can result in increased instruction count, so this may either reduce or
12041 increase overall code size.
12043 @item -mbranch-cost=@var{num}
12044 @opindex mbranch-cost
12045 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12046 This cost is only a heuristic and is not guaranteed to produce
12047 consistent results across releases.
12049 @item -mcmove
12050 @opindex mcmove
12051 Enable the generation of conditional moves.
12053 @item -mnops=@var{num}
12054 @opindex mnops
12055 Emit @var{num} NOPs before every other generated instruction.
12057 @item -mno-soft-cmpsf
12058 @opindex mno-soft-cmpsf
12059 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12060 and test the flags.  This is faster than a software comparison, but can
12061 get incorrect results in the presence of NaNs, or when two different small
12062 numbers are compared such that their difference is calculated as zero.
12063 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12064 software comparisons.
12066 @item -mstack-offset=@var{num}
12067 @opindex mstack-offset
12068 Set the offset between the top of the stack and the stack pointer.
12069 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12070 can be used by leaf functions without stack allocation.
12071 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12072 Note also that this option changes the ABI; compiling a program with a
12073 different stack offset than the libraries have been compiled with
12074 generally does not work.
12075 This option can be useful if you want to evaluate if a different stack
12076 offset would give you better code, but to actually use a different stack
12077 offset to build working programs, it is recommended to configure the
12078 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12080 @item -mno-round-nearest
12081 @opindex mno-round-nearest
12082 Make the scheduler assume that the rounding mode has been set to
12083 truncating.  The default is @option{-mround-nearest}.
12085 @item -mlong-calls
12086 @opindex mlong-calls
12087 If not otherwise specified by an attribute, assume all calls might be beyond
12088 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12089 function address into a register before performing a (otherwise direct) call.
12090 This is the default.
12092 @item -mshort-calls
12093 @opindex short-calls
12094 If not otherwise specified by an attribute, assume all direct calls are
12095 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12096 for direct calls.  The default is @option{-mlong-calls}.
12098 @item -msmall16
12099 @opindex msmall16
12100 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12101 apply to function addresses for which @option{-mlong-calls} semantics
12102 are in effect.
12104 @item -mfp-mode=@var{mode}
12105 @opindex mfp-mode
12106 Set the prevailing mode of the floating-point unit.
12107 This determines the floating-point mode that is provided and expected
12108 at function call and return time.  Making this mode match the mode you
12109 predominantly need at function start can make your programs smaller and
12110 faster by avoiding unnecessary mode switches.
12112 @var{mode} can be set to one the following values:
12114 @table @samp
12115 @item caller
12116 Any mode at function entry is valid, and retained or restored when
12117 the function returns, and when it calls other functions.
12118 This mode is useful for compiling libraries or other compilation units
12119 you might want to incorporate into different programs with different
12120 prevailing FPU modes, and the convenience of being able to use a single
12121 object file outweighs the size and speed overhead for any extra
12122 mode switching that might be needed, compared with what would be needed
12123 with a more specific choice of prevailing FPU mode.
12125 @item truncate
12126 This is the mode used for floating-point calculations with
12127 truncating (i.e.@: round towards zero) rounding mode.  That includes
12128 conversion from floating point to integer.
12130 @item round-nearest
12131 This is the mode used for floating-point calculations with
12132 round-to-nearest-or-even rounding mode.
12134 @item int
12135 This is the mode used to perform integer calculations in the FPU, e.g.@:
12136 integer multiply, or integer multiply-and-accumulate.
12137 @end table
12139 The default is @option{-mfp-mode=caller}
12141 @item -mnosplit-lohi
12142 @itemx -mno-postinc
12143 @itemx -mno-postmodify
12144 @opindex mnosplit-lohi
12145 @opindex mno-postinc
12146 @opindex mno-postmodify
12147 Code generation tweaks that disable, respectively, splitting of 32-bit
12148 loads, generation of post-increment addresses, and generation of
12149 post-modify addresses.  The defaults are @option{msplit-lohi},
12150 @option{-mpost-inc}, and @option{-mpost-modify}.
12152 @item -mnovect-double
12153 @opindex mno-vect-double
12154 Change the preferred SIMD mode to SImode.  The default is
12155 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12157 @item -max-vect-align=@var{num}
12158 @opindex max-vect-align
12159 The maximum alignment for SIMD vector mode types.
12160 @var{num} may be 4 or 8.  The default is 8.
12161 Note that this is an ABI change, even though many library function
12162 interfaces are unaffected if they don't use SIMD vector modes
12163 in places that affect size and/or alignment of relevant types.
12165 @item -msplit-vecmove-early
12166 @opindex msplit-vecmove-early
12167 Split vector moves into single word moves before reload.  In theory this
12168 can give better register allocation, but so far the reverse seems to be
12169 generally the case.
12171 @item -m1reg-@var{reg}
12172 @opindex m1reg-
12173 Specify a register to hold the constant @minus{}1, which makes loading small negative
12174 constants and certain bitmasks faster.
12175 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12176 which specify use of that register as a fixed register,
12177 and @samp{none}, which means that no register is used for this
12178 purpose.  The default is @option{-m1reg-none}.
12180 @end table
12182 @node ARC Options
12183 @subsection ARC Options
12184 @cindex ARC options
12186 The following options control the architecture variant for which code
12187 is being compiled:
12189 @c architecture variants
12190 @table @gcctabopt
12192 @item -mbarrel-shifter
12193 @opindex mbarrel-shifter
12194 Generate instructions supported by barrel shifter.  This is the default
12195 unless @samp{-mcpu=ARC601} is in effect.
12197 @item -mcpu=@var{cpu}
12198 @opindex mcpu
12199 Set architecture type, register usage, and instruction scheduling
12200 parameters for @var{cpu}.  There are also shortcut alias options
12201 available for backward compatibility and convenience.  Supported
12202 values for @var{cpu} are
12204 @table @samp
12205 @opindex mA6
12206 @opindex mARC600
12207 @item ARC600
12208 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12210 @item ARC601
12211 @opindex mARC601
12212 Compile for ARC601.  Alias: @option{-mARC601}.
12214 @item ARC700
12215 @opindex mA7
12216 @opindex mARC700
12217 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12218 This is the default when configured with @samp{--with-cpu=arc700}@.
12219 @end table
12221 @item -mdpfp
12222 @opindex mdpfp
12223 @itemx -mdpfp-compact
12224 @opindex mdpfp-compact
12225 FPX: Generate Double Precision FPX instructions, tuned for the compact
12226 implementation.
12228 @item -mdpfp-fast
12229 @opindex mdpfp-fast
12230 FPX: Generate Double Precision FPX instructions, tuned for the fast
12231 implementation.
12233 @item -mno-dpfp-lrsr
12234 @opindex mno-dpfp-lrsr
12235 Disable LR and SR instructions from using FPX extension aux registers.
12237 @item -mea
12238 @opindex mea
12239 Generate Extended arithmetic instructions.  Currently only
12240 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12241 supported.  This is always enabled for @samp{-mcpu=ARC700}.
12243 @item -mno-mpy
12244 @opindex mno-mpy
12245 Do not generate mpy instructions for ARC700.
12247 @item -mmul32x16
12248 @opindex mmul32x16
12249 Generate 32x16 bit multiply and mac instructions.
12251 @item -mmul64
12252 @opindex mmul64
12253 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
12255 @item -mnorm
12256 @opindex mnorm
12257 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
12258 is in effect.
12260 @item -mspfp
12261 @opindex mspfp
12262 @itemx -mspfp-compact
12263 @opindex mspfp-compact
12264 FPX: Generate Single Precision FPX instructions, tuned for the compact
12265 implementation.
12267 @item -mspfp-fast
12268 @opindex mspfp-fast
12269 FPX: Generate Single Precision FPX instructions, tuned for the fast
12270 implementation.
12272 @item -msimd
12273 @opindex msimd
12274 Enable generation of ARC SIMD instructions via target-specific
12275 builtins.  Only valid for @samp{-mcpu=ARC700}.
12277 @item -msoft-float
12278 @opindex msoft-float
12279 This option ignored; it is provided for compatibility purposes only.
12280 Software floating point code is emitted by default, and this default
12281 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12282 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12283 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12285 @item -mswap
12286 @opindex mswap
12287 Generate swap instructions.
12289 @end table
12291 The following options are passed through to the assembler, and also
12292 define preprocessor macro symbols.
12294 @c Flags used by the assembler, but for which we define preprocessor
12295 @c macro symbols as well.
12296 @table @gcctabopt
12297 @item -mdsp-packa
12298 @opindex mdsp-packa
12299 Passed down to the assembler to enable the DSP Pack A extensions.
12300 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12302 @item -mdvbf
12303 @opindex mdvbf
12304 Passed down to the assembler to enable the dual viterbi butterfly
12305 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12307 @c ARC700 4.10 extension instruction
12308 @item -mlock
12309 @opindex mlock
12310 Passed down to the assembler to enable the Locked Load/Store
12311 Conditional extension.  Also sets the preprocessor symbol
12312 @code{__Xlock}.
12314 @item -mmac-d16
12315 @opindex mmac-d16
12316 Passed down to the assembler.  Also sets the preprocessor symbol
12317 @code{__Xxmac_d16}.
12319 @item -mmac-24
12320 @opindex mmac-24
12321 Passed down to the assembler.  Also sets the preprocessor symbol
12322 @code{__Xxmac_24}.
12324 @c ARC700 4.10 extension instruction
12325 @item -mrtsc
12326 @opindex mrtsc
12327 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12328 extension instruction.  Also sets the preprocessor symbol
12329 @code{__Xrtsc}.
12331 @c ARC700 4.10 extension instruction
12332 @item -mswape
12333 @opindex mswape
12334 Passed down to the assembler to enable the swap byte ordering
12335 extension instruction.  Also sets the preprocessor symbol
12336 @code{__Xswape}.
12338 @item -mtelephony
12339 @opindex mtelephony
12340 Passed down to the assembler to enable dual and single operand
12341 instructions for telephony.  Also sets the preprocessor symbol
12342 @code{__Xtelephony}.
12344 @item -mxy
12345 @opindex mxy
12346 Passed down to the assembler to enable the XY Memory extension.  Also
12347 sets the preprocessor symbol @code{__Xxy}.
12349 @end table
12351 The following options control how the assembly code is annotated:
12353 @c Assembly annotation options
12354 @table @gcctabopt
12355 @item -misize
12356 @opindex misize
12357 Annotate assembler instructions with estimated addresses.
12359 @item -mannotate-align
12360 @opindex mannotate-align
12361 Explain what alignment considerations lead to the decision to make an
12362 instruction short or long.
12364 @end table
12366 The following options are passed through to the linker:
12368 @c options passed through to the linker
12369 @table @gcctabopt
12370 @item -marclinux
12371 @opindex marclinux
12372 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12373 This option is enabled by default in tool chains built for
12374 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12375 when profiling is not requested.
12377 @item -marclinux_prof
12378 @opindex marclinux_prof
12379 Passed through to the linker, to specify use of the
12380 @code{arclinux_prof} emulation.  This option is enabled by default in
12381 tool chains built for @w{@code{arc-linux-uclibc}} and
12382 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12384 @end table
12386 The following options control the semantics of generated code:
12388 @c semantically relevant code generation options
12389 @table @gcctabopt
12390 @item -mepilogue-cfi
12391 @opindex mepilogue-cfi
12392 Enable generation of call frame information for epilogues.
12394 @item -mno-epilogue-cfi
12395 @opindex mno-epilogue-cfi
12396 Disable generation of call frame information for epilogues.
12398 @item -mlong-calls
12399 @opindex mlong-calls
12400 Generate call insns as register indirect calls, thus providing access
12401 to the full 32-bit address range.
12403 @item -mmedium-calls
12404 @opindex mmedium-calls
12405 Don't use less than 25 bit addressing range for calls, which is the
12406 offset available for an unconditional branch-and-link
12407 instruction.  Conditional execution of function calls is suppressed, to
12408 allow use of the 25-bit range, rather than the 21-bit range with
12409 conditional branch-and-link.  This is the default for tool chains built
12410 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12412 @item -mno-sdata
12413 @opindex mno-sdata
12414 Do not generate sdata references.  This is the default for tool chains
12415 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12416 targets.
12418 @item -mucb-mcount
12419 @opindex mucb-mcount
12420 Instrument with mcount calls as used in UCB code.  I.e. do the
12421 counting in the callee, not the caller.  By default ARC instrumentation
12422 counts in the caller.
12424 @item -mvolatile-cache
12425 @opindex mvolatile-cache
12426 Use ordinarily cached memory accesses for volatile references.  This is the
12427 default.
12429 @item -mno-volatile-cache
12430 @opindex mno-volatile-cache
12431 Enable cache bypass for volatile references.
12433 @end table
12435 The following options fine tune code generation:
12436 @c code generation tuning options
12437 @table @gcctabopt
12438 @item -malign-call
12439 @opindex malign-call
12440 Do alignment optimizations for call instructions.
12442 @item -mauto-modify-reg
12443 @opindex mauto-modify-reg
12444 Enable the use of pre/post modify with register displacement.
12446 @item -mbbit-peephole
12447 @opindex mbbit-peephole
12448 Enable bbit peephole2.
12450 @item -mno-brcc
12451 @opindex mno-brcc
12452 This option disables a target-specific pass in @file{arc_reorg} to
12453 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12454 generation driven by the combiner pass.
12456 @item -mcase-vector-pcrel
12457 @opindex mcase-vector-pcrel
12458 Use pc-relative switch case tables - this enables case table shortening.
12459 This is the default for @option{-Os}.
12461 @item -mcompact-casesi
12462 @opindex mcompact-casesi
12463 Enable compact casesi pattern.
12464 This is the default for @option{-Os}.
12466 @item -mno-cond-exec
12467 @opindex mno-cond-exec
12468 Disable ARCompact specific pass to generate conditional execution instructions.
12469 Due to delay slot scheduling and interactions between operand numbers,
12470 literal sizes, instruction lengths, and the support for conditional execution,
12471 the target-independent pass to generate conditional execution is often lacking,
12472 so the ARC port has kept a special pass around that tries to find more
12473 conditional execution generating opportunities after register allocation,
12474 branch shortening, and delay slot scheduling have been done.  This pass
12475 generally, but not always, improves performance and code size, at the cost of
12476 extra compilation time, which is why there is an option to switch it off.
12477 If you have a problem with call instructions exceeding their allowable
12478 offset range because they are conditionalized, you should consider using
12479 @option{-mmedium-calls} instead.
12481 @item -mearly-cbranchsi
12482 @opindex mearly-cbranchsi
12483 Enable pre-reload use of the cbranchsi pattern.
12485 @item -mexpand-adddi
12486 @opindex mexpand-adddi
12487 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12488 @code{add.f}, @code{adc} etc.
12490 @item -mindexed-loads
12491 @opindex mindexed-loads
12492 Enable the use of indexed loads.  This can be problematic because some
12493 optimizers will then assume the that indexed stores exist, which is not
12494 the case.
12496 @item -mlra
12497 @opindex mlra
12498 Enable Local Register Allocation.  This is still experimental for ARC,
12499 so by default the compiler uses standard reload
12500 (i.e. @samp{-mno-lra}).
12502 @item -mlra-priority-none
12503 @opindex mlra-priority-none
12504 Don't indicate any priority for target registers.
12506 @item -mlra-priority-compact
12507 @opindex mlra-priority-compact
12508 Indicate target register priority for r0..r3 / r12..r15.
12510 @item -mlra-priority-noncompact
12511 @opindex mlra-priority-noncompact
12512 Reduce target regsiter priority for r0..r3 / r12..r15.
12514 @item -mno-millicode
12515 @opindex mno-millicode
12516 When optimizing for size (using @option{-Os}), prologues and epilogues
12517 that have to save or restore a large number of registers are often
12518 shortened by using call to a special function in libgcc; this is
12519 referred to as a @emph{millicode} call.  As these calls can pose
12520 performance issues, and/or cause linking issues when linking in a
12521 nonstandard way, this option is provided to turn off millicode call
12522 generation.
12524 @item -mmixed-code
12525 @opindex mmixed-code
12526 Tweak register allocation to help 16-bit instruction generation.
12527 This generally has the effect of decreasing the average instruction size
12528 while increasing the instruction count.
12530 @item -mq-class
12531 @opindex mq-class
12532 Enable 'q' instruction alternatives.
12533 This is the default for @option{-Os}.
12535 @item -mRcq
12536 @opindex mRcq
12537 Enable Rcq constraint handling - most short code generation depends on this.
12538 This is the default.
12540 @item -mRcw
12541 @opindex mRcw
12542 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12543 This is the default.
12545 @item -msize-level=@var{level}
12546 @opindex msize-level
12547 Fine-tune size optimization with regards to instruction lengths and alignment.
12548 The recognized values for @var{level} are:
12549 @table @samp
12550 @item 0
12551 No size optimization.  This level is deprecated and treated like @samp{1}.
12553 @item 1
12554 Short instructions are used opportunistically.
12556 @item 2
12557 In addition, alignment of loops and of code after barriers are dropped.
12559 @item 3
12560 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12562 @end table
12564 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12565 the behavior when this is not set is equivalent to level @samp{1}.
12567 @item -mtune=@var{cpu}
12568 @opindex mtune
12569 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12570 by @option{-mcpu=}.
12572 Supported values for @var{cpu} are
12574 @table @samp
12575 @item ARC600
12576 Tune for ARC600 cpu.
12578 @item ARC601
12579 Tune for ARC601 cpu.
12581 @item ARC700
12582 Tune for ARC700 cpu with standard multiplier block.
12584 @item ARC700-xmac
12585 Tune for ARC700 cpu with XMAC block.
12587 @item ARC725D
12588 Tune for ARC725D cpu.
12590 @item ARC750D
12591 Tune for ARC750D cpu.
12593 @end table
12595 @item -mmultcost=@var{num}
12596 @opindex mmultcost
12597 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12598 normal instruction.
12600 @item -munalign-prob-threshold=@var{probability}
12601 @opindex munalign-prob-threshold
12602 Set probability threshold for unaligning branches.
12603 When tuning for @samp{ARC700} and optimizing for speed, branches without
12604 filled delay slot are preferably emitted unaligned and long, unless
12605 profiling indicates that the probability for the branch to be taken
12606 is below @var{probability}.  @xref{Cross-profiling}.
12607 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12609 @end table
12611 The following options are maintained for backward compatibility, but
12612 are now deprecated and will be removed in a future release:
12614 @c Deprecated options
12615 @table @gcctabopt
12617 @item -margonaut
12618 @opindex margonaut
12619 Obsolete FPX.
12621 @item -mbig-endian
12622 @opindex mbig-endian
12623 @itemx -EB
12624 @opindex EB
12625 Compile code for big endian targets.  Use of these options is now
12626 deprecated.  Users wanting big-endian code, should use the
12627 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12628 building the tool chain, for which big-endian is the default.
12630 @item -mlittle-endian
12631 @opindex mlittle-endian
12632 @itemx -EL
12633 @opindex EL
12634 Compile code for little endian targets.  Use of these options is now
12635 deprecated.  Users wanting little-endian code should use the
12636 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12637 building the tool chain, for which little-endian is the default.
12639 @item -mbarrel_shifter
12640 @opindex mbarrel_shifter
12641 Replaced by @samp{-mbarrel-shifter}
12643 @item -mdpfp_compact
12644 @opindex mdpfp_compact
12645 Replaced by @samp{-mdpfp-compact}
12647 @item -mdpfp_fast
12648 @opindex mdpfp_fast
12649 Replaced by @samp{-mdpfp-fast}
12651 @item -mdsp_packa
12652 @opindex mdsp_packa
12653 Replaced by @samp{-mdsp-packa}
12655 @item -mEA
12656 @opindex mEA
12657 Replaced by @samp{-mea}
12659 @item -mmac_24
12660 @opindex mmac_24
12661 Replaced by @samp{-mmac-24}
12663 @item -mmac_d16
12664 @opindex mmac_d16
12665 Replaced by @samp{-mmac-d16}
12667 @item -mspfp_compact
12668 @opindex mspfp_compact
12669 Replaced by @samp{-mspfp-compact}
12671 @item -mspfp_fast
12672 @opindex mspfp_fast
12673 Replaced by @samp{-mspfp-fast}
12675 @item -mtune=@var{cpu}
12676 @opindex mtune
12677 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12678 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12679 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12681 @item -multcost=@var{num}
12682 @opindex multcost
12683 Replaced by @samp{-mmultcost}.
12685 @end table
12687 @node ARM Options
12688 @subsection ARM Options
12689 @cindex ARM options
12691 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
12692 architectures:
12694 @table @gcctabopt
12695 @item -mabi=@var{name}
12696 @opindex mabi
12697 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12698 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12700 @item -mapcs-frame
12701 @opindex mapcs-frame
12702 Generate a stack frame that is compliant with the ARM Procedure Call
12703 Standard for all functions, even if this is not strictly necessary for
12704 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12705 with this option causes the stack frames not to be generated for
12706 leaf functions.  The default is @option{-mno-apcs-frame}.
12708 @item -mapcs
12709 @opindex mapcs
12710 This is a synonym for @option{-mapcs-frame}.
12712 @ignore
12713 @c not currently implemented
12714 @item -mapcs-stack-check
12715 @opindex mapcs-stack-check
12716 Generate code to check the amount of stack space available upon entry to
12717 every function (that actually uses some stack space).  If there is
12718 insufficient space available then either the function
12719 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12720 called, depending upon the amount of stack space required.  The runtime
12721 system is required to provide these functions.  The default is
12722 @option{-mno-apcs-stack-check}, since this produces smaller code.
12724 @c not currently implemented
12725 @item -mapcs-float
12726 @opindex mapcs-float
12727 Pass floating-point arguments using the floating-point registers.  This is
12728 one of the variants of the APCS@.  This option is recommended if the
12729 target hardware has a floating-point unit or if a lot of floating-point
12730 arithmetic is going to be performed by the code.  The default is
12731 @option{-mno-apcs-float}, since the size of integer-only code is 
12732 slightly increased if @option{-mapcs-float} is used.
12734 @c not currently implemented
12735 @item -mapcs-reentrant
12736 @opindex mapcs-reentrant
12737 Generate reentrant, position-independent code.  The default is
12738 @option{-mno-apcs-reentrant}.
12739 @end ignore
12741 @item -mthumb-interwork
12742 @opindex mthumb-interwork
12743 Generate code that supports calling between the ARM and Thumb
12744 instruction sets.  Without this option, on pre-v5 architectures, the
12745 two instruction sets cannot be reliably used inside one program.  The
12746 default is @option{-mno-thumb-interwork}, since slightly larger code
12747 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12748 configurations this option is meaningless.
12750 @item -mno-sched-prolog
12751 @opindex mno-sched-prolog
12752 Prevent the reordering of instructions in the function prologue, or the
12753 merging of those instruction with the instructions in the function's
12754 body.  This means that all functions start with a recognizable set
12755 of instructions (or in fact one of a choice from a small set of
12756 different function prologues), and this information can be used to
12757 locate the start of functions inside an executable piece of code.  The
12758 default is @option{-msched-prolog}.
12760 @item -mfloat-abi=@var{name}
12761 @opindex mfloat-abi
12762 Specifies which floating-point ABI to use.  Permissible values
12763 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12765 Specifying @samp{soft} causes GCC to generate output containing
12766 library calls for floating-point operations.
12767 @samp{softfp} allows the generation of code using hardware floating-point
12768 instructions, but still uses the soft-float calling conventions.
12769 @samp{hard} allows generation of floating-point instructions
12770 and uses FPU-specific calling conventions.
12772 The default depends on the specific target configuration.  Note that
12773 the hard-float and soft-float ABIs are not link-compatible; you must
12774 compile your entire program with the same ABI, and link with a
12775 compatible set of libraries.
12777 @item -mlittle-endian
12778 @opindex mlittle-endian
12779 Generate code for a processor running in little-endian mode.  This is
12780 the default for all standard configurations.
12782 @item -mbig-endian
12783 @opindex mbig-endian
12784 Generate code for a processor running in big-endian mode; the default is
12785 to compile code for a little-endian processor.
12787 @item -march=@var{name}
12788 @opindex march
12789 This specifies the name of the target ARM architecture.  GCC uses this
12790 name to determine what kind of instructions it can emit when generating
12791 assembly code.  This option can be used in conjunction with or instead
12792 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12793 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12794 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12795 @samp{armv6}, @samp{armv6j},
12796 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12797 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12798 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12799 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12801 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12802 extensions.
12804 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12805 architecture together with the optional CRC32 extensions.
12807 @option{-march=native} causes the compiler to auto-detect the architecture
12808 of the build computer.  At present, this feature is only supported on
12809 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12810 is unsuccessful the option has no effect.
12812 @item -mtune=@var{name}
12813 @opindex mtune
12814 This option specifies the name of the target ARM processor for
12815 which GCC should tune the performance of the code.
12816 For some ARM implementations better performance can be obtained by using
12817 this option.
12818 Permissible names are: @samp{arm2}, @samp{arm250},
12819 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12820 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12821 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12822 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12823 @samp{arm720},
12824 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12825 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12826 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12827 @samp{strongarm1110},
12828 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12829 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12830 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12831 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12832 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12833 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12834 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12835 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12836 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12837 @samp{cortex-r4},
12838 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12839 @samp{cortex-m4},
12840 @samp{cortex-m3},
12841 @samp{cortex-m1},
12842 @samp{cortex-m0},
12843 @samp{cortex-m0plus},
12844 @samp{cortex-m1.small-multiply},
12845 @samp{cortex-m0.small-multiply},
12846 @samp{cortex-m0plus.small-multiply},
12847 @samp{marvell-pj4},
12848 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12849 @samp{fa526}, @samp{fa626},
12850 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12852 Additionally, this option can specify that GCC should tune the performance
12853 of the code for a big.LITTLE system.  Permissible names are:
12854 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12856 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12857 performance for a blend of processors within architecture @var{arch}.
12858 The aim is to generate code that run well on the current most popular
12859 processors, balancing between optimizations that benefit some CPUs in the
12860 range, and avoiding performance pitfalls of other CPUs.  The effects of
12861 this option may change in future GCC versions as CPU models come and go.
12863 @option{-mtune=native} causes the compiler to auto-detect the CPU
12864 of the build computer.  At present, this feature is only supported on
12865 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12866 unsuccessful the option has no effect.
12868 @item -mcpu=@var{name}
12869 @opindex mcpu
12870 This specifies the name of the target ARM processor.  GCC uses this name
12871 to derive the name of the target ARM architecture (as if specified
12872 by @option{-march}) and the ARM processor type for which to tune for
12873 performance (as if specified by @option{-mtune}).  Where this option
12874 is used in conjunction with @option{-march} or @option{-mtune},
12875 those options take precedence over the appropriate part of this option.
12877 Permissible names for this option are the same as those for
12878 @option{-mtune}.
12880 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12881 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12882 See @option{-mtune} for more information.
12884 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12885 of the build computer.  At present, this feature is only supported on
12886 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12887 is unsuccessful the option has no effect.
12889 @item -mfpu=@var{name}
12890 @opindex mfpu
12891 This specifies what floating-point hardware (or hardware emulation) is
12892 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12893 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12894 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12895 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12896 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12897 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12899 If @option{-msoft-float} is specified this specifies the format of
12900 floating-point values.
12902 If the selected floating-point hardware includes the NEON extension
12903 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12904 operations are not generated by GCC's auto-vectorization pass unless
12905 @option{-funsafe-math-optimizations} is also specified.  This is
12906 because NEON hardware does not fully implement the IEEE 754 standard for
12907 floating-point arithmetic (in particular denormal values are treated as
12908 zero), so the use of NEON instructions may lead to a loss of precision.
12910 @item -mfp16-format=@var{name}
12911 @opindex mfp16-format
12912 Specify the format of the @code{__fp16} half-precision floating-point type.
12913 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12914 the default is @samp{none}, in which case the @code{__fp16} type is not
12915 defined.  @xref{Half-Precision}, for more information.
12917 @item -mstructure-size-boundary=@var{n}
12918 @opindex mstructure-size-boundary
12919 The sizes of all structures and unions are rounded up to a multiple
12920 of the number of bits set by this option.  Permissible values are 8, 32
12921 and 64.  The default value varies for different toolchains.  For the COFF
12922 targeted toolchain the default value is 8.  A value of 64 is only allowed
12923 if the underlying ABI supports it.
12925 Specifying a larger number can produce faster, more efficient code, but
12926 can also increase the size of the program.  Different values are potentially
12927 incompatible.  Code compiled with one value cannot necessarily expect to
12928 work with code or libraries compiled with another value, if they exchange
12929 information using structures or unions.
12931 @item -mabort-on-noreturn
12932 @opindex mabort-on-noreturn
12933 Generate a call to the function @code{abort} at the end of a
12934 @code{noreturn} function.  It is executed if the function tries to
12935 return.
12937 @item -mlong-calls
12938 @itemx -mno-long-calls
12939 @opindex mlong-calls
12940 @opindex mno-long-calls
12941 Tells the compiler to perform function calls by first loading the
12942 address of the function into a register and then performing a subroutine
12943 call on this register.  This switch is needed if the target function
12944 lies outside of the 64-megabyte addressing range of the offset-based
12945 version of subroutine call instruction.
12947 Even if this switch is enabled, not all function calls are turned
12948 into long calls.  The heuristic is that static functions, functions
12949 that have the @samp{short-call} attribute, functions that are inside
12950 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12951 definitions have already been compiled within the current compilation
12952 unit are not turned into long calls.  The exceptions to this rule are
12953 that weak function definitions, functions with the @samp{long-call}
12954 attribute or the @samp{section} attribute, and functions that are within
12955 the scope of a @samp{#pragma long_calls} directive are always
12956 turned into long calls.
12958 This feature is not enabled by default.  Specifying
12959 @option{-mno-long-calls} restores the default behavior, as does
12960 placing the function calls within the scope of a @samp{#pragma
12961 long_calls_off} directive.  Note these switches have no effect on how
12962 the compiler generates code to handle function calls via function
12963 pointers.
12965 @item -msingle-pic-base
12966 @opindex msingle-pic-base
12967 Treat the register used for PIC addressing as read-only, rather than
12968 loading it in the prologue for each function.  The runtime system is
12969 responsible for initializing this register with an appropriate value
12970 before execution begins.
12972 @item -mpic-register=@var{reg}
12973 @opindex mpic-register
12974 Specify the register to be used for PIC addressing.
12975 For standard PIC base case, the default will be any suitable register
12976 determined by compiler.  For single PIC base case, the default is
12977 @samp{R9} if target is EABI based or stack-checking is enabled,
12978 otherwise the default is @samp{R10}.
12980 @item -mpic-data-is-text-relative
12981 @opindex mpic-data-is-text-relative
12982 Assume that each data segments are relative to text segment at load time.
12983 Therefore, it permits addressing data using PC-relative operations.
12984 This option is on by default for targets other than VxWorks RTP.
12986 @item -mpoke-function-name
12987 @opindex mpoke-function-name
12988 Write the name of each function into the text section, directly
12989 preceding the function prologue.  The generated code is similar to this:
12991 @smallexample
12992      t0
12993          .ascii "arm_poke_function_name", 0
12994          .align
12995      t1
12996          .word 0xff000000 + (t1 - t0)
12997      arm_poke_function_name
12998          mov     ip, sp
12999          stmfd   sp!, @{fp, ip, lr, pc@}
13000          sub     fp, ip, #4
13001 @end smallexample
13003 When performing a stack backtrace, code can inspect the value of
13004 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13005 location @code{pc - 12} and the top 8 bits are set, then we know that
13006 there is a function name embedded immediately preceding this location
13007 and has length @code{((pc[-3]) & 0xff000000)}.
13009 @item -mthumb
13010 @itemx -marm
13011 @opindex marm
13012 @opindex mthumb
13014 Select between generating code that executes in ARM and Thumb
13015 states.  The default for most configurations is to generate code
13016 that executes in ARM state, but the default can be changed by
13017 configuring GCC with the @option{--with-mode=}@var{state}
13018 configure option.
13020 @item -mtpcs-frame
13021 @opindex mtpcs-frame
13022 Generate a stack frame that is compliant with the Thumb Procedure Call
13023 Standard for all non-leaf functions.  (A leaf function is one that does
13024 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13026 @item -mtpcs-leaf-frame
13027 @opindex mtpcs-leaf-frame
13028 Generate a stack frame that is compliant with the Thumb Procedure Call
13029 Standard for all leaf functions.  (A leaf function is one that does
13030 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13032 @item -mcallee-super-interworking
13033 @opindex mcallee-super-interworking
13034 Gives all externally visible functions in the file being compiled an ARM
13035 instruction set header which switches to Thumb mode before executing the
13036 rest of the function.  This allows these functions to be called from
13037 non-interworking code.  This option is not valid in AAPCS configurations
13038 because interworking is enabled by default.
13040 @item -mcaller-super-interworking
13041 @opindex mcaller-super-interworking
13042 Allows calls via function pointers (including virtual functions) to
13043 execute correctly regardless of whether the target code has been
13044 compiled for interworking or not.  There is a small overhead in the cost
13045 of executing a function pointer if this option is enabled.  This option
13046 is not valid in AAPCS configurations because interworking is enabled
13047 by default.
13049 @item -mtp=@var{name}
13050 @opindex mtp
13051 Specify the access model for the thread local storage pointer.  The valid
13052 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
13053 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
13054 (supported in the arm6k architecture), and @option{auto}, which uses the
13055 best available method for the selected processor.  The default setting is
13056 @option{auto}.
13058 @item -mtls-dialect=@var{dialect}
13059 @opindex mtls-dialect
13060 Specify the dialect to use for accessing thread local storage.  Two
13061 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13062 @samp{gnu} dialect selects the original GNU scheme for supporting
13063 local and global dynamic TLS models.  The @samp{gnu2} dialect
13064 selects the GNU descriptor scheme, which provides better performance
13065 for shared libraries.  The GNU descriptor scheme is compatible with
13066 the original scheme, but does require new assembler, linker and
13067 library support.  Initial and local exec TLS models are unaffected by
13068 this option and always use the original scheme.
13070 @item -mword-relocations
13071 @opindex mword-relocations
13072 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13073 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13074 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13075 is specified.
13077 @item -mfix-cortex-m3-ldrd
13078 @opindex mfix-cortex-m3-ldrd
13079 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13080 with overlapping destination and base registers are used.  This option avoids
13081 generating these instructions.  This option is enabled by default when
13082 @option{-mcpu=cortex-m3} is specified.
13084 @item -munaligned-access
13085 @itemx -mno-unaligned-access
13086 @opindex munaligned-access
13087 @opindex mno-unaligned-access
13088 Enables (or disables) reading and writing of 16- and 32- bit values
13089 from addresses that are not 16- or 32- bit aligned.  By default
13090 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13091 architectures, and enabled for all other architectures.  If unaligned
13092 access is not enabled then words in packed data structures will be
13093 accessed a byte at a time.
13095 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
13096 generated object file to either true or false, depending upon the
13097 setting of this option.  If unaligned access is enabled then the
13098 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
13099 defined.
13101 @item -mneon-for-64bits
13102 @opindex mneon-for-64bits
13103 Enables using Neon to handle scalar 64-bits operations. This is
13104 disabled by default since the cost of moving data from core registers
13105 to Neon is high.
13107 @item -mslow-flash-data
13108 @opindex mslow-flash-data
13109 Assume loading data from flash is slower than fetching instruction.
13110 Therefore literal load is minimized for better performance.
13111 This option is only supported when compiling for ARMv7 M-profile and
13112 off by default.
13114 @item -masm-syntax-unified
13115 @opindex masm-syntax-unified
13116 Assume inline assembler is using unified asm syntax.  The default is
13117 currently off which implies divided syntax.  Currently this option is
13118 available only for Thumb1 and has no effect on ARM state and Thumb2.
13119 However, this may change in future releases of GCC.  Divided syntax
13120 should be considered deprecated.
13122 @item -mrestrict-it
13123 @opindex mrestrict-it
13124 Restricts generation of IT blocks to conform to the rules of ARMv8.
13125 IT blocks can only contain a single 16-bit instruction from a select
13126 set of instructions. This option is on by default for ARMv8 Thumb mode.
13127 @end table
13129 @node AVR Options
13130 @subsection AVR Options
13131 @cindex AVR Options
13133 These options are defined for AVR implementations:
13135 @table @gcctabopt
13136 @item -mmcu=@var{mcu}
13137 @opindex mmcu
13138 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13140 The default for this option is@tie{}@code{avr2}.
13142 GCC supports the following AVR devices and ISAs:
13144 @include avr-mmcu.texi
13146 @item -maccumulate-args
13147 @opindex maccumulate-args
13148 Accumulate outgoing function arguments and acquire/release the needed
13149 stack space for outgoing function arguments once in function
13150 prologue/epilogue.  Without this option, outgoing arguments are pushed
13151 before calling a function and popped afterwards.
13153 Popping the arguments after the function call can be expensive on
13154 AVR so that accumulating the stack space might lead to smaller
13155 executables because arguments need not to be removed from the
13156 stack after such a function call.
13158 This option can lead to reduced code size for functions that perform
13159 several calls to functions that get their arguments on the stack like
13160 calls to printf-like functions.
13162 @item -mbranch-cost=@var{cost}
13163 @opindex mbranch-cost
13164 Set the branch costs for conditional branch instructions to
13165 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13166 integers. The default branch cost is 0.
13168 @item -mcall-prologues
13169 @opindex mcall-prologues
13170 Functions prologues/epilogues are expanded as calls to appropriate
13171 subroutines.  Code size is smaller.
13173 @item -mint8
13174 @opindex mint8
13175 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13176 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13177 and @code{long long} is 4 bytes.  Please note that this option does not
13178 conform to the C standards, but it results in smaller code
13179 size.
13181 @item -mno-interrupts
13182 @opindex mno-interrupts
13183 Generated code is not compatible with hardware interrupts.
13184 Code size is smaller.
13186 @item -mrelax
13187 @opindex mrelax
13188 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13189 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13190 Setting @code{-mrelax} just adds the @code{--relax} option to the
13191 linker command line when the linker is called.
13193 Jump relaxing is performed by the linker because jump offsets are not
13194 known before code is located. Therefore, the assembler code generated by the
13195 compiler is the same, but the instructions in the executable may
13196 differ from instructions in the assembler code.
13198 Relaxing must be turned on if linker stubs are needed, see the
13199 section on @code{EIND} and linker stubs below.
13201 @item -msp8
13202 @opindex msp8
13203 Treat the stack pointer register as an 8-bit register,
13204 i.e.@: assume the high byte of the stack pointer is zero.
13205 In general, you don't need to set this option by hand.
13207 This option is used internally by the compiler to select and
13208 build multilibs for architectures @code{avr2} and @code{avr25}.
13209 These architectures mix devices with and without @code{SPH}.
13210 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
13211 the compiler driver will add or remove this option from the compiler
13212 proper's command line, because the compiler then knows if the device
13213 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13214 register or not.
13216 @item -mstrict-X
13217 @opindex mstrict-X
13218 Use address register @code{X} in a way proposed by the hardware.  This means
13219 that @code{X} is only used in indirect, post-increment or
13220 pre-decrement addressing.
13222 Without this option, the @code{X} register may be used in the same way
13223 as @code{Y} or @code{Z} which then is emulated by additional
13224 instructions.  
13225 For example, loading a value with @code{X+const} addressing with a
13226 small non-negative @code{const < 64} to a register @var{Rn} is
13227 performed as
13229 @example
13230 adiw r26, const   ; X += const
13231 ld   @var{Rn}, X        ; @var{Rn} = *X
13232 sbiw r26, const   ; X -= const
13233 @end example
13235 @item -mtiny-stack
13236 @opindex mtiny-stack
13237 Only change the lower 8@tie{}bits of the stack pointer.
13239 @item -Waddr-space-convert
13240 @opindex Waddr-space-convert
13241 Warn about conversions between address spaces in the case where the
13242 resulting address space is not contained in the incoming address space.
13243 @end table
13245 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
13246 @cindex @code{EIND}
13247 Pointers in the implementation are 16@tie{}bits wide.
13248 The address of a function or label is represented as word address so
13249 that indirect jumps and calls can target any code address in the
13250 range of 64@tie{}Ki words.
13252 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13253 bytes of program memory space, there is a special function register called
13254 @code{EIND} that serves as most significant part of the target address
13255 when @code{EICALL} or @code{EIJMP} instructions are used.
13257 Indirect jumps and calls on these devices are handled as follows by
13258 the compiler and are subject to some limitations:
13260 @itemize @bullet
13262 @item
13263 The compiler never sets @code{EIND}.
13265 @item
13266 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13267 instructions or might read @code{EIND} directly in order to emulate an
13268 indirect call/jump by means of a @code{RET} instruction.
13270 @item
13271 The compiler assumes that @code{EIND} never changes during the startup
13272 code or during the application. In particular, @code{EIND} is not
13273 saved/restored in function or interrupt service routine
13274 prologue/epilogue.
13276 @item
13277 For indirect calls to functions and computed goto, the linker
13278 generates @emph{stubs}. Stubs are jump pads sometimes also called
13279 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13280 The stub contains a direct jump to the desired address.
13282 @item
13283 Linker relaxation must be turned on so that the linker will generate
13284 the stubs correctly an all situaltion. See the compiler option
13285 @code{-mrelax} and the linler option @code{--relax}.
13286 There are corner cases where the linker is supposed to generate stubs
13287 but aborts without relaxation and without a helpful error message.
13289 @item
13290 The default linker script is arranged for code with @code{EIND = 0}.
13291 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13292 linker script has to be used in order to place the sections whose
13293 name start with @code{.trampolines} into the segment where @code{EIND}
13294 points to.
13296 @item
13297 The startup code from libgcc never sets @code{EIND}.
13298 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13299 For the impact of AVR-LibC on @code{EIND}, see the
13300 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13302 @item
13303 It is legitimate for user-specific startup code to set up @code{EIND}
13304 early, for example by means of initialization code located in
13305 section @code{.init3}. Such code runs prior to general startup code
13306 that initializes RAM and calls constructors, but after the bit
13307 of startup code from AVR-LibC that sets @code{EIND} to the segment
13308 where the vector table is located.
13309 @example
13310 #include <avr/io.h>
13312 static void
13313 __attribute__((section(".init3"),naked,used,no_instrument_function))
13314 init3_set_eind (void)
13316   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13317                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13319 @end example
13321 @noindent
13322 The @code{__trampolines_start} symbol is defined in the linker script.
13324 @item
13325 Stubs are generated automatically by the linker if
13326 the following two conditions are met:
13327 @itemize @minus
13329 @item The address of a label is taken by means of the @code{gs} modifier
13330 (short for @emph{generate stubs}) like so:
13331 @example
13332 LDI r24, lo8(gs(@var{func}))
13333 LDI r25, hi8(gs(@var{func}))
13334 @end example
13335 @item The final location of that label is in a code segment
13336 @emph{outside} the segment where the stubs are located.
13337 @end itemize
13339 @item
13340 The compiler emits such @code{gs} modifiers for code labels in the
13341 following situations:
13342 @itemize @minus
13343 @item Taking address of a function or code label.
13344 @item Computed goto.
13345 @item If prologue-save function is used, see @option{-mcall-prologues}
13346 command-line option.
13347 @item Switch/case dispatch tables. If you do not want such dispatch
13348 tables you can specify the @option{-fno-jump-tables} command-line option.
13349 @item C and C++ constructors/destructors called during startup/shutdown.
13350 @item If the tools hit a @code{gs()} modifier explained above.
13351 @end itemize
13353 @item
13354 Jumping to non-symbolic addresses like so is @emph{not} supported:
13356 @example
13357 int main (void)
13359     /* Call function at word address 0x2 */
13360     return ((int(*)(void)) 0x2)();
13362 @end example
13364 Instead, a stub has to be set up, i.e.@: the function has to be called
13365 through a symbol (@code{func_4} in the example):
13367 @example
13368 int main (void)
13370     extern int func_4 (void);
13372     /* Call function at byte address 0x4 */
13373     return func_4();
13375 @end example
13377 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
13378 Alternatively, @code{func_4} can be defined in the linker script.
13379 @end itemize
13381 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13382 @cindex @code{RAMPD}
13383 @cindex @code{RAMPX}
13384 @cindex @code{RAMPY}
13385 @cindex @code{RAMPZ}
13386 Some AVR devices support memories larger than the 64@tie{}KiB range
13387 that can be accessed with 16-bit pointers.  To access memory locations
13388 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13389 register is used as high part of the address:
13390 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13391 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13392 register, respectively, to get a wide address. Similarly,
13393 @code{RAMPD} is used together with direct addressing.
13395 @itemize
13396 @item
13397 The startup code initializes the @code{RAMP} special function
13398 registers with zero.
13400 @item
13401 If a @ref{AVR Named Address Spaces,named address space} other than
13402 generic or @code{__flash} is used, then @code{RAMPZ} is set
13403 as needed before the operation.
13405 @item
13406 If the device supports RAM larger than 64@tie{}KiB and the compiler
13407 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13408 is reset to zero after the operation.
13410 @item
13411 If the device comes with a specific @code{RAMP} register, the ISR
13412 prologue/epilogue saves/restores that SFR and initializes it with
13413 zero in case the ISR code might (implicitly) use it.
13415 @item
13416 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13417 If you use inline assembler to read from locations outside the
13418 16-bit address range and change one of the @code{RAMP} registers,
13419 you must reset it to zero after the access.
13421 @end itemize
13423 @subsubsection AVR Built-in Macros
13425 GCC defines several built-in macros so that the user code can test
13426 for the presence or absence of features.  Almost any of the following
13427 built-in macros are deduced from device capabilities and thus
13428 triggered by the @code{-mmcu=} command-line option.
13430 For even more AVR-specific built-in macros see
13431 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13433 @table @code
13435 @item __AVR_ARCH__
13436 Build-in macro that resolves to a decimal number that identifies the
13437 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13438 Possible values are:
13440 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13441 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13442 @code{105}, @code{106}, @code{107}
13444 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13445 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13446 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13447 @code{avrxmega6}, @code{avrxmega7}, respectively.
13448 If @var{mcu} specifies a device, this built-in macro is set
13449 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13450 defined to @code{4}.
13452 @item __AVR_@var{Device}__
13453 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13454 the device's name. For example, @code{-mmcu=atmega8} defines the
13455 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13456 @code{__AVR_ATtiny261A__}, etc.
13458 The built-in macros' names follow
13459 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13460 the device name as from the AVR user manual. The difference between
13461 @var{Device} in the built-in macro and @var{device} in
13462 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13464 If @var{device} is not a device but only a core architecture like
13465 @code{avr51}, this macro will not be defined.
13467 @item   __AVR_DEVICE_NAME__
13468 Setting @code{-mmcu=@var{device}} defines this built-in macro to
13469 the device's name. For example, with @code{-mmcu=atmega8} the macro
13470 will be defined to @code{atmega8}.
13472 If @var{device} is not a device but only a core architecture like
13473 @code{avr51}, this macro will not be defined.
13475 @item __AVR_XMEGA__
13476 The device / architecture belongs to the XMEGA family of devices.
13478 @item __AVR_HAVE_ELPM__
13479 The device has the the @code{ELPM} instruction.
13481 @item __AVR_HAVE_ELPMX__
13482 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13483 R@var{n},Z+} instructions.
13485 @item __AVR_HAVE_MOVW__
13486 The device has the @code{MOVW} instruction to perform 16-bit
13487 register-register moves.
13489 @item __AVR_HAVE_LPMX__
13490 The device has the @code{LPM R@var{n},Z} and
13491 @code{LPM R@var{n},Z+} instructions.
13493 @item __AVR_HAVE_MUL__
13494 The device has a hardware multiplier. 
13496 @item __AVR_HAVE_JMP_CALL__
13497 The device has the @code{JMP} and @code{CALL} instructions.
13498 This is the case for devices with at least 16@tie{}KiB of program
13499 memory.
13501 @item __AVR_HAVE_EIJMP_EICALL__
13502 @itemx __AVR_3_BYTE_PC__
13503 The device has the @code{EIJMP} and @code{EICALL} instructions.
13504 This is the case for devices with more than 128@tie{}KiB of program memory.
13505 This also means that the program counter
13506 (PC) is 3@tie{}bytes wide.
13508 @item __AVR_2_BYTE_PC__
13509 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13510 with up to 128@tie{}KiB of program memory.
13512 @item __AVR_HAVE_8BIT_SP__
13513 @itemx __AVR_HAVE_16BIT_SP__
13514 The stack pointer (SP) register is treated as 8-bit respectively
13515 16-bit register by the compiler.
13516 The definition of these macros is affected by @code{-mtiny-stack}.
13518 @item __AVR_HAVE_SPH__
13519 @itemx __AVR_SP8__
13520 The device has the SPH (high part of stack pointer) special function
13521 register or has an 8-bit stack pointer, respectively.
13522 The definition of these macros is affected by @code{-mmcu=} and
13523 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13524 by @code{-msp8}.
13526 @item __AVR_HAVE_RAMPD__
13527 @itemx __AVR_HAVE_RAMPX__
13528 @itemx __AVR_HAVE_RAMPY__
13529 @itemx __AVR_HAVE_RAMPZ__
13530 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13531 @code{RAMPZ} special function register, respectively.
13533 @item __NO_INTERRUPTS__
13534 This macro reflects the @code{-mno-interrupts} command line option.
13536 @item __AVR_ERRATA_SKIP__
13537 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13538 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13539 instructions because of a hardware erratum.  Skip instructions are
13540 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13541 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13542 set.
13544 @item __AVR_ISA_RMW__
13545 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13547 @item __AVR_SFR_OFFSET__=@var{offset}
13548 Instructions that can address I/O special function registers directly
13549 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13550 address as if addressed by an instruction to access RAM like @code{LD}
13551 or @code{STS}. This offset depends on the device architecture and has
13552 to be subtracted from the RAM address in order to get the
13553 respective I/O@tie{}address.
13555 @item __WITH_AVRLIBC__
13556 The compiler is configured to be used together with AVR-Libc.
13557 See the @code{--with-avrlibc} configure option.
13559 @end table
13561 @node Blackfin Options
13562 @subsection Blackfin Options
13563 @cindex Blackfin Options
13565 @table @gcctabopt
13566 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13567 @opindex mcpu=
13568 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13569 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13570 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13571 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13572 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13573 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13574 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13575 @samp{bf561}, @samp{bf592}.
13577 The optional @var{sirevision} specifies the silicon revision of the target
13578 Blackfin processor.  Any workarounds available for the targeted silicon revision
13579 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13580 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13581 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13582 hexadecimal digits representing the major and minor numbers in the silicon
13583 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13584 is not defined.  If @var{sirevision} is @samp{any}, the
13585 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13586 If this optional @var{sirevision} is not used, GCC assumes the latest known
13587 silicon revision of the targeted Blackfin processor.
13589 GCC defines a preprocessor macro for the specified @var{cpu}.
13590 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13591 provided by libgloss to be linked in if @option{-msim} is not given.
13593 Without this option, @samp{bf532} is used as the processor by default.
13595 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13596 only the preprocessor macro is defined.
13598 @item -msim
13599 @opindex msim
13600 Specifies that the program will be run on the simulator.  This causes
13601 the simulator BSP provided by libgloss to be linked in.  This option
13602 has effect only for @samp{bfin-elf} toolchain.
13603 Certain other options, such as @option{-mid-shared-library} and
13604 @option{-mfdpic}, imply @option{-msim}.
13606 @item -momit-leaf-frame-pointer
13607 @opindex momit-leaf-frame-pointer
13608 Don't keep the frame pointer in a register for leaf functions.  This
13609 avoids the instructions to save, set up and restore frame pointers and
13610 makes an extra register available in leaf functions.  The option
13611 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13612 which might make debugging harder.
13614 @item -mspecld-anomaly
13615 @opindex mspecld-anomaly
13616 When enabled, the compiler ensures that the generated code does not
13617 contain speculative loads after jump instructions. If this option is used,
13618 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13620 @item -mno-specld-anomaly
13621 @opindex mno-specld-anomaly
13622 Don't generate extra code to prevent speculative loads from occurring.
13624 @item -mcsync-anomaly
13625 @opindex mcsync-anomaly
13626 When enabled, the compiler ensures that the generated code does not
13627 contain CSYNC or SSYNC instructions too soon after conditional branches.
13628 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13630 @item -mno-csync-anomaly
13631 @opindex mno-csync-anomaly
13632 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13633 occurring too soon after a conditional branch.
13635 @item -mlow-64k
13636 @opindex mlow-64k
13637 When enabled, the compiler is free to take advantage of the knowledge that
13638 the entire program fits into the low 64k of memory.
13640 @item -mno-low-64k
13641 @opindex mno-low-64k
13642 Assume that the program is arbitrarily large.  This is the default.
13644 @item -mstack-check-l1
13645 @opindex mstack-check-l1
13646 Do stack checking using information placed into L1 scratchpad memory by the
13647 uClinux kernel.
13649 @item -mid-shared-library
13650 @opindex mid-shared-library
13651 Generate code that supports shared libraries via the library ID method.
13652 This allows for execute in place and shared libraries in an environment
13653 without virtual memory management.  This option implies @option{-fPIC}.
13654 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13656 @item -mno-id-shared-library
13657 @opindex mno-id-shared-library
13658 Generate code that doesn't assume ID-based shared libraries are being used.
13659 This is the default.
13661 @item -mleaf-id-shared-library
13662 @opindex mleaf-id-shared-library
13663 Generate code that supports shared libraries via the library ID method,
13664 but assumes that this library or executable won't link against any other
13665 ID shared libraries.  That allows the compiler to use faster code for jumps
13666 and calls.
13668 @item -mno-leaf-id-shared-library
13669 @opindex mno-leaf-id-shared-library
13670 Do not assume that the code being compiled won't link against any ID shared
13671 libraries.  Slower code is generated for jump and call insns.
13673 @item -mshared-library-id=n
13674 @opindex mshared-library-id
13675 Specifies the identification number of the ID-based shared library being
13676 compiled.  Specifying a value of 0 generates more compact code; specifying
13677 other values forces the allocation of that number to the current
13678 library but is no more space- or time-efficient than omitting this option.
13680 @item -msep-data
13681 @opindex msep-data
13682 Generate code that allows the data segment to be located in a different
13683 area of memory from the text segment.  This allows for execute in place in
13684 an environment without virtual memory management by eliminating relocations
13685 against the text section.
13687 @item -mno-sep-data
13688 @opindex mno-sep-data
13689 Generate code that assumes that the data segment follows the text segment.
13690 This is the default.
13692 @item -mlong-calls
13693 @itemx -mno-long-calls
13694 @opindex mlong-calls
13695 @opindex mno-long-calls
13696 Tells the compiler to perform function calls by first loading the
13697 address of the function into a register and then performing a subroutine
13698 call on this register.  This switch is needed if the target function
13699 lies outside of the 24-bit addressing range of the offset-based
13700 version of subroutine call instruction.
13702 This feature is not enabled by default.  Specifying
13703 @option{-mno-long-calls} restores the default behavior.  Note these
13704 switches have no effect on how the compiler generates code to handle
13705 function calls via function pointers.
13707 @item -mfast-fp
13708 @opindex mfast-fp
13709 Link with the fast floating-point library. This library relaxes some of
13710 the IEEE floating-point standard's rules for checking inputs against
13711 Not-a-Number (NAN), in the interest of performance.
13713 @item -minline-plt
13714 @opindex minline-plt
13715 Enable inlining of PLT entries in function calls to functions that are
13716 not known to bind locally.  It has no effect without @option{-mfdpic}.
13718 @item -mmulticore
13719 @opindex mmulticore
13720 Build a standalone application for multicore Blackfin processors. 
13721 This option causes proper start files and link scripts supporting 
13722 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13723 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13725 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13726 selects the one-application-per-core programming model.  Without
13727 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13728 programming model is used. In this model, the main function of Core B
13729 should be named as @code{coreb_main}.
13731 If this option is not used, the single-core application programming
13732 model is used.
13734 @item -mcorea
13735 @opindex mcorea
13736 Build a standalone application for Core A of BF561 when using
13737 the one-application-per-core programming model. Proper start files
13738 and link scripts are used to support Core A, and the macro
13739 @code{__BFIN_COREA} is defined.
13740 This option can only be used in conjunction with @option{-mmulticore}.
13742 @item -mcoreb
13743 @opindex mcoreb
13744 Build a standalone application for Core B of BF561 when using
13745 the one-application-per-core programming model. Proper start files
13746 and link scripts are used to support Core B, and the macro
13747 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13748 should be used instead of @code{main}. 
13749 This option can only be used in conjunction with @option{-mmulticore}.
13751 @item -msdram
13752 @opindex msdram
13753 Build a standalone application for SDRAM. Proper start files and
13754 link scripts are used to put the application into SDRAM, and the macro
13755 @code{__BFIN_SDRAM} is defined.
13756 The loader should initialize SDRAM before loading the application.
13758 @item -micplb
13759 @opindex micplb
13760 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13761 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13762 are enabled; for standalone applications the default is off.
13763 @end table
13765 @node C6X Options
13766 @subsection C6X Options
13767 @cindex C6X Options
13769 @table @gcctabopt
13770 @item -march=@var{name}
13771 @opindex march
13772 This specifies the name of the target architecture.  GCC uses this
13773 name to determine what kind of instructions it can emit when generating
13774 assembly code.  Permissible names are: @samp{c62x},
13775 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13777 @item -mbig-endian
13778 @opindex mbig-endian
13779 Generate code for a big-endian target.
13781 @item -mlittle-endian
13782 @opindex mlittle-endian
13783 Generate code for a little-endian target.  This is the default.
13785 @item -msim
13786 @opindex msim
13787 Choose startup files and linker script suitable for the simulator.
13789 @item -msdata=default
13790 @opindex msdata=default
13791 Put small global and static data in the @samp{.neardata} section,
13792 which is pointed to by register @code{B14}.  Put small uninitialized
13793 global and static data in the @samp{.bss} section, which is adjacent
13794 to the @samp{.neardata} section.  Put small read-only data into the
13795 @samp{.rodata} section.  The corresponding sections used for large
13796 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13798 @item -msdata=all
13799 @opindex msdata=all
13800 Put all data, not just small objects, into the sections reserved for
13801 small data, and use addressing relative to the @code{B14} register to
13802 access them.
13804 @item -msdata=none
13805 @opindex msdata=none
13806 Make no use of the sections reserved for small data, and use absolute
13807 addresses to access all data.  Put all initialized global and static
13808 data in the @samp{.fardata} section, and all uninitialized data in the
13809 @samp{.far} section.  Put all constant data into the @samp{.const}
13810 section.
13811 @end table
13813 @node CRIS Options
13814 @subsection CRIS Options
13815 @cindex CRIS Options
13817 These options are defined specifically for the CRIS ports.
13819 @table @gcctabopt
13820 @item -march=@var{architecture-type}
13821 @itemx -mcpu=@var{architecture-type}
13822 @opindex march
13823 @opindex mcpu
13824 Generate code for the specified architecture.  The choices for
13825 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13826 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13827 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13828 @samp{v10}.
13830 @item -mtune=@var{architecture-type}
13831 @opindex mtune
13832 Tune to @var{architecture-type} everything applicable about the generated
13833 code, except for the ABI and the set of available instructions.  The
13834 choices for @var{architecture-type} are the same as for
13835 @option{-march=@var{architecture-type}}.
13837 @item -mmax-stack-frame=@var{n}
13838 @opindex mmax-stack-frame
13839 Warn when the stack frame of a function exceeds @var{n} bytes.
13841 @item -metrax4
13842 @itemx -metrax100
13843 @opindex metrax4
13844 @opindex metrax100
13845 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13846 @option{-march=v3} and @option{-march=v8} respectively.
13848 @item -mmul-bug-workaround
13849 @itemx -mno-mul-bug-workaround
13850 @opindex mmul-bug-workaround
13851 @opindex mno-mul-bug-workaround
13852 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13853 models where it applies.  This option is active by default.
13855 @item -mpdebug
13856 @opindex mpdebug
13857 Enable CRIS-specific verbose debug-related information in the assembly
13858 code.  This option also has the effect of turning off the @samp{#NO_APP}
13859 formatted-code indicator to the assembler at the beginning of the
13860 assembly file.
13862 @item -mcc-init
13863 @opindex mcc-init
13864 Do not use condition-code results from previous instruction; always emit
13865 compare and test instructions before use of condition codes.
13867 @item -mno-side-effects
13868 @opindex mno-side-effects
13869 Do not emit instructions with side effects in addressing modes other than
13870 post-increment.
13872 @item -mstack-align
13873 @itemx -mno-stack-align
13874 @itemx -mdata-align
13875 @itemx -mno-data-align
13876 @itemx -mconst-align
13877 @itemx -mno-const-align
13878 @opindex mstack-align
13879 @opindex mno-stack-align
13880 @opindex mdata-align
13881 @opindex mno-data-align
13882 @opindex mconst-align
13883 @opindex mno-const-align
13884 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13885 stack frame, individual data and constants to be aligned for the maximum
13886 single data access size for the chosen CPU model.  The default is to
13887 arrange for 32-bit alignment.  ABI details such as structure layout are
13888 not affected by these options.
13890 @item -m32-bit
13891 @itemx -m16-bit
13892 @itemx -m8-bit
13893 @opindex m32-bit
13894 @opindex m16-bit
13895 @opindex m8-bit
13896 Similar to the stack- data- and const-align options above, these options
13897 arrange for stack frame, writable data and constants to all be 32-bit,
13898 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13900 @item -mno-prologue-epilogue
13901 @itemx -mprologue-epilogue
13902 @opindex mno-prologue-epilogue
13903 @opindex mprologue-epilogue
13904 With @option{-mno-prologue-epilogue}, the normal function prologue and
13905 epilogue which set up the stack frame are omitted and no return
13906 instructions or return sequences are generated in the code.  Use this
13907 option only together with visual inspection of the compiled code: no
13908 warnings or errors are generated when call-saved registers must be saved,
13909 or storage for local variables needs to be allocated.
13911 @item -mno-gotplt
13912 @itemx -mgotplt
13913 @opindex mno-gotplt
13914 @opindex mgotplt
13915 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13916 instruction sequences that load addresses for functions from the PLT part
13917 of the GOT rather than (traditional on other architectures) calls to the
13918 PLT@.  The default is @option{-mgotplt}.
13920 @item -melf
13921 @opindex melf
13922 Legacy no-op option only recognized with the cris-axis-elf and
13923 cris-axis-linux-gnu targets.
13925 @item -mlinux
13926 @opindex mlinux
13927 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13929 @item -sim
13930 @opindex sim
13931 This option, recognized for the cris-axis-elf, arranges
13932 to link with input-output functions from a simulator library.  Code,
13933 initialized data and zero-initialized data are allocated consecutively.
13935 @item -sim2
13936 @opindex sim2
13937 Like @option{-sim}, but pass linker options to locate initialized data at
13938 0x40000000 and zero-initialized data at 0x80000000.
13939 @end table
13941 @node CR16 Options
13942 @subsection CR16 Options
13943 @cindex CR16 Options
13945 These options are defined specifically for the CR16 ports.
13947 @table @gcctabopt
13949 @item -mmac
13950 @opindex mmac
13951 Enable the use of multiply-accumulate instructions. Disabled by default.
13953 @item -mcr16cplus
13954 @itemx -mcr16c
13955 @opindex mcr16cplus
13956 @opindex mcr16c
13957 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13958 is default.
13960 @item -msim
13961 @opindex msim
13962 Links the library libsim.a which is in compatible with simulator. Applicable
13963 to ELF compiler only.
13965 @item -mint32
13966 @opindex mint32
13967 Choose integer type as 32-bit wide.
13969 @item -mbit-ops
13970 @opindex mbit-ops
13971 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13973 @item -mdata-model=@var{model}
13974 @opindex mdata-model
13975 Choose a data model. The choices for @var{model} are @samp{near},
13976 @samp{far} or @samp{medium}. @samp{medium} is default.
13977 However, @samp{far} is not valid with @option{-mcr16c}, as the
13978 CR16C architecture does not support the far data model.
13979 @end table
13981 @node Darwin Options
13982 @subsection Darwin Options
13983 @cindex Darwin options
13985 These options are defined for all architectures running the Darwin operating
13986 system.
13988 FSF GCC on Darwin does not create ``fat'' object files; it creates
13989 an object file for the single architecture that GCC was built to
13990 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13991 @option{-arch} options are used; it does so by running the compiler or
13992 linker multiple times and joining the results together with
13993 @file{lipo}.
13995 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13996 @samp{i686}) is determined by the flags that specify the ISA
13997 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13998 @option{-force_cpusubtype_ALL} option can be used to override this.
14000 The Darwin tools vary in their behavior when presented with an ISA
14001 mismatch.  The assembler, @file{as}, only permits instructions to
14002 be used that are valid for the subtype of the file it is generating,
14003 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14004 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14005 and prints an error if asked to create a shared library with a less
14006 restrictive subtype than its input files (for instance, trying to put
14007 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14008 for executables, @command{ld}, quietly gives the executable the most
14009 restrictive subtype of any of its input files.
14011 @table @gcctabopt
14012 @item -F@var{dir}
14013 @opindex F
14014 Add the framework directory @var{dir} to the head of the list of
14015 directories to be searched for header files.  These directories are
14016 interleaved with those specified by @option{-I} options and are
14017 scanned in a left-to-right order.
14019 A framework directory is a directory with frameworks in it.  A
14020 framework is a directory with a @file{Headers} and/or
14021 @file{PrivateHeaders} directory contained directly in it that ends
14022 in @file{.framework}.  The name of a framework is the name of this
14023 directory excluding the @file{.framework}.  Headers associated with
14024 the framework are found in one of those two directories, with
14025 @file{Headers} being searched first.  A subframework is a framework
14026 directory that is in a framework's @file{Frameworks} directory.
14027 Includes of subframework headers can only appear in a header of a
14028 framework that contains the subframework, or in a sibling subframework
14029 header.  Two subframeworks are siblings if they occur in the same
14030 framework.  A subframework should not have the same name as a
14031 framework; a warning is issued if this is violated.  Currently a
14032 subframework cannot have subframeworks; in the future, the mechanism
14033 may be extended to support this.  The standard frameworks can be found
14034 in @file{/System/Library/Frameworks} and
14035 @file{/Library/Frameworks}.  An example include looks like
14036 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14037 the name of the framework and @file{header.h} is found in the
14038 @file{PrivateHeaders} or @file{Headers} directory.
14040 @item -iframework@var{dir}
14041 @opindex iframework
14042 Like @option{-F} except the directory is a treated as a system
14043 directory.  The main difference between this @option{-iframework} and
14044 @option{-F} is that with @option{-iframework} the compiler does not
14045 warn about constructs contained within header files found via
14046 @var{dir}.  This option is valid only for the C family of languages.
14048 @item -gused
14049 @opindex gused
14050 Emit debugging information for symbols that are used.  For stabs
14051 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14052 This is by default ON@.
14054 @item -gfull
14055 @opindex gfull
14056 Emit debugging information for all symbols and types.
14058 @item -mmacosx-version-min=@var{version}
14059 The earliest version of MacOS X that this executable will run on
14060 is @var{version}.  Typical values of @var{version} include @code{10.1},
14061 @code{10.2}, and @code{10.3.9}.
14063 If the compiler was built to use the system's headers by default,
14064 then the default for this option is the system version on which the
14065 compiler is running, otherwise the default is to make choices that
14066 are compatible with as many systems and code bases as possible.
14068 @item -mkernel
14069 @opindex mkernel
14070 Enable kernel development mode.  The @option{-mkernel} option sets
14071 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14072 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14073 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14074 applicable.  This mode also sets @option{-mno-altivec},
14075 @option{-msoft-float}, @option{-fno-builtin} and
14076 @option{-mlong-branch} for PowerPC targets.
14078 @item -mone-byte-bool
14079 @opindex mone-byte-bool
14080 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
14081 By default @samp{sizeof(bool)} is @samp{4} when compiling for
14082 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
14083 option has no effect on x86.
14085 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14086 to generate code that is not binary compatible with code generated
14087 without that switch.  Using this switch may require recompiling all
14088 other modules in a program, including system libraries.  Use this
14089 switch to conform to a non-default data model.
14091 @item -mfix-and-continue
14092 @itemx -ffix-and-continue
14093 @itemx -findirect-data
14094 @opindex mfix-and-continue
14095 @opindex ffix-and-continue
14096 @opindex findirect-data
14097 Generate code suitable for fast turnaround development, such as to
14098 allow GDB to dynamically load @code{.o} files into already-running
14099 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14100 are provided for backwards compatibility.
14102 @item -all_load
14103 @opindex all_load
14104 Loads all members of static archive libraries.
14105 See man ld(1) for more information.
14107 @item -arch_errors_fatal
14108 @opindex arch_errors_fatal
14109 Cause the errors having to do with files that have the wrong architecture
14110 to be fatal.
14112 @item -bind_at_load
14113 @opindex bind_at_load
14114 Causes the output file to be marked such that the dynamic linker will
14115 bind all undefined references when the file is loaded or launched.
14117 @item -bundle
14118 @opindex bundle
14119 Produce a Mach-o bundle format file.
14120 See man ld(1) for more information.
14122 @item -bundle_loader @var{executable}
14123 @opindex bundle_loader
14124 This option specifies the @var{executable} that will load the build
14125 output file being linked.  See man ld(1) for more information.
14127 @item -dynamiclib
14128 @opindex dynamiclib
14129 When passed this option, GCC produces a dynamic library instead of
14130 an executable when linking, using the Darwin @file{libtool} command.
14132 @item -force_cpusubtype_ALL
14133 @opindex force_cpusubtype_ALL
14134 This causes GCC's output file to have the @var{ALL} subtype, instead of
14135 one controlled by the @option{-mcpu} or @option{-march} option.
14137 @item -allowable_client  @var{client_name}
14138 @itemx -client_name
14139 @itemx -compatibility_version
14140 @itemx -current_version
14141 @itemx -dead_strip
14142 @itemx -dependency-file
14143 @itemx -dylib_file
14144 @itemx -dylinker_install_name
14145 @itemx -dynamic
14146 @itemx -exported_symbols_list
14147 @itemx -filelist
14148 @need 800
14149 @itemx -flat_namespace
14150 @itemx -force_flat_namespace
14151 @itemx -headerpad_max_install_names
14152 @itemx -image_base
14153 @itemx -init
14154 @itemx -install_name
14155 @itemx -keep_private_externs
14156 @itemx -multi_module
14157 @itemx -multiply_defined
14158 @itemx -multiply_defined_unused
14159 @need 800
14160 @itemx -noall_load
14161 @itemx -no_dead_strip_inits_and_terms
14162 @itemx -nofixprebinding
14163 @itemx -nomultidefs
14164 @itemx -noprebind
14165 @itemx -noseglinkedit
14166 @itemx -pagezero_size
14167 @itemx -prebind
14168 @itemx -prebind_all_twolevel_modules
14169 @itemx -private_bundle
14170 @need 800
14171 @itemx -read_only_relocs
14172 @itemx -sectalign
14173 @itemx -sectobjectsymbols
14174 @itemx -whyload
14175 @itemx -seg1addr
14176 @itemx -sectcreate
14177 @itemx -sectobjectsymbols
14178 @itemx -sectorder
14179 @itemx -segaddr
14180 @itemx -segs_read_only_addr
14181 @need 800
14182 @itemx -segs_read_write_addr
14183 @itemx -seg_addr_table
14184 @itemx -seg_addr_table_filename
14185 @itemx -seglinkedit
14186 @itemx -segprot
14187 @itemx -segs_read_only_addr
14188 @itemx -segs_read_write_addr
14189 @itemx -single_module
14190 @itemx -static
14191 @itemx -sub_library
14192 @need 800
14193 @itemx -sub_umbrella
14194 @itemx -twolevel_namespace
14195 @itemx -umbrella
14196 @itemx -undefined
14197 @itemx -unexported_symbols_list
14198 @itemx -weak_reference_mismatches
14199 @itemx -whatsloaded
14200 @opindex allowable_client
14201 @opindex client_name
14202 @opindex compatibility_version
14203 @opindex current_version
14204 @opindex dead_strip
14205 @opindex dependency-file
14206 @opindex dylib_file
14207 @opindex dylinker_install_name
14208 @opindex dynamic
14209 @opindex exported_symbols_list
14210 @opindex filelist
14211 @opindex flat_namespace
14212 @opindex force_flat_namespace
14213 @opindex headerpad_max_install_names
14214 @opindex image_base
14215 @opindex init
14216 @opindex install_name
14217 @opindex keep_private_externs
14218 @opindex multi_module
14219 @opindex multiply_defined
14220 @opindex multiply_defined_unused
14221 @opindex noall_load
14222 @opindex no_dead_strip_inits_and_terms
14223 @opindex nofixprebinding
14224 @opindex nomultidefs
14225 @opindex noprebind
14226 @opindex noseglinkedit
14227 @opindex pagezero_size
14228 @opindex prebind
14229 @opindex prebind_all_twolevel_modules
14230 @opindex private_bundle
14231 @opindex read_only_relocs
14232 @opindex sectalign
14233 @opindex sectobjectsymbols
14234 @opindex whyload
14235 @opindex seg1addr
14236 @opindex sectcreate
14237 @opindex sectobjectsymbols
14238 @opindex sectorder
14239 @opindex segaddr
14240 @opindex segs_read_only_addr
14241 @opindex segs_read_write_addr
14242 @opindex seg_addr_table
14243 @opindex seg_addr_table_filename
14244 @opindex seglinkedit
14245 @opindex segprot
14246 @opindex segs_read_only_addr
14247 @opindex segs_read_write_addr
14248 @opindex single_module
14249 @opindex static
14250 @opindex sub_library
14251 @opindex sub_umbrella
14252 @opindex twolevel_namespace
14253 @opindex umbrella
14254 @opindex undefined
14255 @opindex unexported_symbols_list
14256 @opindex weak_reference_mismatches
14257 @opindex whatsloaded
14258 These options are passed to the Darwin linker.  The Darwin linker man page
14259 describes them in detail.
14260 @end table
14262 @node DEC Alpha Options
14263 @subsection DEC Alpha Options
14265 These @samp{-m} options are defined for the DEC Alpha implementations:
14267 @table @gcctabopt
14268 @item -mno-soft-float
14269 @itemx -msoft-float
14270 @opindex mno-soft-float
14271 @opindex msoft-float
14272 Use (do not use) the hardware floating-point instructions for
14273 floating-point operations.  When @option{-msoft-float} is specified,
14274 functions in @file{libgcc.a} are used to perform floating-point
14275 operations.  Unless they are replaced by routines that emulate the
14276 floating-point operations, or compiled in such a way as to call such
14277 emulations routines, these routines issue floating-point
14278 operations.   If you are compiling for an Alpha without floating-point
14279 operations, you must ensure that the library is built so as not to call
14280 them.
14282 Note that Alpha implementations without floating-point operations are
14283 required to have floating-point registers.
14285 @item -mfp-reg
14286 @itemx -mno-fp-regs
14287 @opindex mfp-reg
14288 @opindex mno-fp-regs
14289 Generate code that uses (does not use) the floating-point register set.
14290 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14291 register set is not used, floating-point operands are passed in integer
14292 registers as if they were integers and floating-point results are passed
14293 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14294 so any function with a floating-point argument or return value called by code
14295 compiled with @option{-mno-fp-regs} must also be compiled with that
14296 option.
14298 A typical use of this option is building a kernel that does not use,
14299 and hence need not save and restore, any floating-point registers.
14301 @item -mieee
14302 @opindex mieee
14303 The Alpha architecture implements floating-point hardware optimized for
14304 maximum performance.  It is mostly compliant with the IEEE floating-point
14305 standard.  However, for full compliance, software assistance is
14306 required.  This option generates code fully IEEE-compliant code
14307 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14308 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14309 defined during compilation.  The resulting code is less efficient but is
14310 able to correctly support denormalized numbers and exceptional IEEE
14311 values such as not-a-number and plus/minus infinity.  Other Alpha
14312 compilers call this option @option{-ieee_with_no_inexact}.
14314 @item -mieee-with-inexact
14315 @opindex mieee-with-inexact
14316 This is like @option{-mieee} except the generated code also maintains
14317 the IEEE @var{inexact-flag}.  Turning on this option causes the
14318 generated code to implement fully-compliant IEEE math.  In addition to
14319 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14320 macro.  On some Alpha implementations the resulting code may execute
14321 significantly slower than the code generated by default.  Since there is
14322 very little code that depends on the @var{inexact-flag}, you should
14323 normally not specify this option.  Other Alpha compilers call this
14324 option @option{-ieee_with_inexact}.
14326 @item -mfp-trap-mode=@var{trap-mode}
14327 @opindex mfp-trap-mode
14328 This option controls what floating-point related traps are enabled.
14329 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14330 The trap mode can be set to one of four values:
14332 @table @samp
14333 @item n
14334 This is the default (normal) setting.  The only traps that are enabled
14335 are the ones that cannot be disabled in software (e.g., division by zero
14336 trap).
14338 @item u
14339 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14340 as well.
14342 @item su
14343 Like @samp{u}, but the instructions are marked to be safe for software
14344 completion (see Alpha architecture manual for details).
14346 @item sui
14347 Like @samp{su}, but inexact traps are enabled as well.
14348 @end table
14350 @item -mfp-rounding-mode=@var{rounding-mode}
14351 @opindex mfp-rounding-mode
14352 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14353 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14356 @table @samp
14357 @item n
14358 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14359 the nearest machine number or towards the even machine number in case
14360 of a tie.
14362 @item m
14363 Round towards minus infinity.
14365 @item c
14366 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14368 @item d
14369 Dynamic rounding mode.  A field in the floating-point control register
14370 (@var{fpcr}, see Alpha architecture reference manual) controls the
14371 rounding mode in effect.  The C library initializes this register for
14372 rounding towards plus infinity.  Thus, unless your program modifies the
14373 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14374 @end table
14376 @item -mtrap-precision=@var{trap-precision}
14377 @opindex mtrap-precision
14378 In the Alpha architecture, floating-point traps are imprecise.  This
14379 means without software assistance it is impossible to recover from a
14380 floating trap and program execution normally needs to be terminated.
14381 GCC can generate code that can assist operating system trap handlers
14382 in determining the exact location that caused a floating-point trap.
14383 Depending on the requirements of an application, different levels of
14384 precisions can be selected:
14386 @table @samp
14387 @item p
14388 Program precision.  This option is the default and means a trap handler
14389 can only identify which program caused a floating-point exception.
14391 @item f
14392 Function precision.  The trap handler can determine the function that
14393 caused a floating-point exception.
14395 @item i
14396 Instruction precision.  The trap handler can determine the exact
14397 instruction that caused a floating-point exception.
14398 @end table
14400 Other Alpha compilers provide the equivalent options called
14401 @option{-scope_safe} and @option{-resumption_safe}.
14403 @item -mieee-conformant
14404 @opindex mieee-conformant
14405 This option marks the generated code as IEEE conformant.  You must not
14406 use this option unless you also specify @option{-mtrap-precision=i} and either
14407 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14408 is to emit the line @samp{.eflag 48} in the function prologue of the
14409 generated assembly file.
14411 @item -mbuild-constants
14412 @opindex mbuild-constants
14413 Normally GCC examines a 32- or 64-bit integer constant to
14414 see if it can construct it from smaller constants in two or three
14415 instructions.  If it cannot, it outputs the constant as a literal and
14416 generates code to load it from the data segment at run time.
14418 Use this option to require GCC to construct @emph{all} integer constants
14419 using code, even if it takes more instructions (the maximum is six).
14421 You typically use this option to build a shared library dynamic
14422 loader.  Itself a shared library, it must relocate itself in memory
14423 before it can find the variables and constants in its own data segment.
14425 @item -mbwx
14426 @itemx -mno-bwx
14427 @itemx -mcix
14428 @itemx -mno-cix
14429 @itemx -mfix
14430 @itemx -mno-fix
14431 @itemx -mmax
14432 @itemx -mno-max
14433 @opindex mbwx
14434 @opindex mno-bwx
14435 @opindex mcix
14436 @opindex mno-cix
14437 @opindex mfix
14438 @opindex mno-fix
14439 @opindex mmax
14440 @opindex mno-max
14441 Indicate whether GCC should generate code to use the optional BWX,
14442 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14443 sets supported by the CPU type specified via @option{-mcpu=} option or that
14444 of the CPU on which GCC was built if none is specified.
14446 @item -mfloat-vax
14447 @itemx -mfloat-ieee
14448 @opindex mfloat-vax
14449 @opindex mfloat-ieee
14450 Generate code that uses (does not use) VAX F and G floating-point
14451 arithmetic instead of IEEE single and double precision.
14453 @item -mexplicit-relocs
14454 @itemx -mno-explicit-relocs
14455 @opindex mexplicit-relocs
14456 @opindex mno-explicit-relocs
14457 Older Alpha assemblers provided no way to generate symbol relocations
14458 except via assembler macros.  Use of these macros does not allow
14459 optimal instruction scheduling.  GNU binutils as of version 2.12
14460 supports a new syntax that allows the compiler to explicitly mark
14461 which relocations should apply to which instructions.  This option
14462 is mostly useful for debugging, as GCC detects the capabilities of
14463 the assembler when it is built and sets the default accordingly.
14465 @item -msmall-data
14466 @itemx -mlarge-data
14467 @opindex msmall-data
14468 @opindex mlarge-data
14469 When @option{-mexplicit-relocs} is in effect, static data is
14470 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14471 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14472 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14473 16-bit relocations off of the @code{$gp} register.  This limits the
14474 size of the small data area to 64KB, but allows the variables to be
14475 directly accessed via a single instruction.
14477 The default is @option{-mlarge-data}.  With this option the data area
14478 is limited to just below 2GB@.  Programs that require more than 2GB of
14479 data must use @code{malloc} or @code{mmap} to allocate the data in the
14480 heap instead of in the program's data segment.
14482 When generating code for shared libraries, @option{-fpic} implies
14483 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14485 @item -msmall-text
14486 @itemx -mlarge-text
14487 @opindex msmall-text
14488 @opindex mlarge-text
14489 When @option{-msmall-text} is used, the compiler assumes that the
14490 code of the entire program (or shared library) fits in 4MB, and is
14491 thus reachable with a branch instruction.  When @option{-msmall-data}
14492 is used, the compiler can assume that all local symbols share the
14493 same @code{$gp} value, and thus reduce the number of instructions
14494 required for a function call from 4 to 1.
14496 The default is @option{-mlarge-text}.
14498 @item -mcpu=@var{cpu_type}
14499 @opindex mcpu
14500 Set the instruction set and instruction scheduling parameters for
14501 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14502 style name or the corresponding chip number.  GCC supports scheduling
14503 parameters for the EV4, EV5 and EV6 family of processors and
14504 chooses the default values for the instruction set from the processor
14505 you specify.  If you do not specify a processor type, GCC defaults
14506 to the processor on which the compiler was built.
14508 Supported values for @var{cpu_type} are
14510 @table @samp
14511 @item ev4
14512 @itemx ev45
14513 @itemx 21064
14514 Schedules as an EV4 and has no instruction set extensions.
14516 @item ev5
14517 @itemx 21164
14518 Schedules as an EV5 and has no instruction set extensions.
14520 @item ev56
14521 @itemx 21164a
14522 Schedules as an EV5 and supports the BWX extension.
14524 @item pca56
14525 @itemx 21164pc
14526 @itemx 21164PC
14527 Schedules as an EV5 and supports the BWX and MAX extensions.
14529 @item ev6
14530 @itemx 21264
14531 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14533 @item ev67
14534 @itemx 21264a
14535 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14536 @end table
14538 Native toolchains also support the value @samp{native},
14539 which selects the best architecture option for the host processor.
14540 @option{-mcpu=native} has no effect if GCC does not recognize
14541 the processor.
14543 @item -mtune=@var{cpu_type}
14544 @opindex mtune
14545 Set only the instruction scheduling parameters for machine type
14546 @var{cpu_type}.  The instruction set is not changed.
14548 Native toolchains also support the value @samp{native},
14549 which selects the best architecture option for the host processor.
14550 @option{-mtune=native} has no effect if GCC does not recognize
14551 the processor.
14553 @item -mmemory-latency=@var{time}
14554 @opindex mmemory-latency
14555 Sets the latency the scheduler should assume for typical memory
14556 references as seen by the application.  This number is highly
14557 dependent on the memory access patterns used by the application
14558 and the size of the external cache on the machine.
14560 Valid options for @var{time} are
14562 @table @samp
14563 @item @var{number}
14564 A decimal number representing clock cycles.
14566 @item L1
14567 @itemx L2
14568 @itemx L3
14569 @itemx main
14570 The compiler contains estimates of the number of clock cycles for
14571 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14572 (also called Dcache, Scache, and Bcache), as well as to main memory.
14573 Note that L3 is only valid for EV5.
14575 @end table
14576 @end table
14578 @node FR30 Options
14579 @subsection FR30 Options
14580 @cindex FR30 Options
14582 These options are defined specifically for the FR30 port.
14584 @table @gcctabopt
14586 @item -msmall-model
14587 @opindex msmall-model
14588 Use the small address space model.  This can produce smaller code, but
14589 it does assume that all symbolic values and addresses fit into a
14590 20-bit range.
14592 @item -mno-lsim
14593 @opindex mno-lsim
14594 Assume that runtime support has been provided and so there is no need
14595 to include the simulator library (@file{libsim.a}) on the linker
14596 command line.
14598 @end table
14600 @node FRV Options
14601 @subsection FRV Options
14602 @cindex FRV Options
14604 @table @gcctabopt
14605 @item -mgpr-32
14606 @opindex mgpr-32
14608 Only use the first 32 general-purpose registers.
14610 @item -mgpr-64
14611 @opindex mgpr-64
14613 Use all 64 general-purpose registers.
14615 @item -mfpr-32
14616 @opindex mfpr-32
14618 Use only the first 32 floating-point registers.
14620 @item -mfpr-64
14621 @opindex mfpr-64
14623 Use all 64 floating-point registers.
14625 @item -mhard-float
14626 @opindex mhard-float
14628 Use hardware instructions for floating-point operations.
14630 @item -msoft-float
14631 @opindex msoft-float
14633 Use library routines for floating-point operations.
14635 @item -malloc-cc
14636 @opindex malloc-cc
14638 Dynamically allocate condition code registers.
14640 @item -mfixed-cc
14641 @opindex mfixed-cc
14643 Do not try to dynamically allocate condition code registers, only
14644 use @code{icc0} and @code{fcc0}.
14646 @item -mdword
14647 @opindex mdword
14649 Change ABI to use double word insns.
14651 @item -mno-dword
14652 @opindex mno-dword
14654 Do not use double word instructions.
14656 @item -mdouble
14657 @opindex mdouble
14659 Use floating-point double instructions.
14661 @item -mno-double
14662 @opindex mno-double
14664 Do not use floating-point double instructions.
14666 @item -mmedia
14667 @opindex mmedia
14669 Use media instructions.
14671 @item -mno-media
14672 @opindex mno-media
14674 Do not use media instructions.
14676 @item -mmuladd
14677 @opindex mmuladd
14679 Use multiply and add/subtract instructions.
14681 @item -mno-muladd
14682 @opindex mno-muladd
14684 Do not use multiply and add/subtract instructions.
14686 @item -mfdpic
14687 @opindex mfdpic
14689 Select the FDPIC ABI, which uses function descriptors to represent
14690 pointers to functions.  Without any PIC/PIE-related options, it
14691 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14692 assumes GOT entries and small data are within a 12-bit range from the
14693 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14694 are computed with 32 bits.
14695 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14697 @item -minline-plt
14698 @opindex minline-plt
14700 Enable inlining of PLT entries in function calls to functions that are
14701 not known to bind locally.  It has no effect without @option{-mfdpic}.
14702 It's enabled by default if optimizing for speed and compiling for
14703 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14704 optimization option such as @option{-O3} or above is present in the
14705 command line.
14707 @item -mTLS
14708 @opindex mTLS
14710 Assume a large TLS segment when generating thread-local code.
14712 @item -mtls
14713 @opindex mtls
14715 Do not assume a large TLS segment when generating thread-local code.
14717 @item -mgprel-ro
14718 @opindex mgprel-ro
14720 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14721 that is known to be in read-only sections.  It's enabled by default,
14722 except for @option{-fpic} or @option{-fpie}: even though it may help
14723 make the global offset table smaller, it trades 1 instruction for 4.
14724 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14725 one of which may be shared by multiple symbols, and it avoids the need
14726 for a GOT entry for the referenced symbol, so it's more likely to be a
14727 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14729 @item -multilib-library-pic
14730 @opindex multilib-library-pic
14732 Link with the (library, not FD) pic libraries.  It's implied by
14733 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14734 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14735 it explicitly.
14737 @item -mlinked-fp
14738 @opindex mlinked-fp
14740 Follow the EABI requirement of always creating a frame pointer whenever
14741 a stack frame is allocated.  This option is enabled by default and can
14742 be disabled with @option{-mno-linked-fp}.
14744 @item -mlong-calls
14745 @opindex mlong-calls
14747 Use indirect addressing to call functions outside the current
14748 compilation unit.  This allows the functions to be placed anywhere
14749 within the 32-bit address space.
14751 @item -malign-labels
14752 @opindex malign-labels
14754 Try to align labels to an 8-byte boundary by inserting NOPs into the
14755 previous packet.  This option only has an effect when VLIW packing
14756 is enabled.  It doesn't create new packets; it merely adds NOPs to
14757 existing ones.
14759 @item -mlibrary-pic
14760 @opindex mlibrary-pic
14762 Generate position-independent EABI code.
14764 @item -macc-4
14765 @opindex macc-4
14767 Use only the first four media accumulator registers.
14769 @item -macc-8
14770 @opindex macc-8
14772 Use all eight media accumulator registers.
14774 @item -mpack
14775 @opindex mpack
14777 Pack VLIW instructions.
14779 @item -mno-pack
14780 @opindex mno-pack
14782 Do not pack VLIW instructions.
14784 @item -mno-eflags
14785 @opindex mno-eflags
14787 Do not mark ABI switches in e_flags.
14789 @item -mcond-move
14790 @opindex mcond-move
14792 Enable the use of conditional-move instructions (default).
14794 This switch is mainly for debugging the compiler and will likely be removed
14795 in a future version.
14797 @item -mno-cond-move
14798 @opindex mno-cond-move
14800 Disable the use of conditional-move instructions.
14802 This switch is mainly for debugging the compiler and will likely be removed
14803 in a future version.
14805 @item -mscc
14806 @opindex mscc
14808 Enable the use of conditional set instructions (default).
14810 This switch is mainly for debugging the compiler and will likely be removed
14811 in a future version.
14813 @item -mno-scc
14814 @opindex mno-scc
14816 Disable the use of conditional set instructions.
14818 This switch is mainly for debugging the compiler and will likely be removed
14819 in a future version.
14821 @item -mcond-exec
14822 @opindex mcond-exec
14824 Enable the use of conditional execution (default).
14826 This switch is mainly for debugging the compiler and will likely be removed
14827 in a future version.
14829 @item -mno-cond-exec
14830 @opindex mno-cond-exec
14832 Disable the use of conditional execution.
14834 This switch is mainly for debugging the compiler and will likely be removed
14835 in a future version.
14837 @item -mvliw-branch
14838 @opindex mvliw-branch
14840 Run a pass to pack branches into VLIW instructions (default).
14842 This switch is mainly for debugging the compiler and will likely be removed
14843 in a future version.
14845 @item -mno-vliw-branch
14846 @opindex mno-vliw-branch
14848 Do not run a pass to pack branches into VLIW instructions.
14850 This switch is mainly for debugging the compiler and will likely be removed
14851 in a future version.
14853 @item -mmulti-cond-exec
14854 @opindex mmulti-cond-exec
14856 Enable optimization of @code{&&} and @code{||} in conditional execution
14857 (default).
14859 This switch is mainly for debugging the compiler and will likely be removed
14860 in a future version.
14862 @item -mno-multi-cond-exec
14863 @opindex mno-multi-cond-exec
14865 Disable optimization of @code{&&} and @code{||} in conditional execution.
14867 This switch is mainly for debugging the compiler and will likely be removed
14868 in a future version.
14870 @item -mnested-cond-exec
14871 @opindex mnested-cond-exec
14873 Enable nested conditional execution optimizations (default).
14875 This switch is mainly for debugging the compiler and will likely be removed
14876 in a future version.
14878 @item -mno-nested-cond-exec
14879 @opindex mno-nested-cond-exec
14881 Disable nested conditional execution optimizations.
14883 This switch is mainly for debugging the compiler and will likely be removed
14884 in a future version.
14886 @item -moptimize-membar
14887 @opindex moptimize-membar
14889 This switch removes redundant @code{membar} instructions from the
14890 compiler-generated code.  It is enabled by default.
14892 @item -mno-optimize-membar
14893 @opindex mno-optimize-membar
14895 This switch disables the automatic removal of redundant @code{membar}
14896 instructions from the generated code.
14898 @item -mtomcat-stats
14899 @opindex mtomcat-stats
14901 Cause gas to print out tomcat statistics.
14903 @item -mcpu=@var{cpu}
14904 @opindex mcpu
14906 Select the processor type for which to generate code.  Possible values are
14907 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14908 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14910 @end table
14912 @node GNU/Linux Options
14913 @subsection GNU/Linux Options
14915 These @samp{-m} options are defined for GNU/Linux targets:
14917 @table @gcctabopt
14918 @item -mglibc
14919 @opindex mglibc
14920 Use the GNU C library.  This is the default except
14921 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14923 @item -muclibc
14924 @opindex muclibc
14925 Use uClibc C library.  This is the default on
14926 @samp{*-*-linux-*uclibc*} targets.
14928 @item -mbionic
14929 @opindex mbionic
14930 Use Bionic C library.  This is the default on
14931 @samp{*-*-linux-*android*} targets.
14933 @item -mandroid
14934 @opindex mandroid
14935 Compile code compatible with Android platform.  This is the default on
14936 @samp{*-*-linux-*android*} targets.
14938 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14939 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14940 this option makes the GCC driver pass Android-specific options to the linker.
14941 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14942 to be defined.
14944 @item -tno-android-cc
14945 @opindex tno-android-cc
14946 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14947 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14948 @option{-fno-rtti} by default.
14950 @item -tno-android-ld
14951 @opindex tno-android-ld
14952 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14953 linking options to the linker.
14955 @end table
14957 @node H8/300 Options
14958 @subsection H8/300 Options
14960 These @samp{-m} options are defined for the H8/300 implementations:
14962 @table @gcctabopt
14963 @item -mrelax
14964 @opindex mrelax
14965 Shorten some address references at link time, when possible; uses the
14966 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14967 ld, Using ld}, for a fuller description.
14969 @item -mh
14970 @opindex mh
14971 Generate code for the H8/300H@.
14973 @item -ms
14974 @opindex ms
14975 Generate code for the H8S@.
14977 @item -mn
14978 @opindex mn
14979 Generate code for the H8S and H8/300H in the normal mode.  This switch
14980 must be used either with @option{-mh} or @option{-ms}.
14982 @item -ms2600
14983 @opindex ms2600
14984 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14986 @item -mexr
14987 @opindex mexr
14988 Extended registers are stored on stack before execution of function
14989 with monitor attribute. Default option is @option{-mexr}.
14990 This option is valid only for H8S targets.
14992 @item -mno-exr
14993 @opindex mno-exr
14994 Extended registers are not stored on stack before execution of function 
14995 with monitor attribute. Default option is @option{-mno-exr}. 
14996 This option is valid only for H8S targets.
14998 @item -mint32
14999 @opindex mint32
15000 Make @code{int} data 32 bits by default.
15002 @item -malign-300
15003 @opindex malign-300
15004 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15005 The default for the H8/300H and H8S is to align longs and floats on
15006 4-byte boundaries.
15007 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15008 This option has no effect on the H8/300.
15009 @end table
15011 @node HPPA Options
15012 @subsection HPPA Options
15013 @cindex HPPA Options
15015 These @samp{-m} options are defined for the HPPA family of computers:
15017 @table @gcctabopt
15018 @item -march=@var{architecture-type}
15019 @opindex march
15020 Generate code for the specified architecture.  The choices for
15021 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15022 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15023 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15024 architecture option for your machine.  Code compiled for lower numbered
15025 architectures runs on higher numbered architectures, but not the
15026 other way around.
15028 @item -mpa-risc-1-0
15029 @itemx -mpa-risc-1-1
15030 @itemx -mpa-risc-2-0
15031 @opindex mpa-risc-1-0
15032 @opindex mpa-risc-1-1
15033 @opindex mpa-risc-2-0
15034 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15036 @item -mjump-in-delay
15037 @opindex mjump-in-delay
15038 This option is ignored and provided for compatibility purposes only.
15040 @item -mdisable-fpregs
15041 @opindex mdisable-fpregs
15042 Prevent floating-point registers from being used in any manner.  This is
15043 necessary for compiling kernels that perform lazy context switching of
15044 floating-point registers.  If you use this option and attempt to perform
15045 floating-point operations, the compiler aborts.
15047 @item -mdisable-indexing
15048 @opindex mdisable-indexing
15049 Prevent the compiler from using indexing address modes.  This avoids some
15050 rather obscure problems when compiling MIG generated code under MACH@.
15052 @item -mno-space-regs
15053 @opindex mno-space-regs
15054 Generate code that assumes the target has no space registers.  This allows
15055 GCC to generate faster indirect calls and use unscaled index address modes.
15057 Such code is suitable for level 0 PA systems and kernels.
15059 @item -mfast-indirect-calls
15060 @opindex mfast-indirect-calls
15061 Generate code that assumes calls never cross space boundaries.  This
15062 allows GCC to emit code that performs faster indirect calls.
15064 This option does not work in the presence of shared libraries or nested
15065 functions.
15067 @item -mfixed-range=@var{register-range}
15068 @opindex mfixed-range
15069 Generate code treating the given register range as fixed registers.
15070 A fixed register is one that the register allocator cannot use.  This is
15071 useful when compiling kernel code.  A register range is specified as
15072 two registers separated by a dash.  Multiple register ranges can be
15073 specified separated by a comma.
15075 @item -mlong-load-store
15076 @opindex mlong-load-store
15077 Generate 3-instruction load and store sequences as sometimes required by
15078 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15079 the HP compilers.
15081 @item -mportable-runtime
15082 @opindex mportable-runtime
15083 Use the portable calling conventions proposed by HP for ELF systems.
15085 @item -mgas
15086 @opindex mgas
15087 Enable the use of assembler directives only GAS understands.
15089 @item -mschedule=@var{cpu-type}
15090 @opindex mschedule
15091 Schedule code according to the constraints for the machine type
15092 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15093 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15094 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15095 proper scheduling option for your machine.  The default scheduling is
15096 @samp{8000}.
15098 @item -mlinker-opt
15099 @opindex mlinker-opt
15100 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15101 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15102 linkers in which they give bogus error messages when linking some programs.
15104 @item -msoft-float
15105 @opindex msoft-float
15106 Generate output containing library calls for floating point.
15107 @strong{Warning:} the requisite libraries are not available for all HPPA
15108 targets.  Normally the facilities of the machine's usual C compiler are
15109 used, but this cannot be done directly in cross-compilation.  You must make
15110 your own arrangements to provide suitable library functions for
15111 cross-compilation.
15113 @option{-msoft-float} changes the calling convention in the output file;
15114 therefore, it is only useful if you compile @emph{all} of a program with
15115 this option.  In particular, you need to compile @file{libgcc.a}, the
15116 library that comes with GCC, with @option{-msoft-float} in order for
15117 this to work.
15119 @item -msio
15120 @opindex msio
15121 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15122 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15123 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15124 options are available under HP-UX and HI-UX@.
15126 @item -mgnu-ld
15127 @opindex mgnu-ld
15128 Use options specific to GNU @command{ld}.
15129 This passes @option{-shared} to @command{ld} when
15130 building a shared library.  It is the default when GCC is configured,
15131 explicitly or implicitly, with the GNU linker.  This option does not
15132 affect which @command{ld} is called; it only changes what parameters
15133 are passed to that @command{ld}.
15134 The @command{ld} that is called is determined by the
15135 @option{--with-ld} configure option, GCC's program search path, and
15136 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15137 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15138 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15140 @item -mhp-ld
15141 @opindex mhp-ld
15142 Use options specific to HP @command{ld}.
15143 This passes @option{-b} to @command{ld} when building
15144 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15145 links.  It is the default when GCC is configured, explicitly or
15146 implicitly, with the HP linker.  This option does not affect
15147 which @command{ld} is called; it only changes what parameters are passed to that
15148 @command{ld}.
15149 The @command{ld} that is called is determined by the @option{--with-ld}
15150 configure option, GCC's program search path, and finally by the user's
15151 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15152 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15153 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15155 @item -mlong-calls
15156 @opindex mno-long-calls
15157 Generate code that uses long call sequences.  This ensures that a call
15158 is always able to reach linker generated stubs.  The default is to generate
15159 long calls only when the distance from the call site to the beginning
15160 of the function or translation unit, as the case may be, exceeds a
15161 predefined limit set by the branch type being used.  The limits for
15162 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15163 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15164 240,000 bytes.
15166 Distances are measured from the beginning of functions when using the
15167 @option{-ffunction-sections} option, or when using the @option{-mgas}
15168 and @option{-mno-portable-runtime} options together under HP-UX with
15169 the SOM linker.
15171 It is normally not desirable to use this option as it degrades
15172 performance.  However, it may be useful in large applications,
15173 particularly when partial linking is used to build the application.
15175 The types of long calls used depends on the capabilities of the
15176 assembler and linker, and the type of code being generated.  The
15177 impact on systems that support long absolute calls, and long pic
15178 symbol-difference or pc-relative calls should be relatively small.
15179 However, an indirect call is used on 32-bit ELF systems in pic code
15180 and it is quite long.
15182 @item -munix=@var{unix-std}
15183 @opindex march
15184 Generate compiler predefines and select a startfile for the specified
15185 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15186 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15187 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15188 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15189 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15190 and later.
15192 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15193 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15194 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15195 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15196 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15197 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15199 It is @emph{important} to note that this option changes the interfaces
15200 for various library routines.  It also affects the operational behavior
15201 of the C library.  Thus, @emph{extreme} care is needed in using this
15202 option.
15204 Library code that is intended to operate with more than one UNIX
15205 standard must test, set and restore the variable @var{__xpg4_extended_mask}
15206 as appropriate.  Most GNU software doesn't provide this capability.
15208 @item -nolibdld
15209 @opindex nolibdld
15210 Suppress the generation of link options to search libdld.sl when the
15211 @option{-static} option is specified on HP-UX 10 and later.
15213 @item -static
15214 @opindex static
15215 The HP-UX implementation of setlocale in libc has a dependency on
15216 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15217 when the @option{-static} option is specified, special link options
15218 are needed to resolve this dependency.
15220 On HP-UX 10 and later, the GCC driver adds the necessary options to
15221 link with libdld.sl when the @option{-static} option is specified.
15222 This causes the resulting binary to be dynamic.  On the 64-bit port,
15223 the linkers generate dynamic binaries by default in any case.  The
15224 @option{-nolibdld} option can be used to prevent the GCC driver from
15225 adding these link options.
15227 @item -threads
15228 @opindex threads
15229 Add support for multithreading with the @dfn{dce thread} library
15230 under HP-UX@.  This option sets flags for both the preprocessor and
15231 linker.
15232 @end table
15234 @node i386 and x86-64 Options
15235 @subsection Intel 386 and AMD x86-64 Options
15236 @cindex i386 Options
15237 @cindex x86-64 Options
15238 @cindex Intel 386 Options
15239 @cindex AMD x86-64 Options
15241 These @samp{-m} options are defined for the i386 and x86-64 family of
15242 computers:
15244 @table @gcctabopt
15246 @item -march=@var{cpu-type}
15247 @opindex march
15248 Generate instructions for the machine type @var{cpu-type}.  In contrast to
15249 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
15250 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
15251 to generate code that may not run at all on processors other than the one
15252 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
15253 @option{-mtune=@var{cpu-type}}.
15255 The choices for @var{cpu-type} are:
15257 @table @samp
15258 @item native
15259 This selects the CPU to generate code for at compilation time by determining
15260 the processor type of the compiling machine.  Using @option{-march=native}
15261 enables all instruction subsets supported by the local machine (hence
15262 the result might not run on different machines).  Using @option{-mtune=native}
15263 produces code optimized for the local machine under the constraints
15264 of the selected instruction set.  
15266 @item i386
15267 Original Intel i386 CPU@.
15269 @item i486
15270 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
15272 @item i586
15273 @itemx pentium
15274 Intel Pentium CPU with no MMX support.
15276 @item pentium-mmx
15277 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
15279 @item pentiumpro
15280 Intel Pentium Pro CPU@.
15282 @item i686
15283 When used with @option{-march}, the Pentium Pro
15284 instruction set is used, so the code runs on all i686 family chips.
15285 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
15287 @item pentium2
15288 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
15289 support.
15291 @item pentium3
15292 @itemx pentium3m
15293 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
15294 set support.
15296 @item pentium-m
15297 Intel Pentium M; low-power version of Intel Pentium III CPU
15298 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
15300 @item pentium4
15301 @itemx pentium4m
15302 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
15304 @item prescott
15305 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
15306 set support.
15308 @item nocona
15309 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
15310 SSE2 and SSE3 instruction set support.
15312 @item core2
15313 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
15314 instruction set support.
15316 @item nehalem
15317 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15318 SSE4.1, SSE4.2 and POPCNT instruction set support.
15320 @item westmere
15321 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15322 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
15324 @item sandybridge
15325 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15326 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
15328 @item ivybridge
15329 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15330 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
15331 instruction set support.
15333 @item haswell
15334 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15335 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15336 BMI, BMI2 and F16C instruction set support.
15338 @item broadwell
15339 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15340 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15341 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
15343 @item bonnell
15344 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
15345 instruction set support.
15347 @item silvermont
15348 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15349 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
15351 @item k6
15352 AMD K6 CPU with MMX instruction set support.
15354 @item k6-2
15355 @itemx k6-3
15356 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
15358 @item athlon
15359 @itemx athlon-tbird
15360 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
15361 support.
15363 @item athlon-4
15364 @itemx athlon-xp
15365 @itemx athlon-mp
15366 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
15367 instruction set support.
15369 @item k8
15370 @itemx opteron
15371 @itemx athlon64
15372 @itemx athlon-fx
15373 Processors based on the AMD K8 core with x86-64 instruction set support,
15374 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
15375 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
15376 instruction set extensions.)
15378 @item k8-sse3
15379 @itemx opteron-sse3
15380 @itemx athlon64-sse3
15381 Improved versions of AMD K8 cores with SSE3 instruction set support.
15383 @item amdfam10
15384 @itemx barcelona
15385 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
15386 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
15387 instruction set extensions.)
15389 @item bdver1
15390 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
15391 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
15392 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
15393 @item bdver2
15394 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15395 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
15396 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
15397 extensions.)
15398 @item bdver3
15399 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15400 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
15401 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
15402 64-bit instruction set extensions.
15403 @item bdver4
15404 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15405 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
15406 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
15407 SSE4.2, ABM and 64-bit instruction set extensions.
15409 @item btver1
15410 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
15411 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
15412 instruction set extensions.)
15414 @item btver2
15415 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
15416 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
15417 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
15419 @item winchip-c6
15420 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15421 set support.
15423 @item winchip2
15424 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15425 instruction set support.
15427 @item c3
15428 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15429 implemented for this chip.)
15431 @item c3-2
15432 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15433 (No scheduling is
15434 implemented for this chip.)
15436 @item geode
15437 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15438 @end table
15440 @item -mtune=@var{cpu-type}
15441 @opindex mtune
15442 Tune to @var{cpu-type} everything applicable about the generated code, except
15443 for the ABI and the set of available instructions.  
15444 While picking a specific @var{cpu-type} schedules things appropriately
15445 for that particular chip, the compiler does not generate any code that
15446 cannot run on the default machine type unless you use a
15447 @option{-march=@var{cpu-type}} option.
15448 For example, if GCC is configured for i686-pc-linux-gnu
15449 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15450 but still runs on i686 machines.
15452 The choices for @var{cpu-type} are the same as for @option{-march}.
15453 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15455 @table @samp
15456 @item generic
15457 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15458 If you know the CPU on which your code will run, then you should use
15459 the corresponding @option{-mtune} or @option{-march} option instead of
15460 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15461 of your application will have, then you should use this option.
15463 As new processors are deployed in the marketplace, the behavior of this
15464 option will change.  Therefore, if you upgrade to a newer version of
15465 GCC, code generation controlled by this option will change to reflect
15466 the processors
15467 that are most common at the time that version of GCC is released.
15469 There is no @option{-march=generic} option because @option{-march}
15470 indicates the instruction set the compiler can use, and there is no
15471 generic instruction set applicable to all processors.  In contrast,
15472 @option{-mtune} indicates the processor (or, in this case, collection of
15473 processors) for which the code is optimized.
15475 @item intel
15476 Produce code optimized for the most current Intel processors, which are
15477 Haswell and Silvermont for this version of GCC.  If you know the CPU
15478 on which your code will run, then you should use the corresponding
15479 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15480 But, if you want your application performs better on both Haswell and
15481 Silvermont, then you should use this option.
15483 As new Intel processors are deployed in the marketplace, the behavior of
15484 this option will change.  Therefore, if you upgrade to a newer version of
15485 GCC, code generation controlled by this option will change to reflect
15486 the most current Intel processors at the time that version of GCC is
15487 released.
15489 There is no @option{-march=intel} option because @option{-march} indicates
15490 the instruction set the compiler can use, and there is no common
15491 instruction set applicable to all processors.  In contrast,
15492 @option{-mtune} indicates the processor (or, in this case, collection of
15493 processors) for which the code is optimized.
15494 @end table
15496 @item -mcpu=@var{cpu-type}
15497 @opindex mcpu
15498 A deprecated synonym for @option{-mtune}.
15500 @item -mfpmath=@var{unit}
15501 @opindex mfpmath
15502 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15503 for @var{unit} are:
15505 @table @samp
15506 @item 387
15507 Use the standard 387 floating-point coprocessor present on the majority of chips and
15508 emulated otherwise.  Code compiled with this option runs almost everywhere.
15509 The temporary results are computed in 80-bit precision instead of the precision
15510 specified by the type, resulting in slightly different results compared to most
15511 of other chips.  See @option{-ffloat-store} for more detailed description.
15513 This is the default choice for i386 compiler.
15515 @item sse
15516 Use scalar floating-point instructions present in the SSE instruction set.
15517 This instruction set is supported by Pentium III and newer chips,
15518 and in the AMD line
15519 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15520 instruction set supports only single-precision arithmetic, thus the double and
15521 extended-precision arithmetic are still done using 387.  A later version, present
15522 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15523 arithmetic too.
15525 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15526 or @option{-msse2} switches to enable SSE extensions and make this option
15527 effective.  For the x86-64 compiler, these extensions are enabled by default.
15529 The resulting code should be considerably faster in the majority of cases and avoid
15530 the numerical instability problems of 387 code, but may break some existing
15531 code that expects temporaries to be 80 bits.
15533 This is the default choice for the x86-64 compiler.
15535 @item sse,387
15536 @itemx sse+387
15537 @itemx both
15538 Attempt to utilize both instruction sets at once.  This effectively doubles the
15539 amount of available registers, and on chips with separate execution units for
15540 387 and SSE the execution resources too.  Use this option with care, as it is
15541 still experimental, because the GCC register allocator does not model separate
15542 functional units well, resulting in unstable performance.
15543 @end table
15545 @item -masm=@var{dialect}
15546 @opindex masm=@var{dialect}
15547 Output assembly instructions using selected @var{dialect}.  Supported
15548 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15549 not support @samp{intel}.
15551 @item -mieee-fp
15552 @itemx -mno-ieee-fp
15553 @opindex mieee-fp
15554 @opindex mno-ieee-fp
15555 Control whether or not the compiler uses IEEE floating-point
15556 comparisons.  These correctly handle the case where the result of a
15557 comparison is unordered.
15559 @item -msoft-float
15560 @opindex msoft-float
15561 Generate output containing library calls for floating point.
15563 @strong{Warning:} the requisite libraries are not part of GCC@.
15564 Normally the facilities of the machine's usual C compiler are used, but
15565 this can't be done directly in cross-compilation.  You must make your
15566 own arrangements to provide suitable library functions for
15567 cross-compilation.
15569 On machines where a function returns floating-point results in the 80387
15570 register stack, some floating-point opcodes may be emitted even if
15571 @option{-msoft-float} is used.
15573 @item -mno-fp-ret-in-387
15574 @opindex mno-fp-ret-in-387
15575 Do not use the FPU registers for return values of functions.
15577 The usual calling convention has functions return values of types
15578 @code{float} and @code{double} in an FPU register, even if there
15579 is no FPU@.  The idea is that the operating system should emulate
15580 an FPU@.
15582 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15583 in ordinary CPU registers instead.
15585 @item -mno-fancy-math-387
15586 @opindex mno-fancy-math-387
15587 Some 387 emulators do not support the @code{sin}, @code{cos} and
15588 @code{sqrt} instructions for the 387.  Specify this option to avoid
15589 generating those instructions.  This option is the default on FreeBSD,
15590 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15591 indicates that the target CPU always has an FPU and so the
15592 instruction does not need emulation.  These
15593 instructions are not generated unless you also use the
15594 @option{-funsafe-math-optimizations} switch.
15596 @item -malign-double
15597 @itemx -mno-align-double
15598 @opindex malign-double
15599 @opindex mno-align-double
15600 Control whether GCC aligns @code{double}, @code{long double}, and
15601 @code{long long} variables on a two-word boundary or a one-word
15602 boundary.  Aligning @code{double} variables on a two-word boundary
15603 produces code that runs somewhat faster on a Pentium at the
15604 expense of more memory.
15606 On x86-64, @option{-malign-double} is enabled by default.
15608 @strong{Warning:} if you use the @option{-malign-double} switch,
15609 structures containing the above types are aligned differently than
15610 the published application binary interface specifications for the 386
15611 and are not binary compatible with structures in code compiled
15612 without that switch.
15614 @item -m96bit-long-double
15615 @itemx -m128bit-long-double
15616 @opindex m96bit-long-double
15617 @opindex m128bit-long-double
15618 These switches control the size of @code{long double} type.  The i386
15619 application binary interface specifies the size to be 96 bits,
15620 so @option{-m96bit-long-double} is the default in 32-bit mode.
15622 Modern architectures (Pentium and newer) prefer @code{long double}
15623 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15624 conforming to the ABI, this is not possible.  So specifying
15625 @option{-m128bit-long-double} aligns @code{long double}
15626 to a 16-byte boundary by padding the @code{long double} with an additional
15627 32-bit zero.
15629 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15630 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15632 Notice that neither of these options enable any extra precision over the x87
15633 standard of 80 bits for a @code{long double}.
15635 @strong{Warning:} if you override the default value for your target ABI, this
15636 changes the size of 
15637 structures and arrays containing @code{long double} variables,
15638 as well as modifying the function calling convention for functions taking
15639 @code{long double}.  Hence they are not binary-compatible
15640 with code compiled without that switch.
15642 @item -mlong-double-64
15643 @itemx -mlong-double-80
15644 @itemx -mlong-double-128
15645 @opindex mlong-double-64
15646 @opindex mlong-double-80
15647 @opindex mlong-double-128
15648 These switches control the size of @code{long double} type. A size
15649 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15650 type. This is the default for 32-bit Bionic C library.  A size
15651 of 128 bits makes the @code{long double} type equivalent to the
15652 @code{__float128} type. This is the default for 64-bit Bionic C library.
15654 @strong{Warning:} if you override the default value for your target ABI, this
15655 changes the size of
15656 structures and arrays containing @code{long double} variables,
15657 as well as modifying the function calling convention for functions taking
15658 @code{long double}.  Hence they are not binary-compatible
15659 with code compiled without that switch.
15661 @item -mlarge-data-threshold=@var{threshold}
15662 @opindex mlarge-data-threshold
15663 When @option{-mcmodel=medium} is specified, data objects larger than
15664 @var{threshold} are placed in the large data section.  This value must be the
15665 same across all objects linked into the binary, and defaults to 65535.
15667 @item -mrtd
15668 @opindex mrtd
15669 Use a different function-calling convention, in which functions that
15670 take a fixed number of arguments return with the @code{ret @var{num}}
15671 instruction, which pops their arguments while returning.  This saves one
15672 instruction in the caller since there is no need to pop the arguments
15673 there.
15675 You can specify that an individual function is called with this calling
15676 sequence with the function attribute @samp{stdcall}.  You can also
15677 override the @option{-mrtd} option by using the function attribute
15678 @samp{cdecl}.  @xref{Function Attributes}.
15680 @strong{Warning:} this calling convention is incompatible with the one
15681 normally used on Unix, so you cannot use it if you need to call
15682 libraries compiled with the Unix compiler.
15684 Also, you must provide function prototypes for all functions that
15685 take variable numbers of arguments (including @code{printf});
15686 otherwise incorrect code is generated for calls to those
15687 functions.
15689 In addition, seriously incorrect code results if you call a
15690 function with too many arguments.  (Normally, extra arguments are
15691 harmlessly ignored.)
15693 @item -mregparm=@var{num}
15694 @opindex mregparm
15695 Control how many registers are used to pass integer arguments.  By
15696 default, no registers are used to pass arguments, and at most 3
15697 registers can be used.  You can control this behavior for a specific
15698 function by using the function attribute @samp{regparm}.
15699 @xref{Function Attributes}.
15701 @strong{Warning:} if you use this switch, and
15702 @var{num} is nonzero, then you must build all modules with the same
15703 value, including any libraries.  This includes the system libraries and
15704 startup modules.
15706 @item -msseregparm
15707 @opindex msseregparm
15708 Use SSE register passing conventions for float and double arguments
15709 and return values.  You can control this behavior for a specific
15710 function by using the function attribute @samp{sseregparm}.
15711 @xref{Function Attributes}.
15713 @strong{Warning:} if you use this switch then you must build all
15714 modules with the same value, including any libraries.  This includes
15715 the system libraries and startup modules.
15717 @item -mvect8-ret-in-mem
15718 @opindex mvect8-ret-in-mem
15719 Return 8-byte vectors in memory instead of MMX registers.  This is the
15720 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15721 Studio compilers until version 12.  Later compiler versions (starting
15722 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15723 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15724 you need to remain compatible with existing code produced by those
15725 previous compiler versions or older versions of GCC@.
15727 @item -mpc32
15728 @itemx -mpc64
15729 @itemx -mpc80
15730 @opindex mpc32
15731 @opindex mpc64
15732 @opindex mpc80
15734 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15735 is specified, the significands of results of floating-point operations are
15736 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15737 significands of results of floating-point operations to 53 bits (double
15738 precision) and @option{-mpc80} rounds the significands of results of
15739 floating-point operations to 64 bits (extended double precision), which is
15740 the default.  When this option is used, floating-point operations in higher
15741 precisions are not available to the programmer without setting the FPU
15742 control word explicitly.
15744 Setting the rounding of floating-point operations to less than the default
15745 80 bits can speed some programs by 2% or more.  Note that some mathematical
15746 libraries assume that extended-precision (80-bit) floating-point operations
15747 are enabled by default; routines in such libraries could suffer significant
15748 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15749 when this option is used to set the precision to less than extended precision.
15751 @item -mstackrealign
15752 @opindex mstackrealign
15753 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15754 option generates an alternate prologue and epilogue that realigns the
15755 run-time stack if necessary.  This supports mixing legacy codes that keep
15756 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15757 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15758 applicable to individual functions.
15760 @item -mpreferred-stack-boundary=@var{num}
15761 @opindex mpreferred-stack-boundary
15762 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15763 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15764 the default is 4 (16 bytes or 128 bits).
15766 @strong{Warning:} When generating code for the x86-64 architecture with
15767 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15768 used to keep the stack boundary aligned to 8 byte boundary.  Since
15769 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15770 intended to be used in controlled environment where stack space is
15771 important limitation.  This option will lead to wrong code when functions
15772 compiled with 16 byte stack alignment (such as functions from a standard
15773 library) are called with misaligned stack.  In this case, SSE
15774 instructions may lead to misaligned memory access traps.  In addition,
15775 variable arguments will be handled incorrectly for 16 byte aligned
15776 objects (including x87 long double and __int128), leading to wrong
15777 results.  You must build all modules with
15778 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15779 includes the system libraries and startup modules.
15781 @item -mincoming-stack-boundary=@var{num}
15782 @opindex mincoming-stack-boundary
15783 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15784 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15785 the one specified by @option{-mpreferred-stack-boundary} is used.
15787 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15788 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15789 suffer significant run time performance penalties.  On Pentium III, the
15790 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15791 properly if it is not 16-byte aligned.
15793 To ensure proper alignment of this values on the stack, the stack boundary
15794 must be as aligned as that required by any value stored on the stack.
15795 Further, every function must be generated such that it keeps the stack
15796 aligned.  Thus calling a function compiled with a higher preferred
15797 stack boundary from a function compiled with a lower preferred stack
15798 boundary most likely misaligns the stack.  It is recommended that
15799 libraries that use callbacks always use the default setting.
15801 This extra alignment does consume extra stack space, and generally
15802 increases code size.  Code that is sensitive to stack space usage, such
15803 as embedded systems and operating system kernels, may want to reduce the
15804 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15806 @item -mmmx
15807 @itemx -mno-mmx
15808 @itemx -msse
15809 @itemx -mno-sse
15810 @itemx -msse2
15811 @itemx -mno-sse2
15812 @itemx -msse3
15813 @itemx -mno-sse3
15814 @itemx -mssse3
15815 @itemx -mno-ssse3
15816 @itemx -msse4.1
15817 @need 800
15818 @itemx -mno-sse4.1
15819 @itemx -msse4.2
15820 @itemx -mno-sse4.2
15821 @itemx -msse4
15822 @itemx -mno-sse4
15823 @itemx -mavx
15824 @itemx -mno-avx
15825 @itemx -mavx2
15826 @itemx -mno-avx2
15827 @itemx -mavx512f
15828 @itemx -mno-avx512f
15829 @need 800
15830 @itemx -mavx512pf
15831 @itemx -mno-avx512pf
15832 @itemx -mavx512er
15833 @itemx -mno-avx512er
15834 @itemx -mavx512cd
15835 @itemx -mno-avx512cd
15836 @itemx -msha
15837 @itemx -mno-sha
15838 @itemx -maes
15839 @itemx -mno-aes
15840 @itemx -mpclmul
15841 @itemx -mno-pclmul
15842 @itemx -mclfushopt
15843 @itemx -mno-clflsuhopt
15844 @need 800
15845 @itemx -mfsgsbase
15846 @itemx -mno-fsgsbase
15847 @itemx -mrdrnd
15848 @itemx -mno-rdrnd
15849 @itemx -mf16c
15850 @itemx -mno-f16c
15851 @itemx -mfma
15852 @itemx -mno-fma
15853 @itemx -mprefetchwt1
15854 @itemx -mno-prefetchwt1
15855 @itemx -msse4a
15856 @itemx -mno-sse4a
15857 @itemx -mfma4
15858 @itemx -mno-fma4
15859 @need 800
15860 @itemx -mxop
15861 @itemx -mno-xop
15862 @itemx -mlwp
15863 @itemx -mno-lwp
15864 @itemx -m3dnow
15865 @itemx -mno-3dnow
15866 @itemx -mpopcnt
15867 @itemx -mno-popcnt
15868 @itemx -mabm
15869 @itemx -mno-abm
15870 @itemx -mbmi
15871 @itemx -mbmi2
15872 @itemx -mno-bmi
15873 @itemx -mno-bmi2
15874 @itemx -mlzcnt
15875 @itemx -mno-lzcnt
15876 @itemx -mfxsr
15877 @itemx -mxsave
15878 @itemx -mxsaveopt
15879 @itemx -mrtm
15880 @itemx -mtbm
15881 @itemx -mno-tbm
15882 @itemx -mxsavec
15883 @itemx -mno-xsavec
15884 @itemx -mxsaves
15885 @itemx -mno-xsaves
15886 @itemx -mmpx
15887 @itemx -mno-mpx
15888 @opindex mmmx
15889 @opindex mno-mmx
15890 @opindex msse
15891 @opindex mno-sse
15892 @opindex m3dnow
15893 @opindex mno-3dnow
15894 These switches enable or disable the use of instructions in the MMX, SSE,
15895 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15896 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15897 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
15898 extended instruction sets.
15899 These extensions are also available as built-in functions: see
15900 @ref{X86 Built-in Functions}, for details of the functions enabled and
15901 disabled by these switches.
15903 To generate SSE/SSE2 instructions automatically from floating-point
15904 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15906 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15907 generates new AVX instructions or AVX equivalence for all SSEx instructions
15908 when needed.
15910 These options enable GCC to use these extended instructions in
15911 generated code, even without @option{-mfpmath=sse}.  Applications that
15912 perform run-time CPU detection must compile separate files for each
15913 supported architecture, using the appropriate flags.  In particular,
15914 the file containing the CPU detection code should be compiled without
15915 these options.
15917 @item -mdump-tune-features
15918 @opindex mdump-tune-features
15919 This option instructs GCC to dump the names of the x86 performance 
15920 tuning features and default settings. The names can be used in 
15921 @option{-mtune-ctrl=@var{feature-list}}.
15923 @item -mtune-ctrl=@var{feature-list}
15924 @opindex mtune-ctrl=@var{feature-list}
15925 This option is used to do fine grain control of x86 code generation features.
15926 @var{feature-list} is a comma separated list of @var{feature} names. See also
15927 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15928 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15929 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15930 developers. Using it may lead to code paths not covered by testing and can
15931 potentially result in compiler ICEs or runtime errors.
15933 @item -mno-default
15934 @opindex mno-default
15935 This option instructs GCC to turn off all tunable features. See also 
15936 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15938 @item -mcld
15939 @opindex mcld
15940 This option instructs GCC to emit a @code{cld} instruction in the prologue
15941 of functions that use string instructions.  String instructions depend on
15942 the DF flag to select between autoincrement or autodecrement mode.  While the
15943 ABI specifies the DF flag to be cleared on function entry, some operating
15944 systems violate this specification by not clearing the DF flag in their
15945 exception dispatchers.  The exception handler can be invoked with the DF flag
15946 set, which leads to wrong direction mode when string instructions are used.
15947 This option can be enabled by default on 32-bit x86 targets by configuring
15948 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15949 instructions can be suppressed with the @option{-mno-cld} compiler option
15950 in this case.
15952 @item -mvzeroupper
15953 @opindex mvzeroupper
15954 This option instructs GCC to emit a @code{vzeroupper} instruction
15955 before a transfer of control flow out of the function to minimize
15956 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15957 intrinsics.
15959 @item -mprefer-avx128
15960 @opindex mprefer-avx128
15961 This option instructs GCC to use 128-bit AVX instructions instead of
15962 256-bit AVX instructions in the auto-vectorizer.
15964 @item -mcx16
15965 @opindex mcx16
15966 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15967 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15968 (or oword) data types.  
15969 This is useful for high-resolution counters that can be updated
15970 by multiple processors (or cores).  This instruction is generated as part of
15971 atomic built-in functions: see @ref{__sync Builtins} or
15972 @ref{__atomic Builtins} for details.
15974 @item -msahf
15975 @opindex msahf
15976 This option enables generation of @code{SAHF} instructions in 64-bit code.
15977 Early Intel Pentium 4 CPUs with Intel 64 support,
15978 prior to the introduction of Pentium 4 G1 step in December 2005,
15979 lacked the @code{LAHF} and @code{SAHF} instructions
15980 which were supported by AMD64.
15981 These are load and store instructions, respectively, for certain status flags.
15982 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15983 @code{drem}, and @code{remainder} built-in functions;
15984 see @ref{Other Builtins} for details.
15986 @item -mmovbe
15987 @opindex mmovbe
15988 This option enables use of the @code{movbe} instruction to implement
15989 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15991 @item -mcrc32
15992 @opindex mcrc32
15993 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15994 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15995 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15997 @item -mrecip
15998 @opindex mrecip
15999 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
16000 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
16001 with an additional Newton-Raphson step
16002 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
16003 (and their vectorized
16004 variants) for single-precision floating-point arguments.  These instructions
16005 are generated only when @option{-funsafe-math-optimizations} is enabled
16006 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
16007 Note that while the throughput of the sequence is higher than the throughput
16008 of the non-reciprocal instruction, the precision of the sequence can be
16009 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
16011 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
16012 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
16013 combination), and doesn't need @option{-mrecip}.
16015 Also note that GCC emits the above sequence with additional Newton-Raphson step
16016 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
16017 already with @option{-ffast-math} (or the above option combination), and
16018 doesn't need @option{-mrecip}.
16020 @item -mrecip=@var{opt}
16021 @opindex mrecip=opt
16022 This option controls which reciprocal estimate instructions
16023 may be used.  @var{opt} is a comma-separated list of options, which may
16024 be preceded by a @samp{!} to invert the option:
16026 @table @samp
16027 @item all
16028 Enable all estimate instructions.
16030 @item default
16031 Enable the default instructions, equivalent to @option{-mrecip}.
16033 @item none
16034 Disable all estimate instructions, equivalent to @option{-mno-recip}.
16036 @item div
16037 Enable the approximation for scalar division.
16039 @item vec-div
16040 Enable the approximation for vectorized division.
16042 @item sqrt
16043 Enable the approximation for scalar square root.
16045 @item vec-sqrt
16046 Enable the approximation for vectorized square root.
16047 @end table
16049 So, for example, @option{-mrecip=all,!sqrt} enables
16050 all of the reciprocal approximations, except for square root.
16052 @item -mveclibabi=@var{type}
16053 @opindex mveclibabi
16054 Specifies the ABI type to use for vectorizing intrinsics using an
16055 external library.  Supported values for @var{type} are @samp{svml} 
16056 for the Intel short
16057 vector math library and @samp{acml} for the AMD math core library.
16058 To use this option, both @option{-ftree-vectorize} and
16059 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
16060 ABI-compatible library must be specified at link time.
16062 GCC currently emits calls to @code{vmldExp2},
16063 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
16064 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
16065 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
16066 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
16067 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
16068 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
16069 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
16070 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
16071 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
16072 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
16073 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
16074 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
16075 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
16076 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
16077 when @option{-mveclibabi=acml} is used.  
16079 @item -mabi=@var{name}
16080 @opindex mabi
16081 Generate code for the specified calling convention.  Permissible values
16082 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
16083 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
16084 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
16085 You can control this behavior for a specific function by
16086 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
16087 @xref{Function Attributes}.
16089 @item -mtls-dialect=@var{type}
16090 @opindex mtls-dialect
16091 Generate code to access thread-local storage using the @samp{gnu} or
16092 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
16093 @samp{gnu2} is more efficient, but it may add compile- and run-time
16094 requirements that cannot be satisfied on all systems.
16096 @item -mpush-args
16097 @itemx -mno-push-args
16098 @opindex mpush-args
16099 @opindex mno-push-args
16100 Use PUSH operations to store outgoing parameters.  This method is shorter
16101 and usually equally fast as method using SUB/MOV operations and is enabled
16102 by default.  In some cases disabling it may improve performance because of
16103 improved scheduling and reduced dependencies.
16105 @item -maccumulate-outgoing-args
16106 @opindex maccumulate-outgoing-args
16107 If enabled, the maximum amount of space required for outgoing arguments is
16108 computed in the function prologue.  This is faster on most modern CPUs
16109 because of reduced dependencies, improved scheduling and reduced stack usage
16110 when the preferred stack boundary is not equal to 2.  The drawback is a notable
16111 increase in code size.  This switch implies @option{-mno-push-args}.
16113 @item -mthreads
16114 @opindex mthreads
16115 Support thread-safe exception handling on MinGW.  Programs that rely
16116 on thread-safe exception handling must compile and link all code with the
16117 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
16118 @code{-D_MT}; when linking, it links in a special thread helper library
16119 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
16121 @item -mno-align-stringops
16122 @opindex mno-align-stringops
16123 Do not align the destination of inlined string operations.  This switch reduces
16124 code size and improves performance in case the destination is already aligned,
16125 but GCC doesn't know about it.
16127 @item -minline-all-stringops
16128 @opindex minline-all-stringops
16129 By default GCC inlines string operations only when the destination is 
16130 known to be aligned to least a 4-byte boundary.  
16131 This enables more inlining and increases code
16132 size, but may improve performance of code that depends on fast
16133 @code{memcpy}, @code{strlen},
16134 and @code{memset} for short lengths.
16136 @item -minline-stringops-dynamically
16137 @opindex minline-stringops-dynamically
16138 For string operations of unknown size, use run-time checks with
16139 inline code for small blocks and a library call for large blocks.
16141 @item -mstringop-strategy=@var{alg}
16142 @opindex mstringop-strategy=@var{alg}
16143 Override the internal decision heuristic for the particular algorithm to use
16144 for inlining string operations.  The allowed values for @var{alg} are:
16146 @table @samp
16147 @item rep_byte
16148 @itemx rep_4byte
16149 @itemx rep_8byte
16150 Expand using i386 @code{rep} prefix of the specified size.
16152 @item byte_loop
16153 @itemx loop
16154 @itemx unrolled_loop
16155 Expand into an inline loop.
16157 @item libcall
16158 Always use a library call.
16159 @end table
16161 @item -mmemcpy-strategy=@var{strategy}
16162 @opindex mmemcpy-strategy=@var{strategy}
16163 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
16164 should be inlined and what inline algorithm to use when the expected size
16165 of the copy operation is known. @var{strategy} 
16166 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
16167 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
16168 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
16169 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
16170 in the list must be specified in increasing order.  The minimal byte size for 
16171 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
16172 preceding range.
16174 @item -mmemset-strategy=@var{strategy}
16175 @opindex mmemset-strategy=@var{strategy}
16176 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
16177 @code{__builtin_memset} expansion.
16179 @item -momit-leaf-frame-pointer
16180 @opindex momit-leaf-frame-pointer
16181 Don't keep the frame pointer in a register for leaf functions.  This
16182 avoids the instructions to save, set up, and restore frame pointers and
16183 makes an extra register available in leaf functions.  The option
16184 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
16185 which might make debugging harder.
16187 @item -mtls-direct-seg-refs
16188 @itemx -mno-tls-direct-seg-refs
16189 @opindex mtls-direct-seg-refs
16190 Controls whether TLS variables may be accessed with offsets from the
16191 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
16192 or whether the thread base pointer must be added.  Whether or not this
16193 is valid depends on the operating system, and whether it maps the
16194 segment to cover the entire TLS area.
16196 For systems that use the GNU C Library, the default is on.
16198 @item -msse2avx
16199 @itemx -mno-sse2avx
16200 @opindex msse2avx
16201 Specify that the assembler should encode SSE instructions with VEX
16202 prefix.  The option @option{-mavx} turns this on by default.
16204 @item -mfentry
16205 @itemx -mno-fentry
16206 @opindex mfentry
16207 If profiling is active (@option{-pg}), put the profiling
16208 counter call before the prologue.
16209 Note: On x86 architectures the attribute @code{ms_hook_prologue}
16210 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
16212 @item -mrecord-mcount
16213 @itemx -mno-record-mcount
16214 @opindex mrecord-mcount
16215 If profiling is active (@option{-pg}), generate a __mcount_loc section
16216 that contains pointers to each profiling call. This is useful for
16217 automatically patching and out calls.
16219 @item -mnop-mcount
16220 @itemx -mno-nop-mcount
16221 @opindex mnop-mcount
16222 If profiling is active (@option{-pg}), generate the calls to
16223 the profiling functions as nops. This is useful when they
16224 should be patched in later dynamically. This is likely only
16225 useful together with @option{-mrecord-mcount}.
16227 @item -m8bit-idiv
16228 @itemx -mno-8bit-idiv
16229 @opindex 8bit-idiv
16230 On some processors, like Intel Atom, 8-bit unsigned integer divide is
16231 much faster than 32-bit/64-bit integer divide.  This option generates a
16232 run-time check.  If both dividend and divisor are within range of 0
16233 to 255, 8-bit unsigned integer divide is used instead of
16234 32-bit/64-bit integer divide.
16236 @item -mavx256-split-unaligned-load
16237 @itemx -mavx256-split-unaligned-store
16238 @opindex avx256-split-unaligned-load
16239 @opindex avx256-split-unaligned-store
16240 Split 32-byte AVX unaligned load and store.
16242 @item -mstack-protector-guard=@var{guard}
16243 @opindex mstack-protector-guard=@var{guard}
16244 Generate stack protection code using canary at @var{guard}.  Supported
16245 locations are @samp{global} for global canary or @samp{tls} for per-thread
16246 canary in the TLS block (the default).  This option has effect only when
16247 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
16249 @end table
16251 These @samp{-m} switches are supported in addition to the above
16252 on x86-64 processors in 64-bit environments.
16254 @table @gcctabopt
16255 @item -m32
16256 @itemx -m64
16257 @itemx -mx32
16258 @itemx -m16
16259 @opindex m32
16260 @opindex m64
16261 @opindex mx32
16262 @opindex m16
16263 Generate code for a 16-bit, 32-bit or 64-bit environment.
16264 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
16265 to 32 bits, and
16266 generates code that runs on any i386 system.
16268 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
16269 types to 64 bits, and generates code for the x86-64 architecture.
16270 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
16271 and @option{-mdynamic-no-pic} options.
16273 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
16274 to 32 bits, and
16275 generates code for the x86-64 architecture.
16277 The @option{-m16} option is the same as @option{-m32}, except for that
16278 it outputs the @code{.code16gcc} assembly directive at the beginning of
16279 the assembly output so that the binary can run in 16-bit mode.
16281 @item -mno-red-zone
16282 @opindex mno-red-zone
16283 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
16284 by the x86-64 ABI; it is a 128-byte area beyond the location of the
16285 stack pointer that is not modified by signal or interrupt handlers
16286 and therefore can be used for temporary data without adjusting the stack
16287 pointer.  The flag @option{-mno-red-zone} disables this red zone.
16289 @item -mcmodel=small
16290 @opindex mcmodel=small
16291 Generate code for the small code model: the program and its symbols must
16292 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
16293 Programs can be statically or dynamically linked.  This is the default
16294 code model.
16296 @item -mcmodel=kernel
16297 @opindex mcmodel=kernel
16298 Generate code for the kernel code model.  The kernel runs in the
16299 negative 2 GB of the address space.
16300 This model has to be used for Linux kernel code.
16302 @item -mcmodel=medium
16303 @opindex mcmodel=medium
16304 Generate code for the medium model: the program is linked in the lower 2
16305 GB of the address space.  Small symbols are also placed there.  Symbols
16306 with sizes larger than @option{-mlarge-data-threshold} are put into
16307 large data or BSS sections and can be located above 2GB.  Programs can
16308 be statically or dynamically linked.
16310 @item -mcmodel=large
16311 @opindex mcmodel=large
16312 Generate code for the large model.  This model makes no assumptions
16313 about addresses and sizes of sections.
16315 @item -maddress-mode=long
16316 @opindex maddress-mode=long
16317 Generate code for long address mode.  This is only supported for 64-bit
16318 and x32 environments.  It is the default address mode for 64-bit
16319 environments.
16321 @item -maddress-mode=short
16322 @opindex maddress-mode=short
16323 Generate code for short address mode.  This is only supported for 32-bit
16324 and x32 environments.  It is the default address mode for 32-bit and
16325 x32 environments.
16326 @end table
16328 @node i386 and x86-64 Windows Options
16329 @subsection i386 and x86-64 Windows Options
16330 @cindex i386 and x86-64 Windows Options
16332 These additional options are available for Microsoft Windows targets:
16334 @table @gcctabopt
16335 @item -mconsole
16336 @opindex mconsole
16337 This option
16338 specifies that a console application is to be generated, by
16339 instructing the linker to set the PE header subsystem type
16340 required for console applications.
16341 This option is available for Cygwin and MinGW targets and is
16342 enabled by default on those targets.
16344 @item -mdll
16345 @opindex mdll
16346 This option is available for Cygwin and MinGW targets.  It
16347 specifies that a DLL---a dynamic link library---is to be
16348 generated, enabling the selection of the required runtime
16349 startup object and entry point.
16351 @item -mnop-fun-dllimport
16352 @opindex mnop-fun-dllimport
16353 This option is available for Cygwin and MinGW targets.  It
16354 specifies that the @code{dllimport} attribute should be ignored.
16356 @item -mthread
16357 @opindex mthread
16358 This option is available for MinGW targets. It specifies
16359 that MinGW-specific thread support is to be used.
16361 @item -municode
16362 @opindex municode
16363 This option is available for MinGW-w64 targets.  It causes
16364 the @code{UNICODE} preprocessor macro to be predefined, and
16365 chooses Unicode-capable runtime startup code.
16367 @item -mwin32
16368 @opindex mwin32
16369 This option is available for Cygwin and MinGW targets.  It
16370 specifies that the typical Microsoft Windows predefined macros are to
16371 be set in the pre-processor, but does not influence the choice
16372 of runtime library/startup code.
16374 @item -mwindows
16375 @opindex mwindows
16376 This option is available for Cygwin and MinGW targets.  It
16377 specifies that a GUI application is to be generated by
16378 instructing the linker to set the PE header subsystem type
16379 appropriately.
16381 @item -fno-set-stack-executable
16382 @opindex fno-set-stack-executable
16383 This option is available for MinGW targets. It specifies that
16384 the executable flag for the stack used by nested functions isn't
16385 set. This is necessary for binaries running in kernel mode of
16386 Microsoft Windows, as there the User32 API, which is used to set executable
16387 privileges, isn't available.
16389 @item -fwritable-relocated-rdata
16390 @opindex fno-writable-relocated-rdata
16391 This option is available for MinGW and Cygwin targets.  It specifies
16392 that relocated-data in read-only section is put into .data
16393 section.  This is a necessary for older runtimes not supporting
16394 modification of .rdata sections for pseudo-relocation.
16396 @item -mpe-aligned-commons
16397 @opindex mpe-aligned-commons
16398 This option is available for Cygwin and MinGW targets.  It
16399 specifies that the GNU extension to the PE file format that
16400 permits the correct alignment of COMMON variables should be
16401 used when generating code.  It is enabled by default if
16402 GCC detects that the target assembler found during configuration
16403 supports the feature.
16404 @end table
16406 See also under @ref{i386 and x86-64 Options} for standard options.
16408 @node IA-64 Options
16409 @subsection IA-64 Options
16410 @cindex IA-64 Options
16412 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16414 @table @gcctabopt
16415 @item -mbig-endian
16416 @opindex mbig-endian
16417 Generate code for a big-endian target.  This is the default for HP-UX@.
16419 @item -mlittle-endian
16420 @opindex mlittle-endian
16421 Generate code for a little-endian target.  This is the default for AIX5
16422 and GNU/Linux.
16424 @item -mgnu-as
16425 @itemx -mno-gnu-as
16426 @opindex mgnu-as
16427 @opindex mno-gnu-as
16428 Generate (or don't) code for the GNU assembler.  This is the default.
16429 @c Also, this is the default if the configure option @option{--with-gnu-as}
16430 @c is used.
16432 @item -mgnu-ld
16433 @itemx -mno-gnu-ld
16434 @opindex mgnu-ld
16435 @opindex mno-gnu-ld
16436 Generate (or don't) code for the GNU linker.  This is the default.
16437 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16438 @c is used.
16440 @item -mno-pic
16441 @opindex mno-pic
16442 Generate code that does not use a global pointer register.  The result
16443 is not position independent code, and violates the IA-64 ABI@.
16445 @item -mvolatile-asm-stop
16446 @itemx -mno-volatile-asm-stop
16447 @opindex mvolatile-asm-stop
16448 @opindex mno-volatile-asm-stop
16449 Generate (or don't) a stop bit immediately before and after volatile asm
16450 statements.
16452 @item -mregister-names
16453 @itemx -mno-register-names
16454 @opindex mregister-names
16455 @opindex mno-register-names
16456 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16457 the stacked registers.  This may make assembler output more readable.
16459 @item -mno-sdata
16460 @itemx -msdata
16461 @opindex mno-sdata
16462 @opindex msdata
16463 Disable (or enable) optimizations that use the small data section.  This may
16464 be useful for working around optimizer bugs.
16466 @item -mconstant-gp
16467 @opindex mconstant-gp
16468 Generate code that uses a single constant global pointer value.  This is
16469 useful when compiling kernel code.
16471 @item -mauto-pic
16472 @opindex mauto-pic
16473 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16474 This is useful when compiling firmware code.
16476 @item -minline-float-divide-min-latency
16477 @opindex minline-float-divide-min-latency
16478 Generate code for inline divides of floating-point values
16479 using the minimum latency algorithm.
16481 @item -minline-float-divide-max-throughput
16482 @opindex minline-float-divide-max-throughput
16483 Generate code for inline divides of floating-point values
16484 using the maximum throughput algorithm.
16486 @item -mno-inline-float-divide
16487 @opindex mno-inline-float-divide
16488 Do not generate inline code for divides of floating-point values.
16490 @item -minline-int-divide-min-latency
16491 @opindex minline-int-divide-min-latency
16492 Generate code for inline divides of integer values
16493 using the minimum latency algorithm.
16495 @item -minline-int-divide-max-throughput
16496 @opindex minline-int-divide-max-throughput
16497 Generate code for inline divides of integer values
16498 using the maximum throughput algorithm.
16500 @item -mno-inline-int-divide
16501 @opindex mno-inline-int-divide
16502 Do not generate inline code for divides of integer values.
16504 @item -minline-sqrt-min-latency
16505 @opindex minline-sqrt-min-latency
16506 Generate code for inline square roots
16507 using the minimum latency algorithm.
16509 @item -minline-sqrt-max-throughput
16510 @opindex minline-sqrt-max-throughput
16511 Generate code for inline square roots
16512 using the maximum throughput algorithm.
16514 @item -mno-inline-sqrt
16515 @opindex mno-inline-sqrt
16516 Do not generate inline code for @code{sqrt}.
16518 @item -mfused-madd
16519 @itemx -mno-fused-madd
16520 @opindex mfused-madd
16521 @opindex mno-fused-madd
16522 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16523 instructions.  The default is to use these instructions.
16525 @item -mno-dwarf2-asm
16526 @itemx -mdwarf2-asm
16527 @opindex mno-dwarf2-asm
16528 @opindex mdwarf2-asm
16529 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16530 info.  This may be useful when not using the GNU assembler.
16532 @item -mearly-stop-bits
16533 @itemx -mno-early-stop-bits
16534 @opindex mearly-stop-bits
16535 @opindex mno-early-stop-bits
16536 Allow stop bits to be placed earlier than immediately preceding the
16537 instruction that triggered the stop bit.  This can improve instruction
16538 scheduling, but does not always do so.
16540 @item -mfixed-range=@var{register-range}
16541 @opindex mfixed-range
16542 Generate code treating the given register range as fixed registers.
16543 A fixed register is one that the register allocator cannot use.  This is
16544 useful when compiling kernel code.  A register range is specified as
16545 two registers separated by a dash.  Multiple register ranges can be
16546 specified separated by a comma.
16548 @item -mtls-size=@var{tls-size}
16549 @opindex mtls-size
16550 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16553 @item -mtune=@var{cpu-type}
16554 @opindex mtune
16555 Tune the instruction scheduling for a particular CPU, Valid values are
16556 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16557 and @samp{mckinley}.
16559 @item -milp32
16560 @itemx -mlp64
16561 @opindex milp32
16562 @opindex mlp64
16563 Generate code for a 32-bit or 64-bit environment.
16564 The 32-bit environment sets int, long and pointer to 32 bits.
16565 The 64-bit environment sets int to 32 bits and long and pointer
16566 to 64 bits.  These are HP-UX specific flags.
16568 @item -mno-sched-br-data-spec
16569 @itemx -msched-br-data-spec
16570 @opindex mno-sched-br-data-spec
16571 @opindex msched-br-data-spec
16572 (Dis/En)able data speculative scheduling before reload.
16573 This results in generation of @code{ld.a} instructions and
16574 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16575 The default is 'disable'.
16577 @item -msched-ar-data-spec
16578 @itemx -mno-sched-ar-data-spec
16579 @opindex msched-ar-data-spec
16580 @opindex mno-sched-ar-data-spec
16581 (En/Dis)able data speculative scheduling after reload.
16582 This results in generation of @code{ld.a} instructions and
16583 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16584 The default is 'enable'.
16586 @item -mno-sched-control-spec
16587 @itemx -msched-control-spec
16588 @opindex mno-sched-control-spec
16589 @opindex msched-control-spec
16590 (Dis/En)able control speculative scheduling.  This feature is
16591 available only during region scheduling (i.e.@: before reload).
16592 This results in generation of the @code{ld.s} instructions and
16593 the corresponding check instructions @code{chk.s}.
16594 The default is 'disable'.
16596 @item -msched-br-in-data-spec
16597 @itemx -mno-sched-br-in-data-spec
16598 @opindex msched-br-in-data-spec
16599 @opindex mno-sched-br-in-data-spec
16600 (En/Dis)able speculative scheduling of the instructions that
16601 are dependent on the data speculative loads before reload.
16602 This is effective only with @option{-msched-br-data-spec} enabled.
16603 The default is 'enable'.
16605 @item -msched-ar-in-data-spec
16606 @itemx -mno-sched-ar-in-data-spec
16607 @opindex msched-ar-in-data-spec
16608 @opindex mno-sched-ar-in-data-spec
16609 (En/Dis)able speculative scheduling of the instructions that
16610 are dependent on the data speculative loads after reload.
16611 This is effective only with @option{-msched-ar-data-spec} enabled.
16612 The default is 'enable'.
16614 @item -msched-in-control-spec
16615 @itemx -mno-sched-in-control-spec
16616 @opindex msched-in-control-spec
16617 @opindex mno-sched-in-control-spec
16618 (En/Dis)able speculative scheduling of the instructions that
16619 are dependent on the control speculative loads.
16620 This is effective only with @option{-msched-control-spec} enabled.
16621 The default is 'enable'.
16623 @item -mno-sched-prefer-non-data-spec-insns
16624 @itemx -msched-prefer-non-data-spec-insns
16625 @opindex mno-sched-prefer-non-data-spec-insns
16626 @opindex msched-prefer-non-data-spec-insns
16627 If enabled, data-speculative instructions are chosen for schedule
16628 only if there are no other choices at the moment.  This makes
16629 the use of the data speculation much more conservative.
16630 The default is 'disable'.
16632 @item -mno-sched-prefer-non-control-spec-insns
16633 @itemx -msched-prefer-non-control-spec-insns
16634 @opindex mno-sched-prefer-non-control-spec-insns
16635 @opindex msched-prefer-non-control-spec-insns
16636 If enabled, control-speculative instructions are chosen for schedule
16637 only if there are no other choices at the moment.  This makes
16638 the use of the control speculation much more conservative.
16639 The default is 'disable'.
16641 @item -mno-sched-count-spec-in-critical-path
16642 @itemx -msched-count-spec-in-critical-path
16643 @opindex mno-sched-count-spec-in-critical-path
16644 @opindex msched-count-spec-in-critical-path
16645 If enabled, speculative dependencies are considered during
16646 computation of the instructions priorities.  This makes the use of the
16647 speculation a bit more conservative.
16648 The default is 'disable'.
16650 @item -msched-spec-ldc
16651 @opindex msched-spec-ldc
16652 Use a simple data speculation check.  This option is on by default.
16654 @item -msched-control-spec-ldc
16655 @opindex msched-spec-ldc
16656 Use a simple check for control speculation.  This option is on by default.
16658 @item -msched-stop-bits-after-every-cycle
16659 @opindex msched-stop-bits-after-every-cycle
16660 Place a stop bit after every cycle when scheduling.  This option is on
16661 by default.
16663 @item -msched-fp-mem-deps-zero-cost
16664 @opindex msched-fp-mem-deps-zero-cost
16665 Assume that floating-point stores and loads are not likely to cause a conflict
16666 when placed into the same instruction group.  This option is disabled by
16667 default.
16669 @item -msel-sched-dont-check-control-spec
16670 @opindex msel-sched-dont-check-control-spec
16671 Generate checks for control speculation in selective scheduling.
16672 This flag is disabled by default.
16674 @item -msched-max-memory-insns=@var{max-insns}
16675 @opindex msched-max-memory-insns
16676 Limit on the number of memory insns per instruction group, giving lower
16677 priority to subsequent memory insns attempting to schedule in the same
16678 instruction group. Frequently useful to prevent cache bank conflicts.
16679 The default value is 1.
16681 @item -msched-max-memory-insns-hard-limit
16682 @opindex msched-max-memory-insns-hard-limit
16683 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16684 disallowing more than that number in an instruction group.
16685 Otherwise, the limit is ``soft'', meaning that non-memory operations
16686 are preferred when the limit is reached, but memory operations may still
16687 be scheduled.
16689 @end table
16691 @node LM32 Options
16692 @subsection LM32 Options
16693 @cindex LM32 options
16695 These @option{-m} options are defined for the LatticeMico32 architecture:
16697 @table @gcctabopt
16698 @item -mbarrel-shift-enabled
16699 @opindex mbarrel-shift-enabled
16700 Enable barrel-shift instructions.
16702 @item -mdivide-enabled
16703 @opindex mdivide-enabled
16704 Enable divide and modulus instructions.
16706 @item -mmultiply-enabled
16707 @opindex multiply-enabled
16708 Enable multiply instructions.
16710 @item -msign-extend-enabled
16711 @opindex msign-extend-enabled
16712 Enable sign extend instructions.
16714 @item -muser-enabled
16715 @opindex muser-enabled
16716 Enable user-defined instructions.
16718 @end table
16720 @node M32C Options
16721 @subsection M32C Options
16722 @cindex M32C options
16724 @table @gcctabopt
16725 @item -mcpu=@var{name}
16726 @opindex mcpu=
16727 Select the CPU for which code is generated.  @var{name} may be one of
16728 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16729 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16730 the M32C/80 series.
16732 @item -msim
16733 @opindex msim
16734 Specifies that the program will be run on the simulator.  This causes
16735 an alternate runtime library to be linked in which supports, for
16736 example, file I/O@.  You must not use this option when generating
16737 programs that will run on real hardware; you must provide your own
16738 runtime library for whatever I/O functions are needed.
16740 @item -memregs=@var{number}
16741 @opindex memregs=
16742 Specifies the number of memory-based pseudo-registers GCC uses
16743 during code generation.  These pseudo-registers are used like real
16744 registers, so there is a tradeoff between GCC's ability to fit the
16745 code into available registers, and the performance penalty of using
16746 memory instead of registers.  Note that all modules in a program must
16747 be compiled with the same value for this option.  Because of that, you
16748 must not use this option with GCC's default runtime libraries.
16750 @end table
16752 @node M32R/D Options
16753 @subsection M32R/D Options
16754 @cindex M32R/D options
16756 These @option{-m} options are defined for Renesas M32R/D architectures:
16758 @table @gcctabopt
16759 @item -m32r2
16760 @opindex m32r2
16761 Generate code for the M32R/2@.
16763 @item -m32rx
16764 @opindex m32rx
16765 Generate code for the M32R/X@.
16767 @item -m32r
16768 @opindex m32r
16769 Generate code for the M32R@.  This is the default.
16771 @item -mmodel=small
16772 @opindex mmodel=small
16773 Assume all objects live in the lower 16MB of memory (so that their addresses
16774 can be loaded with the @code{ld24} instruction), and assume all subroutines
16775 are reachable with the @code{bl} instruction.
16776 This is the default.
16778 The addressability of a particular object can be set with the
16779 @code{model} attribute.
16781 @item -mmodel=medium
16782 @opindex mmodel=medium
16783 Assume objects may be anywhere in the 32-bit address space (the compiler
16784 generates @code{seth/add3} instructions to load their addresses), and
16785 assume all subroutines are reachable with the @code{bl} instruction.
16787 @item -mmodel=large
16788 @opindex mmodel=large
16789 Assume objects may be anywhere in the 32-bit address space (the compiler
16790 generates @code{seth/add3} instructions to load their addresses), and
16791 assume subroutines may not be reachable with the @code{bl} instruction
16792 (the compiler generates the much slower @code{seth/add3/jl}
16793 instruction sequence).
16795 @item -msdata=none
16796 @opindex msdata=none
16797 Disable use of the small data area.  Variables are put into
16798 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16799 @code{section} attribute has been specified).
16800 This is the default.
16802 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16803 Objects may be explicitly put in the small data area with the
16804 @code{section} attribute using one of these sections.
16806 @item -msdata=sdata
16807 @opindex msdata=sdata
16808 Put small global and static data in the small data area, but do not
16809 generate special code to reference them.
16811 @item -msdata=use
16812 @opindex msdata=use
16813 Put small global and static data in the small data area, and generate
16814 special instructions to reference them.
16816 @item -G @var{num}
16817 @opindex G
16818 @cindex smaller data references
16819 Put global and static objects less than or equal to @var{num} bytes
16820 into the small data or BSS sections instead of the normal data or BSS
16821 sections.  The default value of @var{num} is 8.
16822 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16823 for this option to have any effect.
16825 All modules should be compiled with the same @option{-G @var{num}} value.
16826 Compiling with different values of @var{num} may or may not work; if it
16827 doesn't the linker gives an error message---incorrect code is not
16828 generated.
16830 @item -mdebug
16831 @opindex mdebug
16832 Makes the M32R-specific code in the compiler display some statistics
16833 that might help in debugging programs.
16835 @item -malign-loops
16836 @opindex malign-loops
16837 Align all loops to a 32-byte boundary.
16839 @item -mno-align-loops
16840 @opindex mno-align-loops
16841 Do not enforce a 32-byte alignment for loops.  This is the default.
16843 @item -missue-rate=@var{number}
16844 @opindex missue-rate=@var{number}
16845 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16846 or 2.
16848 @item -mbranch-cost=@var{number}
16849 @opindex mbranch-cost=@var{number}
16850 @var{number} can only be 1 or 2.  If it is 1 then branches are
16851 preferred over conditional code, if it is 2, then the opposite applies.
16853 @item -mflush-trap=@var{number}
16854 @opindex mflush-trap=@var{number}
16855 Specifies the trap number to use to flush the cache.  The default is
16856 12.  Valid numbers are between 0 and 15 inclusive.
16858 @item -mno-flush-trap
16859 @opindex mno-flush-trap
16860 Specifies that the cache cannot be flushed by using a trap.
16862 @item -mflush-func=@var{name}
16863 @opindex mflush-func=@var{name}
16864 Specifies the name of the operating system function to call to flush
16865 the cache.  The default is @emph{_flush_cache}, but a function call
16866 is only used if a trap is not available.
16868 @item -mno-flush-func
16869 @opindex mno-flush-func
16870 Indicates that there is no OS function for flushing the cache.
16872 @end table
16874 @node M680x0 Options
16875 @subsection M680x0 Options
16876 @cindex M680x0 options
16878 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16879 The default settings depend on which architecture was selected when
16880 the compiler was configured; the defaults for the most common choices
16881 are given below.
16883 @table @gcctabopt
16884 @item -march=@var{arch}
16885 @opindex march
16886 Generate code for a specific M680x0 or ColdFire instruction set
16887 architecture.  Permissible values of @var{arch} for M680x0
16888 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16889 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16890 architectures are selected according to Freescale's ISA classification
16891 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16892 @samp{isab} and @samp{isac}.
16894 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16895 code for a ColdFire target.  The @var{arch} in this macro is one of the
16896 @option{-march} arguments given above.
16898 When used together, @option{-march} and @option{-mtune} select code
16899 that runs on a family of similar processors but that is optimized
16900 for a particular microarchitecture.
16902 @item -mcpu=@var{cpu}
16903 @opindex mcpu
16904 Generate code for a specific M680x0 or ColdFire processor.
16905 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16906 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16907 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16908 below, which also classifies the CPUs into families:
16910 @multitable @columnfractions 0.20 0.80
16911 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16912 @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}
16913 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16914 @item @samp{5206e} @tab @samp{5206e}
16915 @item @samp{5208} @tab @samp{5207} @samp{5208}
16916 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16917 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16918 @item @samp{5216} @tab @samp{5214} @samp{5216}
16919 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16920 @item @samp{5225} @tab @samp{5224} @samp{5225}
16921 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16922 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16923 @item @samp{5249} @tab @samp{5249}
16924 @item @samp{5250} @tab @samp{5250}
16925 @item @samp{5271} @tab @samp{5270} @samp{5271}
16926 @item @samp{5272} @tab @samp{5272}
16927 @item @samp{5275} @tab @samp{5274} @samp{5275}
16928 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16929 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16930 @item @samp{5307} @tab @samp{5307}
16931 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16932 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16933 @item @samp{5407} @tab @samp{5407}
16934 @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}
16935 @end multitable
16937 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16938 @var{arch} is compatible with @var{cpu}.  Other combinations of
16939 @option{-mcpu} and @option{-march} are rejected.
16941 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16942 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16943 where the value of @var{family} is given by the table above.
16945 @item -mtune=@var{tune}
16946 @opindex mtune
16947 Tune the code for a particular microarchitecture within the
16948 constraints set by @option{-march} and @option{-mcpu}.
16949 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16950 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16951 and @samp{cpu32}.  The ColdFire microarchitectures
16952 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16954 You can also use @option{-mtune=68020-40} for code that needs
16955 to run relatively well on 68020, 68030 and 68040 targets.
16956 @option{-mtune=68020-60} is similar but includes 68060 targets
16957 as well.  These two options select the same tuning decisions as
16958 @option{-m68020-40} and @option{-m68020-60} respectively.
16960 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16961 when tuning for 680x0 architecture @var{arch}.  It also defines
16962 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16963 option is used.  If GCC is tuning for a range of architectures,
16964 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16965 it defines the macros for every architecture in the range.
16967 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16968 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16969 of the arguments given above.
16971 @item -m68000
16972 @itemx -mc68000
16973 @opindex m68000
16974 @opindex mc68000
16975 Generate output for a 68000.  This is the default
16976 when the compiler is configured for 68000-based systems.
16977 It is equivalent to @option{-march=68000}.
16979 Use this option for microcontrollers with a 68000 or EC000 core,
16980 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16982 @item -m68010
16983 @opindex m68010
16984 Generate output for a 68010.  This is the default
16985 when the compiler is configured for 68010-based systems.
16986 It is equivalent to @option{-march=68010}.
16988 @item -m68020
16989 @itemx -mc68020
16990 @opindex m68020
16991 @opindex mc68020
16992 Generate output for a 68020.  This is the default
16993 when the compiler is configured for 68020-based systems.
16994 It is equivalent to @option{-march=68020}.
16996 @item -m68030
16997 @opindex m68030
16998 Generate output for a 68030.  This is the default when the compiler is
16999 configured for 68030-based systems.  It is equivalent to
17000 @option{-march=68030}.
17002 @item -m68040
17003 @opindex m68040
17004 Generate output for a 68040.  This is the default when the compiler is
17005 configured for 68040-based systems.  It is equivalent to
17006 @option{-march=68040}.
17008 This option inhibits the use of 68881/68882 instructions that have to be
17009 emulated by software on the 68040.  Use this option if your 68040 does not
17010 have code to emulate those instructions.
17012 @item -m68060
17013 @opindex m68060
17014 Generate output for a 68060.  This is the default when the compiler is
17015 configured for 68060-based systems.  It is equivalent to
17016 @option{-march=68060}.
17018 This option inhibits the use of 68020 and 68881/68882 instructions that
17019 have to be emulated by software on the 68060.  Use this option if your 68060
17020 does not have code to emulate those instructions.
17022 @item -mcpu32
17023 @opindex mcpu32
17024 Generate output for a CPU32.  This is the default
17025 when the compiler is configured for CPU32-based systems.
17026 It is equivalent to @option{-march=cpu32}.
17028 Use this option for microcontrollers with a
17029 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
17030 68336, 68340, 68341, 68349 and 68360.
17032 @item -m5200
17033 @opindex m5200
17034 Generate output for a 520X ColdFire CPU@.  This is the default
17035 when the compiler is configured for 520X-based systems.
17036 It is equivalent to @option{-mcpu=5206}, and is now deprecated
17037 in favor of that option.
17039 Use this option for microcontroller with a 5200 core, including
17040 the MCF5202, MCF5203, MCF5204 and MCF5206.
17042 @item -m5206e
17043 @opindex m5206e
17044 Generate output for a 5206e ColdFire CPU@.  The option is now
17045 deprecated in favor of the equivalent @option{-mcpu=5206e}.
17047 @item -m528x
17048 @opindex m528x
17049 Generate output for a member of the ColdFire 528X family.
17050 The option is now deprecated in favor of the equivalent
17051 @option{-mcpu=528x}.
17053 @item -m5307
17054 @opindex m5307
17055 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
17056 in favor of the equivalent @option{-mcpu=5307}.
17058 @item -m5407
17059 @opindex m5407
17060 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
17061 in favor of the equivalent @option{-mcpu=5407}.
17063 @item -mcfv4e
17064 @opindex mcfv4e
17065 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
17066 This includes use of hardware floating-point instructions.
17067 The option is equivalent to @option{-mcpu=547x}, and is now
17068 deprecated in favor of that option.
17070 @item -m68020-40
17071 @opindex m68020-40
17072 Generate output for a 68040, without using any of the new instructions.
17073 This results in code that can run relatively efficiently on either a
17074 68020/68881 or a 68030 or a 68040.  The generated code does use the
17075 68881 instructions that are emulated on the 68040.
17077 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
17079 @item -m68020-60
17080 @opindex m68020-60
17081 Generate output for a 68060, without using any of the new instructions.
17082 This results in code that can run relatively efficiently on either a
17083 68020/68881 or a 68030 or a 68040.  The generated code does use the
17084 68881 instructions that are emulated on the 68060.
17086 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
17088 @item -mhard-float
17089 @itemx -m68881
17090 @opindex mhard-float
17091 @opindex m68881
17092 Generate floating-point instructions.  This is the default for 68020
17093 and above, and for ColdFire devices that have an FPU@.  It defines the
17094 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
17095 on ColdFire targets.
17097 @item -msoft-float
17098 @opindex msoft-float
17099 Do not generate floating-point instructions; use library calls instead.
17100 This is the default for 68000, 68010, and 68832 targets.  It is also
17101 the default for ColdFire devices that have no FPU.
17103 @item -mdiv
17104 @itemx -mno-div
17105 @opindex mdiv
17106 @opindex mno-div
17107 Generate (do not generate) ColdFire hardware divide and remainder
17108 instructions.  If @option{-march} is used without @option{-mcpu},
17109 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
17110 architectures.  Otherwise, the default is taken from the target CPU
17111 (either the default CPU, or the one specified by @option{-mcpu}).  For
17112 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
17113 @option{-mcpu=5206e}.
17115 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
17117 @item -mshort
17118 @opindex mshort
17119 Consider type @code{int} to be 16 bits wide, like @code{short int}.
17120 Additionally, parameters passed on the stack are also aligned to a
17121 16-bit boundary even on targets whose API mandates promotion to 32-bit.
17123 @item -mno-short
17124 @opindex mno-short
17125 Do not consider type @code{int} to be 16 bits wide.  This is the default.
17127 @item -mnobitfield
17128 @itemx -mno-bitfield
17129 @opindex mnobitfield
17130 @opindex mno-bitfield
17131 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
17132 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
17134 @item -mbitfield
17135 @opindex mbitfield
17136 Do use the bit-field instructions.  The @option{-m68020} option implies
17137 @option{-mbitfield}.  This is the default if you use a configuration
17138 designed for a 68020.
17140 @item -mrtd
17141 @opindex mrtd
17142 Use a different function-calling convention, in which functions
17143 that take a fixed number of arguments return with the @code{rtd}
17144 instruction, which pops their arguments while returning.  This
17145 saves one instruction in the caller since there is no need to pop
17146 the arguments there.
17148 This calling convention is incompatible with the one normally
17149 used on Unix, so you cannot use it if you need to call libraries
17150 compiled with the Unix compiler.
17152 Also, you must provide function prototypes for all functions that
17153 take variable numbers of arguments (including @code{printf});
17154 otherwise incorrect code is generated for calls to those
17155 functions.
17157 In addition, seriously incorrect code results if you call a
17158 function with too many arguments.  (Normally, extra arguments are
17159 harmlessly ignored.)
17161 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
17162 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
17164 @item -mno-rtd
17165 @opindex mno-rtd
17166 Do not use the calling conventions selected by @option{-mrtd}.
17167 This is the default.
17169 @item -malign-int
17170 @itemx -mno-align-int
17171 @opindex malign-int
17172 @opindex mno-align-int
17173 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
17174 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
17175 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
17176 Aligning variables on 32-bit boundaries produces code that runs somewhat
17177 faster on processors with 32-bit busses at the expense of more memory.
17179 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
17180 aligns structures containing the above types differently than
17181 most published application binary interface specifications for the m68k.
17183 @item -mpcrel
17184 @opindex mpcrel
17185 Use the pc-relative addressing mode of the 68000 directly, instead of
17186 using a global offset table.  At present, this option implies @option{-fpic},
17187 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
17188 not presently supported with @option{-mpcrel}, though this could be supported for
17189 68020 and higher processors.
17191 @item -mno-strict-align
17192 @itemx -mstrict-align
17193 @opindex mno-strict-align
17194 @opindex mstrict-align
17195 Do not (do) assume that unaligned memory references are handled by
17196 the system.
17198 @item -msep-data
17199 Generate code that allows the data segment to be located in a different
17200 area of memory from the text segment.  This allows for execute-in-place in
17201 an environment without virtual memory management.  This option implies
17202 @option{-fPIC}.
17204 @item -mno-sep-data
17205 Generate code that assumes that the data segment follows the text segment.
17206 This is the default.
17208 @item -mid-shared-library
17209 Generate code that supports shared libraries via the library ID method.
17210 This allows for execute-in-place and shared libraries in an environment
17211 without virtual memory management.  This option implies @option{-fPIC}.
17213 @item -mno-id-shared-library
17214 Generate code that doesn't assume ID-based shared libraries are being used.
17215 This is the default.
17217 @item -mshared-library-id=n
17218 Specifies the identification number of the ID-based shared library being
17219 compiled.  Specifying a value of 0 generates more compact code; specifying
17220 other values forces the allocation of that number to the current
17221 library, but is no more space- or time-efficient than omitting this option.
17223 @item -mxgot
17224 @itemx -mno-xgot
17225 @opindex mxgot
17226 @opindex mno-xgot
17227 When generating position-independent code for ColdFire, generate code
17228 that works if the GOT has more than 8192 entries.  This code is
17229 larger and slower than code generated without this option.  On M680x0
17230 processors, this option is not needed; @option{-fPIC} suffices.
17232 GCC normally uses a single instruction to load values from the GOT@.
17233 While this is relatively efficient, it only works if the GOT
17234 is smaller than about 64k.  Anything larger causes the linker
17235 to report an error such as:
17237 @cindex relocation truncated to fit (ColdFire)
17238 @smallexample
17239 relocation truncated to fit: R_68K_GOT16O foobar
17240 @end smallexample
17242 If this happens, you should recompile your code with @option{-mxgot}.
17243 It should then work with very large GOTs.  However, code generated with
17244 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17245 the value of a global symbol.
17247 Note that some linkers, including newer versions of the GNU linker,
17248 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17249 you should only need to use @option{-mxgot} when compiling a single
17250 object file that accesses more than 8192 GOT entries.  Very few do.
17252 These options have no effect unless GCC is generating
17253 position-independent code.
17255 @end table
17257 @node MCore Options
17258 @subsection MCore Options
17259 @cindex MCore options
17261 These are the @samp{-m} options defined for the Motorola M*Core
17262 processors.
17264 @table @gcctabopt
17266 @item -mhardlit
17267 @itemx -mno-hardlit
17268 @opindex mhardlit
17269 @opindex mno-hardlit
17270 Inline constants into the code stream if it can be done in two
17271 instructions or less.
17273 @item -mdiv
17274 @itemx -mno-div
17275 @opindex mdiv
17276 @opindex mno-div
17277 Use the divide instruction.  (Enabled by default).
17279 @item -mrelax-immediate
17280 @itemx -mno-relax-immediate
17281 @opindex mrelax-immediate
17282 @opindex mno-relax-immediate
17283 Allow arbitrary-sized immediates in bit operations.
17285 @item -mwide-bitfields
17286 @itemx -mno-wide-bitfields
17287 @opindex mwide-bitfields
17288 @opindex mno-wide-bitfields
17289 Always treat bit-fields as @code{int}-sized.
17291 @item -m4byte-functions
17292 @itemx -mno-4byte-functions
17293 @opindex m4byte-functions
17294 @opindex mno-4byte-functions
17295 Force all functions to be aligned to a 4-byte boundary.
17297 @item -mcallgraph-data
17298 @itemx -mno-callgraph-data
17299 @opindex mcallgraph-data
17300 @opindex mno-callgraph-data
17301 Emit callgraph information.
17303 @item -mslow-bytes
17304 @itemx -mno-slow-bytes
17305 @opindex mslow-bytes
17306 @opindex mno-slow-bytes
17307 Prefer word access when reading byte quantities.
17309 @item -mlittle-endian
17310 @itemx -mbig-endian
17311 @opindex mlittle-endian
17312 @opindex mbig-endian
17313 Generate code for a little-endian target.
17315 @item -m210
17316 @itemx -m340
17317 @opindex m210
17318 @opindex m340
17319 Generate code for the 210 processor.
17321 @item -mno-lsim
17322 @opindex mno-lsim
17323 Assume that runtime support has been provided and so omit the
17324 simulator library (@file{libsim.a)} from the linker command line.
17326 @item -mstack-increment=@var{size}
17327 @opindex mstack-increment
17328 Set the maximum amount for a single stack increment operation.  Large
17329 values can increase the speed of programs that contain functions
17330 that need a large amount of stack space, but they can also trigger a
17331 segmentation fault if the stack is extended too much.  The default
17332 value is 0x1000.
17334 @end table
17336 @node MeP Options
17337 @subsection MeP Options
17338 @cindex MeP options
17340 @table @gcctabopt
17342 @item -mabsdiff
17343 @opindex mabsdiff
17344 Enables the @code{abs} instruction, which is the absolute difference
17345 between two registers.
17347 @item -mall-opts
17348 @opindex mall-opts
17349 Enables all the optional instructions---average, multiply, divide, bit
17350 operations, leading zero, absolute difference, min/max, clip, and
17351 saturation.
17354 @item -maverage
17355 @opindex maverage
17356 Enables the @code{ave} instruction, which computes the average of two
17357 registers.
17359 @item -mbased=@var{n}
17360 @opindex mbased=
17361 Variables of size @var{n} bytes or smaller are placed in the
17362 @code{.based} section by default.  Based variables use the @code{$tp}
17363 register as a base register, and there is a 128-byte limit to the
17364 @code{.based} section.
17366 @item -mbitops
17367 @opindex mbitops
17368 Enables the bit operation instructions---bit test (@code{btstm}), set
17369 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17370 test-and-set (@code{tas}).
17372 @item -mc=@var{name}
17373 @opindex mc=
17374 Selects which section constant data is placed in.  @var{name} may
17375 be @code{tiny}, @code{near}, or @code{far}.
17377 @item -mclip
17378 @opindex mclip
17379 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
17380 useful unless you also provide @code{-mminmax}.
17382 @item -mconfig=@var{name}
17383 @opindex mconfig=
17384 Selects one of the built-in core configurations.  Each MeP chip has
17385 one or more modules in it; each module has a core CPU and a variety of
17386 coprocessors, optional instructions, and peripherals.  The
17387 @code{MeP-Integrator} tool, not part of GCC, provides these
17388 configurations through this option; using this option is the same as
17389 using all the corresponding command-line options.  The default
17390 configuration is @code{default}.
17392 @item -mcop
17393 @opindex mcop
17394 Enables the coprocessor instructions.  By default, this is a 32-bit
17395 coprocessor.  Note that the coprocessor is normally enabled via the
17396 @code{-mconfig=} option.
17398 @item -mcop32
17399 @opindex mcop32
17400 Enables the 32-bit coprocessor's instructions.
17402 @item -mcop64
17403 @opindex mcop64
17404 Enables the 64-bit coprocessor's instructions.
17406 @item -mivc2
17407 @opindex mivc2
17408 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17410 @item -mdc
17411 @opindex mdc
17412 Causes constant variables to be placed in the @code{.near} section.
17414 @item -mdiv
17415 @opindex mdiv
17416 Enables the @code{div} and @code{divu} instructions.
17418 @item -meb
17419 @opindex meb
17420 Generate big-endian code.
17422 @item -mel
17423 @opindex mel
17424 Generate little-endian code.
17426 @item -mio-volatile
17427 @opindex mio-volatile
17428 Tells the compiler that any variable marked with the @code{io}
17429 attribute is to be considered volatile.
17431 @item -ml
17432 @opindex ml
17433 Causes variables to be assigned to the @code{.far} section by default.
17435 @item -mleadz
17436 @opindex mleadz
17437 Enables the @code{leadz} (leading zero) instruction.
17439 @item -mm
17440 @opindex mm
17441 Causes variables to be assigned to the @code{.near} section by default.
17443 @item -mminmax
17444 @opindex mminmax
17445 Enables the @code{min} and @code{max} instructions.
17447 @item -mmult
17448 @opindex mmult
17449 Enables the multiplication and multiply-accumulate instructions.
17451 @item -mno-opts
17452 @opindex mno-opts
17453 Disables all the optional instructions enabled by @code{-mall-opts}.
17455 @item -mrepeat
17456 @opindex mrepeat
17457 Enables the @code{repeat} and @code{erepeat} instructions, used for
17458 low-overhead looping.
17460 @item -ms
17461 @opindex ms
17462 Causes all variables to default to the @code{.tiny} section.  Note
17463 that there is a 65536-byte limit to this section.  Accesses to these
17464 variables use the @code{%gp} base register.
17466 @item -msatur
17467 @opindex msatur
17468 Enables the saturation instructions.  Note that the compiler does not
17469 currently generate these itself, but this option is included for
17470 compatibility with other tools, like @code{as}.
17472 @item -msdram
17473 @opindex msdram
17474 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17476 @item -msim
17477 @opindex msim
17478 Link the simulator run-time libraries.
17480 @item -msimnovec
17481 @opindex msimnovec
17482 Link the simulator runtime libraries, excluding built-in support
17483 for reset and exception vectors and tables.
17485 @item -mtf
17486 @opindex mtf
17487 Causes all functions to default to the @code{.far} section.  Without
17488 this option, functions default to the @code{.near} section.
17490 @item -mtiny=@var{n}
17491 @opindex mtiny=
17492 Variables that are @var{n} bytes or smaller are allocated to the
17493 @code{.tiny} section.  These variables use the @code{$gp} base
17494 register.  The default for this option is 4, but note that there's a
17495 65536-byte limit to the @code{.tiny} section.
17497 @end table
17499 @node MicroBlaze Options
17500 @subsection MicroBlaze Options
17501 @cindex MicroBlaze Options
17503 @table @gcctabopt
17505 @item -msoft-float
17506 @opindex msoft-float
17507 Use software emulation for floating point (default).
17509 @item -mhard-float
17510 @opindex mhard-float
17511 Use hardware floating-point instructions.
17513 @item -mmemcpy
17514 @opindex mmemcpy
17515 Do not optimize block moves, use @code{memcpy}.
17517 @item -mno-clearbss
17518 @opindex mno-clearbss
17519 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17521 @item -mcpu=@var{cpu-type}
17522 @opindex mcpu=
17523 Use features of, and schedule code for, the given CPU.
17524 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17525 where @var{X} is a major version, @var{YY} is the minor version, and
17526 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17527 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17529 @item -mxl-soft-mul
17530 @opindex mxl-soft-mul
17531 Use software multiply emulation (default).
17533 @item -mxl-soft-div
17534 @opindex mxl-soft-div
17535 Use software emulation for divides (default).
17537 @item -mxl-barrel-shift
17538 @opindex mxl-barrel-shift
17539 Use the hardware barrel shifter.
17541 @item -mxl-pattern-compare
17542 @opindex mxl-pattern-compare
17543 Use pattern compare instructions.
17545 @item -msmall-divides
17546 @opindex msmall-divides
17547 Use table lookup optimization for small signed integer divisions.
17549 @item -mxl-stack-check
17550 @opindex mxl-stack-check
17551 This option is deprecated.  Use @option{-fstack-check} instead.
17553 @item -mxl-gp-opt
17554 @opindex mxl-gp-opt
17555 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17557 @item -mxl-multiply-high
17558 @opindex mxl-multiply-high
17559 Use multiply high instructions for high part of 32x32 multiply.
17561 @item -mxl-float-convert
17562 @opindex mxl-float-convert
17563 Use hardware floating-point conversion instructions.
17565 @item -mxl-float-sqrt
17566 @opindex mxl-float-sqrt
17567 Use hardware floating-point square root instruction.
17569 @item -mbig-endian
17570 @opindex mbig-endian
17571 Generate code for a big-endian target.
17573 @item -mlittle-endian
17574 @opindex mlittle-endian
17575 Generate code for a little-endian target.
17577 @item -mxl-reorder
17578 @opindex mxl-reorder
17579 Use reorder instructions (swap and byte reversed load/store).
17581 @item -mxl-mode-@var{app-model}
17582 Select application model @var{app-model}.  Valid models are
17583 @table @samp
17584 @item executable
17585 normal executable (default), uses startup code @file{crt0.o}.
17587 @item xmdstub
17588 for use with Xilinx Microprocessor Debugger (XMD) based
17589 software intrusive debug agent called xmdstub. This uses startup file
17590 @file{crt1.o} and sets the start address of the program to 0x800.
17592 @item bootstrap
17593 for applications that are loaded using a bootloader.
17594 This model uses startup file @file{crt2.o} which does not contain a processor
17595 reset vector handler. This is suitable for transferring control on a
17596 processor reset to the bootloader rather than the application.
17598 @item novectors
17599 for applications that do not require any of the
17600 MicroBlaze vectors. This option may be useful for applications running
17601 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17602 @end table
17604 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17605 @option{-mxl-mode-@var{app-model}}.
17607 @end table
17609 @node MIPS Options
17610 @subsection MIPS Options
17611 @cindex MIPS options
17613 @table @gcctabopt
17615 @item -EB
17616 @opindex EB
17617 Generate big-endian code.
17619 @item -EL
17620 @opindex EL
17621 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17622 configurations.
17624 @item -march=@var{arch}
17625 @opindex march
17626 Generate code that runs on @var{arch}, which can be the name of a
17627 generic MIPS ISA, or the name of a particular processor.
17628 The ISA names are:
17629 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17630 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5}, 
17631 @samp{mips64}, @samp{mips64r2}, @samp{mips64r3} and @samp{mips64r5}.
17632 The processor names are:
17633 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17634 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17635 @samp{5kc}, @samp{5kf},
17636 @samp{20kc},
17637 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17638 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17639 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17640 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17641 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17642 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17643 @samp{m4k},
17644 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17645 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17646 @samp{orion},
17647 @samp{p5600},
17648 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17649 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17650 @samp{rm7000}, @samp{rm9000},
17651 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17652 @samp{sb1},
17653 @samp{sr71000},
17654 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17655 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17656 @samp{xlr} and @samp{xlp}.
17657 The special value @samp{from-abi} selects the
17658 most compatible architecture for the selected ABI (that is,
17659 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17661 The native Linux/GNU toolchain also supports the value @samp{native},
17662 which selects the best architecture option for the host processor.
17663 @option{-march=native} has no effect if GCC does not recognize
17664 the processor.
17666 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17667 (for example, @option{-march=r2k}).  Prefixes are optional, and
17668 @samp{vr} may be written @samp{r}.
17670 Names of the form @samp{@var{n}f2_1} refer to processors with
17671 FPUs clocked at half the rate of the core, names of the form
17672 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17673 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17674 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17675 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17676 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17677 accepted as synonyms for @samp{@var{n}f1_1}.
17679 GCC defines two macros based on the value of this option.  The first
17680 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17681 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17682 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17683 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17684 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17686 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17687 above.  In other words, it has the full prefix and does not
17688 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17689 the macro names the resolved architecture (either @samp{"mips1"} or
17690 @samp{"mips3"}).  It names the default architecture when no
17691 @option{-march} option is given.
17693 @item -mtune=@var{arch}
17694 @opindex mtune
17695 Optimize for @var{arch}.  Among other things, this option controls
17696 the way instructions are scheduled, and the perceived cost of arithmetic
17697 operations.  The list of @var{arch} values is the same as for
17698 @option{-march}.
17700 When this option is not used, GCC optimizes for the processor
17701 specified by @option{-march}.  By using @option{-march} and
17702 @option{-mtune} together, it is possible to generate code that
17703 runs on a family of processors, but optimize the code for one
17704 particular member of that family.
17706 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17707 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17708 @option{-march} ones described above.
17710 @item -mips1
17711 @opindex mips1
17712 Equivalent to @option{-march=mips1}.
17714 @item -mips2
17715 @opindex mips2
17716 Equivalent to @option{-march=mips2}.
17718 @item -mips3
17719 @opindex mips3
17720 Equivalent to @option{-march=mips3}.
17722 @item -mips4
17723 @opindex mips4
17724 Equivalent to @option{-march=mips4}.
17726 @item -mips32
17727 @opindex mips32
17728 Equivalent to @option{-march=mips32}.
17730 @item -mips32r3
17731 @opindex mips32r3
17732 Equivalent to @option{-march=mips32r3}.
17734 @item -mips32r5
17735 @opindex mips32r5
17736 Equivalent to @option{-march=mips32r5}.
17738 @item -mips64
17739 @opindex mips64
17740 Equivalent to @option{-march=mips64}.
17742 @item -mips64r2
17743 @opindex mips64r2
17744 Equivalent to @option{-march=mips64r2}.
17746 @item -mips64r3
17747 @opindex mips64r3
17748 Equivalent to @option{-march=mips64r3}.
17750 @item -mips64r5
17751 @opindex mips64r5
17752 Equivalent to @option{-march=mips64r5}.
17754 @item -mips16
17755 @itemx -mno-mips16
17756 @opindex mips16
17757 @opindex mno-mips16
17758 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17759 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17761 MIPS16 code generation can also be controlled on a per-function basis
17762 by means of @code{mips16} and @code{nomips16} attributes.
17763 @xref{Function Attributes}, for more information.
17765 @item -mflip-mips16
17766 @opindex mflip-mips16
17767 Generate MIPS16 code on alternating functions.  This option is provided
17768 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17769 not intended for ordinary use in compiling user code.
17771 @item -minterlink-compressed
17772 @item -mno-interlink-compressed
17773 @opindex minterlink-compressed
17774 @opindex mno-interlink-compressed
17775 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17776 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17778 For example, code using the standard ISA encoding cannot jump directly
17779 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17780 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17781 knows that the target of the jump is not compressed.
17783 @item -minterlink-mips16
17784 @itemx -mno-interlink-mips16
17785 @opindex minterlink-mips16
17786 @opindex mno-interlink-mips16
17787 Aliases of @option{-minterlink-compressed} and
17788 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17789 and are retained for backwards compatibility.
17791 @item -mabi=32
17792 @itemx -mabi=o64
17793 @itemx -mabi=n32
17794 @itemx -mabi=64
17795 @itemx -mabi=eabi
17796 @opindex mabi=32
17797 @opindex mabi=o64
17798 @opindex mabi=n32
17799 @opindex mabi=64
17800 @opindex mabi=eabi
17801 Generate code for the given ABI@.
17803 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17804 generates 64-bit code when you select a 64-bit architecture, but you
17805 can use @option{-mgp32} to get 32-bit code instead.
17807 For information about the O64 ABI, see
17808 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17810 GCC supports a variant of the o32 ABI in which floating-point registers
17811 are 64 rather than 32 bits wide.  You can select this combination with
17812 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17813 and @code{mfhc1} instructions and is therefore only supported for
17814 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17816 The register assignments for arguments and return values remain the
17817 same, but each scalar value is passed in a single 64-bit register
17818 rather than a pair of 32-bit registers.  For example, scalar
17819 floating-point values are returned in @samp{$f0} only, not a
17820 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17821 remains the same in that the even-numbered double-precision registers
17822 are saved.
17824 Two additional variants of the o32 ABI are supported to enable
17825 a transition from 32-bit to 64-bit registers.  These are FPXX
17826 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17827 The FPXX extension mandates that all code must execute correctly
17828 when run using 32-bit or 64-bit registers.  The code can be interlinked
17829 with either FP32 or FP64, but not both.
17830 The FP64A extension is similar to the FP64 extension but forbids the
17831 use of odd-numbered single-precision registers.  This can be used
17832 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17833 processors and allows both FP32 and FP64A code to interlink and
17834 run in the same process without changing FPU modes.
17836 @item -mabicalls
17837 @itemx -mno-abicalls
17838 @opindex mabicalls
17839 @opindex mno-abicalls
17840 Generate (do not generate) code that is suitable for SVR4-style
17841 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17842 systems.
17844 @item -mshared
17845 @itemx -mno-shared
17846 Generate (do not generate) code that is fully position-independent,
17847 and that can therefore be linked into shared libraries.  This option
17848 only affects @option{-mabicalls}.
17850 All @option{-mabicalls} code has traditionally been position-independent,
17851 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17852 as an extension, the GNU toolchain allows executables to use absolute
17853 accesses for locally-binding symbols.  It can also use shorter GP
17854 initialization sequences and generate direct calls to locally-defined
17855 functions.  This mode is selected by @option{-mno-shared}.
17857 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17858 objects that can only be linked by the GNU linker.  However, the option
17859 does not affect the ABI of the final executable; it only affects the ABI
17860 of relocatable objects.  Using @option{-mno-shared} generally makes
17861 executables both smaller and quicker.
17863 @option{-mshared} is the default.
17865 @item -mplt
17866 @itemx -mno-plt
17867 @opindex mplt
17868 @opindex mno-plt
17869 Assume (do not assume) that the static and dynamic linkers
17870 support PLTs and copy relocations.  This option only affects
17871 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17872 has no effect without @option{-msym32}.
17874 You can make @option{-mplt} the default by configuring
17875 GCC with @option{--with-mips-plt}.  The default is
17876 @option{-mno-plt} otherwise.
17878 @item -mxgot
17879 @itemx -mno-xgot
17880 @opindex mxgot
17881 @opindex mno-xgot
17882 Lift (do not lift) the usual restrictions on the size of the global
17883 offset table.
17885 GCC normally uses a single instruction to load values from the GOT@.
17886 While this is relatively efficient, it only works if the GOT
17887 is smaller than about 64k.  Anything larger causes the linker
17888 to report an error such as:
17890 @cindex relocation truncated to fit (MIPS)
17891 @smallexample
17892 relocation truncated to fit: R_MIPS_GOT16 foobar
17893 @end smallexample
17895 If this happens, you should recompile your code with @option{-mxgot}.
17896 This works with very large GOTs, although the code is also
17897 less efficient, since it takes three instructions to fetch the
17898 value of a global symbol.
17900 Note that some linkers can create multiple GOTs.  If you have such a
17901 linker, you should only need to use @option{-mxgot} when a single object
17902 file accesses more than 64k's worth of GOT entries.  Very few do.
17904 These options have no effect unless GCC is generating position
17905 independent code.
17907 @item -mgp32
17908 @opindex mgp32
17909 Assume that general-purpose registers are 32 bits wide.
17911 @item -mgp64
17912 @opindex mgp64
17913 Assume that general-purpose registers are 64 bits wide.
17915 @item -mfp32
17916 @opindex mfp32
17917 Assume that floating-point registers are 32 bits wide.
17919 @item -mfp64
17920 @opindex mfp64
17921 Assume that floating-point registers are 64 bits wide.
17923 @item -mfpxx
17924 @opindex mfpxx
17925 Do not assume the width of floating-point registers.
17927 @item -mhard-float
17928 @opindex mhard-float
17929 Use floating-point coprocessor instructions.
17931 @item -msoft-float
17932 @opindex msoft-float
17933 Do not use floating-point coprocessor instructions.  Implement
17934 floating-point calculations using library calls instead.
17936 @item -mno-float
17937 @opindex mno-float
17938 Equivalent to @option{-msoft-float}, but additionally asserts that the
17939 program being compiled does not perform any floating-point operations.
17940 This option is presently supported only by some bare-metal MIPS
17941 configurations, where it may select a special set of libraries
17942 that lack all floating-point support (including, for example, the
17943 floating-point @code{printf} formats).  
17944 If code compiled with @code{-mno-float} accidentally contains
17945 floating-point operations, it is likely to suffer a link-time
17946 or run-time failure.
17948 @item -msingle-float
17949 @opindex msingle-float
17950 Assume that the floating-point coprocessor only supports single-precision
17951 operations.
17953 @item -mdouble-float
17954 @opindex mdouble-float
17955 Assume that the floating-point coprocessor supports double-precision
17956 operations.  This is the default.
17958 @item -modd-spreg
17959 @itemx -mno-odd-spreg
17960 @opindex modd-spreg
17961 @opindex mno-odd-spreg
17962 Enable the use of odd-numbered single-precision floating-point registers
17963 for the o32 ABI.  This is the default for processors that are known to
17964 support these registers.  When using the o32 FPXX ABI, @code{-mno-odd-spreg}
17965 is set by default.
17967 @item -mabs=2008
17968 @itemx -mabs=legacy
17969 @opindex mabs=2008
17970 @opindex mabs=legacy
17971 These options control the treatment of the special not-a-number (NaN)
17972 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17973 @code{neg.@i{fmt}} machine instructions.
17975 By default or when the @option{-mabs=legacy} is used the legacy
17976 treatment is selected.  In this case these instructions are considered
17977 arithmetic and avoided where correct operation is required and the
17978 input operand might be a NaN.  A longer sequence of instructions that
17979 manipulate the sign bit of floating-point datum manually is used
17980 instead unless the @option{-ffinite-math-only} option has also been
17981 specified.
17983 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17984 this case these instructions are considered non-arithmetic and therefore
17985 operating correctly in all cases, including in particular where the
17986 input operand is a NaN.  These instructions are therefore always used
17987 for the respective operations.
17989 @item -mnan=2008
17990 @itemx -mnan=legacy
17991 @opindex mnan=2008
17992 @opindex mnan=legacy
17993 These options control the encoding of the special not-a-number (NaN)
17994 IEEE 754 floating-point data.
17996 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17997 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17998 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17999 by the first bit of their trailing significand field being 1.
18001 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
18002 this case qNaNs are denoted by the first bit of their trailing
18003 significand field being 1, whereas sNaNs are denoted by the first bit of
18004 their trailing significand field being 0.
18006 The default is @option{-mnan=legacy} unless GCC has been configured with
18007 @option{--with-nan=2008}.
18009 @item -mllsc
18010 @itemx -mno-llsc
18011 @opindex mllsc
18012 @opindex mno-llsc
18013 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
18014 implement atomic memory built-in functions.  When neither option is
18015 specified, GCC uses the instructions if the target architecture
18016 supports them.
18018 @option{-mllsc} is useful if the runtime environment can emulate the
18019 instructions and @option{-mno-llsc} can be useful when compiling for
18020 nonstandard ISAs.  You can make either option the default by
18021 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
18022 respectively.  @option{--with-llsc} is the default for some
18023 configurations; see the installation documentation for details.
18025 @item -mdsp
18026 @itemx -mno-dsp
18027 @opindex mdsp
18028 @opindex mno-dsp
18029 Use (do not use) revision 1 of the MIPS DSP ASE@.
18030 @xref{MIPS DSP Built-in Functions}.  This option defines the
18031 preprocessor macro @samp{__mips_dsp}.  It also defines
18032 @samp{__mips_dsp_rev} to 1.
18034 @item -mdspr2
18035 @itemx -mno-dspr2
18036 @opindex mdspr2
18037 @opindex mno-dspr2
18038 Use (do not use) revision 2 of the MIPS DSP ASE@.
18039 @xref{MIPS DSP Built-in Functions}.  This option defines the
18040 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
18041 It also defines @samp{__mips_dsp_rev} to 2.
18043 @item -msmartmips
18044 @itemx -mno-smartmips
18045 @opindex msmartmips
18046 @opindex mno-smartmips
18047 Use (do not use) the MIPS SmartMIPS ASE.
18049 @item -mpaired-single
18050 @itemx -mno-paired-single
18051 @opindex mpaired-single
18052 @opindex mno-paired-single
18053 Use (do not use) paired-single floating-point instructions.
18054 @xref{MIPS Paired-Single Support}.  This option requires
18055 hardware floating-point support to be enabled.
18057 @item -mdmx
18058 @itemx -mno-mdmx
18059 @opindex mdmx
18060 @opindex mno-mdmx
18061 Use (do not use) MIPS Digital Media Extension instructions.
18062 This option can only be used when generating 64-bit code and requires
18063 hardware floating-point support to be enabled.
18065 @item -mips3d
18066 @itemx -mno-mips3d
18067 @opindex mips3d
18068 @opindex mno-mips3d
18069 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
18070 The option @option{-mips3d} implies @option{-mpaired-single}.
18072 @item -mmicromips
18073 @itemx -mno-micromips
18074 @opindex mmicromips
18075 @opindex mno-mmicromips
18076 Generate (do not generate) microMIPS code.
18078 MicroMIPS code generation can also be controlled on a per-function basis
18079 by means of @code{micromips} and @code{nomicromips} attributes.
18080 @xref{Function Attributes}, for more information.
18082 @item -mmt
18083 @itemx -mno-mt
18084 @opindex mmt
18085 @opindex mno-mt
18086 Use (do not use) MT Multithreading instructions.
18088 @item -mmcu
18089 @itemx -mno-mcu
18090 @opindex mmcu
18091 @opindex mno-mcu
18092 Use (do not use) the MIPS MCU ASE instructions.
18094 @item -meva
18095 @itemx -mno-eva
18096 @opindex meva
18097 @opindex mno-eva
18098 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
18100 @item -mvirt
18101 @itemx -mno-virt
18102 @opindex mvirt
18103 @opindex mno-virt
18104 Use (do not use) the MIPS Virtualization Application Specific instructions.
18106 @item -mxpa
18107 @itemx -mno-xpa
18108 @opindex mxpa
18109 @opindex mno-xpa
18110 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
18112 @item -mlong64
18113 @opindex mlong64
18114 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
18115 an explanation of the default and the way that the pointer size is
18116 determined.
18118 @item -mlong32
18119 @opindex mlong32
18120 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
18122 The default size of @code{int}s, @code{long}s and pointers depends on
18123 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
18124 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
18125 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
18126 or the same size as integer registers, whichever is smaller.
18128 @item -msym32
18129 @itemx -mno-sym32
18130 @opindex msym32
18131 @opindex mno-sym32
18132 Assume (do not assume) that all symbols have 32-bit values, regardless
18133 of the selected ABI@.  This option is useful in combination with
18134 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
18135 to generate shorter and faster references to symbolic addresses.
18137 @item -G @var{num}
18138 @opindex G
18139 Put definitions of externally-visible data in a small data section
18140 if that data is no bigger than @var{num} bytes.  GCC can then generate
18141 more efficient accesses to the data; see @option{-mgpopt} for details.
18143 The default @option{-G} option depends on the configuration.
18145 @item -mlocal-sdata
18146 @itemx -mno-local-sdata
18147 @opindex mlocal-sdata
18148 @opindex mno-local-sdata
18149 Extend (do not extend) the @option{-G} behavior to local data too,
18150 such as to static variables in C@.  @option{-mlocal-sdata} is the
18151 default for all configurations.
18153 If the linker complains that an application is using too much small data,
18154 you might want to try rebuilding the less performance-critical parts with
18155 @option{-mno-local-sdata}.  You might also want to build large
18156 libraries with @option{-mno-local-sdata}, so that the libraries leave
18157 more room for the main program.
18159 @item -mextern-sdata
18160 @itemx -mno-extern-sdata
18161 @opindex mextern-sdata
18162 @opindex mno-extern-sdata
18163 Assume (do not assume) that externally-defined data is in
18164 a small data section if the size of that data is within the @option{-G} limit.
18165 @option{-mextern-sdata} is the default for all configurations.
18167 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
18168 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
18169 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
18170 is placed in a small data section.  If @var{Var} is defined by another
18171 module, you must either compile that module with a high-enough
18172 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
18173 definition.  If @var{Var} is common, you must link the application
18174 with a high-enough @option{-G} setting.
18176 The easiest way of satisfying these restrictions is to compile
18177 and link every module with the same @option{-G} option.  However,
18178 you may wish to build a library that supports several different
18179 small data limits.  You can do this by compiling the library with
18180 the highest supported @option{-G} setting and additionally using
18181 @option{-mno-extern-sdata} to stop the library from making assumptions
18182 about externally-defined data.
18184 @item -mgpopt
18185 @itemx -mno-gpopt
18186 @opindex mgpopt
18187 @opindex mno-gpopt
18188 Use (do not use) GP-relative accesses for symbols that are known to be
18189 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
18190 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
18191 configurations.
18193 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
18194 might not hold the value of @code{_gp}.  For example, if the code is
18195 part of a library that might be used in a boot monitor, programs that
18196 call boot monitor routines pass an unknown value in @code{$gp}.
18197 (In such situations, the boot monitor itself is usually compiled
18198 with @option{-G0}.)
18200 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
18201 @option{-mno-extern-sdata}.
18203 @item -membedded-data
18204 @itemx -mno-embedded-data
18205 @opindex membedded-data
18206 @opindex mno-embedded-data
18207 Allocate variables to the read-only data section first if possible, then
18208 next in the small data section if possible, otherwise in data.  This gives
18209 slightly slower code than the default, but reduces the amount of RAM required
18210 when executing, and thus may be preferred for some embedded systems.
18212 @item -muninit-const-in-rodata
18213 @itemx -mno-uninit-const-in-rodata
18214 @opindex muninit-const-in-rodata
18215 @opindex mno-uninit-const-in-rodata
18216 Put uninitialized @code{const} variables in the read-only data section.
18217 This option is only meaningful in conjunction with @option{-membedded-data}.
18219 @item -mcode-readable=@var{setting}
18220 @opindex mcode-readable
18221 Specify whether GCC may generate code that reads from executable sections.
18222 There are three possible settings:
18224 @table @gcctabopt
18225 @item -mcode-readable=yes
18226 Instructions may freely access executable sections.  This is the
18227 default setting.
18229 @item -mcode-readable=pcrel
18230 MIPS16 PC-relative load instructions can access executable sections,
18231 but other instructions must not do so.  This option is useful on 4KSc
18232 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
18233 It is also useful on processors that can be configured to have a dual
18234 instruction/data SRAM interface and that, like the M4K, automatically
18235 redirect PC-relative loads to the instruction RAM.
18237 @item -mcode-readable=no
18238 Instructions must not access executable sections.  This option can be
18239 useful on targets that are configured to have a dual instruction/data
18240 SRAM interface but that (unlike the M4K) do not automatically redirect
18241 PC-relative loads to the instruction RAM.
18242 @end table
18244 @item -msplit-addresses
18245 @itemx -mno-split-addresses
18246 @opindex msplit-addresses
18247 @opindex mno-split-addresses
18248 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18249 relocation operators.  This option has been superseded by
18250 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18252 @item -mexplicit-relocs
18253 @itemx -mno-explicit-relocs
18254 @opindex mexplicit-relocs
18255 @opindex mno-explicit-relocs
18256 Use (do not use) assembler relocation operators when dealing with symbolic
18257 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18258 is to use assembler macros instead.
18260 @option{-mexplicit-relocs} is the default if GCC was configured
18261 to use an assembler that supports relocation operators.
18263 @item -mcheck-zero-division
18264 @itemx -mno-check-zero-division
18265 @opindex mcheck-zero-division
18266 @opindex mno-check-zero-division
18267 Trap (do not trap) on integer division by zero.
18269 The default is @option{-mcheck-zero-division}.
18271 @item -mdivide-traps
18272 @itemx -mdivide-breaks
18273 @opindex mdivide-traps
18274 @opindex mdivide-breaks
18275 MIPS systems check for division by zero by generating either a
18276 conditional trap or a break instruction.  Using traps results in
18277 smaller code, but is only supported on MIPS II and later.  Also, some
18278 versions of the Linux kernel have a bug that prevents trap from
18279 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18280 allow conditional traps on architectures that support them and
18281 @option{-mdivide-breaks} to force the use of breaks.
18283 The default is usually @option{-mdivide-traps}, but this can be
18284 overridden at configure time using @option{--with-divide=breaks}.
18285 Divide-by-zero checks can be completely disabled using
18286 @option{-mno-check-zero-division}.
18288 @item -mmemcpy
18289 @itemx -mno-memcpy
18290 @opindex mmemcpy
18291 @opindex mno-memcpy
18292 Force (do not force) the use of @code{memcpy()} for non-trivial block
18293 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18294 most constant-sized copies.
18296 @item -mlong-calls
18297 @itemx -mno-long-calls
18298 @opindex mlong-calls
18299 @opindex mno-long-calls
18300 Disable (do not disable) use of the @code{jal} instruction.  Calling
18301 functions using @code{jal} is more efficient but requires the caller
18302 and callee to be in the same 256 megabyte segment.
18304 This option has no effect on abicalls code.  The default is
18305 @option{-mno-long-calls}.
18307 @item -mmad
18308 @itemx -mno-mad
18309 @opindex mmad
18310 @opindex mno-mad
18311 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18312 instructions, as provided by the R4650 ISA@.
18314 @item -mimadd
18315 @itemx -mno-imadd
18316 @opindex mimadd
18317 @opindex mno-imadd
18318 Enable (disable) use of the @code{madd} and @code{msub} integer
18319 instructions.  The default is @option{-mimadd} on architectures
18320 that support @code{madd} and @code{msub} except for the 74k 
18321 architecture where it was found to generate slower code.
18323 @item -mfused-madd
18324 @itemx -mno-fused-madd
18325 @opindex mfused-madd
18326 @opindex mno-fused-madd
18327 Enable (disable) use of the floating-point multiply-accumulate
18328 instructions, when they are available.  The default is
18329 @option{-mfused-madd}.
18331 On the R8000 CPU when multiply-accumulate instructions are used,
18332 the intermediate product is calculated to infinite precision
18333 and is not subject to the FCSR Flush to Zero bit.  This may be
18334 undesirable in some circumstances.  On other processors the result
18335 is numerically identical to the equivalent computation using
18336 separate multiply, add, subtract and negate instructions.
18338 @item -nocpp
18339 @opindex nocpp
18340 Tell the MIPS assembler to not run its preprocessor over user
18341 assembler files (with a @samp{.s} suffix) when assembling them.
18343 @item -mfix-24k
18344 @item -mno-fix-24k
18345 @opindex mfix-24k
18346 @opindex mno-fix-24k
18347 Work around the 24K E48 (lost data on stores during refill) errata.
18348 The workarounds are implemented by the assembler rather than by GCC@.
18350 @item -mfix-r4000
18351 @itemx -mno-fix-r4000
18352 @opindex mfix-r4000
18353 @opindex mno-fix-r4000
18354 Work around certain R4000 CPU errata:
18355 @itemize @minus
18356 @item
18357 A double-word or a variable shift may give an incorrect result if executed
18358 immediately after starting an integer division.
18359 @item
18360 A double-word or a variable shift may give an incorrect result if executed
18361 while an integer multiplication is in progress.
18362 @item
18363 An integer division may give an incorrect result if started in a delay slot
18364 of a taken branch or a jump.
18365 @end itemize
18367 @item -mfix-r4400
18368 @itemx -mno-fix-r4400
18369 @opindex mfix-r4400
18370 @opindex mno-fix-r4400
18371 Work around certain R4400 CPU errata:
18372 @itemize @minus
18373 @item
18374 A double-word or a variable shift may give an incorrect result if executed
18375 immediately after starting an integer division.
18376 @end itemize
18378 @item -mfix-r10000
18379 @itemx -mno-fix-r10000
18380 @opindex mfix-r10000
18381 @opindex mno-fix-r10000
18382 Work around certain R10000 errata:
18383 @itemize @minus
18384 @item
18385 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18386 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18387 @end itemize
18389 This option can only be used if the target architecture supports
18390 branch-likely instructions.  @option{-mfix-r10000} is the default when
18391 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18392 otherwise.
18394 @item -mfix-rm7000
18395 @itemx -mno-fix-rm7000
18396 @opindex mfix-rm7000
18397 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18398 workarounds are implemented by the assembler rather than by GCC@.
18400 @item -mfix-vr4120
18401 @itemx -mno-fix-vr4120
18402 @opindex mfix-vr4120
18403 Work around certain VR4120 errata:
18404 @itemize @minus
18405 @item
18406 @code{dmultu} does not always produce the correct result.
18407 @item
18408 @code{div} and @code{ddiv} do not always produce the correct result if one
18409 of the operands is negative.
18410 @end itemize
18411 The workarounds for the division errata rely on special functions in
18412 @file{libgcc.a}.  At present, these functions are only provided by
18413 the @code{mips64vr*-elf} configurations.
18415 Other VR4120 errata require a NOP to be inserted between certain pairs of
18416 instructions.  These errata are handled by the assembler, not by GCC itself.
18418 @item -mfix-vr4130
18419 @opindex mfix-vr4130
18420 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18421 workarounds are implemented by the assembler rather than by GCC,
18422 although GCC avoids using @code{mflo} and @code{mfhi} if the
18423 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18424 instructions are available instead.
18426 @item -mfix-sb1
18427 @itemx -mno-fix-sb1
18428 @opindex mfix-sb1
18429 Work around certain SB-1 CPU core errata.
18430 (This flag currently works around the SB-1 revision 2
18431 ``F1'' and ``F2'' floating-point errata.)
18433 @item -mr10k-cache-barrier=@var{setting}
18434 @opindex mr10k-cache-barrier
18435 Specify whether GCC should insert cache barriers to avoid the
18436 side-effects of speculation on R10K processors.
18438 In common with many processors, the R10K tries to predict the outcome
18439 of a conditional branch and speculatively executes instructions from
18440 the ``taken'' branch.  It later aborts these instructions if the
18441 predicted outcome is wrong.  However, on the R10K, even aborted
18442 instructions can have side effects.
18444 This problem only affects kernel stores and, depending on the system,
18445 kernel loads.  As an example, a speculatively-executed store may load
18446 the target memory into cache and mark the cache line as dirty, even if
18447 the store itself is later aborted.  If a DMA operation writes to the
18448 same area of memory before the ``dirty'' line is flushed, the cached
18449 data overwrites the DMA-ed data.  See the R10K processor manual
18450 for a full description, including other potential problems.
18452 One workaround is to insert cache barrier instructions before every memory
18453 access that might be speculatively executed and that might have side
18454 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18455 controls GCC's implementation of this workaround.  It assumes that
18456 aborted accesses to any byte in the following regions does not have
18457 side effects:
18459 @enumerate
18460 @item
18461 the memory occupied by the current function's stack frame;
18463 @item
18464 the memory occupied by an incoming stack argument;
18466 @item
18467 the memory occupied by an object with a link-time-constant address.
18468 @end enumerate
18470 It is the kernel's responsibility to ensure that speculative
18471 accesses to these regions are indeed safe.
18473 If the input program contains a function declaration such as:
18475 @smallexample
18476 void foo (void);
18477 @end smallexample
18479 then the implementation of @code{foo} must allow @code{j foo} and
18480 @code{jal foo} to be executed speculatively.  GCC honors this
18481 restriction for functions it compiles itself.  It expects non-GCC
18482 functions (such as hand-written assembly code) to do the same.
18484 The option has three forms:
18486 @table @gcctabopt
18487 @item -mr10k-cache-barrier=load-store
18488 Insert a cache barrier before a load or store that might be
18489 speculatively executed and that might have side effects even
18490 if aborted.
18492 @item -mr10k-cache-barrier=store
18493 Insert a cache barrier before a store that might be speculatively
18494 executed and that might have side effects even if aborted.
18496 @item -mr10k-cache-barrier=none
18497 Disable the insertion of cache barriers.  This is the default setting.
18498 @end table
18500 @item -mflush-func=@var{func}
18501 @itemx -mno-flush-func
18502 @opindex mflush-func
18503 Specifies the function to call to flush the I and D caches, or to not
18504 call any such function.  If called, the function must take the same
18505 arguments as the common @code{_flush_func()}, that is, the address of the
18506 memory range for which the cache is being flushed, the size of the
18507 memory range, and the number 3 (to flush both caches).  The default
18508 depends on the target GCC was configured for, but commonly is either
18509 @samp{_flush_func} or @samp{__cpu_flush}.
18511 @item mbranch-cost=@var{num}
18512 @opindex mbranch-cost
18513 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18514 This cost is only a heuristic and is not guaranteed to produce
18515 consistent results across releases.  A zero cost redundantly selects
18516 the default, which is based on the @option{-mtune} setting.
18518 @item -mbranch-likely
18519 @itemx -mno-branch-likely
18520 @opindex mbranch-likely
18521 @opindex mno-branch-likely
18522 Enable or disable use of Branch Likely instructions, regardless of the
18523 default for the selected architecture.  By default, Branch Likely
18524 instructions may be generated if they are supported by the selected
18525 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18526 and processors that implement those architectures; for those, Branch
18527 Likely instructions are not be generated by default because the MIPS32
18528 and MIPS64 architectures specifically deprecate their use.
18530 @item -mfp-exceptions
18531 @itemx -mno-fp-exceptions
18532 @opindex mfp-exceptions
18533 Specifies whether FP exceptions are enabled.  This affects how
18534 FP instructions are scheduled for some processors.
18535 The default is that FP exceptions are
18536 enabled.
18538 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18539 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18540 FP pipe.
18542 @item -mvr4130-align
18543 @itemx -mno-vr4130-align
18544 @opindex mvr4130-align
18545 The VR4130 pipeline is two-way superscalar, but can only issue two
18546 instructions together if the first one is 8-byte aligned.  When this
18547 option is enabled, GCC aligns pairs of instructions that it
18548 thinks should execute in parallel.
18550 This option only has an effect when optimizing for the VR4130.
18551 It normally makes code faster, but at the expense of making it bigger.
18552 It is enabled by default at optimization level @option{-O3}.
18554 @item -msynci
18555 @itemx -mno-synci
18556 @opindex msynci
18557 Enable (disable) generation of @code{synci} instructions on
18558 architectures that support it.  The @code{synci} instructions (if
18559 enabled) are generated when @code{__builtin___clear_cache()} is
18560 compiled.
18562 This option defaults to @code{-mno-synci}, but the default can be
18563 overridden by configuring with @code{--with-synci}.
18565 When compiling code for single processor systems, it is generally safe
18566 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18567 does not invalidate the instruction caches on all cores and may lead
18568 to undefined behavior.
18570 @item -mrelax-pic-calls
18571 @itemx -mno-relax-pic-calls
18572 @opindex mrelax-pic-calls
18573 Try to turn PIC calls that are normally dispatched via register
18574 @code{$25} into direct calls.  This is only possible if the linker can
18575 resolve the destination at link-time and if the destination is within
18576 range for a direct call.
18578 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18579 an assembler and a linker that support the @code{.reloc} assembly
18580 directive and @code{-mexplicit-relocs} is in effect.  With
18581 @code{-mno-explicit-relocs}, this optimization can be performed by the
18582 assembler and the linker alone without help from the compiler.
18584 @item -mmcount-ra-address
18585 @itemx -mno-mcount-ra-address
18586 @opindex mmcount-ra-address
18587 @opindex mno-mcount-ra-address
18588 Emit (do not emit) code that allows @code{_mcount} to modify the
18589 calling function's return address.  When enabled, this option extends
18590 the usual @code{_mcount} interface with a new @var{ra-address}
18591 parameter, which has type @code{intptr_t *} and is passed in register
18592 @code{$12}.  @code{_mcount} can then modify the return address by
18593 doing both of the following:
18594 @itemize
18595 @item
18596 Returning the new address in register @code{$31}.
18597 @item
18598 Storing the new address in @code{*@var{ra-address}},
18599 if @var{ra-address} is nonnull.
18600 @end itemize
18602 The default is @option{-mno-mcount-ra-address}.
18604 @end table
18606 @node MMIX Options
18607 @subsection MMIX Options
18608 @cindex MMIX Options
18610 These options are defined for the MMIX:
18612 @table @gcctabopt
18613 @item -mlibfuncs
18614 @itemx -mno-libfuncs
18615 @opindex mlibfuncs
18616 @opindex mno-libfuncs
18617 Specify that intrinsic library functions are being compiled, passing all
18618 values in registers, no matter the size.
18620 @item -mepsilon
18621 @itemx -mno-epsilon
18622 @opindex mepsilon
18623 @opindex mno-epsilon
18624 Generate floating-point comparison instructions that compare with respect
18625 to the @code{rE} epsilon register.
18627 @item -mabi=mmixware
18628 @itemx -mabi=gnu
18629 @opindex mabi=mmixware
18630 @opindex mabi=gnu
18631 Generate code that passes function parameters and return values that (in
18632 the called function) are seen as registers @code{$0} and up, as opposed to
18633 the GNU ABI which uses global registers @code{$231} and up.
18635 @item -mzero-extend
18636 @itemx -mno-zero-extend
18637 @opindex mzero-extend
18638 @opindex mno-zero-extend
18639 When reading data from memory in sizes shorter than 64 bits, use (do not
18640 use) zero-extending load instructions by default, rather than
18641 sign-extending ones.
18643 @item -mknuthdiv
18644 @itemx -mno-knuthdiv
18645 @opindex mknuthdiv
18646 @opindex mno-knuthdiv
18647 Make the result of a division yielding a remainder have the same sign as
18648 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18649 remainder follows the sign of the dividend.  Both methods are
18650 arithmetically valid, the latter being almost exclusively used.
18652 @item -mtoplevel-symbols
18653 @itemx -mno-toplevel-symbols
18654 @opindex mtoplevel-symbols
18655 @opindex mno-toplevel-symbols
18656 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18657 code can be used with the @code{PREFIX} assembly directive.
18659 @item -melf
18660 @opindex melf
18661 Generate an executable in the ELF format, rather than the default
18662 @samp{mmo} format used by the @command{mmix} simulator.
18664 @item -mbranch-predict
18665 @itemx -mno-branch-predict
18666 @opindex mbranch-predict
18667 @opindex mno-branch-predict
18668 Use (do not use) the probable-branch instructions, when static branch
18669 prediction indicates a probable branch.
18671 @item -mbase-addresses
18672 @itemx -mno-base-addresses
18673 @opindex mbase-addresses
18674 @opindex mno-base-addresses
18675 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18676 base address automatically generates a request (handled by the assembler
18677 and the linker) for a constant to be set up in a global register.  The
18678 register is used for one or more base address requests within the range 0
18679 to 255 from the value held in the register.  The generally leads to short
18680 and fast code, but the number of different data items that can be
18681 addressed is limited.  This means that a program that uses lots of static
18682 data may require @option{-mno-base-addresses}.
18684 @item -msingle-exit
18685 @itemx -mno-single-exit
18686 @opindex msingle-exit
18687 @opindex mno-single-exit
18688 Force (do not force) generated code to have a single exit point in each
18689 function.
18690 @end table
18692 @node MN10300 Options
18693 @subsection MN10300 Options
18694 @cindex MN10300 options
18696 These @option{-m} options are defined for Matsushita MN10300 architectures:
18698 @table @gcctabopt
18699 @item -mmult-bug
18700 @opindex mmult-bug
18701 Generate code to avoid bugs in the multiply instructions for the MN10300
18702 processors.  This is the default.
18704 @item -mno-mult-bug
18705 @opindex mno-mult-bug
18706 Do not generate code to avoid bugs in the multiply instructions for the
18707 MN10300 processors.
18709 @item -mam33
18710 @opindex mam33
18711 Generate code using features specific to the AM33 processor.
18713 @item -mno-am33
18714 @opindex mno-am33
18715 Do not generate code using features specific to the AM33 processor.  This
18716 is the default.
18718 @item -mam33-2
18719 @opindex mam33-2
18720 Generate code using features specific to the AM33/2.0 processor.
18722 @item -mam34
18723 @opindex mam34
18724 Generate code using features specific to the AM34 processor.
18726 @item -mtune=@var{cpu-type}
18727 @opindex mtune
18728 Use the timing characteristics of the indicated CPU type when
18729 scheduling instructions.  This does not change the targeted processor
18730 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18731 @samp{am33-2} or @samp{am34}.
18733 @item -mreturn-pointer-on-d0
18734 @opindex mreturn-pointer-on-d0
18735 When generating a function that returns a pointer, return the pointer
18736 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18737 only in @code{a0}, and attempts to call such functions without a prototype
18738 result in errors.  Note that this option is on by default; use
18739 @option{-mno-return-pointer-on-d0} to disable it.
18741 @item -mno-crt0
18742 @opindex mno-crt0
18743 Do not link in the C run-time initialization object file.
18745 @item -mrelax
18746 @opindex mrelax
18747 Indicate to the linker that it should perform a relaxation optimization pass
18748 to shorten branches, calls and absolute memory addresses.  This option only
18749 has an effect when used on the command line for the final link step.
18751 This option makes symbolic debugging impossible.
18753 @item -mliw
18754 @opindex mliw
18755 Allow the compiler to generate @emph{Long Instruction Word}
18756 instructions if the target is the @samp{AM33} or later.  This is the
18757 default.  This option defines the preprocessor macro @samp{__LIW__}.
18759 @item -mnoliw
18760 @opindex mnoliw
18761 Do not allow the compiler to generate @emph{Long Instruction Word}
18762 instructions.  This option defines the preprocessor macro
18763 @samp{__NO_LIW__}.
18765 @item -msetlb
18766 @opindex msetlb
18767 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18768 instructions if the target is the @samp{AM33} or later.  This is the
18769 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18771 @item -mnosetlb
18772 @opindex mnosetlb
18773 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18774 instructions.  This option defines the preprocessor macro
18775 @samp{__NO_SETLB__}.
18777 @end table
18779 @node Moxie Options
18780 @subsection Moxie Options
18781 @cindex Moxie Options
18783 @table @gcctabopt
18785 @item -meb
18786 @opindex meb
18787 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18788 configurations.
18790 @item -mel
18791 @opindex mel
18792 Generate little-endian code.
18794 @item -mno-crt0
18795 @opindex mno-crt0
18796 Do not link in the C run-time initialization object file.
18798 @end table
18800 @node MSP430 Options
18801 @subsection MSP430 Options
18802 @cindex MSP430 Options
18804 These options are defined for the MSP430:
18806 @table @gcctabopt
18808 @item -masm-hex
18809 @opindex masm-hex
18810 Force assembly output to always use hex constants.  Normally such
18811 constants are signed decimals, but this option is available for
18812 testsuite and/or aesthetic purposes.
18814 @item -mmcu=
18815 @opindex mmcu=
18816 Select the MCU to target.  This is used to create a C preprocessor
18817 symbol based upon the MCU name, converted to upper case and pre- and
18818 post- fixed with @code{__}.  This in turn will be used by the
18819 @code{msp430.h} header file to select an MCU specific supplimentary
18820 header file.
18822 The option also sets the ISA to use.  If the MCU name is one that is
18823 known to only support the 430 ISA then that is selected, otherwise the
18824 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18825 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18826 name will select the 430X ISA.
18828 In addition an MCU specific linker script will be added to the linker
18829 command line.  The script's name is the name of the MCU with
18830 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18831 command line will define the C preprocessor symbol @code{__XXX__} and
18832 cause the linker to search for a script called @file{xxx.ld}.
18834 This option is also passed on to the assembler.
18836 @item -mcpu=
18837 @opindex -mcpu=
18838 Specifies the ISA to use.  Accepted values are @code{msp430},
18839 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18840 @option{-mmcu=} option should be used to select the ISA.
18842 @item -msim
18843 @opindex msim
18844 Link to the simulator runtime libraries and linker script.  Overrides
18845 any scripts that would be selected by the @option{-mmcu=} option.
18847 @item -mlarge
18848 @opindex mlarge
18849 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18851 @item -msmall
18852 @opindex msmall
18853 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18855 @item -mrelax
18856 @opindex mrelax
18857 This option is passed to the assembler and linker, and allows the
18858 linker to perform certain optimizations that cannot be done until
18859 the final link.
18861 @item mhwmult=
18862 @opindex mhwmult=
18863 Describes the type of hardware multiply supported by the target.
18864 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18865 for the original 16-bit-only multiply supported by early MCUs.
18866 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18867 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18868 A value of @code{auto} can also be given.  This tells GCC to deduce
18869 the hardware multiply support based upon the MCU name provided by the
18870 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18871 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18872 default setting.
18874 Hardware multiplies are normally performed by calling a library
18875 routine.  This saves space in the generated code.  When compiling at
18876 @code{-O3} or higher however the hardware multiplier is invoked
18877 inline.  This makes for bigger, but faster code.
18879 The hardware multiply routines disable interrupts whilst running and
18880 restore the previous interrupt state when they finish.  This makes
18881 them safe to use inside interrupt handlers as well as in normal code.
18883 @item -minrt
18884 @opindex minrt
18885 Enable the use of a minimum runtime environment - no static
18886 initializers or constructors.  This is intended for memory-constrained
18887 devices.  The compiler will include special symbols in some objects
18888 that tell the linker and runtime which code fragments are required.
18890 @end table
18892 @node NDS32 Options
18893 @subsection NDS32 Options
18894 @cindex NDS32 Options
18896 These options are defined for NDS32 implementations:
18898 @table @gcctabopt
18900 @item -mbig-endian
18901 @opindex mbig-endian
18902 Generate code in big-endian mode.
18904 @item -mlittle-endian
18905 @opindex mlittle-endian
18906 Generate code in little-endian mode.
18908 @item -mreduced-regs
18909 @opindex mreduced-regs
18910 Use reduced-set registers for register allocation.
18912 @item -mfull-regs
18913 @opindex mfull-regs
18914 Use full-set registers for register allocation.
18916 @item -mcmov
18917 @opindex mcmov
18918 Generate conditional move instructions.
18920 @item -mno-cmov
18921 @opindex mno-cmov
18922 Do not generate conditional move instructions.
18924 @item -mperf-ext
18925 @opindex mperf-ext
18926 Generate performance extension instructions.
18928 @item -mno-perf-ext
18929 @opindex mno-perf-ext
18930 Do not generate performance extension instructions.
18932 @item -mv3push
18933 @opindex mv3push
18934 Generate v3 push25/pop25 instructions.
18936 @item -mno-v3push
18937 @opindex mno-v3push
18938 Do not generate v3 push25/pop25 instructions.
18940 @item -m16-bit
18941 @opindex m16-bit
18942 Generate 16-bit instructions.
18944 @item -mno-16-bit
18945 @opindex mno-16-bit
18946 Do not generate 16-bit instructions.
18948 @item -mgp-direct
18949 @opindex mgp-direct
18950 Generate GP base instructions directly.
18952 @item -mno-gp-direct
18953 @opindex mno-gp-direct
18954 Do no generate GP base instructions directly.
18956 @item -misr-vector-size=@var{num}
18957 @opindex misr-vector-size
18958 Specify the size of each interrupt vector, which must be 4 or 16.
18960 @item -mcache-block-size=@var{num}
18961 @opindex mcache-block-size
18962 Specify the size of each cache block,
18963 which must be a power of 2 between 4 and 512.
18965 @item -march=@var{arch}
18966 @opindex march
18967 Specify the name of the target architecture.
18969 @item -mforce-fp-as-gp
18970 @opindex mforce-fp-as-gp
18971 Prevent $fp being allocated during register allocation so that compiler
18972 is able to force performing fp-as-gp optimization.
18974 @item -mforbid-fp-as-gp
18975 @opindex mforbid-fp-as-gp
18976 Forbid using $fp to access static and global variables.
18977 This option strictly forbids fp-as-gp optimization
18978 regardless of @option{-mforce-fp-as-gp}.
18980 @item -mex9
18981 @opindex mex9
18982 Use special directives to guide linker doing ex9 optimization.
18984 @item -mctor-dtor
18985 @opindex mctor-dtor
18986 Enable constructor/destructor feature.
18988 @item -mrelax
18989 @opindex mrelax
18990 Guide linker to relax instructions.
18992 @end table
18994 @node Nios II Options
18995 @subsection Nios II Options
18996 @cindex Nios II options
18997 @cindex Altera Nios II options
18999 These are the options defined for the Altera Nios II processor.
19001 @table @gcctabopt
19003 @item -G @var{num}
19004 @opindex G
19005 @cindex smaller data references
19006 Put global and static objects less than or equal to @var{num} bytes
19007 into the small data or BSS sections instead of the normal data or BSS
19008 sections.  The default value of @var{num} is 8.
19010 @item -mgpopt
19011 @itemx -mno-gpopt
19012 @opindex mgpopt
19013 @opindex mno-gpopt
19014 Generate (do not generate) GP-relative accesses for objects in the
19015 small data or BSS sections.  The default is @option{-mgpopt} except
19016 when @option{-fpic} or @option{-fPIC} is specified to generate
19017 position-independent code.  Note that the Nios II ABI does not permit
19018 GP-relative accesses from shared libraries.
19020 You may need to specify @option{-mno-gpopt} explicitly when building
19021 programs that include large amounts of small data, including large
19022 GOT data sections.  In this case, the 16-bit offset for GP-relative
19023 addressing may not be large enough to allow access to the entire 
19024 small data section.
19026 @item -mel
19027 @itemx -meb
19028 @opindex mel
19029 @opindex meb
19030 Generate little-endian (default) or big-endian (experimental) code,
19031 respectively.
19033 @item -mbypass-cache
19034 @itemx -mno-bypass-cache
19035 @opindex mno-bypass-cache
19036 @opindex mbypass-cache
19037 Force all load and store instructions to always bypass cache by 
19038 using I/O variants of the instructions. The default is not to
19039 bypass the cache.
19041 @item -mno-cache-volatile 
19042 @itemx -mcache-volatile       
19043 @opindex mcache-volatile 
19044 @opindex mno-cache-volatile
19045 Volatile memory access bypass the cache using the I/O variants of 
19046 the load and store instructions. The default is not to bypass the cache.
19048 @item -mno-fast-sw-div
19049 @itemx -mfast-sw-div
19050 @opindex mno-fast-sw-div
19051 @opindex mfast-sw-div
19052 Do not use table-based fast divide for small numbers. The default 
19053 is to use the fast divide at @option{-O3} and above.
19055 @item -mno-hw-mul
19056 @itemx -mhw-mul
19057 @itemx -mno-hw-mulx
19058 @itemx -mhw-mulx
19059 @itemx -mno-hw-div
19060 @itemx -mhw-div
19061 @opindex mno-hw-mul
19062 @opindex mhw-mul
19063 @opindex mno-hw-mulx
19064 @opindex mhw-mulx
19065 @opindex mno-hw-div
19066 @opindex mhw-div
19067 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
19068 instructions by the compiler. The default is to emit @code{mul}
19069 and not emit @code{div} and @code{mulx}.
19071 @item -mcustom-@var{insn}=@var{N}
19072 @itemx -mno-custom-@var{insn}
19073 @opindex mcustom-@var{insn}
19074 @opindex mno-custom-@var{insn}
19075 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
19076 custom instruction with encoding @var{N} when generating code that uses 
19077 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
19078 instruction 253 for single-precision floating-point add operations instead
19079 of the default behavior of using a library call.
19081 The following values of @var{insn} are supported.  Except as otherwise
19082 noted, floating-point operations are expected to be implemented with
19083 normal IEEE 754 semantics and correspond directly to the C operators or the
19084 equivalent GCC built-in functions (@pxref{Other Builtins}).
19086 Single-precision floating point:
19087 @table @asis
19089 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
19090 Binary arithmetic operations.
19092 @item @samp{fnegs}
19093 Unary negation.
19095 @item @samp{fabss}
19096 Unary absolute value.
19098 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
19099 Comparison operations.
19101 @item @samp{fmins}, @samp{fmaxs}
19102 Floating-point minimum and maximum.  These instructions are only
19103 generated if @option{-ffinite-math-only} is specified.
19105 @item @samp{fsqrts}
19106 Unary square root operation.
19108 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
19109 Floating-point trigonometric and exponential functions.  These instructions
19110 are only generated if @option{-funsafe-math-optimizations} is also specified.
19112 @end table
19114 Double-precision floating point:
19115 @table @asis
19117 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
19118 Binary arithmetic operations.
19120 @item @samp{fnegd}
19121 Unary negation.
19123 @item @samp{fabsd}
19124 Unary absolute value.
19126 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
19127 Comparison operations.
19129 @item @samp{fmind}, @samp{fmaxd}
19130 Double-precision minimum and maximum.  These instructions are only
19131 generated if @option{-ffinite-math-only} is specified.
19133 @item @samp{fsqrtd}
19134 Unary square root operation.
19136 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
19137 Double-precision trigonometric and exponential functions.  These instructions
19138 are only generated if @option{-funsafe-math-optimizations} is also specified.
19140 @end table
19142 Conversions:
19143 @table @asis
19144 @item @samp{fextsd}
19145 Conversion from single precision to double precision.
19147 @item @samp{ftruncds}
19148 Conversion from double precision to single precision.
19150 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
19151 Conversion from floating point to signed or unsigned integer types, with
19152 truncation towards zero.
19154 @item @samp{round}
19155 Conversion from single-precision floating point to signed integer,
19156 rounding to the nearest integer and ties away from zero.
19157 This corresponds to the @code{__builtin_lroundf} function when
19158 @option{-fno-math-errno} is used.
19160 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
19161 Conversion from signed or unsigned integer types to floating-point types.
19163 @end table
19165 In addition, all of the following transfer instructions for internal
19166 registers X and Y must be provided to use any of the double-precision
19167 floating-point instructions.  Custom instructions taking two
19168 double-precision source operands expect the first operand in the
19169 64-bit register X.  The other operand (or only operand of a unary
19170 operation) is given to the custom arithmetic instruction with the
19171 least significant half in source register @var{src1} and the most
19172 significant half in @var{src2}.  A custom instruction that returns a
19173 double-precision result returns the most significant 32 bits in the
19174 destination register and the other half in 32-bit register Y.  
19175 GCC automatically generates the necessary code sequences to write
19176 register X and/or read register Y when double-precision floating-point
19177 instructions are used.
19179 @table @asis
19181 @item @samp{fwrx}
19182 Write @var{src1} into the least significant half of X and @var{src2} into
19183 the most significant half of X.
19185 @item @samp{fwry}
19186 Write @var{src1} into Y.
19188 @item @samp{frdxhi}, @samp{frdxlo}
19189 Read the most or least (respectively) significant half of X and store it in
19190 @var{dest}.
19192 @item @samp{frdy}
19193 Read the value of Y and store it into @var{dest}.
19194 @end table
19196 Note that you can gain more local control over generation of Nios II custom
19197 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
19198 and @code{target("no-custom-@var{insn}")} function attributes
19199 (@pxref{Function Attributes})
19200 or pragmas (@pxref{Function Specific Option Pragmas}).
19202 @item -mcustom-fpu-cfg=@var{name}
19203 @opindex mcustom-fpu-cfg
19205 This option enables a predefined, named set of custom instruction encodings
19206 (see @option{-mcustom-@var{insn}} above).  
19207 Currently, the following sets are defined:
19209 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
19210 @gccoptlist{-mcustom-fmuls=252 @gol
19211 -mcustom-fadds=253 @gol
19212 -mcustom-fsubs=254 @gol
19213 -fsingle-precision-constant}
19215 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
19216 @gccoptlist{-mcustom-fmuls=252 @gol
19217 -mcustom-fadds=253 @gol
19218 -mcustom-fsubs=254 @gol
19219 -mcustom-fdivs=255 @gol
19220 -fsingle-precision-constant}
19222 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
19223 @gccoptlist{-mcustom-floatus=243 @gol
19224 -mcustom-fixsi=244 @gol
19225 -mcustom-floatis=245 @gol
19226 -mcustom-fcmpgts=246 @gol
19227 -mcustom-fcmples=249 @gol
19228 -mcustom-fcmpeqs=250 @gol
19229 -mcustom-fcmpnes=251 @gol
19230 -mcustom-fmuls=252 @gol
19231 -mcustom-fadds=253 @gol
19232 -mcustom-fsubs=254 @gol
19233 -mcustom-fdivs=255 @gol
19234 -fsingle-precision-constant}
19236 Custom instruction assignments given by individual
19237 @option{-mcustom-@var{insn}=} options override those given by
19238 @option{-mcustom-fpu-cfg=}, regardless of the
19239 order of the options on the command line.
19241 Note that you can gain more local control over selection of a FPU
19242 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19243 function attribute (@pxref{Function Attributes})
19244 or pragma (@pxref{Function Specific Option Pragmas}).
19246 @end table
19248 These additional @samp{-m} options are available for the Altera Nios II
19249 ELF (bare-metal) target:
19251 @table @gcctabopt
19253 @item -mhal
19254 @opindex mhal
19255 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19256 startup and termination code, and is typically used in conjunction with
19257 @option{-msys-crt0=} to specify the location of the alternate startup code
19258 provided by the HAL BSP.
19260 @item -msmallc
19261 @opindex msmallc
19262 Link with a limited version of the C library, @option{-lsmallc}, rather than
19263 Newlib.
19265 @item -msys-crt0=@var{startfile}
19266 @opindex msys-crt0
19267 @var{startfile} is the file name of the startfile (crt0) to use 
19268 when linking.  This option is only useful in conjunction with @option{-mhal}.
19270 @item -msys-lib=@var{systemlib}
19271 @opindex msys-lib
19272 @var{systemlib} is the library name of the library that provides
19273 low-level system calls required by the C library,
19274 e.g. @code{read} and @code{write}.
19275 This option is typically used to link with a library provided by a HAL BSP.
19277 @end table
19279 @node PDP-11 Options
19280 @subsection PDP-11 Options
19281 @cindex PDP-11 Options
19283 These options are defined for the PDP-11:
19285 @table @gcctabopt
19286 @item -mfpu
19287 @opindex mfpu
19288 Use hardware FPP floating point.  This is the default.  (FIS floating
19289 point on the PDP-11/40 is not supported.)
19291 @item -msoft-float
19292 @opindex msoft-float
19293 Do not use hardware floating point.
19295 @item -mac0
19296 @opindex mac0
19297 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19299 @item -mno-ac0
19300 @opindex mno-ac0
19301 Return floating-point results in memory.  This is the default.
19303 @item -m40
19304 @opindex m40
19305 Generate code for a PDP-11/40.
19307 @item -m45
19308 @opindex m45
19309 Generate code for a PDP-11/45.  This is the default.
19311 @item -m10
19312 @opindex m10
19313 Generate code for a PDP-11/10.
19315 @item -mbcopy-builtin
19316 @opindex mbcopy-builtin
19317 Use inline @code{movmemhi} patterns for copying memory.  This is the
19318 default.
19320 @item -mbcopy
19321 @opindex mbcopy
19322 Do not use inline @code{movmemhi} patterns for copying memory.
19324 @item -mint16
19325 @itemx -mno-int32
19326 @opindex mint16
19327 @opindex mno-int32
19328 Use 16-bit @code{int}.  This is the default.
19330 @item -mint32
19331 @itemx -mno-int16
19332 @opindex mint32
19333 @opindex mno-int16
19334 Use 32-bit @code{int}.
19336 @item -mfloat64
19337 @itemx -mno-float32
19338 @opindex mfloat64
19339 @opindex mno-float32
19340 Use 64-bit @code{float}.  This is the default.
19342 @item -mfloat32
19343 @itemx -mno-float64
19344 @opindex mfloat32
19345 @opindex mno-float64
19346 Use 32-bit @code{float}.
19348 @item -mabshi
19349 @opindex mabshi
19350 Use @code{abshi2} pattern.  This is the default.
19352 @item -mno-abshi
19353 @opindex mno-abshi
19354 Do not use @code{abshi2} pattern.
19356 @item -mbranch-expensive
19357 @opindex mbranch-expensive
19358 Pretend that branches are expensive.  This is for experimenting with
19359 code generation only.
19361 @item -mbranch-cheap
19362 @opindex mbranch-cheap
19363 Do not pretend that branches are expensive.  This is the default.
19365 @item -munix-asm
19366 @opindex munix-asm
19367 Use Unix assembler syntax.  This is the default when configured for
19368 @samp{pdp11-*-bsd}.
19370 @item -mdec-asm
19371 @opindex mdec-asm
19372 Use DEC assembler syntax.  This is the default when configured for any
19373 PDP-11 target other than @samp{pdp11-*-bsd}.
19374 @end table
19376 @node picoChip Options
19377 @subsection picoChip Options
19378 @cindex picoChip options
19380 These @samp{-m} options are defined for picoChip implementations:
19382 @table @gcctabopt
19384 @item -mae=@var{ae_type}
19385 @opindex mcpu
19386 Set the instruction set, register set, and instruction scheduling
19387 parameters for array element type @var{ae_type}.  Supported values
19388 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19390 @option{-mae=ANY} selects a completely generic AE type.  Code
19391 generated with this option runs on any of the other AE types.  The
19392 code is not as efficient as it would be if compiled for a specific
19393 AE type, and some types of operation (e.g., multiplication) do not
19394 work properly on all types of AE.
19396 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19397 for compiled code, and is the default.
19399 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19400 option may suffer from poor performance of byte (char) manipulation,
19401 since the DSP AE does not provide hardware support for byte load/stores.
19403 @item -msymbol-as-address
19404 Enable the compiler to directly use a symbol name as an address in a
19405 load/store instruction, without first loading it into a
19406 register.  Typically, the use of this option generates larger
19407 programs, which run faster than when the option isn't used.  However, the
19408 results vary from program to program, so it is left as a user option,
19409 rather than being permanently enabled.
19411 @item -mno-inefficient-warnings
19412 Disables warnings about the generation of inefficient code.  These
19413 warnings can be generated, for example, when compiling code that
19414 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19415 no hardware support for byte-level memory operations, so all byte
19416 load/stores must be synthesized from word load/store operations.  This is
19417 inefficient and a warning is generated to indicate
19418 that you should rewrite the code to avoid byte operations, or to target
19419 an AE type that has the necessary hardware support.  This option disables
19420 these warnings.
19422 @end table
19424 @node PowerPC Options
19425 @subsection PowerPC Options
19426 @cindex PowerPC options
19428 These are listed under @xref{RS/6000 and PowerPC Options}.
19430 @node RL78 Options
19431 @subsection RL78 Options
19432 @cindex RL78 Options
19434 @table @gcctabopt
19436 @item -msim
19437 @opindex msim
19438 Links in additional target libraries to support operation within a
19439 simulator.
19441 @item -mmul=none
19442 @itemx -mmul=g13
19443 @itemx -mmul=rl78
19444 @opindex mmul
19445 Specifies the type of hardware multiplication support to be used.  The
19446 default is @code{none}, which uses software multiplication functions.
19447 The @code{g13} option is for the hardware multiply/divide peripheral
19448 only on the RL78/G13 targets.  The @code{rl78} option is for the
19449 standard hardware multiplication defined in the RL78 software manual.
19451 @item -m64bit-doubles
19452 @itemx -m32bit-doubles
19453 @opindex m64bit-doubles
19454 @opindex m32bit-doubles
19455 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19456 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19457 @option{-m32bit-doubles}.
19459 @end table
19461 @node RS/6000 and PowerPC Options
19462 @subsection IBM RS/6000 and PowerPC Options
19463 @cindex RS/6000 and PowerPC Options
19464 @cindex IBM RS/6000 and PowerPC Options
19466 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19467 @table @gcctabopt
19468 @item -mpowerpc-gpopt
19469 @itemx -mno-powerpc-gpopt
19470 @itemx -mpowerpc-gfxopt
19471 @itemx -mno-powerpc-gfxopt
19472 @need 800
19473 @itemx -mpowerpc64
19474 @itemx -mno-powerpc64
19475 @itemx -mmfcrf
19476 @itemx -mno-mfcrf
19477 @itemx -mpopcntb
19478 @itemx -mno-popcntb
19479 @itemx -mpopcntd
19480 @itemx -mno-popcntd
19481 @itemx -mfprnd
19482 @itemx -mno-fprnd
19483 @need 800
19484 @itemx -mcmpb
19485 @itemx -mno-cmpb
19486 @itemx -mmfpgpr
19487 @itemx -mno-mfpgpr
19488 @itemx -mhard-dfp
19489 @itemx -mno-hard-dfp
19490 @opindex mpowerpc-gpopt
19491 @opindex mno-powerpc-gpopt
19492 @opindex mpowerpc-gfxopt
19493 @opindex mno-powerpc-gfxopt
19494 @opindex mpowerpc64
19495 @opindex mno-powerpc64
19496 @opindex mmfcrf
19497 @opindex mno-mfcrf
19498 @opindex mpopcntb
19499 @opindex mno-popcntb
19500 @opindex mpopcntd
19501 @opindex mno-popcntd
19502 @opindex mfprnd
19503 @opindex mno-fprnd
19504 @opindex mcmpb
19505 @opindex mno-cmpb
19506 @opindex mmfpgpr
19507 @opindex mno-mfpgpr
19508 @opindex mhard-dfp
19509 @opindex mno-hard-dfp
19510 You use these options to specify which instructions are available on the
19511 processor you are using.  The default value of these options is
19512 determined when configuring GCC@.  Specifying the
19513 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19514 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19515 rather than the options listed above.
19517 Specifying @option{-mpowerpc-gpopt} allows
19518 GCC to use the optional PowerPC architecture instructions in the
19519 General Purpose group, including floating-point square root.  Specifying
19520 @option{-mpowerpc-gfxopt} allows GCC to
19521 use the optional PowerPC architecture instructions in the Graphics
19522 group, including floating-point select.
19524 The @option{-mmfcrf} option allows GCC to generate the move from
19525 condition register field instruction implemented on the POWER4
19526 processor and other processors that support the PowerPC V2.01
19527 architecture.
19528 The @option{-mpopcntb} option allows GCC to generate the popcount and
19529 double-precision FP reciprocal estimate instruction implemented on the
19530 POWER5 processor and other processors that support the PowerPC V2.02
19531 architecture.
19532 The @option{-mpopcntd} option allows GCC to generate the popcount
19533 instruction implemented on the POWER7 processor and other processors
19534 that support the PowerPC V2.06 architecture.
19535 The @option{-mfprnd} option allows GCC to generate the FP round to
19536 integer instructions implemented on the POWER5+ processor and other
19537 processors that support the PowerPC V2.03 architecture.
19538 The @option{-mcmpb} option allows GCC to generate the compare bytes
19539 instruction implemented on the POWER6 processor and other processors
19540 that support the PowerPC V2.05 architecture.
19541 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19542 general-purpose register instructions implemented on the POWER6X
19543 processor and other processors that support the extended PowerPC V2.05
19544 architecture.
19545 The @option{-mhard-dfp} option allows GCC to generate the decimal
19546 floating-point instructions implemented on some POWER processors.
19548 The @option{-mpowerpc64} option allows GCC to generate the additional
19549 64-bit instructions that are found in the full PowerPC64 architecture
19550 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19551 @option{-mno-powerpc64}.
19553 @item -mcpu=@var{cpu_type}
19554 @opindex mcpu
19555 Set architecture type, register usage, and
19556 instruction scheduling parameters for machine type @var{cpu_type}.
19557 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19558 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19559 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19560 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19561 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19562 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19563 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19564 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19565 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19566 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19567 @samp{powerpc64}, and @samp{rs64}.
19569 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19570 PowerPC and 64-bit PowerPC architecture machine
19571 types, with an appropriate, generic processor model assumed for
19572 scheduling purposes.
19574 The other options specify a specific processor.  Code generated under
19575 those options runs best on that processor, and may not run at all on
19576 others.
19578 The @option{-mcpu} options automatically enable or disable the
19579 following options:
19581 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19582 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19583 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19584 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19585 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19586 -mquad-memory -mquad-memory-atomic}
19588 The particular options set for any particular CPU varies between
19589 compiler versions, depending on what setting seems to produce optimal
19590 code for that CPU; it doesn't necessarily reflect the actual hardware's
19591 capabilities.  If you wish to set an individual option to a particular
19592 value, you may specify it after the @option{-mcpu} option, like
19593 @option{-mcpu=970 -mno-altivec}.
19595 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19596 not enabled or disabled by the @option{-mcpu} option at present because
19597 AIX does not have full support for these options.  You may still
19598 enable or disable them individually if you're sure it'll work in your
19599 environment.
19601 @item -mtune=@var{cpu_type}
19602 @opindex mtune
19603 Set the instruction scheduling parameters for machine type
19604 @var{cpu_type}, but do not set the architecture type or register usage,
19605 as @option{-mcpu=@var{cpu_type}} does.  The same
19606 values for @var{cpu_type} are used for @option{-mtune} as for
19607 @option{-mcpu}.  If both are specified, the code generated uses the
19608 architecture and registers set by @option{-mcpu}, but the
19609 scheduling parameters set by @option{-mtune}.
19611 @item -mcmodel=small
19612 @opindex mcmodel=small
19613 Generate PowerPC64 code for the small model: The TOC is limited to
19614 64k.
19616 @item -mcmodel=medium
19617 @opindex mcmodel=medium
19618 Generate PowerPC64 code for the medium model: The TOC and other static
19619 data may be up to a total of 4G in size.
19621 @item -mcmodel=large
19622 @opindex mcmodel=large
19623 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19624 in size.  Other data and code is only limited by the 64-bit address
19625 space.
19627 @item -maltivec
19628 @itemx -mno-altivec
19629 @opindex maltivec
19630 @opindex mno-altivec
19631 Generate code that uses (does not use) AltiVec instructions, and also
19632 enable the use of built-in functions that allow more direct access to
19633 the AltiVec instruction set.  You may also need to set
19634 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19635 enhancements.
19637 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19638 @option{-maltivec=be}, the element order for Altivec intrinsics such
19639 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19640 match array element order corresponding to the endianness of the
19641 target.  That is, element zero identifies the leftmost element in a
19642 vector register when targeting a big-endian platform, and identifies
19643 the rightmost element in a vector register when targeting a
19644 little-endian platform.
19646 @item -maltivec=be
19647 @opindex maltivec=be
19648 Generate Altivec instructions using big-endian element order,
19649 regardless of whether the target is big- or little-endian.  This is
19650 the default when targeting a big-endian platform.
19652 The element order is used to interpret element numbers in Altivec
19653 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19654 @code{vec_insert}.  By default, these will match array element order
19655 corresponding to the endianness for the target.
19657 @item -maltivec=le
19658 @opindex maltivec=le
19659 Generate Altivec instructions using little-endian element order,
19660 regardless of whether the target is big- or little-endian.  This is
19661 the default when targeting a little-endian platform.  This option is
19662 currently ignored when targeting a big-endian platform.
19664 The element order is used to interpret element numbers in Altivec
19665 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19666 @code{vec_insert}.  By default, these will match array element order
19667 corresponding to the endianness for the target.
19669 @item -mvrsave
19670 @itemx -mno-vrsave
19671 @opindex mvrsave
19672 @opindex mno-vrsave
19673 Generate VRSAVE instructions when generating AltiVec code.
19675 @item -mgen-cell-microcode
19676 @opindex mgen-cell-microcode
19677 Generate Cell microcode instructions.
19679 @item -mwarn-cell-microcode
19680 @opindex mwarn-cell-microcode
19681 Warn when a Cell microcode instruction is emitted.  An example
19682 of a Cell microcode instruction is a variable shift.
19684 @item -msecure-plt
19685 @opindex msecure-plt
19686 Generate code that allows @command{ld} and @command{ld.so}
19687 to build executables and shared
19688 libraries with non-executable @code{.plt} and @code{.got} sections.
19689 This is a PowerPC
19690 32-bit SYSV ABI option.
19692 @item -mbss-plt
19693 @opindex mbss-plt
19694 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19695 fills in, and
19696 requires @code{.plt} and @code{.got}
19697 sections that are both writable and executable.
19698 This is a PowerPC 32-bit SYSV ABI option.
19700 @item -misel
19701 @itemx -mno-isel
19702 @opindex misel
19703 @opindex mno-isel
19704 This switch enables or disables the generation of ISEL instructions.
19706 @item -misel=@var{yes/no}
19707 This switch has been deprecated.  Use @option{-misel} and
19708 @option{-mno-isel} instead.
19710 @item -mspe
19711 @itemx -mno-spe
19712 @opindex mspe
19713 @opindex mno-spe
19714 This switch enables or disables the generation of SPE simd
19715 instructions.
19717 @item -mpaired
19718 @itemx -mno-paired
19719 @opindex mpaired
19720 @opindex mno-paired
19721 This switch enables or disables the generation of PAIRED simd
19722 instructions.
19724 @item -mspe=@var{yes/no}
19725 This option has been deprecated.  Use @option{-mspe} and
19726 @option{-mno-spe} instead.
19728 @item -mvsx
19729 @itemx -mno-vsx
19730 @opindex mvsx
19731 @opindex mno-vsx
19732 Generate code that uses (does not use) vector/scalar (VSX)
19733 instructions, and also enable the use of built-in functions that allow
19734 more direct access to the VSX instruction set.
19736 @item -mcrypto
19737 @itemx -mno-crypto
19738 @opindex mcrypto
19739 @opindex mno-crypto
19740 Enable the use (disable) of the built-in functions that allow direct
19741 access to the cryptographic instructions that were added in version
19742 2.07 of the PowerPC ISA.
19744 @item -mdirect-move
19745 @itemx -mno-direct-move
19746 @opindex mdirect-move
19747 @opindex mno-direct-move
19748 Generate code that uses (does not use) the instructions to move data
19749 between the general purpose registers and the vector/scalar (VSX)
19750 registers that were added in version 2.07 of the PowerPC ISA.
19752 @item -mpower8-fusion
19753 @itemx -mno-power8-fusion
19754 @opindex mpower8-fusion
19755 @opindex mno-power8-fusion
19756 Generate code that keeps (does not keeps) some integer operations
19757 adjacent so that the instructions can be fused together on power8 and
19758 later processors.
19760 @item -mpower8-vector
19761 @itemx -mno-power8-vector
19762 @opindex mpower8-vector
19763 @opindex mno-power8-vector
19764 Generate code that uses (does not use) the vector and scalar
19765 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19766 enable the use of built-in functions that allow more direct access to
19767 the vector instructions.
19769 @item -mquad-memory
19770 @itemx -mno-quad-memory
19771 @opindex mquad-memory
19772 @opindex mno-quad-memory
19773 Generate code that uses (does not use) the non-atomic quad word memory
19774 instructions.  The @option{-mquad-memory} option requires use of
19775 64-bit mode.
19777 @item -mquad-memory-atomic
19778 @itemx -mno-quad-memory-atomic
19779 @opindex mquad-memory-atomic
19780 @opindex mno-quad-memory-atomic
19781 Generate code that uses (does not use) the atomic quad word memory
19782 instructions.  The @option{-mquad-memory-atomic} option requires use of
19783 64-bit mode.
19785 @item -mupper-regs-df
19786 @itemx -mno-upper-regs-df
19787 @opindex mupper-regs-df
19788 @opindex mno-upper-regs-df
19789 Generate code that uses (does not use) the scalar double precision
19790 instructions that target all 64 registers in the vector/scalar
19791 floating point register set that were added in version 2.06 of the
19792 PowerPC ISA.  The @option{-mupper-regs-df} turned on by default if you
19793 use either of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19794 @option{-mvsx} options.
19796 @item -mupper-regs-sf
19797 @itemx -mno-upper-regs-sf
19798 @opindex mupper-regs-sf
19799 @opindex mno-upper-regs-sf
19800 Generate code that uses (does not use) the scalar single precision
19801 instructions that target all 64 registers in the vector/scalar
19802 floating point register set that were added in version 2.07 of the
19803 PowerPC ISA.  The @option{-mupper-regs-sf} turned on by default if you
19804 use either of the @option{-mcpu=power8}, or @option{-mpower8-vector}
19805 options.
19807 @item -mupper-regs
19808 @itemx -mno-upper-regs
19809 @opindex mupper-regs
19810 @opindex mno-upper-regs
19811 Generate code that uses (does not use) the scalar
19812 instructions that target all 64 registers in the vector/scalar
19813 floating point register set, depending on the model of the machine.
19815 If the @option{-mno-upper-regs} option was used, it will turn off both
19816 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19818 @item -mfloat-gprs=@var{yes/single/double/no}
19819 @itemx -mfloat-gprs
19820 @opindex mfloat-gprs
19821 This switch enables or disables the generation of floating-point
19822 operations on the general-purpose registers for architectures that
19823 support it.
19825 The argument @var{yes} or @var{single} enables the use of
19826 single-precision floating-point operations.
19828 The argument @var{double} enables the use of single and
19829 double-precision floating-point operations.
19831 The argument @var{no} disables floating-point operations on the
19832 general-purpose registers.
19834 This option is currently only available on the MPC854x.
19836 @item -m32
19837 @itemx -m64
19838 @opindex m32
19839 @opindex m64
19840 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19841 targets (including GNU/Linux).  The 32-bit environment sets int, long
19842 and pointer to 32 bits and generates code that runs on any PowerPC
19843 variant.  The 64-bit environment sets int to 32 bits and long and
19844 pointer to 64 bits, and generates code for PowerPC64, as for
19845 @option{-mpowerpc64}.
19847 @item -mfull-toc
19848 @itemx -mno-fp-in-toc
19849 @itemx -mno-sum-in-toc
19850 @itemx -mminimal-toc
19851 @opindex mfull-toc
19852 @opindex mno-fp-in-toc
19853 @opindex mno-sum-in-toc
19854 @opindex mminimal-toc
19855 Modify generation of the TOC (Table Of Contents), which is created for
19856 every executable file.  The @option{-mfull-toc} option is selected by
19857 default.  In that case, GCC allocates at least one TOC entry for
19858 each unique non-automatic variable reference in your program.  GCC
19859 also places floating-point constants in the TOC@.  However, only
19860 16,384 entries are available in the TOC@.
19862 If you receive a linker error message that saying you have overflowed
19863 the available TOC space, you can reduce the amount of TOC space used
19864 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19865 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19866 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19867 generate code to calculate the sum of an address and a constant at
19868 run time instead of putting that sum into the TOC@.  You may specify one
19869 or both of these options.  Each causes GCC to produce very slightly
19870 slower and larger code at the expense of conserving TOC space.
19872 If you still run out of space in the TOC even when you specify both of
19873 these options, specify @option{-mminimal-toc} instead.  This option causes
19874 GCC to make only one TOC entry for every file.  When you specify this
19875 option, GCC produces code that is slower and larger but which
19876 uses extremely little TOC space.  You may wish to use this option
19877 only on files that contain less frequently-executed code.
19879 @item -maix64
19880 @itemx -maix32
19881 @opindex maix64
19882 @opindex maix32
19883 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19884 @code{long} type, and the infrastructure needed to support them.
19885 Specifying @option{-maix64} implies @option{-mpowerpc64},
19886 while @option{-maix32} disables the 64-bit ABI and
19887 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19889 @item -mxl-compat
19890 @itemx -mno-xl-compat
19891 @opindex mxl-compat
19892 @opindex mno-xl-compat
19893 Produce code that conforms more closely to IBM XL compiler semantics
19894 when using AIX-compatible ABI@.  Pass floating-point arguments to
19895 prototyped functions beyond the register save area (RSA) on the stack
19896 in addition to argument FPRs.  Do not assume that most significant
19897 double in 128-bit long double value is properly rounded when comparing
19898 values and converting to double.  Use XL symbol names for long double
19899 support routines.
19901 The AIX calling convention was extended but not initially documented to
19902 handle an obscure K&R C case of calling a function that takes the
19903 address of its arguments with fewer arguments than declared.  IBM XL
19904 compilers access floating-point arguments that do not fit in the
19905 RSA from the stack when a subroutine is compiled without
19906 optimization.  Because always storing floating-point arguments on the
19907 stack is inefficient and rarely needed, this option is not enabled by
19908 default and only is necessary when calling subroutines compiled by IBM
19909 XL compilers without optimization.
19911 @item -mpe
19912 @opindex mpe
19913 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19914 application written to use message passing with special startup code to
19915 enable the application to run.  The system must have PE installed in the
19916 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19917 must be overridden with the @option{-specs=} option to specify the
19918 appropriate directory location.  The Parallel Environment does not
19919 support threads, so the @option{-mpe} option and the @option{-pthread}
19920 option are incompatible.
19922 @item -malign-natural
19923 @itemx -malign-power
19924 @opindex malign-natural
19925 @opindex malign-power
19926 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19927 @option{-malign-natural} overrides the ABI-defined alignment of larger
19928 types, such as floating-point doubles, on their natural size-based boundary.
19929 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19930 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19932 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19933 is not supported.
19935 @item -msoft-float
19936 @itemx -mhard-float
19937 @opindex msoft-float
19938 @opindex mhard-float
19939 Generate code that does not use (uses) the floating-point register set.
19940 Software floating-point emulation is provided if you use the
19941 @option{-msoft-float} option, and pass the option to GCC when linking.
19943 @item -msingle-float
19944 @itemx -mdouble-float
19945 @opindex msingle-float
19946 @opindex mdouble-float
19947 Generate code for single- or double-precision floating-point operations.
19948 @option{-mdouble-float} implies @option{-msingle-float}.
19950 @item -msimple-fpu
19951 @opindex msimple-fpu
19952 Do not generate @code{sqrt} and @code{div} instructions for hardware
19953 floating-point unit.
19955 @item -mfpu=@var{name}
19956 @opindex mfpu
19957 Specify type of floating-point unit.  Valid values for @var{name} are
19958 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19959 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19960 @samp{sp_full} (equivalent to @option{-msingle-float}),
19961 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19963 @item -mxilinx-fpu
19964 @opindex mxilinx-fpu
19965 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19967 @item -mmultiple
19968 @itemx -mno-multiple
19969 @opindex mmultiple
19970 @opindex mno-multiple
19971 Generate code that uses (does not use) the load multiple word
19972 instructions and the store multiple word instructions.  These
19973 instructions are generated by default on POWER systems, and not
19974 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19975 PowerPC systems, since those instructions do not work when the
19976 processor is in little-endian mode.  The exceptions are PPC740 and
19977 PPC750 which permit these instructions in little-endian mode.
19979 @item -mstring
19980 @itemx -mno-string
19981 @opindex mstring
19982 @opindex mno-string
19983 Generate code that uses (does not use) the load string instructions
19984 and the store string word instructions to save multiple registers and
19985 do small block moves.  These instructions are generated by default on
19986 POWER systems, and not generated on PowerPC systems.  Do not use
19987 @option{-mstring} on little-endian PowerPC systems, since those
19988 instructions do not work when the processor is in little-endian mode.
19989 The exceptions are PPC740 and PPC750 which permit these instructions
19990 in little-endian mode.
19992 @item -mupdate
19993 @itemx -mno-update
19994 @opindex mupdate
19995 @opindex mno-update
19996 Generate code that uses (does not use) the load or store instructions
19997 that update the base register to the address of the calculated memory
19998 location.  These instructions are generated by default.  If you use
19999 @option{-mno-update}, there is a small window between the time that the
20000 stack pointer is updated and the address of the previous frame is
20001 stored, which means code that walks the stack frame across interrupts or
20002 signals may get corrupted data.
20004 @item -mavoid-indexed-addresses
20005 @itemx -mno-avoid-indexed-addresses
20006 @opindex mavoid-indexed-addresses
20007 @opindex mno-avoid-indexed-addresses
20008 Generate code that tries to avoid (not avoid) the use of indexed load
20009 or store instructions. These instructions can incur a performance
20010 penalty on Power6 processors in certain situations, such as when
20011 stepping through large arrays that cross a 16M boundary.  This option
20012 is enabled by default when targeting Power6 and disabled otherwise.
20014 @item -mfused-madd
20015 @itemx -mno-fused-madd
20016 @opindex mfused-madd
20017 @opindex mno-fused-madd
20018 Generate code that uses (does not use) the floating-point multiply and
20019 accumulate instructions.  These instructions are generated by default
20020 if hardware floating point is used.  The machine-dependent
20021 @option{-mfused-madd} option is now mapped to the machine-independent
20022 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20023 mapped to @option{-ffp-contract=off}.
20025 @item -mmulhw
20026 @itemx -mno-mulhw
20027 @opindex mmulhw
20028 @opindex mno-mulhw
20029 Generate code that uses (does not use) the half-word multiply and
20030 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
20031 These instructions are generated by default when targeting those
20032 processors.
20034 @item -mdlmzb
20035 @itemx -mno-dlmzb
20036 @opindex mdlmzb
20037 @opindex mno-dlmzb
20038 Generate code that uses (does not use) the string-search @samp{dlmzb}
20039 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
20040 generated by default when targeting those processors.
20042 @item -mno-bit-align
20043 @itemx -mbit-align
20044 @opindex mno-bit-align
20045 @opindex mbit-align
20046 On System V.4 and embedded PowerPC systems do not (do) force structures
20047 and unions that contain bit-fields to be aligned to the base type of the
20048 bit-field.
20050 For example, by default a structure containing nothing but 8
20051 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
20052 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
20053 the structure is aligned to a 1-byte boundary and is 1 byte in
20054 size.
20056 @item -mno-strict-align
20057 @itemx -mstrict-align
20058 @opindex mno-strict-align
20059 @opindex mstrict-align
20060 On System V.4 and embedded PowerPC systems do not (do) assume that
20061 unaligned memory references are handled by the system.
20063 @item -mrelocatable
20064 @itemx -mno-relocatable
20065 @opindex mrelocatable
20066 @opindex mno-relocatable
20067 Generate code that allows (does not allow) a static executable to be
20068 relocated to a different address at run time.  A simple embedded
20069 PowerPC system loader should relocate the entire contents of
20070 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
20071 a table of 32-bit addresses generated by this option.  For this to
20072 work, all objects linked together must be compiled with
20073 @option{-mrelocatable} or @option{-mrelocatable-lib}.
20074 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
20076 @item -mrelocatable-lib
20077 @itemx -mno-relocatable-lib
20078 @opindex mrelocatable-lib
20079 @opindex mno-relocatable-lib
20080 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
20081 @code{.fixup} section to allow static executables to be relocated at
20082 run time, but @option{-mrelocatable-lib} does not use the smaller stack
20083 alignment of @option{-mrelocatable}.  Objects compiled with
20084 @option{-mrelocatable-lib} may be linked with objects compiled with
20085 any combination of the @option{-mrelocatable} options.
20087 @item -mno-toc
20088 @itemx -mtoc
20089 @opindex mno-toc
20090 @opindex mtoc
20091 On System V.4 and embedded PowerPC systems do not (do) assume that
20092 register 2 contains a pointer to a global area pointing to the addresses
20093 used in the program.
20095 @item -mlittle
20096 @itemx -mlittle-endian
20097 @opindex mlittle
20098 @opindex mlittle-endian
20099 On System V.4 and embedded PowerPC systems compile code for the
20100 processor in little-endian mode.  The @option{-mlittle-endian} option is
20101 the same as @option{-mlittle}.
20103 @item -mbig
20104 @itemx -mbig-endian
20105 @opindex mbig
20106 @opindex mbig-endian
20107 On System V.4 and embedded PowerPC systems compile code for the
20108 processor in big-endian mode.  The @option{-mbig-endian} option is
20109 the same as @option{-mbig}.
20111 @item -mdynamic-no-pic
20112 @opindex mdynamic-no-pic
20113 On Darwin and Mac OS X systems, compile code so that it is not
20114 relocatable, but that its external references are relocatable.  The
20115 resulting code is suitable for applications, but not shared
20116 libraries.
20118 @item -msingle-pic-base
20119 @opindex msingle-pic-base
20120 Treat the register used for PIC addressing as read-only, rather than
20121 loading it in the prologue for each function.  The runtime system is
20122 responsible for initializing this register with an appropriate value
20123 before execution begins.
20125 @item -mprioritize-restricted-insns=@var{priority}
20126 @opindex mprioritize-restricted-insns
20127 This option controls the priority that is assigned to
20128 dispatch-slot restricted instructions during the second scheduling
20129 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
20130 or @samp{2} to assign no, highest, or second-highest (respectively) 
20131 priority to dispatch-slot restricted
20132 instructions.
20134 @item -msched-costly-dep=@var{dependence_type}
20135 @opindex msched-costly-dep
20136 This option controls which dependences are considered costly
20137 by the target during instruction scheduling.  The argument
20138 @var{dependence_type} takes one of the following values:
20140 @table @asis
20141 @item @samp{no}
20142 No dependence is costly.
20144 @item @samp{all}
20145 All dependences are costly.
20147 @item @samp{true_store_to_load}
20148 A true dependence from store to load is costly.
20150 @item @samp{store_to_load}
20151 Any dependence from store to load is costly.
20153 @item @var{number}
20154 Any dependence for which the latency is greater than or equal to 
20155 @var{number} is costly.
20156 @end table
20158 @item -minsert-sched-nops=@var{scheme}
20159 @opindex minsert-sched-nops
20160 This option controls which NOP insertion scheme is used during
20161 the second scheduling pass.  The argument @var{scheme} takes one of the
20162 following values:
20164 @table @asis
20165 @item @samp{no}
20166 Don't insert NOPs.
20168 @item @samp{pad}
20169 Pad with NOPs any dispatch group that has vacant issue slots,
20170 according to the scheduler's grouping.
20172 @item @samp{regroup_exact}
20173 Insert NOPs to force costly dependent insns into
20174 separate groups.  Insert exactly as many NOPs as needed to force an insn
20175 to a new group, according to the estimated processor grouping.
20177 @item @var{number}
20178 Insert NOPs to force costly dependent insns into
20179 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
20180 @end table
20182 @item -mcall-sysv
20183 @opindex mcall-sysv
20184 On System V.4 and embedded PowerPC systems compile code using calling
20185 conventions that adhere to the March 1995 draft of the System V
20186 Application Binary Interface, PowerPC processor supplement.  This is the
20187 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
20189 @item -mcall-sysv-eabi
20190 @itemx -mcall-eabi
20191 @opindex mcall-sysv-eabi
20192 @opindex mcall-eabi
20193 Specify both @option{-mcall-sysv} and @option{-meabi} options.
20195 @item -mcall-sysv-noeabi
20196 @opindex mcall-sysv-noeabi
20197 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
20199 @item -mcall-aixdesc
20200 @opindex m
20201 On System V.4 and embedded PowerPC systems compile code for the AIX
20202 operating system.
20204 @item -mcall-linux
20205 @opindex mcall-linux
20206 On System V.4 and embedded PowerPC systems compile code for the
20207 Linux-based GNU system.
20209 @item -mcall-freebsd
20210 @opindex mcall-freebsd
20211 On System V.4 and embedded PowerPC systems compile code for the
20212 FreeBSD operating system.
20214 @item -mcall-netbsd
20215 @opindex mcall-netbsd
20216 On System V.4 and embedded PowerPC systems compile code for the
20217 NetBSD operating system.
20219 @item -mcall-openbsd
20220 @opindex mcall-netbsd
20221 On System V.4 and embedded PowerPC systems compile code for the
20222 OpenBSD operating system.
20224 @item -maix-struct-return
20225 @opindex maix-struct-return
20226 Return all structures in memory (as specified by the AIX ABI)@.
20228 @item -msvr4-struct-return
20229 @opindex msvr4-struct-return
20230 Return structures smaller than 8 bytes in registers (as specified by the
20231 SVR4 ABI)@.
20233 @item -mabi=@var{abi-type}
20234 @opindex mabi
20235 Extend the current ABI with a particular extension, or remove such extension.
20236 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
20237 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
20238 @var{elfv1}, @var{elfv2}@.
20240 @item -mabi=spe
20241 @opindex mabi=spe
20242 Extend the current ABI with SPE ABI extensions.  This does not change
20243 the default ABI, instead it adds the SPE ABI extensions to the current
20244 ABI@.
20246 @item -mabi=no-spe
20247 @opindex mabi=no-spe
20248 Disable Book-E SPE ABI extensions for the current ABI@.
20250 @item -mabi=ibmlongdouble
20251 @opindex mabi=ibmlongdouble
20252 Change the current ABI to use IBM extended-precision long double.
20253 This is a PowerPC 32-bit SYSV ABI option.
20255 @item -mabi=ieeelongdouble
20256 @opindex mabi=ieeelongdouble
20257 Change the current ABI to use IEEE extended-precision long double.
20258 This is a PowerPC 32-bit Linux ABI option.
20260 @item -mabi=elfv1
20261 @opindex mabi=elfv1
20262 Change the current ABI to use the ELFv1 ABI.
20263 This is the default ABI for big-endian PowerPC 64-bit Linux.
20264 Overriding the default ABI requires special system support and is
20265 likely to fail in spectacular ways.
20267 @item -mabi=elfv2
20268 @opindex mabi=elfv2
20269 Change the current ABI to use the ELFv2 ABI.
20270 This is the default ABI for little-endian PowerPC 64-bit Linux.
20271 Overriding the default ABI requires special system support and is
20272 likely to fail in spectacular ways.
20274 @item -mprototype
20275 @itemx -mno-prototype
20276 @opindex mprototype
20277 @opindex mno-prototype
20278 On System V.4 and embedded PowerPC systems assume that all calls to
20279 variable argument functions are properly prototyped.  Otherwise, the
20280 compiler must insert an instruction before every non-prototyped call to
20281 set or clear bit 6 of the condition code register (@var{CR}) to
20282 indicate whether floating-point values are passed in the floating-point
20283 registers in case the function takes variable arguments.  With
20284 @option{-mprototype}, only calls to prototyped variable argument functions
20285 set or clear the bit.
20287 @item -msim
20288 @opindex msim
20289 On embedded PowerPC systems, assume that the startup module is called
20290 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20291 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20292 configurations.
20294 @item -mmvme
20295 @opindex mmvme
20296 On embedded PowerPC systems, assume that the startup module is called
20297 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20298 @file{libc.a}.
20300 @item -mads
20301 @opindex mads
20302 On embedded PowerPC systems, assume that the startup module is called
20303 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20304 @file{libc.a}.
20306 @item -myellowknife
20307 @opindex myellowknife
20308 On embedded PowerPC systems, assume that the startup module is called
20309 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20310 @file{libc.a}.
20312 @item -mvxworks
20313 @opindex mvxworks
20314 On System V.4 and embedded PowerPC systems, specify that you are
20315 compiling for a VxWorks system.
20317 @item -memb
20318 @opindex memb
20319 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
20320 header to indicate that @samp{eabi} extended relocations are used.
20322 @item -meabi
20323 @itemx -mno-eabi
20324 @opindex meabi
20325 @opindex mno-eabi
20326 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20327 Embedded Applications Binary Interface (EABI), which is a set of
20328 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20329 means that the stack is aligned to an 8-byte boundary, a function
20330 @code{__eabi} is called from @code{main} to set up the EABI
20331 environment, and the @option{-msdata} option can use both @code{r2} and
20332 @code{r13} to point to two separate small data areas.  Selecting
20333 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20334 no EABI initialization function is called from @code{main}, and the
20335 @option{-msdata} option only uses @code{r13} to point to a single
20336 small data area.  The @option{-meabi} option is on by default if you
20337 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20339 @item -msdata=eabi
20340 @opindex msdata=eabi
20341 On System V.4 and embedded PowerPC systems, put small initialized
20342 @code{const} global and static data in the @samp{.sdata2} section, which
20343 is pointed to by register @code{r2}.  Put small initialized
20344 non-@code{const} global and static data in the @samp{.sdata} section,
20345 which is pointed to by register @code{r13}.  Put small uninitialized
20346 global and static data in the @samp{.sbss} section, which is adjacent to
20347 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
20348 incompatible with the @option{-mrelocatable} option.  The
20349 @option{-msdata=eabi} option also sets the @option{-memb} option.
20351 @item -msdata=sysv
20352 @opindex msdata=sysv
20353 On System V.4 and embedded PowerPC systems, put small global and static
20354 data in the @samp{.sdata} section, which is pointed to by register
20355 @code{r13}.  Put small uninitialized global and static data in the
20356 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
20357 The @option{-msdata=sysv} option is incompatible with the
20358 @option{-mrelocatable} option.
20360 @item -msdata=default
20361 @itemx -msdata
20362 @opindex msdata=default
20363 @opindex msdata
20364 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20365 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20366 same as @option{-msdata=sysv}.
20368 @item -msdata=data
20369 @opindex msdata=data
20370 On System V.4 and embedded PowerPC systems, put small global
20371 data in the @samp{.sdata} section.  Put small uninitialized global
20372 data in the @samp{.sbss} section.  Do not use register @code{r13}
20373 to address small data however.  This is the default behavior unless
20374 other @option{-msdata} options are used.
20376 @item -msdata=none
20377 @itemx -mno-sdata
20378 @opindex msdata=none
20379 @opindex mno-sdata
20380 On embedded PowerPC systems, put all initialized global and static data
20381 in the @samp{.data} section, and all uninitialized data in the
20382 @samp{.bss} section.
20384 @item -mblock-move-inline-limit=@var{num}
20385 @opindex mblock-move-inline-limit
20386 Inline all block moves (such as calls to @code{memcpy} or structure
20387 copies) less than or equal to @var{num} bytes.  The minimum value for
20388 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20389 targets.  The default value is target-specific.
20391 @item -G @var{num}
20392 @opindex G
20393 @cindex smaller data references (PowerPC)
20394 @cindex .sdata/.sdata2 references (PowerPC)
20395 On embedded PowerPC systems, put global and static items less than or
20396 equal to @var{num} bytes into the small data or BSS sections instead of
20397 the normal data or BSS section.  By default, @var{num} is 8.  The
20398 @option{-G @var{num}} switch is also passed to the linker.
20399 All modules should be compiled with the same @option{-G @var{num}} value.
20401 @item -mregnames
20402 @itemx -mno-regnames
20403 @opindex mregnames
20404 @opindex mno-regnames
20405 On System V.4 and embedded PowerPC systems do (do not) emit register
20406 names in the assembly language output using symbolic forms.
20408 @item -mlongcall
20409 @itemx -mno-longcall
20410 @opindex mlongcall
20411 @opindex mno-longcall
20412 By default assume that all calls are far away so that a longer and more
20413 expensive calling sequence is required.  This is required for calls
20414 farther than 32 megabytes (33,554,432 bytes) from the current location.
20415 A short call is generated if the compiler knows
20416 the call cannot be that far away.  This setting can be overridden by
20417 the @code{shortcall} function attribute, or by @code{#pragma
20418 longcall(0)}.
20420 Some linkers are capable of detecting out-of-range calls and generating
20421 glue code on the fly.  On these systems, long calls are unnecessary and
20422 generate slower code.  As of this writing, the AIX linker can do this,
20423 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20424 to the GNU linker for 32-bit PowerPC systems as well.
20426 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20427 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20428 addresses represent the callee and the branch island.  The
20429 Darwin/PPC linker prefers the first address and generates a @code{bl
20430 callee} if the PPC @code{bl} instruction reaches the callee directly;
20431 otherwise, the linker generates @code{bl L42} to call the branch
20432 island.  The branch island is appended to the body of the
20433 calling function; it computes the full 32-bit address of the callee
20434 and jumps to it.
20436 On Mach-O (Darwin) systems, this option directs the compiler emit to
20437 the glue for every direct call, and the Darwin linker decides whether
20438 to use or discard it.
20440 In the future, GCC may ignore all longcall specifications
20441 when the linker is known to generate glue.
20443 @item -mtls-markers
20444 @itemx -mno-tls-markers
20445 @opindex mtls-markers
20446 @opindex mno-tls-markers
20447 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20448 specifying the function argument.  The relocation allows the linker to
20449 reliably associate function call with argument setup instructions for
20450 TLS optimization, which in turn allows GCC to better schedule the
20451 sequence.
20453 @item -pthread
20454 @opindex pthread
20455 Adds support for multithreading with the @dfn{pthreads} library.
20456 This option sets flags for both the preprocessor and linker.
20458 @item -mrecip
20459 @itemx -mno-recip
20460 @opindex mrecip
20461 This option enables use of the reciprocal estimate and
20462 reciprocal square root estimate instructions with additional
20463 Newton-Raphson steps to increase precision instead of doing a divide or
20464 square root and divide for floating-point arguments.  You should use
20465 the @option{-ffast-math} option when using @option{-mrecip} (or at
20466 least @option{-funsafe-math-optimizations},
20467 @option{-finite-math-only}, @option{-freciprocal-math} and
20468 @option{-fno-trapping-math}).  Note that while the throughput of the
20469 sequence is generally higher than the throughput of the non-reciprocal
20470 instruction, the precision of the sequence can be decreased by up to 2
20471 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20472 roots.
20474 @item -mrecip=@var{opt}
20475 @opindex mrecip=opt
20476 This option controls which reciprocal estimate instructions
20477 may be used.  @var{opt} is a comma-separated list of options, which may
20478 be preceded by a @code{!} to invert the option:
20479 @code{all}: enable all estimate instructions,
20480 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
20481 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
20482 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
20483 @code{divf}: enable the single-precision reciprocal approximation instructions;
20484 @code{divd}: enable the double-precision reciprocal approximation instructions;
20485 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
20486 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
20487 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
20489 So, for example, @option{-mrecip=all,!rsqrtd} enables
20490 all of the reciprocal estimate instructions, except for the
20491 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20492 which handle the double-precision reciprocal square root calculations.
20494 @item -mrecip-precision
20495 @itemx -mno-recip-precision
20496 @opindex mrecip-precision
20497 Assume (do not assume) that the reciprocal estimate instructions
20498 provide higher-precision estimates than is mandated by the PowerPC
20499 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20500 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20501 The double-precision square root estimate instructions are not generated by
20502 default on low-precision machines, since they do not provide an
20503 estimate that converges after three steps.
20505 @item -mveclibabi=@var{type}
20506 @opindex mveclibabi
20507 Specifies the ABI type to use for vectorizing intrinsics using an
20508 external library.  The only type supported at present is @code{mass},
20509 which specifies to use IBM's Mathematical Acceleration Subsystem
20510 (MASS) libraries for vectorizing intrinsics using external libraries.
20511 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20512 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20513 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20514 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20515 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20516 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20517 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20518 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20519 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20520 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20521 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20522 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20523 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20524 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20525 for power7.  Both @option{-ftree-vectorize} and
20526 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20527 libraries must be specified at link time.
20529 @item -mfriz
20530 @itemx -mno-friz
20531 @opindex mfriz
20532 Generate (do not generate) the @code{friz} instruction when the
20533 @option{-funsafe-math-optimizations} option is used to optimize
20534 rounding of floating-point values to 64-bit integer and back to floating
20535 point.  The @code{friz} instruction does not return the same value if
20536 the floating-point number is too large to fit in an integer.
20538 @item -mpointers-to-nested-functions
20539 @itemx -mno-pointers-to-nested-functions
20540 @opindex mpointers-to-nested-functions
20541 Generate (do not generate) code to load up the static chain register
20542 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20543 systems where a function pointer points to a 3-word descriptor giving
20544 the function address, TOC value to be loaded in register @var{r2}, and
20545 static chain value to be loaded in register @var{r11}.  The
20546 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20547 call through pointers to nested functions or pointers
20548 to functions compiled in other languages that use the static chain if
20549 you use the @option{-mno-pointers-to-nested-functions}.
20551 @item -msave-toc-indirect
20552 @itemx -mno-save-toc-indirect
20553 @opindex msave-toc-indirect
20554 Generate (do not generate) code to save the TOC value in the reserved
20555 stack location in the function prologue if the function calls through
20556 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20557 saved in the prologue, it is saved just before the call through the
20558 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20560 @item -mcompat-align-parm
20561 @itemx -mno-compat-align-parm
20562 @opindex mcompat-align-parm
20563 Generate (do not generate) code to pass structure parameters with a
20564 maximum alignment of 64 bits, for compatibility with older versions
20565 of GCC.
20567 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20568 structure parameter on a 128-bit boundary when that structure contained
20569 a member requiring 128-bit alignment.  This is corrected in more
20570 recent versions of GCC.  This option may be used to generate code
20571 that is compatible with functions compiled with older versions of
20572 GCC.
20574 The @option{-mno-compat-align-parm} option is the default.
20575 @end table
20577 @node RX Options
20578 @subsection RX Options
20579 @cindex RX Options
20581 These command-line options are defined for RX targets:
20583 @table @gcctabopt
20584 @item -m64bit-doubles
20585 @itemx -m32bit-doubles
20586 @opindex m64bit-doubles
20587 @opindex m32bit-doubles
20588 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20589 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20590 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20591 works on 32-bit values, which is why the default is
20592 @option{-m32bit-doubles}.
20594 @item -fpu
20595 @itemx -nofpu
20596 @opindex fpu
20597 @opindex nofpu
20598 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20599 floating-point hardware.  The default is enabled for the @var{RX600}
20600 series and disabled for the @var{RX200} series.
20602 Floating-point instructions are only generated for 32-bit floating-point 
20603 values, however, so the FPU hardware is not used for doubles if the
20604 @option{-m64bit-doubles} option is used.
20606 @emph{Note} If the @option{-fpu} option is enabled then
20607 @option{-funsafe-math-optimizations} is also enabled automatically.
20608 This is because the RX FPU instructions are themselves unsafe.
20610 @item -mcpu=@var{name}
20611 @opindex -mcpu
20612 Selects the type of RX CPU to be targeted.  Currently three types are
20613 supported, the generic @var{RX600} and @var{RX200} series hardware and
20614 the specific @var{RX610} CPU.  The default is @var{RX600}.
20616 The only difference between @var{RX600} and @var{RX610} is that the
20617 @var{RX610} does not support the @code{MVTIPL} instruction.
20619 The @var{RX200} series does not have a hardware floating-point unit
20620 and so @option{-nofpu} is enabled by default when this type is
20621 selected.
20623 @item -mbig-endian-data
20624 @itemx -mlittle-endian-data
20625 @opindex mbig-endian-data
20626 @opindex mlittle-endian-data
20627 Store data (but not code) in the big-endian format.  The default is
20628 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20629 format.
20631 @item -msmall-data-limit=@var{N}
20632 @opindex msmall-data-limit
20633 Specifies the maximum size in bytes of global and static variables
20634 which can be placed into the small data area.  Using the small data
20635 area can lead to smaller and faster code, but the size of area is
20636 limited and it is up to the programmer to ensure that the area does
20637 not overflow.  Also when the small data area is used one of the RX's
20638 registers (usually @code{r13}) is reserved for use pointing to this
20639 area, so it is no longer available for use by the compiler.  This
20640 could result in slower and/or larger code if variables are pushed onto
20641 the stack instead of being held in this register.
20643 Note, common variables (variables that have not been initialized) and
20644 constants are not placed into the small data area as they are assigned
20645 to other sections in the output executable.
20647 The default value is zero, which disables this feature.  Note, this
20648 feature is not enabled by default with higher optimization levels
20649 (@option{-O2} etc) because of the potentially detrimental effects of
20650 reserving a register.  It is up to the programmer to experiment and
20651 discover whether this feature is of benefit to their program.  See the
20652 description of the @option{-mpid} option for a description of how the
20653 actual register to hold the small data area pointer is chosen.
20655 @item -msim
20656 @itemx -mno-sim
20657 @opindex msim
20658 @opindex mno-sim
20659 Use the simulator runtime.  The default is to use the libgloss
20660 board-specific runtime.
20662 @item -mas100-syntax
20663 @itemx -mno-as100-syntax
20664 @opindex mas100-syntax
20665 @opindex mno-as100-syntax
20666 When generating assembler output use a syntax that is compatible with
20667 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20668 assembler, but it has some restrictions so it is not generated by default.
20670 @item -mmax-constant-size=@var{N}
20671 @opindex mmax-constant-size
20672 Specifies the maximum size, in bytes, of a constant that can be used as
20673 an operand in a RX instruction.  Although the RX instruction set does
20674 allow constants of up to 4 bytes in length to be used in instructions,
20675 a longer value equates to a longer instruction.  Thus in some
20676 circumstances it can be beneficial to restrict the size of constants
20677 that are used in instructions.  Constants that are too big are instead
20678 placed into a constant pool and referenced via register indirection.
20680 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20681 or 4 means that constants of any size are allowed.
20683 @item -mrelax
20684 @opindex mrelax
20685 Enable linker relaxation.  Linker relaxation is a process whereby the
20686 linker attempts to reduce the size of a program by finding shorter
20687 versions of various instructions.  Disabled by default.
20689 @item -mint-register=@var{N}
20690 @opindex mint-register
20691 Specify the number of registers to reserve for fast interrupt handler
20692 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20693 means that register @code{r13} is reserved for the exclusive use
20694 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20695 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20696 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20697 A value of 0, the default, does not reserve any registers.
20699 @item -msave-acc-in-interrupts
20700 @opindex msave-acc-in-interrupts
20701 Specifies that interrupt handler functions should preserve the
20702 accumulator register.  This is only necessary if normal code might use
20703 the accumulator register, for example because it performs 64-bit
20704 multiplications.  The default is to ignore the accumulator as this
20705 makes the interrupt handlers faster.
20707 @item -mpid
20708 @itemx -mno-pid
20709 @opindex mpid
20710 @opindex mno-pid
20711 Enables the generation of position independent data.  When enabled any
20712 access to constant data is done via an offset from a base address
20713 held in a register.  This allows the location of constant data to be
20714 determined at run time without requiring the executable to be
20715 relocated, which is a benefit to embedded applications with tight
20716 memory constraints.  Data that can be modified is not affected by this
20717 option.
20719 Note, using this feature reserves a register, usually @code{r13}, for
20720 the constant data base address.  This can result in slower and/or
20721 larger code, especially in complicated functions.
20723 The actual register chosen to hold the constant data base address
20724 depends upon whether the @option{-msmall-data-limit} and/or the
20725 @option{-mint-register} command-line options are enabled.  Starting
20726 with register @code{r13} and proceeding downwards, registers are
20727 allocated first to satisfy the requirements of @option{-mint-register},
20728 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20729 is possible for the small data area register to be @code{r8} if both
20730 @option{-mint-register=4} and @option{-mpid} are specified on the
20731 command line.
20733 By default this feature is not enabled.  The default can be restored
20734 via the @option{-mno-pid} command-line option.
20736 @item -mno-warn-multiple-fast-interrupts
20737 @itemx -mwarn-multiple-fast-interrupts
20738 @opindex mno-warn-multiple-fast-interrupts
20739 @opindex mwarn-multiple-fast-interrupts
20740 Prevents GCC from issuing a warning message if it finds more than one
20741 fast interrupt handler when it is compiling a file.  The default is to
20742 issue a warning for each extra fast interrupt handler found, as the RX
20743 only supports one such interrupt.
20745 @end table
20747 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20748 has special significance to the RX port when used with the
20749 @code{interrupt} function attribute.  This attribute indicates a
20750 function intended to process fast interrupts.  GCC ensures
20751 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20752 and/or @code{r13} and only provided that the normal use of the
20753 corresponding registers have been restricted via the
20754 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20755 options.
20757 @node S/390 and zSeries Options
20758 @subsection S/390 and zSeries Options
20759 @cindex S/390 and zSeries Options
20761 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20763 @table @gcctabopt
20764 @item -mhard-float
20765 @itemx -msoft-float
20766 @opindex mhard-float
20767 @opindex msoft-float
20768 Use (do not use) the hardware floating-point instructions and registers
20769 for floating-point operations.  When @option{-msoft-float} is specified,
20770 functions in @file{libgcc.a} are used to perform floating-point
20771 operations.  When @option{-mhard-float} is specified, the compiler
20772 generates IEEE floating-point instructions.  This is the default.
20774 @item -mhard-dfp
20775 @itemx -mno-hard-dfp
20776 @opindex mhard-dfp
20777 @opindex mno-hard-dfp
20778 Use (do not use) the hardware decimal-floating-point instructions for
20779 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20780 specified, functions in @file{libgcc.a} are used to perform
20781 decimal-floating-point operations.  When @option{-mhard-dfp} is
20782 specified, the compiler generates decimal-floating-point hardware
20783 instructions.  This is the default for @option{-march=z9-ec} or higher.
20785 @item -mlong-double-64
20786 @itemx -mlong-double-128
20787 @opindex mlong-double-64
20788 @opindex mlong-double-128
20789 These switches control the size of @code{long double} type. A size
20790 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20791 type. This is the default.
20793 @item -mbackchain
20794 @itemx -mno-backchain
20795 @opindex mbackchain
20796 @opindex mno-backchain
20797 Store (do not store) the address of the caller's frame as backchain pointer
20798 into the callee's stack frame.
20799 A backchain may be needed to allow debugging using tools that do not understand
20800 DWARF 2 call frame information.
20801 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20802 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20803 the backchain is placed into the topmost word of the 96/160 byte register
20804 save area.
20806 In general, code compiled with @option{-mbackchain} is call-compatible with
20807 code compiled with @option{-mmo-backchain}; however, use of the backchain
20808 for debugging purposes usually requires that the whole binary is built with
20809 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20810 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20811 to build a linux kernel use @option{-msoft-float}.
20813 The default is to not maintain the backchain.
20815 @item -mpacked-stack
20816 @itemx -mno-packed-stack
20817 @opindex mpacked-stack
20818 @opindex mno-packed-stack
20819 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20820 specified, the compiler uses the all fields of the 96/160 byte register save
20821 area only for their default purpose; unused fields still take up stack space.
20822 When @option{-mpacked-stack} is specified, register save slots are densely
20823 packed at the top of the register save area; unused space is reused for other
20824 purposes, allowing for more efficient use of the available stack space.
20825 However, when @option{-mbackchain} is also in effect, the topmost word of
20826 the save area is always used to store the backchain, and the return address
20827 register is always saved two words below the backchain.
20829 As long as the stack frame backchain is not used, code generated with
20830 @option{-mpacked-stack} is call-compatible with code generated with
20831 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20832 S/390 or zSeries generated code that uses the stack frame backchain at run
20833 time, not just for debugging purposes.  Such code is not call-compatible
20834 with code compiled with @option{-mpacked-stack}.  Also, note that the
20835 combination of @option{-mbackchain},
20836 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20837 to build a linux kernel use @option{-msoft-float}.
20839 The default is to not use the packed stack layout.
20841 @item -msmall-exec
20842 @itemx -mno-small-exec
20843 @opindex msmall-exec
20844 @opindex mno-small-exec
20845 Generate (or do not generate) code using the @code{bras} instruction
20846 to do subroutine calls.
20847 This only works reliably if the total executable size does not
20848 exceed 64k.  The default is to use the @code{basr} instruction instead,
20849 which does not have this limitation.
20851 @item -m64
20852 @itemx -m31
20853 @opindex m64
20854 @opindex m31
20855 When @option{-m31} is specified, generate code compliant to the
20856 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20857 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20858 particular to generate 64-bit instructions.  For the @samp{s390}
20859 targets, the default is @option{-m31}, while the @samp{s390x}
20860 targets default to @option{-m64}.
20862 @item -mzarch
20863 @itemx -mesa
20864 @opindex mzarch
20865 @opindex mesa
20866 When @option{-mzarch} is specified, generate code using the
20867 instructions available on z/Architecture.
20868 When @option{-mesa} is specified, generate code using the
20869 instructions available on ESA/390.  Note that @option{-mesa} is
20870 not possible with @option{-m64}.
20871 When generating code compliant to the GNU/Linux for S/390 ABI,
20872 the default is @option{-mesa}.  When generating code compliant
20873 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20875 @item -mmvcle
20876 @itemx -mno-mvcle
20877 @opindex mmvcle
20878 @opindex mno-mvcle
20879 Generate (or do not generate) code using the @code{mvcle} instruction
20880 to perform block moves.  When @option{-mno-mvcle} is specified,
20881 use a @code{mvc} loop instead.  This is the default unless optimizing for
20882 size.
20884 @item -mdebug
20885 @itemx -mno-debug
20886 @opindex mdebug
20887 @opindex mno-debug
20888 Print (or do not print) additional debug information when compiling.
20889 The default is to not print debug information.
20891 @item -march=@var{cpu-type}
20892 @opindex march
20893 Generate code that runs on @var{cpu-type}, which is the name of a system
20894 representing a certain processor type.  Possible values for
20895 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20896 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20897 When generating code using the instructions available on z/Architecture,
20898 the default is @option{-march=z900}.  Otherwise, the default is
20899 @option{-march=g5}.
20901 @item -mtune=@var{cpu-type}
20902 @opindex mtune
20903 Tune to @var{cpu-type} everything applicable about the generated code,
20904 except for the ABI and the set of available instructions.
20905 The list of @var{cpu-type} values is the same as for @option{-march}.
20906 The default is the value used for @option{-march}.
20908 @item -mtpf-trace
20909 @itemx -mno-tpf-trace
20910 @opindex mtpf-trace
20911 @opindex mno-tpf-trace
20912 Generate code that adds (does not add) in TPF OS specific branches to trace
20913 routines in the operating system.  This option is off by default, even
20914 when compiling for the TPF OS@.
20916 @item -mfused-madd
20917 @itemx -mno-fused-madd
20918 @opindex mfused-madd
20919 @opindex mno-fused-madd
20920 Generate code that uses (does not use) the floating-point multiply and
20921 accumulate instructions.  These instructions are generated by default if
20922 hardware floating point is used.
20924 @item -mwarn-framesize=@var{framesize}
20925 @opindex mwarn-framesize
20926 Emit a warning if the current function exceeds the given frame size.  Because
20927 this is a compile-time check it doesn't need to be a real problem when the program
20928 runs.  It is intended to identify functions that most probably cause
20929 a stack overflow.  It is useful to be used in an environment with limited stack
20930 size e.g.@: the linux kernel.
20932 @item -mwarn-dynamicstack
20933 @opindex mwarn-dynamicstack
20934 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20935 arrays.  This is generally a bad idea with a limited stack size.
20937 @item -mstack-guard=@var{stack-guard}
20938 @itemx -mstack-size=@var{stack-size}
20939 @opindex mstack-guard
20940 @opindex mstack-size
20941 If these options are provided the S/390 back end emits additional instructions in
20942 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20943 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20944 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20945 the frame size of the compiled function is chosen.
20946 These options are intended to be used to help debugging stack overflow problems.
20947 The additionally emitted code causes only little overhead and hence can also be
20948 used in production-like systems without greater performance degradation.  The given
20949 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20950 @var{stack-guard} without exceeding 64k.
20951 In order to be efficient the extra code makes the assumption that the stack starts
20952 at an address aligned to the value given by @var{stack-size}.
20953 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20955 @item -mhotpatch[=@var{halfwords}]
20956 @itemx -mno-hotpatch
20957 @opindex mhotpatch
20958 If the hotpatch option is enabled, a ``hot-patching'' function
20959 prologue is generated for all functions in the compilation unit.
20960 The funtion label is prepended with the given number of two-byte
20961 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
20962 instructions if no argument is present.  Functions with a
20963 hot-patching prologue are never inlined automatically, and a
20964 hot-patching prologue is never generated for functions
20965 that are explicitly inline.
20967 This option can be overridden for individual functions with the
20968 @code{hotpatch} attribute.
20969 @end table
20971 @node Score Options
20972 @subsection Score Options
20973 @cindex Score Options
20975 These options are defined for Score implementations:
20977 @table @gcctabopt
20978 @item -meb
20979 @opindex meb
20980 Compile code for big-endian mode.  This is the default.
20982 @item -mel
20983 @opindex mel
20984 Compile code for little-endian mode.
20986 @item -mnhwloop
20987 @opindex mnhwloop
20988 Disable generation of @code{bcnz} instructions.
20990 @item -muls
20991 @opindex muls
20992 Enable generation of unaligned load and store instructions.
20994 @item -mmac
20995 @opindex mmac
20996 Enable the use of multiply-accumulate instructions. Disabled by default.
20998 @item -mscore5
20999 @opindex mscore5
21000 Specify the SCORE5 as the target architecture.
21002 @item -mscore5u
21003 @opindex mscore5u
21004 Specify the SCORE5U of the target architecture.
21006 @item -mscore7
21007 @opindex mscore7
21008 Specify the SCORE7 as the target architecture. This is the default.
21010 @item -mscore7d
21011 @opindex mscore7d
21012 Specify the SCORE7D as the target architecture.
21013 @end table
21015 @node SH Options
21016 @subsection SH Options
21018 These @samp{-m} options are defined for the SH implementations:
21020 @table @gcctabopt
21021 @item -m1
21022 @opindex m1
21023 Generate code for the SH1.
21025 @item -m2
21026 @opindex m2
21027 Generate code for the SH2.
21029 @item -m2e
21030 Generate code for the SH2e.
21032 @item -m2a-nofpu
21033 @opindex m2a-nofpu
21034 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
21035 that the floating-point unit is not used.
21037 @item -m2a-single-only
21038 @opindex m2a-single-only
21039 Generate code for the SH2a-FPU, in such a way that no double-precision
21040 floating-point operations are used.
21042 @item -m2a-single
21043 @opindex m2a-single
21044 Generate code for the SH2a-FPU assuming the floating-point unit is in
21045 single-precision mode by default.
21047 @item -m2a
21048 @opindex m2a
21049 Generate code for the SH2a-FPU assuming the floating-point unit is in
21050 double-precision mode by default.
21052 @item -m3
21053 @opindex m3
21054 Generate code for the SH3.
21056 @item -m3e
21057 @opindex m3e
21058 Generate code for the SH3e.
21060 @item -m4-nofpu
21061 @opindex m4-nofpu
21062 Generate code for the SH4 without a floating-point unit.
21064 @item -m4-single-only
21065 @opindex m4-single-only
21066 Generate code for the SH4 with a floating-point unit that only
21067 supports single-precision arithmetic.
21069 @item -m4-single
21070 @opindex m4-single
21071 Generate code for the SH4 assuming the floating-point unit is in
21072 single-precision mode by default.
21074 @item -m4
21075 @opindex m4
21076 Generate code for the SH4.
21078 @item -m4-100
21079 @opindex m4-100
21080 Generate code for SH4-100.
21082 @item -m4-100-nofpu
21083 @opindex m4-100-nofpu
21084 Generate code for SH4-100 in such a way that the
21085 floating-point unit is not used.
21087 @item -m4-100-single
21088 @opindex m4-100-single
21089 Generate code for SH4-100 assuming the floating-point unit is in
21090 single-precision mode by default.
21092 @item -m4-100-single-only
21093 @opindex m4-100-single-only
21094 Generate code for SH4-100 in such a way that no double-precision
21095 floating-point operations are used.
21097 @item -m4-200
21098 @opindex m4-200
21099 Generate code for SH4-200.
21101 @item -m4-200-nofpu
21102 @opindex m4-200-nofpu
21103 Generate code for SH4-200 without in such a way that the
21104 floating-point unit is not used.
21106 @item -m4-200-single
21107 @opindex m4-200-single
21108 Generate code for SH4-200 assuming the floating-point unit is in
21109 single-precision mode by default.
21111 @item -m4-200-single-only
21112 @opindex m4-200-single-only
21113 Generate code for SH4-200 in such a way that no double-precision
21114 floating-point operations are used.
21116 @item -m4-300
21117 @opindex m4-300
21118 Generate code for SH4-300.
21120 @item -m4-300-nofpu
21121 @opindex m4-300-nofpu
21122 Generate code for SH4-300 without in such a way that the
21123 floating-point unit is not used.
21125 @item -m4-300-single
21126 @opindex m4-300-single
21127 Generate code for SH4-300 in such a way that no double-precision
21128 floating-point operations are used.
21130 @item -m4-300-single-only
21131 @opindex m4-300-single-only
21132 Generate code for SH4-300 in such a way that no double-precision
21133 floating-point operations are used.
21135 @item -m4-340
21136 @opindex m4-340
21137 Generate code for SH4-340 (no MMU, no FPU).
21139 @item -m4-500
21140 @opindex m4-500
21141 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
21142 assembler.
21144 @item -m4a-nofpu
21145 @opindex m4a-nofpu
21146 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
21147 floating-point unit is not used.
21149 @item -m4a-single-only
21150 @opindex m4a-single-only
21151 Generate code for the SH4a, in such a way that no double-precision
21152 floating-point operations are used.
21154 @item -m4a-single
21155 @opindex m4a-single
21156 Generate code for the SH4a assuming the floating-point unit is in
21157 single-precision mode by default.
21159 @item -m4a
21160 @opindex m4a
21161 Generate code for the SH4a.
21163 @item -m4al
21164 @opindex m4al
21165 Same as @option{-m4a-nofpu}, except that it implicitly passes
21166 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
21167 instructions at the moment.
21169 @item -m5-32media
21170 @opindex m5-32media
21171 Generate 32-bit code for SHmedia.
21173 @item -m5-32media-nofpu
21174 @opindex m5-32media-nofpu
21175 Generate 32-bit code for SHmedia in such a way that the
21176 floating-point unit is not used.
21178 @item -m5-64media
21179 @opindex m5-64media
21180 Generate 64-bit code for SHmedia.
21182 @item -m5-64media-nofpu
21183 @opindex m5-64media-nofpu
21184 Generate 64-bit code for SHmedia in such a way that the
21185 floating-point unit is not used.
21187 @item -m5-compact
21188 @opindex m5-compact
21189 Generate code for SHcompact.
21191 @item -m5-compact-nofpu
21192 @opindex m5-compact-nofpu
21193 Generate code for SHcompact in such a way that the
21194 floating-point unit is not used.
21196 @item -mb
21197 @opindex mb
21198 Compile code for the processor in big-endian mode.
21200 @item -ml
21201 @opindex ml
21202 Compile code for the processor in little-endian mode.
21204 @item -mdalign
21205 @opindex mdalign
21206 Align doubles at 64-bit boundaries.  Note that this changes the calling
21207 conventions, and thus some functions from the standard C library do
21208 not work unless you recompile it first with @option{-mdalign}.
21210 @item -mrelax
21211 @opindex mrelax
21212 Shorten some address references at link time, when possible; uses the
21213 linker option @option{-relax}.
21215 @item -mbigtable
21216 @opindex mbigtable
21217 Use 32-bit offsets in @code{switch} tables.  The default is to use
21218 16-bit offsets.
21220 @item -mbitops
21221 @opindex mbitops
21222 Enable the use of bit manipulation instructions on SH2A.
21224 @item -mfmovd
21225 @opindex mfmovd
21226 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21227 alignment constraints.
21229 @item -mrenesas
21230 @opindex mrenesas
21231 Comply with the calling conventions defined by Renesas.
21233 @item -mno-renesas
21234 @opindex mno-renesas
21235 Comply with the calling conventions defined for GCC before the Renesas
21236 conventions were available.  This option is the default for all
21237 targets of the SH toolchain.
21239 @item -mnomacsave
21240 @opindex mnomacsave
21241 Mark the @code{MAC} register as call-clobbered, even if
21242 @option{-mrenesas} is given.
21244 @item -mieee
21245 @itemx -mno-ieee
21246 @opindex mieee
21247 @opindex mno-ieee
21248 Control the IEEE compliance of floating-point comparisons, which affects the
21249 handling of cases where the result of a comparison is unordered.  By default
21250 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21251 enabled @option{-mno-ieee} is implicitly set, which results in faster
21252 floating-point greater-equal and less-equal comparisons.  The implcit settings
21253 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21255 @item -minline-ic_invalidate
21256 @opindex minline-ic_invalidate
21257 Inline code to invalidate instruction cache entries after setting up
21258 nested function trampolines.
21259 This option has no effect if @option{-musermode} is in effect and the selected
21260 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21261 instruction.
21262 If the selected code generation option does not allow the use of the @code{icbi}
21263 instruction, and @option{-musermode} is not in effect, the inlined code
21264 manipulates the instruction cache address array directly with an associative
21265 write.  This not only requires privileged mode at run time, but it also
21266 fails if the cache line had been mapped via the TLB and has become unmapped.
21268 @item -misize
21269 @opindex misize
21270 Dump instruction size and location in the assembly code.
21272 @item -mpadstruct
21273 @opindex mpadstruct
21274 This option is deprecated.  It pads structures to multiple of 4 bytes,
21275 which is incompatible with the SH ABI@.
21277 @item -matomic-model=@var{model}
21278 @opindex matomic-model=@var{model}
21279 Sets the model of atomic operations and additional parameters as a comma
21280 separated list.  For details on the atomic built-in functions see
21281 @ref{__atomic Builtins}.  The following models and parameters are supported:
21283 @table @samp
21285 @item none
21286 Disable compiler generated atomic sequences and emit library calls for atomic
21287 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21289 @item soft-gusa
21290 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21291 built-in functions.  The generated atomic sequences require additional support
21292 from the interrupt/exception handling code of the system and are only suitable
21293 for SH3* and SH4* single-core systems.  This option is enabled by default when
21294 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21295 this option will also partially utilize the hardware atomic instructions
21296 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21297 @samp{strict} is specified.  
21299 @item soft-tcb
21300 Generate software atomic sequences that use a variable in the thread control
21301 block.  This is a variation of the gUSA sequences which can also be used on
21302 SH1* and SH2* targets.  The generated atomic sequences require additional
21303 support from the interrupt/exception handling code of the system and are only
21304 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21305 parameter has to be specified as well.
21307 @item soft-imask
21308 Generate software atomic sequences that temporarily disable interrupts by
21309 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21310 in privileged mode and is only suitable for single-core systems.  Additional
21311 support from the interrupt/exception handling code of the system is not
21312 required.  This model is enabled by default when the target is
21313 @code{sh*-*-linux*} and SH1* or SH2*.
21315 @item hard-llcs
21316 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21317 instructions only.  This is only available on SH4A and is suitable for
21318 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21319 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21320 Code compiled with this option will also be compatible with other software
21321 atomic model interrupt/exception handling systems if executed on an SH4A
21322 system.  Additional support from the interrupt/exception handling code of the
21323 system is not required for this model.
21325 @item gbr-offset=
21326 This parameter specifies the offset in bytes of the variable in the thread
21327 control block structure that should be used by the generated atomic sequences
21328 when the @samp{soft-tcb} model has been selected.  For other models this
21329 parameter is ignored.  The specified value must be an integer multiple of four
21330 and in the range 0-1020.
21332 @item strict
21333 This parameter prevents mixed usage of multiple atomic models, even though they
21334 would be compatible, and will make the compiler generate atomic sequences of the
21335 specified model only.
21337 @end table
21339 @item -mtas
21340 @opindex mtas
21341 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21342 Notice that depending on the particular hardware and software configuration
21343 this can degrade overall performance due to the operand cache line flushes
21344 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21345 processors the @code{tas.b} instruction must be used with caution since it
21346 can result in data corruption for certain cache configurations.
21348 @item -mprefergot
21349 @opindex mprefergot
21350 When generating position-independent code, emit function calls using
21351 the Global Offset Table instead of the Procedure Linkage Table.
21353 @item -musermode
21354 @itemx -mno-usermode
21355 @opindex musermode
21356 @opindex mno-usermode
21357 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21358 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21359 inlined code would not work in user mode.  @option{-musermode} is the default
21360 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21361 @option{-musermode} has no effect, since there is no user mode.
21363 @item -multcost=@var{number}
21364 @opindex multcost=@var{number}
21365 Set the cost to assume for a multiply insn.
21367 @item -mdiv=@var{strategy}
21368 @opindex mdiv=@var{strategy}
21369 Set the division strategy to be used for integer division operations.
21370 For SHmedia @var{strategy} can be one of: 
21372 @table @samp
21374 @item fp 
21375 Performs the operation in floating point.  This has a very high latency,
21376 but needs only a few instructions, so it might be a good choice if
21377 your code has enough easily-exploitable ILP to allow the compiler to
21378 schedule the floating-point instructions together with other instructions.
21379 Division by zero causes a floating-point exception.
21381 @item inv
21382 Uses integer operations to calculate the inverse of the divisor,
21383 and then multiplies the dividend with the inverse.  This strategy allows
21384 CSE and hoisting of the inverse calculation.  Division by zero calculates
21385 an unspecified result, but does not trap.
21387 @item inv:minlat
21388 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21389 have been found, or if the entire operation has been hoisted to the same
21390 place, the last stages of the inverse calculation are intertwined with the
21391 final multiply to reduce the overall latency, at the expense of using a few
21392 more instructions, and thus offering fewer scheduling opportunities with
21393 other code.
21395 @item call
21396 Calls a library function that usually implements the @samp{inv:minlat}
21397 strategy.
21398 This gives high code density for @code{m5-*media-nofpu} compilations.
21400 @item call2
21401 Uses a different entry point of the same library function, where it
21402 assumes that a pointer to a lookup table has already been set up, which
21403 exposes the pointer load to CSE and code hoisting optimizations.
21405 @item inv:call
21406 @itemx inv:call2
21407 @itemx inv:fp
21408 Use the @samp{inv} algorithm for initial
21409 code generation, but if the code stays unoptimized, revert to the @samp{call},
21410 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21411 potentially-trapping side effect of division by zero is carried by a
21412 separate instruction, so it is possible that all the integer instructions
21413 are hoisted out, but the marker for the side effect stays where it is.
21414 A recombination to floating-point operations or a call is not possible
21415 in that case.
21417 @item inv20u
21418 @itemx inv20l
21419 Variants of the @samp{inv:minlat} strategy.  In the case
21420 that the inverse calculation is not separated from the multiply, they speed
21421 up division where the dividend fits into 20 bits (plus sign where applicable)
21422 by inserting a test to skip a number of operations in this case; this test
21423 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21424 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21426 @end table
21428 For targets other than SHmedia @var{strategy} can be one of:
21430 @table @samp
21432 @item call-div1
21433 Calls a library function that uses the single-step division instruction
21434 @code{div1} to perform the operation.  Division by zero calculates an
21435 unspecified result and does not trap.  This is the default except for SH4,
21436 SH2A and SHcompact.
21438 @item call-fp
21439 Calls a library function that performs the operation in double precision
21440 floating point.  Division by zero causes a floating-point exception.  This is
21441 the default for SHcompact with FPU.  Specifying this for targets that do not
21442 have a double precision FPU will default to @code{call-div1}.
21444 @item call-table
21445 Calls a library function that uses a lookup table for small divisors and
21446 the @code{div1} instruction with case distinction for larger divisors.  Division
21447 by zero calculates an unspecified result and does not trap.  This is the default
21448 for SH4.  Specifying this for targets that do not have dynamic shift
21449 instructions will default to @code{call-div1}.
21451 @end table
21453 When a division strategy has not been specified the default strategy will be
21454 selected based on the current target.  For SH2A the default strategy is to
21455 use the @code{divs} and @code{divu} instructions instead of library function
21456 calls.
21458 @item -maccumulate-outgoing-args
21459 @opindex maccumulate-outgoing-args
21460 Reserve space once for outgoing arguments in the function prologue rather
21461 than around each call.  Generally beneficial for performance and size.  Also
21462 needed for unwinding to avoid changing the stack frame around conditional code.
21464 @item -mdivsi3_libfunc=@var{name}
21465 @opindex mdivsi3_libfunc=@var{name}
21466 Set the name of the library function used for 32-bit signed division to
21467 @var{name}.
21468 This only affects the name used in the @samp{call} and @samp{inv:call}
21469 division strategies, and the compiler still expects the same
21470 sets of input/output/clobbered registers as if this option were not present.
21472 @item -mfixed-range=@var{register-range}
21473 @opindex mfixed-range
21474 Generate code treating the given register range as fixed registers.
21475 A fixed register is one that the register allocator can not use.  This is
21476 useful when compiling kernel code.  A register range is specified as
21477 two registers separated by a dash.  Multiple register ranges can be
21478 specified separated by a comma.
21480 @item -mindexed-addressing
21481 @opindex mindexed-addressing
21482 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21483 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21484 semantics for the indexed addressing mode.  The architecture allows the
21485 implementation of processors with 64-bit MMU, which the OS could use to
21486 get 32-bit addressing, but since no current hardware implementation supports
21487 this or any other way to make the indexed addressing mode safe to use in
21488 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21490 @item -mgettrcost=@var{number}
21491 @opindex mgettrcost=@var{number}
21492 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21493 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21495 @item -mpt-fixed
21496 @opindex mpt-fixed
21497 Assume @code{pt*} instructions won't trap.  This generally generates
21498 better-scheduled code, but is unsafe on current hardware.
21499 The current architecture
21500 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21501 anded with 3 is 3.
21502 This has the unintentional effect of making it unsafe to schedule these
21503 instructions before a branch, or hoist them out of a loop.  For example,
21504 @code{__do_global_ctors}, a part of @file{libgcc}
21505 that runs constructors at program
21506 startup, calls functions in a list which is delimited by @minus{}1.  With the
21507 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21508 That means that all the constructors run a bit more quickly, but when
21509 the loop comes to the end of the list, the program crashes because @code{ptabs}
21510 loads @minus{}1 into a target register.  
21512 Since this option is unsafe for any
21513 hardware implementing the current architecture specification, the default
21514 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21515 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21516 this deters register allocation from using target registers for storing
21517 ordinary integers.
21519 @item -minvalid-symbols
21520 @opindex minvalid-symbols
21521 Assume symbols might be invalid.  Ordinary function symbols generated by
21522 the compiler are always valid to load with
21523 @code{movi}/@code{shori}/@code{ptabs} or
21524 @code{movi}/@code{shori}/@code{ptrel},
21525 but with assembler and/or linker tricks it is possible
21526 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21527 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21528 It prevents cross-basic-block CSE, hoisting and most scheduling
21529 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21531 @item -mbranch-cost=@var{num}
21532 @opindex mbranch-cost=@var{num}
21533 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21534 make the compiler try to generate more branch-free code if possible.  
21535 If not specified the value is selected depending on the processor type that
21536 is being compiled for.
21538 @item -mzdcbranch
21539 @itemx -mno-zdcbranch
21540 @opindex mzdcbranch
21541 @opindex mno-zdcbranch
21542 Assume (do not assume) that zero displacement conditional branch instructions
21543 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21544 compiler will try to prefer zero displacement branch code sequences.  This is
21545 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21546 disabled by specifying @option{-mno-zdcbranch}.
21548 @item -mfused-madd
21549 @itemx -mno-fused-madd
21550 @opindex mfused-madd
21551 @opindex mno-fused-madd
21552 Generate code that uses (does not use) the floating-point multiply and
21553 accumulate instructions.  These instructions are generated by default
21554 if hardware floating point is used.  The machine-dependent
21555 @option{-mfused-madd} option is now mapped to the machine-independent
21556 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21557 mapped to @option{-ffp-contract=off}.
21559 @item -mfsca
21560 @itemx -mno-fsca
21561 @opindex mfsca
21562 @opindex mno-fsca
21563 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21564 and cosine approximations.  The option @code{-mfsca} must be used in
21565 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
21566 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
21567 approximations even if @code{-funsafe-math-optimizations} is in effect.
21569 @item -mfsrra
21570 @itemx -mno-fsrra
21571 @opindex mfsrra
21572 @opindex mno-fsrra
21573 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21574 reciprocal square root approximations.  The option @code{-mfsrra} must be used
21575 in combination with @code{-funsafe-math-optimizations} and
21576 @code{-ffinite-math-only}.  It is enabled by default when generating code for
21577 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
21578 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
21579 in effect.
21581 @item -mpretend-cmove
21582 @opindex mpretend-cmove
21583 Prefer zero-displacement conditional branches for conditional move instruction
21584 patterns.  This can result in faster code on the SH4 processor.
21586 @end table
21588 @node Solaris 2 Options
21589 @subsection Solaris 2 Options
21590 @cindex Solaris 2 options
21592 These @samp{-m} options are supported on Solaris 2:
21594 @table @gcctabopt
21595 @item -mclear-hwcap
21596 @opindex mclear-hwcap
21597 @option{-mclear-hwcap} tells the compiler to remove the hardware
21598 capabilities generated by the Solaris assembler.  This is only necessary
21599 when object files use ISA extensions not supported by the current
21600 machine, but check at runtime whether or not to use them.
21602 @item -mimpure-text
21603 @opindex mimpure-text
21604 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21605 the compiler to not pass @option{-z text} to the linker when linking a
21606 shared object.  Using this option, you can link position-dependent
21607 code into a shared object.
21609 @option{-mimpure-text} suppresses the ``relocations remain against
21610 allocatable but non-writable sections'' linker error message.
21611 However, the necessary relocations trigger copy-on-write, and the
21612 shared object is not actually shared across processes.  Instead of
21613 using @option{-mimpure-text}, you should compile all source code with
21614 @option{-fpic} or @option{-fPIC}.
21616 @end table
21618 These switches are supported in addition to the above on Solaris 2:
21620 @table @gcctabopt
21621 @item -pthreads
21622 @opindex pthreads
21623 Add support for multithreading using the POSIX threads library.  This
21624 option sets flags for both the preprocessor and linker.  This option does
21625 not affect the thread safety of object code produced  by the compiler or
21626 that of libraries supplied with it.
21628 @item -pthread
21629 @opindex pthread
21630 This is a synonym for @option{-pthreads}.
21631 @end table
21633 @node SPARC Options
21634 @subsection SPARC Options
21635 @cindex SPARC options
21637 These @samp{-m} options are supported on the SPARC:
21639 @table @gcctabopt
21640 @item -mno-app-regs
21641 @itemx -mapp-regs
21642 @opindex mno-app-regs
21643 @opindex mapp-regs
21644 Specify @option{-mapp-regs} to generate output using the global registers
21645 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21646 global register 1, each global register 2 through 4 is then treated as an
21647 allocable register that is clobbered by function calls.  This is the default.
21649 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21650 specify @option{-mno-app-regs}.  You should compile libraries and system
21651 software with this option.
21653 @item -mflat
21654 @itemx -mno-flat
21655 @opindex mflat
21656 @opindex mno-flat
21657 With @option{-mflat}, the compiler does not generate save/restore instructions
21658 and uses a ``flat'' or single register window model.  This model is compatible
21659 with the regular register window model.  The local registers and the input
21660 registers (0--5) are still treated as ``call-saved'' registers and are
21661 saved on the stack as needed.
21663 With @option{-mno-flat} (the default), the compiler generates save/restore
21664 instructions (except for leaf functions).  This is the normal operating mode.
21666 @item -mfpu
21667 @itemx -mhard-float
21668 @opindex mfpu
21669 @opindex mhard-float
21670 Generate output containing floating-point instructions.  This is the
21671 default.
21673 @item -mno-fpu
21674 @itemx -msoft-float
21675 @opindex mno-fpu
21676 @opindex msoft-float
21677 Generate output containing library calls for floating point.
21678 @strong{Warning:} the requisite libraries are not available for all SPARC
21679 targets.  Normally the facilities of the machine's usual C compiler are
21680 used, but this cannot be done directly in cross-compilation.  You must make
21681 your own arrangements to provide suitable library functions for
21682 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21683 @samp{sparclite-*-*} do provide software floating-point support.
21685 @option{-msoft-float} changes the calling convention in the output file;
21686 therefore, it is only useful if you compile @emph{all} of a program with
21687 this option.  In particular, you need to compile @file{libgcc.a}, the
21688 library that comes with GCC, with @option{-msoft-float} in order for
21689 this to work.
21691 @item -mhard-quad-float
21692 @opindex mhard-quad-float
21693 Generate output containing quad-word (long double) floating-point
21694 instructions.
21696 @item -msoft-quad-float
21697 @opindex msoft-quad-float
21698 Generate output containing library calls for quad-word (long double)
21699 floating-point instructions.  The functions called are those specified
21700 in the SPARC ABI@.  This is the default.
21702 As of this writing, there are no SPARC implementations that have hardware
21703 support for the quad-word floating-point instructions.  They all invoke
21704 a trap handler for one of these instructions, and then the trap handler
21705 emulates the effect of the instruction.  Because of the trap handler overhead,
21706 this is much slower than calling the ABI library routines.  Thus the
21707 @option{-msoft-quad-float} option is the default.
21709 @item -mno-unaligned-doubles
21710 @itemx -munaligned-doubles
21711 @opindex mno-unaligned-doubles
21712 @opindex munaligned-doubles
21713 Assume that doubles have 8-byte alignment.  This is the default.
21715 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21716 alignment only if they are contained in another type, or if they have an
21717 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21718 Specifying this option avoids some rare compatibility problems with code
21719 generated by other compilers.  It is not the default because it results
21720 in a performance loss, especially for floating-point code.
21722 @item -muser-mode
21723 @itemx -mno-user-mode
21724 @opindex muser-mode
21725 @opindex mno-user-mode
21726 Do not generate code that can only run in supervisor mode.  This is relevant
21727 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21728 default is @option{-mno-user-mode}.
21730 @item -mno-faster-structs
21731 @itemx -mfaster-structs
21732 @opindex mno-faster-structs
21733 @opindex mfaster-structs
21734 With @option{-mfaster-structs}, the compiler assumes that structures
21735 should have 8-byte alignment.  This enables the use of pairs of
21736 @code{ldd} and @code{std} instructions for copies in structure
21737 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21738 However, the use of this changed alignment directly violates the SPARC
21739 ABI@.  Thus, it's intended only for use on targets where the developer
21740 acknowledges that their resulting code is not directly in line with
21741 the rules of the ABI@.
21743 @item -mcpu=@var{cpu_type}
21744 @opindex mcpu
21745 Set the instruction set, register set, and instruction scheduling parameters
21746 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21747 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21748 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21749 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21750 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21751 @samp{niagara3} and @samp{niagara4}.
21753 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21754 which selects the best architecture option for the host processor.
21755 @option{-mcpu=native} has no effect if GCC does not recognize
21756 the processor.
21758 Default instruction scheduling parameters are used for values that select
21759 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21760 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21762 Here is a list of each supported architecture and their supported
21763 implementations.
21765 @table @asis
21766 @item v7
21767 cypress, leon3v7
21769 @item v8
21770 supersparc, hypersparc, leon, leon3
21772 @item sparclite
21773 f930, f934, sparclite86x
21775 @item sparclet
21776 tsc701
21778 @item v9
21779 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21780 @end table
21782 By default (unless configured otherwise), GCC generates code for the V7
21783 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21784 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21785 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21786 SPARCStation 1, 2, IPX etc.
21788 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21789 architecture.  The only difference from V7 code is that the compiler emits
21790 the integer multiply and integer divide instructions which exist in SPARC-V8
21791 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21792 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21793 2000 series.
21795 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21796 the SPARC architecture.  This adds the integer multiply, integer divide step
21797 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21798 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21799 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21800 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21801 MB86934 chip, which is the more recent SPARClite with FPU@.
21803 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21804 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21805 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21806 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21807 optimizes it for the TEMIC SPARClet chip.
21809 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21810 architecture.  This adds 64-bit integer and floating-point move instructions,
21811 3 additional floating-point condition code registers and conditional move
21812 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21813 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21814 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21815 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21816 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21817 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21818 additionally optimizes it for Sun UltraSPARC T2 chips. With
21819 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21820 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21821 additionally optimizes it for Sun UltraSPARC T4 chips.
21823 @item -mtune=@var{cpu_type}
21824 @opindex mtune
21825 Set the instruction scheduling parameters for machine type
21826 @var{cpu_type}, but do not set the instruction set or register set that the
21827 option @option{-mcpu=@var{cpu_type}} does.
21829 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21830 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21831 that select a particular CPU implementation.  Those are @samp{cypress},
21832 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21833 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21834 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21835 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21836 toolchains, @samp{native} can also be used.
21838 @item -mv8plus
21839 @itemx -mno-v8plus
21840 @opindex mv8plus
21841 @opindex mno-v8plus
21842 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21843 difference from the V8 ABI is that the global and out registers are
21844 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21845 mode for all SPARC-V9 processors.
21847 @item -mvis
21848 @itemx -mno-vis
21849 @opindex mvis
21850 @opindex mno-vis
21851 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21852 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21854 @item -mvis2
21855 @itemx -mno-vis2
21856 @opindex mvis2
21857 @opindex mno-vis2
21858 With @option{-mvis2}, GCC generates code that takes advantage of
21859 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21860 default is @option{-mvis2} when targeting a cpu that supports such
21861 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21862 also sets @option{-mvis}.
21864 @item -mvis3
21865 @itemx -mno-vis3
21866 @opindex mvis3
21867 @opindex mno-vis3
21868 With @option{-mvis3}, GCC generates code that takes advantage of
21869 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21870 default is @option{-mvis3} when targeting a cpu that supports such
21871 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21872 also sets @option{-mvis2} and @option{-mvis}.
21874 @item -mcbcond
21875 @itemx -mno-cbcond
21876 @opindex mcbcond
21877 @opindex mno-cbcond
21878 With @option{-mcbcond}, GCC generates code that takes advantage of
21879 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21880 The default is @option{-mcbcond} when targeting a cpu that supports such
21881 instructions, such as niagara-4 and later.
21883 @item -mpopc
21884 @itemx -mno-popc
21885 @opindex mpopc
21886 @opindex mno-popc
21887 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21888 population count instruction.  The default is @option{-mpopc}
21889 when targeting a cpu that supports such instructions, such as Niagara-2 and
21890 later.
21892 @item -mfmaf
21893 @itemx -mno-fmaf
21894 @opindex mfmaf
21895 @opindex mno-fmaf
21896 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21897 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21898 when targeting a cpu that supports such instructions, such as Niagara-3 and
21899 later.
21901 @item -mfix-at697f
21902 @opindex mfix-at697f
21903 Enable the documented workaround for the single erratum of the Atmel AT697F
21904 processor (which corresponds to erratum #13 of the AT697E processor).
21906 @item -mfix-ut699
21907 @opindex mfix-ut699
21908 Enable the documented workarounds for the floating-point errata and the data
21909 cache nullify errata of the UT699 processor.
21910 @end table
21912 These @samp{-m} options are supported in addition to the above
21913 on SPARC-V9 processors in 64-bit environments:
21915 @table @gcctabopt
21916 @item -m32
21917 @itemx -m64
21918 @opindex m32
21919 @opindex m64
21920 Generate code for a 32-bit or 64-bit environment.
21921 The 32-bit environment sets int, long and pointer to 32 bits.
21922 The 64-bit environment sets int to 32 bits and long and pointer
21923 to 64 bits.
21925 @item -mcmodel=@var{which}
21926 @opindex mcmodel
21927 Set the code model to one of
21929 @table @samp
21930 @item medlow
21931 The Medium/Low code model: 64-bit addresses, programs
21932 must be linked in the low 32 bits of memory.  Programs can be statically
21933 or dynamically linked.
21935 @item medmid
21936 The Medium/Middle code model: 64-bit addresses, programs
21937 must be linked in the low 44 bits of memory, the text and data segments must
21938 be less than 2GB in size and the data segment must be located within 2GB of
21939 the text segment.
21941 @item medany
21942 The Medium/Anywhere code model: 64-bit addresses, programs
21943 may be linked anywhere in memory, the text and data segments must be less
21944 than 2GB in size and the data segment must be located within 2GB of the
21945 text segment.
21947 @item embmedany
21948 The Medium/Anywhere code model for embedded systems:
21949 64-bit addresses, the text and data segments must be less than 2GB in
21950 size, both starting anywhere in memory (determined at link time).  The
21951 global register %g4 points to the base of the data segment.  Programs
21952 are statically linked and PIC is not supported.
21953 @end table
21955 @item -mmemory-model=@var{mem-model}
21956 @opindex mmemory-model
21957 Set the memory model in force on the processor to one of
21959 @table @samp
21960 @item default
21961 The default memory model for the processor and operating system.
21963 @item rmo
21964 Relaxed Memory Order
21966 @item pso
21967 Partial Store Order
21969 @item tso
21970 Total Store Order
21972 @item sc
21973 Sequential Consistency
21974 @end table
21976 These memory models are formally defined in Appendix D of the Sparc V9
21977 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21979 @item -mstack-bias
21980 @itemx -mno-stack-bias
21981 @opindex mstack-bias
21982 @opindex mno-stack-bias
21983 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21984 frame pointer if present, are offset by @minus{}2047 which must be added back
21985 when making stack frame references.  This is the default in 64-bit mode.
21986 Otherwise, assume no such offset is present.
21987 @end table
21989 @node SPU Options
21990 @subsection SPU Options
21991 @cindex SPU options
21993 These @samp{-m} options are supported on the SPU:
21995 @table @gcctabopt
21996 @item -mwarn-reloc
21997 @itemx -merror-reloc
21998 @opindex mwarn-reloc
21999 @opindex merror-reloc
22001 The loader for SPU does not handle dynamic relocations.  By default, GCC
22002 gives an error when it generates code that requires a dynamic
22003 relocation.  @option{-mno-error-reloc} disables the error,
22004 @option{-mwarn-reloc} generates a warning instead.
22006 @item -msafe-dma
22007 @itemx -munsafe-dma
22008 @opindex msafe-dma
22009 @opindex munsafe-dma
22011 Instructions that initiate or test completion of DMA must not be
22012 reordered with respect to loads and stores of the memory that is being
22013 accessed.
22014 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
22015 memory accesses, but that can lead to inefficient code in places where the
22016 memory is known to not change.  Rather than mark the memory as volatile,
22017 you can use @option{-msafe-dma} to tell the compiler to treat
22018 the DMA instructions as potentially affecting all memory.  
22020 @item -mbranch-hints
22021 @opindex mbranch-hints
22023 By default, GCC generates a branch hint instruction to avoid
22024 pipeline stalls for always-taken or probably-taken branches.  A hint
22025 is not generated closer than 8 instructions away from its branch.
22026 There is little reason to disable them, except for debugging purposes,
22027 or to make an object a little bit smaller.
22029 @item -msmall-mem
22030 @itemx -mlarge-mem
22031 @opindex msmall-mem
22032 @opindex mlarge-mem
22034 By default, GCC generates code assuming that addresses are never larger
22035 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
22036 a full 32-bit address.
22038 @item -mstdmain
22039 @opindex mstdmain
22041 By default, GCC links against startup code that assumes the SPU-style
22042 main function interface (which has an unconventional parameter list).
22043 With @option{-mstdmain}, GCC links your program against startup
22044 code that assumes a C99-style interface to @code{main}, including a
22045 local copy of @code{argv} strings.
22047 @item -mfixed-range=@var{register-range}
22048 @opindex mfixed-range
22049 Generate code treating the given register range as fixed registers.
22050 A fixed register is one that the register allocator cannot use.  This is
22051 useful when compiling kernel code.  A register range is specified as
22052 two registers separated by a dash.  Multiple register ranges can be
22053 specified separated by a comma.
22055 @item -mea32
22056 @itemx -mea64
22057 @opindex mea32
22058 @opindex mea64
22059 Compile code assuming that pointers to the PPU address space accessed
22060 via the @code{__ea} named address space qualifier are either 32 or 64
22061 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
22062 all object code in an executable must be compiled with the same setting.
22064 @item -maddress-space-conversion
22065 @itemx -mno-address-space-conversion
22066 @opindex maddress-space-conversion
22067 @opindex mno-address-space-conversion
22068 Allow/disallow treating the @code{__ea} address space as superset
22069 of the generic address space.  This enables explicit type casts
22070 between @code{__ea} and generic pointer as well as implicit
22071 conversions of generic pointers to @code{__ea} pointers.  The
22072 default is to allow address space pointer conversions.
22074 @item -mcache-size=@var{cache-size}
22075 @opindex mcache-size
22076 This option controls the version of libgcc that the compiler links to an
22077 executable and selects a software-managed cache for accessing variables
22078 in the @code{__ea} address space with a particular cache size.  Possible
22079 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
22080 and @samp{128}.  The default cache size is 64KB.
22082 @item -matomic-updates
22083 @itemx -mno-atomic-updates
22084 @opindex matomic-updates
22085 @opindex mno-atomic-updates
22086 This option controls the version of libgcc that the compiler links to an
22087 executable and selects whether atomic updates to the software-managed
22088 cache of PPU-side variables are used.  If you use atomic updates, changes
22089 to a PPU variable from SPU code using the @code{__ea} named address space
22090 qualifier do not interfere with changes to other PPU variables residing
22091 in the same cache line from PPU code.  If you do not use atomic updates,
22092 such interference may occur; however, writing back cache lines is
22093 more efficient.  The default behavior is to use atomic updates.
22095 @item -mdual-nops
22096 @itemx -mdual-nops=@var{n}
22097 @opindex mdual-nops
22098 By default, GCC inserts nops to increase dual issue when it expects
22099 it to increase performance.  @var{n} can be a value from 0 to 10.  A
22100 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
22101 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
22103 @item -mhint-max-nops=@var{n}
22104 @opindex mhint-max-nops
22105 Maximum number of nops to insert for a branch hint.  A branch hint must
22106 be at least 8 instructions away from the branch it is affecting.  GCC
22107 inserts up to @var{n} nops to enforce this, otherwise it does not
22108 generate the branch hint.
22110 @item -mhint-max-distance=@var{n}
22111 @opindex mhint-max-distance
22112 The encoding of the branch hint instruction limits the hint to be within
22113 256 instructions of the branch it is affecting.  By default, GCC makes
22114 sure it is within 125.
22116 @item -msafe-hints
22117 @opindex msafe-hints
22118 Work around a hardware bug that causes the SPU to stall indefinitely.
22119 By default, GCC inserts the @code{hbrp} instruction to make sure
22120 this stall won't happen.
22122 @end table
22124 @node System V Options
22125 @subsection Options for System V
22127 These additional options are available on System V Release 4 for
22128 compatibility with other compilers on those systems:
22130 @table @gcctabopt
22131 @item -G
22132 @opindex G
22133 Create a shared object.
22134 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
22136 @item -Qy
22137 @opindex Qy
22138 Identify the versions of each tool used by the compiler, in a
22139 @code{.ident} assembler directive in the output.
22141 @item -Qn
22142 @opindex Qn
22143 Refrain from adding @code{.ident} directives to the output file (this is
22144 the default).
22146 @item -YP,@var{dirs}
22147 @opindex YP
22148 Search the directories @var{dirs}, and no others, for libraries
22149 specified with @option{-l}.
22151 @item -Ym,@var{dir}
22152 @opindex Ym
22153 Look in the directory @var{dir} to find the M4 preprocessor.
22154 The assembler uses this option.
22155 @c This is supposed to go with a -Yd for predefined M4 macro files, but
22156 @c the generic assembler that comes with Solaris takes just -Ym.
22157 @end table
22159 @node TILE-Gx Options
22160 @subsection TILE-Gx Options
22161 @cindex TILE-Gx options
22163 These @samp{-m} options are supported on the TILE-Gx:
22165 @table @gcctabopt
22166 @item -mcmodel=small
22167 @opindex mcmodel=small
22168 Generate code for the small model.  The distance for direct calls is
22169 limited to 500M in either direction.  PC-relative addresses are 32
22170 bits.  Absolute addresses support the full address range.
22172 @item -mcmodel=large
22173 @opindex mcmodel=large
22174 Generate code for the large model.  There is no limitation on call
22175 distance, pc-relative addresses, or absolute addresses.
22177 @item -mcpu=@var{name}
22178 @opindex mcpu
22179 Selects the type of CPU to be targeted.  Currently the only supported
22180 type is @samp{tilegx}.
22182 @item -m32
22183 @itemx -m64
22184 @opindex m32
22185 @opindex m64
22186 Generate code for a 32-bit or 64-bit environment.  The 32-bit
22187 environment sets int, long, and pointer to 32 bits.  The 64-bit
22188 environment sets int to 32 bits and long and pointer to 64 bits.
22190 @item -mbig-endian
22191 @itemx -mlittle-endian
22192 @opindex mbig-endian
22193 @opindex mlittle-endian
22194 Generate code in big/little endian mode, respectively.
22195 @end table
22197 @node TILEPro Options
22198 @subsection TILEPro Options
22199 @cindex TILEPro options
22201 These @samp{-m} options are supported on the TILEPro:
22203 @table @gcctabopt
22204 @item -mcpu=@var{name}
22205 @opindex mcpu
22206 Selects the type of CPU to be targeted.  Currently the only supported
22207 type is @samp{tilepro}.
22209 @item -m32
22210 @opindex m32
22211 Generate code for a 32-bit environment, which sets int, long, and
22212 pointer to 32 bits.  This is the only supported behavior so the flag
22213 is essentially ignored.
22214 @end table
22216 @node V850 Options
22217 @subsection V850 Options
22218 @cindex V850 Options
22220 These @samp{-m} options are defined for V850 implementations:
22222 @table @gcctabopt
22223 @item -mlong-calls
22224 @itemx -mno-long-calls
22225 @opindex mlong-calls
22226 @opindex mno-long-calls
22227 Treat all calls as being far away (near).  If calls are assumed to be
22228 far away, the compiler always loads the function's address into a
22229 register, and calls indirect through the pointer.
22231 @item -mno-ep
22232 @itemx -mep
22233 @opindex mno-ep
22234 @opindex mep
22235 Do not optimize (do optimize) basic blocks that use the same index
22236 pointer 4 or more times to copy pointer into the @code{ep} register, and
22237 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
22238 option is on by default if you optimize.
22240 @item -mno-prolog-function
22241 @itemx -mprolog-function
22242 @opindex mno-prolog-function
22243 @opindex mprolog-function
22244 Do not use (do use) external functions to save and restore registers
22245 at the prologue and epilogue of a function.  The external functions
22246 are slower, but use less code space if more than one function saves
22247 the same number of registers.  The @option{-mprolog-function} option
22248 is on by default if you optimize.
22250 @item -mspace
22251 @opindex mspace
22252 Try to make the code as small as possible.  At present, this just turns
22253 on the @option{-mep} and @option{-mprolog-function} options.
22255 @item -mtda=@var{n}
22256 @opindex mtda
22257 Put static or global variables whose size is @var{n} bytes or less into
22258 the tiny data area that register @code{ep} points to.  The tiny data
22259 area can hold up to 256 bytes in total (128 bytes for byte references).
22261 @item -msda=@var{n}
22262 @opindex msda
22263 Put static or global variables whose size is @var{n} bytes or less into
22264 the small data area that register @code{gp} points to.  The small data
22265 area can hold up to 64 kilobytes.
22267 @item -mzda=@var{n}
22268 @opindex mzda
22269 Put static or global variables whose size is @var{n} bytes or less into
22270 the first 32 kilobytes of memory.
22272 @item -mv850
22273 @opindex mv850
22274 Specify that the target processor is the V850.
22276 @item -mv850e3v5
22277 @opindex mv850e3v5
22278 Specify that the target processor is the V850E3V5.  The preprocessor
22279 constant @samp{__v850e3v5__} is defined if this option is used.
22281 @item -mv850e2v4
22282 @opindex mv850e2v4
22283 Specify that the target processor is the V850E3V5.  This is an alias for
22284 the @option{-mv850e3v5} option.
22286 @item -mv850e2v3
22287 @opindex mv850e2v3
22288 Specify that the target processor is the V850E2V3.  The preprocessor
22289 constant @samp{__v850e2v3__} is defined if this option is used.
22291 @item -mv850e2
22292 @opindex mv850e2
22293 Specify that the target processor is the V850E2.  The preprocessor
22294 constant @samp{__v850e2__} is defined if this option is used.
22296 @item -mv850e1
22297 @opindex mv850e1
22298 Specify that the target processor is the V850E1.  The preprocessor
22299 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
22300 this option is used.
22302 @item -mv850es
22303 @opindex mv850es
22304 Specify that the target processor is the V850ES.  This is an alias for
22305 the @option{-mv850e1} option.
22307 @item -mv850e
22308 @opindex mv850e
22309 Specify that the target processor is the V850E@.  The preprocessor
22310 constant @samp{__v850e__} is defined if this option is used.
22312 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22313 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22314 are defined then a default target processor is chosen and the
22315 relevant @samp{__v850*__} preprocessor constant is defined.
22317 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
22318 defined, regardless of which processor variant is the target.
22320 @item -mdisable-callt
22321 @itemx -mno-disable-callt
22322 @opindex mdisable-callt
22323 @opindex mno-disable-callt
22324 This option suppresses generation of the @code{CALLT} instruction for the
22325 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22326 architecture.
22328 This option is enabled by default when the RH850 ABI is
22329 in use (see @option{-mrh850-abi}), and disabled by default when the
22330 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22331 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
22333 @item -mrelax
22334 @itemx -mno-relax
22335 @opindex mrelax
22336 @opindex mno-relax
22337 Pass on (or do not pass on) the @option{-mrelax} command line option
22338 to the assembler.
22340 @item -mlong-jumps
22341 @itemx -mno-long-jumps
22342 @opindex mlong-jumps
22343 @opindex mno-long-jumps
22344 Disable (or re-enable) the generation of PC-relative jump instructions.
22346 @item -msoft-float
22347 @itemx -mhard-float
22348 @opindex msoft-float
22349 @opindex mhard-float
22350 Disable (or re-enable) the generation of hardware floating point
22351 instructions.  This option is only significant when the target
22352 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22353 instructions are being generated then the C preprocessor symbol
22354 @code{__FPU_OK__} will be defined, otherwise the symbol
22355 @code{__NO_FPU__} will be defined.
22357 @item -mloop
22358 @opindex mloop
22359 Enables the use of the e3v5 LOOP instruction.  The use of this
22360 instruction is not enabled by default when the e3v5 architecture is
22361 selected because its use is still experimental.
22363 @item -mrh850-abi
22364 @itemx -mghs
22365 @opindex mrh850-abi
22366 @opindex mghs
22367 Enables support for the RH850 version of the V850 ABI.  This is the
22368 default.  With this version of the ABI the following rules apply:
22370 @itemize
22371 @item
22372 Integer sized structures and unions are returned via a memory pointer
22373 rather than a register.
22375 @item
22376 Large structures and unions (more than 8 bytes in size) are passed by
22377 value.
22379 @item
22380 Functions are aligned to 16-bit boundaries.
22382 @item
22383 The @option{-m8byte-align} command line option is supported.
22385 @item
22386 The @option{-mdisable-callt} command line option is enabled by
22387 default.  The @option{-mno-disable-callt} command line option is not
22388 supported.
22389 @end itemize
22391 When this version of the ABI is enabled the C preprocessor symbol
22392 @code{__V850_RH850_ABI__} is defined.
22394 @item -mgcc-abi
22395 @opindex mgcc-abi
22396 Enables support for the old GCC version of the V850 ABI.  With this
22397 version of the ABI the following rules apply:
22399 @itemize
22400 @item
22401 Integer sized structures and unions are returned in register @code{r10}.
22403 @item
22404 Large structures and unions (more than 8 bytes in size) are passed by
22405 reference.
22407 @item
22408 Functions are aligned to 32-bit boundaries, unless optimizing for
22409 size.
22411 @item
22412 The @option{-m8byte-align} command line option is not supported.
22414 @item
22415 The @option{-mdisable-callt} command line option is supported but not
22416 enabled by default.
22417 @end itemize
22419 When this version of the ABI is enabled the C preprocessor symbol
22420 @code{__V850_GCC_ABI__} is defined.
22422 @item -m8byte-align
22423 @itemx -mno-8byte-align
22424 @opindex m8byte-align
22425 @opindex mno-8byte-align
22426 Enables support for @code{doubles} and @code{long long} types to be
22427 aligned on 8-byte boundaries.  The default is to restrict the
22428 alignment of all objects to at most 4-bytes.  When
22429 @option{-m8byte-align} is in effect the C preprocessor symbol
22430 @code{__V850_8BYTE_ALIGN__} will be defined.
22432 @item -mbig-switch
22433 @opindex mbig-switch
22434 Generate code suitable for big switch tables.  Use this option only if
22435 the assembler/linker complain about out of range branches within a switch
22436 table.
22438 @item -mapp-regs
22439 @opindex mapp-regs
22440 This option causes r2 and r5 to be used in the code generated by
22441 the compiler.  This setting is the default.
22443 @item -mno-app-regs
22444 @opindex mno-app-regs
22445 This option causes r2 and r5 to be treated as fixed registers.
22447 @end table
22449 @node VAX Options
22450 @subsection VAX Options
22451 @cindex VAX options
22453 These @samp{-m} options are defined for the VAX:
22455 @table @gcctabopt
22456 @item -munix
22457 @opindex munix
22458 Do not output certain jump instructions (@code{aobleq} and so on)
22459 that the Unix assembler for the VAX cannot handle across long
22460 ranges.
22462 @item -mgnu
22463 @opindex mgnu
22464 Do output those jump instructions, on the assumption that the
22465 GNU assembler is being used.
22467 @item -mg
22468 @opindex mg
22469 Output code for G-format floating-point numbers instead of D-format.
22470 @end table
22472 @node VMS Options
22473 @subsection VMS Options
22475 These @samp{-m} options are defined for the VMS implementations:
22477 @table @gcctabopt
22478 @item -mvms-return-codes
22479 @opindex mvms-return-codes
22480 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22481 condition (e.g.@ error) codes.
22483 @item -mdebug-main=@var{prefix}
22484 @opindex mdebug-main=@var{prefix}
22485 Flag the first routine whose name starts with @var{prefix} as the main
22486 routine for the debugger.
22488 @item -mmalloc64
22489 @opindex mmalloc64
22490 Default to 64-bit memory allocation routines.
22492 @item -mpointer-size=@var{size}
22493 @opindex -mpointer-size=@var{size}
22494 Set the default size of pointers. Possible options for @var{size} are
22495 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22496 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22497 The later option disables @code{pragma pointer_size}.
22498 @end table
22500 @node VxWorks Options
22501 @subsection VxWorks Options
22502 @cindex VxWorks Options
22504 The options in this section are defined for all VxWorks targets.
22505 Options specific to the target hardware are listed with the other
22506 options for that target.
22508 @table @gcctabopt
22509 @item -mrtp
22510 @opindex mrtp
22511 GCC can generate code for both VxWorks kernels and real time processes
22512 (RTPs).  This option switches from the former to the latter.  It also
22513 defines the preprocessor macro @code{__RTP__}.
22515 @item -non-static
22516 @opindex non-static
22517 Link an RTP executable against shared libraries rather than static
22518 libraries.  The options @option{-static} and @option{-shared} can
22519 also be used for RTPs (@pxref{Link Options}); @option{-static}
22520 is the default.
22522 @item -Bstatic
22523 @itemx -Bdynamic
22524 @opindex Bstatic
22525 @opindex Bdynamic
22526 These options are passed down to the linker.  They are defined for
22527 compatibility with Diab.
22529 @item -Xbind-lazy
22530 @opindex Xbind-lazy
22531 Enable lazy binding of function calls.  This option is equivalent to
22532 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22534 @item -Xbind-now
22535 @opindex Xbind-now
22536 Disable lazy binding of function calls.  This option is the default and
22537 is defined for compatibility with Diab.
22538 @end table
22540 @node x86-64 Options
22541 @subsection x86-64 Options
22542 @cindex x86-64 options
22544 These are listed under @xref{i386 and x86-64 Options}.
22546 @node Xstormy16 Options
22547 @subsection Xstormy16 Options
22548 @cindex Xstormy16 Options
22550 These options are defined for Xstormy16:
22552 @table @gcctabopt
22553 @item -msim
22554 @opindex msim
22555 Choose startup files and linker script suitable for the simulator.
22556 @end table
22558 @node Xtensa Options
22559 @subsection Xtensa Options
22560 @cindex Xtensa Options
22562 These options are supported for Xtensa targets:
22564 @table @gcctabopt
22565 @item -mconst16
22566 @itemx -mno-const16
22567 @opindex mconst16
22568 @opindex mno-const16
22569 Enable or disable use of @code{CONST16} instructions for loading
22570 constant values.  The @code{CONST16} instruction is currently not a
22571 standard option from Tensilica.  When enabled, @code{CONST16}
22572 instructions are always used in place of the standard @code{L32R}
22573 instructions.  The use of @code{CONST16} is enabled by default only if
22574 the @code{L32R} instruction is not available.
22576 @item -mfused-madd
22577 @itemx -mno-fused-madd
22578 @opindex mfused-madd
22579 @opindex mno-fused-madd
22580 Enable or disable use of fused multiply/add and multiply/subtract
22581 instructions in the floating-point option.  This has no effect if the
22582 floating-point option is not also enabled.  Disabling fused multiply/add
22583 and multiply/subtract instructions forces the compiler to use separate
22584 instructions for the multiply and add/subtract operations.  This may be
22585 desirable in some cases where strict IEEE 754-compliant results are
22586 required: the fused multiply add/subtract instructions do not round the
22587 intermediate result, thereby producing results with @emph{more} bits of
22588 precision than specified by the IEEE standard.  Disabling fused multiply
22589 add/subtract instructions also ensures that the program output is not
22590 sensitive to the compiler's ability to combine multiply and add/subtract
22591 operations.
22593 @item -mserialize-volatile
22594 @itemx -mno-serialize-volatile
22595 @opindex mserialize-volatile
22596 @opindex mno-serialize-volatile
22597 When this option is enabled, GCC inserts @code{MEMW} instructions before
22598 @code{volatile} memory references to guarantee sequential consistency.
22599 The default is @option{-mserialize-volatile}.  Use
22600 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22602 @item -mforce-no-pic
22603 @opindex mforce-no-pic
22604 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22605 position-independent code (PIC), this option disables PIC for compiling
22606 kernel code.
22608 @item -mtext-section-literals
22609 @itemx -mno-text-section-literals
22610 @opindex mtext-section-literals
22611 @opindex mno-text-section-literals
22612 Control the treatment of literal pools.  The default is
22613 @option{-mno-text-section-literals}, which places literals in a separate
22614 section in the output file.  This allows the literal pool to be placed
22615 in a data RAM/ROM, and it also allows the linker to combine literal
22616 pools from separate object files to remove redundant literals and
22617 improve code size.  With @option{-mtext-section-literals}, the literals
22618 are interspersed in the text section in order to keep them as close as
22619 possible to their references.  This may be necessary for large assembly
22620 files.
22622 @item -mtarget-align
22623 @itemx -mno-target-align
22624 @opindex mtarget-align
22625 @opindex mno-target-align
22626 When this option is enabled, GCC instructs the assembler to
22627 automatically align instructions to reduce branch penalties at the
22628 expense of some code density.  The assembler attempts to widen density
22629 instructions to align branch targets and the instructions following call
22630 instructions.  If there are not enough preceding safe density
22631 instructions to align a target, no widening is performed.  The
22632 default is @option{-mtarget-align}.  These options do not affect the
22633 treatment of auto-aligned instructions like @code{LOOP}, which the
22634 assembler always aligns, either by widening density instructions or
22635 by inserting NOP instructions.
22637 @item -mlongcalls
22638 @itemx -mno-longcalls
22639 @opindex mlongcalls
22640 @opindex mno-longcalls
22641 When this option is enabled, GCC instructs the assembler to translate
22642 direct calls to indirect calls unless it can determine that the target
22643 of a direct call is in the range allowed by the call instruction.  This
22644 translation typically occurs for calls to functions in other source
22645 files.  Specifically, the assembler translates a direct @code{CALL}
22646 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22647 The default is @option{-mno-longcalls}.  This option should be used in
22648 programs where the call target can potentially be out of range.  This
22649 option is implemented in the assembler, not the compiler, so the
22650 assembly code generated by GCC still shows direct call
22651 instructions---look at the disassembled object code to see the actual
22652 instructions.  Note that the assembler uses an indirect call for
22653 every cross-file call, not just those that really are out of range.
22654 @end table
22656 @node zSeries Options
22657 @subsection zSeries Options
22658 @cindex zSeries options
22660 These are listed under @xref{S/390 and zSeries Options}.
22662 @node Code Gen Options
22663 @section Options for Code Generation Conventions
22664 @cindex code generation conventions
22665 @cindex options, code generation
22666 @cindex run-time options
22668 These machine-independent options control the interface conventions
22669 used in code generation.
22671 Most of them have both positive and negative forms; the negative form
22672 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22673 one of the forms is listed---the one that is not the default.  You
22674 can figure out the other form by either removing @samp{no-} or adding
22677 @table @gcctabopt
22678 @item -fbounds-check
22679 @opindex fbounds-check
22680 For front ends that support it, generate additional code to check that
22681 indices used to access arrays are within the declared range.  This is
22682 currently only supported by the Java and Fortran front ends, where
22683 this option defaults to true and false respectively.
22685 @item -fstack-reuse=@var{reuse-level}
22686 @opindex fstack_reuse
22687 This option controls stack space reuse for user declared local/auto variables
22688 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22689 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22690 local variables and temporaries, @samp{named_vars} enables the reuse only for
22691 user defined local variables with names, and @samp{none} disables stack reuse
22692 completely. The default value is @samp{all}. The option is needed when the
22693 program extends the lifetime of a scoped local variable or a compiler generated
22694 temporary beyond the end point defined by the language.  When a lifetime of
22695 a variable ends, and if the variable lives in memory, the optimizing compiler
22696 has the freedom to reuse its stack space with other temporaries or scoped
22697 local variables whose live range does not overlap with it. Legacy code extending
22698 local lifetime will likely to break with the stack reuse optimization.
22700 For example,
22702 @smallexample
22703    int *p;
22704    @{
22705      int local1;
22707      p = &local1;
22708      local1 = 10;
22709      ....
22710    @}
22711    @{
22712       int local2;
22713       local2 = 20;
22714       ...
22715    @}
22717    if (*p == 10)  // out of scope use of local1
22718      @{
22720      @}
22721 @end smallexample
22723 Another example:
22724 @smallexample
22726    struct A
22727    @{
22728        A(int k) : i(k), j(k) @{ @}
22729        int i;
22730        int j;
22731    @};
22733    A *ap;
22735    void foo(const A& ar)
22736    @{
22737       ap = &ar;
22738    @}
22740    void bar()
22741    @{
22742       foo(A(10)); // temp object's lifetime ends when foo returns
22744       @{
22745         A a(20);
22746         ....
22747       @}
22748       ap->i+= 10;  // ap references out of scope temp whose space
22749                    // is reused with a. What is the value of ap->i?
22750    @}
22752 @end smallexample
22754 The lifetime of a compiler generated temporary is well defined by the C++
22755 standard. When a lifetime of a temporary ends, and if the temporary lives
22756 in memory, the optimizing compiler has the freedom to reuse its stack
22757 space with other temporaries or scoped local variables whose live range
22758 does not overlap with it. However some of the legacy code relies on
22759 the behavior of older compilers in which temporaries' stack space is
22760 not reused, the aggressive stack reuse can lead to runtime errors. This
22761 option is used to control the temporary stack reuse optimization.
22763 @item -ftrapv
22764 @opindex ftrapv
22765 This option generates traps for signed overflow on addition, subtraction,
22766 multiplication operations.
22768 @item -fwrapv
22769 @opindex fwrapv
22770 This option instructs the compiler to assume that signed arithmetic
22771 overflow of addition, subtraction and multiplication wraps around
22772 using twos-complement representation.  This flag enables some optimizations
22773 and disables others.  This option is enabled by default for the Java
22774 front end, as required by the Java language specification.
22776 @item -fexceptions
22777 @opindex fexceptions
22778 Enable exception handling.  Generates extra code needed to propagate
22779 exceptions.  For some targets, this implies GCC generates frame
22780 unwind information for all functions, which can produce significant data
22781 size overhead, although it does not affect execution.  If you do not
22782 specify this option, GCC enables it by default for languages like
22783 C++ that normally require exception handling, and disables it for
22784 languages like C that do not normally require it.  However, you may need
22785 to enable this option when compiling C code that needs to interoperate
22786 properly with exception handlers written in C++.  You may also wish to
22787 disable this option if you are compiling older C++ programs that don't
22788 use exception handling.
22790 @item -fnon-call-exceptions
22791 @opindex fnon-call-exceptions
22792 Generate code that allows trapping instructions to throw exceptions.
22793 Note that this requires platform-specific runtime support that does
22794 not exist everywhere.  Moreover, it only allows @emph{trapping}
22795 instructions to throw exceptions, i.e.@: memory references or floating-point
22796 instructions.  It does not allow exceptions to be thrown from
22797 arbitrary signal handlers such as @code{SIGALRM}.
22799 @item -fdelete-dead-exceptions
22800 @opindex fdelete-dead-exceptions
22801 Consider that instructions that may throw exceptions but don't otherwise
22802 contribute to the execution of the program can be optimized away.
22803 This option is enabled by default for the Ada front end, as permitted by
22804 the Ada language specification.
22805 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22807 @item -funwind-tables
22808 @opindex funwind-tables
22809 Similar to @option{-fexceptions}, except that it just generates any needed
22810 static data, but does not affect the generated code in any other way.
22811 You normally do not need to enable this option; instead, a language processor
22812 that needs this handling enables it on your behalf.
22814 @item -fasynchronous-unwind-tables
22815 @opindex fasynchronous-unwind-tables
22816 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22817 table is exact at each instruction boundary, so it can be used for stack
22818 unwinding from asynchronous events (such as debugger or garbage collector).
22820 @item -fno-gnu-unique
22821 @opindex fno-gnu-unique
22822 On systems with recent GNU assembler and C library, the C++ compiler
22823 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22824 of template static data members and static local variables in inline
22825 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22826 is necessary to avoid problems with a library used by two different
22827 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22828 therefore disagreeing with the other one about the binding of the
22829 symbol.  But this causes @code{dlclose} to be ignored for affected
22830 DSOs; if your program relies on reinitialization of a DSO via
22831 @code{dlclose} and @code{dlopen}, you can use
22832 @option{-fno-gnu-unique}.
22834 @item -fpcc-struct-return
22835 @opindex fpcc-struct-return
22836 Return ``short'' @code{struct} and @code{union} values in memory like
22837 longer ones, rather than in registers.  This convention is less
22838 efficient, but it has the advantage of allowing intercallability between
22839 GCC-compiled files and files compiled with other compilers, particularly
22840 the Portable C Compiler (pcc).
22842 The precise convention for returning structures in memory depends
22843 on the target configuration macros.
22845 Short structures and unions are those whose size and alignment match
22846 that of some integer type.
22848 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22849 switch is not binary compatible with code compiled with the
22850 @option{-freg-struct-return} switch.
22851 Use it to conform to a non-default application binary interface.
22853 @item -freg-struct-return
22854 @opindex freg-struct-return
22855 Return @code{struct} and @code{union} values in registers when possible.
22856 This is more efficient for small structures than
22857 @option{-fpcc-struct-return}.
22859 If you specify neither @option{-fpcc-struct-return} nor
22860 @option{-freg-struct-return}, GCC defaults to whichever convention is
22861 standard for the target.  If there is no standard convention, GCC
22862 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22863 the principal compiler.  In those cases, we can choose the standard, and
22864 we chose the more efficient register return alternative.
22866 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22867 switch is not binary compatible with code compiled with the
22868 @option{-fpcc-struct-return} switch.
22869 Use it to conform to a non-default application binary interface.
22871 @item -fshort-enums
22872 @opindex fshort-enums
22873 Allocate to an @code{enum} type only as many bytes as it needs for the
22874 declared range of possible values.  Specifically, the @code{enum} type
22875 is equivalent to the smallest integer type that has enough room.
22877 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22878 code that is not binary compatible with code generated without that switch.
22879 Use it to conform to a non-default application binary interface.
22881 @item -fshort-double
22882 @opindex fshort-double
22883 Use the same size for @code{double} as for @code{float}.
22885 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22886 code that is not binary compatible with code generated without that switch.
22887 Use it to conform to a non-default application binary interface.
22889 @item -fshort-wchar
22890 @opindex fshort-wchar
22891 Override the underlying type for @samp{wchar_t} to be @samp{short
22892 unsigned int} instead of the default for the target.  This option is
22893 useful for building programs to run under WINE@.
22895 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22896 code that is not binary compatible with code generated without that switch.
22897 Use it to conform to a non-default application binary interface.
22899 @item -fno-common
22900 @opindex fno-common
22901 In C code, controls the placement of uninitialized global variables.
22902 Unix C compilers have traditionally permitted multiple definitions of
22903 such variables in different compilation units by placing the variables
22904 in a common block.
22905 This is the behavior specified by @option{-fcommon}, and is the default
22906 for GCC on most targets.
22907 On the other hand, this behavior is not required by ISO C, and on some
22908 targets may carry a speed or code size penalty on variable references.
22909 The @option{-fno-common} option specifies that the compiler should place
22910 uninitialized global variables in the data section of the object file,
22911 rather than generating them as common blocks.
22912 This has the effect that if the same variable is declared
22913 (without @code{extern}) in two different compilations,
22914 you get a multiple-definition error when you link them.
22915 In this case, you must compile with @option{-fcommon} instead.
22916 Compiling with @option{-fno-common} is useful on targets for which
22917 it provides better performance, or if you wish to verify that the
22918 program will work on other systems that always treat uninitialized
22919 variable declarations this way.
22921 @item -fno-ident
22922 @opindex fno-ident
22923 Ignore the @samp{#ident} directive.
22925 @item -finhibit-size-directive
22926 @opindex finhibit-size-directive
22927 Don't output a @code{.size} assembler directive, or anything else that
22928 would cause trouble if the function is split in the middle, and the
22929 two halves are placed at locations far apart in memory.  This option is
22930 used when compiling @file{crtstuff.c}; you should not need to use it
22931 for anything else.
22933 @item -fverbose-asm
22934 @opindex fverbose-asm
22935 Put extra commentary information in the generated assembly code to
22936 make it more readable.  This option is generally only of use to those
22937 who actually need to read the generated assembly code (perhaps while
22938 debugging the compiler itself).
22940 @option{-fno-verbose-asm}, the default, causes the
22941 extra information to be omitted and is useful when comparing two assembler
22942 files.
22944 @item -frecord-gcc-switches
22945 @opindex frecord-gcc-switches
22946 This switch causes the command line used to invoke the
22947 compiler to be recorded into the object file that is being created.
22948 This switch is only implemented on some targets and the exact format
22949 of the recording is target and binary file format dependent, but it
22950 usually takes the form of a section containing ASCII text.  This
22951 switch is related to the @option{-fverbose-asm} switch, but that
22952 switch only records information in the assembler output file as
22953 comments, so it never reaches the object file.
22954 See also @option{-grecord-gcc-switches} for another
22955 way of storing compiler options into the object file.
22957 @item -fpic
22958 @opindex fpic
22959 @cindex global offset table
22960 @cindex PIC
22961 Generate position-independent code (PIC) suitable for use in a shared
22962 library, if supported for the target machine.  Such code accesses all
22963 constant addresses through a global offset table (GOT)@.  The dynamic
22964 loader resolves the GOT entries when the program starts (the dynamic
22965 loader is not part of GCC; it is part of the operating system).  If
22966 the GOT size for the linked executable exceeds a machine-specific
22967 maximum size, you get an error message from the linker indicating that
22968 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
22969 instead.  (These maximums are 8k on the SPARC and 32k
22970 on the m68k and RS/6000.  The 386 has no such limit.)
22972 Position-independent code requires special support, and therefore works
22973 only on certain machines.  For the 386, GCC supports PIC for System V
22974 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
22975 position-independent.
22977 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22978 are defined to 1.
22980 @item -fPIC
22981 @opindex fPIC
22982 If supported for the target machine, emit position-independent code,
22983 suitable for dynamic linking and avoiding any limit on the size of the
22984 global offset table.  This option makes a difference on the m68k,
22985 PowerPC and SPARC@.
22987 Position-independent code requires special support, and therefore works
22988 only on certain machines.
22990 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22991 are defined to 2.
22993 @item -fpie
22994 @itemx -fPIE
22995 @opindex fpie
22996 @opindex fPIE
22997 These options are similar to @option{-fpic} and @option{-fPIC}, but
22998 generated position independent code can be only linked into executables.
22999 Usually these options are used when @option{-pie} GCC option is
23000 used during linking.
23002 @option{-fpie} and @option{-fPIE} both define the macros
23003 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23004 for @option{-fpie} and 2 for @option{-fPIE}.
23006 @item -fno-jump-tables
23007 @opindex fno-jump-tables
23008 Do not use jump tables for switch statements even where it would be
23009 more efficient than other code generation strategies.  This option is
23010 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23011 building code that forms part of a dynamic linker and cannot
23012 reference the address of a jump table.  On some targets, jump tables
23013 do not require a GOT and this option is not needed.
23015 @item -ffixed-@var{reg}
23016 @opindex ffixed
23017 Treat the register named @var{reg} as a fixed register; generated code
23018 should never refer to it (except perhaps as a stack pointer, frame
23019 pointer or in some other fixed role).
23021 @var{reg} must be the name of a register.  The register names accepted
23022 are machine-specific and are defined in the @code{REGISTER_NAMES}
23023 macro in the machine description macro file.
23025 This flag does not have a negative form, because it specifies a
23026 three-way choice.
23028 @item -fcall-used-@var{reg}
23029 @opindex fcall-used
23030 Treat the register named @var{reg} as an allocable register that is
23031 clobbered by function calls.  It may be allocated for temporaries or
23032 variables that do not live across a call.  Functions compiled this way
23033 do not save and restore the register @var{reg}.
23035 It is an error to use this flag with the frame pointer or stack pointer.
23036 Use of this flag for other registers that have fixed pervasive roles in
23037 the machine's execution model produces disastrous results.
23039 This flag does not have a negative form, because it specifies a
23040 three-way choice.
23042 @item -fcall-saved-@var{reg}
23043 @opindex fcall-saved
23044 Treat the register named @var{reg} as an allocable register saved by
23045 functions.  It may be allocated even for temporaries or variables that
23046 live across a call.  Functions compiled this way save and restore
23047 the register @var{reg} if they use it.
23049 It is an error to use this flag with the frame pointer or stack pointer.
23050 Use of this flag for other registers that have fixed pervasive roles in
23051 the machine's execution model produces disastrous results.
23053 A different sort of disaster results from the use of this flag for
23054 a register in which function values may be returned.
23056 This flag does not have a negative form, because it specifies a
23057 three-way choice.
23059 @item -fpack-struct[=@var{n}]
23060 @opindex fpack-struct
23061 Without a value specified, pack all structure members together without
23062 holes.  When a value is specified (which must be a small power of two), pack
23063 structure members according to this value, representing the maximum
23064 alignment (that is, objects with default alignment requirements larger than
23065 this are output potentially unaligned at the next fitting location.
23067 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23068 code that is not binary compatible with code generated without that switch.
23069 Additionally, it makes the code suboptimal.
23070 Use it to conform to a non-default application binary interface.
23072 @item -finstrument-functions
23073 @opindex finstrument-functions
23074 Generate instrumentation calls for entry and exit to functions.  Just
23075 after function entry and just before function exit, the following
23076 profiling functions are called with the address of the current
23077 function and its call site.  (On some platforms,
23078 @code{__builtin_return_address} does not work beyond the current
23079 function, so the call site information may not be available to the
23080 profiling functions otherwise.)
23082 @smallexample
23083 void __cyg_profile_func_enter (void *this_fn,
23084                                void *call_site);
23085 void __cyg_profile_func_exit  (void *this_fn,
23086                                void *call_site);
23087 @end smallexample
23089 The first argument is the address of the start of the current function,
23090 which may be looked up exactly in the symbol table.
23092 This instrumentation is also done for functions expanded inline in other
23093 functions.  The profiling calls indicate where, conceptually, the
23094 inline function is entered and exited.  This means that addressable
23095 versions of such functions must be available.  If all your uses of a
23096 function are expanded inline, this may mean an additional expansion of
23097 code size.  If you use @samp{extern inline} in your C code, an
23098 addressable version of such functions must be provided.  (This is
23099 normally the case anyway, but if you get lucky and the optimizer always
23100 expands the functions inline, you might have gotten away without
23101 providing static copies.)
23103 A function may be given the attribute @code{no_instrument_function}, in
23104 which case this instrumentation is not done.  This can be used, for
23105 example, for the profiling functions listed above, high-priority
23106 interrupt routines, and any functions from which the profiling functions
23107 cannot safely be called (perhaps signal handlers, if the profiling
23108 routines generate output or allocate memory).
23110 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
23111 @opindex finstrument-functions-exclude-file-list
23113 Set the list of functions that are excluded from instrumentation (see
23114 the description of @code{-finstrument-functions}).  If the file that
23115 contains a function definition matches with one of @var{file}, then
23116 that function is not instrumented.  The match is done on substrings:
23117 if the @var{file} parameter is a substring of the file name, it is
23118 considered to be a match.
23120 For example:
23122 @smallexample
23123 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
23124 @end smallexample
23126 @noindent
23127 excludes any inline function defined in files whose pathnames
23128 contain @code{/bits/stl} or @code{include/sys}.
23130 If, for some reason, you want to include letter @code{','} in one of
23131 @var{sym}, write @code{'\,'}. For example,
23132 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
23133 (note the single quote surrounding the option).
23135 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
23136 @opindex finstrument-functions-exclude-function-list
23138 This is similar to @code{-finstrument-functions-exclude-file-list},
23139 but this option sets the list of function names to be excluded from
23140 instrumentation.  The function name to be matched is its user-visible
23141 name, such as @code{vector<int> blah(const vector<int> &)}, not the
23142 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
23143 match is done on substrings: if the @var{sym} parameter is a substring
23144 of the function name, it is considered to be a match.  For C99 and C++
23145 extended identifiers, the function name must be given in UTF-8, not
23146 using universal character names.
23148 @item -fstack-check
23149 @opindex fstack-check
23150 Generate code to verify that you do not go beyond the boundary of the
23151 stack.  You should specify this flag if you are running in an
23152 environment with multiple threads, but you only rarely need to specify it in
23153 a single-threaded environment since stack overflow is automatically
23154 detected on nearly all systems if there is only one stack.
23156 Note that this switch does not actually cause checking to be done; the
23157 operating system or the language runtime must do that.  The switch causes
23158 generation of code to ensure that they see the stack being extended.
23160 You can additionally specify a string parameter: @code{no} means no
23161 checking, @code{generic} means force the use of old-style checking,
23162 @code{specific} means use the best checking method and is equivalent
23163 to bare @option{-fstack-check}.
23165 Old-style checking is a generic mechanism that requires no specific
23166 target support in the compiler but comes with the following drawbacks:
23168 @enumerate
23169 @item
23170 Modified allocation strategy for large objects: they are always
23171 allocated dynamically if their size exceeds a fixed threshold.
23173 @item
23174 Fixed limit on the size of the static frame of functions: when it is
23175 topped by a particular function, stack checking is not reliable and
23176 a warning is issued by the compiler.
23178 @item
23179 Inefficiency: because of both the modified allocation strategy and the
23180 generic implementation, code performance is hampered.
23181 @end enumerate
23183 Note that old-style stack checking is also the fallback method for
23184 @code{specific} if no target support has been added in the compiler.
23186 @item -fstack-limit-register=@var{reg}
23187 @itemx -fstack-limit-symbol=@var{sym}
23188 @itemx -fno-stack-limit
23189 @opindex fstack-limit-register
23190 @opindex fstack-limit-symbol
23191 @opindex fno-stack-limit
23192 Generate code to ensure that the stack does not grow beyond a certain value,
23193 either the value of a register or the address of a symbol.  If a larger
23194 stack is required, a signal is raised at run time.  For most targets,
23195 the signal is raised before the stack overruns the boundary, so
23196 it is possible to catch the signal without taking special precautions.
23198 For instance, if the stack starts at absolute address @samp{0x80000000}
23199 and grows downwards, you can use the flags
23200 @option{-fstack-limit-symbol=__stack_limit} and
23201 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
23202 of 128KB@.  Note that this may only work with the GNU linker.
23204 @item -fsplit-stack
23205 @opindex fsplit-stack
23206 Generate code to automatically split the stack before it overflows.
23207 The resulting program has a discontiguous stack which can only
23208 overflow if the program is unable to allocate any more memory.  This
23209 is most useful when running threaded programs, as it is no longer
23210 necessary to calculate a good stack size to use for each thread.  This
23211 is currently only implemented for the i386 and x86_64 back ends running
23212 GNU/Linux.
23214 When code compiled with @option{-fsplit-stack} calls code compiled
23215 without @option{-fsplit-stack}, there may not be much stack space
23216 available for the latter code to run.  If compiling all code,
23217 including library code, with @option{-fsplit-stack} is not an option,
23218 then the linker can fix up these calls so that the code compiled
23219 without @option{-fsplit-stack} always has a large stack.  Support for
23220 this is implemented in the gold linker in GNU binutils release 2.21
23221 and later.
23223 @item -fleading-underscore
23224 @opindex fleading-underscore
23225 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
23226 change the way C symbols are represented in the object file.  One use
23227 is to help link with legacy assembly code.
23229 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
23230 generate code that is not binary compatible with code generated without that
23231 switch.  Use it to conform to a non-default application binary interface.
23232 Not all targets provide complete support for this switch.
23234 @item -ftls-model=@var{model}
23235 @opindex ftls-model
23236 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
23237 The @var{model} argument should be one of @code{global-dynamic},
23238 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
23239 Note that the choice is subject to optimization: the compiler may use
23240 a more efficient model for symbols not visible outside of the translation
23241 unit, or if @option{-fpic} is not given on the command line.
23243 The default without @option{-fpic} is @code{initial-exec}; with
23244 @option{-fpic} the default is @code{global-dynamic}.
23246 @item -fvisibility=@var{default|internal|hidden|protected}
23247 @opindex fvisibility
23248 Set the default ELF image symbol visibility to the specified option---all
23249 symbols are marked with this unless overridden within the code.
23250 Using this feature can very substantially improve linking and
23251 load times of shared object libraries, produce more optimized
23252 code, provide near-perfect API export and prevent symbol clashes.
23253 It is @strong{strongly} recommended that you use this in any shared objects
23254 you distribute.
23256 Despite the nomenclature, @code{default} always means public; i.e.,
23257 available to be linked against from outside the shared object.
23258 @code{protected} and @code{internal} are pretty useless in real-world
23259 usage so the only other commonly used option is @code{hidden}.
23260 The default if @option{-fvisibility} isn't specified is
23261 @code{default}, i.e., make every
23262 symbol public---this causes the same behavior as previous versions of
23263 GCC@.
23265 A good explanation of the benefits offered by ensuring ELF
23266 symbols have the correct visibility is given by ``How To Write
23267 Shared Libraries'' by Ulrich Drepper (which can be found at
23268 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
23269 solution made possible by this option to marking things hidden when
23270 the default is public is to make the default hidden and mark things
23271 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
23272 and @code{__attribute__ ((visibility("default")))} instead of
23273 @code{__declspec(dllexport)} you get almost identical semantics with
23274 identical syntax.  This is a great boon to those working with
23275 cross-platform projects.
23277 For those adding visibility support to existing code, you may find
23278 @samp{#pragma GCC visibility} of use.  This works by you enclosing
23279 the declarations you wish to set visibility for with (for example)
23280 @samp{#pragma GCC visibility push(hidden)} and
23281 @samp{#pragma GCC visibility pop}.
23282 Bear in mind that symbol visibility should be viewed @strong{as
23283 part of the API interface contract} and thus all new code should
23284 always specify visibility when it is not the default; i.e., declarations
23285 only for use within the local DSO should @strong{always} be marked explicitly
23286 as hidden as so to avoid PLT indirection overheads---making this
23287 abundantly clear also aids readability and self-documentation of the code.
23288 Note that due to ISO C++ specification requirements, @code{operator new} and
23289 @code{operator delete} must always be of default visibility.
23291 Be aware that headers from outside your project, in particular system
23292 headers and headers from any other library you use, may not be
23293 expecting to be compiled with visibility other than the default.  You
23294 may need to explicitly say @samp{#pragma GCC visibility push(default)}
23295 before including any such headers.
23297 @samp{extern} declarations are not affected by @option{-fvisibility}, so
23298 a lot of code can be recompiled with @option{-fvisibility=hidden} with
23299 no modifications.  However, this means that calls to @code{extern}
23300 functions with no explicit visibility use the PLT, so it is more
23301 effective to use @code{__attribute ((visibility))} and/or
23302 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
23303 declarations should be treated as hidden.
23305 Note that @option{-fvisibility} does affect C++ vague linkage
23306 entities. This means that, for instance, an exception class that is
23307 be thrown between DSOs must be explicitly marked with default
23308 visibility so that the @samp{type_info} nodes are unified between
23309 the DSOs.
23311 An overview of these techniques, their benefits and how to use them
23312 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
23314 @item -fstrict-volatile-bitfields
23315 @opindex fstrict-volatile-bitfields
23316 This option should be used if accesses to volatile bit-fields (or other
23317 structure fields, although the compiler usually honors those types
23318 anyway) should use a single access of the width of the
23319 field's type, aligned to a natural alignment if possible.  For
23320 example, targets with memory-mapped peripheral registers might require
23321 all such accesses to be 16 bits wide; with this flag you can
23322 declare all peripheral bit-fields as @code{unsigned short} (assuming short
23323 is 16 bits on these targets) to force GCC to use 16-bit accesses
23324 instead of, perhaps, a more efficient 32-bit access.
23326 If this option is disabled, the compiler uses the most efficient
23327 instruction.  In the previous example, that might be a 32-bit load
23328 instruction, even though that accesses bytes that do not contain
23329 any portion of the bit-field, or memory-mapped registers unrelated to
23330 the one being updated.
23332 In some cases, such as when the @code{packed} attribute is applied to a 
23333 structure field, it may not be possible to access the field with a single
23334 read or write that is correctly aligned for the target machine.  In this
23335 case GCC falls back to generating multiple accesses rather than code that 
23336 will fault or truncate the result at run time.
23338 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
23339 not allowed to touch non bit-field members.  It is therefore recommended
23340 to define all bits of the field's type as bit-field members.
23342 The default value of this option is determined by the application binary
23343 interface for the target processor.
23345 @item -fsync-libcalls
23346 @opindex fsync-libcalls
23347 This option controls whether any out-of-line instance of the @code{__sync}
23348 family of functions may be used to implement the C++11 @code{__atomic}
23349 family of functions.
23351 The default value of this option is enabled, thus the only useful form
23352 of the option is @option{-fno-sync-libcalls}.  This option is used in
23353 the implementation of the @file{libatomic} runtime library.
23355 @end table
23357 @c man end
23359 @node Environment Variables
23360 @section Environment Variables Affecting GCC
23361 @cindex environment variables
23363 @c man begin ENVIRONMENT
23364 This section describes several environment variables that affect how GCC
23365 operates.  Some of them work by specifying directories or prefixes to use
23366 when searching for various kinds of files.  Some are used to specify other
23367 aspects of the compilation environment.
23369 Note that you can also specify places to search using options such as
23370 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
23371 take precedence over places specified using environment variables, which
23372 in turn take precedence over those specified by the configuration of GCC@.
23373 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
23374 GNU Compiler Collection (GCC) Internals}.
23376 @table @env
23377 @item LANG
23378 @itemx LC_CTYPE
23379 @c @itemx LC_COLLATE
23380 @itemx LC_MESSAGES
23381 @c @itemx LC_MONETARY
23382 @c @itemx LC_NUMERIC
23383 @c @itemx LC_TIME
23384 @itemx LC_ALL
23385 @findex LANG
23386 @findex LC_CTYPE
23387 @c @findex LC_COLLATE
23388 @findex LC_MESSAGES
23389 @c @findex LC_MONETARY
23390 @c @findex LC_NUMERIC
23391 @c @findex LC_TIME
23392 @findex LC_ALL
23393 @cindex locale
23394 These environment variables control the way that GCC uses
23395 localization information which allows GCC to work with different
23396 national conventions.  GCC inspects the locale categories
23397 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
23398 so.  These locale categories can be set to any value supported by your
23399 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
23400 Kingdom encoded in UTF-8.
23402 The @env{LC_CTYPE} environment variable specifies character
23403 classification.  GCC uses it to determine the character boundaries in
23404 a string; this is needed for some multibyte encodings that contain quote
23405 and escape characters that are otherwise interpreted as a string
23406 end or escape.
23408 The @env{LC_MESSAGES} environment variable specifies the language to
23409 use in diagnostic messages.
23411 If the @env{LC_ALL} environment variable is set, it overrides the value
23412 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
23413 and @env{LC_MESSAGES} default to the value of the @env{LANG}
23414 environment variable.  If none of these variables are set, GCC
23415 defaults to traditional C English behavior.
23417 @item TMPDIR
23418 @findex TMPDIR
23419 If @env{TMPDIR} is set, it specifies the directory to use for temporary
23420 files.  GCC uses temporary files to hold the output of one stage of
23421 compilation which is to be used as input to the next stage: for example,
23422 the output of the preprocessor, which is the input to the compiler
23423 proper.
23425 @item GCC_COMPARE_DEBUG
23426 @findex GCC_COMPARE_DEBUG
23427 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
23428 @option{-fcompare-debug} to the compiler driver.  See the documentation
23429 of this option for more details.
23431 @item GCC_EXEC_PREFIX
23432 @findex GCC_EXEC_PREFIX
23433 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
23434 names of the subprograms executed by the compiler.  No slash is added
23435 when this prefix is combined with the name of a subprogram, but you can
23436 specify a prefix that ends with a slash if you wish.
23438 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
23439 an appropriate prefix to use based on the pathname it is invoked with.
23441 If GCC cannot find the subprogram using the specified prefix, it
23442 tries looking in the usual places for the subprogram.
23444 The default value of @env{GCC_EXEC_PREFIX} is
23445 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
23446 the installed compiler. In many cases @var{prefix} is the value
23447 of @code{prefix} when you ran the @file{configure} script.
23449 Other prefixes specified with @option{-B} take precedence over this prefix.
23451 This prefix is also used for finding files such as @file{crt0.o} that are
23452 used for linking.
23454 In addition, the prefix is used in an unusual way in finding the
23455 directories to search for header files.  For each of the standard
23456 directories whose name normally begins with @samp{/usr/local/lib/gcc}
23457 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
23458 replacing that beginning with the specified prefix to produce an
23459 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
23460 @file{foo/bar} just before it searches the standard directory 
23461 @file{/usr/local/lib/bar}.
23462 If a standard directory begins with the configured
23463 @var{prefix} then the value of @var{prefix} is replaced by
23464 @env{GCC_EXEC_PREFIX} when looking for header files.
23466 @item COMPILER_PATH
23467 @findex COMPILER_PATH
23468 The value of @env{COMPILER_PATH} is a colon-separated list of
23469 directories, much like @env{PATH}.  GCC tries the directories thus
23470 specified when searching for subprograms, if it can't find the
23471 subprograms using @env{GCC_EXEC_PREFIX}.
23473 @item LIBRARY_PATH
23474 @findex LIBRARY_PATH
23475 The value of @env{LIBRARY_PATH} is a colon-separated list of
23476 directories, much like @env{PATH}.  When configured as a native compiler,
23477 GCC tries the directories thus specified when searching for special
23478 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
23479 using GCC also uses these directories when searching for ordinary
23480 libraries for the @option{-l} option (but directories specified with
23481 @option{-L} come first).
23483 @item LANG
23484 @findex LANG
23485 @cindex locale definition
23486 This variable is used to pass locale information to the compiler.  One way in
23487 which this information is used is to determine the character set to be used
23488 when character literals, string literals and comments are parsed in C and C++.
23489 When the compiler is configured to allow multibyte characters,
23490 the following values for @env{LANG} are recognized:
23492 @table @samp
23493 @item C-JIS
23494 Recognize JIS characters.
23495 @item C-SJIS
23496 Recognize SJIS characters.
23497 @item C-EUCJP
23498 Recognize EUCJP characters.
23499 @end table
23501 If @env{LANG} is not defined, or if it has some other value, then the
23502 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
23503 recognize and translate multibyte characters.
23504 @end table
23506 @noindent
23507 Some additional environment variables affect the behavior of the
23508 preprocessor.
23510 @include cppenv.texi
23512 @c man end
23514 @node Precompiled Headers
23515 @section Using Precompiled Headers
23516 @cindex precompiled headers
23517 @cindex speed of compilation
23519 Often large projects have many header files that are included in every
23520 source file.  The time the compiler takes to process these header files
23521 over and over again can account for nearly all of the time required to
23522 build the project.  To make builds faster, GCC allows you to
23523 @dfn{precompile} a header file.
23525 To create a precompiled header file, simply compile it as you would any
23526 other file, if necessary using the @option{-x} option to make the driver
23527 treat it as a C or C++ header file.  You may want to use a
23528 tool like @command{make} to keep the precompiled header up-to-date when
23529 the headers it contains change.
23531 A precompiled header file is searched for when @code{#include} is
23532 seen in the compilation.  As it searches for the included file
23533 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
23534 compiler looks for a precompiled header in each directory just before it
23535 looks for the include file in that directory.  The name searched for is
23536 the name specified in the @code{#include} with @samp{.gch} appended.  If
23537 the precompiled header file can't be used, it is ignored.
23539 For instance, if you have @code{#include "all.h"}, and you have
23540 @file{all.h.gch} in the same directory as @file{all.h}, then the
23541 precompiled header file is used if possible, and the original
23542 header is used otherwise.
23544 Alternatively, you might decide to put the precompiled header file in a
23545 directory and use @option{-I} to ensure that directory is searched
23546 before (or instead of) the directory containing the original header.
23547 Then, if you want to check that the precompiled header file is always
23548 used, you can put a file of the same name as the original header in this
23549 directory containing an @code{#error} command.
23551 This also works with @option{-include}.  So yet another way to use
23552 precompiled headers, good for projects not designed with precompiled
23553 header files in mind, is to simply take most of the header files used by
23554 a project, include them from another header file, precompile that header
23555 file, and @option{-include} the precompiled header.  If the header files
23556 have guards against multiple inclusion, they are skipped because
23557 they've already been included (in the precompiled header).
23559 If you need to precompile the same header file for different
23560 languages, targets, or compiler options, you can instead make a
23561 @emph{directory} named like @file{all.h.gch}, and put each precompiled
23562 header in the directory, perhaps using @option{-o}.  It doesn't matter
23563 what you call the files in the directory; every precompiled header in
23564 the directory is considered.  The first precompiled header
23565 encountered in the directory that is valid for this compilation is
23566 used; they're searched in no particular order.
23568 There are many other possibilities, limited only by your imagination,
23569 good sense, and the constraints of your build system.
23571 A precompiled header file can be used only when these conditions apply:
23573 @itemize
23574 @item
23575 Only one precompiled header can be used in a particular compilation.
23577 @item
23578 A precompiled header can't be used once the first C token is seen.  You
23579 can have preprocessor directives before a precompiled header; you cannot
23580 include a precompiled header from inside another header.
23582 @item
23583 The precompiled header file must be produced for the same language as
23584 the current compilation.  You can't use a C precompiled header for a C++
23585 compilation.
23587 @item
23588 The precompiled header file must have been produced by the same compiler
23589 binary as the current compilation is using.
23591 @item
23592 Any macros defined before the precompiled header is included must
23593 either be defined in the same way as when the precompiled header was
23594 generated, or must not affect the precompiled header, which usually
23595 means that they don't appear in the precompiled header at all.
23597 The @option{-D} option is one way to define a macro before a
23598 precompiled header is included; using a @code{#define} can also do it.
23599 There are also some options that define macros implicitly, like
23600 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23601 defined this way.
23603 @item If debugging information is output when using the precompiled
23604 header, using @option{-g} or similar, the same kind of debugging information
23605 must have been output when building the precompiled header.  However,
23606 a precompiled header built using @option{-g} can be used in a compilation
23607 when no debugging information is being output.
23609 @item The same @option{-m} options must generally be used when building
23610 and using the precompiled header.  @xref{Submodel Options},
23611 for any cases where this rule is relaxed.
23613 @item Each of the following options must be the same when building and using
23614 the precompiled header:
23616 @gccoptlist{-fexceptions}
23618 @item
23619 Some other command-line options starting with @option{-f},
23620 @option{-p}, or @option{-O} must be defined in the same way as when
23621 the precompiled header was generated.  At present, it's not clear
23622 which options are safe to change and which are not; the safest choice
23623 is to use exactly the same options when generating and using the
23624 precompiled header.  The following are known to be safe:
23626 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23627 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23628 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23629 -pedantic-errors}
23631 @end itemize
23633 For all of these except the last, the compiler automatically
23634 ignores the precompiled header if the conditions aren't met.  If you
23635 find an option combination that doesn't work and doesn't cause the
23636 precompiled header to be ignored, please consider filing a bug report,
23637 see @ref{Bugs}.
23639 If you do use differing options when generating and using the
23640 precompiled header, the actual behavior is a mixture of the
23641 behavior for the options.  For instance, if you use @option{-g} to
23642 generate the precompiled header but not when using it, you may or may
23643 not get debugging information for routines in the precompiled header.