* doc/invoke.texi (Warning Options): Fix spelling and grammar.
[official-gcc.git] / gcc / doc / invoke.texi
blobd2f3c79536a08203b46c766362482d917caefab1
1 @c Copyright (C) 1988-2014 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2014 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command-line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
97 -v}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several
103 options of the same kind; for example, if you specify @option{-L} more
104 than once, the directories are searched in the order specified.  Also,
105 the placement of the @option{-l} option is significant.
107 Many options have long names starting with @samp{-f} or with
108 @samp{-W}---for example,
109 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
110 these have both positive and negative forms; the negative form of
111 @option{-ffoo} is @option{-fno-foo}.  This manual documents
112 only one of these two forms, whichever one is not the default.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
118 @menu
119 * Option Summary::      Brief list of all options, without explanations.
120 * Overall Options::     Controlling the kind of output:
121                         an executable, object files, assembler files,
122                         or preprocessed source.
123 * Invoking G++::        Compiling C++ programs.
124 * C Dialect Options::   Controlling the variant of C language compiled.
125 * C++ Dialect Options:: Variations on C++.
126 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
127                         and Objective-C++.
128 * Language Independent Options:: Controlling how diagnostics should be
129                         formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
157 @table @emph
158 @item Overall Options
159 @xref{Overall Options,,Options Controlling the Kind of Output}.
160 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
161 -pipe  -pass-exit-codes  @gol
162 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
163 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
164 -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
169 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
170 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
171 -fhosted  -ffreestanding -fopenmp -fopenmp-simd -fms-extensions @gol
172 -fplan9-extensions -trigraphs  -traditional  -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
191 -ftemplate-depth=@var{n} @gol
192 -fno-threadsafe-statics  -fuse-cxa-atexit @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 -fdse @gol
379 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
380 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
381 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
382 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
383 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
384 -fif-conversion2 -findirect-inlining @gol
385 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
386 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
387 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
388 -fira-algorithm=@var{algorithm} @gol
389 -fira-region=@var{region} -fira-hoist-pressure @gol
390 -fira-loop-pressure -fno-ira-share-save-slots @gol
391 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
392 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
393 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
394 -floop-block -floop-interchange -floop-strip-mine @gol  
395 -floop-unroll-and-jam -floop-nest-optimize @gol
396 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
397 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
398 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
399 -fmove-loop-invariants -fno-branch-count-reg @gol
400 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
401 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
402 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
403 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
404 -fomit-frame-pointer -foptimize-sibling-calls @gol
405 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
406 -fprefetch-loop-arrays -fprofile-report @gol
407 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
408 -fprofile-generate=@var{path} @gol
409 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
410 -freciprocal-math -free -frename-registers -fschedule-fusion -freorder-blocks @gol
411 -freorder-blocks-and-partition -freorder-functions @gol
412 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
413 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
414 -fsched-spec-load -fsched-spec-load-dangerous @gol
415 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
416 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
417 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
418 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
419 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
420 -fselective-scheduling -fselective-scheduling2 @gol
421 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
422 -fsemantic-interposition @gol
423 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
424 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt -fstack-protector @gol
425 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
426 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
427 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
428 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
429 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
430 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
431 -ftree-loop-if-convert-stores -ftree-loop-im @gol
432 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
433 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
434 -ftree-loop-vectorize @gol
435 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
436 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
437 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
438 -ftree-vectorize -ftree-vrp @gol
439 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
440 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
441 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
442 -fweb -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
443 --param @var{name}=@var{value}
444 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
446 @item Preprocessor Options
447 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
448 @gccoptlist{-A@var{question}=@var{answer} @gol
449 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
450 -C  -dD  -dI  -dM  -dN @gol
451 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
452 -idirafter @var{dir} @gol
453 -include @var{file}  -imacros @var{file} @gol
454 -iprefix @var{file}  -iwithprefix @var{dir} @gol
455 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
456 -imultilib @var{dir} -isysroot @var{dir} @gol
457 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
458 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
459 -remap -trigraphs  -undef  -U@var{macro}  @gol
460 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
462 @item Assembler Option
463 @xref{Assembler Options,,Passing Options to the Assembler}.
464 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
466 @item Linker Options
467 @xref{Link Options,,Options for Linking}.
468 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
469 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
470 -s  -static -static-libgcc -static-libstdc++ @gol
471 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
472 -shared -shared-libgcc  -symbolic @gol
473 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
474 -u @var{symbol} -z @var{keyword}}
476 @item Directory Options
477 @xref{Directory Options,,Options for Directory Search}.
478 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
479 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
480 --sysroot=@var{dir} --no-sysroot-suffix}
482 @item Machine Dependent Options
483 @xref{Submodel Options,,Hardware Models and Configurations}.
484 @c This list is ordered alphanumerically by subsection name.
485 @c Try and put the significant identifier (CPU or system) first,
486 @c so users have a clue at guessing where the ones they want will be.
488 @emph{AArch64 Options}
489 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
490 -mgeneral-regs-only @gol
491 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
492 -mstrict-align @gol
493 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
494 -mtls-dialect=desc  -mtls-dialect=traditional @gol
495 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
496 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
498 @emph{Adapteva Epiphany Options}
499 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
500 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
501 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
502 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
503 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
504 -msplit-vecmove-early -m1reg-@var{reg}}
506 @emph{ARC Options}
507 @gccoptlist{-mbarrel-shifter @gol
508 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
509 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
510 -mea -mno-mpy -mmul32x16 -mmul64 @gol
511 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
512 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
513 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
514 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
515 -mucb-mcount -mvolatile-cache @gol
516 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
517 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
518 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
519 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
520 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
521 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
523 @emph{ARM Options}
524 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
525 -mabi=@var{name} @gol
526 -mapcs-stack-check  -mno-apcs-stack-check @gol
527 -mapcs-float  -mno-apcs-float @gol
528 -mapcs-reentrant  -mno-apcs-reentrant @gol
529 -msched-prolog  -mno-sched-prolog @gol
530 -mlittle-endian  -mbig-endian @gol
531 -mfloat-abi=@var{name} @gol
532 -mfp16-format=@var{name}
533 -mthumb-interwork  -mno-thumb-interwork @gol
534 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
535 -mstructure-size-boundary=@var{n} @gol
536 -mabort-on-noreturn @gol
537 -mlong-calls  -mno-long-calls @gol
538 -msingle-pic-base  -mno-single-pic-base @gol
539 -mpic-register=@var{reg} @gol
540 -mnop-fun-dllimport @gol
541 -mpoke-function-name @gol
542 -mthumb  -marm @gol
543 -mtpcs-frame  -mtpcs-leaf-frame @gol
544 -mcaller-super-interworking  -mcallee-super-interworking @gol
545 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
546 -mword-relocations @gol
547 -mfix-cortex-m3-ldrd @gol
548 -munaligned-access @gol
549 -mneon-for-64bits @gol
550 -mslow-flash-data @gol
551 -masm-syntax-unified @gol
552 -mrestrict-it}
554 @emph{AVR Options}
555 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
556 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
557 -mstrict-X -mtiny-stack -Waddr-space-convert}
559 @emph{Blackfin Options}
560 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
561 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
562 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
563 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
564 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
565 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
566 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
567 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
568 -micplb}
570 @emph{C6X Options}
571 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
572 -msim -msdata=@var{sdata-type}}
574 @emph{CRIS Options}
575 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
576 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
577 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
578 -mstack-align  -mdata-align  -mconst-align @gol
579 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
580 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
581 -mmul-bug-workaround  -mno-mul-bug-workaround}
583 @emph{CR16 Options}
584 @gccoptlist{-mmac @gol
585 -mcr16cplus -mcr16c @gol
586 -msim -mint32 -mbit-ops
587 -mdata-model=@var{model}}
589 @emph{Darwin Options}
590 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
591 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
592 -client_name  -compatibility_version  -current_version @gol
593 -dead_strip @gol
594 -dependency-file  -dylib_file  -dylinker_install_name @gol
595 -dynamic  -dynamiclib  -exported_symbols_list @gol
596 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
597 -force_flat_namespace  -headerpad_max_install_names @gol
598 -iframework @gol
599 -image_base  -init  -install_name  -keep_private_externs @gol
600 -multi_module  -multiply_defined  -multiply_defined_unused @gol
601 -noall_load   -no_dead_strip_inits_and_terms @gol
602 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
603 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
604 -private_bundle  -read_only_relocs  -sectalign @gol
605 -sectobjectsymbols  -whyload  -seg1addr @gol
606 -sectcreate  -sectobjectsymbols  -sectorder @gol
607 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
608 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
609 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
610 -single_module  -static  -sub_library  -sub_umbrella @gol
611 -twolevel_namespace  -umbrella  -undefined @gol
612 -unexported_symbols_list  -weak_reference_mismatches @gol
613 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
614 -mkernel -mone-byte-bool}
616 @emph{DEC Alpha Options}
617 @gccoptlist{-mno-fp-regs  -msoft-float @gol
618 -mieee  -mieee-with-inexact  -mieee-conformant @gol
619 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
620 -mtrap-precision=@var{mode}  -mbuild-constants @gol
621 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
622 -mbwx  -mmax  -mfix  -mcix @gol
623 -mfloat-vax  -mfloat-ieee @gol
624 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
625 -msmall-text  -mlarge-text @gol
626 -mmemory-latency=@var{time}}
628 @emph{FR30 Options}
629 @gccoptlist{-msmall-model -mno-lsim}
631 @emph{FRV Options}
632 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
633 -mhard-float  -msoft-float @gol
634 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
635 -mdouble  -mno-double @gol
636 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
637 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
638 -mlinked-fp  -mlong-calls  -malign-labels @gol
639 -mlibrary-pic  -macc-4  -macc-8 @gol
640 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
641 -moptimize-membar -mno-optimize-membar @gol
642 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
643 -mvliw-branch  -mno-vliw-branch @gol
644 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
645 -mno-nested-cond-exec  -mtomcat-stats @gol
646 -mTLS -mtls @gol
647 -mcpu=@var{cpu}}
649 @emph{GNU/Linux Options}
650 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
651 -tno-android-cc -tno-android-ld}
653 @emph{H8/300 Options}
654 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
656 @emph{HPPA Options}
657 @gccoptlist{-march=@var{architecture-type} @gol
658 -mdisable-fpregs  -mdisable-indexing @gol
659 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
660 -mfixed-range=@var{register-range} @gol
661 -mjump-in-delay -mlinker-opt -mlong-calls @gol
662 -mlong-load-store  -mno-disable-fpregs @gol
663 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
664 -mno-jump-in-delay  -mno-long-load-store @gol
665 -mno-portable-runtime  -mno-soft-float @gol
666 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
667 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
668 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
669 -munix=@var{unix-std}  -nolibdld  -static  -threads}
671 @emph{i386 and x86-64 Options}
672 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
673 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
674 -mfpmath=@var{unit} @gol
675 -masm=@var{dialect}  -mno-fancy-math-387 @gol
676 -mno-fp-ret-in-387  -msoft-float @gol
677 -mno-wide-multiply  -mrtd  -malign-double @gol
678 -mpreferred-stack-boundary=@var{num} @gol
679 -mincoming-stack-boundary=@var{num} @gol
680 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
681 -mrecip -mrecip=@var{opt} @gol
682 -mvzeroupper -mprefer-avx128 @gol
683 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
684 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
685 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
686 -mclflushopt -mxsavec -mxsaves @gol
687 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
688 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mthreads @gol
689 -mno-align-stringops  -minline-all-stringops @gol
690 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
691 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
692 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
693 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
694 -mregparm=@var{num}  -msseregparm @gol
695 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
696 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
697 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
698 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
699 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
700 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
701 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
702 -mstack-protector-guard=@var{guard}}
704 @emph{i386 and x86-64 Windows Options}
705 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
706 -mnop-fun-dllimport -mthread @gol
707 -municode -mwin32 -mwindows -fno-set-stack-executable}
709 @emph{IA-64 Options}
710 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
711 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
712 -mconstant-gp  -mauto-pic  -mfused-madd @gol
713 -minline-float-divide-min-latency @gol
714 -minline-float-divide-max-throughput @gol
715 -mno-inline-float-divide @gol
716 -minline-int-divide-min-latency @gol
717 -minline-int-divide-max-throughput  @gol
718 -mno-inline-int-divide @gol
719 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
720 -mno-inline-sqrt @gol
721 -mdwarf2-asm -mearly-stop-bits @gol
722 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
723 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
724 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
725 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
726 -msched-spec-ldc -msched-spec-control-ldc @gol
727 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
728 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
729 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
730 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
732 @emph{LM32 Options}
733 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
734 -msign-extend-enabled -muser-enabled}
736 @emph{M32R/D Options}
737 @gccoptlist{-m32r2 -m32rx -m32r @gol
738 -mdebug @gol
739 -malign-loops -mno-align-loops @gol
740 -missue-rate=@var{number} @gol
741 -mbranch-cost=@var{number} @gol
742 -mmodel=@var{code-size-model-type} @gol
743 -msdata=@var{sdata-type} @gol
744 -mno-flush-func -mflush-func=@var{name} @gol
745 -mno-flush-trap -mflush-trap=@var{number} @gol
746 -G @var{num}}
748 @emph{M32C Options}
749 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
751 @emph{M680x0 Options}
752 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
753 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
754 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
755 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
756 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
757 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
758 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
759 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
760 -mxgot -mno-xgot}
762 @emph{MCore Options}
763 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
764 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
765 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
766 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
767 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
769 @emph{MeP Options}
770 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
771 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
772 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
773 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
774 -mtiny=@var{n}}
776 @emph{MicroBlaze Options}
777 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
778 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
779 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
780 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
781 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
783 @emph{MIPS Options}
784 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
785 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
786 -mips64  -mips64r2  -mips64r3  -mips64r5 @gol
787 -mips16  -mno-mips16  -mflip-mips16 @gol
788 -minterlink-compressed -mno-interlink-compressed @gol
789 -minterlink-mips16  -mno-interlink-mips16 @gol
790 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
791 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
792 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
793 -mno-float  -msingle-float  -mdouble-float @gol
794 -modd-spreg -mno-odd-spreg @gol
795 -mabs=@var{mode}  -mnan=@var{encoding} @gol
796 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
797 -mmcu -mmno-mcu @gol
798 -meva -mno-eva @gol
799 -mvirt -mno-virt @gol
800 -mxpa -mno-xpa @gol
801 -mmicromips -mno-micromips @gol
802 -mfpu=@var{fpu-type} @gol
803 -msmartmips  -mno-smartmips @gol
804 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
805 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
806 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
807 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
808 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
809 -membedded-data  -mno-embedded-data @gol
810 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
811 -mcode-readable=@var{setting} @gol
812 -msplit-addresses  -mno-split-addresses @gol
813 -mexplicit-relocs  -mno-explicit-relocs @gol
814 -mcheck-zero-division  -mno-check-zero-division @gol
815 -mdivide-traps  -mdivide-breaks @gol
816 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
817 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
818 -mfix-24k -mno-fix-24k @gol
819 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
820 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
821 -mfix-vr4120  -mno-fix-vr4120 @gol
822 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
823 -mflush-func=@var{func}  -mno-flush-func @gol
824 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
825 -mfp-exceptions -mno-fp-exceptions @gol
826 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
827 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
829 @emph{MMIX Options}
830 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
831 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
832 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
833 -mno-base-addresses  -msingle-exit  -mno-single-exit}
835 @emph{MN10300 Options}
836 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
837 -mno-am33 -mam33 -mam33-2 -mam34 @gol
838 -mtune=@var{cpu-type} @gol
839 -mreturn-pointer-on-d0 @gol
840 -mno-crt0  -mrelax -mliw -msetlb}
842 @emph{Moxie Options}
843 @gccoptlist{-meb -mel -mno-crt0}
845 @emph{MSP430 Options}
846 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
847 -mhwmult= -minrt}
849 @emph{NDS32 Options}
850 @gccoptlist{-mbig-endian -mlittle-endian @gol
851 -mreduced-regs -mfull-regs @gol
852 -mcmov -mno-cmov @gol
853 -mperf-ext -mno-perf-ext @gol
854 -mv3push -mno-v3push @gol
855 -m16bit -mno-16bit @gol
856 -mgp-direct -mno-gp-direct @gol
857 -misr-vector-size=@var{num} @gol
858 -mcache-block-size=@var{num} @gol
859 -march=@var{arch} @gol
860 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
861 -mex9 -mctor-dtor -mrelax}
863 @emph{Nios II Options}
864 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
865 -mno-bypass-cache -mbypass-cache @gol
866 -mno-cache-volatile -mcache-volatile @gol
867 -mno-fast-sw-div -mfast-sw-div @gol
868 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
869 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
870 -mcustom-fpu-cfg=@var{name} @gol
871 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
873 @emph{PDP-11 Options}
874 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
875 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
876 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
877 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
878 -mbranch-expensive  -mbranch-cheap @gol
879 -munix-asm  -mdec-asm}
881 @emph{picoChip Options}
882 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
883 -msymbol-as-address -mno-inefficient-warnings}
885 @emph{PowerPC Options}
886 See RS/6000 and PowerPC Options.
888 @emph{RL78 Options}
889 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78 @gol
890 -m64bit-doubles -m32bit-doubles}
892 @emph{RS/6000 and PowerPC Options}
893 @gccoptlist{-mcpu=@var{cpu-type} @gol
894 -mtune=@var{cpu-type} @gol
895 -mcmodel=@var{code-model} @gol
896 -mpowerpc64 @gol
897 -maltivec  -mno-altivec @gol
898 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
899 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
900 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
901 -mfprnd  -mno-fprnd @gol
902 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
903 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
904 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
905 -malign-power  -malign-natural @gol
906 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
907 -msingle-float -mdouble-float -msimple-fpu @gol
908 -mstring  -mno-string  -mupdate  -mno-update @gol
909 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
910 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
911 -mstrict-align  -mno-strict-align  -mrelocatable @gol
912 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
913 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
914 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
915 -mprioritize-restricted-insns=@var{priority} @gol
916 -msched-costly-dep=@var{dependence_type} @gol
917 -minsert-sched-nops=@var{scheme} @gol
918 -mcall-sysv  -mcall-netbsd @gol
919 -maix-struct-return  -msvr4-struct-return @gol
920 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
921 -mblock-move-inline-limit=@var{num} @gol
922 -misel -mno-isel @gol
923 -misel=yes  -misel=no @gol
924 -mspe -mno-spe @gol
925 -mspe=yes  -mspe=no @gol
926 -mpaired @gol
927 -mgen-cell-microcode -mwarn-cell-microcode @gol
928 -mvrsave -mno-vrsave @gol
929 -mmulhw -mno-mulhw @gol
930 -mdlmzb -mno-dlmzb @gol
931 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
932 -mprototype  -mno-prototype @gol
933 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
934 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
935 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
936 -mno-recip-precision @gol
937 -mveclibabi=@var{type} -mfriz -mno-friz @gol
938 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
939 -msave-toc-indirect -mno-save-toc-indirect @gol
940 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
941 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
942 -mquad-memory -mno-quad-memory @gol
943 -mquad-memory-atomic -mno-quad-memory-atomic @gol
944 -mcompat-align-parm -mno-compat-align-parm @gol
945 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
946 -mupper-regs -mno-upper-regs}
948 @emph{RX Options}
949 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
950 -mcpu=@gol
951 -mbig-endian-data -mlittle-endian-data @gol
952 -msmall-data @gol
953 -msim  -mno-sim@gol
954 -mas100-syntax -mno-as100-syntax@gol
955 -mrelax@gol
956 -mmax-constant-size=@gol
957 -mint-register=@gol
958 -mpid@gol
959 -mno-warn-multiple-fast-interrupts@gol
960 -msave-acc-in-interrupts}
962 @emph{S/390 and zSeries Options}
963 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
964 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
965 -mlong-double-64 -mlong-double-128 @gol
966 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
967 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
968 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
969 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
970 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
971 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
973 @emph{Score Options}
974 @gccoptlist{-meb -mel @gol
975 -mnhwloop @gol
976 -muls @gol
977 -mmac @gol
978 -mscore5 -mscore5u -mscore7 -mscore7d}
980 @emph{SH Options}
981 @gccoptlist{-m1  -m2  -m2e @gol
982 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
983 -m3  -m3e @gol
984 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
985 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
986 -m5-64media  -m5-64media-nofpu @gol
987 -m5-32media  -m5-32media-nofpu @gol
988 -m5-compact  -m5-compact-nofpu @gol
989 -mb  -ml  -mdalign  -mrelax @gol
990 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
991 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
992 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
993 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
994 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
995 -maccumulate-outgoing-args -minvalid-symbols @gol
996 -matomic-model=@var{atomic-model} @gol
997 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
998 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
999 -mpretend-cmove -mtas}
1001 @emph{Solaris 2 Options}
1002 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1003 -pthreads -pthread}
1005 @emph{SPARC Options}
1006 @gccoptlist{-mcpu=@var{cpu-type} @gol
1007 -mtune=@var{cpu-type} @gol
1008 -mcmodel=@var{code-model} @gol
1009 -mmemory-model=@var{mem-model} @gol
1010 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1011 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1012 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1013 -mhard-quad-float  -msoft-quad-float @gol
1014 -mstack-bias  -mno-stack-bias @gol
1015 -munaligned-doubles  -mno-unaligned-doubles @gol
1016 -muser-mode  -mno-user-mode @gol
1017 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1018 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1019 -mcbcond -mno-cbcond @gol
1020 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1021 -mfix-at697f -mfix-ut699}
1023 @emph{SPU Options}
1024 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1025 -msafe-dma -munsafe-dma @gol
1026 -mbranch-hints @gol
1027 -msmall-mem -mlarge-mem -mstdmain @gol
1028 -mfixed-range=@var{register-range} @gol
1029 -mea32 -mea64 @gol
1030 -maddress-space-conversion -mno-address-space-conversion @gol
1031 -mcache-size=@var{cache-size} @gol
1032 -matomic-updates -mno-atomic-updates}
1034 @emph{System V Options}
1035 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1037 @emph{TILE-Gx Options}
1038 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1039 -mcmodel=@var{code-model}}
1041 @emph{TILEPro Options}
1042 @gccoptlist{-mcpu=@var{cpu} -m32}
1044 @emph{V850 Options}
1045 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1046 -mprolog-function  -mno-prolog-function  -mspace @gol
1047 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1048 -mapp-regs  -mno-app-regs @gol
1049 -mdisable-callt  -mno-disable-callt @gol
1050 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1051 -mv850e -mv850 -mv850e3v5 @gol
1052 -mloop @gol
1053 -mrelax @gol
1054 -mlong-jumps @gol
1055 -msoft-float @gol
1056 -mhard-float @gol
1057 -mgcc-abi @gol
1058 -mrh850-abi @gol
1059 -mbig-switch}
1061 @emph{VAX Options}
1062 @gccoptlist{-mg  -mgnu  -munix}
1064 @emph{VMS Options}
1065 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1066 -mpointer-size=@var{size}}
1068 @emph{VxWorks Options}
1069 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1070 -Xbind-lazy  -Xbind-now}
1072 @emph{x86-64 Options}
1073 See i386 and x86-64 Options.
1075 @emph{Xstormy16 Options}
1076 @gccoptlist{-msim}
1078 @emph{Xtensa Options}
1079 @gccoptlist{-mconst16 -mno-const16 @gol
1080 -mfused-madd  -mno-fused-madd @gol
1081 -mforce-no-pic @gol
1082 -mserialize-volatile  -mno-serialize-volatile @gol
1083 -mtext-section-literals  -mno-text-section-literals @gol
1084 -mtarget-align  -mno-target-align @gol
1085 -mlongcalls  -mno-longcalls}
1087 @emph{zSeries Options}
1088 See S/390 and zSeries Options.
1090 @item Code Generation Options
1091 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1092 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1093 -ffixed-@var{reg}  -fexceptions @gol
1094 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1095 -fasynchronous-unwind-tables @gol
1096 -fno-gnu-unique @gol
1097 -finhibit-size-directive  -finstrument-functions @gol
1098 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1099 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1100 -fno-common  -fno-ident @gol
1101 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1102 -fno-jump-tables @gol
1103 -frecord-gcc-switches @gol
1104 -freg-struct-return  -fshort-enums @gol
1105 -fshort-double  -fshort-wchar @gol
1106 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1107 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1108 -fno-stack-limit -fsplit-stack @gol
1109 -fleading-underscore  -ftls-model=@var{model} @gol
1110 -fstack-reuse=@var{reuse_level} @gol
1111 -ftrapv  -fwrapv  -fbounds-check @gol
1112 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1113 @end table
1116 @node Overall Options
1117 @section Options Controlling the Kind of Output
1119 Compilation can involve up to four stages: preprocessing, compilation
1120 proper, assembly and linking, always in that order.  GCC is capable of
1121 preprocessing and compiling several files either into several
1122 assembler input files, or into one assembler input file; then each
1123 assembler input file produces an object file, and linking combines all
1124 the object files (those newly compiled, and those specified as input)
1125 into an executable file.
1127 @cindex file name suffix
1128 For any given input file, the file name suffix determines what kind of
1129 compilation is done:
1131 @table @gcctabopt
1132 @item @var{file}.c
1133 C source code that must be preprocessed.
1135 @item @var{file}.i
1136 C source code that should not be preprocessed.
1138 @item @var{file}.ii
1139 C++ source code that should not be preprocessed.
1141 @item @var{file}.m
1142 Objective-C source code.  Note that you must link with the @file{libobjc}
1143 library to make an Objective-C program work.
1145 @item @var{file}.mi
1146 Objective-C source code that should not be preprocessed.
1148 @item @var{file}.mm
1149 @itemx @var{file}.M
1150 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1151 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1152 to a literal capital M@.
1154 @item @var{file}.mii
1155 Objective-C++ source code that should not be preprocessed.
1157 @item @var{file}.h
1158 C, C++, Objective-C or Objective-C++ header file to be turned into a
1159 precompiled header (default), or C, C++ header file to be turned into an
1160 Ada spec (via the @option{-fdump-ada-spec} switch).
1162 @item @var{file}.cc
1163 @itemx @var{file}.cp
1164 @itemx @var{file}.cxx
1165 @itemx @var{file}.cpp
1166 @itemx @var{file}.CPP
1167 @itemx @var{file}.c++
1168 @itemx @var{file}.C
1169 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1170 the last two letters must both be literally @samp{x}.  Likewise,
1171 @samp{.C} refers to a literal capital C@.
1173 @item @var{file}.mm
1174 @itemx @var{file}.M
1175 Objective-C++ source code that must be preprocessed.
1177 @item @var{file}.mii
1178 Objective-C++ source code that should not be preprocessed.
1180 @item @var{file}.hh
1181 @itemx @var{file}.H
1182 @itemx @var{file}.hp
1183 @itemx @var{file}.hxx
1184 @itemx @var{file}.hpp
1185 @itemx @var{file}.HPP
1186 @itemx @var{file}.h++
1187 @itemx @var{file}.tcc
1188 C++ header file to be turned into a precompiled header or Ada spec.
1190 @item @var{file}.f
1191 @itemx @var{file}.for
1192 @itemx @var{file}.ftn
1193 Fixed form Fortran source code that should not be preprocessed.
1195 @item @var{file}.F
1196 @itemx @var{file}.FOR
1197 @itemx @var{file}.fpp
1198 @itemx @var{file}.FPP
1199 @itemx @var{file}.FTN
1200 Fixed form Fortran source code that must be preprocessed (with the traditional
1201 preprocessor).
1203 @item @var{file}.f90
1204 @itemx @var{file}.f95
1205 @itemx @var{file}.f03
1206 @itemx @var{file}.f08
1207 Free form Fortran source code that should not be preprocessed.
1209 @item @var{file}.F90
1210 @itemx @var{file}.F95
1211 @itemx @var{file}.F03
1212 @itemx @var{file}.F08
1213 Free form Fortran source code that must be preprocessed (with the
1214 traditional preprocessor).
1216 @item @var{file}.go
1217 Go source code.
1219 @c FIXME: Descriptions of Java file types.
1220 @c @var{file}.java
1221 @c @var{file}.class
1222 @c @var{file}.zip
1223 @c @var{file}.jar
1225 @item @var{file}.ads
1226 Ada source code file that contains a library unit declaration (a
1227 declaration of a package, subprogram, or generic, or a generic
1228 instantiation), or a library unit renaming declaration (a package,
1229 generic, or subprogram renaming declaration).  Such files are also
1230 called @dfn{specs}.
1232 @item @var{file}.adb
1233 Ada source code file containing a library unit body (a subprogram or
1234 package body).  Such files are also called @dfn{bodies}.
1236 @c GCC also knows about some suffixes for languages not yet included:
1237 @c Pascal:
1238 @c @var{file}.p
1239 @c @var{file}.pas
1240 @c Ratfor:
1241 @c @var{file}.r
1243 @item @var{file}.s
1244 Assembler code.
1246 @item @var{file}.S
1247 @itemx @var{file}.sx
1248 Assembler code that must be preprocessed.
1250 @item @var{other}
1251 An object file to be fed straight into linking.
1252 Any file name with no recognized suffix is treated this way.
1253 @end table
1255 @opindex x
1256 You can specify the input language explicitly with the @option{-x} option:
1258 @table @gcctabopt
1259 @item -x @var{language}
1260 Specify explicitly the @var{language} for the following input files
1261 (rather than letting the compiler choose a default based on the file
1262 name suffix).  This option applies to all following input files until
1263 the next @option{-x} option.  Possible values for @var{language} are:
1264 @smallexample
1265 c  c-header  cpp-output
1266 c++  c++-header  c++-cpp-output
1267 objective-c  objective-c-header  objective-c-cpp-output
1268 objective-c++ objective-c++-header objective-c++-cpp-output
1269 assembler  assembler-with-cpp
1271 f77  f77-cpp-input f95  f95-cpp-input
1273 java
1274 @end smallexample
1276 @item -x none
1277 Turn off any specification of a language, so that subsequent files are
1278 handled according to their file name suffixes (as they are if @option{-x}
1279 has not been used at all).
1281 @item -pass-exit-codes
1282 @opindex pass-exit-codes
1283 Normally the @command{gcc} program exits with the code of 1 if any
1284 phase of the compiler returns a non-success return code.  If you specify
1285 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1286 the numerically highest error produced by any phase returning an error
1287 indication.  The C, C++, and Fortran front ends return 4 if an internal
1288 compiler error is encountered.
1289 @end table
1291 If you only want some of the stages of compilation, you can use
1292 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1293 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1294 @command{gcc} is to stop.  Note that some combinations (for example,
1295 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1297 @table @gcctabopt
1298 @item -c
1299 @opindex c
1300 Compile or assemble the source files, but do not link.  The linking
1301 stage simply is not done.  The ultimate output is in the form of an
1302 object file for each source file.
1304 By default, the object file name for a source file is made by replacing
1305 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1307 Unrecognized input files, not requiring compilation or assembly, are
1308 ignored.
1310 @item -S
1311 @opindex S
1312 Stop after the stage of compilation proper; do not assemble.  The output
1313 is in the form of an assembler code file for each non-assembler input
1314 file specified.
1316 By default, the assembler file name for a source file is made by
1317 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1319 Input files that don't require compilation are ignored.
1321 @item -E
1322 @opindex E
1323 Stop after the preprocessing stage; do not run the compiler proper.  The
1324 output is in the form of preprocessed source code, which is sent to the
1325 standard output.
1327 Input files that don't require preprocessing are ignored.
1329 @cindex output file option
1330 @item -o @var{file}
1331 @opindex o
1332 Place output in file @var{file}.  This applies to whatever
1333 sort of output is being produced, whether it be an executable file,
1334 an object file, an assembler file or preprocessed C code.
1336 If @option{-o} is not specified, the default is to put an executable
1337 file in @file{a.out}, the object file for
1338 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1339 assembler file in @file{@var{source}.s}, a precompiled header file in
1340 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1341 standard output.
1343 @item -v
1344 @opindex v
1345 Print (on standard error output) the commands executed to run the stages
1346 of compilation.  Also print the version number of the compiler driver
1347 program and of the preprocessor and the compiler proper.
1349 @item -###
1350 @opindex ###
1351 Like @option{-v} except the commands are not executed and arguments
1352 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1353 This is useful for shell scripts to capture the driver-generated command lines.
1355 @item -pipe
1356 @opindex pipe
1357 Use pipes rather than temporary files for communication between the
1358 various stages of compilation.  This fails to work on some systems where
1359 the assembler is unable to read from a pipe; but the GNU assembler has
1360 no trouble.
1362 @item --help
1363 @opindex help
1364 Print (on the standard output) a description of the command-line options
1365 understood by @command{gcc}.  If the @option{-v} option is also specified
1366 then @option{--help} is also passed on to the various processes
1367 invoked by @command{gcc}, so that they can display the command-line options
1368 they accept.  If the @option{-Wextra} option has also been specified
1369 (prior to the @option{--help} option), then command-line options that
1370 have no documentation associated with them are also displayed.
1372 @item --target-help
1373 @opindex target-help
1374 Print (on the standard output) a description of target-specific command-line
1375 options for each tool.  For some targets extra target-specific
1376 information may also be printed.
1378 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1379 Print (on the standard output) a description of the command-line
1380 options understood by the compiler that fit into all specified classes
1381 and qualifiers.  These are the supported classes:
1383 @table @asis
1384 @item @samp{optimizers}
1385 Display all of the optimization options supported by the
1386 compiler.
1388 @item @samp{warnings}
1389 Display all of the options controlling warning messages
1390 produced by the compiler.
1392 @item @samp{target}
1393 Display target-specific options.  Unlike the
1394 @option{--target-help} option however, target-specific options of the
1395 linker and assembler are not displayed.  This is because those
1396 tools do not currently support the extended @option{--help=} syntax.
1398 @item @samp{params}
1399 Display the values recognized by the @option{--param}
1400 option.
1402 @item @var{language}
1403 Display the options supported for @var{language}, where
1404 @var{language} is the name of one of the languages supported in this
1405 version of GCC@.
1407 @item @samp{common}
1408 Display the options that are common to all languages.
1409 @end table
1411 These are the supported qualifiers:
1413 @table @asis
1414 @item @samp{undocumented}
1415 Display only those options that are undocumented.
1417 @item @samp{joined}
1418 Display options taking an argument that appears after an equal
1419 sign in the same continuous piece of text, such as:
1420 @samp{--help=target}.
1422 @item @samp{separate}
1423 Display options taking an argument that appears as a separate word
1424 following the original option, such as: @samp{-o output-file}.
1425 @end table
1427 Thus for example to display all the undocumented target-specific
1428 switches supported by the compiler, use:
1430 @smallexample
1431 --help=target,undocumented
1432 @end smallexample
1434 The sense of a qualifier can be inverted by prefixing it with the
1435 @samp{^} character, so for example to display all binary warning
1436 options (i.e., ones that are either on or off and that do not take an
1437 argument) that have a description, use:
1439 @smallexample
1440 --help=warnings,^joined,^undocumented
1441 @end smallexample
1443 The argument to @option{--help=} should not consist solely of inverted
1444 qualifiers.
1446 Combining several classes is possible, although this usually
1447 restricts the output so much that there is nothing to display.  One
1448 case where it does work, however, is when one of the classes is
1449 @var{target}.  For example, to display all the target-specific
1450 optimization options, use:
1452 @smallexample
1453 --help=target,optimizers
1454 @end smallexample
1456 The @option{--help=} option can be repeated on the command line.  Each
1457 successive use displays its requested class of options, skipping
1458 those that have already been displayed.
1460 If the @option{-Q} option appears on the command line before the
1461 @option{--help=} option, then the descriptive text displayed by
1462 @option{--help=} is changed.  Instead of describing the displayed
1463 options, an indication is given as to whether the option is enabled,
1464 disabled or set to a specific value (assuming that the compiler
1465 knows this at the point where the @option{--help=} option is used).
1467 Here is a truncated example from the ARM port of @command{gcc}:
1469 @smallexample
1470   % gcc -Q -mabi=2 --help=target -c
1471   The following options are target specific:
1472   -mabi=                                2
1473   -mabort-on-noreturn                   [disabled]
1474   -mapcs                                [disabled]
1475 @end smallexample
1477 The output is sensitive to the effects of previous command-line
1478 options, so for example it is possible to find out which optimizations
1479 are enabled at @option{-O2} by using:
1481 @smallexample
1482 -Q -O2 --help=optimizers
1483 @end smallexample
1485 Alternatively you can discover which binary optimizations are enabled
1486 by @option{-O3} by using:
1488 @smallexample
1489 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1490 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1491 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1492 @end smallexample
1494 @item -no-canonical-prefixes
1495 @opindex no-canonical-prefixes
1496 Do not expand any symbolic links, resolve references to @samp{/../}
1497 or @samp{/./}, or make the path absolute when generating a relative
1498 prefix.
1500 @item --version
1501 @opindex version
1502 Display the version number and copyrights of the invoked GCC@.
1504 @item -wrapper
1505 @opindex wrapper
1506 Invoke all subcommands under a wrapper program.  The name of the
1507 wrapper program and its parameters are passed as a comma separated
1508 list.
1510 @smallexample
1511 gcc -c t.c -wrapper gdb,--args
1512 @end smallexample
1514 @noindent
1515 This invokes all subprograms of @command{gcc} under
1516 @samp{gdb --args}, thus the invocation of @command{cc1} is
1517 @samp{gdb --args cc1 @dots{}}.
1519 @item -fplugin=@var{name}.so
1520 @opindex fplugin
1521 Load the plugin code in file @var{name}.so, assumed to be a
1522 shared object to be dlopen'd by the compiler.  The base name of
1523 the shared object file is used to identify the plugin for the
1524 purposes of argument parsing (See
1525 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1526 Each plugin should define the callback functions specified in the
1527 Plugins API.
1529 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1530 @opindex fplugin-arg
1531 Define an argument called @var{key} with a value of @var{value}
1532 for the plugin called @var{name}.
1534 @item -fdump-ada-spec@r{[}-slim@r{]}
1535 @opindex fdump-ada-spec
1536 For C and C++ source and include files, generate corresponding Ada specs.
1537 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1538 GNAT User's Guide}, which provides detailed documentation on this feature.
1540 @item -fada-spec-parent=@var{unit}
1541 @opindex fada-spec-parent
1542 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1543 Ada specs as child units of parent @var{unit}.
1545 @item -fdump-go-spec=@var{file}
1546 @opindex fdump-go-spec
1547 For input files in any language, generate corresponding Go
1548 declarations in @var{file}.  This generates Go @code{const},
1549 @code{type}, @code{var}, and @code{func} declarations which may be a
1550 useful way to start writing a Go interface to code written in some
1551 other language.
1553 @include @value{srcdir}/../libiberty/at-file.texi
1554 @end table
1556 @node Invoking G++
1557 @section Compiling C++ Programs
1559 @cindex suffixes for C++ source
1560 @cindex C++ source file suffixes
1561 C++ source files conventionally use one of the suffixes @samp{.C},
1562 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1563 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1564 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1565 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1566 files with these names and compiles them as C++ programs even if you
1567 call the compiler the same way as for compiling C programs (usually
1568 with the name @command{gcc}).
1570 @findex g++
1571 @findex c++
1572 However, the use of @command{gcc} does not add the C++ library.
1573 @command{g++} is a program that calls GCC and automatically specifies linking
1574 against the C++ library.  It treats @samp{.c},
1575 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1576 files unless @option{-x} is used.  This program is also useful when
1577 precompiling a C header file with a @samp{.h} extension for use in C++
1578 compilations.  On many systems, @command{g++} is also installed with
1579 the name @command{c++}.
1581 @cindex invoking @command{g++}
1582 When you compile C++ programs, you may specify many of the same
1583 command-line options that you use for compiling programs in any
1584 language; or command-line options meaningful for C and related
1585 languages; or options that are meaningful only for C++ programs.
1586 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1587 explanations of options for languages related to C@.
1588 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1589 explanations of options that are meaningful only for C++ programs.
1591 @node C Dialect Options
1592 @section Options Controlling C Dialect
1593 @cindex dialect options
1594 @cindex language dialect options
1595 @cindex options, dialect
1597 The following options control the dialect of C (or languages derived
1598 from C, such as C++, Objective-C and Objective-C++) that the compiler
1599 accepts:
1601 @table @gcctabopt
1602 @cindex ANSI support
1603 @cindex ISO support
1604 @item -ansi
1605 @opindex ansi
1606 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1607 equivalent to @option{-std=c++98}.
1609 This turns off certain features of GCC that are incompatible with ISO
1610 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1611 such as the @code{asm} and @code{typeof} keywords, and
1612 predefined macros such as @code{unix} and @code{vax} that identify the
1613 type of system you are using.  It also enables the undesirable and
1614 rarely used ISO trigraph feature.  For the C compiler,
1615 it disables recognition of C++ style @samp{//} comments as well as
1616 the @code{inline} keyword.
1618 The alternate keywords @code{__asm__}, @code{__extension__},
1619 @code{__inline__} and @code{__typeof__} continue to work despite
1620 @option{-ansi}.  You would not want to use them in an ISO C program, of
1621 course, but it is useful to put them in header files that might be included
1622 in compilations done with @option{-ansi}.  Alternate predefined macros
1623 such as @code{__unix__} and @code{__vax__} are also available, with or
1624 without @option{-ansi}.
1626 The @option{-ansi} option does not cause non-ISO programs to be
1627 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1628 addition to @option{-ansi}.  @xref{Warning Options}.
1630 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1631 option is used.  Some header files may notice this macro and refrain
1632 from declaring certain functions or defining certain macros that the
1633 ISO standard doesn't call for; this is to avoid interfering with any
1634 programs that might use these names for other things.
1636 Functions that are normally built in but do not have semantics
1637 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1638 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1639 built-in functions provided by GCC}, for details of the functions
1640 affected.
1642 @item -std=
1643 @opindex std
1644 Determine the language standard. @xref{Standards,,Language Standards
1645 Supported by GCC}, for details of these standard versions.  This option
1646 is currently only supported when compiling C or C++.
1648 The compiler can accept several base standards, such as @samp{c90} or
1649 @samp{c++98}, and GNU dialects of those standards, such as
1650 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1651 compiler accepts all programs following that standard plus those
1652 using GNU extensions that do not contradict it.  For example,
1653 @option{-std=c90} turns off certain features of GCC that are
1654 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1655 keywords, but not other GNU extensions that do not have a meaning in
1656 ISO C90, such as omitting the middle term of a @code{?:}
1657 expression. On the other hand, when a GNU dialect of a standard is
1658 specified, all features supported by the compiler are enabled, even when
1659 those features change the meaning of the base standard.  As a result, some
1660 strict-conforming programs may be rejected.  The particular standard
1661 is used by @option{-Wpedantic} to identify which features are GNU
1662 extensions given that version of the standard. For example
1663 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1664 comments, while @option{-std=gnu99 -Wpedantic} does not.
1666 A value for this option must be provided; possible values are
1668 @table @samp
1669 @item c90
1670 @itemx c89
1671 @itemx iso9899:1990
1672 Support all ISO C90 programs (certain GNU extensions that conflict
1673 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1675 @item iso9899:199409
1676 ISO C90 as modified in amendment 1.
1678 @item c99
1679 @itemx c9x
1680 @itemx iso9899:1999
1681 @itemx iso9899:199x
1682 ISO C99.  This standard is substantially completely supported, modulo
1683 bugs and floating-point issues
1684 (mainly but not entirely relating to optional C99 features from
1685 Annexes F and G).  See
1686 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1687 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1689 @item c11
1690 @itemx c1x
1691 @itemx iso9899:2011
1692 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1693 substantially completely supported, modulo bugs, floating-point issues
1694 (mainly but not entirely relating to optional C11 features from
1695 Annexes F and G) and the optional Annexes K (Bounds-checking
1696 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1698 @item gnu90
1699 @itemx gnu89
1700 GNU dialect of ISO C90 (including some C99 features).
1702 @item gnu99
1703 @itemx gnu9x
1704 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1706 @item gnu11
1707 @itemx gnu1x
1708 GNU dialect of ISO C11.  This is the default for C code.
1709 The name @samp{gnu1x} is deprecated.
1711 @item c++98
1712 @itemx c++03
1713 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1714 additional defect reports. Same as @option{-ansi} for C++ code.
1716 @item gnu++98
1717 @itemx gnu++03
1718 GNU dialect of @option{-std=c++98}.  This is the default for
1719 C++ code.
1721 @item c++11
1722 @itemx c++0x
1723 The 2011 ISO C++ standard plus amendments.
1724 The name @samp{c++0x} is deprecated.
1726 @item gnu++11
1727 @itemx gnu++0x
1728 GNU dialect of @option{-std=c++11}.
1729 The name @samp{gnu++0x} is deprecated.
1731 @item c++14
1732 @itemx c++1y
1733 The 2014 ISO C++ standard plus amendments.
1734 The name @samp{c++1y} is deprecated.
1736 @item gnu++14
1737 @itemx gnu++1y
1738 GNU dialect of @option{-std=c++14}.
1739 The name @samp{gnu++1y} is deprecated.
1741 @item c++1z
1742 The next revision of the ISO C++ standard, tentatively planned for
1743 2017.  Support is highly experimental, and will almost certainly
1744 change in incompatible ways in future releases.
1746 @item gnu++1z
1747 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1748 and will almost certainly change in incompatible ways in future
1749 releases.
1750 @end table
1752 @item -fgnu89-inline
1753 @opindex fgnu89-inline
1754 The option @option{-fgnu89-inline} tells GCC to use the traditional
1755 GNU semantics for @code{inline} functions when in C99 mode.
1756 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1757 is accepted and ignored by GCC versions 4.1.3 up to but not including
1758 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1759 C99 mode.  Using this option is roughly equivalent to adding the
1760 @code{gnu_inline} function attribute to all inline functions
1761 (@pxref{Function Attributes}).
1763 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1764 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1765 specifies the default behavior).  This option was first supported in
1766 GCC 4.3.  This option is not supported in @option{-std=c90} or
1767 @option{-std=gnu90} mode.
1769 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1770 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1771 in effect for @code{inline} functions.  @xref{Common Predefined
1772 Macros,,,cpp,The C Preprocessor}.
1774 @item -aux-info @var{filename}
1775 @opindex aux-info
1776 Output to the given filename prototyped declarations for all functions
1777 declared and/or defined in a translation unit, including those in header
1778 files.  This option is silently ignored in any language other than C@.
1780 Besides declarations, the file indicates, in comments, the origin of
1781 each declaration (source file and line), whether the declaration was
1782 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1783 @samp{O} for old, respectively, in the first character after the line
1784 number and the colon), and whether it came from a declaration or a
1785 definition (@samp{C} or @samp{F}, respectively, in the following
1786 character).  In the case of function definitions, a K&R-style list of
1787 arguments followed by their declarations is also provided, inside
1788 comments, after the declaration.
1790 @item -fallow-parameterless-variadic-functions
1791 @opindex fallow-parameterless-variadic-functions
1792 Accept variadic functions without named parameters.
1794 Although it is possible to define such a function, this is not very
1795 useful as it is not possible to read the arguments.  This is only
1796 supported for C as this construct is allowed by C++.
1798 @item -fno-asm
1799 @opindex fno-asm
1800 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1801 keyword, so that code can use these words as identifiers.  You can use
1802 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1803 instead.  @option{-ansi} implies @option{-fno-asm}.
1805 In C++, this switch only affects the @code{typeof} keyword, since
1806 @code{asm} and @code{inline} are standard keywords.  You may want to
1807 use the @option{-fno-gnu-keywords} flag instead, which has the same
1808 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1809 switch only affects the @code{asm} and @code{typeof} keywords, since
1810 @code{inline} is a standard keyword in ISO C99.
1812 @item -fno-builtin
1813 @itemx -fno-builtin-@var{function}
1814 @opindex fno-builtin
1815 @cindex built-in functions
1816 Don't recognize built-in functions that do not begin with
1817 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1818 functions provided by GCC}, for details of the functions affected,
1819 including those which are not built-in functions when @option{-ansi} or
1820 @option{-std} options for strict ISO C conformance are used because they
1821 do not have an ISO standard meaning.
1823 GCC normally generates special code to handle certain built-in functions
1824 more efficiently; for instance, calls to @code{alloca} may become single
1825 instructions which adjust the stack directly, and calls to @code{memcpy}
1826 may become inline copy loops.  The resulting code is often both smaller
1827 and faster, but since the function calls no longer appear as such, you
1828 cannot set a breakpoint on those calls, nor can you change the behavior
1829 of the functions by linking with a different library.  In addition,
1830 when a function is recognized as a built-in function, GCC may use
1831 information about that function to warn about problems with calls to
1832 that function, or to generate more efficient code, even if the
1833 resulting code still contains calls to that function.  For example,
1834 warnings are given with @option{-Wformat} for bad calls to
1835 @code{printf} when @code{printf} is built in and @code{strlen} is
1836 known not to modify global memory.
1838 With the @option{-fno-builtin-@var{function}} option
1839 only the built-in function @var{function} is
1840 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1841 function is named that is not built-in in this version of GCC, this
1842 option is ignored.  There is no corresponding
1843 @option{-fbuiltin-@var{function}} option; if you wish to enable
1844 built-in functions selectively when using @option{-fno-builtin} or
1845 @option{-ffreestanding}, you may define macros such as:
1847 @smallexample
1848 #define abs(n)          __builtin_abs ((n))
1849 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1850 @end smallexample
1852 @item -fhosted
1853 @opindex fhosted
1854 @cindex hosted environment
1856 Assert that compilation targets a hosted environment.  This implies
1857 @option{-fbuiltin}.  A hosted environment is one in which the
1858 entire standard library is available, and in which @code{main} has a return
1859 type of @code{int}.  Examples are nearly everything except a kernel.
1860 This is equivalent to @option{-fno-freestanding}.
1862 @item -ffreestanding
1863 @opindex ffreestanding
1864 @cindex hosted environment
1866 Assert that compilation targets a freestanding environment.  This
1867 implies @option{-fno-builtin}.  A freestanding environment
1868 is one in which the standard library may not exist, and program startup may
1869 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1870 This is equivalent to @option{-fno-hosted}.
1872 @xref{Standards,,Language Standards Supported by GCC}, for details of
1873 freestanding and hosted environments.
1875 @item -fopenmp
1876 @opindex fopenmp
1877 @cindex OpenMP parallel
1878 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1879 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1880 compiler generates parallel code according to the OpenMP Application
1881 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1882 implies @option{-pthread}, and thus is only supported on targets that
1883 have support for @option{-pthread}. @option{-fopenmp} implies
1884 @option{-fopenmp-simd}.
1886 @item -fopenmp-simd
1887 @opindex fopenmp-simd
1888 @cindex OpenMP SIMD
1889 @cindex SIMD
1890 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1891 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1892 are ignored.
1894 @item -fcilkplus
1895 @opindex fcilkplus
1896 @cindex Enable Cilk Plus
1897 Enable the usage of Cilk Plus language extension features for C/C++.
1898 When the option @option{-fcilkplus} is specified, enable the usage of
1899 the Cilk Plus Language extension features for C/C++.  The present
1900 implementation follows ABI version 1.2.  This is an experimental
1901 feature that is only partially complete, and whose interface may
1902 change in future versions of GCC as the official specification
1903 changes.  Currently, all features but @code{_Cilk_for} have been
1904 implemented.
1906 @item -fgnu-tm
1907 @opindex fgnu-tm
1908 When the option @option{-fgnu-tm} is specified, the compiler
1909 generates code for the Linux variant of Intel's current Transactional
1910 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1911 an experimental feature whose interface may change in future versions
1912 of GCC, as the official specification changes.  Please note that not
1913 all architectures are supported for this feature.
1915 For more information on GCC's support for transactional memory,
1916 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1917 Transactional Memory Library}.
1919 Note that the transactional memory feature is not supported with
1920 non-call exceptions (@option{-fnon-call-exceptions}).
1922 @item -fms-extensions
1923 @opindex fms-extensions
1924 Accept some non-standard constructs used in Microsoft header files.
1926 In C++ code, this allows member names in structures to be similar
1927 to previous types declarations.
1929 @smallexample
1930 typedef int UOW;
1931 struct ABC @{
1932   UOW UOW;
1934 @end smallexample
1936 Some cases of unnamed fields in structures and unions are only
1937 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1938 fields within structs/unions}, for details.
1940 Note that this option is off for all targets but i?86 and x86_64
1941 targets using ms-abi.
1942 @item -fplan9-extensions
1943 Accept some non-standard constructs used in Plan 9 code.
1945 This enables @option{-fms-extensions}, permits passing pointers to
1946 structures with anonymous fields to functions that expect pointers to
1947 elements of the type of the field, and permits referring to anonymous
1948 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1949 struct/union fields within structs/unions}, for details.  This is only
1950 supported for C, not C++.
1952 @item -trigraphs
1953 @opindex trigraphs
1954 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1955 options for strict ISO C conformance) implies @option{-trigraphs}.
1957 @cindex traditional C language
1958 @cindex C language, traditional
1959 @item -traditional
1960 @itemx -traditional-cpp
1961 @opindex traditional-cpp
1962 @opindex traditional
1963 Formerly, these options caused GCC to attempt to emulate a pre-standard
1964 C compiler.  They are now only supported with the @option{-E} switch.
1965 The preprocessor continues to support a pre-standard mode.  See the GNU
1966 CPP manual for details.
1968 @item -fcond-mismatch
1969 @opindex fcond-mismatch
1970 Allow conditional expressions with mismatched types in the second and
1971 third arguments.  The value of such an expression is void.  This option
1972 is not supported for C++.
1974 @item -flax-vector-conversions
1975 @opindex flax-vector-conversions
1976 Allow implicit conversions between vectors with differing numbers of
1977 elements and/or incompatible element types.  This option should not be
1978 used for new code.
1980 @item -funsigned-char
1981 @opindex funsigned-char
1982 Let the type @code{char} be unsigned, like @code{unsigned char}.
1984 Each kind of machine has a default for what @code{char} should
1985 be.  It is either like @code{unsigned char} by default or like
1986 @code{signed char} by default.
1988 Ideally, a portable program should always use @code{signed char} or
1989 @code{unsigned char} when it depends on the signedness of an object.
1990 But many programs have been written to use plain @code{char} and
1991 expect it to be signed, or expect it to be unsigned, depending on the
1992 machines they were written for.  This option, and its inverse, let you
1993 make such a program work with the opposite default.
1995 The type @code{char} is always a distinct type from each of
1996 @code{signed char} or @code{unsigned char}, even though its behavior
1997 is always just like one of those two.
1999 @item -fsigned-char
2000 @opindex fsigned-char
2001 Let the type @code{char} be signed, like @code{signed char}.
2003 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2004 the negative form of @option{-funsigned-char}.  Likewise, the option
2005 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2007 @item -fsigned-bitfields
2008 @itemx -funsigned-bitfields
2009 @itemx -fno-signed-bitfields
2010 @itemx -fno-unsigned-bitfields
2011 @opindex fsigned-bitfields
2012 @opindex funsigned-bitfields
2013 @opindex fno-signed-bitfields
2014 @opindex fno-unsigned-bitfields
2015 These options control whether a bit-field is signed or unsigned, when the
2016 declaration does not use either @code{signed} or @code{unsigned}.  By
2017 default, such a bit-field is signed, because this is consistent: the
2018 basic integer types such as @code{int} are signed types.
2019 @end table
2021 @node C++ Dialect Options
2022 @section Options Controlling C++ Dialect
2024 @cindex compiler options, C++
2025 @cindex C++ options, command-line
2026 @cindex options, C++
2027 This section describes the command-line options that are only meaningful
2028 for C++ programs.  You can also use most of the GNU compiler options
2029 regardless of what language your program is in.  For example, you
2030 might compile a file @code{firstClass.C} like this:
2032 @smallexample
2033 g++ -g -frepo -O -c firstClass.C
2034 @end smallexample
2036 @noindent
2037 In this example, only @option{-frepo} is an option meant
2038 only for C++ programs; you can use the other options with any
2039 language supported by GCC@.
2041 Here is a list of options that are @emph{only} for compiling C++ programs:
2043 @table @gcctabopt
2045 @item -fabi-version=@var{n}
2046 @opindex fabi-version
2047 Use version @var{n} of the C++ ABI@.  The default is version 0.
2049 Version 0 refers to the version conforming most closely to
2050 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2051 will change in different versions of G++ as ABI bugs are fixed.
2053 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2055 Version 2 is the version of the C++ ABI that first appeared in G++
2056 3.4, and was the default through G++ 4.9.
2058 Version 3 corrects an error in mangling a constant address as a
2059 template argument.
2061 Version 4, which first appeared in G++ 4.5, implements a standard
2062 mangling for vector types.
2064 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2065 attribute const/volatile on function pointer types, decltype of a
2066 plain decl, and use of a function parameter in the declaration of
2067 another parameter.
2069 Version 6, which first appeared in G++ 4.7, corrects the promotion
2070 behavior of C++11 scoped enums and the mangling of template argument
2071 packs, const/static_cast, prefix ++ and --, and a class scope function
2072 used as a template argument.
2074 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2075 builtin type and corrects the mangling of lambdas in default argument
2076 scope.
2078 Version 8, which first appeared in G++ 4.9, corrects the substitution
2079 behavior of function types with function-cv-qualifiers.
2081 See also @option{-Wabi}.
2083 @item -fabi-compat-version=@var{n}
2084 @opindex fabi-compat-version
2085 Starting with GCC 4.5, on targets that support strong aliases, G++
2086 works around mangling changes by creating an alias with the correct
2087 mangled name when defining a symbol with an incorrect mangled name.
2088 This switch specifies which ABI version to use for the alias.
2090 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2091 another ABI version is explicitly selected, this defaults to 0.
2093 The compatibility version is also set by @option{-Wabi=@var{n}}.
2095 @item -fno-access-control
2096 @opindex fno-access-control
2097 Turn off all access checking.  This switch is mainly useful for working
2098 around bugs in the access control code.
2100 @item -fcheck-new
2101 @opindex fcheck-new
2102 Check that the pointer returned by @code{operator new} is non-null
2103 before attempting to modify the storage allocated.  This check is
2104 normally unnecessary because the C++ standard specifies that
2105 @code{operator new} only returns @code{0} if it is declared
2106 @samp{throw()}, in which case the compiler always checks the
2107 return value even without this option.  In all other cases, when
2108 @code{operator new} has a non-empty exception specification, memory
2109 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2110 @samp{new (nothrow)}.
2112 @item -fconstexpr-depth=@var{n}
2113 @opindex fconstexpr-depth
2114 Set the maximum nested evaluation depth for C++11 constexpr functions
2115 to @var{n}.  A limit is needed to detect endless recursion during
2116 constant expression evaluation.  The minimum specified by the standard
2117 is 512.
2119 @item -fdeduce-init-list
2120 @opindex fdeduce-init-list
2121 Enable deduction of a template type parameter as
2122 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2124 @smallexample
2125 template <class T> auto forward(T t) -> decltype (realfn (t))
2127   return realfn (t);
2130 void f()
2132   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2134 @end smallexample
2136 This deduction was implemented as a possible extension to the
2137 originally proposed semantics for the C++11 standard, but was not part
2138 of the final standard, so it is disabled by default.  This option is
2139 deprecated, and may be removed in a future version of G++.
2141 @item -ffriend-injection
2142 @opindex ffriend-injection
2143 Inject friend functions into the enclosing namespace, so that they are
2144 visible outside the scope of the class in which they are declared.
2145 Friend functions were documented to work this way in the old Annotated
2146 C++ Reference Manual, and versions of G++ before 4.1 always worked
2147 that way.  However, in ISO C++ a friend function that is not declared
2148 in an enclosing scope can only be found using argument dependent
2149 lookup.  This option causes friends to be injected as they were in
2150 earlier releases.
2152 This option is for compatibility, and may be removed in a future
2153 release of G++.
2155 @item -fno-elide-constructors
2156 @opindex fno-elide-constructors
2157 The C++ standard allows an implementation to omit creating a temporary
2158 that is only used to initialize another object of the same type.
2159 Specifying this option disables that optimization, and forces G++ to
2160 call the copy constructor in all cases.
2162 @item -fno-enforce-eh-specs
2163 @opindex fno-enforce-eh-specs
2164 Don't generate code to check for violation of exception specifications
2165 at run time.  This option violates the C++ standard, but may be useful
2166 for reducing code size in production builds, much like defining
2167 @samp{NDEBUG}.  This does not give user code permission to throw
2168 exceptions in violation of the exception specifications; the compiler
2169 still optimizes based on the specifications, so throwing an
2170 unexpected exception results in undefined behavior at run time.
2172 @item -fextern-tls-init
2173 @itemx -fno-extern-tls-init
2174 @opindex fextern-tls-init
2175 @opindex fno-extern-tls-init
2176 The C++11 and OpenMP standards allow @samp{thread_local} and
2177 @samp{threadprivate} variables to have dynamic (runtime)
2178 initialization.  To support this, any use of such a variable goes
2179 through a wrapper function that performs any necessary initialization.
2180 When the use and definition of the variable are in the same
2181 translation unit, this overhead can be optimized away, but when the
2182 use is in a different translation unit there is significant overhead
2183 even if the variable doesn't actually need dynamic initialization.  If
2184 the programmer can be sure that no use of the variable in a
2185 non-defining TU needs to trigger dynamic initialization (either
2186 because the variable is statically initialized, or a use of the
2187 variable in the defining TU will be executed before any uses in
2188 another TU), they can avoid this overhead with the
2189 @option{-fno-extern-tls-init} option.
2191 On targets that support symbol aliases, the default is
2192 @option{-fextern-tls-init}.  On targets that do not support symbol
2193 aliases, the default is @option{-fno-extern-tls-init}.
2195 @item -ffor-scope
2196 @itemx -fno-for-scope
2197 @opindex ffor-scope
2198 @opindex fno-for-scope
2199 If @option{-ffor-scope} is specified, the scope of variables declared in
2200 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2201 as specified by the C++ standard.
2202 If @option{-fno-for-scope} is specified, the scope of variables declared in
2203 a @i{for-init-statement} extends to the end of the enclosing scope,
2204 as was the case in old versions of G++, and other (traditional)
2205 implementations of C++.
2207 If neither flag is given, the default is to follow the standard,
2208 but to allow and give a warning for old-style code that would
2209 otherwise be invalid, or have different behavior.
2211 @item -fno-gnu-keywords
2212 @opindex fno-gnu-keywords
2213 Do not recognize @code{typeof} as a keyword, so that code can use this
2214 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2215 @option{-ansi} implies @option{-fno-gnu-keywords}.
2217 @item -fno-implicit-templates
2218 @opindex fno-implicit-templates
2219 Never emit code for non-inline templates that are instantiated
2220 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2221 @xref{Template Instantiation}, for more information.
2223 @item -fno-implicit-inline-templates
2224 @opindex fno-implicit-inline-templates
2225 Don't emit code for implicit instantiations of inline templates, either.
2226 The default is to handle inlines differently so that compiles with and
2227 without optimization need the same set of explicit instantiations.
2229 @item -fno-implement-inlines
2230 @opindex fno-implement-inlines
2231 To save space, do not emit out-of-line copies of inline functions
2232 controlled by @samp{#pragma implementation}.  This causes linker
2233 errors if these functions are not inlined everywhere they are called.
2235 @item -fms-extensions
2236 @opindex fms-extensions
2237 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2238 int and getting a pointer to member function via non-standard syntax.
2240 @item -fno-nonansi-builtins
2241 @opindex fno-nonansi-builtins
2242 Disable built-in declarations of functions that are not mandated by
2243 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2244 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2246 @item -fnothrow-opt
2247 @opindex fnothrow-opt
2248 Treat a @code{throw()} exception specification as if it were a
2249 @code{noexcept} specification to reduce or eliminate the text size
2250 overhead relative to a function with no exception specification.  If
2251 the function has local variables of types with non-trivial
2252 destructors, the exception specification actually makes the
2253 function smaller because the EH cleanups for those variables can be
2254 optimized away.  The semantic effect is that an exception thrown out of
2255 a function with such an exception specification results in a call
2256 to @code{terminate} rather than @code{unexpected}.
2258 @item -fno-operator-names
2259 @opindex fno-operator-names
2260 Do not treat the operator name keywords @code{and}, @code{bitand},
2261 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2262 synonyms as keywords.
2264 @item -fno-optional-diags
2265 @opindex fno-optional-diags
2266 Disable diagnostics that the standard says a compiler does not need to
2267 issue.  Currently, the only such diagnostic issued by G++ is the one for
2268 a name having multiple meanings within a class.
2270 @item -fpermissive
2271 @opindex fpermissive
2272 Downgrade some diagnostics about nonconformant code from errors to
2273 warnings.  Thus, using @option{-fpermissive} allows some
2274 nonconforming code to compile.
2276 @item -fno-pretty-templates
2277 @opindex fno-pretty-templates
2278 When an error message refers to a specialization of a function
2279 template, the compiler normally prints the signature of the
2280 template followed by the template arguments and any typedefs or
2281 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2282 rather than @code{void f(int)}) so that it's clear which template is
2283 involved.  When an error message refers to a specialization of a class
2284 template, the compiler omits any template arguments that match
2285 the default template arguments for that template.  If either of these
2286 behaviors make it harder to understand the error message rather than
2287 easier, you can use @option{-fno-pretty-templates} to disable them.
2289 @item -frepo
2290 @opindex frepo
2291 Enable automatic template instantiation at link time.  This option also
2292 implies @option{-fno-implicit-templates}.  @xref{Template
2293 Instantiation}, for more information.
2295 @item -fno-rtti
2296 @opindex fno-rtti
2297 Disable generation of information about every class with virtual
2298 functions for use by the C++ run-time type identification features
2299 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2300 of the language, you can save some space by using this flag.  Note that
2301 exception handling uses the same information, but G++ generates it as
2302 needed. The @samp{dynamic_cast} operator can still be used for casts that
2303 do not require run-time type information, i.e.@: casts to @code{void *} or to
2304 unambiguous base classes.
2306 @item -fstats
2307 @opindex fstats
2308 Emit statistics about front-end processing at the end of the compilation.
2309 This information is generally only useful to the G++ development team.
2311 @item -fstrict-enums
2312 @opindex fstrict-enums
2313 Allow the compiler to optimize using the assumption that a value of
2314 enumerated type can only be one of the values of the enumeration (as
2315 defined in the C++ standard; basically, a value that can be
2316 represented in the minimum number of bits needed to represent all the
2317 enumerators).  This assumption may not be valid if the program uses a
2318 cast to convert an arbitrary integer value to the enumerated type.
2320 @item -ftemplate-backtrace-limit=@var{n}
2321 @opindex ftemplate-backtrace-limit
2322 Set the maximum number of template instantiation notes for a single
2323 warning or error to @var{n}.  The default value is 10.
2325 @item -ftemplate-depth=@var{n}
2326 @opindex ftemplate-depth
2327 Set the maximum instantiation depth for template classes to @var{n}.
2328 A limit on the template instantiation depth is needed to detect
2329 endless recursions during template class instantiation.  ANSI/ISO C++
2330 conforming programs must not rely on a maximum depth greater than 17
2331 (changed to 1024 in C++11).  The default value is 900, as the compiler
2332 can run out of stack space before hitting 1024 in some situations.
2334 @item -fno-threadsafe-statics
2335 @opindex fno-threadsafe-statics
2336 Do not emit the extra code to use the routines specified in the C++
2337 ABI for thread-safe initialization of local statics.  You can use this
2338 option to reduce code size slightly in code that doesn't need to be
2339 thread-safe.
2341 @item -fuse-cxa-atexit
2342 @opindex fuse-cxa-atexit
2343 Register destructors for objects with static storage duration with the
2344 @code{__cxa_atexit} function rather than the @code{atexit} function.
2345 This option is required for fully standards-compliant handling of static
2346 destructors, but only works if your C library supports
2347 @code{__cxa_atexit}.
2349 @item -fno-use-cxa-get-exception-ptr
2350 @opindex fno-use-cxa-get-exception-ptr
2351 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2352 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2353 if the runtime routine is not available.
2355 @item -fvisibility-inlines-hidden
2356 @opindex fvisibility-inlines-hidden
2357 This switch declares that the user does not attempt to compare
2358 pointers to inline functions or methods where the addresses of the two functions
2359 are taken in different shared objects.
2361 The effect of this is that GCC may, effectively, mark inline methods with
2362 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2363 appear in the export table of a DSO and do not require a PLT indirection
2364 when used within the DSO@.  Enabling this option can have a dramatic effect
2365 on load and link times of a DSO as it massively reduces the size of the
2366 dynamic export table when the library makes heavy use of templates.
2368 The behavior of this switch is not quite the same as marking the
2369 methods as hidden directly, because it does not affect static variables
2370 local to the function or cause the compiler to deduce that
2371 the function is defined in only one shared object.
2373 You may mark a method as having a visibility explicitly to negate the
2374 effect of the switch for that method.  For example, if you do want to
2375 compare pointers to a particular inline method, you might mark it as
2376 having default visibility.  Marking the enclosing class with explicit
2377 visibility has no effect.
2379 Explicitly instantiated inline methods are unaffected by this option
2380 as their linkage might otherwise cross a shared library boundary.
2381 @xref{Template Instantiation}.
2383 @item -fvisibility-ms-compat
2384 @opindex fvisibility-ms-compat
2385 This flag attempts to use visibility settings to make GCC's C++
2386 linkage model compatible with that of Microsoft Visual Studio.
2388 The flag makes these changes to GCC's linkage model:
2390 @enumerate
2391 @item
2392 It sets the default visibility to @code{hidden}, like
2393 @option{-fvisibility=hidden}.
2395 @item
2396 Types, but not their members, are not hidden by default.
2398 @item
2399 The One Definition Rule is relaxed for types without explicit
2400 visibility specifications that are defined in more than one
2401 shared object: those declarations are permitted if they are
2402 permitted when this option is not used.
2403 @end enumerate
2405 In new code it is better to use @option{-fvisibility=hidden} and
2406 export those classes that are intended to be externally visible.
2407 Unfortunately it is possible for code to rely, perhaps accidentally,
2408 on the Visual Studio behavior.
2410 Among the consequences of these changes are that static data members
2411 of the same type with the same name but defined in different shared
2412 objects are different, so changing one does not change the other;
2413 and that pointers to function members defined in different shared
2414 objects may not compare equal.  When this flag is given, it is a
2415 violation of the ODR to define types with the same name differently.
2417 @item -fvtable-verify=@var{std|preinit|none}
2418 @opindex fvtable-verify
2419 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2420 feature that verifies at runtime, for every virtual call that is made, that
2421 the vtable pointer through which the call is made is valid for the type of
2422 the object, and has not been corrupted or overwritten.  If an invalid vtable
2423 pointer is detected (at runtime), an error is reported and execution of the
2424 program is immediately halted.
2426 This option causes runtime data structures to be built, at program start up,
2427 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2428 control the timing of when these data structures are built.  In both cases the
2429 data structures are built before execution reaches 'main'.  The
2430 @option{-fvtable-verify=std} causes these data structure to be built after the
2431 shared libraries have been loaded and initialized.
2432 @option{-fvtable-verify=preinit} causes them to be built before the shared
2433 libraries have been loaded and initialized.
2435 If this option appears multiple times in the compiler line, with different
2436 values specified, 'none' will take highest priority over both 'std' and
2437 'preinit'; 'preinit' will take priority over 'std'.
2439 @item -fvtv-debug
2440 @opindex (fvtv-debug)
2441 Causes debug versions of the runtime functions for the vtable verification 
2442 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2443 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2444 compiler to keep track of which vtable pointers it found for each class, and
2445 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2446 file directory on the user's machine.
2448 Note:  This feature APPENDS data to the log file. If you want a fresh log
2449 file, be sure to delete any existing one.
2451 @item -fvtv-counts
2452 @opindex fvtv-counts
2453 This is a debugging flag.  When used in conjunction with
2454 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2455 causes the compiler to keep track of the total number of virtual calls
2456 it encountered and the number of verifications it inserted.  It also
2457 counts the number of calls to certain runtime library functions
2458 that it inserts.  This information, for each compilation unit, is written
2459 to a file named ``vtv_count_data.log'', in the dump_file directory on
2460 the user's machine.   It also counts the size of the vtable pointer sets
2461 for each class, and writes this information to ``vtv_class_set_sizes.log''
2462 in the same directory.
2464 Note:  This feature APPENDS data to the log files.  To get a fresh log
2465 files, be sure to delete any existing ones.
2467 @item -fno-weak
2468 @opindex fno-weak
2469 Do not use weak symbol support, even if it is provided by the linker.
2470 By default, G++ uses weak symbols if they are available.  This
2471 option exists only for testing, and should not be used by end-users;
2472 it results in inferior code and has no benefits.  This option may
2473 be removed in a future release of G++.
2475 @item -nostdinc++
2476 @opindex nostdinc++
2477 Do not search for header files in the standard directories specific to
2478 C++, but do still search the other standard directories.  (This option
2479 is used when building the C++ library.)
2480 @end table
2482 In addition, these optimization, warning, and code generation options
2483 have meanings only for C++ programs:
2485 @table @gcctabopt
2486 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2487 @opindex Wabi
2488 @opindex Wno-abi
2489 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2490 G++ to warn when it generates code that is probably not compatible with the
2491 vendor-neutral C++ ABI@.  Since G++ now defaults to
2492 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2493 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2494 or an older compatibility version is selected (with
2495 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2497 Although an effort has been made to warn about
2498 all such cases, there are probably some cases that are not warned about,
2499 even though G++ is generating incompatible code.  There may also be
2500 cases where warnings are emitted even though the code that is generated
2501 is compatible.
2503 You should rewrite your code to avoid these warnings if you are
2504 concerned about the fact that code generated by G++ may not be binary
2505 compatible with code generated by other compilers.
2507 @option{-Wabi} can also be used with an explicit version number to
2508 warn about compatibility with a particular @option{-fabi-version}
2509 level, e.g. @option{-Wabi=2} to warn about changes relative to
2510 @option{-fabi-version=2}.  Specifying a version number also sets
2511 @option{-fabi-compat-version=@var{n}}.
2513 The known incompatibilities in @option{-fabi-version=2} (which was the
2514 default from GCC 3.4 to 4.9) include:
2516 @itemize @bullet
2518 @item
2519 A template with a non-type template parameter of reference type was
2520 mangled incorrectly:
2521 @smallexample
2522 extern int N;
2523 template <int &> struct S @{@};
2524 void n (S<N>) @{2@}
2525 @end smallexample
2527 This was fixed in @option{-fabi-version=3}.
2529 @item
2530 SIMD vector types declared using @code{__attribute ((vector_size))} were
2531 mangled in a non-standard way that does not allow for overloading of
2532 functions taking vectors of different sizes.
2534 The mangling was changed in @option{-fabi-version=4}.
2536 @item
2537 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2538 qualifiers, and @code{decltype} of a plain declaration was folded away.
2540 These mangling issues were fixed in @option{-fabi-version=5}.
2542 @item
2543 Scoped enumerators passed as arguments to a variadic function are
2544 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2545 On most targets this does not actually affect the parameter passing
2546 ABI, as there is no way to pass an argument smaller than @samp{int}.
2548 Also, the ABI changed the mangling of template argument packs,
2549 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2550 a class scope function used as a template argument.
2552 These issues were corrected in @option{-fabi-version=6}.
2554 @item
2555 Lambdas in default argument scope were mangled incorrectly, and the
2556 ABI changed the mangling of nullptr_t.
2558 These issues were corrected in @option{-fabi-version=7}.
2560 @item
2561 When mangling a function type with function-cv-qualifiers, the
2562 un-qualified function type was incorrectly treated as a substitution
2563 candidate.
2565 This was fixed in @option{-fabi-version=8}.
2566 @end itemize
2568 It also warns about psABI-related changes.  The known psABI changes at this
2569 point include:
2571 @itemize @bullet
2573 @item
2574 For SysV/x86-64, unions with @code{long double} members are 
2575 passed in memory as specified in psABI.  For example:
2577 @smallexample
2578 union U @{
2579   long double ld;
2580   int i;
2582 @end smallexample
2584 @noindent
2585 @code{union U} is always passed in memory.
2587 @end itemize
2589 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2590 @opindex Wctor-dtor-privacy
2591 @opindex Wno-ctor-dtor-privacy
2592 Warn when a class seems unusable because all the constructors or
2593 destructors in that class are private, and it has neither friends nor
2594 public static member functions.  Also warn if there are no non-private
2595 methods, and there's at least one private member function that isn't
2596 a constructor or destructor.
2598 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2599 @opindex Wdelete-non-virtual-dtor
2600 @opindex Wno-delete-non-virtual-dtor
2601 Warn when @samp{delete} is used to destroy an instance of a class that
2602 has virtual functions and non-virtual destructor. It is unsafe to delete
2603 an instance of a derived class through a pointer to a base class if the
2604 base class does not have a virtual destructor.  This warning is enabled
2605 by @option{-Wall}.
2607 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2608 @opindex Wliteral-suffix
2609 @opindex Wno-literal-suffix
2610 Warn when a string or character literal is followed by a ud-suffix which does
2611 not begin with an underscore.  As a conforming extension, GCC treats such
2612 suffixes as separate preprocessing tokens in order to maintain backwards
2613 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2614 For example:
2616 @smallexample
2617 #define __STDC_FORMAT_MACROS
2618 #include <inttypes.h>
2619 #include <stdio.h>
2621 int main() @{
2622   int64_t i64 = 123;
2623   printf("My int64: %"PRId64"\n", i64);
2625 @end smallexample
2627 In this case, @code{PRId64} is treated as a separate preprocessing token.
2629 This warning is enabled by default.
2631 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2632 @opindex Wnarrowing
2633 @opindex Wno-narrowing
2634 Warn when a narrowing conversion prohibited by C++11 occurs within
2635 @samp{@{ @}}, e.g.
2637 @smallexample
2638 int i = @{ 2.2 @}; // error: narrowing from double to int
2639 @end smallexample
2641 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2643 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses for
2644 non-constants the diagnostic required by the standard.  Note that this
2645 does not affect the meaning of well-formed code; narrowing conversions
2646 are still considered ill-formed in SFINAE context.
2648 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2649 @opindex Wnoexcept
2650 @opindex Wno-noexcept
2651 Warn when a noexcept-expression evaluates to false because of a call
2652 to a function that does not have a non-throwing exception
2653 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2654 the compiler to never throw an exception.
2656 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2657 @opindex Wnon-virtual-dtor
2658 @opindex Wno-non-virtual-dtor
2659 Warn when a class has virtual functions and an accessible non-virtual
2660 destructor itself or in an accessible polymorphic base class, in which
2661 case it is possible but unsafe to delete an instance of a derived
2662 class through a pointer to the class itself or base class.  This
2663 warning is automatically enabled if @option{-Weffc++} is specified.
2665 @item -Wreorder @r{(C++ and Objective-C++ only)}
2666 @opindex Wreorder
2667 @opindex Wno-reorder
2668 @cindex reordering, warning
2669 @cindex warning for reordering of member initializers
2670 Warn when the order of member initializers given in the code does not
2671 match the order in which they must be executed.  For instance:
2673 @smallexample
2674 struct A @{
2675   int i;
2676   int j;
2677   A(): j (0), i (1) @{ @}
2679 @end smallexample
2681 @noindent
2682 The compiler rearranges the member initializers for @samp{i}
2683 and @samp{j} to match the declaration order of the members, emitting
2684 a warning to that effect.  This warning is enabled by @option{-Wall}.
2686 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2687 @opindex fext-numeric-literals
2688 @opindex fno-ext-numeric-literals
2689 Accept imaginary, fixed-point, or machine-defined
2690 literal number suffixes as GNU extensions.
2691 When this option is turned off these suffixes are treated
2692 as C++11 user-defined literal numeric suffixes.
2693 This is on by default for all pre-C++11 dialects and all GNU dialects:
2694 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2695 @option{-std=gnu++14}.
2696 This option is off by default
2697 for ISO C++11 onwards (@option{-std=c++11}, ...).
2698 @end table
2700 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2702 @table @gcctabopt
2703 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2704 @opindex Weffc++
2705 @opindex Wno-effc++
2706 Warn about violations of the following style guidelines from Scott Meyers'
2707 @cite{Effective C++} series of books:
2709 @itemize @bullet
2710 @item
2711 Define a copy constructor and an assignment operator for classes
2712 with dynamically-allocated memory.
2714 @item
2715 Prefer initialization to assignment in constructors.
2717 @item
2718 Have @code{operator=} return a reference to @code{*this}.
2720 @item
2721 Don't try to return a reference when you must return an object.
2723 @item
2724 Distinguish between prefix and postfix forms of increment and
2725 decrement operators.
2727 @item
2728 Never overload @code{&&}, @code{||}, or @code{,}.
2730 @end itemize
2732 This option also enables @option{-Wnon-virtual-dtor}, which is also
2733 one of the effective C++ recommendations.  However, the check is
2734 extended to warn about the lack of virtual destructor in accessible
2735 non-polymorphic bases classes too.
2737 When selecting this option, be aware that the standard library
2738 headers do not obey all of these guidelines; use @samp{grep -v}
2739 to filter out those warnings.
2741 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2742 @opindex Wstrict-null-sentinel
2743 @opindex Wno-strict-null-sentinel
2744 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2745 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2746 to @code{__null}.  Although it is a null pointer constant rather than a
2747 null pointer, it is guaranteed to be of the same size as a pointer.
2748 But this use is not portable across different compilers.
2750 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2751 @opindex Wno-non-template-friend
2752 @opindex Wnon-template-friend
2753 Disable warnings when non-templatized friend functions are declared
2754 within a template.  Since the advent of explicit template specification
2755 support in G++, if the name of the friend is an unqualified-id (i.e.,
2756 @samp{friend foo(int)}), the C++ language specification demands that the
2757 friend declare or define an ordinary, nontemplate function.  (Section
2758 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2759 could be interpreted as a particular specialization of a templatized
2760 function.  Because this non-conforming behavior is no longer the default
2761 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2762 check existing code for potential trouble spots and is on by default.
2763 This new compiler behavior can be turned off with
2764 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2765 but disables the helpful warning.
2767 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2768 @opindex Wold-style-cast
2769 @opindex Wno-old-style-cast
2770 Warn if an old-style (C-style) cast to a non-void type is used within
2771 a C++ program.  The new-style casts (@samp{dynamic_cast},
2772 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2773 less vulnerable to unintended effects and much easier to search for.
2775 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2776 @opindex Woverloaded-virtual
2777 @opindex Wno-overloaded-virtual
2778 @cindex overloaded virtual function, warning
2779 @cindex warning for overloaded virtual function
2780 Warn when a function declaration hides virtual functions from a
2781 base class.  For example, in:
2783 @smallexample
2784 struct A @{
2785   virtual void f();
2788 struct B: public A @{
2789   void f(int);
2791 @end smallexample
2793 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2794 like:
2796 @smallexample
2797 B* b;
2798 b->f();
2799 @end smallexample
2801 @noindent
2802 fails to compile.
2804 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2805 @opindex Wno-pmf-conversions
2806 @opindex Wpmf-conversions
2807 Disable the diagnostic for converting a bound pointer to member function
2808 to a plain pointer.
2810 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2811 @opindex Wsign-promo
2812 @opindex Wno-sign-promo
2813 Warn when overload resolution chooses a promotion from unsigned or
2814 enumerated type to a signed type, over a conversion to an unsigned type of
2815 the same size.  Previous versions of G++ tried to preserve
2816 unsignedness, but the standard mandates the current behavior.
2817 @end table
2819 @node Objective-C and Objective-C++ Dialect Options
2820 @section Options Controlling Objective-C and Objective-C++ Dialects
2822 @cindex compiler options, Objective-C and Objective-C++
2823 @cindex Objective-C and Objective-C++ options, command-line
2824 @cindex options, Objective-C and Objective-C++
2825 (NOTE: This manual does not describe the Objective-C and Objective-C++
2826 languages themselves.  @xref{Standards,,Language Standards
2827 Supported by GCC}, for references.)
2829 This section describes the command-line options that are only meaningful
2830 for Objective-C and Objective-C++ programs.  You can also use most of
2831 the language-independent GNU compiler options.
2832 For example, you might compile a file @code{some_class.m} like this:
2834 @smallexample
2835 gcc -g -fgnu-runtime -O -c some_class.m
2836 @end smallexample
2838 @noindent
2839 In this example, @option{-fgnu-runtime} is an option meant only for
2840 Objective-C and Objective-C++ programs; you can use the other options with
2841 any language supported by GCC@.
2843 Note that since Objective-C is an extension of the C language, Objective-C
2844 compilations may also use options specific to the C front-end (e.g.,
2845 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2846 C++-specific options (e.g., @option{-Wabi}).
2848 Here is a list of options that are @emph{only} for compiling Objective-C
2849 and Objective-C++ programs:
2851 @table @gcctabopt
2852 @item -fconstant-string-class=@var{class-name}
2853 @opindex fconstant-string-class
2854 Use @var{class-name} as the name of the class to instantiate for each
2855 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2856 class name is @code{NXConstantString} if the GNU runtime is being used, and
2857 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2858 @option{-fconstant-cfstrings} option, if also present, overrides the
2859 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2860 to be laid out as constant CoreFoundation strings.
2862 @item -fgnu-runtime
2863 @opindex fgnu-runtime
2864 Generate object code compatible with the standard GNU Objective-C
2865 runtime.  This is the default for most types of systems.
2867 @item -fnext-runtime
2868 @opindex fnext-runtime
2869 Generate output compatible with the NeXT runtime.  This is the default
2870 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2871 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2872 used.
2874 @item -fno-nil-receivers
2875 @opindex fno-nil-receivers
2876 Assume that all Objective-C message dispatches (@code{[receiver
2877 message:arg]}) in this translation unit ensure that the receiver is
2878 not @code{nil}.  This allows for more efficient entry points in the
2879 runtime to be used.  This option is only available in conjunction with
2880 the NeXT runtime and ABI version 0 or 1.
2882 @item -fobjc-abi-version=@var{n}
2883 @opindex fobjc-abi-version
2884 Use version @var{n} of the Objective-C ABI for the selected runtime.
2885 This option is currently supported only for the NeXT runtime.  In that
2886 case, Version 0 is the traditional (32-bit) ABI without support for
2887 properties and other Objective-C 2.0 additions.  Version 1 is the
2888 traditional (32-bit) ABI with support for properties and other
2889 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2890 nothing is specified, the default is Version 0 on 32-bit target
2891 machines, and Version 2 on 64-bit target machines.
2893 @item -fobjc-call-cxx-cdtors
2894 @opindex fobjc-call-cxx-cdtors
2895 For each Objective-C class, check if any of its instance variables is a
2896 C++ object with a non-trivial default constructor.  If so, synthesize a
2897 special @code{- (id) .cxx_construct} instance method which runs
2898 non-trivial default constructors on any such instance variables, in order,
2899 and then return @code{self}.  Similarly, check if any instance variable
2900 is a C++ object with a non-trivial destructor, and if so, synthesize a
2901 special @code{- (void) .cxx_destruct} method which runs
2902 all such default destructors, in reverse order.
2904 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2905 methods thusly generated only operate on instance variables
2906 declared in the current Objective-C class, and not those inherited
2907 from superclasses.  It is the responsibility of the Objective-C
2908 runtime to invoke all such methods in an object's inheritance
2909 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2910 by the runtime immediately after a new object instance is allocated;
2911 the @code{- (void) .cxx_destruct} methods are invoked immediately
2912 before the runtime deallocates an object instance.
2914 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2915 support for invoking the @code{- (id) .cxx_construct} and
2916 @code{- (void) .cxx_destruct} methods.
2918 @item -fobjc-direct-dispatch
2919 @opindex fobjc-direct-dispatch
2920 Allow fast jumps to the message dispatcher.  On Darwin this is
2921 accomplished via the comm page.
2923 @item -fobjc-exceptions
2924 @opindex fobjc-exceptions
2925 Enable syntactic support for structured exception handling in
2926 Objective-C, similar to what is offered by C++ and Java.  This option
2927 is required to use the Objective-C keywords @code{@@try},
2928 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2929 @code{@@synchronized}.  This option is available with both the GNU
2930 runtime and the NeXT runtime (but not available in conjunction with
2931 the NeXT runtime on Mac OS X 10.2 and earlier).
2933 @item -fobjc-gc
2934 @opindex fobjc-gc
2935 Enable garbage collection (GC) in Objective-C and Objective-C++
2936 programs.  This option is only available with the NeXT runtime; the
2937 GNU runtime has a different garbage collection implementation that
2938 does not require special compiler flags.
2940 @item -fobjc-nilcheck
2941 @opindex fobjc-nilcheck
2942 For the NeXT runtime with version 2 of the ABI, check for a nil
2943 receiver in method invocations before doing the actual method call.
2944 This is the default and can be disabled using
2945 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2946 checked for nil in this way no matter what this flag is set to.
2947 Currently this flag does nothing when the GNU runtime, or an older
2948 version of the NeXT runtime ABI, is used.
2950 @item -fobjc-std=objc1
2951 @opindex fobjc-std
2952 Conform to the language syntax of Objective-C 1.0, the language
2953 recognized by GCC 4.0.  This only affects the Objective-C additions to
2954 the C/C++ language; it does not affect conformance to C/C++ standards,
2955 which is controlled by the separate C/C++ dialect option flags.  When
2956 this option is used with the Objective-C or Objective-C++ compiler,
2957 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2958 This is useful if you need to make sure that your Objective-C code can
2959 be compiled with older versions of GCC@.
2961 @item -freplace-objc-classes
2962 @opindex freplace-objc-classes
2963 Emit a special marker instructing @command{ld(1)} not to statically link in
2964 the resulting object file, and allow @command{dyld(1)} to load it in at
2965 run time instead.  This is used in conjunction with the Fix-and-Continue
2966 debugging mode, where the object file in question may be recompiled and
2967 dynamically reloaded in the course of program execution, without the need
2968 to restart the program itself.  Currently, Fix-and-Continue functionality
2969 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2970 and later.
2972 @item -fzero-link
2973 @opindex fzero-link
2974 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2975 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2976 compile time) with static class references that get initialized at load time,
2977 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2978 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2979 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2980 for individual class implementations to be modified during program execution.
2981 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2982 regardless of command-line options.
2984 @item -fno-local-ivars
2985 @opindex fno-local-ivars
2986 @opindex flocal-ivars
2987 By default instance variables in Objective-C can be accessed as if
2988 they were local variables from within the methods of the class they're
2989 declared in.  This can lead to shadowing between instance variables
2990 and other variables declared either locally inside a class method or
2991 globally with the same name.  Specifying the @option{-fno-local-ivars}
2992 flag disables this behavior thus avoiding variable shadowing issues.
2994 @item -fivar-visibility=@var{public|protected|private|package}
2995 @opindex fivar-visibility
2996 Set the default instance variable visibility to the specified option
2997 so that instance variables declared outside the scope of any access
2998 modifier directives default to the specified visibility.
3000 @item -gen-decls
3001 @opindex gen-decls
3002 Dump interface declarations for all classes seen in the source file to a
3003 file named @file{@var{sourcename}.decl}.
3005 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3006 @opindex Wassign-intercept
3007 @opindex Wno-assign-intercept
3008 Warn whenever an Objective-C assignment is being intercepted by the
3009 garbage collector.
3011 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3012 @opindex Wno-protocol
3013 @opindex Wprotocol
3014 If a class is declared to implement a protocol, a warning is issued for
3015 every method in the protocol that is not implemented by the class.  The
3016 default behavior is to issue a warning for every method not explicitly
3017 implemented in the class, even if a method implementation is inherited
3018 from the superclass.  If you use the @option{-Wno-protocol} option, then
3019 methods inherited from the superclass are considered to be implemented,
3020 and no warning is issued for them.
3022 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3023 @opindex Wselector
3024 @opindex Wno-selector
3025 Warn if multiple methods of different types for the same selector are
3026 found during compilation.  The check is performed on the list of methods
3027 in the final stage of compilation.  Additionally, a check is performed
3028 for each selector appearing in a @code{@@selector(@dots{})}
3029 expression, and a corresponding method for that selector has been found
3030 during compilation.  Because these checks scan the method table only at
3031 the end of compilation, these warnings are not produced if the final
3032 stage of compilation is not reached, for example because an error is
3033 found during compilation, or because the @option{-fsyntax-only} option is
3034 being used.
3036 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3037 @opindex Wstrict-selector-match
3038 @opindex Wno-strict-selector-match
3039 Warn if multiple methods with differing argument and/or return types are
3040 found for a given selector when attempting to send a message using this
3041 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3042 is off (which is the default behavior), the compiler omits such warnings
3043 if any differences found are confined to types that share the same size
3044 and alignment.
3046 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3047 @opindex Wundeclared-selector
3048 @opindex Wno-undeclared-selector
3049 Warn if a @code{@@selector(@dots{})} expression referring to an
3050 undeclared selector is found.  A selector is considered undeclared if no
3051 method with that name has been declared before the
3052 @code{@@selector(@dots{})} expression, either explicitly in an
3053 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3054 an @code{@@implementation} section.  This option always performs its
3055 checks as soon as a @code{@@selector(@dots{})} expression is found,
3056 while @option{-Wselector} only performs its checks in the final stage of
3057 compilation.  This also enforces the coding style convention
3058 that methods and selectors must be declared before being used.
3060 @item -print-objc-runtime-info
3061 @opindex print-objc-runtime-info
3062 Generate C header describing the largest structure that is passed by
3063 value, if any.
3065 @end table
3067 @node Language Independent Options
3068 @section Options to Control Diagnostic Messages Formatting
3069 @cindex options to control diagnostics formatting
3070 @cindex diagnostic messages
3071 @cindex message formatting
3073 Traditionally, diagnostic messages have been formatted irrespective of
3074 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3075 options described below
3076 to control the formatting algorithm for diagnostic messages, 
3077 e.g.@: how many characters per line, how often source location
3078 information should be reported.  Note that some language front ends may not
3079 honor these options.
3081 @table @gcctabopt
3082 @item -fmessage-length=@var{n}
3083 @opindex fmessage-length
3084 Try to format error messages so that they fit on lines of about
3085 @var{n} characters.  If @var{n} is zero, then no line-wrapping will be
3086 done; each error message will appear on a single line.  This is the
3087 default for all front ends.
3089 @item -fdiagnostics-show-location=once
3090 @opindex fdiagnostics-show-location
3091 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3092 reporter to emit source location information @emph{once}; that is, in
3093 case the message is too long to fit on a single physical line and has to
3094 be wrapped, the source location won't be emitted (as prefix) again,
3095 over and over, in subsequent continuation lines.  This is the default
3096 behavior.
3098 @item -fdiagnostics-show-location=every-line
3099 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3100 messages reporter to emit the same source location information (as
3101 prefix) for physical lines that result from the process of breaking
3102 a message which is too long to fit on a single line.
3104 @item -fdiagnostics-color[=@var{WHEN}]
3105 @itemx -fno-diagnostics-color
3106 @opindex fdiagnostics-color
3107 @cindex highlight, color, colour
3108 @vindex GCC_COLORS @r{environment variable}
3109 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3110 or @samp{auto}.  The default depends on how the compiler has been configured,
3111 it can be any of the above @var{WHEN} options or also @samp{never}
3112 if @env{GCC_COLORS} environment variable isn't present in the environment,
3113 and @samp{auto} otherwise.
3114 @samp{auto} means to use color only when the standard error is a terminal.
3115 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3116 aliases for @option{-fdiagnostics-color=always} and
3117 @option{-fdiagnostics-color=never}, respectively.
3119 The colors are defined by the environment variable @env{GCC_COLORS}.
3120 Its value is a colon-separated list of capabilities and Select Graphic
3121 Rendition (SGR) substrings. SGR commands are interpreted by the
3122 terminal or terminal emulator.  (See the section in the documentation
3123 of your text terminal for permitted values and their meanings as
3124 character attributes.)  These substring values are integers in decimal
3125 representation and can be concatenated with semicolons.
3126 Common values to concatenate include
3127 @samp{1} for bold,
3128 @samp{4} for underline,
3129 @samp{5} for blink,
3130 @samp{7} for inverse,
3131 @samp{39} for default foreground color,
3132 @samp{30} to @samp{37} for foreground colors,
3133 @samp{90} to @samp{97} for 16-color mode foreground colors,
3134 @samp{38;5;0} to @samp{38;5;255}
3135 for 88-color and 256-color modes foreground colors,
3136 @samp{49} for default background color,
3137 @samp{40} to @samp{47} for background colors,
3138 @samp{100} to @samp{107} for 16-color mode background colors,
3139 and @samp{48;5;0} to @samp{48;5;255}
3140 for 88-color and 256-color modes background colors.
3142 The default @env{GCC_COLORS} is
3143 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3144 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3145 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3146 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3147 string disables colors.
3148 Supported capabilities are as follows.
3150 @table @code
3151 @item error=
3152 @vindex error GCC_COLORS @r{capability}
3153 SGR substring for error: markers.
3155 @item warning=
3156 @vindex warning GCC_COLORS @r{capability}
3157 SGR substring for warning: markers.
3159 @item note=
3160 @vindex note GCC_COLORS @r{capability}
3161 SGR substring for note: markers.
3163 @item caret=
3164 @vindex caret GCC_COLORS @r{capability}
3165 SGR substring for caret line.
3167 @item locus=
3168 @vindex locus GCC_COLORS @r{capability}
3169 SGR substring for location information, @samp{file:line} or
3170 @samp{file:line:column} etc.
3172 @item quote=
3173 @vindex quote GCC_COLORS @r{capability}
3174 SGR substring for information printed within quotes.
3175 @end table
3177 @item -fno-diagnostics-show-option
3178 @opindex fno-diagnostics-show-option
3179 @opindex fdiagnostics-show-option
3180 By default, each diagnostic emitted includes text indicating the
3181 command-line option that directly controls the diagnostic (if such an
3182 option is known to the diagnostic machinery).  Specifying the
3183 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3185 @item -fno-diagnostics-show-caret
3186 @opindex fno-diagnostics-show-caret
3187 @opindex fdiagnostics-show-caret
3188 By default, each diagnostic emitted includes the original source line
3189 and a caret '^' indicating the column.  This option suppresses this
3190 information.
3192 @end table
3194 @node Warning Options
3195 @section Options to Request or Suppress Warnings
3196 @cindex options to control warnings
3197 @cindex warning messages
3198 @cindex messages, warning
3199 @cindex suppressing warnings
3201 Warnings are diagnostic messages that report constructions that
3202 are not inherently erroneous but that are risky or suggest there
3203 may have been an error.
3205 The following language-independent options do not enable specific
3206 warnings but control the kinds of diagnostics produced by GCC@.
3208 @table @gcctabopt
3209 @cindex syntax checking
3210 @item -fsyntax-only
3211 @opindex fsyntax-only
3212 Check the code for syntax errors, but don't do anything beyond that.
3214 @item -fmax-errors=@var{n}
3215 @opindex fmax-errors
3216 Limits the maximum number of error messages to @var{n}, at which point
3217 GCC bails out rather than attempting to continue processing the source
3218 code.  If @var{n} is 0 (the default), there is no limit on the number
3219 of error messages produced.  If @option{-Wfatal-errors} is also
3220 specified, then @option{-Wfatal-errors} takes precedence over this
3221 option.
3223 @item -w
3224 @opindex w
3225 Inhibit all warning messages.
3227 @item -Werror
3228 @opindex Werror
3229 @opindex Wno-error
3230 Make all warnings into errors.
3232 @item -Werror=
3233 @opindex Werror=
3234 @opindex Wno-error=
3235 Make the specified warning into an error.  The specifier for a warning
3236 is appended; for example @option{-Werror=switch} turns the warnings
3237 controlled by @option{-Wswitch} into errors.  This switch takes a
3238 negative form, to be used to negate @option{-Werror} for specific
3239 warnings; for example @option{-Wno-error=switch} makes
3240 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3241 is in effect.
3243 The warning message for each controllable warning includes the
3244 option that controls the warning.  That option can then be used with
3245 @option{-Werror=} and @option{-Wno-error=} as described above.
3246 (Printing of the option in the warning message can be disabled using the
3247 @option{-fno-diagnostics-show-option} flag.)
3249 Note that specifying @option{-Werror=}@var{foo} automatically implies
3250 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3251 imply anything.
3253 @item -Wfatal-errors
3254 @opindex Wfatal-errors
3255 @opindex Wno-fatal-errors
3256 This option causes the compiler to abort compilation on the first error
3257 occurred rather than trying to keep going and printing further error
3258 messages.
3260 @end table
3262 You can request many specific warnings with options beginning with
3263 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3264 implicit declarations.  Each of these specific warning options also
3265 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3266 example, @option{-Wno-implicit}.  This manual lists only one of the
3267 two forms, whichever is not the default.  For further
3268 language-specific options also refer to @ref{C++ Dialect Options} and
3269 @ref{Objective-C and Objective-C++ Dialect Options}.
3271 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3272 options, such as @option{-Wunused}, which may turn on further options,
3273 such as @option{-Wunused-value}. The combined effect of positive and
3274 negative forms is that more specific options have priority over less
3275 specific ones, independently of their position in the command-line. For
3276 options of the same specificity, the last one takes effect. Options
3277 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3278 as if they appeared at the end of the command-line.
3280 When an unrecognized warning option is requested (e.g.,
3281 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3282 that the option is not recognized.  However, if the @option{-Wno-} form
3283 is used, the behavior is slightly different: no diagnostic is
3284 produced for @option{-Wno-unknown-warning} unless other diagnostics
3285 are being produced.  This allows the use of new @option{-Wno-} options
3286 with old compilers, but if something goes wrong, the compiler
3287 warns that an unrecognized option is present.
3289 @table @gcctabopt
3290 @item -Wpedantic
3291 @itemx -pedantic
3292 @opindex pedantic
3293 @opindex Wpedantic
3294 Issue all the warnings demanded by strict ISO C and ISO C++;
3295 reject all programs that use forbidden extensions, and some other
3296 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3297 version of the ISO C standard specified by any @option{-std} option used.
3299 Valid ISO C and ISO C++ programs should compile properly with or without
3300 this option (though a rare few require @option{-ansi} or a
3301 @option{-std} option specifying the required version of ISO C)@.  However,
3302 without this option, certain GNU extensions and traditional C and C++
3303 features are supported as well.  With this option, they are rejected.
3305 @option{-Wpedantic} does not cause warning messages for use of the
3306 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3307 warnings are also disabled in the expression that follows
3308 @code{__extension__}.  However, only system header files should use
3309 these escape routes; application programs should avoid them.
3310 @xref{Alternate Keywords}.
3312 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3313 C conformance.  They soon find that it does not do quite what they want:
3314 it finds some non-ISO practices, but not all---only those for which
3315 ISO C @emph{requires} a diagnostic, and some others for which
3316 diagnostics have been added.
3318 A feature to report any failure to conform to ISO C might be useful in
3319 some instances, but would require considerable additional work and would
3320 be quite different from @option{-Wpedantic}.  We don't have plans to
3321 support such a feature in the near future.
3323 Where the standard specified with @option{-std} represents a GNU
3324 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3325 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3326 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3327 where they are required by the base standard.  (It does not make sense
3328 for such warnings to be given only for features not in the specified GNU
3329 C dialect, since by definition the GNU dialects of C include all
3330 features the compiler supports with the given option, and there would be
3331 nothing to warn about.)
3333 @item -pedantic-errors
3334 @opindex pedantic-errors
3335 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3336 requires a diagnostic, in some cases where there is undefined behavior
3337 at compile-time and in some other cases that do not prevent compilation
3338 of programs that are valid according to the standard. This is not
3339 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3340 by this option and not enabled by the latter and vice versa.
3342 @item -Wall
3343 @opindex Wall
3344 @opindex Wno-all
3345 This enables all the warnings about constructions that some users
3346 consider questionable, and that are easy to avoid (or modify to
3347 prevent the warning), even in conjunction with macros.  This also
3348 enables some language-specific warnings described in @ref{C++ Dialect
3349 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3351 @option{-Wall} turns on the following warning flags:
3353 @gccoptlist{-Waddress   @gol
3354 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3355 -Wc++11-compat  @gol
3356 -Wchar-subscripts  @gol
3357 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3358 -Wimplicit-int @r{(C and Objective-C only)} @gol
3359 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3360 -Wcomment  @gol
3361 -Wformat   @gol
3362 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3363 -Wmaybe-uninitialized @gol
3364 -Wmissing-braces @r{(only for C/ObjC)} @gol
3365 -Wnonnull  @gol
3366 -Wopenmp-simd @gol
3367 -Wparentheses  @gol
3368 -Wpointer-sign  @gol
3369 -Wreorder   @gol
3370 -Wreturn-type  @gol
3371 -Wsequence-point  @gol
3372 -Wsign-compare @r{(only in C++)}  @gol
3373 -Wstrict-aliasing  @gol
3374 -Wstrict-overflow=1  @gol
3375 -Wswitch  @gol
3376 -Wtrigraphs  @gol
3377 -Wuninitialized  @gol
3378 -Wunknown-pragmas  @gol
3379 -Wunused-function  @gol
3380 -Wunused-label     @gol
3381 -Wunused-value     @gol
3382 -Wunused-variable  @gol
3383 -Wvolatile-register-var @gol
3386 Note that some warning flags are not implied by @option{-Wall}.  Some of
3387 them warn about constructions that users generally do not consider
3388 questionable, but which occasionally you might wish to check for;
3389 others warn about constructions that are necessary or hard to avoid in
3390 some cases, and there is no simple way to modify the code to suppress
3391 the warning. Some of them are enabled by @option{-Wextra} but many of
3392 them must be enabled individually.
3394 @item -Wextra
3395 @opindex W
3396 @opindex Wextra
3397 @opindex Wno-extra
3398 This enables some extra warning flags that are not enabled by
3399 @option{-Wall}. (This option used to be called @option{-W}.  The older
3400 name is still supported, but the newer name is more descriptive.)
3402 @gccoptlist{-Wclobbered  @gol
3403 -Wempty-body  @gol
3404 -Wignored-qualifiers @gol
3405 -Wmissing-field-initializers  @gol
3406 -Wmissing-parameter-type @r{(C only)}  @gol
3407 -Wold-style-declaration @r{(C only)}  @gol
3408 -Woverride-init  @gol
3409 -Wsign-compare  @gol
3410 -Wtype-limits  @gol
3411 -Wuninitialized  @gol
3412 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3413 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3416 The option @option{-Wextra} also prints warning messages for the
3417 following cases:
3419 @itemize @bullet
3421 @item
3422 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3423 @samp{>}, or @samp{>=}.
3425 @item
3426 (C++ only) An enumerator and a non-enumerator both appear in a
3427 conditional expression.
3429 @item
3430 (C++ only) Ambiguous virtual bases.
3432 @item
3433 (C++ only) Subscripting an array that has been declared @samp{register}.
3435 @item
3436 (C++ only) Taking the address of a variable that has been declared
3437 @samp{register}.
3439 @item
3440 (C++ only) A base class is not initialized in a derived class's copy
3441 constructor.
3443 @end itemize
3445 @item -Wchar-subscripts
3446 @opindex Wchar-subscripts
3447 @opindex Wno-char-subscripts
3448 Warn if an array subscript has type @code{char}.  This is a common cause
3449 of error, as programmers often forget that this type is signed on some
3450 machines.
3451 This warning is enabled by @option{-Wall}.
3453 @item -Wcomment
3454 @opindex Wcomment
3455 @opindex Wno-comment
3456 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3457 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3458 This warning is enabled by @option{-Wall}.
3460 @item -Wno-coverage-mismatch
3461 @opindex Wno-coverage-mismatch
3462 Warn if feedback profiles do not match when using the
3463 @option{-fprofile-use} option.
3464 If a source file is changed between compiling with @option{-fprofile-gen} and
3465 with @option{-fprofile-use}, the files with the profile feedback can fail
3466 to match the source file and GCC cannot use the profile feedback
3467 information.  By default, this warning is enabled and is treated as an
3468 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3469 warning or @option{-Wno-error=coverage-mismatch} can be used to
3470 disable the error.  Disabling the error for this warning can result in
3471 poorly optimized code and is useful only in the
3472 case of very minor changes such as bug fixes to an existing code-base.
3473 Completely disabling the warning is not recommended.
3475 @item -Wno-cpp
3476 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3478 Suppress warning messages emitted by @code{#warning} directives.
3480 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3481 @opindex Wdouble-promotion
3482 @opindex Wno-double-promotion
3483 Give a warning when a value of type @code{float} is implicitly
3484 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3485 floating-point unit implement @code{float} in hardware, but emulate
3486 @code{double} in software.  On such a machine, doing computations
3487 using @code{double} values is much more expensive because of the
3488 overhead required for software emulation.
3490 It is easy to accidentally do computations with @code{double} because
3491 floating-point literals are implicitly of type @code{double}.  For
3492 example, in:
3493 @smallexample
3494 @group
3495 float area(float radius)
3497    return 3.14159 * radius * radius;
3499 @end group
3500 @end smallexample
3501 the compiler performs the entire computation with @code{double}
3502 because the floating-point literal is a @code{double}.
3504 @item -Wformat
3505 @itemx -Wformat=@var{n}
3506 @opindex Wformat
3507 @opindex Wno-format
3508 @opindex ffreestanding
3509 @opindex fno-builtin
3510 @opindex Wformat=
3511 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3512 the arguments supplied have types appropriate to the format string
3513 specified, and that the conversions specified in the format string make
3514 sense.  This includes standard functions, and others specified by format
3515 attributes (@pxref{Function Attributes}), in the @code{printf},
3516 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3517 not in the C standard) families (or other target-specific families).
3518 Which functions are checked without format attributes having been
3519 specified depends on the standard version selected, and such checks of
3520 functions without the attribute specified are disabled by
3521 @option{-ffreestanding} or @option{-fno-builtin}.
3523 The formats are checked against the format features supported by GNU
3524 libc version 2.2.  These include all ISO C90 and C99 features, as well
3525 as features from the Single Unix Specification and some BSD and GNU
3526 extensions.  Other library implementations may not support all these
3527 features; GCC does not support warning about features that go beyond a
3528 particular library's limitations.  However, if @option{-Wpedantic} is used
3529 with @option{-Wformat}, warnings are given about format features not
3530 in the selected standard version (but not for @code{strfmon} formats,
3531 since those are not in any version of the C standard).  @xref{C Dialect
3532 Options,,Options Controlling C Dialect}.
3534 @table @gcctabopt
3535 @item -Wformat=1
3536 @itemx -Wformat
3537 @opindex Wformat
3538 @opindex Wformat=1
3539 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3540 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3541 @option{-Wformat} also checks for null format arguments for several
3542 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3543 aspects of this level of format checking can be disabled by the
3544 options: @option{-Wno-format-contains-nul},
3545 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3546 @option{-Wformat} is enabled by @option{-Wall}.
3548 @item -Wno-format-contains-nul
3549 @opindex Wno-format-contains-nul
3550 @opindex Wformat-contains-nul
3551 If @option{-Wformat} is specified, do not warn about format strings that
3552 contain NUL bytes.
3554 @item -Wno-format-extra-args
3555 @opindex Wno-format-extra-args
3556 @opindex Wformat-extra-args
3557 If @option{-Wformat} is specified, do not warn about excess arguments to a
3558 @code{printf} or @code{scanf} format function.  The C standard specifies
3559 that such arguments are ignored.
3561 Where the unused arguments lie between used arguments that are
3562 specified with @samp{$} operand number specifications, normally
3563 warnings are still given, since the implementation could not know what
3564 type to pass to @code{va_arg} to skip the unused arguments.  However,
3565 in the case of @code{scanf} formats, this option suppresses the
3566 warning if the unused arguments are all pointers, since the Single
3567 Unix Specification says that such unused arguments are allowed.
3569 @item -Wno-format-zero-length
3570 @opindex Wno-format-zero-length
3571 @opindex Wformat-zero-length
3572 If @option{-Wformat} is specified, do not warn about zero-length formats.
3573 The C standard specifies that zero-length formats are allowed.
3576 @item -Wformat=2
3577 @opindex Wformat=2
3578 Enable @option{-Wformat} plus additional format checks.  Currently
3579 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3580 -Wformat-signedness -Wformat-y2k}.
3582 @item -Wformat-nonliteral
3583 @opindex Wformat-nonliteral
3584 @opindex Wno-format-nonliteral
3585 If @option{-Wformat} is specified, also warn if the format string is not a
3586 string literal and so cannot be checked, unless the format function
3587 takes its format arguments as a @code{va_list}.
3589 @item -Wformat-security
3590 @opindex Wformat-security
3591 @opindex Wno-format-security
3592 If @option{-Wformat} is specified, also warn about uses of format
3593 functions that represent possible security problems.  At present, this
3594 warns about calls to @code{printf} and @code{scanf} functions where the
3595 format string is not a string literal and there are no format arguments,
3596 as in @code{printf (foo);}.  This may be a security hole if the format
3597 string came from untrusted input and contains @samp{%n}.  (This is
3598 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3599 in future warnings may be added to @option{-Wformat-security} that are not
3600 included in @option{-Wformat-nonliteral}.)
3602 @item -Wformat-signedness
3603 @opindex Wformat-signedness
3604 @opindex Wno-format-signedness
3605 If @option{-Wformat} is specified, also warn if the format string
3606 requires an unsigned argument and the argument is signed and vice versa.
3608 @item -Wformat-y2k
3609 @opindex Wformat-y2k
3610 @opindex Wno-format-y2k
3611 If @option{-Wformat} is specified, also warn about @code{strftime}
3612 formats that may yield only a two-digit year.
3613 @end table
3615 @item -Wnonnull
3616 @opindex Wnonnull
3617 @opindex Wno-nonnull
3618 Warn about passing a null pointer for arguments marked as
3619 requiring a non-null value by the @code{nonnull} function attribute.
3621 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3622 can be disabled with the @option{-Wno-nonnull} option.
3624 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3625 @opindex Winit-self
3626 @opindex Wno-init-self
3627 Warn about uninitialized variables that are initialized with themselves.
3628 Note this option can only be used with the @option{-Wuninitialized} option.
3630 For example, GCC warns about @code{i} being uninitialized in the
3631 following snippet only when @option{-Winit-self} has been specified:
3632 @smallexample
3633 @group
3634 int f()
3636   int i = i;
3637   return i;
3639 @end group
3640 @end smallexample
3642 This warning is enabled by @option{-Wall} in C++.
3644 @item -Wimplicit-int @r{(C and Objective-C only)}
3645 @opindex Wimplicit-int
3646 @opindex Wno-implicit-int
3647 Warn when a declaration does not specify a type.
3648 This warning is enabled by @option{-Wall}.
3650 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3651 @opindex Wimplicit-function-declaration
3652 @opindex Wno-implicit-function-declaration
3653 Give a warning whenever a function is used before being declared. In
3654 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3655 enabled by default and it is made into an error by
3656 @option{-pedantic-errors}. This warning is also enabled by
3657 @option{-Wall}.
3659 @item -Wimplicit @r{(C and Objective-C only)}
3660 @opindex Wimplicit
3661 @opindex Wno-implicit
3662 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3663 This warning is enabled by @option{-Wall}.
3665 @item -Wignored-qualifiers @r{(C and C++ only)}
3666 @opindex Wignored-qualifiers
3667 @opindex Wno-ignored-qualifiers
3668 Warn if the return type of a function has a type qualifier
3669 such as @code{const}.  For ISO C such a type qualifier has no effect,
3670 since the value returned by a function is not an lvalue.
3671 For C++, the warning is only emitted for scalar types or @code{void}.
3672 ISO C prohibits qualified @code{void} return types on function
3673 definitions, so such return types always receive a warning
3674 even without this option.
3676 This warning is also enabled by @option{-Wextra}.
3678 @item -Wmain
3679 @opindex Wmain
3680 @opindex Wno-main
3681 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3682 a function with external linkage, returning int, taking either zero
3683 arguments, two, or three arguments of appropriate types.  This warning
3684 is enabled by default in C++ and is enabled by either @option{-Wall}
3685 or @option{-Wpedantic}.
3687 @item -Wmissing-braces
3688 @opindex Wmissing-braces
3689 @opindex Wno-missing-braces
3690 Warn if an aggregate or union initializer is not fully bracketed.  In
3691 the following example, the initializer for @samp{a} is not fully
3692 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3693 enabled by @option{-Wall} in C.
3695 @smallexample
3696 int a[2][2] = @{ 0, 1, 2, 3 @};
3697 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3698 @end smallexample
3700 This warning is enabled by @option{-Wall}.
3702 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3703 @opindex Wmissing-include-dirs
3704 @opindex Wno-missing-include-dirs
3705 Warn if a user-supplied include directory does not exist.
3707 @item -Wparentheses
3708 @opindex Wparentheses
3709 @opindex Wno-parentheses
3710 Warn if parentheses are omitted in certain contexts, such
3711 as when there is an assignment in a context where a truth value
3712 is expected, or when operators are nested whose precedence people
3713 often get confused about.
3715 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3716 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3717 interpretation from that of ordinary mathematical notation.
3719 Also warn about constructions where there may be confusion to which
3720 @code{if} statement an @code{else} branch belongs.  Here is an example of
3721 such a case:
3723 @smallexample
3724 @group
3726   if (a)
3727     if (b)
3728       foo ();
3729   else
3730     bar ();
3732 @end group
3733 @end smallexample
3735 In C/C++, every @code{else} branch belongs to the innermost possible
3736 @code{if} statement, which in this example is @code{if (b)}.  This is
3737 often not what the programmer expected, as illustrated in the above
3738 example by indentation the programmer chose.  When there is the
3739 potential for this confusion, GCC issues a warning when this flag
3740 is specified.  To eliminate the warning, add explicit braces around
3741 the innermost @code{if} statement so there is no way the @code{else}
3742 can belong to the enclosing @code{if}.  The resulting code
3743 looks like this:
3745 @smallexample
3746 @group
3748   if (a)
3749     @{
3750       if (b)
3751         foo ();
3752       else
3753         bar ();
3754     @}
3756 @end group
3757 @end smallexample
3759 Also warn for dangerous uses of the GNU extension to
3760 @code{?:} with omitted middle operand. When the condition
3761 in the @code{?}: operator is a boolean expression, the omitted value is
3762 always 1.  Often programmers expect it to be a value computed
3763 inside the conditional expression instead.
3765 This warning is enabled by @option{-Wall}.
3767 @item -Wsequence-point
3768 @opindex Wsequence-point
3769 @opindex Wno-sequence-point
3770 Warn about code that may have undefined semantics because of violations
3771 of sequence point rules in the C and C++ standards.
3773 The C and C++ standards define the order in which expressions in a C/C++
3774 program are evaluated in terms of @dfn{sequence points}, which represent
3775 a partial ordering between the execution of parts of the program: those
3776 executed before the sequence point, and those executed after it.  These
3777 occur after the evaluation of a full expression (one which is not part
3778 of a larger expression), after the evaluation of the first operand of a
3779 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3780 function is called (but after the evaluation of its arguments and the
3781 expression denoting the called function), and in certain other places.
3782 Other than as expressed by the sequence point rules, the order of
3783 evaluation of subexpressions of an expression is not specified.  All
3784 these rules describe only a partial order rather than a total order,
3785 since, for example, if two functions are called within one expression
3786 with no sequence point between them, the order in which the functions
3787 are called is not specified.  However, the standards committee have
3788 ruled that function calls do not overlap.
3790 It is not specified when between sequence points modifications to the
3791 values of objects take effect.  Programs whose behavior depends on this
3792 have undefined behavior; the C and C++ standards specify that ``Between
3793 the previous and next sequence point an object shall have its stored
3794 value modified at most once by the evaluation of an expression.
3795 Furthermore, the prior value shall be read only to determine the value
3796 to be stored.''.  If a program breaks these rules, the results on any
3797 particular implementation are entirely unpredictable.
3799 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3800 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3801 diagnosed by this option, and it may give an occasional false positive
3802 result, but in general it has been found fairly effective at detecting
3803 this sort of problem in programs.
3805 The standard is worded confusingly, therefore there is some debate
3806 over the precise meaning of the sequence point rules in subtle cases.
3807 Links to discussions of the problem, including proposed formal
3808 definitions, may be found on the GCC readings page, at
3809 @uref{http://gcc.gnu.org/@/readings.html}.
3811 This warning is enabled by @option{-Wall} for C and C++.
3813 @item -Wno-return-local-addr
3814 @opindex Wno-return-local-addr
3815 @opindex Wreturn-local-addr
3816 Do not warn about returning a pointer (or in C++, a reference) to a
3817 variable that goes out of scope after the function returns.
3819 @item -Wreturn-type
3820 @opindex Wreturn-type
3821 @opindex Wno-return-type
3822 Warn whenever a function is defined with a return type that defaults
3823 to @code{int}.  Also warn about any @code{return} statement with no
3824 return value in a function whose return type is not @code{void}
3825 (falling off the end of the function body is considered returning
3826 without a value), and about a @code{return} statement with an
3827 expression in a function whose return type is @code{void}.
3829 For C++, a function without return type always produces a diagnostic
3830 message, even when @option{-Wno-return-type} is specified.  The only
3831 exceptions are @samp{main} and functions defined in system headers.
3833 This warning is enabled by @option{-Wall}.
3835 @item -Wshift-count-negative
3836 @opindex Wshift-count-negative
3837 @opindex Wno-shift-count-negative
3838 Warn if shift count is negative. This warning is enabled by default.
3840 @item -Wshift-count-overflow
3841 @opindex Wshift-count-overflow
3842 @opindex Wno-shift-count-overflow
3843 Warn if shift count >= width of type. This warning is enabled by default.
3845 @item -Wswitch
3846 @opindex Wswitch
3847 @opindex Wno-switch
3848 Warn whenever a @code{switch} statement has an index of enumerated type
3849 and lacks a @code{case} for one or more of the named codes of that
3850 enumeration.  (The presence of a @code{default} label prevents this
3851 warning.)  @code{case} labels outside the enumeration range also
3852 provoke warnings when this option is used (even if there is a
3853 @code{default} label).
3854 This warning is enabled by @option{-Wall}.
3856 @item -Wswitch-default
3857 @opindex Wswitch-default
3858 @opindex Wno-switch-default
3859 Warn whenever a @code{switch} statement does not have a @code{default}
3860 case.
3862 @item -Wswitch-enum
3863 @opindex Wswitch-enum
3864 @opindex Wno-switch-enum
3865 Warn whenever a @code{switch} statement has an index of enumerated type
3866 and lacks a @code{case} for one or more of the named codes of that
3867 enumeration.  @code{case} labels outside the enumeration range also
3868 provoke warnings when this option is used.  The only difference
3869 between @option{-Wswitch} and this option is that this option gives a
3870 warning about an omitted enumeration code even if there is a
3871 @code{default} label.
3873 @item -Wswitch-bool
3874 @opindex Wswitch-bool
3875 @opindex Wno-switch-bool
3876 Warn whenever a @code{switch} statement has an index of boolean type.
3877 It is possible to suppress this warning by casting the controlling
3878 expression to a type other than @code{bool}.  For example:
3879 @smallexample
3880 @group
3881 switch ((int) (a == 4))
3882   @{
3883   @dots{}
3884   @}
3885 @end group
3886 @end smallexample
3887 This warning is enabled by default for C and C++ programs.
3889 @item -Wsync-nand @r{(C and C++ only)}
3890 @opindex Wsync-nand
3891 @opindex Wno-sync-nand
3892 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3893 built-in functions are used.  These functions changed semantics in GCC 4.4.
3895 @item -Wtrigraphs
3896 @opindex Wtrigraphs
3897 @opindex Wno-trigraphs
3898 Warn if any trigraphs are encountered that might change the meaning of
3899 the program (trigraphs within comments are not warned about).
3900 This warning is enabled by @option{-Wall}.
3902 @item -Wunused-but-set-parameter
3903 @opindex Wunused-but-set-parameter
3904 @opindex Wno-unused-but-set-parameter
3905 Warn whenever a function parameter is assigned to, but otherwise unused
3906 (aside from its declaration).
3908 To suppress this warning use the @samp{unused} attribute
3909 (@pxref{Variable Attributes}).
3911 This warning is also enabled by @option{-Wunused} together with
3912 @option{-Wextra}.
3914 @item -Wunused-but-set-variable
3915 @opindex Wunused-but-set-variable
3916 @opindex Wno-unused-but-set-variable
3917 Warn whenever a local variable is assigned to, but otherwise unused
3918 (aside from its declaration).
3919 This warning is enabled by @option{-Wall}.
3921 To suppress this warning use the @samp{unused} attribute
3922 (@pxref{Variable Attributes}).
3924 This warning is also enabled by @option{-Wunused}, which is enabled
3925 by @option{-Wall}.
3927 @item -Wunused-function
3928 @opindex Wunused-function
3929 @opindex Wno-unused-function
3930 Warn whenever a static function is declared but not defined or a
3931 non-inline static function is unused.
3932 This warning is enabled by @option{-Wall}.
3934 @item -Wunused-label
3935 @opindex Wunused-label
3936 @opindex Wno-unused-label
3937 Warn whenever a label is declared but not used.
3938 This warning is enabled by @option{-Wall}.
3940 To suppress this warning use the @samp{unused} attribute
3941 (@pxref{Variable Attributes}).
3943 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3944 @opindex Wunused-local-typedefs
3945 Warn when a typedef locally defined in a function is not used.
3946 This warning is enabled by @option{-Wall}.
3948 @item -Wunused-parameter
3949 @opindex Wunused-parameter
3950 @opindex Wno-unused-parameter
3951 Warn whenever a function parameter is unused aside from its declaration.
3953 To suppress this warning use the @samp{unused} attribute
3954 (@pxref{Variable Attributes}).
3956 @item -Wno-unused-result
3957 @opindex Wunused-result
3958 @opindex Wno-unused-result
3959 Do not warn if a caller of a function marked with attribute
3960 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3961 its return value. The default is @option{-Wunused-result}.
3963 @item -Wunused-variable
3964 @opindex Wunused-variable
3965 @opindex Wno-unused-variable
3966 Warn whenever a local variable or non-constant static variable is unused
3967 aside from its declaration.
3968 This warning is enabled by @option{-Wall}.
3970 To suppress this warning use the @samp{unused} attribute
3971 (@pxref{Variable Attributes}).
3973 @item -Wunused-value
3974 @opindex Wunused-value
3975 @opindex Wno-unused-value
3976 Warn whenever a statement computes a result that is explicitly not
3977 used. To suppress this warning cast the unused expression to
3978 @samp{void}. This includes an expression-statement or the left-hand
3979 side of a comma expression that contains no side effects. For example,
3980 an expression such as @samp{x[i,j]} causes a warning, while
3981 @samp{x[(void)i,j]} does not.
3983 This warning is enabled by @option{-Wall}.
3985 @item -Wunused
3986 @opindex Wunused
3987 @opindex Wno-unused
3988 All the above @option{-Wunused} options combined.
3990 In order to get a warning about an unused function parameter, you must
3991 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3992 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3994 @item -Wuninitialized
3995 @opindex Wuninitialized
3996 @opindex Wno-uninitialized
3997 Warn if an automatic variable is used without first being initialized
3998 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3999 warn if a non-static reference or non-static @samp{const} member
4000 appears in a class without constructors.
4002 If you want to warn about code that uses the uninitialized value of the
4003 variable in its own initializer, use the @option{-Winit-self} option.
4005 These warnings occur for individual uninitialized or clobbered
4006 elements of structure, union or array variables as well as for
4007 variables that are uninitialized or clobbered as a whole.  They do
4008 not occur for variables or elements declared @code{volatile}.  Because
4009 these warnings depend on optimization, the exact variables or elements
4010 for which there are warnings depends on the precise optimization
4011 options and version of GCC used.
4013 Note that there may be no warning about a variable that is used only
4014 to compute a value that itself is never used, because such
4015 computations may be deleted by data flow analysis before the warnings
4016 are printed.
4018 @item -Wmaybe-uninitialized
4019 @opindex Wmaybe-uninitialized
4020 @opindex Wno-maybe-uninitialized
4021 For an automatic variable, if there exists a path from the function
4022 entry to a use of the variable that is initialized, but there exist
4023 some other paths for which the variable is not initialized, the compiler
4024 emits a warning if it cannot prove the uninitialized paths are not
4025 executed at run time. These warnings are made optional because GCC is
4026 not smart enough to see all the reasons why the code might be correct
4027 in spite of appearing to have an error.  Here is one example of how
4028 this can happen:
4030 @smallexample
4031 @group
4033   int x;
4034   switch (y)
4035     @{
4036     case 1: x = 1;
4037       break;
4038     case 2: x = 4;
4039       break;
4040     case 3: x = 5;
4041     @}
4042   foo (x);
4044 @end group
4045 @end smallexample
4047 @noindent
4048 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4049 always initialized, but GCC doesn't know this. To suppress the
4050 warning, you need to provide a default case with assert(0) or
4051 similar code.
4053 @cindex @code{longjmp} warnings
4054 This option also warns when a non-volatile automatic variable might be
4055 changed by a call to @code{longjmp}.  These warnings as well are possible
4056 only in optimizing compilation.
4058 The compiler sees only the calls to @code{setjmp}.  It cannot know
4059 where @code{longjmp} will be called; in fact, a signal handler could
4060 call it at any point in the code.  As a result, you may get a warning
4061 even when there is in fact no problem because @code{longjmp} cannot
4062 in fact be called at the place that would cause a problem.
4064 Some spurious warnings can be avoided if you declare all the functions
4065 you use that never return as @code{noreturn}.  @xref{Function
4066 Attributes}.
4068 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4070 @item -Wunknown-pragmas
4071 @opindex Wunknown-pragmas
4072 @opindex Wno-unknown-pragmas
4073 @cindex warning for unknown pragmas
4074 @cindex unknown pragmas, warning
4075 @cindex pragmas, warning of unknown
4076 Warn when a @code{#pragma} directive is encountered that is not understood by 
4077 GCC@.  If this command-line option is used, warnings are even issued
4078 for unknown pragmas in system header files.  This is not the case if
4079 the warnings are only enabled by the @option{-Wall} command-line option.
4081 @item -Wno-pragmas
4082 @opindex Wno-pragmas
4083 @opindex Wpragmas
4084 Do not warn about misuses of pragmas, such as incorrect parameters,
4085 invalid syntax, or conflicts between pragmas.  See also
4086 @option{-Wunknown-pragmas}.
4088 @item -Wstrict-aliasing
4089 @opindex Wstrict-aliasing
4090 @opindex Wno-strict-aliasing
4091 This option is only active when @option{-fstrict-aliasing} is active.
4092 It warns about code that might break the strict aliasing rules that the
4093 compiler is using for optimization.  The warning does not catch all
4094 cases, but does attempt to catch the more common pitfalls.  It is
4095 included in @option{-Wall}.
4096 It is equivalent to @option{-Wstrict-aliasing=3}
4098 @item -Wstrict-aliasing=n
4099 @opindex Wstrict-aliasing=n
4100 This option is only active when @option{-fstrict-aliasing} is active.
4101 It warns about code that might break the strict aliasing rules that the
4102 compiler is using for optimization.
4103 Higher levels correspond to higher accuracy (fewer false positives).
4104 Higher levels also correspond to more effort, similar to the way @option{-O} 
4105 works.
4106 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4108 Level 1: Most aggressive, quick, least accurate.
4109 Possibly useful when higher levels
4110 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4111 false negatives.  However, it has many false positives.
4112 Warns for all pointer conversions between possibly incompatible types,
4113 even if never dereferenced.  Runs in the front end only.
4115 Level 2: Aggressive, quick, not too precise.
4116 May still have many false positives (not as many as level 1 though),
4117 and few false negatives (but possibly more than level 1).
4118 Unlike level 1, it only warns when an address is taken.  Warns about
4119 incomplete types.  Runs in the front end only.
4121 Level 3 (default for @option{-Wstrict-aliasing}):
4122 Should have very few false positives and few false
4123 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4124 Takes care of the common pun+dereference pattern in the front end:
4125 @code{*(int*)&some_float}.
4126 If optimization is enabled, it also runs in the back end, where it deals
4127 with multiple statement cases using flow-sensitive points-to information.
4128 Only warns when the converted pointer is dereferenced.
4129 Does not warn about incomplete types.
4131 @item -Wstrict-overflow
4132 @itemx -Wstrict-overflow=@var{n}
4133 @opindex Wstrict-overflow
4134 @opindex Wno-strict-overflow
4135 This option is only active when @option{-fstrict-overflow} is active.
4136 It warns about cases where the compiler optimizes based on the
4137 assumption that signed overflow does not occur.  Note that it does not
4138 warn about all cases where the code might overflow: it only warns
4139 about cases where the compiler implements some optimization.  Thus
4140 this warning depends on the optimization level.
4142 An optimization that assumes that signed overflow does not occur is
4143 perfectly safe if the values of the variables involved are such that
4144 overflow never does, in fact, occur.  Therefore this warning can
4145 easily give a false positive: a warning about code that is not
4146 actually a problem.  To help focus on important issues, several
4147 warning levels are defined.  No warnings are issued for the use of
4148 undefined signed overflow when estimating how many iterations a loop
4149 requires, in particular when determining whether a loop will be
4150 executed at all.
4152 @table @gcctabopt
4153 @item -Wstrict-overflow=1
4154 Warn about cases that are both questionable and easy to avoid.  For
4155 example,  with @option{-fstrict-overflow}, the compiler simplifies
4156 @code{x + 1 > x} to @code{1}.  This level of
4157 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4158 are not, and must be explicitly requested.
4160 @item -Wstrict-overflow=2
4161 Also warn about other cases where a comparison is simplified to a
4162 constant.  For example: @code{abs (x) >= 0}.  This can only be
4163 simplified when @option{-fstrict-overflow} is in effect, because
4164 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4165 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4166 @option{-Wstrict-overflow=2}.
4168 @item -Wstrict-overflow=3
4169 Also warn about other cases where a comparison is simplified.  For
4170 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4172 @item -Wstrict-overflow=4
4173 Also warn about other simplifications not covered by the above cases.
4174 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4176 @item -Wstrict-overflow=5
4177 Also warn about cases where the compiler reduces the magnitude of a
4178 constant involved in a comparison.  For example: @code{x + 2 > y} is
4179 simplified to @code{x + 1 >= y}.  This is reported only at the
4180 highest warning level because this simplification applies to many
4181 comparisons, so this warning level gives a very large number of
4182 false positives.
4183 @end table
4185 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4186 @opindex Wsuggest-attribute=
4187 @opindex Wno-suggest-attribute=
4188 Warn for cases where adding an attribute may be beneficial. The
4189 attributes currently supported are listed below.
4191 @table @gcctabopt
4192 @item -Wsuggest-attribute=pure
4193 @itemx -Wsuggest-attribute=const
4194 @itemx -Wsuggest-attribute=noreturn
4195 @opindex Wsuggest-attribute=pure
4196 @opindex Wno-suggest-attribute=pure
4197 @opindex Wsuggest-attribute=const
4198 @opindex Wno-suggest-attribute=const
4199 @opindex Wsuggest-attribute=noreturn
4200 @opindex Wno-suggest-attribute=noreturn
4202 Warn about functions that might be candidates for attributes
4203 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4204 functions visible in other compilation units or (in the case of @code{pure} and
4205 @code{const}) if it cannot prove that the function returns normally. A function
4206 returns normally if it doesn't contain an infinite loop or return abnormally
4207 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4208 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4209 higher.  Higher optimization levels improve the accuracy of the analysis.
4211 @item -Wsuggest-attribute=format
4212 @itemx -Wmissing-format-attribute
4213 @opindex Wsuggest-attribute=format
4214 @opindex Wmissing-format-attribute
4215 @opindex Wno-suggest-attribute=format
4216 @opindex Wno-missing-format-attribute
4217 @opindex Wformat
4218 @opindex Wno-format
4220 Warn about function pointers that might be candidates for @code{format}
4221 attributes.  Note these are only possible candidates, not absolute ones.
4222 GCC guesses that function pointers with @code{format} attributes that
4223 are used in assignment, initialization, parameter passing or return
4224 statements should have a corresponding @code{format} attribute in the
4225 resulting type.  I.e.@: the left-hand side of the assignment or
4226 initialization, the type of the parameter variable, or the return type
4227 of the containing function respectively should also have a @code{format}
4228 attribute to avoid the warning.
4230 GCC also warns about function definitions that might be
4231 candidates for @code{format} attributes.  Again, these are only
4232 possible candidates.  GCC guesses that @code{format} attributes
4233 might be appropriate for any function that calls a function like
4234 @code{vprintf} or @code{vscanf}, but this might not always be the
4235 case, and some functions for which @code{format} attributes are
4236 appropriate may not be detected.
4237 @end table
4239 @item -Wsuggest-final-types
4240 @opindex Wno-suggest-final-types
4241 @opindex Wsuggest-final-types
4242 Warn about types with virtual methods where code quality would be improved
4243 if the type was declared with the C++11 final specifier, or, if possible,
4244 declared in an anonymous namespace. This allows GCC to more aggressively
4245 devirtualize the polymorphic calls. This warning is more effective with link
4246 time optimization, where the information about the class hierarchy graph is
4247 more complete.
4249 @item -Wsuggest-final-methods
4250 @opindex Wno-suggest-final-methods
4251 @opindex Wsuggest-final-methods
4252 Warn about virtual methods where code quality would be improved if the method
4253 was declared with the C++11 final specifier, or, if possible, its type was
4254 declared in an anonymous namespace or with the final specifier. This warning is
4255 more effective with link time optimization, where the information about the
4256 class hierarchy graph is more complete. It is recommended to first consider
4257 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4258 annotations.
4260 @item -Warray-bounds
4261 @opindex Wno-array-bounds
4262 @opindex Warray-bounds
4263 This option is only active when @option{-ftree-vrp} is active
4264 (default for @option{-O2} and above). It warns about subscripts to arrays
4265 that are always out of bounds. This warning is enabled by @option{-Wall}.
4267 @item -Wbool-compare
4268 @opindex Wno-bool-compare
4269 @opindex Wbool-compare
4270 Warn about boolean expression compared with an integer value different from
4271 @code{true}/@code{false}.  For instance, the following comparison is
4272 always false:
4273 @smallexample
4274 int n = 5;
4275 @dots{}
4276 if ((n > 1) == 2) @{ @dots{} @}
4277 @end smallexample
4278 This warning is enabled by @option{-Wall}.
4280 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4281 @opindex Wno-discarded-qualifiers
4282 @opindex Wdiscarded-qualifiers
4283 Do not warn if type qualifiers on pointers are being discarded.
4284 Typically, the compiler will warn if a @code{const char *} variable is
4285 passed to a function that takes @code{char *} parameter.  This option
4286 can be used to suppress such a warning.
4288 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4289 @opindex Wno-incompatible-pointer-types
4290 @opindex Wincompatible-pointer-types
4291 Do not warn when there is a conversion between pointers that have incompatible
4292 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4293 which warns for pointer argument passing or assignment with different
4294 signedness.
4296 @item -Wno-int-conversion @r{(C and Objective-C only)}
4297 @opindex Wno-int-conversion
4298 @opindex Wint-conversion
4299 Do not warn about incompatible integer to pointer and pointer to integer
4300 conversions.  This warning is about implicit conversions; for explicit
4301 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4302 @option{-Wno-pointer-to-int-cast} may be used.
4304 @item -Wno-div-by-zero
4305 @opindex Wno-div-by-zero
4306 @opindex Wdiv-by-zero
4307 Do not warn about compile-time integer division by zero.  Floating-point
4308 division by zero is not warned about, as it can be a legitimate way of
4309 obtaining infinities and NaNs.
4311 @item -Wsystem-headers
4312 @opindex Wsystem-headers
4313 @opindex Wno-system-headers
4314 @cindex warnings from system headers
4315 @cindex system headers, warnings from
4316 Print warning messages for constructs found in system header files.
4317 Warnings from system headers are normally suppressed, on the assumption
4318 that they usually do not indicate real problems and would only make the
4319 compiler output harder to read.  Using this command-line option tells
4320 GCC to emit warnings from system headers as if they occurred in user
4321 code.  However, note that using @option{-Wall} in conjunction with this
4322 option does @emph{not} warn about unknown pragmas in system
4323 headers---for that, @option{-Wunknown-pragmas} must also be used.
4325 @item -Wtrampolines
4326 @opindex Wtrampolines
4327 @opindex Wno-trampolines
4328 Warn about trampolines generated for pointers to nested functions.
4329 A trampoline is a small piece of data or code that is created at run
4330 time on the stack when the address of a nested function is taken, and is
4331 used to call the nested function indirectly.  For some targets, it is
4332 made up of data only and thus requires no special treatment.  But, for
4333 most targets, it is made up of code and thus requires the stack to be
4334 made executable in order for the program to work properly.
4336 @item -Wfloat-equal
4337 @opindex Wfloat-equal
4338 @opindex Wno-float-equal
4339 Warn if floating-point values are used in equality comparisons.
4341 The idea behind this is that sometimes it is convenient (for the
4342 programmer) to consider floating-point values as approximations to
4343 infinitely precise real numbers.  If you are doing this, then you need
4344 to compute (by analyzing the code, or in some other way) the maximum or
4345 likely maximum error that the computation introduces, and allow for it
4346 when performing comparisons (and when producing output, but that's a
4347 different problem).  In particular, instead of testing for equality, you
4348 should check to see whether the two values have ranges that overlap; and
4349 this is done with the relational operators, so equality comparisons are
4350 probably mistaken.
4352 @item -Wtraditional @r{(C and Objective-C only)}
4353 @opindex Wtraditional
4354 @opindex Wno-traditional
4355 Warn about certain constructs that behave differently in traditional and
4356 ISO C@.  Also warn about ISO C constructs that have no traditional C
4357 equivalent, and/or problematic constructs that should be avoided.
4359 @itemize @bullet
4360 @item
4361 Macro parameters that appear within string literals in the macro body.
4362 In traditional C macro replacement takes place within string literals,
4363 but in ISO C it does not.
4365 @item
4366 In traditional C, some preprocessor directives did not exist.
4367 Traditional preprocessors only considered a line to be a directive
4368 if the @samp{#} appeared in column 1 on the line.  Therefore
4369 @option{-Wtraditional} warns about directives that traditional C
4370 understands but ignores because the @samp{#} does not appear as the
4371 first character on the line.  It also suggests you hide directives like
4372 @samp{#pragma} not understood by traditional C by indenting them.  Some
4373 traditional implementations do not recognize @samp{#elif}, so this option
4374 suggests avoiding it altogether.
4376 @item
4377 A function-like macro that appears without arguments.
4379 @item
4380 The unary plus operator.
4382 @item
4383 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4384 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4385 constants.)  Note, these suffixes appear in macros defined in the system
4386 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4387 Use of these macros in user code might normally lead to spurious
4388 warnings, however GCC's integrated preprocessor has enough context to
4389 avoid warning in these cases.
4391 @item
4392 A function declared external in one block and then used after the end of
4393 the block.
4395 @item
4396 A @code{switch} statement has an operand of type @code{long}.
4398 @item
4399 A non-@code{static} function declaration follows a @code{static} one.
4400 This construct is not accepted by some traditional C compilers.
4402 @item
4403 The ISO type of an integer constant has a different width or
4404 signedness from its traditional type.  This warning is only issued if
4405 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4406 typically represent bit patterns, are not warned about.
4408 @item
4409 Usage of ISO string concatenation is detected.
4411 @item
4412 Initialization of automatic aggregates.
4414 @item
4415 Identifier conflicts with labels.  Traditional C lacks a separate
4416 namespace for labels.
4418 @item
4419 Initialization of unions.  If the initializer is zero, the warning is
4420 omitted.  This is done under the assumption that the zero initializer in
4421 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4422 initializer warnings and relies on default initialization to zero in the
4423 traditional C case.
4425 @item
4426 Conversions by prototypes between fixed/floating-point values and vice
4427 versa.  The absence of these prototypes when compiling with traditional
4428 C causes serious problems.  This is a subset of the possible
4429 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4431 @item
4432 Use of ISO C style function definitions.  This warning intentionally is
4433 @emph{not} issued for prototype declarations or variadic functions
4434 because these ISO C features appear in your code when using
4435 libiberty's traditional C compatibility macros, @code{PARAMS} and
4436 @code{VPARAMS}.  This warning is also bypassed for nested functions
4437 because that feature is already a GCC extension and thus not relevant to
4438 traditional C compatibility.
4439 @end itemize
4441 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4442 @opindex Wtraditional-conversion
4443 @opindex Wno-traditional-conversion
4444 Warn if a prototype causes a type conversion that is different from what
4445 would happen to the same argument in the absence of a prototype.  This
4446 includes conversions of fixed point to floating and vice versa, and
4447 conversions changing the width or signedness of a fixed-point argument
4448 except when the same as the default promotion.
4450 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4451 @opindex Wdeclaration-after-statement
4452 @opindex Wno-declaration-after-statement
4453 Warn when a declaration is found after a statement in a block.  This
4454 construct, known from C++, was introduced with ISO C99 and is by default
4455 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4456 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4458 @item -Wundef
4459 @opindex Wundef
4460 @opindex Wno-undef
4461 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4463 @item -Wno-endif-labels
4464 @opindex Wno-endif-labels
4465 @opindex Wendif-labels
4466 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4468 @item -Wshadow
4469 @opindex Wshadow
4470 @opindex Wno-shadow
4471 Warn whenever a local variable or type declaration shadows another
4472 variable, parameter, type, class member (in C++), or instance variable
4473 (in Objective-C) or whenever a built-in function is shadowed. Note
4474 that in C++, the compiler warns if a local variable shadows an
4475 explicit typedef, but not if it shadows a struct/class/enum.
4477 @item -Wno-shadow-ivar @r{(Objective-C only)}
4478 @opindex Wno-shadow-ivar
4479 @opindex Wshadow-ivar
4480 Do not warn whenever a local variable shadows an instance variable in an
4481 Objective-C method.
4483 @item -Wlarger-than=@var{len}
4484 @opindex Wlarger-than=@var{len}
4485 @opindex Wlarger-than-@var{len}
4486 Warn whenever an object of larger than @var{len} bytes is defined.
4488 @item -Wframe-larger-than=@var{len}
4489 @opindex Wframe-larger-than
4490 Warn if the size of a function frame is larger than @var{len} bytes.
4491 The computation done to determine the stack frame size is approximate
4492 and not conservative.
4493 The actual requirements may be somewhat greater than @var{len}
4494 even if you do not get a warning.  In addition, any space allocated
4495 via @code{alloca}, variable-length arrays, or related constructs
4496 is not included by the compiler when determining
4497 whether or not to issue a warning.
4499 @item -Wno-free-nonheap-object
4500 @opindex Wno-free-nonheap-object
4501 @opindex Wfree-nonheap-object
4502 Do not warn when attempting to free an object that was not allocated
4503 on the heap.
4505 @item -Wstack-usage=@var{len}
4506 @opindex Wstack-usage
4507 Warn if the stack usage of a function might be larger than @var{len} bytes.
4508 The computation done to determine the stack usage is conservative.
4509 Any space allocated via @code{alloca}, variable-length arrays, or related
4510 constructs is included by the compiler when determining whether or not to
4511 issue a warning.
4513 The message is in keeping with the output of @option{-fstack-usage}.
4515 @itemize
4516 @item
4517 If the stack usage is fully static but exceeds the specified amount, it's:
4519 @smallexample
4520   warning: stack usage is 1120 bytes
4521 @end smallexample
4522 @item
4523 If the stack usage is (partly) dynamic but bounded, it's:
4525 @smallexample
4526   warning: stack usage might be 1648 bytes
4527 @end smallexample
4528 @item
4529 If the stack usage is (partly) dynamic and not bounded, it's:
4531 @smallexample
4532   warning: stack usage might be unbounded
4533 @end smallexample
4534 @end itemize
4536 @item -Wunsafe-loop-optimizations
4537 @opindex Wunsafe-loop-optimizations
4538 @opindex Wno-unsafe-loop-optimizations
4539 Warn if the loop cannot be optimized because the compiler cannot
4540 assume anything on the bounds of the loop indices.  With
4541 @option{-funsafe-loop-optimizations} warn if the compiler makes
4542 such assumptions.
4544 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4545 @opindex Wno-pedantic-ms-format
4546 @opindex Wpedantic-ms-format
4547 When used in combination with @option{-Wformat}
4548 and @option{-pedantic} without GNU extensions, this option
4549 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4550 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4551 which depend on the MS runtime.
4553 @item -Wpointer-arith
4554 @opindex Wpointer-arith
4555 @opindex Wno-pointer-arith
4556 Warn about anything that depends on the ``size of'' a function type or
4557 of @code{void}.  GNU C assigns these types a size of 1, for
4558 convenience in calculations with @code{void *} pointers and pointers
4559 to functions.  In C++, warn also when an arithmetic operation involves
4560 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4562 @item -Wtype-limits
4563 @opindex Wtype-limits
4564 @opindex Wno-type-limits
4565 Warn if a comparison is always true or always false due to the limited
4566 range of the data type, but do not warn for constant expressions.  For
4567 example, warn if an unsigned variable is compared against zero with
4568 @samp{<} or @samp{>=}.  This warning is also enabled by
4569 @option{-Wextra}.
4571 @item -Wbad-function-cast @r{(C and Objective-C only)}
4572 @opindex Wbad-function-cast
4573 @opindex Wno-bad-function-cast
4574 Warn whenever a function call is cast to a non-matching type.
4575 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4577 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4578 @opindex Wc90-c99-compat
4579 @opindex Wno-c90-c99-compat
4580 Warn about features not present in ISO C90, but present in ISO C99.
4581 For instance, warn about use of variable length arrays, @code{long long}
4582 type, @code{bool} type, compound literals, designated initializers, and so
4583 on.  This option is independent of the standards mode.  Warnings are disabled
4584 in the expression that follows @code{__extension__}.
4586 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4587 @opindex Wc99-c11-compat
4588 @opindex Wno-c99-c11-compat
4589 Warn about features not present in ISO C99, but present in ISO C11.
4590 For instance, warn about use of anonymous structures and unions,
4591 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4592 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4593 and so on.  This option is independent of the standards mode.  Warnings are
4594 disabled in the expression that follows @code{__extension__}.
4596 @item -Wc++-compat @r{(C and Objective-C only)}
4597 Warn about ISO C constructs that are outside of the common subset of
4598 ISO C and ISO C++, e.g.@: request for implicit conversion from
4599 @code{void *} to a pointer to non-@code{void} type.
4601 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4602 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4603 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4604 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4605 enabled by @option{-Wall}.
4607 @item -Wcast-qual
4608 @opindex Wcast-qual
4609 @opindex Wno-cast-qual
4610 Warn whenever a pointer is cast so as to remove a type qualifier from
4611 the target type.  For example, warn if a @code{const char *} is cast
4612 to an ordinary @code{char *}.
4614 Also warn when making a cast that introduces a type qualifier in an
4615 unsafe way.  For example, casting @code{char **} to @code{const char **}
4616 is unsafe, as in this example:
4618 @smallexample
4619   /* p is char ** value.  */
4620   const char **q = (const char **) p;
4621   /* Assignment of readonly string to const char * is OK.  */
4622   *q = "string";
4623   /* Now char** pointer points to read-only memory.  */
4624   **p = 'b';
4625 @end smallexample
4627 @item -Wcast-align
4628 @opindex Wcast-align
4629 @opindex Wno-cast-align
4630 Warn whenever a pointer is cast such that the required alignment of the
4631 target is increased.  For example, warn if a @code{char *} is cast to
4632 an @code{int *} on machines where integers can only be accessed at
4633 two- or four-byte boundaries.
4635 @item -Wwrite-strings
4636 @opindex Wwrite-strings
4637 @opindex Wno-write-strings
4638 When compiling C, give string constants the type @code{const
4639 char[@var{length}]} so that copying the address of one into a
4640 non-@code{const} @code{char *} pointer produces a warning.  These
4641 warnings help you find at compile time code that can try to write
4642 into a string constant, but only if you have been very careful about
4643 using @code{const} in declarations and prototypes.  Otherwise, it is
4644 just a nuisance. This is why we did not make @option{-Wall} request
4645 these warnings.
4647 When compiling C++, warn about the deprecated conversion from string
4648 literals to @code{char *}.  This warning is enabled by default for C++
4649 programs.
4651 @item -Wclobbered
4652 @opindex Wclobbered
4653 @opindex Wno-clobbered
4654 Warn for variables that might be changed by @samp{longjmp} or
4655 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4657 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4658 @opindex Wconditionally-supported
4659 @opindex Wno-conditionally-supported
4660 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4662 @item -Wconversion
4663 @opindex Wconversion
4664 @opindex Wno-conversion
4665 Warn for implicit conversions that may alter a value. This includes
4666 conversions between real and integer, like @code{abs (x)} when
4667 @code{x} is @code{double}; conversions between signed and unsigned,
4668 like @code{unsigned ui = -1}; and conversions to smaller types, like
4669 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4670 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4671 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4672 conversions between signed and unsigned integers can be disabled by
4673 using @option{-Wno-sign-conversion}.
4675 For C++, also warn for confusing overload resolution for user-defined
4676 conversions; and conversions that never use a type conversion
4677 operator: conversions to @code{void}, the same type, a base class or a
4678 reference to them. Warnings about conversions between signed and
4679 unsigned integers are disabled by default in C++ unless
4680 @option{-Wsign-conversion} is explicitly enabled.
4682 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4683 @opindex Wconversion-null
4684 @opindex Wno-conversion-null
4685 Do not warn for conversions between @code{NULL} and non-pointer
4686 types. @option{-Wconversion-null} is enabled by default.
4688 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4689 @opindex Wzero-as-null-pointer-constant
4690 @opindex Wno-zero-as-null-pointer-constant
4691 Warn when a literal '0' is used as null pointer constant.  This can
4692 be useful to facilitate the conversion to @code{nullptr} in C++11.
4694 @item -Wdate-time
4695 @opindex Wdate-time
4696 @opindex Wno-date-time
4697 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4698 are encountered as they might prevent bit-wise-identical reproducible
4699 compilations.
4701 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4702 @opindex Wdelete-incomplete
4703 @opindex Wno-delete-incomplete
4704 Warn when deleting a pointer to incomplete type, which may cause
4705 undefined behavior at runtime.  This warning is enabled by default.
4707 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4708 @opindex Wuseless-cast
4709 @opindex Wno-useless-cast
4710 Warn when an expression is casted to its own type.
4712 @item -Wempty-body
4713 @opindex Wempty-body
4714 @opindex Wno-empty-body
4715 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4716 while} statement.  This warning is also enabled by @option{-Wextra}.
4718 @item -Wenum-compare
4719 @opindex Wenum-compare
4720 @opindex Wno-enum-compare
4721 Warn about a comparison between values of different enumerated types.
4722 In C++ enumeral mismatches in conditional expressions are also
4723 diagnosed and the warning is enabled by default.  In C this warning is 
4724 enabled by @option{-Wall}.
4726 @item -Wjump-misses-init @r{(C, Objective-C only)}
4727 @opindex Wjump-misses-init
4728 @opindex Wno-jump-misses-init
4729 Warn if a @code{goto} statement or a @code{switch} statement jumps
4730 forward across the initialization of a variable, or jumps backward to a
4731 label after the variable has been initialized.  This only warns about
4732 variables that are initialized when they are declared.  This warning is
4733 only supported for C and Objective-C; in C++ this sort of branch is an
4734 error in any case.
4736 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4737 can be disabled with the @option{-Wno-jump-misses-init} option.
4739 @item -Wsign-compare
4740 @opindex Wsign-compare
4741 @opindex Wno-sign-compare
4742 @cindex warning for comparison of signed and unsigned values
4743 @cindex comparison of signed and unsigned values, warning
4744 @cindex signed and unsigned values, comparison warning
4745 Warn when a comparison between signed and unsigned values could produce
4746 an incorrect result when the signed value is converted to unsigned.
4747 This warning is also enabled by @option{-Wextra}; to get the other warnings
4748 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4750 @item -Wsign-conversion
4751 @opindex Wsign-conversion
4752 @opindex Wno-sign-conversion
4753 Warn for implicit conversions that may change the sign of an integer
4754 value, like assigning a signed integer expression to an unsigned
4755 integer variable. An explicit cast silences the warning. In C, this
4756 option is enabled also by @option{-Wconversion}.
4758 @item -Wfloat-conversion
4759 @opindex Wfloat-conversion
4760 @opindex Wno-float-conversion
4761 Warn for implicit conversions that reduce the precision of a real value.
4762 This includes conversions from real to integer, and from higher precision
4763 real to lower precision real values.  This option is also enabled by
4764 @option{-Wconversion}.
4766 @item -Wsizeof-pointer-memaccess
4767 @opindex Wsizeof-pointer-memaccess
4768 @opindex Wno-sizeof-pointer-memaccess
4769 Warn for suspicious length parameters to certain string and memory built-in
4770 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4771 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4772 but a pointer, and suggests a possible fix, or about
4773 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4774 @option{-Wall}.
4776 @item -Wsizeof-array-argument
4777 @opindex Wsizeof-array-argument
4778 @opindex Wno-sizeof-array-argument
4779 Warn when the @code{sizeof} operator is applied to a parameter that is
4780 declared as an array in a function definition.  This warning is enabled by
4781 default for C and C++ programs.
4783 @item -Wmemset-transposed-args
4784 @opindex Wmemset-transposed-args
4785 @opindex Wno-memset-transposed-args
4786 Warn for suspicious calls to the @code{memset} built-in function, if the
4787 second argument is not zero and the third argument is zero.  This warns e.g.@
4788 about @code{memset (buf, sizeof buf, 0)} where most probably
4789 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4790 is only emitted if the third argument is literal zero, if it is some expression
4791 that is folded to zero, or e.g. a cast of zero to some type etc., it
4792 is far less likely that user has mistakenly exchanged the arguments and
4793 no warning is emitted.  This warning is enabled by @option{-Wall}.
4795 @item -Waddress
4796 @opindex Waddress
4797 @opindex Wno-address
4798 Warn about suspicious uses of memory addresses. These include using
4799 the address of a function in a conditional expression, such as
4800 @code{void func(void); if (func)}, and comparisons against the memory
4801 address of a string literal, such as @code{if (x == "abc")}.  Such
4802 uses typically indicate a programmer error: the address of a function
4803 always evaluates to true, so their use in a conditional usually
4804 indicate that the programmer forgot the parentheses in a function
4805 call; and comparisons against string literals result in unspecified
4806 behavior and are not portable in C, so they usually indicate that the
4807 programmer intended to use @code{strcmp}.  This warning is enabled by
4808 @option{-Wall}.
4810 @item -Wlogical-op
4811 @opindex Wlogical-op
4812 @opindex Wno-logical-op
4813 Warn about suspicious uses of logical operators in expressions.
4814 This includes using logical operators in contexts where a
4815 bit-wise operator is likely to be expected.
4817 @item -Wlogical-not-parentheses
4818 @opindex Wlogical-not-parentheses
4819 @opindex Wno-logical-not-parentheses
4820 Warn about logical not used on the left hand side operand of a comparison.
4821 This option does not warn if the RHS operand is of a boolean type.  Its
4822 purpose is to detect suspicious code like the following:
4823 @smallexample
4824 int a;
4825 @dots{}
4826 if (!a > 1) @{ @dots{} @}
4827 @end smallexample
4829 It is possible to suppress the warning by wrapping the LHS into
4830 parentheses:
4831 @smallexample
4832 if ((!a) > 1) @{ @dots{} @}
4833 @end smallexample
4835 This warning is enabled by @option{-Wall}.
4837 @item -Waggregate-return
4838 @opindex Waggregate-return
4839 @opindex Wno-aggregate-return
4840 Warn if any functions that return structures or unions are defined or
4841 called.  (In languages where you can return an array, this also elicits
4842 a warning.)
4844 @item -Wno-aggressive-loop-optimizations
4845 @opindex Wno-aggressive-loop-optimizations
4846 @opindex Waggressive-loop-optimizations
4847 Warn if in a loop with constant number of iterations the compiler detects
4848 undefined behavior in some statement during one or more of the iterations.
4850 @item -Wno-attributes
4851 @opindex Wno-attributes
4852 @opindex Wattributes
4853 Do not warn if an unexpected @code{__attribute__} is used, such as
4854 unrecognized attributes, function attributes applied to variables,
4855 etc.  This does not stop errors for incorrect use of supported
4856 attributes.
4858 @item -Wno-builtin-macro-redefined
4859 @opindex Wno-builtin-macro-redefined
4860 @opindex Wbuiltin-macro-redefined
4861 Do not warn if certain built-in macros are redefined.  This suppresses
4862 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4863 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4865 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4866 @opindex Wstrict-prototypes
4867 @opindex Wno-strict-prototypes
4868 Warn if a function is declared or defined without specifying the
4869 argument types.  (An old-style function definition is permitted without
4870 a warning if preceded by a declaration that specifies the argument
4871 types.)
4873 @item -Wold-style-declaration @r{(C and Objective-C only)}
4874 @opindex Wold-style-declaration
4875 @opindex Wno-old-style-declaration
4876 Warn for obsolescent usages, according to the C Standard, in a
4877 declaration. For example, warn if storage-class specifiers like
4878 @code{static} are not the first things in a declaration.  This warning
4879 is also enabled by @option{-Wextra}.
4881 @item -Wold-style-definition @r{(C and Objective-C only)}
4882 @opindex Wold-style-definition
4883 @opindex Wno-old-style-definition
4884 Warn if an old-style function definition is used.  A warning is given
4885 even if there is a previous prototype.
4887 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4888 @opindex Wmissing-parameter-type
4889 @opindex Wno-missing-parameter-type
4890 A function parameter is declared without a type specifier in K&R-style
4891 functions:
4893 @smallexample
4894 void foo(bar) @{ @}
4895 @end smallexample
4897 This warning is also enabled by @option{-Wextra}.
4899 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4900 @opindex Wmissing-prototypes
4901 @opindex Wno-missing-prototypes
4902 Warn if a global function is defined without a previous prototype
4903 declaration.  This warning is issued even if the definition itself
4904 provides a prototype.  Use this option to detect global functions
4905 that do not have a matching prototype declaration in a header file.
4906 This option is not valid for C++ because all function declarations
4907 provide prototypes and a non-matching declaration will declare an
4908 overload rather than conflict with an earlier declaration.
4909 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4911 @item -Wmissing-declarations
4912 @opindex Wmissing-declarations
4913 @opindex Wno-missing-declarations
4914 Warn if a global function is defined without a previous declaration.
4915 Do so even if the definition itself provides a prototype.
4916 Use this option to detect global functions that are not declared in
4917 header files.  In C, no warnings are issued for functions with previous
4918 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4919 missing prototypes.  In C++, no warnings are issued for function templates,
4920 or for inline functions, or for functions in anonymous namespaces.
4922 @item -Wmissing-field-initializers
4923 @opindex Wmissing-field-initializers
4924 @opindex Wno-missing-field-initializers
4925 @opindex W
4926 @opindex Wextra
4927 @opindex Wno-extra
4928 Warn if a structure's initializer has some fields missing.  For
4929 example, the following code causes such a warning, because
4930 @code{x.h} is implicitly zero:
4932 @smallexample
4933 struct s @{ int f, g, h; @};
4934 struct s x = @{ 3, 4 @};
4935 @end smallexample
4937 This option does not warn about designated initializers, so the following
4938 modification does not trigger a warning:
4940 @smallexample
4941 struct s @{ int f, g, h; @};
4942 struct s x = @{ .f = 3, .g = 4 @};
4943 @end smallexample
4945 In C++ this option does not warn either about the empty @{ @}
4946 initializer, for example:
4948 @smallexample
4949 struct s @{ int f, g, h; @};
4950 s x = @{ @};
4951 @end smallexample
4953 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4954 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4956 @item -Wno-multichar
4957 @opindex Wno-multichar
4958 @opindex Wmultichar
4959 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4960 Usually they indicate a typo in the user's code, as they have
4961 implementation-defined values, and should not be used in portable code.
4963 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
4964 @opindex Wnormalized=
4965 @opindex Wnormalized
4966 @opindex Wno-normalized
4967 @cindex NFC
4968 @cindex NFKC
4969 @cindex character set, input normalization
4970 In ISO C and ISO C++, two identifiers are different if they are
4971 different sequences of characters.  However, sometimes when characters
4972 outside the basic ASCII character set are used, you can have two
4973 different character sequences that look the same.  To avoid confusion,
4974 the ISO 10646 standard sets out some @dfn{normalization rules} which
4975 when applied ensure that two sequences that look the same are turned into
4976 the same sequence.  GCC can warn you if you are using identifiers that
4977 have not been normalized; this option controls that warning.
4979 There are four levels of warning supported by GCC@.  The default is
4980 @option{-Wnormalized=nfc}, which warns about any identifier that is
4981 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4982 recommended form for most uses.  It is equivalent to
4983 @option{-Wnormalized}.
4985 Unfortunately, there are some characters allowed in identifiers by
4986 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4987 identifiers.  That is, there's no way to use these symbols in portable
4988 ISO C or C++ and have all your identifiers in NFC@.
4989 @option{-Wnormalized=id} suppresses the warning for these characters.
4990 It is hoped that future versions of the standards involved will correct
4991 this, which is why this option is not the default.
4993 You can switch the warning off for all characters by writing
4994 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
4995 only do this if you are using some other normalization scheme (like
4996 ``D''), because otherwise you can easily create bugs that are
4997 literally impossible to see.
4999 Some characters in ISO 10646 have distinct meanings but look identical
5000 in some fonts or display methodologies, especially once formatting has
5001 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5002 LETTER N'', displays just like a regular @code{n} that has been
5003 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5004 normalization scheme to convert all these into a standard form as
5005 well, and GCC warns if your code is not in NFKC if you use
5006 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5007 about every identifier that contains the letter O because it might be
5008 confused with the digit 0, and so is not the default, but may be
5009 useful as a local coding convention if the programming environment 
5010 cannot be fixed to display these characters distinctly.
5012 @item -Wno-deprecated
5013 @opindex Wno-deprecated
5014 @opindex Wdeprecated
5015 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5017 @item -Wno-deprecated-declarations
5018 @opindex Wno-deprecated-declarations
5019 @opindex Wdeprecated-declarations
5020 Do not warn about uses of functions (@pxref{Function Attributes}),
5021 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5022 Attributes}) marked as deprecated by using the @code{deprecated}
5023 attribute.
5025 @item -Wno-overflow
5026 @opindex Wno-overflow
5027 @opindex Woverflow
5028 Do not warn about compile-time overflow in constant expressions.
5030 @item -Wno-odr
5031 @opindex Wno-odr
5032 @opindex Wodr
5033 Warn about One Definition Rule violations during link-time optimization.
5034 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5036 @item -Wopenmp-simd
5037 @opindex Wopenm-simd
5038 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5039 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
5040 be used to relax the cost model.
5042 @item -Woverride-init @r{(C and Objective-C only)}
5043 @opindex Woverride-init
5044 @opindex Wno-override-init
5045 @opindex W
5046 @opindex Wextra
5047 @opindex Wno-extra
5048 Warn if an initialized field without side effects is overridden when
5049 using designated initializers (@pxref{Designated Inits, , Designated
5050 Initializers}).
5052 This warning is included in @option{-Wextra}.  To get other
5053 @option{-Wextra} warnings without this one, use @option{-Wextra
5054 -Wno-override-init}.
5056 @item -Wpacked
5057 @opindex Wpacked
5058 @opindex Wno-packed
5059 Warn if a structure is given the packed attribute, but the packed
5060 attribute has no effect on the layout or size of the structure.
5061 Such structures may be mis-aligned for little benefit.  For
5062 instance, in this code, the variable @code{f.x} in @code{struct bar}
5063 is misaligned even though @code{struct bar} does not itself
5064 have the packed attribute:
5066 @smallexample
5067 @group
5068 struct foo @{
5069   int x;
5070   char a, b, c, d;
5071 @} __attribute__((packed));
5072 struct bar @{
5073   char z;
5074   struct foo f;
5076 @end group
5077 @end smallexample
5079 @item -Wpacked-bitfield-compat
5080 @opindex Wpacked-bitfield-compat
5081 @opindex Wno-packed-bitfield-compat
5082 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5083 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5084 the change can lead to differences in the structure layout.  GCC
5085 informs you when the offset of such a field has changed in GCC 4.4.
5086 For example there is no longer a 4-bit padding between field @code{a}
5087 and @code{b} in this structure:
5089 @smallexample
5090 struct foo
5092   char a:4;
5093   char b:8;
5094 @} __attribute__ ((packed));
5095 @end smallexample
5097 This warning is enabled by default.  Use
5098 @option{-Wno-packed-bitfield-compat} to disable this warning.
5100 @item -Wpadded
5101 @opindex Wpadded
5102 @opindex Wno-padded
5103 Warn if padding is included in a structure, either to align an element
5104 of the structure or to align the whole structure.  Sometimes when this
5105 happens it is possible to rearrange the fields of the structure to
5106 reduce the padding and so make the structure smaller.
5108 @item -Wredundant-decls
5109 @opindex Wredundant-decls
5110 @opindex Wno-redundant-decls
5111 Warn if anything is declared more than once in the same scope, even in
5112 cases where multiple declaration is valid and changes nothing.
5114 @item -Wnested-externs @r{(C and Objective-C only)}
5115 @opindex Wnested-externs
5116 @opindex Wno-nested-externs
5117 Warn if an @code{extern} declaration is encountered within a function.
5119 @item -Wno-inherited-variadic-ctor
5120 @opindex Winherited-variadic-ctor
5121 @opindex Wno-inherited-variadic-ctor
5122 Suppress warnings about use of C++11 inheriting constructors when the
5123 base class inherited from has a C variadic constructor; the warning is
5124 on by default because the ellipsis is not inherited.
5126 @item -Winline
5127 @opindex Winline
5128 @opindex Wno-inline
5129 Warn if a function that is declared as inline cannot be inlined.
5130 Even with this option, the compiler does not warn about failures to
5131 inline functions declared in system headers.
5133 The compiler uses a variety of heuristics to determine whether or not
5134 to inline a function.  For example, the compiler takes into account
5135 the size of the function being inlined and the amount of inlining
5136 that has already been done in the current function.  Therefore,
5137 seemingly insignificant changes in the source program can cause the
5138 warnings produced by @option{-Winline} to appear or disappear.
5140 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5141 @opindex Wno-invalid-offsetof
5142 @opindex Winvalid-offsetof
5143 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
5144 type.  According to the 2014 ISO C++ standard, applying @samp{offsetof}
5145 to a non-standard-layout type is undefined.  In existing C++ implementations,
5146 however, @samp{offsetof} typically gives meaningful results.
5147 This flag is for users who are aware that they are
5148 writing nonportable code and who have deliberately chosen to ignore the
5149 warning about it.
5151 The restrictions on @samp{offsetof} may be relaxed in a future version
5152 of the C++ standard.
5154 @item -Wno-int-to-pointer-cast
5155 @opindex Wno-int-to-pointer-cast
5156 @opindex Wint-to-pointer-cast
5157 Suppress warnings from casts to pointer type of an integer of a
5158 different size. In C++, casting to a pointer type of smaller size is
5159 an error. @option{Wint-to-pointer-cast} is enabled by default.
5162 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5163 @opindex Wno-pointer-to-int-cast
5164 @opindex Wpointer-to-int-cast
5165 Suppress warnings from casts from a pointer to an integer type of a
5166 different size.
5168 @item -Winvalid-pch
5169 @opindex Winvalid-pch
5170 @opindex Wno-invalid-pch
5171 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5172 the search path but can't be used.
5174 @item -Wlong-long
5175 @opindex Wlong-long
5176 @opindex Wno-long-long
5177 Warn if @samp{long long} type is used.  This is enabled by either
5178 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5179 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5181 @item -Wvariadic-macros
5182 @opindex Wvariadic-macros
5183 @opindex Wno-variadic-macros
5184 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5185 alternate syntax is used in ISO C99 mode.  This is enabled by either
5186 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5187 messages, use @option{-Wno-variadic-macros}.
5189 @item -Wvarargs
5190 @opindex Wvarargs
5191 @opindex Wno-varargs
5192 Warn upon questionable usage of the macros used to handle variable
5193 arguments like @samp{va_start}.  This is default.  To inhibit the
5194 warning messages, use @option{-Wno-varargs}.
5196 @item -Wvector-operation-performance
5197 @opindex Wvector-operation-performance
5198 @opindex Wno-vector-operation-performance
5199 Warn if vector operation is not implemented via SIMD capabilities of the
5200 architecture.  Mainly useful for the performance tuning.
5201 Vector operation can be implemented @code{piecewise}, which means that the
5202 scalar operation is performed on every vector element; 
5203 @code{in parallel}, which means that the vector operation is implemented
5204 using scalars of wider type, which normally is more performance efficient;
5205 and @code{as a single scalar}, which means that vector fits into a
5206 scalar type.
5208 @item -Wno-virtual-move-assign
5209 @opindex Wvirtual-move-assign
5210 @opindex Wno-virtual-move-assign
5211 Suppress warnings about inheriting from a virtual base with a
5212 non-trivial C++11 move assignment operator.  This is dangerous because
5213 if the virtual base is reachable along more than one path, it will be
5214 moved multiple times, which can mean both objects end up in the
5215 moved-from state.  If the move assignment operator is written to avoid
5216 moving from a moved-from object, this warning can be disabled.
5218 @item -Wvla
5219 @opindex Wvla
5220 @opindex Wno-vla
5221 Warn if variable length array is used in the code.
5222 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5223 the variable length array.
5225 @item -Wvolatile-register-var
5226 @opindex Wvolatile-register-var
5227 @opindex Wno-volatile-register-var
5228 Warn if a register variable is declared volatile.  The volatile
5229 modifier does not inhibit all optimizations that may eliminate reads
5230 and/or writes to register variables.  This warning is enabled by
5231 @option{-Wall}.
5233 @item -Wdisabled-optimization
5234 @opindex Wdisabled-optimization
5235 @opindex Wno-disabled-optimization
5236 Warn if a requested optimization pass is disabled.  This warning does
5237 not generally indicate that there is anything wrong with your code; it
5238 merely indicates that GCC's optimizers are unable to handle the code
5239 effectively.  Often, the problem is that your code is too big or too
5240 complex; GCC refuses to optimize programs when the optimization
5241 itself is likely to take inordinate amounts of time.
5243 @item -Wpointer-sign @r{(C and Objective-C only)}
5244 @opindex Wpointer-sign
5245 @opindex Wno-pointer-sign
5246 Warn for pointer argument passing or assignment with different signedness.
5247 This option is only supported for C and Objective-C@.  It is implied by
5248 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5249 @option{-Wno-pointer-sign}.
5251 @item -Wstack-protector
5252 @opindex Wstack-protector
5253 @opindex Wno-stack-protector
5254 This option is only active when @option{-fstack-protector} is active.  It
5255 warns about functions that are not protected against stack smashing.
5257 @item -Woverlength-strings
5258 @opindex Woverlength-strings
5259 @opindex Wno-overlength-strings
5260 Warn about string constants that are longer than the ``minimum
5261 maximum'' length specified in the C standard.  Modern compilers
5262 generally allow string constants that are much longer than the
5263 standard's minimum limit, but very portable programs should avoid
5264 using longer strings.
5266 The limit applies @emph{after} string constant concatenation, and does
5267 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5268 C99, it was raised to 4095.  C++98 does not specify a normative
5269 minimum maximum, so we do not diagnose overlength strings in C++@.
5271 This option is implied by @option{-Wpedantic}, and can be disabled with
5272 @option{-Wno-overlength-strings}.
5274 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5275 @opindex Wunsuffixed-float-constants
5277 Issue a warning for any floating constant that does not have
5278 a suffix.  When used together with @option{-Wsystem-headers} it
5279 warns about such constants in system header files.  This can be useful
5280 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5281 from the decimal floating-point extension to C99.
5283 @item -Wno-designated-init @r{(C and Objective-C only)}
5284 Suppress warnings when a positional initializer is used to initialize
5285 a structure that has been marked with the @code{designated_init}
5286 attribute.
5288 @end table
5290 @node Debugging Options
5291 @section Options for Debugging Your Program or GCC
5292 @cindex options, debugging
5293 @cindex debugging information options
5295 GCC has various special options that are used for debugging
5296 either your program or GCC:
5298 @table @gcctabopt
5299 @item -g
5300 @opindex g
5301 Produce debugging information in the operating system's native format
5302 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5303 information.
5305 On most systems that use stabs format, @option{-g} enables use of extra
5306 debugging information that only GDB can use; this extra information
5307 makes debugging work better in GDB but probably makes other debuggers
5308 crash or
5309 refuse to read the program.  If you want to control for certain whether
5310 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5311 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5313 GCC allows you to use @option{-g} with
5314 @option{-O}.  The shortcuts taken by optimized code may occasionally
5315 produce surprising results: some variables you declared may not exist
5316 at all; flow of control may briefly move where you did not expect it;
5317 some statements may not be executed because they compute constant
5318 results or their values are already at hand; some statements may
5319 execute in different places because they have been moved out of loops.
5321 Nevertheless it proves possible to debug optimized output.  This makes
5322 it reasonable to use the optimizer for programs that might have bugs.
5324 The following options are useful when GCC is generated with the
5325 capability for more than one debugging format.
5327 @item -gsplit-dwarf
5328 @opindex gsplit-dwarf
5329 Separate as much dwarf debugging information as possible into a
5330 separate output file with the extension .dwo.  This option allows
5331 the build system to avoid linking files with debug information.  To
5332 be useful, this option requires a debugger capable of reading .dwo
5333 files.
5335 @item -ggdb
5336 @opindex ggdb
5337 Produce debugging information for use by GDB@.  This means to use the
5338 most expressive format available (DWARF 2, stabs, or the native format
5339 if neither of those are supported), including GDB extensions if at all
5340 possible.
5342 @item -gpubnames
5343 @opindex gpubnames
5344 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5346 @item -ggnu-pubnames
5347 @opindex ggnu-pubnames
5348 Generate .debug_pubnames and .debug_pubtypes sections in a format
5349 suitable for conversion into a GDB@ index.  This option is only useful
5350 with a linker that can produce GDB@ index version 7.
5352 @item -gstabs
5353 @opindex gstabs
5354 Produce debugging information in stabs format (if that is supported),
5355 without GDB extensions.  This is the format used by DBX on most BSD
5356 systems.  On MIPS, Alpha and System V Release 4 systems this option
5357 produces stabs debugging output that is not understood by DBX or SDB@.
5358 On System V Release 4 systems this option requires the GNU assembler.
5360 @item -feliminate-unused-debug-symbols
5361 @opindex feliminate-unused-debug-symbols
5362 Produce debugging information in stabs format (if that is supported),
5363 for only symbols that are actually used.
5365 @item -femit-class-debug-always
5366 Instead of emitting debugging information for a C++ class in only one
5367 object file, emit it in all object files using the class.  This option
5368 should be used only with debuggers that are unable to handle the way GCC
5369 normally emits debugging information for classes because using this
5370 option increases the size of debugging information by as much as a
5371 factor of two.
5373 @item -fdebug-types-section
5374 @opindex fdebug-types-section
5375 @opindex fno-debug-types-section
5376 When using DWARF Version 4 or higher, type DIEs can be put into
5377 their own @code{.debug_types} section instead of making them part of the
5378 @code{.debug_info} section.  It is more efficient to put them in a separate
5379 comdat sections since the linker can then remove duplicates.
5380 But not all DWARF consumers support @code{.debug_types} sections yet
5381 and on some objects @code{.debug_types} produces larger instead of smaller
5382 debugging information.
5384 @item -gstabs+
5385 @opindex gstabs+
5386 Produce debugging information in stabs format (if that is supported),
5387 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5388 use of these extensions is likely to make other debuggers crash or
5389 refuse to read the program.
5391 @item -gcoff
5392 @opindex gcoff
5393 Produce debugging information in COFF format (if that is supported).
5394 This is the format used by SDB on most System V systems prior to
5395 System V Release 4.
5397 @item -gxcoff
5398 @opindex gxcoff
5399 Produce debugging information in XCOFF format (if that is supported).
5400 This is the format used by the DBX debugger on IBM RS/6000 systems.
5402 @item -gxcoff+
5403 @opindex gxcoff+
5404 Produce debugging information in XCOFF format (if that is supported),
5405 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5406 use of these extensions is likely to make other debuggers crash or
5407 refuse to read the program, and may cause assemblers other than the GNU
5408 assembler (GAS) to fail with an error.
5410 @item -gdwarf-@var{version}
5411 @opindex gdwarf-@var{version}
5412 Produce debugging information in DWARF format (if that is supported).
5413 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5414 for most targets is 4.  DWARF Version 5 is only experimental.
5416 Note that with DWARF Version 2, some ports require and always
5417 use some non-conflicting DWARF 3 extensions in the unwind tables.
5419 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5420 for maximum benefit.
5422 @item -grecord-gcc-switches
5423 @opindex grecord-gcc-switches
5424 This switch causes the command-line options used to invoke the
5425 compiler that may affect code generation to be appended to the
5426 DW_AT_producer attribute in DWARF debugging information.  The options
5427 are concatenated with spaces separating them from each other and from
5428 the compiler version.  See also @option{-frecord-gcc-switches} for another
5429 way of storing compiler options into the object file.  This is the default.
5431 @item -gno-record-gcc-switches
5432 @opindex gno-record-gcc-switches
5433 Disallow appending command-line options to the DW_AT_producer attribute
5434 in DWARF debugging information.
5436 @item -gstrict-dwarf
5437 @opindex gstrict-dwarf
5438 Disallow using extensions of later DWARF standard version than selected
5439 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5440 DWARF extensions from later standard versions is allowed.
5442 @item -gno-strict-dwarf
5443 @opindex gno-strict-dwarf
5444 Allow using extensions of later DWARF standard version than selected with
5445 @option{-gdwarf-@var{version}}.
5447 @item -gz@r{[}=@var{type}@r{]}
5448 @opindex gz
5449 Produce compressed debug sections in DWARF format, if that is supported.
5450 If @var{type} is not given, the default type depends on the capabilities
5451 of the assembler and linker used.  @var{type} may be one of
5452 @option{none} (don't compress debug sections), @option{zlib} (use zlib
5453 compression in ELF gABI format), or @option{zlib-gnu} (use zlib
5454 compression in traditional GNU format).  If the linker doesn't support
5455 writing compressed debug sections, the option is rejected.  Otherwise,
5456 if the assembler does not support them, @option{-gz} is silently ignored
5457 when producing object files.
5459 @item -gvms
5460 @opindex gvms
5461 Produce debugging information in Alpha/VMS debug format (if that is
5462 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5464 @item -g@var{level}
5465 @itemx -ggdb@var{level}
5466 @itemx -gstabs@var{level}
5467 @itemx -gcoff@var{level}
5468 @itemx -gxcoff@var{level}
5469 @itemx -gvms@var{level}
5470 Request debugging information and also use @var{level} to specify how
5471 much information.  The default level is 2.
5473 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5474 @option{-g}.
5476 Level 1 produces minimal information, enough for making backtraces in
5477 parts of the program that you don't plan to debug.  This includes
5478 descriptions of functions and external variables, and line number
5479 tables, but no information about local variables.
5481 Level 3 includes extra information, such as all the macro definitions
5482 present in the program.  Some debuggers support macro expansion when
5483 you use @option{-g3}.
5485 @option{-gdwarf-2} does not accept a concatenated debug level, because
5486 GCC used to support an option @option{-gdwarf} that meant to generate
5487 debug information in version 1 of the DWARF format (which is very
5488 different from version 2), and it would have been too confusing.  That
5489 debug format is long obsolete, but the option cannot be changed now.
5490 Instead use an additional @option{-g@var{level}} option to change the
5491 debug level for DWARF.
5493 @item -gtoggle
5494 @opindex gtoggle
5495 Turn off generation of debug info, if leaving out this option
5496 generates it, or turn it on at level 2 otherwise.  The position of this
5497 argument in the command line does not matter; it takes effect after all
5498 other options are processed, and it does so only once, no matter how
5499 many times it is given.  This is mainly intended to be used with
5500 @option{-fcompare-debug}.
5502 @item -fsanitize=address
5503 @opindex fsanitize=address
5504 Enable AddressSanitizer, a fast memory error detector.
5505 Memory access instructions will be instrumented to detect
5506 out-of-bounds and use-after-free bugs.
5507 See @uref{http://code.google.com/p/address-sanitizer/} for
5508 more details.  The run-time behavior can be influenced using the
5509 @env{ASAN_OPTIONS} environment variable; see
5510 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5511 a list of supported options.
5513 @item -fsanitize=kernel-address
5514 @opindex fsanitize=kernel-address
5515 Enable AddressSanitizer for Linux kernel.
5516 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5518 @item -fsanitize=thread
5519 @opindex fsanitize=thread
5520 Enable ThreadSanitizer, a fast data race detector.
5521 Memory access instructions will be instrumented to detect
5522 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5523 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5524 environment variable; see
5525 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5526 supported options.
5528 @item -fsanitize=leak
5529 @opindex fsanitize=leak
5530 Enable LeakSanitizer, a memory leak detector.
5531 This option only matters for linking of executables and if neither
5532 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5533 case it will link the executable against a library that overrides @code{malloc}
5534 and other allocator functions.  See
5535 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5536 details.  The run-time behavior can be influenced using the
5537 @env{LSAN_OPTIONS} environment variable.
5539 @item -fsanitize=undefined
5540 @opindex fsanitize=undefined
5541 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5542 Various computations will be instrumented to detect undefined behavior
5543 at runtime.  Current suboptions are:
5545 @table @gcctabopt
5547 @item -fsanitize=shift
5548 @opindex fsanitize=shift
5549 This option enables checking that the result of a shift operation is
5550 not undefined.  Note that what exactly is considered undefined differs
5551 slightly between C and C++, as well as between ISO C90 and C99, etc.
5553 @item -fsanitize=integer-divide-by-zero
5554 @opindex fsanitize=integer-divide-by-zero
5555 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5557 @item -fsanitize=unreachable
5558 @opindex fsanitize=unreachable
5559 With this option, the compiler will turn the @code{__builtin_unreachable}
5560 call into a diagnostics message call instead.  When reaching the
5561 @code{__builtin_unreachable} call, the behavior is undefined.
5563 @item -fsanitize=vla-bound
5564 @opindex fsanitize=vla-bound
5565 This option instructs the compiler to check that the size of a variable
5566 length array is positive.  This option does not have any effect in
5567 @option{-std=c++14} mode, as the standard requires the exception be thrown
5568 instead.
5570 @item -fsanitize=null
5571 @opindex fsanitize=null
5572 This option enables pointer checking.  Particularly, the application
5573 built with this option turned on will issue an error message when it
5574 tries to dereference a NULL pointer, or if a reference (possibly an
5575 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5576 on an object pointed by a NULL pointer.
5578 @item -fsanitize=return
5579 @opindex fsanitize=return
5580 This option enables return statement checking.  Programs
5581 built with this option turned on will issue an error message
5582 when the end of a non-void function is reached without actually
5583 returning a value.  This option works in C++ only.
5585 @item -fsanitize=signed-integer-overflow
5586 @opindex fsanitize=signed-integer-overflow
5587 This option enables signed integer overflow checking.  We check that
5588 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5589 does not overflow in the signed arithmetics.  Note, integer promotion
5590 rules must be taken into account.  That is, the following is not an
5591 overflow:
5592 @smallexample
5593 signed char a = SCHAR_MAX;
5594 a++;
5595 @end smallexample
5597 @item -fsanitize=bounds
5598 @opindex fsanitize=bounds
5599 This option enables instrumentation of array bounds.  Various out of bounds
5600 accesses are detected.  Flexible array members and initializers of variables
5601 with static storage are not instrumented.
5603 @item -fsanitize=alignment
5604 @opindex fsanitize=alignment
5606 This option enables checking of alignment of pointers when they are
5607 dereferenced, or when a reference is bound to insufficiently aligned target,
5608 or when a method or constructor is invoked on insufficiently aligned object.
5610 @item -fsanitize=object-size
5611 @opindex fsanitize=object-size
5612 This option enables instrumentation of memory references using the
5613 @code{__builtin_object_size} function.  Various out of bounds pointer
5614 accesses are detected.
5616 @item -fsanitize=float-divide-by-zero
5617 @opindex fsanitize=float-divide-by-zero
5618 Detect floating-point division by zero.  Unlike other similar options,
5619 @option{-fsanitize=float-divide-by-zero} is not enabled by
5620 @option{-fsanitize=undefined}, since floating-point division by zero can
5621 be a legitimate way of obtaining infinities and NaNs.
5623 @item -fsanitize=float-cast-overflow
5624 @opindex fsanitize=float-cast-overflow
5625 This option enables floating-point type to integer conversion checking.
5626 We check that the result of the conversion does not overflow.
5627 This option does not work well with @code{FE_INVALID} exceptions enabled.
5629 @item -fsanitize=nonnull-attribute
5630 @opindex fsanitize=nonnull-attribute
5632 This option enables instrumentation of calls, checking whether null values
5633 are not passed to arguments marked as requiring a non-null value by the
5634 @code{nonnull} function attribute.
5636 @item -fsanitize=returns-nonnull-attribute
5637 @opindex fsanitize=returns-nonnull-attribute
5639 This option enables instrumentation of return statements in functions
5640 marked with @code{returns_nonnull} function attribute, to detect returning
5641 of null values from such functions.
5643 @item -fsanitize=bool
5644 @opindex fsanitize=bool
5646 This option enables instrumentation of loads from bool.  If a value other
5647 than 0/1 is loaded, a run-time error is issued.
5649 @item -fsanitize=enum
5650 @opindex fsanitize=enum
5652 This option enables instrumentation of loads from an enum type.  If
5653 a value outside the range of values for the enum type is loaded,
5654 a run-time error is issued.
5656 @end table
5658 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5659 @option{-fsanitize=undefined} gives a diagnostic message.
5660 This currently works only for the C family of languages.
5662 @item -fasan-shadow-offset=@var{number}
5663 @opindex fasan-shadow-offset
5664 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5665 It is useful for experimenting with different shadow memory layouts in
5666 Kernel AddressSanitizer.
5668 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5669 @opindex fsanitize-recover
5670 @opindex fno-sanitize-recover
5671 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5672 mentioned in comma-separated list of @var{opts}.  Enabling this option
5673 for a sanitizer component would cause it to attempt to continue
5674 running the program as if no error happened.  This means multiple
5675 runtime errors can be reported in a single program run, and the exit
5676 code of the program may indicate success even when errors
5677 have been reported.  The @option{-fno-sanitize-recover=} can be used to alter
5678 this behavior, only the first detected error will be reported
5679 and program will exit after that with non-zero exit code.
5681 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5682 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5683 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5684 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5686 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5687 @option{-fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5688 Similarly @option{-fno-sanitize-recover} is equivalent to
5689 @option{-fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5691 @item -fsanitize-undefined-trap-on-error
5692 @opindex fsanitize-undefined-trap-on-error
5693 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5694 report undefined behavior using @code{__builtin_trap ()} rather than
5695 a @code{libubsan} library routine.  The advantage of this is that the
5696 @code{libubsan} library is not needed and will not be linked in, so this
5697 is usable even for use in freestanding environments.
5699 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5700 @opindex fdump-final-insns
5701 Dump the final internal representation (RTL) to @var{file}.  If the
5702 optional argument is omitted (or if @var{file} is @code{.}), the name
5703 of the dump file is determined by appending @code{.gkd} to the
5704 compilation output file name.
5706 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5707 @opindex fcompare-debug
5708 @opindex fno-compare-debug
5709 If no error occurs during compilation, run the compiler a second time,
5710 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5711 passed to the second compilation.  Dump the final internal
5712 representation in both compilations, and print an error if they differ.
5714 If the equal sign is omitted, the default @option{-gtoggle} is used.
5716 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5717 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5718 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5719 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5720 is used.
5722 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5723 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5724 of the final representation and the second compilation, preventing even
5725 @env{GCC_COMPARE_DEBUG} from taking effect.
5727 To verify full coverage during @option{-fcompare-debug} testing, set
5728 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5729 which GCC rejects as an invalid option in any actual compilation
5730 (rather than preprocessing, assembly or linking).  To get just a
5731 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5732 not overridden} will do.
5734 @item -fcompare-debug-second
5735 @opindex fcompare-debug-second
5736 This option is implicitly passed to the compiler for the second
5737 compilation requested by @option{-fcompare-debug}, along with options to
5738 silence warnings, and omitting other options that would cause
5739 side-effect compiler outputs to files or to the standard output.  Dump
5740 files and preserved temporary files are renamed so as to contain the
5741 @code{.gk} additional extension during the second compilation, to avoid
5742 overwriting those generated by the first.
5744 When this option is passed to the compiler driver, it causes the
5745 @emph{first} compilation to be skipped, which makes it useful for little
5746 other than debugging the compiler proper.
5748 @item -feliminate-dwarf2-dups
5749 @opindex feliminate-dwarf2-dups
5750 Compress DWARF 2 debugging information by eliminating duplicated
5751 information about each symbol.  This option only makes sense when
5752 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5754 @item -femit-struct-debug-baseonly
5755 @opindex femit-struct-debug-baseonly
5756 Emit debug information for struct-like types
5757 only when the base name of the compilation source file
5758 matches the base name of file in which the struct is defined.
5760 This option substantially reduces the size of debugging information,
5761 but at significant potential loss in type information to the debugger.
5762 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5763 See @option{-femit-struct-debug-detailed} for more detailed control.
5765 This option works only with DWARF 2.
5767 @item -femit-struct-debug-reduced
5768 @opindex femit-struct-debug-reduced
5769 Emit debug information for struct-like types
5770 only when the base name of the compilation source file
5771 matches the base name of file in which the type is defined,
5772 unless the struct is a template or defined in a system header.
5774 This option significantly reduces the size of debugging information,
5775 with some potential loss in type information to the debugger.
5776 See @option{-femit-struct-debug-baseonly} for a more 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-detailed@r{[}=@var{spec-list}@r{]}
5782 Specify the struct-like types
5783 for which the compiler generates debug information.
5784 The intent is to reduce duplicate struct debug information
5785 between different object files within the same program.
5787 This option is a detailed version of
5788 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5789 which serves for most needs.
5791 A specification has the syntax@*
5792 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5794 The optional first word limits the specification to
5795 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5796 A struct type is used directly when it is the type of a variable, member.
5797 Indirect uses arise through pointers to structs.
5798 That is, when use of an incomplete struct is valid, the use is indirect.
5799 An example is
5800 @samp{struct one direct; struct two * indirect;}.
5802 The optional second word limits the specification to
5803 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5804 Generic structs are a bit complicated to explain.
5805 For C++, these are non-explicit specializations of template classes,
5806 or non-template classes within the above.
5807 Other programming languages have generics,
5808 but @option{-femit-struct-debug-detailed} does not yet implement them.
5810 The third word specifies the source files for those
5811 structs for which the compiler should emit debug information.
5812 The values @samp{none} and @samp{any} have the normal meaning.
5813 The value @samp{base} means that
5814 the base of name of the file in which the type declaration appears
5815 must match the base of the name of the main compilation file.
5816 In practice, this means that when compiling @file{foo.c}, debug information
5817 is generated for types declared in that file and @file{foo.h},
5818 but not other header files.
5819 The value @samp{sys} means those types satisfying @samp{base}
5820 or declared in system or compiler headers.
5822 You may need to experiment to determine the best settings for your application.
5824 The default is @option{-femit-struct-debug-detailed=all}.
5826 This option works only with DWARF 2.
5828 @item -fno-merge-debug-strings
5829 @opindex fmerge-debug-strings
5830 @opindex fno-merge-debug-strings
5831 Direct the linker to not merge together strings in the debugging
5832 information that are identical in different object files.  Merging is
5833 not supported by all assemblers or linkers.  Merging decreases the size
5834 of the debug information in the output file at the cost of increasing
5835 link processing time.  Merging is enabled by default.
5837 @item -fdebug-prefix-map=@var{old}=@var{new}
5838 @opindex fdebug-prefix-map
5839 When compiling files in directory @file{@var{old}}, record debugging
5840 information describing them as in @file{@var{new}} instead.
5842 @item -fno-dwarf2-cfi-asm
5843 @opindex fdwarf2-cfi-asm
5844 @opindex fno-dwarf2-cfi-asm
5845 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5846 instead of using GAS @code{.cfi_*} directives.
5848 @cindex @command{prof}
5849 @item -p
5850 @opindex p
5851 Generate extra code to write profile information suitable for the
5852 analysis program @command{prof}.  You must use this option when compiling
5853 the source files you want data about, and you must also use it when
5854 linking.
5856 @cindex @command{gprof}
5857 @item -pg
5858 @opindex pg
5859 Generate extra code to write profile information suitable for the
5860 analysis program @command{gprof}.  You must use this option when compiling
5861 the source files you want data about, and you must also use it when
5862 linking.
5864 @item -Q
5865 @opindex Q
5866 Makes the compiler print out each function name as it is compiled, and
5867 print some statistics about each pass when it finishes.
5869 @item -ftime-report
5870 @opindex ftime-report
5871 Makes the compiler print some statistics about the time consumed by each
5872 pass when it finishes.
5874 @item -fmem-report
5875 @opindex fmem-report
5876 Makes the compiler print some statistics about permanent memory
5877 allocation when it finishes.
5879 @item -fmem-report-wpa
5880 @opindex fmem-report-wpa
5881 Makes the compiler print some statistics about permanent memory
5882 allocation for the WPA phase only.
5884 @item -fpre-ipa-mem-report
5885 @opindex fpre-ipa-mem-report
5886 @item -fpost-ipa-mem-report
5887 @opindex fpost-ipa-mem-report
5888 Makes the compiler print some statistics about permanent memory
5889 allocation before or after interprocedural optimization.
5891 @item -fprofile-report
5892 @opindex fprofile-report
5893 Makes the compiler print some statistics about consistency of the
5894 (estimated) profile and effect of individual passes.
5896 @item -fstack-usage
5897 @opindex fstack-usage
5898 Makes the compiler output stack usage information for the program, on a
5899 per-function basis.  The filename for the dump is made by appending
5900 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5901 the output file, if explicitly specified and it is not an executable,
5902 otherwise it is the basename of the source file.  An entry is made up
5903 of three fields:
5905 @itemize
5906 @item
5907 The name of the function.
5908 @item
5909 A number of bytes.
5910 @item
5911 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5912 @end itemize
5914 The qualifier @code{static} means that the function manipulates the stack
5915 statically: a fixed number of bytes are allocated for the frame on function
5916 entry and released on function exit; no stack adjustments are otherwise made
5917 in the function.  The second field is this fixed number of bytes.
5919 The qualifier @code{dynamic} means that the function manipulates the stack
5920 dynamically: in addition to the static allocation described above, stack
5921 adjustments are made in the body of the function, for example to push/pop
5922 arguments around function calls.  If the qualifier @code{bounded} is also
5923 present, the amount of these adjustments is bounded at compile time and
5924 the second field is an upper bound of the total amount of stack used by
5925 the function.  If it is not present, the amount of these adjustments is
5926 not bounded at compile time and the second field only represents the
5927 bounded part.
5929 @item -fprofile-arcs
5930 @opindex fprofile-arcs
5931 Add code so that program flow @dfn{arcs} are instrumented.  During
5932 execution the program records how many times each branch and call is
5933 executed and how many times it is taken or returns.  When the compiled
5934 program exits it saves this data to a file called
5935 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5936 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5937 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5938 @var{auxname} is generated from the name of the output file, if
5939 explicitly specified and it is not the final executable, otherwise it is
5940 the basename of the source file.  In both cases any suffix is removed
5941 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5942 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5943 @xref{Cross-profiling}.
5945 @cindex @command{gcov}
5946 @item --coverage
5947 @opindex coverage
5949 This option is used to compile and link code instrumented for coverage
5950 analysis.  The option is a synonym for @option{-fprofile-arcs}
5951 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5952 linking).  See the documentation for those options for more details.
5954 @itemize
5956 @item
5957 Compile the source files with @option{-fprofile-arcs} plus optimization
5958 and code generation options.  For test coverage analysis, use the
5959 additional @option{-ftest-coverage} option.  You do not need to profile
5960 every source file in a program.
5962 @item
5963 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5964 (the latter implies the former).
5966 @item
5967 Run the program on a representative workload to generate the arc profile
5968 information.  This may be repeated any number of times.  You can run
5969 concurrent instances of your program, and provided that the file system
5970 supports locking, the data files will be correctly updated.  Also
5971 @code{fork} calls are detected and correctly handled (double counting
5972 will not happen).
5974 @item
5975 For profile-directed optimizations, compile the source files again with
5976 the same optimization and code generation options plus
5977 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5978 Control Optimization}).
5980 @item
5981 For test coverage analysis, use @command{gcov} to produce human readable
5982 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5983 @command{gcov} documentation for further information.
5985 @end itemize
5987 With @option{-fprofile-arcs}, for each function of your program GCC
5988 creates a program flow graph, then finds a spanning tree for the graph.
5989 Only arcs that are not on the spanning tree have to be instrumented: the
5990 compiler adds code to count the number of times that these arcs are
5991 executed.  When an arc is the only exit or only entrance to a block, the
5992 instrumentation code can be added to the block; otherwise, a new basic
5993 block must be created to hold the instrumentation code.
5995 @need 2000
5996 @item -ftest-coverage
5997 @opindex ftest-coverage
5998 Produce a notes file that the @command{gcov} code-coverage utility
5999 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6000 show program coverage.  Each source file's note file is called
6001 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6002 above for a description of @var{auxname} and instructions on how to
6003 generate test coverage data.  Coverage data matches the source files
6004 more closely if you do not optimize.
6006 @item -fdbg-cnt-list
6007 @opindex fdbg-cnt-list
6008 Print the name and the counter upper bound for all debug counters.
6011 @item -fdbg-cnt=@var{counter-value-list}
6012 @opindex fdbg-cnt
6013 Set the internal debug counter upper bound.  @var{counter-value-list}
6014 is a comma-separated list of @var{name}:@var{value} pairs
6015 which sets the upper bound of each debug counter @var{name} to @var{value}.
6016 All debug counters have the initial upper bound of @code{UINT_MAX};
6017 thus @code{dbg_cnt()} returns true always unless the upper bound
6018 is set by this option.
6019 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6020 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6022 @item -fenable-@var{kind}-@var{pass}
6023 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6024 @opindex fdisable-
6025 @opindex fenable-
6027 This is a set of options that are used to explicitly disable/enable
6028 optimization passes.  These options are intended for use for debugging GCC.
6029 Compiler users should use regular options for enabling/disabling
6030 passes instead.
6032 @table @gcctabopt
6034 @item -fdisable-ipa-@var{pass}
6035 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6036 statically invoked in the compiler multiple times, the pass name should be
6037 appended with a sequential number starting from 1.
6039 @item -fdisable-rtl-@var{pass}
6040 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6041 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6042 statically invoked in the compiler multiple times, the pass name should be
6043 appended with a sequential number starting from 1.  @var{range-list} is a 
6044 comma-separated list of function ranges or assembler names.  Each range is a number
6045 pair separated by a colon.  The range is inclusive in both ends.  If the range
6046 is trivial, the number pair can be simplified as a single number.  If the
6047 function's call graph node's @var{uid} falls within one of the specified ranges,
6048 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6049 function header of a dump file, and the pass names can be dumped by using
6050 option @option{-fdump-passes}.
6052 @item -fdisable-tree-@var{pass}
6053 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6054 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6055 option arguments.
6057 @item -fenable-ipa-@var{pass}
6058 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6059 statically invoked in the compiler multiple times, the pass name should be
6060 appended with a sequential number starting from 1.
6062 @item -fenable-rtl-@var{pass}
6063 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6064 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6065 description and examples.
6067 @item -fenable-tree-@var{pass}
6068 @itemx -fenable-tree-@var{pass}=@var{range-list}
6069 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6070 of option arguments.
6072 @end table
6074 Here are some examples showing uses of these options.
6076 @smallexample
6078 # disable ccp1 for all functions
6079    -fdisable-tree-ccp1
6080 # disable complete unroll for function whose cgraph node uid is 1
6081    -fenable-tree-cunroll=1
6082 # disable gcse2 for functions at the following ranges [1,1],
6083 # [300,400], and [400,1000]
6084 # disable gcse2 for functions foo and foo2
6085    -fdisable-rtl-gcse2=foo,foo2
6086 # disable early inlining
6087    -fdisable-tree-einline
6088 # disable ipa inlining
6089    -fdisable-ipa-inline
6090 # enable tree full unroll
6091    -fenable-tree-unroll
6093 @end smallexample
6095 @item -d@var{letters}
6096 @itemx -fdump-rtl-@var{pass}
6097 @itemx -fdump-rtl-@var{pass}=@var{filename}
6098 @opindex d
6099 @opindex fdump-rtl-@var{pass}
6100 Says to make debugging dumps during compilation at times specified by
6101 @var{letters}.  This is used for debugging the RTL-based passes of the
6102 compiler.  The file names for most of the dumps are made by appending
6103 a pass number and a word to the @var{dumpname}, and the files are
6104 created in the directory of the output file. In case of
6105 @option{=@var{filename}} option, the dump is output on the given file
6106 instead of the pass numbered dump files. Note that the pass number is
6107 computed statically as passes get registered into the pass manager.
6108 Thus the numbering is not related to the dynamic order of execution of
6109 passes.  In particular, a pass installed by a plugin could have a
6110 number over 200 even if it executed quite early.  @var{dumpname} is
6111 generated from the name of the output file, if explicitly specified
6112 and it is not an executable, otherwise it is the basename of the
6113 source file. These switches may have different effects when
6114 @option{-E} is used for preprocessing.
6116 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6117 @option{-d} option @var{letters}.  Here are the possible
6118 letters for use in @var{pass} and @var{letters}, and their meanings:
6120 @table @gcctabopt
6122 @item -fdump-rtl-alignments
6123 @opindex fdump-rtl-alignments
6124 Dump after branch alignments have been computed.
6126 @item -fdump-rtl-asmcons
6127 @opindex fdump-rtl-asmcons
6128 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6130 @item -fdump-rtl-auto_inc_dec
6131 @opindex fdump-rtl-auto_inc_dec
6132 Dump after auto-inc-dec discovery.  This pass is only run on
6133 architectures that have auto inc or auto dec instructions.
6135 @item -fdump-rtl-barriers
6136 @opindex fdump-rtl-barriers
6137 Dump after cleaning up the barrier instructions.
6139 @item -fdump-rtl-bbpart
6140 @opindex fdump-rtl-bbpart
6141 Dump after partitioning hot and cold basic blocks.
6143 @item -fdump-rtl-bbro
6144 @opindex fdump-rtl-bbro
6145 Dump after block reordering.
6147 @item -fdump-rtl-btl1
6148 @itemx -fdump-rtl-btl2
6149 @opindex fdump-rtl-btl2
6150 @opindex fdump-rtl-btl2
6151 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6152 after the two branch
6153 target load optimization passes.
6155 @item -fdump-rtl-bypass
6156 @opindex fdump-rtl-bypass
6157 Dump after jump bypassing and control flow optimizations.
6159 @item -fdump-rtl-combine
6160 @opindex fdump-rtl-combine
6161 Dump after the RTL instruction combination pass.
6163 @item -fdump-rtl-compgotos
6164 @opindex fdump-rtl-compgotos
6165 Dump after duplicating the computed gotos.
6167 @item -fdump-rtl-ce1
6168 @itemx -fdump-rtl-ce2
6169 @itemx -fdump-rtl-ce3
6170 @opindex fdump-rtl-ce1
6171 @opindex fdump-rtl-ce2
6172 @opindex fdump-rtl-ce3
6173 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6174 @option{-fdump-rtl-ce3} enable dumping after the three
6175 if conversion passes.
6177 @item -fdump-rtl-cprop_hardreg
6178 @opindex fdump-rtl-cprop_hardreg
6179 Dump after hard register copy propagation.
6181 @item -fdump-rtl-csa
6182 @opindex fdump-rtl-csa
6183 Dump after combining stack adjustments.
6185 @item -fdump-rtl-cse1
6186 @itemx -fdump-rtl-cse2
6187 @opindex fdump-rtl-cse1
6188 @opindex fdump-rtl-cse2
6189 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6190 the two common subexpression elimination passes.
6192 @item -fdump-rtl-dce
6193 @opindex fdump-rtl-dce
6194 Dump after the standalone dead code elimination passes.
6196 @item -fdump-rtl-dbr
6197 @opindex fdump-rtl-dbr
6198 Dump after delayed branch scheduling.
6200 @item -fdump-rtl-dce1
6201 @itemx -fdump-rtl-dce2
6202 @opindex fdump-rtl-dce1
6203 @opindex fdump-rtl-dce2
6204 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6205 the two dead store elimination passes.
6207 @item -fdump-rtl-eh
6208 @opindex fdump-rtl-eh
6209 Dump after finalization of EH handling code.
6211 @item -fdump-rtl-eh_ranges
6212 @opindex fdump-rtl-eh_ranges
6213 Dump after conversion of EH handling range regions.
6215 @item -fdump-rtl-expand
6216 @opindex fdump-rtl-expand
6217 Dump after RTL generation.
6219 @item -fdump-rtl-fwprop1
6220 @itemx -fdump-rtl-fwprop2
6221 @opindex fdump-rtl-fwprop1
6222 @opindex fdump-rtl-fwprop2
6223 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6224 dumping after the two forward propagation passes.
6226 @item -fdump-rtl-gcse1
6227 @itemx -fdump-rtl-gcse2
6228 @opindex fdump-rtl-gcse1
6229 @opindex fdump-rtl-gcse2
6230 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6231 after global common subexpression elimination.
6233 @item -fdump-rtl-init-regs
6234 @opindex fdump-rtl-init-regs
6235 Dump after the initialization of the registers.
6237 @item -fdump-rtl-initvals
6238 @opindex fdump-rtl-initvals
6239 Dump after the computation of the initial value sets.
6241 @item -fdump-rtl-into_cfglayout
6242 @opindex fdump-rtl-into_cfglayout
6243 Dump after converting to cfglayout mode.
6245 @item -fdump-rtl-ira
6246 @opindex fdump-rtl-ira
6247 Dump after iterated register allocation.
6249 @item -fdump-rtl-jump
6250 @opindex fdump-rtl-jump
6251 Dump after the second jump optimization.
6253 @item -fdump-rtl-loop2
6254 @opindex fdump-rtl-loop2
6255 @option{-fdump-rtl-loop2} enables dumping after the rtl
6256 loop optimization passes.
6258 @item -fdump-rtl-mach
6259 @opindex fdump-rtl-mach
6260 Dump after performing the machine dependent reorganization pass, if that
6261 pass exists.
6263 @item -fdump-rtl-mode_sw
6264 @opindex fdump-rtl-mode_sw
6265 Dump after removing redundant mode switches.
6267 @item -fdump-rtl-rnreg
6268 @opindex fdump-rtl-rnreg
6269 Dump after register renumbering.
6271 @item -fdump-rtl-outof_cfglayout
6272 @opindex fdump-rtl-outof_cfglayout
6273 Dump after converting from cfglayout mode.
6275 @item -fdump-rtl-peephole2
6276 @opindex fdump-rtl-peephole2
6277 Dump after the peephole pass.
6279 @item -fdump-rtl-postreload
6280 @opindex fdump-rtl-postreload
6281 Dump after post-reload optimizations.
6283 @item -fdump-rtl-pro_and_epilogue
6284 @opindex fdump-rtl-pro_and_epilogue
6285 Dump after generating the function prologues and epilogues.
6287 @item -fdump-rtl-sched1
6288 @itemx -fdump-rtl-sched2
6289 @opindex fdump-rtl-sched1
6290 @opindex fdump-rtl-sched2
6291 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6292 after the basic block scheduling passes.
6294 @item -fdump-rtl-ree
6295 @opindex fdump-rtl-ree
6296 Dump after sign/zero extension elimination.
6298 @item -fdump-rtl-seqabstr
6299 @opindex fdump-rtl-seqabstr
6300 Dump after common sequence discovery.
6302 @item -fdump-rtl-shorten
6303 @opindex fdump-rtl-shorten
6304 Dump after shortening branches.
6306 @item -fdump-rtl-sibling
6307 @opindex fdump-rtl-sibling
6308 Dump after sibling call optimizations.
6310 @item -fdump-rtl-split1
6311 @itemx -fdump-rtl-split2
6312 @itemx -fdump-rtl-split3
6313 @itemx -fdump-rtl-split4
6314 @itemx -fdump-rtl-split5
6315 @opindex fdump-rtl-split1
6316 @opindex fdump-rtl-split2
6317 @opindex fdump-rtl-split3
6318 @opindex fdump-rtl-split4
6319 @opindex fdump-rtl-split5
6320 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6321 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6322 @option{-fdump-rtl-split5} enable dumping after five rounds of
6323 instruction splitting.
6325 @item -fdump-rtl-sms
6326 @opindex fdump-rtl-sms
6327 Dump after modulo scheduling.  This pass is only run on some
6328 architectures.
6330 @item -fdump-rtl-stack
6331 @opindex fdump-rtl-stack
6332 Dump after conversion from GCC's ``flat register file'' registers to the
6333 x87's stack-like registers.  This pass is only run on x86 variants.
6335 @item -fdump-rtl-subreg1
6336 @itemx -fdump-rtl-subreg2
6337 @opindex fdump-rtl-subreg1
6338 @opindex fdump-rtl-subreg2
6339 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6340 the two subreg expansion passes.
6342 @item -fdump-rtl-unshare
6343 @opindex fdump-rtl-unshare
6344 Dump after all rtl has been unshared.
6346 @item -fdump-rtl-vartrack
6347 @opindex fdump-rtl-vartrack
6348 Dump after variable tracking.
6350 @item -fdump-rtl-vregs
6351 @opindex fdump-rtl-vregs
6352 Dump after converting virtual registers to hard registers.
6354 @item -fdump-rtl-web
6355 @opindex fdump-rtl-web
6356 Dump after live range splitting.
6358 @item -fdump-rtl-regclass
6359 @itemx -fdump-rtl-subregs_of_mode_init
6360 @itemx -fdump-rtl-subregs_of_mode_finish
6361 @itemx -fdump-rtl-dfinit
6362 @itemx -fdump-rtl-dfinish
6363 @opindex fdump-rtl-regclass
6364 @opindex fdump-rtl-subregs_of_mode_init
6365 @opindex fdump-rtl-subregs_of_mode_finish
6366 @opindex fdump-rtl-dfinit
6367 @opindex fdump-rtl-dfinish
6368 These dumps are defined but always produce empty files.
6370 @item -da
6371 @itemx -fdump-rtl-all
6372 @opindex da
6373 @opindex fdump-rtl-all
6374 Produce all the dumps listed above.
6376 @item -dA
6377 @opindex dA
6378 Annotate the assembler output with miscellaneous debugging information.
6380 @item -dD
6381 @opindex dD
6382 Dump all macro definitions, at the end of preprocessing, in addition to
6383 normal output.
6385 @item -dH
6386 @opindex dH
6387 Produce a core dump whenever an error occurs.
6389 @item -dp
6390 @opindex dp
6391 Annotate the assembler output with a comment indicating which
6392 pattern and alternative is used.  The length of each instruction is
6393 also printed.
6395 @item -dP
6396 @opindex dP
6397 Dump the RTL in the assembler output as a comment before each instruction.
6398 Also turns on @option{-dp} annotation.
6400 @item -dx
6401 @opindex dx
6402 Just generate RTL for a function instead of compiling it.  Usually used
6403 with @option{-fdump-rtl-expand}.
6404 @end table
6406 @item -fdump-noaddr
6407 @opindex fdump-noaddr
6408 When doing debugging dumps, suppress address output.  This makes it more
6409 feasible to use diff on debugging dumps for compiler invocations with
6410 different compiler binaries and/or different
6411 text / bss / data / heap / stack / dso start locations.
6413 @item -freport-bug
6414 @opindex freport-bug
6415 Collect and dump debug information into temporary file if ICE in C/C++
6416 compiler occured.
6418 @item -fdump-unnumbered
6419 @opindex fdump-unnumbered
6420 When doing debugging dumps, suppress instruction numbers and address output.
6421 This makes it more feasible to use diff on debugging dumps for compiler
6422 invocations with different options, in particular with and without
6423 @option{-g}.
6425 @item -fdump-unnumbered-links
6426 @opindex fdump-unnumbered-links
6427 When doing debugging dumps (see @option{-d} option above), suppress
6428 instruction numbers for the links to the previous and next instructions
6429 in a sequence.
6431 @item -fdump-translation-unit @r{(C++ only)}
6432 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6433 @opindex fdump-translation-unit
6434 Dump a representation of the tree structure for the entire translation
6435 unit to a file.  The file name is made by appending @file{.tu} to the
6436 source file name, and the file is created in the same directory as the
6437 output file.  If the @samp{-@var{options}} form is used, @var{options}
6438 controls the details of the dump as described for the
6439 @option{-fdump-tree} options.
6441 @item -fdump-class-hierarchy @r{(C++ only)}
6442 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6443 @opindex fdump-class-hierarchy
6444 Dump a representation of each class's hierarchy and virtual function
6445 table layout to a file.  The file name is made by appending
6446 @file{.class} to the source file name, and the file is created in the
6447 same directory as the output file.  If the @samp{-@var{options}} form
6448 is used, @var{options} controls the details of the dump as described
6449 for the @option{-fdump-tree} options.
6451 @item -fdump-ipa-@var{switch}
6452 @opindex fdump-ipa
6453 Control the dumping at various stages of inter-procedural analysis
6454 language tree to a file.  The file name is generated by appending a
6455 switch specific suffix to the source file name, and the file is created
6456 in the same directory as the output file.  The following dumps are
6457 possible:
6459 @table @samp
6460 @item all
6461 Enables all inter-procedural analysis dumps.
6463 @item cgraph
6464 Dumps information about call-graph optimization, unused function removal,
6465 and inlining decisions.
6467 @item inline
6468 Dump after function inlining.
6470 @end table
6472 @item -fdump-passes
6473 @opindex fdump-passes
6474 Dump the list of optimization passes that are turned on and off by
6475 the current command-line options.
6477 @item -fdump-statistics-@var{option}
6478 @opindex fdump-statistics
6479 Enable and control dumping of pass statistics in a separate file.  The
6480 file name is generated by appending a suffix ending in
6481 @samp{.statistics} to the source file name, and the file is created in
6482 the same directory as the output file.  If the @samp{-@var{option}}
6483 form is used, @samp{-stats} causes counters to be summed over the
6484 whole compilation unit while @samp{-details} dumps every event as
6485 the passes generate them.  The default with no option is to sum
6486 counters for each function compiled.
6488 @item -fdump-tree-@var{switch}
6489 @itemx -fdump-tree-@var{switch}-@var{options}
6490 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6491 @opindex fdump-tree
6492 Control the dumping at various stages of processing the intermediate
6493 language tree to a file.  The file name is generated by appending a
6494 switch-specific suffix to the source file name, and the file is
6495 created in the same directory as the output file. In case of
6496 @option{=@var{filename}} option, the dump is output on the given file
6497 instead of the auto named dump files.  If the @samp{-@var{options}}
6498 form is used, @var{options} is a list of @samp{-} separated options
6499 which control the details of the dump.  Not all options are applicable
6500 to all dumps; those that are not meaningful are ignored.  The
6501 following options are available
6503 @table @samp
6504 @item address
6505 Print the address of each node.  Usually this is not meaningful as it
6506 changes according to the environment and source file.  Its primary use
6507 is for tying up a dump file with a debug environment.
6508 @item asmname
6509 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6510 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6511 use working backward from mangled names in the assembly file.
6512 @item slim
6513 When dumping front-end intermediate representations, inhibit dumping
6514 of members of a scope or body of a function merely because that scope
6515 has been reached.  Only dump such items when they are directly reachable
6516 by some other path.
6518 When dumping pretty-printed trees, this option inhibits dumping the
6519 bodies of control structures.
6521 When dumping RTL, print the RTL in slim (condensed) form instead of
6522 the default LISP-like representation.
6523 @item raw
6524 Print a raw representation of the tree.  By default, trees are
6525 pretty-printed into a C-like representation.
6526 @item details
6527 Enable more detailed dumps (not honored by every dump option). Also
6528 include information from the optimization passes.
6529 @item stats
6530 Enable dumping various statistics about the pass (not honored by every dump
6531 option).
6532 @item blocks
6533 Enable showing basic block boundaries (disabled in raw dumps).
6534 @item graph
6535 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6536 dump a representation of the control flow graph suitable for viewing with
6537 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6538 the file is pretty-printed as a subgraph, so that GraphViz can render them
6539 all in a single plot.
6541 This option currently only works for RTL dumps, and the RTL is always
6542 dumped in slim form.
6543 @item vops
6544 Enable showing virtual operands for every statement.
6545 @item lineno
6546 Enable showing line numbers for statements.
6547 @item uid
6548 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6549 @item verbose
6550 Enable showing the tree dump for each statement.
6551 @item eh
6552 Enable showing the EH region number holding each statement.
6553 @item scev
6554 Enable showing scalar evolution analysis details.
6555 @item optimized
6556 Enable showing optimization information (only available in certain
6557 passes).
6558 @item missed
6559 Enable showing missed optimization information (only available in certain
6560 passes).
6561 @item note
6562 Enable other detailed optimization information (only available in
6563 certain passes).
6564 @item =@var{filename}
6565 Instead of an auto named dump file, output into the given file
6566 name. The file names @file{stdout} and @file{stderr} are treated
6567 specially and are considered already open standard streams. For
6568 example,
6570 @smallexample
6571 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6572      -fdump-tree-pre=stderr file.c
6573 @end smallexample
6575 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6576 output on to @file{stderr}. If two conflicting dump filenames are
6577 given for the same pass, then the latter option overrides the earlier
6578 one.
6580 @item all
6581 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6582 and @option{lineno}.
6584 @item optall
6585 Turn on all optimization options, i.e., @option{optimized},
6586 @option{missed}, and @option{note}.
6587 @end table
6589 The following tree dumps are possible:
6590 @table @samp
6592 @item original
6593 @opindex fdump-tree-original
6594 Dump before any tree based optimization, to @file{@var{file}.original}.
6596 @item optimized
6597 @opindex fdump-tree-optimized
6598 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6600 @item gimple
6601 @opindex fdump-tree-gimple
6602 Dump each function before and after the gimplification pass to a file.  The
6603 file name is made by appending @file{.gimple} to the source file name.
6605 @item cfg
6606 @opindex fdump-tree-cfg
6607 Dump the control flow graph of each function to a file.  The file name is
6608 made by appending @file{.cfg} to the source file name.
6610 @item ch
6611 @opindex fdump-tree-ch
6612 Dump each function after copying loop headers.  The file name is made by
6613 appending @file{.ch} to the source file name.
6615 @item ssa
6616 @opindex fdump-tree-ssa
6617 Dump SSA related information to a file.  The file name is made by appending
6618 @file{.ssa} to the source file name.
6620 @item alias
6621 @opindex fdump-tree-alias
6622 Dump aliasing information for each function.  The file name is made by
6623 appending @file{.alias} to the source file name.
6625 @item ccp
6626 @opindex fdump-tree-ccp
6627 Dump each function after CCP@.  The file name is made by appending
6628 @file{.ccp} to the source file name.
6630 @item storeccp
6631 @opindex fdump-tree-storeccp
6632 Dump each function after STORE-CCP@.  The file name is made by appending
6633 @file{.storeccp} to the source file name.
6635 @item pre
6636 @opindex fdump-tree-pre
6637 Dump trees after partial redundancy elimination.  The file name is made
6638 by appending @file{.pre} to the source file name.
6640 @item fre
6641 @opindex fdump-tree-fre
6642 Dump trees after full redundancy elimination.  The file name is made
6643 by appending @file{.fre} to the source file name.
6645 @item copyprop
6646 @opindex fdump-tree-copyprop
6647 Dump trees after copy propagation.  The file name is made
6648 by appending @file{.copyprop} to the source file name.
6650 @item store_copyprop
6651 @opindex fdump-tree-store_copyprop
6652 Dump trees after store copy-propagation.  The file name is made
6653 by appending @file{.store_copyprop} to the source file name.
6655 @item dce
6656 @opindex fdump-tree-dce
6657 Dump each function after dead code elimination.  The file name is made by
6658 appending @file{.dce} to the source file name.
6660 @item sra
6661 @opindex fdump-tree-sra
6662 Dump each function after performing scalar replacement of aggregates.  The
6663 file name is made by appending @file{.sra} to the source file name.
6665 @item sink
6666 @opindex fdump-tree-sink
6667 Dump each function after performing code sinking.  The file name is made
6668 by appending @file{.sink} to the source file name.
6670 @item dom
6671 @opindex fdump-tree-dom
6672 Dump each function after applying dominator tree optimizations.  The file
6673 name is made by appending @file{.dom} to the source file name.
6675 @item dse
6676 @opindex fdump-tree-dse
6677 Dump each function after applying dead store elimination.  The file
6678 name is made by appending @file{.dse} to the source file name.
6680 @item phiopt
6681 @opindex fdump-tree-phiopt
6682 Dump each function after optimizing PHI nodes into straightline code.  The file
6683 name is made by appending @file{.phiopt} to the source file name.
6685 @item forwprop
6686 @opindex fdump-tree-forwprop
6687 Dump each function after forward propagating single use variables.  The file
6688 name is made by appending @file{.forwprop} to the source file name.
6690 @item copyrename
6691 @opindex fdump-tree-copyrename
6692 Dump each function after applying the copy rename optimization.  The file
6693 name is made by appending @file{.copyrename} to the source file name.
6695 @item nrv
6696 @opindex fdump-tree-nrv
6697 Dump each function after applying the named return value optimization on
6698 generic trees.  The file name is made by appending @file{.nrv} to the source
6699 file name.
6701 @item vect
6702 @opindex fdump-tree-vect
6703 Dump each function after applying vectorization of loops.  The file name is
6704 made by appending @file{.vect} to the source file name.
6706 @item slp
6707 @opindex fdump-tree-slp
6708 Dump each function after applying vectorization of basic blocks.  The file name
6709 is made by appending @file{.slp} to the source file name.
6711 @item vrp
6712 @opindex fdump-tree-vrp
6713 Dump each function after Value Range Propagation (VRP).  The file name
6714 is made by appending @file{.vrp} to the source file name.
6716 @item all
6717 @opindex fdump-tree-all
6718 Enable all the available tree dumps with the flags provided in this option.
6719 @end table
6721 @item -fopt-info
6722 @itemx -fopt-info-@var{options}
6723 @itemx -fopt-info-@var{options}=@var{filename}
6724 @opindex fopt-info
6725 Controls optimization dumps from various optimization passes. If the
6726 @samp{-@var{options}} form is used, @var{options} is a list of
6727 @samp{-} separated options to select the dump details and
6728 optimizations.  If @var{options} is not specified, it defaults to
6729 @option{optimized} for details and @option{optall} for optimization
6730 groups. If the @var{filename} is not specified, it defaults to
6731 @file{stderr}. Note that the output @var{filename} will be overwritten
6732 in case of multiple translation units. If a combined output from
6733 multiple translation units is desired, @file{stderr} should be used
6734 instead.
6736 The options can be divided into two groups, 1) options describing the
6737 verbosity of the dump, and 2) options describing which optimizations
6738 should be included. The options from both the groups can be freely
6739 mixed as they are non-overlapping. However, in case of any conflicts,
6740 the latter options override the earlier options on the command
6741 line. Though multiple -fopt-info options are accepted, only one of
6742 them can have @option{=filename}. If other filenames are provided then
6743 all but the first one are ignored.
6745 The dump verbosity has the following options
6747 @table @samp
6748 @item optimized
6749 Print information when an optimization is successfully applied. It is
6750 up to a pass to decide which information is relevant. For example, the
6751 vectorizer passes print the source location of loops which got
6752 successfully vectorized.
6753 @item missed
6754 Print information about missed optimizations. Individual passes
6755 control which information to include in the output. For example,
6757 @smallexample
6758 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6759 @end smallexample
6761 will print information about missed optimization opportunities from
6762 vectorization passes on stderr.
6763 @item note
6764 Print verbose information about optimizations, such as certain
6765 transformations, more detailed messages about decisions etc.
6766 @item all
6767 Print detailed optimization information. This includes
6768 @var{optimized}, @var{missed}, and @var{note}.
6769 @end table
6771 The second set of options describes a group of optimizations and may
6772 include one or more of the following.
6774 @table @samp
6775 @item ipa
6776 Enable dumps from all interprocedural optimizations.
6777 @item loop
6778 Enable dumps from all loop optimizations.
6779 @item inline
6780 Enable dumps from all inlining optimizations.
6781 @item vec
6782 Enable dumps from all vectorization optimizations.
6783 @item optall
6784 Enable dumps from all optimizations. This is a superset of
6785 the optimization groups listed above.
6786 @end table
6788 For example,
6789 @smallexample
6790 gcc -O3 -fopt-info-missed=missed.all
6791 @end smallexample
6793 outputs missed optimization report from all the passes into
6794 @file{missed.all}.
6796 As another example,
6797 @smallexample
6798 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6799 @end smallexample
6801 will output information about missed optimizations as well as
6802 optimized locations from all the inlining passes into
6803 @file{inline.txt}.
6805 If the @var{filename} is provided, then the dumps from all the
6806 applicable optimizations are concatenated into the @file{filename}.
6807 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6808 omitted, it defaults to @option{all-optall}, which means dump all
6809 available optimization info from all the passes. In the following
6810 example, all optimization info is output on to @file{stderr}.
6812 @smallexample
6813 gcc -O3 -fopt-info
6814 @end smallexample
6816 Note that @option{-fopt-info-vec-missed} behaves the same as
6817 @option{-fopt-info-missed-vec}.
6819 As another example, consider
6821 @smallexample
6822 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6823 @end smallexample
6825 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6826 in conflict since only one output file is allowed. In this case, only
6827 the first option takes effect and the subsequent options are
6828 ignored. Thus only the @file{vec.miss} is produced which contains
6829 dumps from the vectorizer about missed opportunities.
6831 @item -frandom-seed=@var{number}
6832 @opindex frandom-seed
6833 This option provides a seed that GCC uses in place of
6834 random numbers in generating certain symbol names
6835 that have to be different in every compiled file.  It is also used to
6836 place unique stamps in coverage data files and the object files that
6837 produce them.  You can use the @option{-frandom-seed} option to produce
6838 reproducibly identical object files.
6840 The @var{number} should be different for every file you compile.
6842 @item -fsched-verbose=@var{n}
6843 @opindex fsched-verbose
6844 On targets that use instruction scheduling, this option controls the
6845 amount of debugging output the scheduler prints.  This information is
6846 written to standard error, unless @option{-fdump-rtl-sched1} or
6847 @option{-fdump-rtl-sched2} is specified, in which case it is output
6848 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6849 respectively.  However for @var{n} greater than nine, the output is
6850 always printed to standard error.
6852 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6853 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6854 For @var{n} greater than one, it also output basic block probabilities,
6855 detailed ready list information and unit/insn info.  For @var{n} greater
6856 than two, it includes RTL at abort point, control-flow and regions info.
6857 And for @var{n} over four, @option{-fsched-verbose} also includes
6858 dependence info.
6860 @item -save-temps
6861 @itemx -save-temps=cwd
6862 @opindex save-temps
6863 Store the usual ``temporary'' intermediate files permanently; place them
6864 in the current directory and name them based on the source file.  Thus,
6865 compiling @file{foo.c} with @option{-c -save-temps} produces files
6866 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6867 preprocessed @file{foo.i} output file even though the compiler now
6868 normally uses an integrated preprocessor.
6870 When used in combination with the @option{-x} command-line option,
6871 @option{-save-temps} is sensible enough to avoid over writing an
6872 input source file with the same extension as an intermediate file.
6873 The corresponding intermediate file may be obtained by renaming the
6874 source file before using @option{-save-temps}.
6876 If you invoke GCC in parallel, compiling several different source
6877 files that share a common base name in different subdirectories or the
6878 same source file compiled for multiple output destinations, it is
6879 likely that the different parallel compilers will interfere with each
6880 other, and overwrite the temporary files.  For instance:
6882 @smallexample
6883 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6884 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6885 @end smallexample
6887 may result in @file{foo.i} and @file{foo.o} being written to
6888 simultaneously by both compilers.
6890 @item -save-temps=obj
6891 @opindex save-temps=obj
6892 Store the usual ``temporary'' intermediate files permanently.  If the
6893 @option{-o} option is used, the temporary files are based on the
6894 object file.  If the @option{-o} option is not used, the
6895 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6897 For example:
6899 @smallexample
6900 gcc -save-temps=obj -c foo.c
6901 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6902 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6903 @end smallexample
6905 @noindent
6906 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6907 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6908 @file{dir2/yfoobar.o}.
6910 @item -time@r{[}=@var{file}@r{]}
6911 @opindex time
6912 Report the CPU time taken by each subprocess in the compilation
6913 sequence.  For C source files, this is the compiler proper and assembler
6914 (plus the linker if linking is done).
6916 Without the specification of an output file, the output looks like this:
6918 @smallexample
6919 # cc1 0.12 0.01
6920 # as 0.00 0.01
6921 @end smallexample
6923 The first number on each line is the ``user time'', that is time spent
6924 executing the program itself.  The second number is ``system time'',
6925 time spent executing operating system routines on behalf of the program.
6926 Both numbers are in seconds.
6928 With the specification of an output file, the output is appended to the
6929 named file, and it looks like this:
6931 @smallexample
6932 0.12 0.01 cc1 @var{options}
6933 0.00 0.01 as @var{options}
6934 @end smallexample
6936 The ``user time'' and the ``system time'' are moved before the program
6937 name, and the options passed to the program are displayed, so that one
6938 can later tell what file was being compiled, and with which options.
6940 @item -fvar-tracking
6941 @opindex fvar-tracking
6942 Run variable tracking pass.  It computes where variables are stored at each
6943 position in code.  Better debugging information is then generated
6944 (if the debugging information format supports this information).
6946 It is enabled by default when compiling with optimization (@option{-Os},
6947 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6948 the debug info format supports it.
6950 @item -fvar-tracking-assignments
6951 @opindex fvar-tracking-assignments
6952 @opindex fno-var-tracking-assignments
6953 Annotate assignments to user variables early in the compilation and
6954 attempt to carry the annotations over throughout the compilation all the
6955 way to the end, in an attempt to improve debug information while
6956 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6958 It can be enabled even if var-tracking is disabled, in which case
6959 annotations are created and maintained, but discarded at the end.
6961 @item -fvar-tracking-assignments-toggle
6962 @opindex fvar-tracking-assignments-toggle
6963 @opindex fno-var-tracking-assignments-toggle
6964 Toggle @option{-fvar-tracking-assignments}, in the same way that
6965 @option{-gtoggle} toggles @option{-g}.
6967 @item -print-file-name=@var{library}
6968 @opindex print-file-name
6969 Print the full absolute name of the library file @var{library} that
6970 would be used when linking---and don't do anything else.  With this
6971 option, GCC does not compile or link anything; it just prints the
6972 file name.
6974 @item -print-multi-directory
6975 @opindex print-multi-directory
6976 Print the directory name corresponding to the multilib selected by any
6977 other switches present in the command line.  This directory is supposed
6978 to exist in @env{GCC_EXEC_PREFIX}.
6980 @item -print-multi-lib
6981 @opindex print-multi-lib
6982 Print the mapping from multilib directory names to compiler switches
6983 that enable them.  The directory name is separated from the switches by
6984 @samp{;}, and each switch starts with an @samp{@@} instead of the
6985 @samp{-}, without spaces between multiple switches.  This is supposed to
6986 ease shell processing.
6988 @item -print-multi-os-directory
6989 @opindex print-multi-os-directory
6990 Print the path to OS libraries for the selected
6991 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6992 present in the @file{lib} subdirectory and no multilibs are used, this is
6993 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6994 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6995 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6996 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6998 @item -print-multiarch
6999 @opindex print-multiarch
7000 Print the path to OS libraries for the selected multiarch,
7001 relative to some @file{lib} subdirectory.
7003 @item -print-prog-name=@var{program}
7004 @opindex print-prog-name
7005 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
7007 @item -print-libgcc-file-name
7008 @opindex print-libgcc-file-name
7009 Same as @option{-print-file-name=libgcc.a}.
7011 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7012 but you do want to link with @file{libgcc.a}.  You can do:
7014 @smallexample
7015 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7016 @end smallexample
7018 @item -print-search-dirs
7019 @opindex print-search-dirs
7020 Print the name of the configured installation directory and a list of
7021 program and library directories @command{gcc} searches---and don't do anything else.
7023 This is useful when @command{gcc} prints the error message
7024 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7025 To resolve this you either need to put @file{cpp0} and the other compiler
7026 components where @command{gcc} expects to find them, or you can set the environment
7027 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7028 Don't forget the trailing @samp{/}.
7029 @xref{Environment Variables}.
7031 @item -print-sysroot
7032 @opindex print-sysroot
7033 Print the target sysroot directory that is used during
7034 compilation.  This is the target sysroot specified either at configure
7035 time or using the @option{--sysroot} option, possibly with an extra
7036 suffix that depends on compilation options.  If no target sysroot is
7037 specified, the option prints nothing.
7039 @item -print-sysroot-headers-suffix
7040 @opindex print-sysroot-headers-suffix
7041 Print the suffix added to the target sysroot when searching for
7042 headers, or give an error if the compiler is not configured with such
7043 a suffix---and don't do anything else.
7045 @item -dumpmachine
7046 @opindex dumpmachine
7047 Print the compiler's target machine (for example,
7048 @samp{i686-pc-linux-gnu})---and don't do anything else.
7050 @item -dumpversion
7051 @opindex dumpversion
7052 Print the compiler version (for example, @samp{3.0})---and don't do
7053 anything else.
7055 @item -dumpspecs
7056 @opindex dumpspecs
7057 Print the compiler's built-in specs---and don't do anything else.  (This
7058 is used when GCC itself is being built.)  @xref{Spec Files}.
7060 @item -fno-eliminate-unused-debug-types
7061 @opindex feliminate-unused-debug-types
7062 @opindex fno-eliminate-unused-debug-types
7063 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7064 output for types that are nowhere used in the source file being compiled.
7065 Sometimes it is useful to have GCC emit debugging
7066 information for all types declared in a compilation
7067 unit, regardless of whether or not they are actually used
7068 in that compilation unit, for example 
7069 if, in the debugger, you want to cast a value to a type that is
7070 not actually used in your program (but is declared).  More often,
7071 however, this results in a significant amount of wasted space.
7072 @end table
7074 @node Optimize Options
7075 @section Options That Control Optimization
7076 @cindex optimize options
7077 @cindex options, optimization
7079 These options control various sorts of optimizations.
7081 Without any optimization option, the compiler's goal is to reduce the
7082 cost of compilation and to make debugging produce the expected
7083 results.  Statements are independent: if you stop the program with a
7084 breakpoint between statements, you can then assign a new value to any
7085 variable or change the program counter to any other statement in the
7086 function and get exactly the results you expect from the source
7087 code.
7089 Turning on optimization flags makes the compiler attempt to improve
7090 the performance and/or code size at the expense of compilation time
7091 and possibly the ability to debug the program.
7093 The compiler performs optimization based on the knowledge it has of the
7094 program.  Compiling multiple files at once to a single output file mode allows
7095 the compiler to use information gained from all of the files when compiling
7096 each of them.
7098 Not all optimizations are controlled directly by a flag.  Only
7099 optimizations that have a flag are listed in this section.
7101 Most optimizations are only enabled if an @option{-O} level is set on
7102 the command line.  Otherwise they are disabled, even if individual
7103 optimization flags are specified.
7105 Depending on the target and how GCC was configured, a slightly different
7106 set of optimizations may be enabled at each @option{-O} level than
7107 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7108 to find out the exact set of optimizations that are enabled at each level.
7109 @xref{Overall Options}, for examples.
7111 @table @gcctabopt
7112 @item -O
7113 @itemx -O1
7114 @opindex O
7115 @opindex O1
7116 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7117 more memory for a large function.
7119 With @option{-O}, the compiler tries to reduce code size and execution
7120 time, without performing any optimizations that take a great deal of
7121 compilation time.
7123 @option{-O} turns on the following optimization flags:
7124 @gccoptlist{
7125 -fauto-inc-dec @gol
7126 -fbranch-count-reg @gol
7127 -fcombine-stack-adjustments @gol
7128 -fcompare-elim @gol
7129 -fcprop-registers @gol
7130 -fdce @gol
7131 -fdefer-pop @gol
7132 -fdelayed-branch @gol
7133 -fdse @gol
7134 -fforward-propagate @gol
7135 -fguess-branch-probability @gol
7136 -fif-conversion2 @gol
7137 -fif-conversion @gol
7138 -finline-functions-called-once @gol
7139 -fipa-pure-const @gol
7140 -fipa-profile @gol
7141 -fipa-reference @gol
7142 -fmerge-constants @gol
7143 -fmove-loop-invariants @gol
7144 -fshrink-wrap @gol
7145 -fsplit-wide-types @gol
7146 -ftree-bit-ccp @gol
7147 -ftree-ccp @gol
7148 -fssa-phiopt @gol
7149 -ftree-ch @gol
7150 -ftree-copy-prop @gol
7151 -ftree-copyrename @gol
7152 -ftree-dce @gol
7153 -ftree-dominator-opts @gol
7154 -ftree-dse @gol
7155 -ftree-forwprop @gol
7156 -ftree-fre @gol
7157 -ftree-phiprop @gol
7158 -ftree-sink @gol
7159 -ftree-slsr @gol
7160 -ftree-sra @gol
7161 -ftree-pta @gol
7162 -ftree-ter @gol
7163 -funit-at-a-time}
7165 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7166 where doing so does not interfere with debugging.
7168 @item -O2
7169 @opindex O2
7170 Optimize even more.  GCC performs nearly all supported optimizations
7171 that do not involve a space-speed tradeoff.
7172 As compared to @option{-O}, this option increases both compilation time
7173 and the performance of the generated code.
7175 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7176 also turns on the following optimization flags:
7177 @gccoptlist{-fthread-jumps @gol
7178 -falign-functions  -falign-jumps @gol
7179 -falign-loops  -falign-labels @gol
7180 -fcaller-saves @gol
7181 -fcrossjumping @gol
7182 -fcse-follow-jumps  -fcse-skip-blocks @gol
7183 -fdelete-null-pointer-checks @gol
7184 -fdevirtualize -fdevirtualize-speculatively @gol
7185 -fexpensive-optimizations @gol
7186 -fgcse  -fgcse-lm  @gol
7187 -fhoist-adjacent-loads @gol
7188 -finline-small-functions @gol
7189 -findirect-inlining @gol
7190 -fipa-cp @gol
7191 -fipa-sra @gol
7192 -fipa-icf @gol
7193 -fisolate-erroneous-paths-dereference @gol
7194 -flra-remat @gol
7195 -foptimize-sibling-calls @gol
7196 -foptimize-strlen @gol
7197 -fpartial-inlining @gol
7198 -fpeephole2 @gol
7199 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7200 -frerun-cse-after-loop  @gol
7201 -fsched-interblock  -fsched-spec @gol
7202 -fschedule-insns  -fschedule-insns2 @gol
7203 -fstrict-aliasing -fstrict-overflow @gol
7204 -ftree-builtin-call-dce @gol
7205 -ftree-switch-conversion -ftree-tail-merge @gol
7206 -ftree-pre @gol
7207 -ftree-vrp @gol
7208 -fipa-ra}
7210 Please note the warning under @option{-fgcse} about
7211 invoking @option{-O2} on programs that use computed gotos.
7213 @item -O3
7214 @opindex O3
7215 Optimize yet more.  @option{-O3} turns on all optimizations specified
7216 by @option{-O2} and also turns on the @option{-finline-functions},
7217 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7218 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7219 @option{-ftree-loop-distribute-patterns},
7220 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7221 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7223 @item -O0
7224 @opindex O0
7225 Reduce compilation time and make debugging produce the expected
7226 results.  This is the default.
7228 @item -Os
7229 @opindex Os
7230 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7231 do not typically increase code size.  It also performs further
7232 optimizations designed to reduce code size.
7234 @option{-Os} disables the following optimization flags:
7235 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7236 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7237 -fprefetch-loop-arrays}
7239 @item -Ofast
7240 @opindex Ofast
7241 Disregard strict standards compliance.  @option{-Ofast} enables all
7242 @option{-O3} optimizations.  It also enables optimizations that are not
7243 valid for all standard-compliant programs.
7244 It turns on @option{-ffast-math} and the Fortran-specific
7245 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7247 @item -Og
7248 @opindex Og
7249 Optimize debugging experience.  @option{-Og} enables optimizations
7250 that do not interfere with debugging. It should be the optimization
7251 level of choice for the standard edit-compile-debug cycle, offering
7252 a reasonable level of optimization while maintaining fast compilation
7253 and a good debugging experience.
7255 If you use multiple @option{-O} options, with or without level numbers,
7256 the last such option is the one that is effective.
7257 @end table
7259 Options of the form @option{-f@var{flag}} specify machine-independent
7260 flags.  Most flags have both positive and negative forms; the negative
7261 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7262 below, only one of the forms is listed---the one you typically 
7263 use.  You can figure out the other form by either removing @samp{no-}
7264 or adding it.
7266 The following options control specific optimizations.  They are either
7267 activated by @option{-O} options or are related to ones that are.  You
7268 can use the following flags in the rare cases when ``fine-tuning'' of
7269 optimizations to be performed is desired.
7271 @table @gcctabopt
7272 @item -fno-defer-pop
7273 @opindex fno-defer-pop
7274 Always pop the arguments to each function call as soon as that function
7275 returns.  For machines that must pop arguments after a function call,
7276 the compiler normally lets arguments accumulate on the stack for several
7277 function calls and pops them all at once.
7279 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7281 @item -fforward-propagate
7282 @opindex fforward-propagate
7283 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7284 instructions and checks if the result can be simplified.  If loop unrolling
7285 is active, two passes are performed and the second is scheduled after
7286 loop unrolling.
7288 This option is enabled by default at optimization levels @option{-O},
7289 @option{-O2}, @option{-O3}, @option{-Os}.
7291 @item -ffp-contract=@var{style}
7292 @opindex ffp-contract
7293 @option{-ffp-contract=off} disables floating-point expression contraction.
7294 @option{-ffp-contract=fast} enables floating-point expression contraction
7295 such as forming of fused multiply-add operations if the target has
7296 native support for them.
7297 @option{-ffp-contract=on} enables floating-point expression contraction
7298 if allowed by the language standard.  This is currently not implemented
7299 and treated equal to @option{-ffp-contract=off}.
7301 The default is @option{-ffp-contract=fast}.
7303 @item -fomit-frame-pointer
7304 @opindex fomit-frame-pointer
7305 Don't keep the frame pointer in a register for functions that
7306 don't need one.  This avoids the instructions to save, set up and
7307 restore frame pointers; it also makes an extra register available
7308 in many functions.  @strong{It also makes debugging impossible on
7309 some machines.}
7311 On some machines, such as the VAX, this flag has no effect, because
7312 the standard calling sequence automatically handles the frame pointer
7313 and nothing is saved by pretending it doesn't exist.  The
7314 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7315 whether a target machine supports this flag.  @xref{Registers,,Register
7316 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7318 Starting with GCC version 4.6, the default setting (when not optimizing for
7319 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7320 @option{-fomit-frame-pointer}.  The default can be reverted to
7321 @option{-fno-omit-frame-pointer} by configuring GCC with the
7322 @option{--enable-frame-pointer} configure option.
7324 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7326 @item -foptimize-sibling-calls
7327 @opindex foptimize-sibling-calls
7328 Optimize sibling and tail recursive calls.
7330 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7332 @item -foptimize-strlen
7333 @opindex foptimize-strlen
7334 Optimize various standard C string functions (e.g. @code{strlen},
7335 @code{strchr} or @code{strcpy}) and
7336 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7338 Enabled at levels @option{-O2}, @option{-O3}.
7340 @item -fno-inline
7341 @opindex fno-inline
7342 Do not expand any functions inline apart from those marked with
7343 the @code{always_inline} attribute.  This is the default when not
7344 optimizing.
7346 Single functions can be exempted from inlining by marking them
7347 with the @code{noinline} attribute.
7349 @item -finline-small-functions
7350 @opindex finline-small-functions
7351 Integrate functions into their callers when their body is smaller than expected
7352 function call code (so overall size of program gets smaller).  The compiler
7353 heuristically decides which functions are simple enough to be worth integrating
7354 in this way.  This inlining applies to all functions, even those not declared
7355 inline.
7357 Enabled at level @option{-O2}.
7359 @item -findirect-inlining
7360 @opindex findirect-inlining
7361 Inline also indirect calls that are discovered to be known at compile
7362 time thanks to previous inlining.  This option has any effect only
7363 when inlining itself is turned on by the @option{-finline-functions}
7364 or @option{-finline-small-functions} options.
7366 Enabled at level @option{-O2}.
7368 @item -finline-functions
7369 @opindex finline-functions
7370 Consider all functions for inlining, even if they are not declared inline.
7371 The compiler heuristically decides which functions are worth integrating
7372 in this way.
7374 If all calls to a given function are integrated, and the function is
7375 declared @code{static}, then the function is normally not output as
7376 assembler code in its own right.
7378 Enabled at level @option{-O3}.
7380 @item -finline-functions-called-once
7381 @opindex finline-functions-called-once
7382 Consider all @code{static} functions called once for inlining into their
7383 caller even if they are not marked @code{inline}.  If a call to a given
7384 function is integrated, then the function is not output as assembler code
7385 in its own right.
7387 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7389 @item -fearly-inlining
7390 @opindex fearly-inlining
7391 Inline functions marked by @code{always_inline} and functions whose body seems
7392 smaller than the function call overhead early before doing
7393 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7394 makes profiling significantly cheaper and usually inlining faster on programs
7395 having large chains of nested wrapper functions.
7397 Enabled by default.
7399 @item -fipa-sra
7400 @opindex fipa-sra
7401 Perform interprocedural scalar replacement of aggregates, removal of
7402 unused parameters and replacement of parameters passed by reference
7403 by parameters passed by value.
7405 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7407 @item -finline-limit=@var{n}
7408 @opindex finline-limit
7409 By default, GCC limits the size of functions that can be inlined.  This flag
7410 allows coarse control of this limit.  @var{n} is the size of functions that
7411 can be inlined in number of pseudo instructions.
7413 Inlining is actually controlled by a number of parameters, which may be
7414 specified individually by using @option{--param @var{name}=@var{value}}.
7415 The @option{-finline-limit=@var{n}} option sets some of these parameters
7416 as follows:
7418 @table @gcctabopt
7419 @item max-inline-insns-single
7420 is set to @var{n}/2.
7421 @item max-inline-insns-auto
7422 is set to @var{n}/2.
7423 @end table
7425 See below for a documentation of the individual
7426 parameters controlling inlining and for the defaults of these parameters.
7428 @emph{Note:} there may be no value to @option{-finline-limit} that results
7429 in default behavior.
7431 @emph{Note:} pseudo instruction represents, in this particular context, an
7432 abstract measurement of function's size.  In no way does it represent a count
7433 of assembly instructions and as such its exact meaning might change from one
7434 release to an another.
7436 @item -fno-keep-inline-dllexport
7437 @opindex -fno-keep-inline-dllexport
7438 This is a more fine-grained version of @option{-fkeep-inline-functions},
7439 which applies only to functions that are declared using the @code{dllexport}
7440 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7441 Functions}.)
7443 @item -fkeep-inline-functions
7444 @opindex fkeep-inline-functions
7445 In C, emit @code{static} functions that are declared @code{inline}
7446 into the object file, even if the function has been inlined into all
7447 of its callers.  This switch does not affect functions using the
7448 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7449 inline functions into the object file.
7451 @item -fkeep-static-consts
7452 @opindex fkeep-static-consts
7453 Emit variables declared @code{static const} when optimization isn't turned
7454 on, even if the variables aren't referenced.
7456 GCC enables this option by default.  If you want to force the compiler to
7457 check if a variable is referenced, regardless of whether or not
7458 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7460 @item -fmerge-constants
7461 @opindex fmerge-constants
7462 Attempt to merge identical constants (string constants and floating-point
7463 constants) across compilation units.
7465 This option is the default for optimized compilation if the assembler and
7466 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7467 behavior.
7469 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7471 @item -fmerge-all-constants
7472 @opindex fmerge-all-constants
7473 Attempt to merge identical constants and identical variables.
7475 This option implies @option{-fmerge-constants}.  In addition to
7476 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7477 arrays or initialized constant variables with integral or floating-point
7478 types.  Languages like C or C++ require each variable, including multiple
7479 instances of the same variable in recursive calls, to have distinct locations,
7480 so using this option results in non-conforming
7481 behavior.
7483 @item -fmodulo-sched
7484 @opindex fmodulo-sched
7485 Perform swing modulo scheduling immediately before the first scheduling
7486 pass.  This pass looks at innermost loops and reorders their
7487 instructions by overlapping different iterations.
7489 @item -fmodulo-sched-allow-regmoves
7490 @opindex fmodulo-sched-allow-regmoves
7491 Perform more aggressive SMS-based modulo scheduling with register moves
7492 allowed.  By setting this flag certain anti-dependences edges are
7493 deleted, which triggers the generation of reg-moves based on the
7494 life-range analysis.  This option is effective only with
7495 @option{-fmodulo-sched} enabled.
7497 @item -fno-branch-count-reg
7498 @opindex fno-branch-count-reg
7499 Do not use ``decrement and branch'' instructions on a count register,
7500 but instead generate a sequence of instructions that decrement a
7501 register, compare it against zero, then branch based upon the result.
7502 This option is only meaningful on architectures that support such
7503 instructions, which include x86, PowerPC, IA-64 and S/390.
7505 Enabled by default at @option{-O1} and higher.
7507 The default is @option{-fbranch-count-reg}.
7509 @item -fno-function-cse
7510 @opindex fno-function-cse
7511 Do not put function addresses in registers; make each instruction that
7512 calls a constant function contain the function's address explicitly.
7514 This option results in less efficient code, but some strange hacks
7515 that alter the assembler output may be confused by the optimizations
7516 performed when this option is not used.
7518 The default is @option{-ffunction-cse}
7520 @item -fno-zero-initialized-in-bss
7521 @opindex fno-zero-initialized-in-bss
7522 If the target supports a BSS section, GCC by default puts variables that
7523 are initialized to zero into BSS@.  This can save space in the resulting
7524 code.
7526 This option turns off this behavior because some programs explicitly
7527 rely on variables going to the data section---e.g., so that the
7528 resulting executable can find the beginning of that section and/or make
7529 assumptions based on that.
7531 The default is @option{-fzero-initialized-in-bss}.
7533 @item -fthread-jumps
7534 @opindex fthread-jumps
7535 Perform optimizations that check to see if a jump branches to a
7536 location where another comparison subsumed by the first is found.  If
7537 so, the first branch is redirected to either the destination of the
7538 second branch or a point immediately following it, depending on whether
7539 the condition is known to be true or false.
7541 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7543 @item -fsplit-wide-types
7544 @opindex fsplit-wide-types
7545 When using a type that occupies multiple registers, such as @code{long
7546 long} on a 32-bit system, split the registers apart and allocate them
7547 independently.  This normally generates better code for those types,
7548 but may make debugging more difficult.
7550 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7551 @option{-Os}.
7553 @item -fcse-follow-jumps
7554 @opindex fcse-follow-jumps
7555 In common subexpression elimination (CSE), scan through jump instructions
7556 when the target of the jump is not reached by any other path.  For
7557 example, when CSE encounters an @code{if} statement with an
7558 @code{else} clause, CSE follows the jump when the condition
7559 tested is false.
7561 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7563 @item -fcse-skip-blocks
7564 @opindex fcse-skip-blocks
7565 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7566 follow jumps that conditionally skip over blocks.  When CSE
7567 encounters a simple @code{if} statement with no else clause,
7568 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7569 body of the @code{if}.
7571 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7573 @item -frerun-cse-after-loop
7574 @opindex frerun-cse-after-loop
7575 Re-run common subexpression elimination after loop optimizations are
7576 performed.
7578 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7580 @item -fgcse
7581 @opindex fgcse
7582 Perform a global common subexpression elimination pass.
7583 This pass also performs global constant and copy propagation.
7585 @emph{Note:} When compiling a program using computed gotos, a GCC
7586 extension, you may get better run-time performance if you disable
7587 the global common subexpression elimination pass by adding
7588 @option{-fno-gcse} to the command line.
7590 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7592 @item -fgcse-lm
7593 @opindex fgcse-lm
7594 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7595 attempts to move loads that are only killed by stores into themselves.  This
7596 allows a loop containing a load/store sequence to be changed to a load outside
7597 the loop, and a copy/store within the loop.
7599 Enabled by default when @option{-fgcse} is enabled.
7601 @item -fgcse-sm
7602 @opindex fgcse-sm
7603 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7604 global common subexpression elimination.  This pass attempts to move
7605 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7606 loops containing a load/store sequence can be changed to a load before
7607 the loop and a store after the loop.
7609 Not enabled at any optimization level.
7611 @item -fgcse-las
7612 @opindex fgcse-las
7613 When @option{-fgcse-las} is enabled, the global common subexpression
7614 elimination pass eliminates redundant loads that come after stores to the
7615 same memory location (both partial and full redundancies).
7617 Not enabled at any optimization level.
7619 @item -fgcse-after-reload
7620 @opindex fgcse-after-reload
7621 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7622 pass is performed after reload.  The purpose of this pass is to clean up
7623 redundant spilling.
7625 @item -faggressive-loop-optimizations
7626 @opindex faggressive-loop-optimizations
7627 This option tells the loop optimizer to use language constraints to
7628 derive bounds for the number of iterations of a loop.  This assumes that
7629 loop code does not invoke undefined behavior by for example causing signed
7630 integer overflows or out-of-bound array accesses.  The bounds for the
7631 number of iterations of a loop are used to guide loop unrolling and peeling
7632 and loop exit test optimizations.
7633 This option is enabled by default.
7635 @item -funsafe-loop-optimizations
7636 @opindex funsafe-loop-optimizations
7637 This option tells the loop optimizer to assume that loop indices do not
7638 overflow, and that loops with nontrivial exit condition are not
7639 infinite.  This enables a wider range of loop optimizations even if
7640 the loop optimizer itself cannot prove that these assumptions are valid.
7641 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7642 if it finds this kind of loop.
7644 @item -fcrossjumping
7645 @opindex fcrossjumping
7646 Perform cross-jumping transformation.
7647 This transformation unifies equivalent code and saves code size.  The
7648 resulting code may or may not perform better than without cross-jumping.
7650 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7652 @item -fauto-inc-dec
7653 @opindex fauto-inc-dec
7654 Combine increments or decrements of addresses with memory accesses.
7655 This pass is always skipped on architectures that do not have
7656 instructions to support this.  Enabled by default at @option{-O} and
7657 higher on architectures that support this.
7659 @item -fdce
7660 @opindex fdce
7661 Perform dead code elimination (DCE) on RTL@.
7662 Enabled by default at @option{-O} and higher.
7664 @item -fdse
7665 @opindex fdse
7666 Perform dead store elimination (DSE) on RTL@.
7667 Enabled by default at @option{-O} and higher.
7669 @item -fif-conversion
7670 @opindex fif-conversion
7671 Attempt to transform conditional jumps into branch-less equivalents.  This
7672 includes use of conditional moves, min, max, set flags and abs instructions, and
7673 some tricks doable by standard arithmetics.  The use of conditional execution
7674 on chips where it is available is controlled by @code{if-conversion2}.
7676 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7678 @item -fif-conversion2
7679 @opindex fif-conversion2
7680 Use conditional execution (where available) to transform conditional jumps into
7681 branch-less equivalents.
7683 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7685 @item -fdeclone-ctor-dtor
7686 @opindex fdeclone-ctor-dtor
7687 The C++ ABI requires multiple entry points for constructors and
7688 destructors: one for a base subobject, one for a complete object, and
7689 one for a virtual destructor that calls operator delete afterwards.
7690 For a hierarchy with virtual bases, the base and complete variants are
7691 clones, which means two copies of the function.  With this option, the
7692 base and complete variants are changed to be thunks that call a common
7693 implementation.
7695 Enabled by @option{-Os}.
7697 @item -fdelete-null-pointer-checks
7698 @opindex fdelete-null-pointer-checks
7699 Assume that programs cannot safely dereference null pointers, and that
7700 no code or data element resides there.  This enables simple constant
7701 folding optimizations at all optimization levels.  In addition, other
7702 optimization passes in GCC use this flag to control global dataflow
7703 analyses that eliminate useless checks for null pointers; these assume
7704 that if a pointer is checked after it has already been dereferenced,
7705 it cannot be null.
7707 Note however that in some environments this assumption is not true.
7708 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7709 for programs that depend on that behavior.
7711 Some targets, especially embedded ones, disable this option at all levels.
7712 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7713 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7714 are enabled independently at different optimization levels.
7716 @item -fdevirtualize
7717 @opindex fdevirtualize
7718 Attempt to convert calls to virtual functions to direct calls.  This
7719 is done both within a procedure and interprocedurally as part of
7720 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7721 propagation (@option{-fipa-cp}).
7722 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7724 @item -fdevirtualize-speculatively
7725 @opindex fdevirtualize-speculatively
7726 Attempt to convert calls to virtual functions to speculative direct calls.
7727 Based on the analysis of the type inheritance graph, determine for a given call
7728 the set of likely targets. If the set is small, preferably of size 1, change
7729 the call into an conditional deciding on direct and indirect call.  The
7730 speculative calls enable more optimizations, such as inlining.  When they seem
7731 useless after further optimization, they are converted back into original form.
7733 @item -fexpensive-optimizations
7734 @opindex fexpensive-optimizations
7735 Perform a number of minor optimizations that are relatively expensive.
7737 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7739 @item -free
7740 @opindex free
7741 Attempt to remove redundant extension instructions.  This is especially
7742 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7743 registers after writing to their lower 32-bit half.
7745 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7746 @option{-O3}, @option{-Os}.
7748 @item -flive-range-shrinkage
7749 @opindex flive-range-shrinkage
7750 Attempt to decrease register pressure through register live range
7751 shrinkage.  This is helpful for fast processors with small or moderate
7752 size register sets.
7754 @item -fira-algorithm=@var{algorithm}
7755 Use the specified coloring algorithm for the integrated register
7756 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7757 specifies Chow's priority coloring, or @samp{CB}, which specifies
7758 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7759 for all architectures, but for those targets that do support it, it is
7760 the default because it generates better code.
7762 @item -fira-region=@var{region}
7763 Use specified regions for the integrated register allocator.  The
7764 @var{region} argument should be one of the following:
7766 @table @samp
7768 @item all
7769 Use all loops as register allocation regions.
7770 This can give the best results for machines with a small and/or
7771 irregular register set.
7773 @item mixed
7774 Use all loops except for loops with small register pressure 
7775 as the regions.  This value usually gives
7776 the best results in most cases and for most architectures,
7777 and is enabled by default when compiling with optimization for speed
7778 (@option{-O}, @option{-O2}, @dots{}).
7780 @item one
7781 Use all functions as a single region.  
7782 This typically results in the smallest code size, and is enabled by default for
7783 @option{-Os} or @option{-O0}.
7785 @end table
7787 @item -fira-hoist-pressure
7788 @opindex fira-hoist-pressure
7789 Use IRA to evaluate register pressure in the code hoisting pass for
7790 decisions to hoist expressions.  This option usually results in smaller
7791 code, but it can slow the compiler down.
7793 This option is enabled at level @option{-Os} for all targets.
7795 @item -fira-loop-pressure
7796 @opindex fira-loop-pressure
7797 Use IRA to evaluate register pressure in loops for decisions to move
7798 loop invariants.  This option usually results in generation
7799 of faster and smaller code on machines with large register files (>= 32
7800 registers), but it can slow the compiler down.
7802 This option is enabled at level @option{-O3} for some targets.
7804 @item -fno-ira-share-save-slots
7805 @opindex fno-ira-share-save-slots
7806 Disable sharing of stack slots used for saving call-used hard
7807 registers living through a call.  Each hard register gets a
7808 separate stack slot, and as a result function stack frames are
7809 larger.
7811 @item -fno-ira-share-spill-slots
7812 @opindex fno-ira-share-spill-slots
7813 Disable sharing of stack slots allocated for pseudo-registers.  Each
7814 pseudo-register that does not get a hard register gets a separate
7815 stack slot, and as a result function stack frames are larger.
7817 @item -fira-verbose=@var{n}
7818 @opindex fira-verbose
7819 Control the verbosity of the dump file for the integrated register allocator.
7820 The default value is 5.  If the value @var{n} is greater or equal to 10,
7821 the dump output is sent to stderr using the same format as @var{n} minus 10.
7823 @item -flra-remat
7824 @opindex fcaller-saves
7825 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7826 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7827 values if it is profitable.
7829 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7831 @item -fdelayed-branch
7832 @opindex fdelayed-branch
7833 If supported for the target machine, attempt to reorder instructions
7834 to exploit instruction slots available after delayed branch
7835 instructions.
7837 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7839 @item -fschedule-insns
7840 @opindex fschedule-insns
7841 If supported for the target machine, attempt to reorder instructions to
7842 eliminate execution stalls due to required data being unavailable.  This
7843 helps machines that have slow floating point or memory load instructions
7844 by allowing other instructions to be issued until the result of the load
7845 or floating-point instruction is required.
7847 Enabled at levels @option{-O2}, @option{-O3}.
7849 @item -fschedule-insns2
7850 @opindex fschedule-insns2
7851 Similar to @option{-fschedule-insns}, but requests an additional pass of
7852 instruction scheduling after register allocation has been done.  This is
7853 especially useful on machines with a relatively small number of
7854 registers and where memory load instructions take more than one cycle.
7856 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7858 @item -fno-sched-interblock
7859 @opindex fno-sched-interblock
7860 Don't schedule instructions across basic blocks.  This is normally
7861 enabled by default when scheduling before register allocation, i.e.@:
7862 with @option{-fschedule-insns} or at @option{-O2} or higher.
7864 @item -fno-sched-spec
7865 @opindex fno-sched-spec
7866 Don't allow speculative motion of non-load instructions.  This is normally
7867 enabled by default when scheduling before register allocation, i.e.@:
7868 with @option{-fschedule-insns} or at @option{-O2} or higher.
7870 @item -fsched-pressure
7871 @opindex fsched-pressure
7872 Enable register pressure sensitive insn scheduling before register
7873 allocation.  This only makes sense when scheduling before register
7874 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7875 @option{-O2} or higher.  Usage of this option can improve the
7876 generated code and decrease its size by preventing register pressure
7877 increase above the number of available hard registers and subsequent
7878 spills in register allocation.
7880 @item -fsched-spec-load
7881 @opindex fsched-spec-load
7882 Allow speculative motion of some load instructions.  This only makes
7883 sense when scheduling before register allocation, i.e.@: with
7884 @option{-fschedule-insns} or at @option{-O2} or higher.
7886 @item -fsched-spec-load-dangerous
7887 @opindex fsched-spec-load-dangerous
7888 Allow speculative motion of more load instructions.  This only makes
7889 sense when scheduling before register allocation, i.e.@: with
7890 @option{-fschedule-insns} or at @option{-O2} or higher.
7892 @item -fsched-stalled-insns
7893 @itemx -fsched-stalled-insns=@var{n}
7894 @opindex fsched-stalled-insns
7895 Define how many insns (if any) can be moved prematurely from the queue
7896 of stalled insns into the ready list during the second scheduling pass.
7897 @option{-fno-sched-stalled-insns} means that no insns are moved
7898 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7899 on how many queued insns can be moved prematurely.
7900 @option{-fsched-stalled-insns} without a value is equivalent to
7901 @option{-fsched-stalled-insns=1}.
7903 @item -fsched-stalled-insns-dep
7904 @itemx -fsched-stalled-insns-dep=@var{n}
7905 @opindex fsched-stalled-insns-dep
7906 Define how many insn groups (cycles) are examined for a dependency
7907 on a stalled insn that is a candidate for premature removal from the queue
7908 of stalled insns.  This has an effect only during the second scheduling pass,
7909 and only if @option{-fsched-stalled-insns} is used.
7910 @option{-fno-sched-stalled-insns-dep} is equivalent to
7911 @option{-fsched-stalled-insns-dep=0}.
7912 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7913 @option{-fsched-stalled-insns-dep=1}.
7915 @item -fsched2-use-superblocks
7916 @opindex fsched2-use-superblocks
7917 When scheduling after register allocation, use superblock scheduling.
7918 This allows motion across basic block boundaries,
7919 resulting in faster schedules.  This option is experimental, as not all machine
7920 descriptions used by GCC model the CPU closely enough to avoid unreliable
7921 results from the algorithm.
7923 This only makes sense when scheduling after register allocation, i.e.@: with
7924 @option{-fschedule-insns2} or at @option{-O2} or higher.
7926 @item -fsched-group-heuristic
7927 @opindex fsched-group-heuristic
7928 Enable the group heuristic in the scheduler.  This heuristic favors
7929 the instruction that belongs to a schedule group.  This is enabled
7930 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7931 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7933 @item -fsched-critical-path-heuristic
7934 @opindex fsched-critical-path-heuristic
7935 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7936 instructions on the critical path.  This is enabled by default when
7937 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7938 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7940 @item -fsched-spec-insn-heuristic
7941 @opindex fsched-spec-insn-heuristic
7942 Enable the speculative instruction heuristic in the scheduler.  This
7943 heuristic favors speculative instructions with greater dependency weakness.
7944 This is enabled by default when scheduling is enabled, i.e.@:
7945 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7946 or at @option{-O2} or higher.
7948 @item -fsched-rank-heuristic
7949 @opindex fsched-rank-heuristic
7950 Enable the rank heuristic in the scheduler.  This heuristic favors
7951 the instruction belonging to a basic block with greater size or frequency.
7952 This is enabled by default when scheduling is enabled, i.e.@:
7953 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7954 at @option{-O2} or higher.
7956 @item -fsched-last-insn-heuristic
7957 @opindex fsched-last-insn-heuristic
7958 Enable the last-instruction heuristic in the scheduler.  This heuristic
7959 favors the instruction that is less dependent on the last instruction
7960 scheduled.  This is enabled by default when scheduling is enabled,
7961 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7962 at @option{-O2} or higher.
7964 @item -fsched-dep-count-heuristic
7965 @opindex fsched-dep-count-heuristic
7966 Enable the dependent-count heuristic in the scheduler.  This heuristic
7967 favors the instruction that has more instructions depending on it.
7968 This is enabled by default when scheduling is enabled, i.e.@:
7969 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7970 at @option{-O2} or higher.
7972 @item -freschedule-modulo-scheduled-loops
7973 @opindex freschedule-modulo-scheduled-loops
7974 Modulo scheduling is performed before traditional scheduling.  If a loop
7975 is modulo scheduled, later scheduling passes may change its schedule.  
7976 Use this option to control that behavior.
7978 @item -fselective-scheduling
7979 @opindex fselective-scheduling
7980 Schedule instructions using selective scheduling algorithm.  Selective
7981 scheduling runs instead of the first scheduler pass.
7983 @item -fselective-scheduling2
7984 @opindex fselective-scheduling2
7985 Schedule instructions using selective scheduling algorithm.  Selective
7986 scheduling runs instead of the second scheduler pass.
7988 @item -fsel-sched-pipelining
7989 @opindex fsel-sched-pipelining
7990 Enable software pipelining of innermost loops during selective scheduling.
7991 This option has no effect unless one of @option{-fselective-scheduling} or
7992 @option{-fselective-scheduling2} is turned on.
7994 @item -fsel-sched-pipelining-outer-loops
7995 @opindex fsel-sched-pipelining-outer-loops
7996 When pipelining loops during selective scheduling, also pipeline outer loops.
7997 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7999 @item -fsemantic-interposition
8000 @opindex fsemantic-interposition
8001 Some object formats, like ELF, allow interposing of symbols by dynamic linker.
8002 This means that for symbols exported from the DSO compiler can not perform
8003 inter-procedural propagation, inlining and other optimizations in anticipation
8004 that the function or variable in question may change. While this feature is
8005 useful, for example, to rewrite memory allocation functions by a debugging
8006 implementation, it is expensive in the terms of code quality.
8007 With @option{-fno-semantic-inteposition} compiler assumest that if interposition
8008 happens for functions the overwritting function will have
8009 precisely same semantics (and side effects). Similarly if interposition happens
8010 for variables, the constructor of the variable will be the same. The flag
8011 has no effect for functions explicitly declared inline, where
8012 interposition changing semantic is never allowed and for symbols explicitly
8013 declared weak.
8015 @item -fshrink-wrap
8016 @opindex fshrink-wrap
8017 Emit function prologues only before parts of the function that need it,
8018 rather than at the top of the function.  This flag is enabled by default at
8019 @option{-O} and higher.
8021 @item -fcaller-saves
8022 @opindex fcaller-saves
8023 Enable allocation of values to registers that are clobbered by
8024 function calls, by emitting extra instructions to save and restore the
8025 registers around such calls.  Such allocation is done only when it
8026 seems to result in better code.
8028 This option is always enabled by default on certain machines, usually
8029 those which have no call-preserved registers to use instead.
8031 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8033 @item -fcombine-stack-adjustments
8034 @opindex fcombine-stack-adjustments
8035 Tracks stack adjustments (pushes and pops) and stack memory references
8036 and then tries to find ways to combine them.
8038 Enabled by default at @option{-O1} and higher.
8040 @item -fipa-ra
8041 Use caller save registers for allocation if those registers are not used by
8042 any called function.  In that case it is not necessary to save and restore
8043 them around calls.  This is only possible if called functions are part of
8044 same compilation unit as current function and they are compiled before it.
8046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8048 @item -fconserve-stack
8049 @opindex fconserve-stack
8050 Attempt to minimize stack usage.  The compiler attempts to use less
8051 stack space, even if that makes the program slower.  This option
8052 implies setting the @option{large-stack-frame} parameter to 100
8053 and the @option{large-stack-frame-growth} parameter to 400.
8055 @item -ftree-reassoc
8056 @opindex ftree-reassoc
8057 Perform reassociation on trees.  This flag is enabled by default
8058 at @option{-O} and higher.
8060 @item -ftree-pre
8061 @opindex ftree-pre
8062 Perform partial redundancy elimination (PRE) on trees.  This flag is
8063 enabled by default at @option{-O2} and @option{-O3}.
8065 @item -ftree-partial-pre
8066 @opindex ftree-partial-pre
8067 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8068 enabled by default at @option{-O3}.
8070 @item -ftree-forwprop
8071 @opindex ftree-forwprop
8072 Perform forward propagation on trees.  This flag is enabled by default
8073 at @option{-O} and higher.
8075 @item -ftree-fre
8076 @opindex ftree-fre
8077 Perform full redundancy elimination (FRE) on trees.  The difference
8078 between FRE and PRE is that FRE only considers expressions
8079 that are computed on all paths leading to the redundant computation.
8080 This analysis is faster than PRE, though it exposes fewer redundancies.
8081 This flag is enabled by default at @option{-O} and higher.
8083 @item -ftree-phiprop
8084 @opindex ftree-phiprop
8085 Perform hoisting of loads from conditional pointers on trees.  This
8086 pass is enabled by default at @option{-O} and higher.
8088 @item -fhoist-adjacent-loads
8089 @opindex hoist-adjacent-loads
8090 Speculatively hoist loads from both branches of an if-then-else if the
8091 loads are from adjacent locations in the same structure and the target
8092 architecture has a conditional move instruction.  This flag is enabled
8093 by default at @option{-O2} and higher.
8095 @item -ftree-copy-prop
8096 @opindex ftree-copy-prop
8097 Perform copy propagation on trees.  This pass eliminates unnecessary
8098 copy operations.  This flag is enabled by default at @option{-O} and
8099 higher.
8101 @item -fipa-pure-const
8102 @opindex fipa-pure-const
8103 Discover which functions are pure or constant.
8104 Enabled by default at @option{-O} and higher.
8106 @item -fipa-reference
8107 @opindex fipa-reference
8108 Discover which static variables do not escape the
8109 compilation unit.
8110 Enabled by default at @option{-O} and higher.
8112 @item -fipa-pta
8113 @opindex fipa-pta
8114 Perform interprocedural pointer analysis and interprocedural modification
8115 and reference analysis.  This option can cause excessive memory and
8116 compile-time usage on large compilation units.  It is not enabled by
8117 default at any optimization level.
8119 @item -fipa-profile
8120 @opindex fipa-profile
8121 Perform interprocedural profile propagation.  The functions called only from
8122 cold functions are marked as cold. Also functions executed once (such as
8123 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8124 functions and loop less parts of functions executed once are then optimized for
8125 size.
8126 Enabled by default at @option{-O} and higher.
8128 @item -fipa-cp
8129 @opindex fipa-cp
8130 Perform interprocedural constant propagation.
8131 This optimization analyzes the program to determine when values passed
8132 to functions are constants and then optimizes accordingly.
8133 This optimization can substantially increase performance
8134 if the application has constants passed to functions.
8135 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8137 @item -fipa-cp-clone
8138 @opindex fipa-cp-clone
8139 Perform function cloning to make interprocedural constant propagation stronger.
8140 When enabled, interprocedural constant propagation performs function cloning
8141 when externally visible function can be called with constant arguments.
8142 Because this optimization can create multiple copies of functions,
8143 it may significantly increase code size
8144 (see @option{--param ipcp-unit-growth=@var{value}}).
8145 This flag is enabled by default at @option{-O3}.
8147 @item -fipa-icf
8148 @opindex fipa-icf
8149 Perform Identical Code Folding for functions and read-only variables.
8150 The optimization reduces code size and may disturb unwind stacks by replacing
8151 a function by equivalent one with a different name. The optimization works
8152 more effectively with link time optimization enabled.
8154 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8155 works on different levels and thus the optimizations are not same - there are
8156 equivalences that are found only by GCC and equivalences found only by Gold.
8158 This flag is enabled by default at @option{-O2} and @option{-Os}.
8160 @item -fisolate-erroneous-paths-dereference
8161 Detect paths which trigger erroneous or undefined behaviour due to
8162 dereferencing a NULL pointer.  Isolate those paths from the main control
8163 flow and turn the statement with erroneous or undefined behaviour into a trap.
8165 @item -fisolate-erroneous-paths-attribute
8166 Detect paths which trigger erroneous or undefined behaviour due a NULL value
8167 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
8168 attribute.  Isolate those paths from the main control flow and turn the
8169 statement with erroneous or undefined behaviour into a trap.  This is not
8170 currently enabled, but may be enabled by @code{-O2} in the future.
8172 @item -ftree-sink
8173 @opindex ftree-sink
8174 Perform forward store motion  on trees.  This flag is
8175 enabled by default at @option{-O} and higher.
8177 @item -ftree-bit-ccp
8178 @opindex ftree-bit-ccp
8179 Perform sparse conditional bit constant propagation on trees and propagate
8180 pointer alignment information.
8181 This pass only operates on local scalar variables and is enabled by default
8182 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8184 @item -ftree-ccp
8185 @opindex ftree-ccp
8186 Perform sparse conditional constant propagation (CCP) on trees.  This
8187 pass only operates on local scalar variables and is enabled by default
8188 at @option{-O} and higher.
8190 @item -fssa-phiopt
8191 @opindex fssa-phiopt
8192 Perform pattern matching on SSA PHI nodes to optimize conditional
8193 code.  This pass is enabled by default at @option{-O} and higher.
8195 @item -ftree-switch-conversion
8196 Perform conversion of simple initializations in a switch to
8197 initializations from a scalar array.  This flag is enabled by default
8198 at @option{-O2} and higher.
8200 @item -ftree-tail-merge
8201 Look for identical code sequences.  When found, replace one with a jump to the
8202 other.  This optimization is known as tail merging or cross jumping.  This flag
8203 is enabled by default at @option{-O2} and higher.  The compilation time
8204 in this pass can
8205 be limited using @option{max-tail-merge-comparisons} parameter and
8206 @option{max-tail-merge-iterations} parameter.
8208 @item -ftree-dce
8209 @opindex ftree-dce
8210 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8211 default at @option{-O} and higher.
8213 @item -ftree-builtin-call-dce
8214 @opindex ftree-builtin-call-dce
8215 Perform conditional dead code elimination (DCE) for calls to built-in functions
8216 that may set @code{errno} but are otherwise side-effect free.  This flag is
8217 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8218 specified.
8220 @item -ftree-dominator-opts
8221 @opindex ftree-dominator-opts
8222 Perform a variety of simple scalar cleanups (constant/copy
8223 propagation, redundancy elimination, range propagation and expression
8224 simplification) based on a dominator tree traversal.  This also
8225 performs jump threading (to reduce jumps to jumps). This flag is
8226 enabled by default at @option{-O} and higher.
8228 @item -ftree-dse
8229 @opindex ftree-dse
8230 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8231 a memory location that is later overwritten by another store without
8232 any intervening loads.  In this case the earlier store can be deleted.  This
8233 flag is enabled by default at @option{-O} and higher.
8235 @item -ftree-ch
8236 @opindex ftree-ch
8237 Perform loop header copying on trees.  This is beneficial since it increases
8238 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8239 is enabled by default at @option{-O} and higher.  It is not enabled
8240 for @option{-Os}, since it usually increases code size.
8242 @item -ftree-loop-optimize
8243 @opindex ftree-loop-optimize
8244 Perform loop optimizations on trees.  This flag is enabled by default
8245 at @option{-O} and higher.
8247 @item -ftree-loop-linear
8248 @opindex ftree-loop-linear
8249 Perform loop interchange transformations on tree.  Same as
8250 @option{-floop-interchange}.  To use this code transformation, GCC has
8251 to be configured with @option{--with-isl} to enable the Graphite loop
8252 transformation infrastructure.
8254 @item -floop-interchange
8255 @opindex floop-interchange
8256 Perform loop interchange transformations on loops.  Interchanging two
8257 nested loops switches the inner and outer loops.  For example, given a
8258 loop like:
8259 @smallexample
8260 DO J = 1, M
8261   DO I = 1, N
8262     A(J, I) = A(J, I) * C
8263   ENDDO
8264 ENDDO
8265 @end smallexample
8266 loop interchange transforms the loop as if it were written:
8267 @smallexample
8268 DO I = 1, N
8269   DO J = 1, M
8270     A(J, I) = A(J, I) * C
8271   ENDDO
8272 ENDDO
8273 @end smallexample
8274 which can be beneficial when @code{N} is larger than the caches,
8275 because in Fortran, the elements of an array are stored in memory
8276 contiguously by column, and the original loop iterates over rows,
8277 potentially creating at each access a cache miss.  This optimization
8278 applies to all the languages supported by GCC and is not limited to
8279 Fortran.  To use this code transformation, GCC has to be configured
8280 with @option{--with-isl} to enable the Graphite loop transformation
8281 infrastructure.
8283 @item -floop-strip-mine
8284 @opindex floop-strip-mine
8285 Perform loop strip mining transformations on loops.  Strip mining
8286 splits a loop into two nested loops.  The outer loop has strides
8287 equal to the strip size and the inner loop has strides of the
8288 original loop within a strip.  The strip length can be changed
8289 using the @option{loop-block-tile-size} parameter.  For example,
8290 given a loop like:
8291 @smallexample
8292 DO I = 1, N
8293   A(I) = A(I) + C
8294 ENDDO
8295 @end smallexample
8296 loop strip mining transforms the loop as if it were written:
8297 @smallexample
8298 DO II = 1, N, 51
8299   DO I = II, min (II + 50, N)
8300     A(I) = A(I) + C
8301   ENDDO
8302 ENDDO
8303 @end smallexample
8304 This optimization applies to all the languages supported by GCC and is
8305 not limited to Fortran.  To use this code transformation, GCC has to
8306 be configured with @option{--with-isl} to enable the Graphite loop
8307 transformation infrastructure.
8309 @item -floop-block
8310 @opindex floop-block
8311 Perform loop blocking transformations on loops.  Blocking strip mines
8312 each loop in the loop nest such that the memory accesses of the
8313 element loops fit inside caches.  The strip length can be changed
8314 using the @option{loop-block-tile-size} parameter.  For example, given
8315 a loop like:
8316 @smallexample
8317 DO I = 1, N
8318   DO J = 1, M
8319     A(J, I) = B(I) + C(J)
8320   ENDDO
8321 ENDDO
8322 @end smallexample
8323 loop blocking transforms the loop as if it were written:
8324 @smallexample
8325 DO II = 1, N, 51
8326   DO JJ = 1, M, 51
8327     DO I = II, min (II + 50, N)
8328       DO J = JJ, min (JJ + 50, M)
8329         A(J, I) = B(I) + C(J)
8330       ENDDO
8331     ENDDO
8332   ENDDO
8333 ENDDO
8334 @end smallexample
8335 which can be beneficial when @code{M} is larger than the caches,
8336 because the innermost loop iterates over a smaller amount of data
8337 which can be kept in the caches.  This optimization applies to all the
8338 languages supported by GCC and is not limited to Fortran.  To use this
8339 code transformation, GCC has to be configured with @option{--with-isl}
8340 to enable the Graphite loop transformation infrastructure.
8342 @item -fgraphite-identity
8343 @opindex fgraphite-identity
8344 Enable the identity transformation for graphite.  For every SCoP we generate
8345 the polyhedral representation and transform it back to gimple.  Using
8346 @option{-fgraphite-identity} we can check the costs or benefits of the
8347 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8348 are also performed by the code generator ISL, like index splitting and
8349 dead code elimination in loops.
8351 @item -floop-nest-optimize
8352 @opindex floop-nest-optimize
8353 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8354 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8355 structure optimized for data-locality and parallelism.  This option
8356 is experimental.
8358 @item -floop-unroll-and-jam
8359 @opindex floop-unroll-and-jam
8360 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8361 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8362 The unrolled dimension (counting from the most inner one) can be changed 
8363 using the @option{loop-unroll-jam-depth} parameter.                 .
8365 @item -floop-parallelize-all
8366 @opindex floop-parallelize-all
8367 Use the Graphite data dependence analysis to identify loops that can
8368 be parallelized.  Parallelize all the loops that can be analyzed to
8369 not contain loop carried dependences without checking that it is
8370 profitable to parallelize the loops.
8372 @item -fcheck-data-deps
8373 @opindex fcheck-data-deps
8374 Compare the results of several data dependence analyzers.  This option
8375 is used for debugging the data dependence analyzers.
8377 @item -ftree-loop-if-convert
8378 Attempt to transform conditional jumps in the innermost loops to
8379 branch-less equivalents.  The intent is to remove control-flow from
8380 the innermost loops in order to improve the ability of the
8381 vectorization pass to handle these loops.  This is enabled by default
8382 if vectorization is enabled.
8384 @item -ftree-loop-if-convert-stores
8385 Attempt to also if-convert conditional jumps containing memory writes.
8386 This transformation can be unsafe for multi-threaded programs as it
8387 transforms conditional memory writes into unconditional memory writes.
8388 For example,
8389 @smallexample
8390 for (i = 0; i < N; i++)
8391   if (cond)
8392     A[i] = expr;
8393 @end smallexample
8394 is transformed to
8395 @smallexample
8396 for (i = 0; i < N; i++)
8397   A[i] = cond ? expr : A[i];
8398 @end smallexample
8399 potentially producing data races.
8401 @item -ftree-loop-distribution
8402 Perform loop distribution.  This flag can improve cache performance on
8403 big loop bodies and allow further loop optimizations, like
8404 parallelization or vectorization, to take place.  For example, the loop
8405 @smallexample
8406 DO I = 1, N
8407   A(I) = B(I) + C
8408   D(I) = E(I) * F
8409 ENDDO
8410 @end smallexample
8411 is transformed to
8412 @smallexample
8413 DO I = 1, N
8414    A(I) = B(I) + C
8415 ENDDO
8416 DO I = 1, N
8417    D(I) = E(I) * F
8418 ENDDO
8419 @end smallexample
8421 @item -ftree-loop-distribute-patterns
8422 Perform loop distribution of patterns that can be code generated with
8423 calls to a library.  This flag is enabled by default at @option{-O3}.
8425 This pass distributes the initialization loops and generates a call to
8426 memset zero.  For example, the loop
8427 @smallexample
8428 DO I = 1, N
8429   A(I) = 0
8430   B(I) = A(I) + I
8431 ENDDO
8432 @end smallexample
8433 is transformed to
8434 @smallexample
8435 DO I = 1, N
8436    A(I) = 0
8437 ENDDO
8438 DO I = 1, N
8439    B(I) = A(I) + I
8440 ENDDO
8441 @end smallexample
8442 and the initialization loop is transformed into a call to memset zero.
8444 @item -ftree-loop-im
8445 @opindex ftree-loop-im
8446 Perform loop invariant motion on trees.  This pass moves only invariants that
8447 are hard to handle at RTL level (function calls, operations that expand to
8448 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8449 operands of conditions that are invariant out of the loop, so that we can use
8450 just trivial invariantness analysis in loop unswitching.  The pass also includes
8451 store motion.
8453 @item -ftree-loop-ivcanon
8454 @opindex ftree-loop-ivcanon
8455 Create a canonical counter for number of iterations in loops for which
8456 determining number of iterations requires complicated analysis.  Later
8457 optimizations then may determine the number easily.  Useful especially
8458 in connection with unrolling.
8460 @item -fivopts
8461 @opindex fivopts
8462 Perform induction variable optimizations (strength reduction, induction
8463 variable merging and induction variable elimination) on trees.
8465 @item -ftree-parallelize-loops=n
8466 @opindex ftree-parallelize-loops
8467 Parallelize loops, i.e., split their iteration space to run in n threads.
8468 This is only possible for loops whose iterations are independent
8469 and can be arbitrarily reordered.  The optimization is only
8470 profitable on multiprocessor machines, for loops that are CPU-intensive,
8471 rather than constrained e.g.@: by memory bandwidth.  This option
8472 implies @option{-pthread}, and thus is only supported on targets
8473 that have support for @option{-pthread}.
8475 @item -ftree-pta
8476 @opindex ftree-pta
8477 Perform function-local points-to analysis on trees.  This flag is
8478 enabled by default at @option{-O} and higher.
8480 @item -ftree-sra
8481 @opindex ftree-sra
8482 Perform scalar replacement of aggregates.  This pass replaces structure
8483 references with scalars to prevent committing structures to memory too
8484 early.  This flag is enabled by default at @option{-O} and higher.
8486 @item -ftree-copyrename
8487 @opindex ftree-copyrename
8488 Perform copy renaming on trees.  This pass attempts to rename compiler
8489 temporaries to other variables at copy locations, usually resulting in
8490 variable names which more closely resemble the original variables.  This flag
8491 is enabled by default at @option{-O} and higher.
8493 @item -ftree-coalesce-inlined-vars
8494 @opindex ftree-coalesce-inlined-vars
8495 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8496 combine small user-defined variables too, but only if they were inlined
8497 from other functions.  It is a more limited form of
8498 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8499 inlined variables, but it will keep variables of the inlined-into
8500 function apart from each other, such that they are more likely to
8501 contain the expected values in a debugging session.  This was the
8502 default in GCC versions older than 4.7.
8504 @item -ftree-coalesce-vars
8505 @opindex ftree-coalesce-vars
8506 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8507 combine small user-defined variables too, instead of just compiler
8508 temporaries.  This may severely limit the ability to debug an optimized
8509 program compiled with @option{-fno-var-tracking-assignments}.  In the
8510 negated form, this flag prevents SSA coalescing of user variables,
8511 including inlined ones.  This option is enabled by default.
8513 @item -ftree-ter
8514 @opindex ftree-ter
8515 Perform temporary expression replacement during the SSA->normal phase.  Single
8516 use/single def temporaries are replaced at their use location with their
8517 defining expression.  This results in non-GIMPLE code, but gives the expanders
8518 much more complex trees to work on resulting in better RTL generation.  This is
8519 enabled by default at @option{-O} and higher.
8521 @item -ftree-slsr
8522 @opindex ftree-slsr
8523 Perform straight-line strength reduction on trees.  This recognizes related
8524 expressions involving multiplications and replaces them by less expensive
8525 calculations when possible.  This is enabled by default at @option{-O} and
8526 higher.
8528 @item -ftree-vectorize
8529 @opindex ftree-vectorize
8530 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8531 and @option{-ftree-slp-vectorize} if not explicitly specified.
8533 @item -ftree-loop-vectorize
8534 @opindex ftree-loop-vectorize
8535 Perform loop vectorization on trees. This flag is enabled by default at
8536 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8538 @item -ftree-slp-vectorize
8539 @opindex ftree-slp-vectorize
8540 Perform basic block vectorization on trees. This flag is enabled by default at
8541 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8543 @item -fvect-cost-model=@var{model}
8544 @opindex fvect-cost-model
8545 Alter the cost model used for vectorization.  The @var{model} argument
8546 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8547 With the @code{unlimited} model the vectorized code-path is assumed
8548 to be profitable while with the @code{dynamic} model a runtime check
8549 will guard the vectorized code-path to enable it only for iteration
8550 counts that will likely execute faster than when executing the original
8551 scalar loop.  The @code{cheap} model will disable vectorization of
8552 loops where doing so would be cost prohibitive for example due to
8553 required runtime checks for data dependence or alignment but otherwise
8554 is equal to the @code{dynamic} model.
8555 The default cost model depends on other optimization flags and is
8556 either @code{dynamic} or @code{cheap}.
8558 @item -fsimd-cost-model=@var{model}
8559 @opindex fsimd-cost-model
8560 Alter the cost model used for vectorization of loops marked with the OpenMP
8561 or Cilk Plus simd directive.  The @var{model} argument should be one of
8562 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8563 have the same meaning as described in @option{-fvect-cost-model} and by
8564 default a cost model defined with @option{-fvect-cost-model} is used.
8566 @item -ftree-vrp
8567 @opindex ftree-vrp
8568 Perform Value Range Propagation on trees.  This is similar to the
8569 constant propagation pass, but instead of values, ranges of values are
8570 propagated.  This allows the optimizers to remove unnecessary range
8571 checks like array bound checks and null pointer checks.  This is
8572 enabled by default at @option{-O2} and higher.  Null pointer check
8573 elimination is only done if @option{-fdelete-null-pointer-checks} is
8574 enabled.
8576 @item -ftracer
8577 @opindex ftracer
8578 Perform tail duplication to enlarge superblock size.  This transformation
8579 simplifies the control flow of the function allowing other optimizations to do
8580 a better job.
8582 @item -funroll-loops
8583 @opindex funroll-loops
8584 Unroll loops whose number of iterations can be determined at compile
8585 time or upon entry to the loop.  @option{-funroll-loops} implies
8586 @option{-frerun-cse-after-loop}.  This option makes code larger,
8587 and may or may not make it run faster.
8589 @item -funroll-all-loops
8590 @opindex funroll-all-loops
8591 Unroll all loops, even if their number of iterations is uncertain when
8592 the loop is entered.  This usually makes programs run more slowly.
8593 @option{-funroll-all-loops} implies the same options as
8594 @option{-funroll-loops},
8596 @item -fsplit-ivs-in-unroller
8597 @opindex fsplit-ivs-in-unroller
8598 Enables expression of values of induction variables in later iterations
8599 of the unrolled loop using the value in the first iteration.  This breaks
8600 long dependency chains, thus improving efficiency of the scheduling passes.
8602 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8603 same effect.  However, that is not reliable in cases where the loop body
8604 is more complicated than a single basic block.  It also does not work at all
8605 on some architectures due to restrictions in the CSE pass.
8607 This optimization is enabled by default.
8609 @item -fvariable-expansion-in-unroller
8610 @opindex fvariable-expansion-in-unroller
8611 With this option, the compiler creates multiple copies of some
8612 local variables when unrolling a loop, which can result in superior code.
8614 @item -fpartial-inlining
8615 @opindex fpartial-inlining
8616 Inline parts of functions.  This option has any effect only
8617 when inlining itself is turned on by the @option{-finline-functions}
8618 or @option{-finline-small-functions} options.
8620 Enabled at level @option{-O2}.
8622 @item -fpredictive-commoning
8623 @opindex fpredictive-commoning
8624 Perform predictive commoning optimization, i.e., reusing computations
8625 (especially memory loads and stores) performed in previous
8626 iterations of loops.
8628 This option is enabled at level @option{-O3}.
8630 @item -fprefetch-loop-arrays
8631 @opindex fprefetch-loop-arrays
8632 If supported by the target machine, generate instructions to prefetch
8633 memory to improve the performance of loops that access large arrays.
8635 This option may generate better or worse code; results are highly
8636 dependent on the structure of loops within the source code.
8638 Disabled at level @option{-Os}.
8640 @item -fno-peephole
8641 @itemx -fno-peephole2
8642 @opindex fno-peephole
8643 @opindex fno-peephole2
8644 Disable any machine-specific peephole optimizations.  The difference
8645 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8646 are implemented in the compiler; some targets use one, some use the
8647 other, a few use both.
8649 @option{-fpeephole} is enabled by default.
8650 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8652 @item -fno-guess-branch-probability
8653 @opindex fno-guess-branch-probability
8654 Do not guess branch probabilities using heuristics.
8656 GCC uses heuristics to guess branch probabilities if they are
8657 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8658 heuristics are based on the control flow graph.  If some branch probabilities
8659 are specified by @samp{__builtin_expect}, then the heuristics are
8660 used to guess branch probabilities for the rest of the control flow graph,
8661 taking the @samp{__builtin_expect} info into account.  The interactions
8662 between the heuristics and @samp{__builtin_expect} can be complex, and in
8663 some cases, it may be useful to disable the heuristics so that the effects
8664 of @samp{__builtin_expect} are easier to understand.
8666 The default is @option{-fguess-branch-probability} at levels
8667 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8669 @item -freorder-blocks
8670 @opindex freorder-blocks
8671 Reorder basic blocks in the compiled function in order to reduce number of
8672 taken branches and improve code locality.
8674 Enabled at levels @option{-O2}, @option{-O3}.
8676 @item -freorder-blocks-and-partition
8677 @opindex freorder-blocks-and-partition
8678 In addition to reordering basic blocks in the compiled function, in order
8679 to reduce number of taken branches, partitions hot and cold basic blocks
8680 into separate sections of the assembly and .o files, to improve
8681 paging and cache locality performance.
8683 This optimization is automatically turned off in the presence of
8684 exception handling, for linkonce sections, for functions with a user-defined
8685 section attribute and on any architecture that does not support named
8686 sections.
8688 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8690 @item -freorder-functions
8691 @opindex freorder-functions
8692 Reorder functions in the object file in order to
8693 improve code locality.  This is implemented by using special
8694 subsections @code{.text.hot} for most frequently executed functions and
8695 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8696 the linker so object file format must support named sections and linker must
8697 place them in a reasonable way.
8699 Also profile feedback must be available to make this option effective.  See
8700 @option{-fprofile-arcs} for details.
8702 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8704 @item -fstrict-aliasing
8705 @opindex fstrict-aliasing
8706 Allow the compiler to assume the strictest aliasing rules applicable to
8707 the language being compiled.  For C (and C++), this activates
8708 optimizations based on the type of expressions.  In particular, an
8709 object of one type is assumed never to reside at the same address as an
8710 object of a different type, unless the types are almost the same.  For
8711 example, an @code{unsigned int} can alias an @code{int}, but not a
8712 @code{void*} or a @code{double}.  A character type may alias any other
8713 type.
8715 @anchor{Type-punning}Pay special attention to code like this:
8716 @smallexample
8717 union a_union @{
8718   int i;
8719   double d;
8722 int f() @{
8723   union a_union t;
8724   t.d = 3.0;
8725   return t.i;
8727 @end smallexample
8728 The practice of reading from a different union member than the one most
8729 recently written to (called ``type-punning'') is common.  Even with
8730 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8731 is accessed through the union type.  So, the code above works as
8732 expected.  @xref{Structures unions enumerations and bit-fields
8733 implementation}.  However, this code might not:
8734 @smallexample
8735 int f() @{
8736   union a_union t;
8737   int* ip;
8738   t.d = 3.0;
8739   ip = &t.i;
8740   return *ip;
8742 @end smallexample
8744 Similarly, access by taking the address, casting the resulting pointer
8745 and dereferencing the result has undefined behavior, even if the cast
8746 uses a union type, e.g.:
8747 @smallexample
8748 int f() @{
8749   double d = 3.0;
8750   return ((union a_union *) &d)->i;
8752 @end smallexample
8754 The @option{-fstrict-aliasing} option is enabled at levels
8755 @option{-O2}, @option{-O3}, @option{-Os}.
8757 @item -fstrict-overflow
8758 @opindex fstrict-overflow
8759 Allow the compiler to assume strict signed overflow rules, depending
8760 on the language being compiled.  For C (and C++) this means that
8761 overflow when doing arithmetic with signed numbers is undefined, which
8762 means that the compiler may assume that it does not happen.  This
8763 permits various optimizations.  For example, the compiler assumes
8764 that an expression like @code{i + 10 > i} is always true for
8765 signed @code{i}.  This assumption is only valid if signed overflow is
8766 undefined, as the expression is false if @code{i + 10} overflows when
8767 using twos complement arithmetic.  When this option is in effect any
8768 attempt to determine whether an operation on signed numbers 
8769 overflows must be written carefully to not actually involve overflow.
8771 This option also allows the compiler to assume strict pointer
8772 semantics: given a pointer to an object, if adding an offset to that
8773 pointer does not produce a pointer to the same object, the addition is
8774 undefined.  This permits the compiler to conclude that @code{p + u >
8775 p} is always true for a pointer @code{p} and unsigned integer
8776 @code{u}.  This assumption is only valid because pointer wraparound is
8777 undefined, as the expression is false if @code{p + u} overflows using
8778 twos complement arithmetic.
8780 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8781 that integer signed overflow is fully defined: it wraps.  When
8782 @option{-fwrapv} is used, there is no difference between
8783 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8784 integers.  With @option{-fwrapv} certain types of overflow are
8785 permitted.  For example, if the compiler gets an overflow when doing
8786 arithmetic on constants, the overflowed value can still be used with
8787 @option{-fwrapv}, but not otherwise.
8789 The @option{-fstrict-overflow} option is enabled at levels
8790 @option{-O2}, @option{-O3}, @option{-Os}.
8792 @item -falign-functions
8793 @itemx -falign-functions=@var{n}
8794 @opindex falign-functions
8795 Align the start of functions to the next power-of-two greater than
8796 @var{n}, skipping up to @var{n} bytes.  For instance,
8797 @option{-falign-functions=32} aligns functions to the next 32-byte
8798 boundary, but @option{-falign-functions=24} aligns to the next
8799 32-byte boundary only if this can be done by skipping 23 bytes or less.
8801 @option{-fno-align-functions} and @option{-falign-functions=1} are
8802 equivalent and mean that functions are not aligned.
8804 Some assemblers only support this flag when @var{n} is a power of two;
8805 in that case, it is rounded up.
8807 If @var{n} is not specified or is zero, use a machine-dependent default.
8809 Enabled at levels @option{-O2}, @option{-O3}.
8811 @item -falign-labels
8812 @itemx -falign-labels=@var{n}
8813 @opindex falign-labels
8814 Align all branch targets to a power-of-two boundary, skipping up to
8815 @var{n} bytes like @option{-falign-functions}.  This option can easily
8816 make code slower, because it must insert dummy operations for when the
8817 branch target is reached in the usual flow of the code.
8819 @option{-fno-align-labels} and @option{-falign-labels=1} are
8820 equivalent and mean that labels are not aligned.
8822 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8823 are greater than this value, then their values are used instead.
8825 If @var{n} is not specified or is zero, use a machine-dependent default
8826 which is very likely to be @samp{1}, meaning no alignment.
8828 Enabled at levels @option{-O2}, @option{-O3}.
8830 @item -falign-loops
8831 @itemx -falign-loops=@var{n}
8832 @opindex falign-loops
8833 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8834 like @option{-falign-functions}.  If the loops are
8835 executed many times, this makes up for any execution of the dummy
8836 operations.
8838 @option{-fno-align-loops} and @option{-falign-loops=1} are
8839 equivalent and mean that loops are not aligned.
8841 If @var{n} is not specified or is zero, use a machine-dependent default.
8843 Enabled at levels @option{-O2}, @option{-O3}.
8845 @item -falign-jumps
8846 @itemx -falign-jumps=@var{n}
8847 @opindex falign-jumps
8848 Align branch targets to a power-of-two boundary, for branch targets
8849 where the targets can only be reached by jumping, skipping up to @var{n}
8850 bytes like @option{-falign-functions}.  In this case, no dummy operations
8851 need be executed.
8853 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8854 equivalent and mean that loops are not aligned.
8856 If @var{n} is not specified or is zero, use a machine-dependent default.
8858 Enabled at levels @option{-O2}, @option{-O3}.
8860 @item -funit-at-a-time
8861 @opindex funit-at-a-time
8862 This option is left for compatibility reasons. @option{-funit-at-a-time}
8863 has no effect, while @option{-fno-unit-at-a-time} implies
8864 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8866 Enabled by default.
8868 @item -fno-toplevel-reorder
8869 @opindex fno-toplevel-reorder
8870 Do not reorder top-level functions, variables, and @code{asm}
8871 statements.  Output them in the same order that they appear in the
8872 input file.  When this option is used, unreferenced static variables
8873 are not removed.  This option is intended to support existing code
8874 that relies on a particular ordering.  For new code, it is better to
8875 use attributes when possible.
8877 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8878 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8879 targets.
8881 @item -fweb
8882 @opindex fweb
8883 Constructs webs as commonly used for register allocation purposes and assign
8884 each web individual pseudo register.  This allows the register allocation pass
8885 to operate on pseudos directly, but also strengthens several other optimization
8886 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8887 however, make debugging impossible, since variables no longer stay in a
8888 ``home register''.
8890 Enabled by default with @option{-funroll-loops}.
8892 @item -fwhole-program
8893 @opindex fwhole-program
8894 Assume that the current compilation unit represents the whole program being
8895 compiled.  All public functions and variables with the exception of @code{main}
8896 and those merged by attribute @code{externally_visible} become static functions
8897 and in effect are optimized more aggressively by interprocedural optimizers.
8899 This option should not be used in combination with @code{-flto}.
8900 Instead relying on a linker plugin should provide safer and more precise
8901 information.
8903 @item -flto[=@var{n}]
8904 @opindex flto
8905 This option runs the standard link-time optimizer.  When invoked
8906 with source code, it generates GIMPLE (one of GCC's internal
8907 representations) and writes it to special ELF sections in the object
8908 file.  When the object files are linked together, all the function
8909 bodies are read from these ELF sections and instantiated as if they
8910 had been part of the same translation unit.
8912 To use the link-time optimizer, @option{-flto} and optimization
8913 options should be specified at compile time and during the final link.
8914 For example:
8916 @smallexample
8917 gcc -c -O2 -flto foo.c
8918 gcc -c -O2 -flto bar.c
8919 gcc -o myprog -flto -O2 foo.o bar.o
8920 @end smallexample
8922 The first two invocations to GCC save a bytecode representation
8923 of GIMPLE into special ELF sections inside @file{foo.o} and
8924 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8925 @file{foo.o} and @file{bar.o}, merges the two files into a single
8926 internal image, and compiles the result as usual.  Since both
8927 @file{foo.o} and @file{bar.o} are merged into a single image, this
8928 causes all the interprocedural analyses and optimizations in GCC to
8929 work across the two files as if they were a single one.  This means,
8930 for example, that the inliner is able to inline functions in
8931 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8933 Another (simpler) way to enable link-time optimization is:
8935 @smallexample
8936 gcc -o myprog -flto -O2 foo.c bar.c
8937 @end smallexample
8939 The above generates bytecode for @file{foo.c} and @file{bar.c},
8940 merges them together into a single GIMPLE representation and optimizes
8941 them as usual to produce @file{myprog}.
8943 The only important thing to keep in mind is that to enable link-time
8944 optimizations you need to use the GCC driver to perform the link-step.
8945 GCC then automatically performs link-time optimization if any of the
8946 objects involved were compiled with the @option{-flto}.  You generally
8947 should specify the optimization options to be used for link-time
8948 optimization though GCC will try to be clever at guessing an
8949 optimization level to use from the options used at compile-time
8950 if you fail to specify one at link-time.  You can always override
8951 the automatic decision to do link-time optimization at link-time
8952 by passing @option{-fno-lto} to the link command.
8954 To make whole program optimization effective, it is necessary to make
8955 certain whole program assumptions.  The compiler needs to know
8956 what functions and variables can be accessed by libraries and runtime
8957 outside of the link-time optimized unit.  When supported by the linker,
8958 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8959 to the compiler about used and externally visible symbols.  When
8960 the linker plugin is not available, @option{-fwhole-program} should be
8961 used to allow the compiler to make these assumptions, which leads
8962 to more aggressive optimization decisions.
8964 When @option{-fuse-linker-plugin} is not enabled then, when a file is
8965 compiled with @option{-flto}, the generated object file is larger than
8966 a regular object file because it contains GIMPLE bytecodes and the usual
8967 final code (see @option{-ffat-lto-objects}.  This means that
8968 object files with LTO information can be linked as normal object
8969 files; if @option{-fno-lto} is passed to the linker, no
8970 interprocedural optimizations are applied.  Note that when
8971 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
8972 but you cannot perform a regular, non-LTO link on them.
8974 Additionally, the optimization flags used to compile individual files
8975 are not necessarily related to those used at link time.  For instance,
8977 @smallexample
8978 gcc -c -O0 -ffat-lto-objects -flto foo.c
8979 gcc -c -O0 -ffat-lto-objects -flto bar.c
8980 gcc -o myprog -O3 foo.o bar.o
8981 @end smallexample
8983 This produces individual object files with unoptimized assembler
8984 code, but the resulting binary @file{myprog} is optimized at
8985 @option{-O3}.  If, instead, the final binary is generated with
8986 @option{-fno-lto}, then @file{myprog} is not optimized.
8988 When producing the final binary, GCC only
8989 applies link-time optimizations to those files that contain bytecode.
8990 Therefore, you can mix and match object files and libraries with
8991 GIMPLE bytecodes and final object code.  GCC automatically selects
8992 which files to optimize in LTO mode and which files to link without
8993 further processing.
8995 There are some code generation flags preserved by GCC when
8996 generating bytecodes, as they need to be used during the final link
8997 stage.  Generally options specified at link-time override those
8998 specified at compile-time.
9000 If you do not specify an optimization level option @option{-O} at
9001 link-time then GCC will compute one based on the optimization levels
9002 used when compiling the object files.  The highest optimization
9003 level will win here.
9005 Currently, the following options and their setting are take from
9006 the first object file that explicitely specified it: 
9007 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9008 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9009 and all the @option{-m} target flags.
9011 Certain ABI changing flags are required to match in all compilation-units
9012 and trying to override this at link-time with a conflicting value
9013 is ignored.  This includes options such as @option{-freg-struct-return}
9014 and @option{-fpcc-struct-return}. 
9016 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9017 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9018 are passed through to the link stage and merged conservatively for
9019 conflicting translation units.  Specifically
9020 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9021 precedence and for example @option{-ffp-contract=off} takes precedence
9022 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9024 It is recommended that you compile all the files participating in the
9025 same link with the same options and also specify those options at
9026 link time.
9028 If LTO encounters objects with C linkage declared with incompatible
9029 types in separate translation units to be linked together (undefined
9030 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9031 issued.  The behavior is still undefined at run time.  Similar
9032 diagnostics may be raised for other languages.
9034 Another feature of LTO is that it is possible to apply interprocedural
9035 optimizations on files written in different languages:
9037 @smallexample
9038 gcc -c -flto foo.c
9039 g++ -c -flto bar.cc
9040 gfortran -c -flto baz.f90
9041 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9042 @end smallexample
9044 Notice that the final link is done with @command{g++} to get the C++
9045 runtime libraries and @option{-lgfortran} is added to get the Fortran
9046 runtime libraries.  In general, when mixing languages in LTO mode, you
9047 should use the same link command options as when mixing languages in a
9048 regular (non-LTO) compilation.
9050 If object files containing GIMPLE bytecode are stored in a library archive, say
9051 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9052 are using a linker with plugin support.  To create static libraries suitable
9053 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9054 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
9055 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9056 and @command{nm} have been compiled with plugin support.  At link time, use the the
9057 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9058 the LTO optimization process:
9060 @smallexample
9061 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9062 @end smallexample
9064 With the linker plugin enabled, the linker extracts the needed
9065 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9066 to make them part of the aggregated GIMPLE image to be optimized.
9068 If you are not using a linker with plugin support and/or do not
9069 enable the linker plugin, then the objects inside @file{libfoo.a}
9070 are extracted and linked as usual, but they do not participate
9071 in the LTO optimization process.  In order to make a static library suitable
9072 for both LTO optimization and usual linkage, compile its object files with
9073 @option{-flto} @code{-ffat-lto-objects}.
9075 Link-time optimizations do not require the presence of the whole program to
9076 operate.  If the program does not require any symbols to be exported, it is
9077 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9078 the interprocedural optimizers to use more aggressive assumptions which may
9079 lead to improved optimization opportunities.
9080 Use of @option{-fwhole-program} is not needed when linker plugin is
9081 active (see @option{-fuse-linker-plugin}).
9083 The current implementation of LTO makes no
9084 attempt to generate bytecode that is portable between different
9085 types of hosts.  The bytecode files are versioned and there is a
9086 strict version check, so bytecode files generated in one version of
9087 GCC will not work with an older or newer version of GCC.
9089 Link-time optimization does not work well with generation of debugging
9090 information.  Combining @option{-flto} with
9091 @option{-g} is currently experimental and expected to produce unexpected
9092 results.
9094 If you specify the optional @var{n}, the optimization and code
9095 generation done at link time is executed in parallel using @var{n}
9096 parallel jobs by utilizing an installed @command{make} program.  The
9097 environment variable @env{MAKE} may be used to override the program
9098 used.  The default value for @var{n} is 1.
9100 You can also specify @option{-flto=jobserver} to use GNU make's
9101 job server mode to determine the number of parallel jobs. This
9102 is useful when the Makefile calling GCC is already executing in parallel.
9103 You must prepend a @samp{+} to the command recipe in the parent Makefile
9104 for this to work.  This option likely only works if @env{MAKE} is
9105 GNU make.
9107 @item -flto-partition=@var{alg}
9108 @opindex flto-partition
9109 Specify the partitioning algorithm used by the link-time optimizer.
9110 The value is either @code{1to1} to specify a partitioning mirroring
9111 the original source files or @code{balanced} to specify partitioning
9112 into equally sized chunks (whenever possible) or @code{max} to create
9113 new partition for every symbol where possible.  Specifying @code{none}
9114 as an algorithm disables partitioning and streaming completely. 
9115 The default value is @code{balanced}. While @code{1to1} can be used
9116 as an workaround for various code ordering issues, the @code{max}
9117 partitioning is intended for internal testing only.
9118 The value @code{one} specifies that exactly one partition should be
9119 used while the value @code{none} bypasses partitioning and executes
9120 the link-time optimization step directly from the WPA phase.
9122 @item -flto-odr-type-merging
9123 @opindex flto-odr-type-merging
9124 Enable streaming of mangled types names of C++ types and their unification
9125 at linktime.  This increases size of LTO object files, but enable
9126 diagnostics about One Definition Rule violations.
9128 @item -flto-compression-level=@var{n}
9129 This option specifies the level of compression used for intermediate
9130 language written to LTO object files, and is only meaningful in
9131 conjunction with LTO mode (@option{-flto}).  Valid
9132 values are 0 (no compression) to 9 (maximum compression).  Values
9133 outside this range are clamped to either 0 or 9.  If the option is not
9134 given, a default balanced compression setting is used.
9136 @item -flto-report
9137 Prints a report with internal details on the workings of the link-time
9138 optimizer.  The contents of this report vary from version to version.
9139 It is meant to be useful to GCC developers when processing object
9140 files in LTO mode (via @option{-flto}).
9142 Disabled by default.
9144 @item -flto-report-wpa
9145 Like @option{-flto-report}, but only print for the WPA phase of Link
9146 Time Optimization.
9148 @item -fuse-linker-plugin
9149 Enables the use of a linker plugin during link-time optimization.  This
9150 option relies on plugin support in the linker, which is available in gold
9151 or in GNU ld 2.21 or newer.
9153 This option enables the extraction of object files with GIMPLE bytecode out
9154 of library archives. This improves the quality of optimization by exposing
9155 more code to the link-time optimizer.  This information specifies what
9156 symbols can be accessed externally (by non-LTO object or during dynamic
9157 linking).  Resulting code quality improvements on binaries (and shared
9158 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
9159 See @option{-flto} for a description of the effect of this flag and how to
9160 use it.
9162 This option is enabled by default when LTO support in GCC is enabled
9163 and GCC was configured for use with
9164 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9166 @item -ffat-lto-objects
9167 @opindex ffat-lto-objects
9168 Fat LTO objects are object files that contain both the intermediate language
9169 and the object code. This makes them usable for both LTO linking and normal
9170 linking. This option is effective only when compiling with @option{-flto}
9171 and is ignored at link time.
9173 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9174 requires the complete toolchain to be aware of LTO. It requires a linker with
9175 linker plugin support for basic functionality.  Additionally,
9176 @command{nm}, @command{ar} and @command{ranlib}
9177 need to support linker plugins to allow a full-featured build environment
9178 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9179 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9180 to these tools. With non fat LTO makefiles need to be modified to use them.
9182 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9183 support.
9185 @item -fcompare-elim
9186 @opindex fcompare-elim
9187 After register allocation and post-register allocation instruction splitting,
9188 identify arithmetic instructions that compute processor flags similar to a
9189 comparison operation based on that arithmetic.  If possible, eliminate the
9190 explicit comparison operation.
9192 This pass only applies to certain targets that cannot explicitly represent
9193 the comparison operation before register allocation is complete.
9195 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9197 @item -fuse-ld=bfd
9198 @opindex fuse-ld=bfd
9199 Use the @command{bfd} linker instead of the default linker.
9201 @item -fuse-ld=gold
9202 @opindex fuse-ld=gold
9203 Use the @command{gold} linker instead of the default linker.
9205 @item -fcprop-registers
9206 @opindex fcprop-registers
9207 After register allocation and post-register allocation instruction splitting,
9208 perform a copy-propagation pass to try to reduce scheduling dependencies
9209 and occasionally eliminate the copy.
9211 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9213 @item -fprofile-correction
9214 @opindex fprofile-correction
9215 Profiles collected using an instrumented binary for multi-threaded programs may
9216 be inconsistent due to missed counter updates. When this option is specified,
9217 GCC uses heuristics to correct or smooth out such inconsistencies. By
9218 default, GCC emits an error message when an inconsistent profile is detected.
9220 @item -fprofile-dir=@var{path}
9221 @opindex fprofile-dir
9223 Set the directory to search for the profile data files in to @var{path}.
9224 This option affects only the profile data generated by
9225 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9226 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9227 and its related options.  Both absolute and relative paths can be used.
9228 By default, GCC uses the current directory as @var{path}, thus the
9229 profile data file appears in the same directory as the object file.
9231 @item -fprofile-generate
9232 @itemx -fprofile-generate=@var{path}
9233 @opindex fprofile-generate
9235 Enable options usually used for instrumenting application to produce
9236 profile useful for later recompilation with profile feedback based
9237 optimization.  You must use @option{-fprofile-generate} both when
9238 compiling and when linking your program.
9240 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
9242 If @var{path} is specified, GCC looks at the @var{path} to find
9243 the profile feedback data files. See @option{-fprofile-dir}.
9245 @item -fprofile-use
9246 @itemx -fprofile-use=@var{path}
9247 @opindex fprofile-use
9248 Enable profile feedback directed optimizations, and optimizations
9249 generally profitable only with profile feedback available.
9251 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9252 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9253 @code{ftree-loop-distribute-patterns}
9255 By default, GCC emits an error message if the feedback profiles do not
9256 match the source code.  This error can be turned into a warning by using
9257 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9258 code.
9260 If @var{path} is specified, GCC looks at the @var{path} to find
9261 the profile feedback data files. See @option{-fprofile-dir}.
9263 @item -fauto-profile
9264 @itemx -fauto-profile=@var{path}
9265 @opindex fauto-profile
9266 Enable sampling based feedback directed optimizations, and optimizations
9267 generally profitable only with profile feedback available.
9269 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9270 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9271 @code{-finline-functions}, @code{-fipa-cp}, @code{-fipa-cp-clone},
9272 @code{-fpredictive-commoning}, @code{-funswitch-loops},
9273 @code{-fgcse-after-reload}, @code{-ftree-loop-distribute-patterns},
9275 If @var{path} is specified, GCC looks at the @var{path} to find
9276 the profile feedback data files.
9278 In order to collect AutoFDO profile, you need to have:
9280 1. A linux system with linux perf support
9281 2. (optional) An Intel processor with last branch record (LBR) support. This is
9282    to guarantee accurate instruction level profile, which is important for
9283    AutoFDO performance.
9285 To collect the profile, first use linux perf to collect raw profile
9286 (see @uref{https://perf.wiki.kernel.org/}).
9288 E.g.
9289 @code{perf record -e br_inst_retired:near_taken -b -o perf.data -- your_program}
9291 Then use create_gcov tool, which takes raw profile and unstripped binary to
9292 generate AutoFDO profile that can be used by GCC.
9293 (see @uref{https://github.com/google/autofdo}).
9295 E.g.
9296 @code{create_gcov --binary=your_program.unstripped --profile=perf.data --gcov=profile.afdo}
9297 @end table
9299 The following options control compiler behavior regarding floating-point 
9300 arithmetic.  These options trade off between speed and
9301 correctness.  All must be specifically enabled.
9303 @table @gcctabopt
9304 @item -ffloat-store
9305 @opindex ffloat-store
9306 Do not store floating-point variables in registers, and inhibit other
9307 options that might change whether a floating-point value is taken from a
9308 register or memory.
9310 @cindex floating-point precision
9311 This option prevents undesirable excess precision on machines such as
9312 the 68000 where the floating registers (of the 68881) keep more
9313 precision than a @code{double} is supposed to have.  Similarly for the
9314 x86 architecture.  For most programs, the excess precision does only
9315 good, but a few programs rely on the precise definition of IEEE floating
9316 point.  Use @option{-ffloat-store} for such programs, after modifying
9317 them to store all pertinent intermediate computations into variables.
9319 @item -fexcess-precision=@var{style}
9320 @opindex fexcess-precision
9321 This option allows further control over excess precision on machines
9322 where floating-point registers have more precision than the IEEE
9323 @code{float} and @code{double} types and the processor does not
9324 support operations rounding to those types.  By default,
9325 @option{-fexcess-precision=fast} is in effect; this means that
9326 operations are carried out in the precision of the registers and that
9327 it is unpredictable when rounding to the types specified in the source
9328 code takes place.  When compiling C, if
9329 @option{-fexcess-precision=standard} is specified then excess
9330 precision follows the rules specified in ISO C99; in particular,
9331 both casts and assignments cause values to be rounded to their
9332 semantic types (whereas @option{-ffloat-store} only affects
9333 assignments).  This option is enabled by default for C if a strict
9334 conformance option such as @option{-std=c99} is used.
9336 @opindex mfpmath
9337 @option{-fexcess-precision=standard} is not implemented for languages
9338 other than C, and has no effect if
9339 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9340 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9341 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9342 semantics apply without excess precision, and in the latter, rounding
9343 is unpredictable.
9345 @item -ffast-math
9346 @opindex ffast-math
9347 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9348 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9349 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9351 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9353 This option is not turned on by any @option{-O} option besides
9354 @option{-Ofast} since it can result in incorrect output for programs
9355 that depend on an exact implementation of IEEE or ISO rules/specifications
9356 for math functions. It may, however, yield faster code for programs
9357 that do not require the guarantees of these specifications.
9359 @item -fno-math-errno
9360 @opindex fno-math-errno
9361 Do not set @code{errno} after calling math functions that are executed
9362 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9363 IEEE exceptions for math error handling may want to use this flag
9364 for speed while maintaining IEEE arithmetic compatibility.
9366 This option is not turned on by any @option{-O} option since
9367 it can result in incorrect output for programs that depend on
9368 an exact implementation of IEEE or ISO rules/specifications for
9369 math functions. It may, however, yield faster code for programs
9370 that do not require the guarantees of these specifications.
9372 The default is @option{-fmath-errno}.
9374 On Darwin systems, the math library never sets @code{errno}.  There is
9375 therefore no reason for the compiler to consider the possibility that
9376 it might, and @option{-fno-math-errno} is the default.
9378 @item -funsafe-math-optimizations
9379 @opindex funsafe-math-optimizations
9381 Allow optimizations for floating-point arithmetic that (a) assume
9382 that arguments and results are valid and (b) may violate IEEE or
9383 ANSI standards.  When used at link-time, it may include libraries
9384 or startup files that change the default FPU control word or other
9385 similar optimizations.
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.
9392 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9393 @option{-fassociative-math} and @option{-freciprocal-math}.
9395 The default is @option{-fno-unsafe-math-optimizations}.
9397 @item -fassociative-math
9398 @opindex fassociative-math
9400 Allow re-association of operands in series of floating-point operations.
9401 This violates the ISO C and C++ language standard by possibly changing
9402 computation result.  NOTE: re-ordering may change the sign of zero as
9403 well as ignore NaNs and inhibit or create underflow or overflow (and
9404 thus cannot be used on code that relies on rounding behavior like
9405 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9406 and thus may not be used when ordered comparisons are required.
9407 This option requires that both @option{-fno-signed-zeros} and
9408 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9409 much sense with @option{-frounding-math}. For Fortran the option
9410 is automatically enabled when both @option{-fno-signed-zeros} and
9411 @option{-fno-trapping-math} are in effect.
9413 The default is @option{-fno-associative-math}.
9415 @item -freciprocal-math
9416 @opindex freciprocal-math
9418 Allow the reciprocal of a value to be used instead of dividing by
9419 the value if this enables optimizations.  For example @code{x / y}
9420 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9421 is subject to common subexpression elimination.  Note that this loses
9422 precision and increases the number of flops operating on the value.
9424 The default is @option{-fno-reciprocal-math}.
9426 @item -ffinite-math-only
9427 @opindex ffinite-math-only
9428 Allow optimizations for floating-point arithmetic that assume
9429 that arguments and results are not NaNs or +-Infs.
9431 This option is not turned on by any @option{-O} option since
9432 it can result in incorrect output for programs that depend on
9433 an exact implementation of IEEE or ISO rules/specifications for
9434 math functions. It may, however, yield faster code for programs
9435 that do not require the guarantees of these specifications.
9437 The default is @option{-fno-finite-math-only}.
9439 @item -fno-signed-zeros
9440 @opindex fno-signed-zeros
9441 Allow optimizations for floating-point arithmetic that ignore the
9442 signedness of zero.  IEEE arithmetic specifies the behavior of
9443 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9444 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9445 This option implies that the sign of a zero result isn't significant.
9447 The default is @option{-fsigned-zeros}.
9449 @item -fno-trapping-math
9450 @opindex fno-trapping-math
9451 Compile code assuming that floating-point operations cannot generate
9452 user-visible traps.  These traps include division by zero, overflow,
9453 underflow, inexact result and invalid operation.  This option requires
9454 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9455 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9457 This option should never be turned on by any @option{-O} option since
9458 it can result in incorrect output for programs that depend on
9459 an exact implementation of IEEE or ISO rules/specifications for
9460 math functions.
9462 The default is @option{-ftrapping-math}.
9464 @item -frounding-math
9465 @opindex frounding-math
9466 Disable transformations and optimizations that assume default floating-point
9467 rounding behavior.  This is round-to-zero for all floating point
9468 to integer conversions, and round-to-nearest for all other arithmetic
9469 truncations.  This option should be specified for programs that change
9470 the FP rounding mode dynamically, or that may be executed with a
9471 non-default rounding mode.  This option disables constant folding of
9472 floating-point expressions at compile time (which may be affected by
9473 rounding mode) and arithmetic transformations that are unsafe in the
9474 presence of sign-dependent rounding modes.
9476 The default is @option{-fno-rounding-math}.
9478 This option is experimental and does not currently guarantee to
9479 disable all GCC optimizations that are affected by rounding mode.
9480 Future versions of GCC may provide finer control of this setting
9481 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9482 will be used to specify the default state for @code{FENV_ACCESS}.
9484 @item -fsignaling-nans
9485 @opindex fsignaling-nans
9486 Compile code assuming that IEEE signaling NaNs may generate user-visible
9487 traps during floating-point operations.  Setting this option disables
9488 optimizations that may change the number of exceptions visible with
9489 signaling NaNs.  This option implies @option{-ftrapping-math}.
9491 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9492 be defined.
9494 The default is @option{-fno-signaling-nans}.
9496 This option is experimental and does not currently guarantee to
9497 disable all GCC optimizations that affect signaling NaN behavior.
9499 @item -fsingle-precision-constant
9500 @opindex fsingle-precision-constant
9501 Treat floating-point constants as single precision instead of
9502 implicitly converting them to double-precision constants.
9504 @item -fcx-limited-range
9505 @opindex fcx-limited-range
9506 When enabled, this option states that a range reduction step is not
9507 needed when performing complex division.  Also, there is no checking
9508 whether the result of a complex multiplication or division is @code{NaN
9509 + I*NaN}, with an attempt to rescue the situation in that case.  The
9510 default is @option{-fno-cx-limited-range}, but is enabled by
9511 @option{-ffast-math}.
9513 This option controls the default setting of the ISO C99
9514 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9515 all languages.
9517 @item -fcx-fortran-rules
9518 @opindex fcx-fortran-rules
9519 Complex multiplication and division follow Fortran rules.  Range
9520 reduction is done as part of complex division, but there is no checking
9521 whether the result of a complex multiplication or division is @code{NaN
9522 + I*NaN}, with an attempt to rescue the situation in that case.
9524 The default is @option{-fno-cx-fortran-rules}.
9526 @end table
9528 The following options control optimizations that may improve
9529 performance, but are not enabled by any @option{-O} options.  This
9530 section includes experimental options that may produce broken code.
9532 @table @gcctabopt
9533 @item -fbranch-probabilities
9534 @opindex fbranch-probabilities
9535 After running a program compiled with @option{-fprofile-arcs}
9536 (@pxref{Debugging Options,, Options for Debugging Your Program or
9537 @command{gcc}}), you can compile it a second time using
9538 @option{-fbranch-probabilities}, to improve optimizations based on
9539 the number of times each branch was taken.  When a program
9540 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9541 counts to a file called @file{@var{sourcename}.gcda} for each source
9542 file.  The information in this data file is very dependent on the
9543 structure of the generated code, so you must use the same source code
9544 and the same optimization options for both compilations.
9546 With @option{-fbranch-probabilities}, GCC puts a
9547 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9548 These can be used to improve optimization.  Currently, they are only
9549 used in one place: in @file{reorg.c}, instead of guessing which path a
9550 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9551 exactly determine which path is taken more often.
9553 @item -fprofile-values
9554 @opindex fprofile-values
9555 If combined with @option{-fprofile-arcs}, it adds code so that some
9556 data about values of expressions in the program is gathered.
9558 With @option{-fbranch-probabilities}, it reads back the data gathered
9559 from profiling values of expressions for usage in optimizations.
9561 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9563 @item -fprofile-reorder-functions
9564 @opindex fprofile-reorder-functions
9565 Function reordering based on profile instrumentation collects
9566 first time of execution of a function and orders these functions
9567 in ascending order.
9569 Enabled with @option{-fprofile-use}.
9571 @item -fvpt
9572 @opindex fvpt
9573 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9574 to add code to gather information about values of expressions.
9576 With @option{-fbranch-probabilities}, it reads back the data gathered
9577 and actually performs the optimizations based on them.
9578 Currently the optimizations include specialization of division operations
9579 using the knowledge about the value of the denominator.
9581 @item -frename-registers
9582 @opindex frename-registers
9583 Attempt to avoid false dependencies in scheduled code by making use
9584 of registers left over after register allocation.  This optimization
9585 most benefits processors with lots of registers.  Depending on the
9586 debug information format adopted by the target, however, it can
9587 make debugging impossible, since variables no longer stay in
9588 a ``home register''.
9590 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9592 @item -fschedule-fusion
9593 @opindex fschedule-fusion
9594 Performs a target dependent pass over the instruction stream to schedule
9595 instructions of same type together because target machine can execute them
9596 more efficiently if they are adjacent to each other in the instruction flow.
9598 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9600 @item -ftracer
9601 @opindex ftracer
9602 Perform tail duplication to enlarge superblock size.  This transformation
9603 simplifies the control flow of the function allowing other optimizations to do
9604 a better job.
9606 Enabled with @option{-fprofile-use}.
9608 @item -funroll-loops
9609 @opindex funroll-loops
9610 Unroll loops whose number of iterations can be determined at compile time or
9611 upon entry to the loop.  @option{-funroll-loops} implies
9612 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9613 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9614 a small constant number of iterations).  This option makes code larger, and may
9615 or may not make it run faster.
9617 Enabled with @option{-fprofile-use}.
9619 @item -funroll-all-loops
9620 @opindex funroll-all-loops
9621 Unroll all loops, even if their number of iterations is uncertain when
9622 the loop is entered.  This usually makes programs run more slowly.
9623 @option{-funroll-all-loops} implies the same options as
9624 @option{-funroll-loops}.
9626 @item -fpeel-loops
9627 @opindex fpeel-loops
9628 Peels loops for which there is enough information that they do not
9629 roll much (from profile feedback).  It also turns on complete loop peeling
9630 (i.e.@: complete removal of loops with small constant number of iterations).
9632 Enabled with @option{-fprofile-use}.
9634 @item -fmove-loop-invariants
9635 @opindex fmove-loop-invariants
9636 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9637 at level @option{-O1}
9639 @item -funswitch-loops
9640 @opindex funswitch-loops
9641 Move branches with loop invariant conditions out of the loop, with duplicates
9642 of the loop on both branches (modified according to result of the condition).
9644 @item -ffunction-sections
9645 @itemx -fdata-sections
9646 @opindex ffunction-sections
9647 @opindex fdata-sections
9648 Place each function or data item into its own section in the output
9649 file if the target supports arbitrary sections.  The name of the
9650 function or the name of the data item determines the section's name
9651 in the output file.
9653 Use these options on systems where the linker can perform optimizations
9654 to improve locality of reference in the instruction space.  Most systems
9655 using the ELF object format and SPARC processors running Solaris 2 have
9656 linkers with such optimizations.  AIX may have these optimizations in
9657 the future.
9659 Only use these options when there are significant benefits from doing
9660 so.  When you specify these options, the assembler and linker
9661 create larger object and executable files and are also slower.
9662 You cannot use @code{gprof} on all systems if you
9663 specify this option, and you may have problems with debugging if
9664 you specify both this option and @option{-g}.
9666 @item -fbranch-target-load-optimize
9667 @opindex fbranch-target-load-optimize
9668 Perform branch target register load optimization before prologue / epilogue
9669 threading.
9670 The use of target registers can typically be exposed only during reload,
9671 thus hoisting loads out of loops and doing inter-block scheduling needs
9672 a separate optimization pass.
9674 @item -fbranch-target-load-optimize2
9675 @opindex fbranch-target-load-optimize2
9676 Perform branch target register load optimization after prologue / epilogue
9677 threading.
9679 @item -fbtr-bb-exclusive
9680 @opindex fbtr-bb-exclusive
9681 When performing branch target register load optimization, don't reuse
9682 branch target registers within any basic block.
9684 @item -fstack-protector
9685 @opindex fstack-protector
9686 Emit extra code to check for buffer overflows, such as stack smashing
9687 attacks.  This is done by adding a guard variable to functions with
9688 vulnerable objects.  This includes functions that call @code{alloca}, and
9689 functions with buffers larger than 8 bytes.  The guards are initialized
9690 when a function is entered and then checked when the function exits.
9691 If a guard check fails, an error message is printed and the program exits.
9693 @item -fstack-protector-all
9694 @opindex fstack-protector-all
9695 Like @option{-fstack-protector} except that all functions are protected.
9697 @item -fstack-protector-strong
9698 @opindex fstack-protector-strong
9699 Like @option{-fstack-protector} but includes additional functions to
9700 be protected --- those that have local array definitions, or have
9701 references to local frame addresses.
9703 @item -fsection-anchors
9704 @opindex fsection-anchors
9705 Try to reduce the number of symbolic address calculations by using
9706 shared ``anchor'' symbols to address nearby objects.  This transformation
9707 can help to reduce the number of GOT entries and GOT accesses on some
9708 targets.
9710 For example, the implementation of the following function @code{foo}:
9712 @smallexample
9713 static int a, b, c;
9714 int foo (void) @{ return a + b + c; @}
9715 @end smallexample
9717 @noindent
9718 usually calculates the addresses of all three variables, but if you
9719 compile it with @option{-fsection-anchors}, it accesses the variables
9720 from a common anchor point instead.  The effect is similar to the
9721 following pseudocode (which isn't valid C):
9723 @smallexample
9724 int foo (void)
9726   register int *xr = &x;
9727   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9729 @end smallexample
9731 Not all targets support this option.
9733 @item --param @var{name}=@var{value}
9734 @opindex param
9735 In some places, GCC uses various constants to control the amount of
9736 optimization that is done.  For example, GCC does not inline functions
9737 that contain more than a certain number of instructions.  You can
9738 control some of these constants on the command line using the
9739 @option{--param} option.
9741 The names of specific parameters, and the meaning of the values, are
9742 tied to the internals of the compiler, and are subject to change
9743 without notice in future releases.
9745 In each case, the @var{value} is an integer.  The allowable choices for
9746 @var{name} are:
9748 @table @gcctabopt
9749 @item predictable-branch-outcome
9750 When branch is predicted to be taken with probability lower than this threshold
9751 (in percent), then it is considered well predictable. The default is 10.
9753 @item max-crossjump-edges
9754 The maximum number of incoming edges to consider for cross-jumping.
9755 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9756 the number of edges incoming to each block.  Increasing values mean
9757 more aggressive optimization, making the compilation time increase with
9758 probably small improvement in executable size.
9760 @item min-crossjump-insns
9761 The minimum number of instructions that must be matched at the end
9762 of two blocks before cross-jumping is performed on them.  This
9763 value is ignored in the case where all instructions in the block being
9764 cross-jumped from are matched.  The default value is 5.
9766 @item max-grow-copy-bb-insns
9767 The maximum code size expansion factor when copying basic blocks
9768 instead of jumping.  The expansion is relative to a jump instruction.
9769 The default value is 8.
9771 @item max-goto-duplication-insns
9772 The maximum number of instructions to duplicate to a block that jumps
9773 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9774 passes, GCC factors computed gotos early in the compilation process,
9775 and unfactors them as late as possible.  Only computed jumps at the
9776 end of a basic blocks with no more than max-goto-duplication-insns are
9777 unfactored.  The default value is 8.
9779 @item max-delay-slot-insn-search
9780 The maximum number of instructions to consider when looking for an
9781 instruction to fill a delay slot.  If more than this arbitrary number of
9782 instructions are searched, the time savings from filling the delay slot
9783 are minimal, so stop searching.  Increasing values mean more
9784 aggressive optimization, making the compilation time increase with probably
9785 small improvement in execution time.
9787 @item max-delay-slot-live-search
9788 When trying to fill delay slots, the maximum number of instructions to
9789 consider when searching for a block with valid live register
9790 information.  Increasing this arbitrarily chosen value means more
9791 aggressive optimization, increasing the compilation time.  This parameter
9792 should be removed when the delay slot code is rewritten to maintain the
9793 control-flow graph.
9795 @item max-gcse-memory
9796 The approximate maximum amount of memory that can be allocated in
9797 order to perform the global common subexpression elimination
9798 optimization.  If more memory than specified is required, the
9799 optimization is not done.
9801 @item max-gcse-insertion-ratio
9802 If the ratio of expression insertions to deletions is larger than this value
9803 for any expression, then RTL PRE inserts or removes the expression and thus
9804 leaves partially redundant computations in the instruction stream.  The default value is 20.
9806 @item max-pending-list-length
9807 The maximum number of pending dependencies scheduling allows
9808 before flushing the current state and starting over.  Large functions
9809 with few branches or calls can create excessively large lists which
9810 needlessly consume memory and resources.
9812 @item max-modulo-backtrack-attempts
9813 The maximum number of backtrack attempts the scheduler should make
9814 when modulo scheduling a loop.  Larger values can exponentially increase
9815 compilation time.
9817 @item max-inline-insns-single
9818 Several parameters control the tree inliner used in GCC@.
9819 This number sets the maximum number of instructions (counted in GCC's
9820 internal representation) in a single function that the tree inliner
9821 considers for inlining.  This only affects functions declared
9822 inline and methods implemented in a class declaration (C++).
9823 The default value is 400.
9825 @item max-inline-insns-auto
9826 When you use @option{-finline-functions} (included in @option{-O3}),
9827 a lot of functions that would otherwise not be considered for inlining
9828 by the compiler are investigated.  To those functions, a different
9829 (more restrictive) limit compared to functions declared inline can
9830 be applied.
9831 The default value is 40.
9833 @item inline-min-speedup
9834 When estimated performance improvement of caller + callee runtime exceeds this
9835 threshold (in precent), the function can be inlined regardless the limit on
9836 @option{--param max-inline-insns-single} and @option{--param
9837 max-inline-insns-auto}.
9839 @item large-function-insns
9840 The limit specifying really large functions.  For functions larger than this
9841 limit after inlining, inlining is constrained by
9842 @option{--param large-function-growth}.  This parameter is useful primarily
9843 to avoid extreme compilation time caused by non-linear algorithms used by the
9844 back end.
9845 The default value is 2700.
9847 @item large-function-growth
9848 Specifies maximal growth of large function caused by inlining in percents.
9849 The default value is 100 which limits large function growth to 2.0 times
9850 the original size.
9852 @item large-unit-insns
9853 The limit specifying large translation unit.  Growth caused by inlining of
9854 units larger than this limit is limited by @option{--param inline-unit-growth}.
9855 For small units this might be too tight.
9856 For example, consider a unit consisting of function A
9857 that is inline and B that just calls A three times.  If B is small relative to
9858 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9859 large units consisting of small inlineable functions, however, the overall unit
9860 growth limit is needed to avoid exponential explosion of code size.  Thus for
9861 smaller units, the size is increased to @option{--param large-unit-insns}
9862 before applying @option{--param inline-unit-growth}.  The default is 10000.
9864 @item inline-unit-growth
9865 Specifies maximal overall growth of the compilation unit caused by inlining.
9866 The default value is 30 which limits unit growth to 1.3 times the original
9867 size. Cold functions (either marked cold via an attribute or by profile
9868 feedback) are not accounted into the unit size.
9870 @item ipcp-unit-growth
9871 Specifies maximal overall growth of the compilation unit caused by
9872 interprocedural constant propagation.  The default value is 10 which limits
9873 unit growth to 1.1 times the original size.
9875 @item large-stack-frame
9876 The limit specifying large stack frames.  While inlining the algorithm is trying
9877 to not grow past this limit too much.  The default value is 256 bytes.
9879 @item large-stack-frame-growth
9880 Specifies maximal growth of large stack frames caused by inlining in percents.
9881 The default value is 1000 which limits large stack frame growth to 11 times
9882 the original size.
9884 @item max-inline-insns-recursive
9885 @itemx max-inline-insns-recursive-auto
9886 Specifies the maximum number of instructions an out-of-line copy of a
9887 self-recursive inline
9888 function can grow into by performing recursive inlining.
9890 For functions declared inline, @option{--param max-inline-insns-recursive} is
9891 taken into account.  For functions not declared inline, recursive inlining
9892 happens only when @option{-finline-functions} (included in @option{-O3}) is
9893 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9894 default value is 450.
9896 @item max-inline-recursive-depth
9897 @itemx max-inline-recursive-depth-auto
9898 Specifies the maximum recursion depth used for recursive inlining.
9900 For functions declared inline, @option{--param max-inline-recursive-depth} is
9901 taken into account.  For functions not declared inline, recursive inlining
9902 happens only when @option{-finline-functions} (included in @option{-O3}) is
9903 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9904 default value is 8.
9906 @item min-inline-recursive-probability
9907 Recursive inlining is profitable only for function having deep recursion
9908 in average and can hurt for function having little recursion depth by
9909 increasing the prologue size or complexity of function body to other
9910 optimizers.
9912 When profile feedback is available (see @option{-fprofile-generate}) the actual
9913 recursion depth can be guessed from probability that function recurses via a
9914 given call expression.  This parameter limits inlining only to call expressions
9915 whose probability exceeds the given threshold (in percents).
9916 The default value is 10.
9918 @item early-inlining-insns
9919 Specify growth that the early inliner can make.  In effect it increases
9920 the amount of inlining for code having a large abstraction penalty.
9921 The default value is 10.
9923 @item max-early-inliner-iterations
9924 @itemx max-early-inliner-iterations
9925 Limit of iterations of the early inliner.  This basically bounds
9926 the number of nested indirect calls the early inliner can resolve.
9927 Deeper chains are still handled by late inlining.
9929 @item comdat-sharing-probability
9930 @itemx comdat-sharing-probability
9931 Probability (in percent) that C++ inline function with comdat visibility
9932 are shared across multiple compilation units.  The default value is 20.
9934 @item profile-func-internal-id
9935 @itemx profile-func-internal-id
9936 A parameter to control whether to use function internal id in profile
9937 database lookup. If the value is 0, the compiler will use id that
9938 is based on function assembler name and filename, which makes old profile
9939 data more tolerant to source changes such as function reordering etc.
9940 The default value is 0.
9942 @item min-vect-loop-bound
9943 The minimum number of iterations under which loops are not vectorized
9944 when @option{-ftree-vectorize} is used.  The number of iterations after
9945 vectorization needs to be greater than the value specified by this option
9946 to allow vectorization.  The default value is 0.
9948 @item gcse-cost-distance-ratio
9949 Scaling factor in calculation of maximum distance an expression
9950 can be moved by GCSE optimizations.  This is currently supported only in the
9951 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9952 is with simple expressions, i.e., the expressions that have cost
9953 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9954 hoisting of simple expressions.  The default value is 10.
9956 @item gcse-unrestricted-cost
9957 Cost, roughly measured as the cost of a single typical machine
9958 instruction, at which GCSE optimizations do not constrain
9959 the distance an expression can travel.  This is currently
9960 supported only in the code hoisting pass.  The lesser the cost,
9961 the more aggressive code hoisting is.  Specifying 0 
9962 allows all expressions to travel unrestricted distances.
9963 The default value is 3.
9965 @item max-hoist-depth
9966 The depth of search in the dominator tree for expressions to hoist.
9967 This is used to avoid quadratic behavior in hoisting algorithm.
9968 The value of 0 does not limit on the search, but may slow down compilation
9969 of huge functions.  The default value is 30.
9971 @item max-tail-merge-comparisons
9972 The maximum amount of similar bbs to compare a bb with.  This is used to
9973 avoid quadratic behavior in tree tail merging.  The default value is 10.
9975 @item max-tail-merge-iterations
9976 The maximum amount of iterations of the pass over the function.  This is used to
9977 limit compilation time in tree tail merging.  The default value is 2.
9979 @item max-unrolled-insns
9980 The maximum number of instructions that a loop may have to be unrolled.
9981 If a loop is unrolled, this parameter also determines how many times
9982 the loop code is unrolled.
9984 @item max-average-unrolled-insns
9985 The maximum number of instructions biased by probabilities of their execution
9986 that a loop may have to be unrolled.  If a loop is unrolled,
9987 this parameter also determines how many times the loop code is unrolled.
9989 @item max-unroll-times
9990 The maximum number of unrollings of a single loop.
9992 @item max-peeled-insns
9993 The maximum number of instructions that a loop may have to be peeled.
9994 If a loop is peeled, this parameter also determines how many times
9995 the loop code is peeled.
9997 @item max-peel-times
9998 The maximum number of peelings of a single loop.
10000 @item max-peel-branches
10001 The maximum number of branches on the hot path through the peeled sequence.
10003 @item max-completely-peeled-insns
10004 The maximum number of insns of a completely peeled loop.
10006 @item max-completely-peel-times
10007 The maximum number of iterations of a loop to be suitable for complete peeling.
10009 @item max-completely-peel-loop-nest-depth
10010 The maximum depth of a loop nest suitable for complete peeling.
10012 @item max-unswitch-insns
10013 The maximum number of insns of an unswitched loop.
10015 @item max-unswitch-level
10016 The maximum number of branches unswitched in a single loop.
10018 @item lim-expensive
10019 The minimum cost of an expensive expression in the loop invariant motion.
10021 @item iv-consider-all-candidates-bound
10022 Bound on number of candidates for induction variables, below which
10023 all candidates are considered for each use in induction variable
10024 optimizations.  If there are more candidates than this,
10025 only the most relevant ones are considered to avoid quadratic time complexity.
10027 @item iv-max-considered-uses
10028 The induction variable optimizations give up on loops that contain more
10029 induction variable uses.
10031 @item iv-always-prune-cand-set-bound
10032 If the number of candidates in the set is smaller than this value,
10033 always try to remove unnecessary ivs from the set
10034 when adding a new one.
10036 @item scev-max-expr-size
10037 Bound on size of expressions used in the scalar evolutions analyzer.
10038 Large expressions slow the analyzer.
10040 @item scev-max-expr-complexity
10041 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10042 Complex expressions slow the analyzer.
10044 @item omega-max-vars
10045 The maximum number of variables in an Omega constraint system.
10046 The default value is 128.
10048 @item omega-max-geqs
10049 The maximum number of inequalities in an Omega constraint system.
10050 The default value is 256.
10052 @item omega-max-eqs
10053 The maximum number of equalities in an Omega constraint system.
10054 The default value is 128.
10056 @item omega-max-wild-cards
10057 The maximum number of wildcard variables that the Omega solver is
10058 able to insert.  The default value is 18.
10060 @item omega-hash-table-size
10061 The size of the hash table in the Omega solver.  The default value is
10062 550.
10064 @item omega-max-keys
10065 The maximal number of keys used by the Omega solver.  The default
10066 value is 500.
10068 @item omega-eliminate-redundant-constraints
10069 When set to 1, use expensive methods to eliminate all redundant
10070 constraints.  The default value is 0.
10072 @item vect-max-version-for-alignment-checks
10073 The maximum number of run-time checks that can be performed when
10074 doing loop versioning for alignment in the vectorizer.
10076 @item vect-max-version-for-alias-checks
10077 The maximum number of run-time checks that can be performed when
10078 doing loop versioning for alias in the vectorizer.
10080 @item vect-max-peeling-for-alignment
10081 The maximum number of loop peels to enhance access alignment
10082 for vectorizer. Value -1 means 'no limit'.
10084 @item max-iterations-to-track
10085 The maximum number of iterations of a loop the brute-force algorithm
10086 for analysis of the number of iterations of the loop tries to evaluate.
10088 @item hot-bb-count-ws-permille
10089 A basic block profile count is considered hot if it contributes to 
10090 the given permillage (i.e. 0...1000) of the entire profiled execution.
10092 @item hot-bb-frequency-fraction
10093 Select fraction of the entry block frequency of executions of basic block in
10094 function given basic block needs to have to be considered hot.
10096 @item max-predicted-iterations
10097 The maximum number of loop iterations we predict statically.  This is useful
10098 in cases where a function contains a single loop with known bound and
10099 another loop with unknown bound.
10100 The known number of iterations is predicted correctly, while
10101 the unknown number of iterations average to roughly 10.  This means that the
10102 loop without bounds appears artificially cold relative to the other one.
10104 @item builtin-expect-probability
10105 Control the probability of the expression having the specified value. This
10106 parameter takes a percentage (i.e. 0 ... 100) as input.
10107 The default probability of 90 is obtained empirically.
10109 @item align-threshold
10111 Select fraction of the maximal frequency of executions of a basic block in
10112 a function to align the basic block.
10114 @item align-loop-iterations
10116 A loop expected to iterate at least the selected number of iterations is
10117 aligned.
10119 @item tracer-dynamic-coverage
10120 @itemx tracer-dynamic-coverage-feedback
10122 This value is used to limit superblock formation once the given percentage of
10123 executed instructions is covered.  This limits unnecessary code size
10124 expansion.
10126 The @option{tracer-dynamic-coverage-feedback} is used only when profile
10127 feedback is available.  The real profiles (as opposed to statically estimated
10128 ones) are much less balanced allowing the threshold to be larger value.
10130 @item tracer-max-code-growth
10131 Stop tail duplication once code growth has reached given percentage.  This is
10132 a rather artificial limit, as most of the duplicates are eliminated later in
10133 cross jumping, so it may be set to much higher values than is the desired code
10134 growth.
10136 @item tracer-min-branch-ratio
10138 Stop reverse growth when the reverse probability of best edge is less than this
10139 threshold (in percent).
10141 @item tracer-min-branch-ratio
10142 @itemx tracer-min-branch-ratio-feedback
10144 Stop forward growth if the best edge has probability lower than this
10145 threshold.
10147 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10148 compilation for profile feedback and one for compilation without.  The value
10149 for compilation with profile feedback needs to be more conservative (higher) in
10150 order to make tracer effective.
10152 @item max-cse-path-length
10154 The maximum number of basic blocks on path that CSE considers.
10155 The default is 10.
10157 @item max-cse-insns
10158 The maximum number of instructions CSE processes before flushing.
10159 The default is 1000.
10161 @item ggc-min-expand
10163 GCC uses a garbage collector to manage its own memory allocation.  This
10164 parameter specifies the minimum percentage by which the garbage
10165 collector's heap should be allowed to expand between collections.
10166 Tuning this may improve compilation speed; it has no effect on code
10167 generation.
10169 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10170 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10171 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10172 GCC is not able to calculate RAM on a particular platform, the lower
10173 bound of 30% is used.  Setting this parameter and
10174 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10175 every opportunity.  This is extremely slow, but can be useful for
10176 debugging.
10178 @item ggc-min-heapsize
10180 Minimum size of the garbage collector's heap before it begins bothering
10181 to collect garbage.  The first collection occurs after the heap expands
10182 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10183 tuning this may improve compilation speed, and has no effect on code
10184 generation.
10186 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10187 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10188 with a lower bound of 4096 (four megabytes) and an upper bound of
10189 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10190 particular platform, the lower bound is used.  Setting this parameter
10191 very large effectively disables garbage collection.  Setting this
10192 parameter and @option{ggc-min-expand} to zero causes a full collection
10193 to occur at every opportunity.
10195 @item max-reload-search-insns
10196 The maximum number of instruction reload should look backward for equivalent
10197 register.  Increasing values mean more aggressive optimization, making the
10198 compilation time increase with probably slightly better performance.
10199 The default value is 100.
10201 @item max-cselib-memory-locations
10202 The maximum number of memory locations cselib should take into account.
10203 Increasing values mean more aggressive optimization, making the compilation time
10204 increase with probably slightly better performance.  The default value is 500.
10206 @item reorder-blocks-duplicate
10207 @itemx reorder-blocks-duplicate-feedback
10209 Used by the basic block reordering pass to decide whether to use unconditional
10210 branch or duplicate the code on its destination.  Code is duplicated when its
10211 estimated size is smaller than this value multiplied by the estimated size of
10212 unconditional jump in the hot spots of the program.
10214 The @option{reorder-block-duplicate-feedback} is used only when profile
10215 feedback is available.  It may be set to higher values than
10216 @option{reorder-block-duplicate} since information about the hot spots is more
10217 accurate.
10219 @item max-sched-ready-insns
10220 The maximum number of instructions ready to be issued the scheduler should
10221 consider at any given time during the first scheduling pass.  Increasing
10222 values mean more thorough searches, making the compilation time increase
10223 with probably little benefit.  The default value is 100.
10225 @item max-sched-region-blocks
10226 The maximum number of blocks in a region to be considered for
10227 interblock scheduling.  The default value is 10.
10229 @item max-pipeline-region-blocks
10230 The maximum number of blocks in a region to be considered for
10231 pipelining in the selective scheduler.  The default value is 15.
10233 @item max-sched-region-insns
10234 The maximum number of insns in a region to be considered for
10235 interblock scheduling.  The default value is 100.
10237 @item max-pipeline-region-insns
10238 The maximum number of insns in a region to be considered for
10239 pipelining in the selective scheduler.  The default value is 200.
10241 @item min-spec-prob
10242 The minimum probability (in percents) of reaching a source block
10243 for interblock speculative scheduling.  The default value is 40.
10245 @item max-sched-extend-regions-iters
10246 The maximum number of iterations through CFG to extend regions.
10247 A value of 0 (the default) disables region extensions.
10249 @item max-sched-insn-conflict-delay
10250 The maximum conflict delay for an insn to be considered for speculative motion.
10251 The default value is 3.
10253 @item sched-spec-prob-cutoff
10254 The minimal probability of speculation success (in percents), so that
10255 speculative insns are scheduled.
10256 The default value is 40.
10258 @item sched-spec-state-edge-prob-cutoff
10259 The minimum probability an edge must have for the scheduler to save its
10260 state across it.
10261 The default value is 10.
10263 @item sched-mem-true-dep-cost
10264 Minimal distance (in CPU cycles) between store and load targeting same
10265 memory locations.  The default value is 1.
10267 @item selsched-max-lookahead
10268 The maximum size of the lookahead window of selective scheduling.  It is a
10269 depth of search for available instructions.
10270 The default value is 50.
10272 @item selsched-max-sched-times
10273 The maximum number of times that an instruction is scheduled during
10274 selective scheduling.  This is the limit on the number of iterations
10275 through which the instruction may be pipelined.  The default value is 2.
10277 @item selsched-max-insns-to-rename
10278 The maximum number of best instructions in the ready list that are considered
10279 for renaming in the selective scheduler.  The default value is 2.
10281 @item sms-min-sc
10282 The minimum value of stage count that swing modulo scheduler
10283 generates.  The default value is 2.
10285 @item max-last-value-rtl
10286 The maximum size measured as number of RTLs that can be recorded in an expression
10287 in combiner for a pseudo register as last known value of that register.  The default
10288 is 10000.
10290 @item max-combine-insns
10291 The maximum number of instructions the RTL combiner tries to combine.
10292 The default value is 2 at @option{-Og} and 4 otherwise.
10294 @item integer-share-limit
10295 Small integer constants can use a shared data structure, reducing the
10296 compiler's memory usage and increasing its speed.  This sets the maximum
10297 value of a shared integer constant.  The default value is 256.
10299 @item ssp-buffer-size
10300 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10301 protection when @option{-fstack-protection} is used.
10303 @item min-size-for-stack-sharing
10304 The minimum size of variables taking part in stack slot sharing when not
10305 optimizing. The default value is 32.
10307 @item max-jump-thread-duplication-stmts
10308 Maximum number of statements allowed in a block that needs to be
10309 duplicated when threading jumps.
10311 @item max-fields-for-field-sensitive
10312 Maximum number of fields in a structure treated in
10313 a field sensitive manner during pointer analysis.  The default is zero
10314 for @option{-O0} and @option{-O1},
10315 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10317 @item prefetch-latency
10318 Estimate on average number of instructions that are executed before
10319 prefetch finishes.  The distance prefetched ahead is proportional
10320 to this constant.  Increasing this number may also lead to less
10321 streams being prefetched (see @option{simultaneous-prefetches}).
10323 @item simultaneous-prefetches
10324 Maximum number of prefetches that can run at the same time.
10326 @item l1-cache-line-size
10327 The size of cache line in L1 cache, in bytes.
10329 @item l1-cache-size
10330 The size of L1 cache, in kilobytes.
10332 @item l2-cache-size
10333 The size of L2 cache, in kilobytes.
10335 @item min-insn-to-prefetch-ratio
10336 The minimum ratio between the number of instructions and the
10337 number of prefetches to enable prefetching in a loop.
10339 @item prefetch-min-insn-to-mem-ratio
10340 The minimum ratio between the number of instructions and the
10341 number of memory references to enable prefetching in a loop.
10343 @item use-canonical-types
10344 Whether the compiler should use the ``canonical'' type system.  By
10345 default, this should always be 1, which uses a more efficient internal
10346 mechanism for comparing types in C++ and Objective-C++.  However, if
10347 bugs in the canonical type system are causing compilation failures,
10348 set this value to 0 to disable canonical types.
10350 @item switch-conversion-max-branch-ratio
10351 Switch initialization conversion refuses to create arrays that are
10352 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10353 branches in the switch.
10355 @item max-partial-antic-length
10356 Maximum length of the partial antic set computed during the tree
10357 partial redundancy elimination optimization (@option{-ftree-pre}) when
10358 optimizing at @option{-O3} and above.  For some sorts of source code
10359 the enhanced partial redundancy elimination optimization can run away,
10360 consuming all of the memory available on the host machine.  This
10361 parameter sets a limit on the length of the sets that are computed,
10362 which prevents the runaway behavior.  Setting a value of 0 for
10363 this parameter allows an unlimited set length.
10365 @item sccvn-max-scc-size
10366 Maximum size of a strongly connected component (SCC) during SCCVN
10367 processing.  If this limit is hit, SCCVN processing for the whole
10368 function is not done and optimizations depending on it are
10369 disabled.  The default maximum SCC size is 10000.
10371 @item sccvn-max-alias-queries-per-access
10372 Maximum number of alias-oracle queries we perform when looking for
10373 redundancies for loads and stores.  If this limit is hit the search
10374 is aborted and the load or store is not considered redundant.  The
10375 number of queries is algorithmically limited to the number of
10376 stores on all paths from the load to the function entry.
10377 The default maxmimum number of queries is 1000.
10379 @item ira-max-loops-num
10380 IRA uses regional register allocation by default.  If a function
10381 contains more loops than the number given by this parameter, only at most
10382 the given number of the most frequently-executed loops form regions
10383 for regional register allocation.  The default value of the
10384 parameter is 100.
10386 @item ira-max-conflict-table-size 
10387 Although IRA uses a sophisticated algorithm to compress the conflict
10388 table, the table can still require excessive amounts of memory for
10389 huge functions.  If the conflict table for a function could be more
10390 than the size in MB given by this parameter, the register allocator
10391 instead uses a faster, simpler, and lower-quality
10392 algorithm that does not require building a pseudo-register conflict table.  
10393 The default value of the parameter is 2000.
10395 @item ira-loop-reserved-regs
10396 IRA can be used to evaluate more accurate register pressure in loops
10397 for decisions to move loop invariants (see @option{-O3}).  The number
10398 of available registers reserved for some other purposes is given
10399 by this parameter.  The default value of the parameter is 2, which is
10400 the minimal number of registers needed by typical instructions.
10401 This value is the best found from numerous experiments.
10403 @item loop-invariant-max-bbs-in-loop
10404 Loop invariant motion can be very expensive, both in compilation time and
10405 in amount of needed compile-time memory, with very large loops.  Loops
10406 with more basic blocks than this parameter won't have loop invariant
10407 motion optimization performed on them.  The default value of the
10408 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10410 @item loop-max-datarefs-for-datadeps
10411 Building data dapendencies is expensive for very large loops.  This
10412 parameter limits the number of data references in loops that are
10413 considered for data dependence analysis.  These large loops are no
10414 handled by the optimizations using loop data dependencies.
10415 The default value is 1000.
10417 @item max-vartrack-size
10418 Sets a maximum number of hash table slots to use during variable
10419 tracking dataflow analysis of any function.  If this limit is exceeded
10420 with variable tracking at assignments enabled, analysis for that
10421 function is retried without it, after removing all debug insns from
10422 the function.  If the limit is exceeded even without debug insns, var
10423 tracking analysis is completely disabled for the function.  Setting
10424 the parameter to zero makes it unlimited.
10426 @item max-vartrack-expr-depth
10427 Sets a maximum number of recursion levels when attempting to map
10428 variable names or debug temporaries to value expressions.  This trades
10429 compilation time for more complete debug information.  If this is set too
10430 low, value expressions that are available and could be represented in
10431 debug information may end up not being used; setting this higher may
10432 enable the compiler to find more complex debug expressions, but compile
10433 time and memory use may grow.  The default is 12.
10435 @item min-nondebug-insn-uid
10436 Use uids starting at this parameter for nondebug insns.  The range below
10437 the parameter is reserved exclusively for debug insns created by
10438 @option{-fvar-tracking-assignments}, but debug insns may get
10439 (non-overlapping) uids above it if the reserved range is exhausted.
10441 @item ipa-sra-ptr-growth-factor
10442 IPA-SRA replaces a pointer to an aggregate with one or more new
10443 parameters only when their cumulative size is less or equal to
10444 @option{ipa-sra-ptr-growth-factor} times the size of the original
10445 pointer parameter.
10447 @item sra-max-scalarization-size-Ospeed
10448 @item sra-max-scalarization-size-Osize
10449 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10450 replace scalar parts of aggregates with uses of independent scalar
10451 variables.  These parameters control the maximum size, in storage units,
10452 of aggregate which will be considered for replacement when compiling for
10453 speed
10454 (@option{sra-max-scalarization-size-Ospeed}) or size
10455 (@option{sra-max-scalarization-size-Osize}) respectively.
10457 @item tm-max-aggregate-size
10458 When making copies of thread-local variables in a transaction, this
10459 parameter specifies the size in bytes after which variables are
10460 saved with the logging functions as opposed to save/restore code
10461 sequence pairs.  This option only applies when using
10462 @option{-fgnu-tm}.
10464 @item graphite-max-nb-scop-params
10465 To avoid exponential effects in the Graphite loop transforms, the
10466 number of parameters in a Static Control Part (SCoP) is bounded.  The
10467 default value is 10 parameters.  A variable whose value is unknown at
10468 compilation time and defined outside a SCoP is a parameter of the SCoP.
10470 @item graphite-max-bbs-per-function
10471 To avoid exponential effects in the detection of SCoPs, the size of
10472 the functions analyzed by Graphite is bounded.  The default value is
10473 100 basic blocks.
10475 @item loop-block-tile-size
10476 Loop blocking or strip mining transforms, enabled with
10477 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10478 loop in the loop nest by a given number of iterations.  The strip
10479 length can be changed using the @option{loop-block-tile-size}
10480 parameter.  The default value is 51 iterations.
10482 @item loop-unroll-jam-size
10483 Specify the unroll factor for the @option{-floop-unroll-and-jam}.  The 
10484 default value is 4.
10486 @item loop-unroll-jam-depth
10487 Specify the dimension to be unrolled (counting from the most inner loop)
10488 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10490 @item ipa-cp-value-list-size
10491 IPA-CP attempts to track all possible values and types passed to a function's
10492 parameter in order to propagate them and perform devirtualization.
10493 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10494 stores per one formal parameter of a function.
10496 @item ipa-cp-eval-threshold
10497 IPA-CP calculates its own score of cloning profitability heuristics
10498 and performs those cloning opportunities with scores that exceed
10499 @option{ipa-cp-eval-threshold}.
10501 @item ipa-max-agg-items
10502 IPA-CP is also capable to propagate a number of scalar values passed
10503 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10504 number of such values per one parameter.
10506 @item ipa-cp-loop-hint-bonus
10507 When IPA-CP determines that a cloning candidate would make the number
10508 of iterations of a loop known, it adds a bonus of
10509 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10510 the candidate.
10512 @item ipa-cp-array-index-hint-bonus
10513 When IPA-CP determines that a cloning candidate would make the index of
10514 an array access known, it adds a bonus of
10515 @option{ipa-cp-array-index-hint-bonus} to the profitability
10516 score of the candidate.
10518 @item ipa-max-aa-steps
10519 During its analysis of function bodies, IPA-CP employs alias analysis
10520 in order to track values pointed to by function parameters.  In order
10521 not spend too much time analyzing huge functions, it will give up and
10522 consider all memory clobbered after examining
10523 @option{ipa-max-aa-steps} statements modifying memory.
10525 @item lto-partitions
10526 Specify desired number of partitions produced during WHOPR compilation.
10527 The number of partitions should exceed the number of CPUs used for compilation.
10528 The default value is 32.
10530 @item lto-minpartition
10531 Size of minimal partition for WHOPR (in estimated instructions).
10532 This prevents expenses of splitting very small programs into too many
10533 partitions.
10535 @item cxx-max-namespaces-for-diagnostic-help
10536 The maximum number of namespaces to consult for suggestions when C++
10537 name lookup fails for an identifier.  The default is 1000.
10539 @item sink-frequency-threshold
10540 The maximum relative execution frequency (in percents) of the target block
10541 relative to a statement's original block to allow statement sinking of a
10542 statement.  Larger numbers result in more aggressive statement sinking.
10543 The default value is 75.  A small positive adjustment is applied for
10544 statements with memory operands as those are even more profitable so sink.
10546 @item max-stores-to-sink
10547 The maximum number of conditional stores paires that can be sunk.  Set to 0
10548 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10549 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10551 @item allow-store-data-races
10552 Allow optimizers to introduce new data races on stores.
10553 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10554 at optimization level @option{-Ofast}.
10556 @item case-values-threshold
10557 The smallest number of different values for which it is best to use a
10558 jump-table instead of a tree of conditional branches.  If the value is
10559 0, use the default for the machine.  The default is 0.
10561 @item tree-reassoc-width
10562 Set the maximum number of instructions executed in parallel in
10563 reassociated tree. This parameter overrides target dependent
10564 heuristics used by default if has non zero value.
10566 @item sched-pressure-algorithm
10567 Choose between the two available implementations of
10568 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10569 and is the more likely to prevent instructions from being reordered.
10570 Algorithm 2 was designed to be a compromise between the relatively
10571 conservative approach taken by algorithm 1 and the rather aggressive
10572 approach taken by the default scheduler.  It relies more heavily on
10573 having a regular register file and accurate register pressure classes.
10574 See @file{haifa-sched.c} in the GCC sources for more details.
10576 The default choice depends on the target.
10578 @item max-slsr-cand-scan
10579 Set the maximum number of existing candidates that will be considered when
10580 seeking a basis for a new straight-line strength reduction candidate.
10582 @item asan-globals
10583 Enable buffer overflow detection for global objects.  This kind
10584 of protection is enabled by default if you are using
10585 @option{-fsanitize=address} option.
10586 To disable global objects protection use @option{--param asan-globals=0}.
10588 @item asan-stack
10589 Enable buffer overflow detection for stack objects.  This kind of
10590 protection is enabled by default when using@option{-fsanitize=address}.
10591 To disable stack protection use @option{--param asan-stack=0} option.
10593 @item asan-instrument-reads
10594 Enable buffer overflow detection for memory reads.  This kind of
10595 protection is enabled by default when using @option{-fsanitize=address}.
10596 To disable memory reads protection use
10597 @option{--param asan-instrument-reads=0}.
10599 @item asan-instrument-writes
10600 Enable buffer overflow detection for memory writes.  This kind of
10601 protection is enabled by default when using @option{-fsanitize=address}.
10602 To disable memory writes protection use
10603 @option{--param asan-instrument-writes=0} option.
10605 @item asan-memintrin
10606 Enable detection for built-in functions.  This kind of protection
10607 is enabled by default when using @option{-fsanitize=address}.
10608 To disable built-in functions protection use
10609 @option{--param asan-memintrin=0}.
10611 @item asan-use-after-return
10612 Enable detection of use-after-return.  This kind of protection
10613 is enabled by default when using @option{-fsanitize=address} option.
10614 To disable use-after-return detection use 
10615 @option{--param asan-use-after-return=0}.
10617 @item asan-instrumentation-with-call-threshold
10618 If number of memory accesses in function being instrumented
10619 is greater or equal to this number, use callbacks instead of inline checks.
10620 E.g. to disable inline code use
10621 @option{--param asan-instrumentation-with-call-threshold=0}.
10623 @item chkp-max-ctor-size
10624 Static constructors generated by Pointer Bounds Checker may become very
10625 large and significantly increase compile time at optimization level
10626 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10627 in a single generated constructor.  Default value is 5000.
10629 @item max-fsm-thread-path-insns
10630 Maximum number of instructions to copy when duplicating blocks on a
10631 finite state automaton jump thread path.  The default is 100.
10633 @item max-fsm-thread-length
10634 Maximum number of basic blocks on a finite state automaton jump thread
10635 path.  The default is 10.
10637 @item max-fsm-thread-paths
10638 Maximum number of new jump thread paths to create for a finite state
10639 automaton.  The default is 50.
10641 @end table
10642 @end table
10644 @node Preprocessor Options
10645 @section Options Controlling the Preprocessor
10646 @cindex preprocessor options
10647 @cindex options, preprocessor
10649 These options control the C preprocessor, which is run on each C source
10650 file before actual compilation.
10652 If you use the @option{-E} option, nothing is done except preprocessing.
10653 Some of these options make sense only together with @option{-E} because
10654 they cause the preprocessor output to be unsuitable for actual
10655 compilation.
10657 @table @gcctabopt
10658 @item -Wp,@var{option}
10659 @opindex Wp
10660 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10661 and pass @var{option} directly through to the preprocessor.  If
10662 @var{option} contains commas, it is split into multiple options at the
10663 commas.  However, many options are modified, translated or interpreted
10664 by the compiler driver before being passed to the preprocessor, and
10665 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10666 interface is undocumented and subject to change, so whenever possible
10667 you should avoid using @option{-Wp} and let the driver handle the
10668 options instead.
10670 @item -Xpreprocessor @var{option}
10671 @opindex Xpreprocessor
10672 Pass @var{option} as an option to the preprocessor.  You can use this to
10673 supply system-specific preprocessor options that GCC does not 
10674 recognize.
10676 If you want to pass an option that takes an argument, you must use
10677 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10679 @item -no-integrated-cpp
10680 @opindex no-integrated-cpp
10681 Perform preprocessing as a separate pass before compilation.
10682 By default, GCC performs preprocessing as an integrated part of
10683 input tokenization and parsing.
10684 If this option is provided, the appropriate language front end
10685 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10686 and Objective-C, respectively) is instead invoked twice,
10687 once for preprocessing only and once for actual compilation
10688 of the preprocessed input.
10689 This option may be useful in conjunction with the @option{-B} or
10690 @option{-wrapper} options to specify an alternate preprocessor or
10691 perform additional processing of the program source between
10692 normal preprocessing and compilation.
10693 @end table
10695 @include cppopts.texi
10697 @node Assembler Options
10698 @section Passing Options to the Assembler
10700 @c prevent bad page break with this line
10701 You can pass options to the assembler.
10703 @table @gcctabopt
10704 @item -Wa,@var{option}
10705 @opindex Wa
10706 Pass @var{option} as an option to the assembler.  If @var{option}
10707 contains commas, it is split into multiple options at the commas.
10709 @item -Xassembler @var{option}
10710 @opindex Xassembler
10711 Pass @var{option} as an option to the assembler.  You can use this to
10712 supply system-specific assembler options that GCC does not
10713 recognize.
10715 If you want to pass an option that takes an argument, you must use
10716 @option{-Xassembler} twice, once for the option and once for the argument.
10718 @end table
10720 @node Link Options
10721 @section Options for Linking
10722 @cindex link options
10723 @cindex options, linking
10725 These options come into play when the compiler links object files into
10726 an executable output file.  They are meaningless if the compiler is
10727 not doing a link step.
10729 @table @gcctabopt
10730 @cindex file names
10731 @item @var{object-file-name}
10732 A file name that does not end in a special recognized suffix is
10733 considered to name an object file or library.  (Object files are
10734 distinguished from libraries by the linker according to the file
10735 contents.)  If linking is done, these object files are used as input
10736 to the linker.
10738 @item -c
10739 @itemx -S
10740 @itemx -E
10741 @opindex c
10742 @opindex S
10743 @opindex E
10744 If any of these options is used, then the linker is not run, and
10745 object file names should not be used as arguments.  @xref{Overall
10746 Options}.
10748 @cindex Libraries
10749 @item -l@var{library}
10750 @itemx -l @var{library}
10751 @opindex l
10752 Search the library named @var{library} when linking.  (The second
10753 alternative with the library as a separate argument is only for
10754 POSIX compliance and is not recommended.)
10756 It makes a difference where in the command you write this option; the
10757 linker searches and processes libraries and object files in the order they
10758 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10759 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10760 to functions in @samp{z}, those functions may not be loaded.
10762 The linker searches a standard list of directories for the library,
10763 which is actually a file named @file{lib@var{library}.a}.  The linker
10764 then uses this file as if it had been specified precisely by name.
10766 The directories searched include several standard system directories
10767 plus any that you specify with @option{-L}.
10769 Normally the files found this way are library files---archive files
10770 whose members are object files.  The linker handles an archive file by
10771 scanning through it for members which define symbols that have so far
10772 been referenced but not defined.  But if the file that is found is an
10773 ordinary object file, it is linked in the usual fashion.  The only
10774 difference between using an @option{-l} option and specifying a file name
10775 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10776 and searches several directories.
10778 @item -lobjc
10779 @opindex lobjc
10780 You need this special case of the @option{-l} option in order to
10781 link an Objective-C or Objective-C++ program.
10783 @item -nostartfiles
10784 @opindex nostartfiles
10785 Do not use the standard system startup files when linking.
10786 The standard system libraries are used normally, unless @option{-nostdlib}
10787 or @option{-nodefaultlibs} is used.
10789 @item -nodefaultlibs
10790 @opindex nodefaultlibs
10791 Do not use the standard system libraries when linking.
10792 Only the libraries you specify are passed to the linker, and options
10793 specifying linkage of the system libraries, such as @code{-static-libgcc}
10794 or @code{-shared-libgcc}, are ignored.  
10795 The standard startup files are used normally, unless @option{-nostartfiles}
10796 is used.  
10798 The compiler may generate calls to @code{memcmp},
10799 @code{memset}, @code{memcpy} and @code{memmove}.
10800 These entries are usually resolved by entries in
10801 libc.  These entry points should be supplied through some other
10802 mechanism when this option is specified.
10804 @item -nostdlib
10805 @opindex nostdlib
10806 Do not use the standard system startup files or libraries when linking.
10807 No startup files and only the libraries you specify are passed to
10808 the linker, and options specifying linkage of the system libraries, such as
10809 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10811 The compiler may generate calls to @code{memcmp}, @code{memset},
10812 @code{memcpy} and @code{memmove}.
10813 These entries are usually resolved by entries in
10814 libc.  These entry points should be supplied through some other
10815 mechanism when this option is specified.
10817 @cindex @option{-lgcc}, use with @option{-nostdlib}
10818 @cindex @option{-nostdlib} and unresolved references
10819 @cindex unresolved references and @option{-nostdlib}
10820 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10821 @cindex @option{-nodefaultlibs} and unresolved references
10822 @cindex unresolved references and @option{-nodefaultlibs}
10823 One of the standard libraries bypassed by @option{-nostdlib} and
10824 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10825 which GCC uses to overcome shortcomings of particular machines, or special
10826 needs for some languages.
10827 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10828 Collection (GCC) Internals},
10829 for more discussion of @file{libgcc.a}.)
10830 In most cases, you need @file{libgcc.a} even when you want to avoid
10831 other standard libraries.  In other words, when you specify @option{-nostdlib}
10832 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10833 This ensures that you have no unresolved references to internal GCC
10834 library subroutines.
10835 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10836 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10837 GNU Compiler Collection (GCC) Internals}.)
10839 @item -pie
10840 @opindex pie
10841 Produce a position independent executable on targets that support it.
10842 For predictable results, you must also specify the same set of options
10843 used for compilation (@option{-fpie}, @option{-fPIE},
10844 or model suboptions) when you specify this linker option.
10846 @item -rdynamic
10847 @opindex rdynamic
10848 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10849 that support it. This instructs the linker to add all symbols, not
10850 only used ones, to the dynamic symbol table. This option is needed
10851 for some uses of @code{dlopen} or to allow obtaining backtraces
10852 from within a program.
10854 @item -s
10855 @opindex s
10856 Remove all symbol table and relocation information from the executable.
10858 @item -static
10859 @opindex static
10860 On systems that support dynamic linking, this prevents linking with the shared
10861 libraries.  On other systems, this option has no effect.
10863 @item -shared
10864 @opindex shared
10865 Produce a shared object which can then be linked with other objects to
10866 form an executable.  Not all systems support this option.  For predictable
10867 results, you must also specify the same set of options used for compilation
10868 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10869 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10870 needs to build supplementary stub code for constructors to work.  On
10871 multi-libbed systems, @samp{gcc -shared} must select the correct support
10872 libraries to link against.  Failing to supply the correct flags may lead
10873 to subtle defects.  Supplying them in cases where they are not necessary
10874 is innocuous.}
10876 @item -shared-libgcc
10877 @itemx -static-libgcc
10878 @opindex shared-libgcc
10879 @opindex static-libgcc
10880 On systems that provide @file{libgcc} as a shared library, these options
10881 force the use of either the shared or static version, respectively.
10882 If no shared version of @file{libgcc} was built when the compiler was
10883 configured, these options have no effect.
10885 There are several situations in which an application should use the
10886 shared @file{libgcc} instead of the static version.  The most common
10887 of these is when the application wishes to throw and catch exceptions
10888 across different shared libraries.  In that case, each of the libraries
10889 as well as the application itself should use the shared @file{libgcc}.
10891 Therefore, the G++ and GCJ drivers automatically add
10892 @option{-shared-libgcc} whenever you build a shared library or a main
10893 executable, because C++ and Java programs typically use exceptions, so
10894 this is the right thing to do.
10896 If, instead, you use the GCC driver to create shared libraries, you may
10897 find that they are not always linked with the shared @file{libgcc}.
10898 If GCC finds, at its configuration time, that you have a non-GNU linker
10899 or a GNU linker that does not support option @option{--eh-frame-hdr},
10900 it links the shared version of @file{libgcc} into shared libraries
10901 by default.  Otherwise, it takes advantage of the linker and optimizes
10902 away the linking with the shared version of @file{libgcc}, linking with
10903 the static version of libgcc by default.  This allows exceptions to
10904 propagate through such shared libraries, without incurring relocation
10905 costs at library load time.
10907 However, if a library or main executable is supposed to throw or catch
10908 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10909 for the languages used in the program, or using the option
10910 @option{-shared-libgcc}, such that it is linked with the shared
10911 @file{libgcc}.
10913 @item -static-libasan
10914 @opindex static-libasan
10915 When the @option{-fsanitize=address} option is used to link a program,
10916 the GCC driver automatically links against @option{libasan}.  If
10917 @file{libasan} is available as a shared library, and the @option{-static}
10918 option is not used, then this links against the shared version of
10919 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10920 driver to link @file{libasan} statically, without necessarily linking
10921 other libraries statically.
10923 @item -static-libtsan
10924 @opindex static-libtsan
10925 When the @option{-fsanitize=thread} option is used to link a program,
10926 the GCC driver automatically links against @option{libtsan}.  If
10927 @file{libtsan} is available as a shared library, and the @option{-static}
10928 option is not used, then this links against the shared version of
10929 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10930 driver to link @file{libtsan} statically, without necessarily linking
10931 other libraries statically.
10933 @item -static-liblsan
10934 @opindex static-liblsan
10935 When the @option{-fsanitize=leak} option is used to link a program,
10936 the GCC driver automatically links against @option{liblsan}.  If
10937 @file{liblsan} is available as a shared library, and the @option{-static}
10938 option is not used, then this links against the shared version of
10939 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10940 driver to link @file{liblsan} statically, without necessarily linking
10941 other libraries statically.
10943 @item -static-libubsan
10944 @opindex static-libubsan
10945 When the @option{-fsanitize=undefined} option is used to link a program,
10946 the GCC driver automatically links against @option{libubsan}.  If
10947 @file{libubsan} is available as a shared library, and the @option{-static}
10948 option is not used, then this links against the shared version of
10949 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10950 driver to link @file{libubsan} statically, without necessarily linking
10951 other libraries statically.
10953 @item -static-libstdc++
10954 @opindex static-libstdc++
10955 When the @command{g++} program is used to link a C++ program, it
10956 normally automatically links against @option{libstdc++}.  If
10957 @file{libstdc++} is available as a shared library, and the
10958 @option{-static} option is not used, then this links against the
10959 shared version of @file{libstdc++}.  That is normally fine.  However, it
10960 is sometimes useful to freeze the version of @file{libstdc++} used by
10961 the program without going all the way to a fully static link.  The
10962 @option{-static-libstdc++} option directs the @command{g++} driver to
10963 link @file{libstdc++} statically, without necessarily linking other
10964 libraries statically.
10966 @item -symbolic
10967 @opindex symbolic
10968 Bind references to global symbols when building a shared object.  Warn
10969 about any unresolved references (unless overridden by the link editor
10970 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10971 this option.
10973 @item -T @var{script}
10974 @opindex T
10975 @cindex linker script
10976 Use @var{script} as the linker script.  This option is supported by most
10977 systems using the GNU linker.  On some targets, such as bare-board
10978 targets without an operating system, the @option{-T} option may be required
10979 when linking to avoid references to undefined symbols.
10981 @item -Xlinker @var{option}
10982 @opindex Xlinker
10983 Pass @var{option} as an option to the linker.  You can use this to
10984 supply system-specific linker options that GCC does not recognize.
10986 If you want to pass an option that takes a separate argument, you must use
10987 @option{-Xlinker} twice, once for the option and once for the argument.
10988 For example, to pass @option{-assert definitions}, you must write
10989 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10990 @option{-Xlinker "-assert definitions"}, because this passes the entire
10991 string as a single argument, which is not what the linker expects.
10993 When using the GNU linker, it is usually more convenient to pass
10994 arguments to linker options using the @option{@var{option}=@var{value}}
10995 syntax than as separate arguments.  For example, you can specify
10996 @option{-Xlinker -Map=output.map} rather than
10997 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10998 this syntax for command-line options.
11000 @item -Wl,@var{option}
11001 @opindex Wl
11002 Pass @var{option} as an option to the linker.  If @var{option} contains
11003 commas, it is split into multiple options at the commas.  You can use this
11004 syntax to pass an argument to the option.
11005 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11006 linker.  When using the GNU linker, you can also get the same effect with
11007 @option{-Wl,-Map=output.map}.
11009 @item -u @var{symbol}
11010 @opindex u
11011 Pretend the symbol @var{symbol} is undefined, to force linking of
11012 library modules to define it.  You can use @option{-u} multiple times with
11013 different symbols to force loading of additional library modules.
11015 @item -z @var{keyword}
11016 @opindex z
11017 @option{-z} is passed directly on to the linker along with the keyword
11018 @var{keyword}. See the section in the documentation of your linker for
11019 permitted values and their meanings.
11020 @end table
11022 @node Directory Options
11023 @section Options for Directory Search
11024 @cindex directory options
11025 @cindex options, directory search
11026 @cindex search path
11028 These options specify directories to search for header files, for
11029 libraries and for parts of the compiler:
11031 @table @gcctabopt
11032 @item -I@var{dir}
11033 @opindex I
11034 Add the directory @var{dir} to the head of the list of directories to be
11035 searched for header files.  This can be used to override a system header
11036 file, substituting your own version, since these directories are
11037 searched before the system header file directories.  However, you should
11038 not use this option to add directories that contain vendor-supplied
11039 system header files (use @option{-isystem} for that).  If you use more than
11040 one @option{-I} option, the directories are scanned in left-to-right
11041 order; the standard system directories come after.
11043 If a standard system include directory, or a directory specified with
11044 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11045 option is ignored.  The directory is still searched but as a
11046 system directory at its normal position in the system include chain.
11047 This is to ensure that GCC's procedure to fix buggy system headers and
11048 the ordering for the @code{include_next} directive are not inadvertently changed.
11049 If you really need to change the search order for system directories,
11050 use the @option{-nostdinc} and/or @option{-isystem} options.
11052 @item -iplugindir=@var{dir}
11053 @opindex iplugindir=
11054 Set the directory to search for plugins that are passed
11055 by @option{-fplugin=@var{name}} instead of
11056 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11057 to be used by the user, but only passed by the driver.
11059 @item -iquote@var{dir}
11060 @opindex iquote
11061 Add the directory @var{dir} to the head of the list of directories to
11062 be searched for header files only for the case of @samp{#include
11063 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
11064 otherwise just like @option{-I}.
11066 @item -L@var{dir}
11067 @opindex L
11068 Add directory @var{dir} to the list of directories to be searched
11069 for @option{-l}.
11071 @item -B@var{prefix}
11072 @opindex B
11073 This option specifies where to find the executables, libraries,
11074 include files, and data files of the compiler itself.
11076 The compiler driver program runs one or more of the subprograms
11077 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11078 @var{prefix} as a prefix for each program it tries to run, both with and
11079 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11081 For each subprogram to be run, the compiler driver first tries the
11082 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11083 is not specified, the driver tries two standard prefixes, 
11084 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11085 those results in a file name that is found, the unmodified program
11086 name is searched for using the directories specified in your
11087 @env{PATH} environment variable.
11089 The compiler checks to see if the path provided by the @option{-B}
11090 refers to a directory, and if necessary it adds a directory
11091 separator character at the end of the path.
11093 @option{-B} prefixes that effectively specify directory names also apply
11094 to libraries in the linker, because the compiler translates these
11095 options into @option{-L} options for the linker.  They also apply to
11096 include files in the preprocessor, because the compiler translates these
11097 options into @option{-isystem} options for the preprocessor.  In this case,
11098 the compiler appends @samp{include} to the prefix.
11100 The runtime support file @file{libgcc.a} can also be searched for using
11101 the @option{-B} prefix, if needed.  If it is not found there, the two
11102 standard prefixes above are tried, and that is all.  The file is left
11103 out of the link if it is not found by those means.
11105 Another way to specify a prefix much like the @option{-B} prefix is to use
11106 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11107 Variables}.
11109 As a special kludge, if the path provided by @option{-B} is
11110 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11111 9, then it is replaced by @file{[dir/]include}.  This is to help
11112 with boot-strapping the compiler.
11114 @item -specs=@var{file}
11115 @opindex specs
11116 Process @var{file} after the compiler reads in the standard @file{specs}
11117 file, in order to override the defaults which the @command{gcc} driver
11118 program uses when determining what switches to pass to @command{cc1},
11119 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11120 @option{-specs=@var{file}} can be specified on the command line, and they
11121 are processed in order, from left to right.
11123 @item --sysroot=@var{dir}
11124 @opindex sysroot
11125 Use @var{dir} as the logical root directory for headers and libraries.
11126 For example, if the compiler normally searches for headers in
11127 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11128 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11130 If you use both this option and the @option{-isysroot} option, then
11131 the @option{--sysroot} option applies to libraries, but the
11132 @option{-isysroot} option applies to header files.
11134 The GNU linker (beginning with version 2.16) has the necessary support
11135 for this option.  If your linker does not support this option, the
11136 header file aspect of @option{--sysroot} still works, but the
11137 library aspect does not.
11139 @item --no-sysroot-suffix
11140 @opindex no-sysroot-suffix
11141 For some targets, a suffix is added to the root directory specified
11142 with @option{--sysroot}, depending on the other options used, so that
11143 headers may for example be found in
11144 @file{@var{dir}/@var{suffix}/usr/include} instead of
11145 @file{@var{dir}/usr/include}.  This option disables the addition of
11146 such a suffix.
11148 @item -I-
11149 @opindex I-
11150 This option has been deprecated.  Please use @option{-iquote} instead for
11151 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
11152 Any directories you specify with @option{-I} options before the @option{-I-}
11153 option are searched only for the case of @samp{#include "@var{file}"};
11154 they are not searched for @samp{#include <@var{file}>}.
11156 If additional directories are specified with @option{-I} options after
11157 the @option{-I-}, these directories are searched for all @samp{#include}
11158 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11159 this way.)
11161 In addition, the @option{-I-} option inhibits the use of the current
11162 directory (where the current input file came from) as the first search
11163 directory for @samp{#include "@var{file}"}.  There is no way to
11164 override this effect of @option{-I-}.  With @option{-I.} you can specify
11165 searching the directory that is current when the compiler is
11166 invoked.  That is not exactly the same as what the preprocessor does
11167 by default, but it is often satisfactory.
11169 @option{-I-} does not inhibit the use of the standard system directories
11170 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11171 independent.
11172 @end table
11174 @c man end
11176 @node Spec Files
11177 @section Specifying subprocesses and the switches to pass to them
11178 @cindex Spec Files
11180 @command{gcc} is a driver program.  It performs its job by invoking a
11181 sequence of other programs to do the work of compiling, assembling and
11182 linking.  GCC interprets its command-line parameters and uses these to
11183 deduce which programs it should invoke, and which command-line options
11184 it ought to place on their command lines.  This behavior is controlled
11185 by @dfn{spec strings}.  In most cases there is one spec string for each
11186 program that GCC can invoke, but a few programs have multiple spec
11187 strings to control their behavior.  The spec strings built into GCC can
11188 be overridden by using the @option{-specs=} command-line switch to specify
11189 a spec file.
11191 @dfn{Spec files} are plaintext files that are used to construct spec
11192 strings.  They consist of a sequence of directives separated by blank
11193 lines.  The type of directive is determined by the first non-whitespace
11194 character on the line, which can be one of the following:
11196 @table @code
11197 @item %@var{command}
11198 Issues a @var{command} to the spec file processor.  The commands that can
11199 appear here are:
11201 @table @code
11202 @item %include <@var{file}>
11203 @cindex @code{%include}
11204 Search for @var{file} and insert its text at the current point in the
11205 specs file.
11207 @item %include_noerr <@var{file}>
11208 @cindex @code{%include_noerr}
11209 Just like @samp{%include}, but do not generate an error message if the include
11210 file cannot be found.
11212 @item %rename @var{old_name} @var{new_name}
11213 @cindex @code{%rename}
11214 Rename the spec string @var{old_name} to @var{new_name}.
11216 @end table
11218 @item *[@var{spec_name}]:
11219 This tells the compiler to create, override or delete the named spec
11220 string.  All lines after this directive up to the next directive or
11221 blank line are considered to be the text for the spec string.  If this
11222 results in an empty string then the spec is deleted.  (Or, if the
11223 spec did not exist, then nothing happens.)  Otherwise, if the spec
11224 does not currently exist a new spec is created.  If the spec does
11225 exist then its contents are overridden by the text of this
11226 directive, unless the first character of that text is the @samp{+}
11227 character, in which case the text is appended to the spec.
11229 @item [@var{suffix}]:
11230 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11231 and up to the next directive or blank line are considered to make up the
11232 spec string for the indicated suffix.  When the compiler encounters an
11233 input file with the named suffix, it processes the spec string in
11234 order to work out how to compile that file.  For example:
11236 @smallexample
11237 .ZZ:
11238 z-compile -input %i
11239 @end smallexample
11241 This says that any input file whose name ends in @samp{.ZZ} should be
11242 passed to the program @samp{z-compile}, which should be invoked with the
11243 command-line switch @option{-input} and with the result of performing the
11244 @samp{%i} substitution.  (See below.)
11246 As an alternative to providing a spec string, the text following a
11247 suffix directive can be one of the following:
11249 @table @code
11250 @item @@@var{language}
11251 This says that the suffix is an alias for a known @var{language}.  This is
11252 similar to using the @option{-x} command-line switch to GCC to specify a
11253 language explicitly.  For example:
11255 @smallexample
11256 .ZZ:
11257 @@c++
11258 @end smallexample
11260 Says that .ZZ files are, in fact, C++ source files.
11262 @item #@var{name}
11263 This causes an error messages saying:
11265 @smallexample
11266 @var{name} compiler not installed on this system.
11267 @end smallexample
11268 @end table
11270 GCC already has an extensive list of suffixes built into it.
11271 This directive adds an entry to the end of the list of suffixes, but
11272 since the list is searched from the end backwards, it is effectively
11273 possible to override earlier entries using this technique.
11275 @end table
11277 GCC has the following spec strings built into it.  Spec files can
11278 override these strings or create their own.  Note that individual
11279 targets can also add their own spec strings to this list.
11281 @smallexample
11282 asm          Options to pass to the assembler
11283 asm_final    Options to pass to the assembler post-processor
11284 cpp          Options to pass to the C preprocessor
11285 cc1          Options to pass to the C compiler
11286 cc1plus      Options to pass to the C++ compiler
11287 endfile      Object files to include at the end of the link
11288 link         Options to pass to the linker
11289 lib          Libraries to include on the command line to the linker
11290 libgcc       Decides which GCC support library to pass to the linker
11291 linker       Sets the name of the linker
11292 predefines   Defines to be passed to the C preprocessor
11293 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11294              by default
11295 startfile    Object files to include at the start of the link
11296 @end smallexample
11298 Here is a small example of a spec file:
11300 @smallexample
11301 %rename lib                 old_lib
11303 *lib:
11304 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11305 @end smallexample
11307 This example renames the spec called @samp{lib} to @samp{old_lib} and
11308 then overrides the previous definition of @samp{lib} with a new one.
11309 The new definition adds in some extra command-line options before
11310 including the text of the old definition.
11312 @dfn{Spec strings} are a list of command-line options to be passed to their
11313 corresponding program.  In addition, the spec strings can contain
11314 @samp{%}-prefixed sequences to substitute variable text or to
11315 conditionally insert text into the command line.  Using these constructs
11316 it is possible to generate quite complex command lines.
11318 Here is a table of all defined @samp{%}-sequences for spec
11319 strings.  Note that spaces are not generated automatically around the
11320 results of expanding these sequences.  Therefore you can concatenate them
11321 together or combine them with constant text in a single argument.
11323 @table @code
11324 @item %%
11325 Substitute one @samp{%} into the program name or argument.
11327 @item %i
11328 Substitute the name of the input file being processed.
11330 @item %b
11331 Substitute the basename of the input file being processed.
11332 This is the substring up to (and not including) the last period
11333 and not including the directory.
11335 @item %B
11336 This is the same as @samp{%b}, but include the file suffix (text after
11337 the last period).
11339 @item %d
11340 Marks the argument containing or following the @samp{%d} as a
11341 temporary file name, so that that file is deleted if GCC exits
11342 successfully.  Unlike @samp{%g}, this contributes no text to the
11343 argument.
11345 @item %g@var{suffix}
11346 Substitute a file name that has suffix @var{suffix} and is chosen
11347 once per compilation, and mark the argument in the same way as
11348 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11349 name is now chosen in a way that is hard to predict even when previously
11350 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11351 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11352 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11353 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11354 was simply substituted with a file name chosen once per compilation,
11355 without regard to any appended suffix (which was therefore treated
11356 just like ordinary text), making such attacks more likely to succeed.
11358 @item %u@var{suffix}
11359 Like @samp{%g}, but generates a new temporary file name
11360 each time it appears instead of once per compilation.
11362 @item %U@var{suffix}
11363 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11364 new one if there is no such last file name.  In the absence of any
11365 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11366 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11367 involves the generation of two distinct file names, one
11368 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11369 simply substituted with a file name chosen for the previous @samp{%u},
11370 without regard to any appended suffix.
11372 @item %j@var{suffix}
11373 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11374 writable, and if @option{-save-temps} is not used; 
11375 otherwise, substitute the name
11376 of a temporary file, just like @samp{%u}.  This temporary file is not
11377 meant for communication between processes, but rather as a junk
11378 disposal mechanism.
11380 @item %|@var{suffix}
11381 @itemx %m@var{suffix}
11382 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11383 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11384 all.  These are the two most common ways to instruct a program that it
11385 should read from standard input or write to standard output.  If you
11386 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11387 construct: see for example @file{f/lang-specs.h}.
11389 @item %.@var{SUFFIX}
11390 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11391 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11392 terminated by the next space or %.
11394 @item %w
11395 Marks the argument containing or following the @samp{%w} as the
11396 designated output file of this compilation.  This puts the argument
11397 into the sequence of arguments that @samp{%o} substitutes.
11399 @item %o
11400 Substitutes the names of all the output files, with spaces
11401 automatically placed around them.  You should write spaces
11402 around the @samp{%o} as well or the results are undefined.
11403 @samp{%o} is for use in the specs for running the linker.
11404 Input files whose names have no recognized suffix are not compiled
11405 at all, but they are included among the output files, so they are
11406 linked.
11408 @item %O
11409 Substitutes the suffix for object files.  Note that this is
11410 handled specially when it immediately follows @samp{%g, %u, or %U},
11411 because of the need for those to form complete file names.  The
11412 handling is such that @samp{%O} is treated exactly as if it had already
11413 been substituted, except that @samp{%g, %u, and %U} do not currently
11414 support additional @var{suffix} characters following @samp{%O} as they do
11415 following, for example, @samp{.o}.
11417 @item %p
11418 Substitutes the standard macro predefinitions for the
11419 current target machine.  Use this when running @code{cpp}.
11421 @item %P
11422 Like @samp{%p}, but puts @samp{__} before and after the name of each
11423 predefined macro, except for macros that start with @samp{__} or with
11424 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11427 @item %I
11428 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11429 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11430 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11431 and @option{-imultilib} as necessary.
11433 @item %s
11434 Current argument is the name of a library or startup file of some sort.
11435 Search for that file in a standard list of directories and substitute
11436 the full name found.  The current working directory is included in the
11437 list of directories scanned.
11439 @item %T
11440 Current argument is the name of a linker script.  Search for that file
11441 in the current list of directories to scan for libraries. If the file
11442 is located insert a @option{--script} option into the command line
11443 followed by the full path name found.  If the file is not found then
11444 generate an error message.  Note: the current working directory is not
11445 searched.
11447 @item %e@var{str}
11448 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11449 Use this when inconsistent options are detected.
11451 @item %(@var{name})
11452 Substitute the contents of spec string @var{name} at this point.
11454 @item %x@{@var{option}@}
11455 Accumulate an option for @samp{%X}.
11457 @item %X
11458 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11459 spec string.
11461 @item %Y
11462 Output the accumulated assembler options specified by @option{-Wa}.
11464 @item %Z
11465 Output the accumulated preprocessor options specified by @option{-Wp}.
11467 @item %a
11468 Process the @code{asm} spec.  This is used to compute the
11469 switches to be passed to the assembler.
11471 @item %A
11472 Process the @code{asm_final} spec.  This is a spec string for
11473 passing switches to an assembler post-processor, if such a program is
11474 needed.
11476 @item %l
11477 Process the @code{link} spec.  This is the spec for computing the
11478 command line passed to the linker.  Typically it makes use of the
11479 @samp{%L %G %S %D and %E} sequences.
11481 @item %D
11482 Dump out a @option{-L} option for each directory that GCC believes might
11483 contain startup files.  If the target supports multilibs then the
11484 current multilib directory is prepended to each of these paths.
11486 @item %L
11487 Process the @code{lib} spec.  This is a spec string for deciding which
11488 libraries are included on the command line to the linker.
11490 @item %G
11491 Process the @code{libgcc} spec.  This is a spec string for deciding
11492 which GCC support library is included on the command line to the linker.
11494 @item %S
11495 Process the @code{startfile} spec.  This is a spec for deciding which
11496 object files are the first ones passed to the linker.  Typically
11497 this might be a file named @file{crt0.o}.
11499 @item %E
11500 Process the @code{endfile} spec.  This is a spec string that specifies
11501 the last object files that are passed to the linker.
11503 @item %C
11504 Process the @code{cpp} spec.  This is used to construct the arguments
11505 to be passed to the C preprocessor.
11507 @item %1
11508 Process the @code{cc1} spec.  This is used to construct the options to be
11509 passed to the actual C compiler (@samp{cc1}).
11511 @item %2
11512 Process the @code{cc1plus} spec.  This is used to construct the options to be
11513 passed to the actual C++ compiler (@samp{cc1plus}).
11515 @item %*
11516 Substitute the variable part of a matched option.  See below.
11517 Note that each comma in the substituted string is replaced by
11518 a single space.
11520 @item %<@code{S}
11521 Remove all occurrences of @code{-S} from the command line.  Note---this
11522 command is position dependent.  @samp{%} commands in the spec string
11523 before this one see @code{-S}, @samp{%} commands in the spec string
11524 after this one do not.
11526 @item %:@var{function}(@var{args})
11527 Call the named function @var{function}, passing it @var{args}.
11528 @var{args} is first processed as a nested spec string, then split
11529 into an argument vector in the usual fashion.  The function returns
11530 a string which is processed as if it had appeared literally as part
11531 of the current spec.
11533 The following built-in spec functions are provided:
11535 @table @code
11536 @item @code{getenv}
11537 The @code{getenv} spec function takes two arguments: an environment
11538 variable name and a string.  If the environment variable is not
11539 defined, a fatal error is issued.  Otherwise, the return value is the
11540 value of the environment variable concatenated with the string.  For
11541 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11543 @smallexample
11544 %:getenv(TOPDIR /include)
11545 @end smallexample
11547 expands to @file{/path/to/top/include}.
11549 @item @code{if-exists}
11550 The @code{if-exists} spec function takes one argument, an absolute
11551 pathname to a file.  If the file exists, @code{if-exists} returns the
11552 pathname.  Here is a small example of its usage:
11554 @smallexample
11555 *startfile:
11556 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11557 @end smallexample
11559 @item @code{if-exists-else}
11560 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11561 spec function, except that it takes two arguments.  The first argument is
11562 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11563 returns the pathname.  If it does not exist, it returns the second argument.
11564 This way, @code{if-exists-else} can be used to select one file or another,
11565 based on the existence of the first.  Here is a small example of its usage:
11567 @smallexample
11568 *startfile:
11569 crt0%O%s %:if-exists(crti%O%s) \
11570 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11571 @end smallexample
11573 @item @code{replace-outfile}
11574 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11575 first argument in the outfiles array and replaces it with the second argument.  Here
11576 is a small example of its usage:
11578 @smallexample
11579 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11580 @end smallexample
11582 @item @code{remove-outfile}
11583 The @code{remove-outfile} spec function takes one argument.  It looks for the
11584 first argument in the outfiles array and removes it.  Here is a small example
11585 its usage:
11587 @smallexample
11588 %:remove-outfile(-lm)
11589 @end smallexample
11591 @item @code{pass-through-libs}
11592 The @code{pass-through-libs} spec function takes any number of arguments.  It
11593 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11594 assumes are the names of linker input library archive files) and returns a
11595 result containing all the found arguments each prepended by
11596 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11597 intended to be passed to the LTO linker plugin.
11599 @smallexample
11600 %:pass-through-libs(%G %L %G)
11601 @end smallexample
11603 @item @code{print-asm-header}
11604 The @code{print-asm-header} function takes no arguments and simply
11605 prints a banner like:
11607 @smallexample
11608 Assembler options
11609 =================
11611 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11612 @end smallexample
11614 It is used to separate compiler options from assembler options
11615 in the @option{--target-help} output.
11616 @end table
11618 @item %@{@code{S}@}
11619 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11620 If that switch is not specified, this substitutes nothing.  Note that
11621 the leading dash is omitted when specifying this option, and it is
11622 automatically inserted if the substitution is performed.  Thus the spec
11623 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11624 and outputs the command-line option @option{-foo}.
11626 @item %W@{@code{S}@}
11627 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11628 deleted on failure.
11630 @item %@{@code{S}*@}
11631 Substitutes all the switches specified to GCC whose names start
11632 with @code{-S}, but which also take an argument.  This is used for
11633 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11634 GCC considers @option{-o foo} as being
11635 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11636 text, including the space.  Thus two arguments are generated.
11638 @item %@{@code{S}*&@code{T}*@}
11639 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11640 (the order of @code{S} and @code{T} in the spec is not significant).
11641 There can be any number of ampersand-separated variables; for each the
11642 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11644 @item %@{@code{S}:@code{X}@}
11645 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11647 @item %@{!@code{S}:@code{X}@}
11648 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11650 @item %@{@code{S}*:@code{X}@}
11651 Substitutes @code{X} if one or more switches whose names start with
11652 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11653 once, no matter how many such switches appeared.  However, if @code{%*}
11654 appears somewhere in @code{X}, then @code{X} is substituted once
11655 for each matching switch, with the @code{%*} replaced by the part of
11656 that switch matching the @code{*}.
11658 If @code{%*} appears as the last part of a spec sequence then a space
11659 will be added after the end of the last substitution.  If there is more
11660 text in the sequence however then a space will not be generated.  This
11661 allows the @code{%*} substitution to be used as part of a larger
11662 string.  For example, a spec string like this:
11664 @smallexample
11665 %@{mcu=*:--script=%*/memory.ld@}
11666 @end smallexample
11668 when matching an option like @code{-mcu=newchip} will produce:
11670 @smallexample
11671 --script=newchip/memory.ld
11672 @end smallexample
11674 @item %@{.@code{S}:@code{X}@}
11675 Substitutes @code{X}, if processing a file with suffix @code{S}.
11677 @item %@{!.@code{S}:@code{X}@}
11678 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11680 @item %@{,@code{S}:@code{X}@}
11681 Substitutes @code{X}, if processing a file for language @code{S}.
11683 @item %@{!,@code{S}:@code{X}@}
11684 Substitutes @code{X}, if not processing a file for language @code{S}.
11686 @item %@{@code{S}|@code{P}:@code{X}@}
11687 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11688 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11689 @code{*} sequences as well, although they have a stronger binding than
11690 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11691 alternatives must be starred, and only the first matching alternative
11692 is substituted.
11694 For example, a spec string like this:
11696 @smallexample
11697 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11698 @end smallexample
11700 @noindent
11701 outputs the following command-line options from the following input
11702 command-line options:
11704 @smallexample
11705 fred.c        -foo -baz
11706 jim.d         -bar -boggle
11707 -d fred.c     -foo -baz -boggle
11708 -d jim.d      -bar -baz -boggle
11709 @end smallexample
11711 @item %@{S:X; T:Y; :D@}
11713 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11714 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11715 be as many clauses as you need.  This may be combined with @code{.},
11716 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11719 @end table
11721 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11722 construct may contain other nested @samp{%} constructs or spaces, or
11723 even newlines.  They are processed as usual, as described above.
11724 Trailing white space in @code{X} is ignored.  White space may also
11725 appear anywhere on the left side of the colon in these constructs,
11726 except between @code{.} or @code{*} and the corresponding word.
11728 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11729 handled specifically in these constructs.  If another value of
11730 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11731 @option{-W} switch is found later in the command line, the earlier
11732 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11733 just one letter, which passes all matching options.
11735 The character @samp{|} at the beginning of the predicate text is used to
11736 indicate that a command should be piped to the following command, but
11737 only if @option{-pipe} is specified.
11739 It is built into GCC which switches take arguments and which do not.
11740 (You might think it would be useful to generalize this to allow each
11741 compiler's spec to say which switches take arguments.  But this cannot
11742 be done in a consistent fashion.  GCC cannot even decide which input
11743 files have been specified without knowing which switches take arguments,
11744 and it must know which input files to compile in order to tell which
11745 compilers to run).
11747 GCC also knows implicitly that arguments starting in @option{-l} are to be
11748 treated as compiler output files, and passed to the linker in their
11749 proper position among the other output files.
11751 @c man begin OPTIONS
11753 @node Target Options
11754 @section Specifying Target Machine and Compiler Version
11755 @cindex target options
11756 @cindex cross compiling
11757 @cindex specifying machine version
11758 @cindex specifying compiler version and target machine
11759 @cindex compiler version, specifying
11760 @cindex target machine, specifying
11762 The usual way to run GCC is to run the executable called @command{gcc}, or
11763 @command{@var{machine}-gcc} when cross-compiling, or
11764 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11765 one that was installed last.
11767 @node Submodel Options
11768 @section Hardware Models and Configurations
11769 @cindex submodel options
11770 @cindex specifying hardware config
11771 @cindex hardware models and configurations, specifying
11772 @cindex machine dependent options
11774 Each target machine types can have its own
11775 special options, starting with @samp{-m}, to choose among various
11776 hardware models or configurations---for example, 68010 vs 68020,
11777 floating coprocessor or none.  A single installed version of the
11778 compiler can compile for any model or configuration, according to the
11779 options specified.
11781 Some configurations of the compiler also support additional special
11782 options, usually for compatibility with other compilers on the same
11783 platform.
11785 @c This list is ordered alphanumerically by subsection name.
11786 @c It should be the same order and spelling as these options are listed
11787 @c in Machine Dependent Options
11789 @menu
11790 * AArch64 Options::
11791 * Adapteva Epiphany Options::
11792 * ARC Options::
11793 * ARM Options::
11794 * AVR Options::
11795 * Blackfin Options::
11796 * C6X Options::
11797 * CRIS Options::
11798 * CR16 Options::
11799 * Darwin Options::
11800 * DEC Alpha Options::
11801 * FR30 Options::
11802 * FRV Options::
11803 * GNU/Linux Options::
11804 * H8/300 Options::
11805 * HPPA Options::
11806 * i386 and x86-64 Options::
11807 * i386 and x86-64 Windows Options::
11808 * IA-64 Options::
11809 * LM32 Options::
11810 * M32C Options::
11811 * M32R/D Options::
11812 * M680x0 Options::
11813 * MCore Options::
11814 * MeP Options::
11815 * MicroBlaze Options::
11816 * MIPS Options::
11817 * MMIX Options::
11818 * MN10300 Options::
11819 * Moxie Options::
11820 * MSP430 Options::
11821 * NDS32 Options::
11822 * Nios II Options::
11823 * PDP-11 Options::
11824 * picoChip Options::
11825 * PowerPC Options::
11826 * RL78 Options::
11827 * RS/6000 and PowerPC Options::
11828 * RX Options::
11829 * S/390 and zSeries Options::
11830 * Score Options::
11831 * SH Options::
11832 * Solaris 2 Options::
11833 * SPARC Options::
11834 * SPU Options::
11835 * System V Options::
11836 * TILE-Gx Options::
11837 * TILEPro Options::
11838 * V850 Options::
11839 * VAX Options::
11840 * VMS Options::
11841 * VxWorks Options::
11842 * x86-64 Options::
11843 * Xstormy16 Options::
11844 * Xtensa Options::
11845 * zSeries Options::
11846 @end menu
11848 @node AArch64 Options
11849 @subsection AArch64 Options
11850 @cindex AArch64 Options
11852 These options are defined for AArch64 implementations:
11854 @table @gcctabopt
11856 @item -mabi=@var{name}
11857 @opindex mabi
11858 Generate code for the specified data model.  Permissible values
11859 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11860 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11861 but long int and pointer are 64-bit.
11863 The default depends on the specific target configuration.  Note that
11864 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11865 entire program with the same ABI, and link with a compatible set of libraries.
11867 @item -mbig-endian
11868 @opindex mbig-endian
11869 Generate big-endian code.  This is the default when GCC is configured for an
11870 @samp{aarch64_be-*-*} target.
11872 @item -mgeneral-regs-only
11873 @opindex mgeneral-regs-only
11874 Generate code which uses only the general registers.
11876 @item -mlittle-endian
11877 @opindex mlittle-endian
11878 Generate little-endian code.  This is the default when GCC is configured for an
11879 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11881 @item -mcmodel=tiny
11882 @opindex mcmodel=tiny
11883 Generate code for the tiny code model.  The program and its statically defined
11884 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11885 be statically or dynamically linked.  This model is not fully implemented and
11886 mostly treated as @samp{small}.
11888 @item -mcmodel=small
11889 @opindex mcmodel=small
11890 Generate code for the small code model.  The program and its statically defined
11891 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11892 be statically or dynamically linked.  This is the default code model.
11894 @item -mcmodel=large
11895 @opindex mcmodel=large
11896 Generate code for the large code model.  This makes no assumptions about
11897 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11898 statically linked only.
11900 @item -mstrict-align
11901 @opindex mstrict-align
11902 Do not assume that unaligned memory references will be handled by the system.
11904 @item -momit-leaf-frame-pointer
11905 @itemx -mno-omit-leaf-frame-pointer
11906 @opindex momit-leaf-frame-pointer
11907 @opindex mno-omit-leaf-frame-pointer
11908 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11909 default.
11911 @item -mtls-dialect=desc
11912 @opindex mtls-dialect=desc
11913 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11914 of TLS variables.  This is the default.
11916 @item -mtls-dialect=traditional
11917 @opindex mtls-dialect=traditional
11918 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11919 of TLS variables.
11921 @item -mfix-cortex-a53-835769
11922 @itemx -mno-fix-cortex-a53-835769
11923 @opindex -mfix-cortex-a53-835769
11924 @opindex -mno-fix-cortex-a53-835769
11925 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
11926 This will involve inserting a NOP instruction between memory instructions and
11927 64-bit integer multiply-accumulate instructions.
11929 @item -march=@var{name}
11930 @opindex march
11931 Specify the name of the target architecture, optionally suffixed by one or
11932 more feature modifiers.  This option has the form
11933 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11934 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11935 values for @var{feature} are documented in the sub-section below.
11937 Where conflicting feature modifiers are specified, the right-most feature is
11938 used.
11940 GCC uses this name to determine what kind of instructions it can emit when
11941 generating assembly code.
11943 Where @option{-march} is specified without either of @option{-mtune}
11944 or @option{-mcpu} also being specified, the code will be tuned to perform
11945 well across a range of target processors implementing the target
11946 architecture.
11948 @item -mtune=@var{name}
11949 @opindex mtune
11950 Specify the name of the target processor for which GCC should tune the
11951 performance of the code.  Permissible values for this option are:
11952 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{thunderx}.
11954 Additionally, this option can specify that GCC should tune the performance
11955 of the code for a big.LITTLE system.  The only permissible value is
11956 @samp{cortex-a57.cortex-a53}.
11958 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
11959 are specified, the code will be tuned to perform well across a range
11960 of target processors.
11962 This option cannot be suffixed by feature modifiers.
11964 @item -mcpu=@var{name}
11965 @opindex mcpu
11966 Specify the name of the target processor, optionally suffixed by one or more
11967 feature modifiers.  This option has the form
11968 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11969 permissible values for @var{cpu} are the same as those available for
11970 @option{-mtune}.
11972 The permissible values for @var{feature} are documented in the sub-section
11973 below.
11975 Where conflicting feature modifiers are specified, the right-most feature is
11976 used.
11978 GCC uses this name to determine what kind of instructions it can emit when
11979 generating assembly code (as if by @option{-march}) and to determine
11980 the target processor for which to tune for performance (as if
11981 by @option{-mtune}).  Where this option is used in conjunction
11982 with @option{-march} or @option{-mtune}, those options take precedence
11983 over the appropriate part of this option.
11984 @end table
11986 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11987 @cindex @option{-march} feature modifiers
11988 @cindex @option{-mcpu} feature modifiers
11989 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11990 the following:
11992 @table @samp
11993 @item crc
11994 Enable CRC extension.
11995 @item crypto
11996 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11997 @item fp
11998 Enable floating-point instructions.
11999 @item simd
12000 Enable Advanced SIMD instructions.  This implies floating-point instructions
12001 are enabled.  This is the default for all current possible values for options
12002 @option{-march} and @option{-mcpu=}.
12003 @end table
12005 @node Adapteva Epiphany Options
12006 @subsection Adapteva Epiphany Options
12008 These @samp{-m} options are defined for Adapteva Epiphany:
12010 @table @gcctabopt
12011 @item -mhalf-reg-file
12012 @opindex mhalf-reg-file
12013 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12014 That allows code to run on hardware variants that lack these registers.
12016 @item -mprefer-short-insn-regs
12017 @opindex mprefer-short-insn-regs
12018 Preferrentially allocate registers that allow short instruction generation.
12019 This can result in increased instruction count, so this may either reduce or
12020 increase overall code size.
12022 @item -mbranch-cost=@var{num}
12023 @opindex mbranch-cost
12024 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12025 This cost is only a heuristic and is not guaranteed to produce
12026 consistent results across releases.
12028 @item -mcmove
12029 @opindex mcmove
12030 Enable the generation of conditional moves.
12032 @item -mnops=@var{num}
12033 @opindex mnops
12034 Emit @var{num} NOPs before every other generated instruction.
12036 @item -mno-soft-cmpsf
12037 @opindex mno-soft-cmpsf
12038 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12039 and test the flags.  This is faster than a software comparison, but can
12040 get incorrect results in the presence of NaNs, or when two different small
12041 numbers are compared such that their difference is calculated as zero.
12042 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12043 software comparisons.
12045 @item -mstack-offset=@var{num}
12046 @opindex mstack-offset
12047 Set the offset between the top of the stack and the stack pointer.
12048 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12049 can be used by leaf functions without stack allocation.
12050 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12051 Note also that this option changes the ABI; compiling a program with a
12052 different stack offset than the libraries have been compiled with
12053 generally does not work.
12054 This option can be useful if you want to evaluate if a different stack
12055 offset would give you better code, but to actually use a different stack
12056 offset to build working programs, it is recommended to configure the
12057 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12059 @item -mno-round-nearest
12060 @opindex mno-round-nearest
12061 Make the scheduler assume that the rounding mode has been set to
12062 truncating.  The default is @option{-mround-nearest}.
12064 @item -mlong-calls
12065 @opindex mlong-calls
12066 If not otherwise specified by an attribute, assume all calls might be beyond
12067 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12068 function address into a register before performing a (otherwise direct) call.
12069 This is the default.
12071 @item -mshort-calls
12072 @opindex short-calls
12073 If not otherwise specified by an attribute, assume all direct calls are
12074 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12075 for direct calls.  The default is @option{-mlong-calls}.
12077 @item -msmall16
12078 @opindex msmall16
12079 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12080 apply to function addresses for which @option{-mlong-calls} semantics
12081 are in effect.
12083 @item -mfp-mode=@var{mode}
12084 @opindex mfp-mode
12085 Set the prevailing mode of the floating-point unit.
12086 This determines the floating-point mode that is provided and expected
12087 at function call and return time.  Making this mode match the mode you
12088 predominantly need at function start can make your programs smaller and
12089 faster by avoiding unnecessary mode switches.
12091 @var{mode} can be set to one the following values:
12093 @table @samp
12094 @item caller
12095 Any mode at function entry is valid, and retained or restored when
12096 the function returns, and when it calls other functions.
12097 This mode is useful for compiling libraries or other compilation units
12098 you might want to incorporate into different programs with different
12099 prevailing FPU modes, and the convenience of being able to use a single
12100 object file outweighs the size and speed overhead for any extra
12101 mode switching that might be needed, compared with what would be needed
12102 with a more specific choice of prevailing FPU mode.
12104 @item truncate
12105 This is the mode used for floating-point calculations with
12106 truncating (i.e.@: round towards zero) rounding mode.  That includes
12107 conversion from floating point to integer.
12109 @item round-nearest
12110 This is the mode used for floating-point calculations with
12111 round-to-nearest-or-even rounding mode.
12113 @item int
12114 This is the mode used to perform integer calculations in the FPU, e.g.@:
12115 integer multiply, or integer multiply-and-accumulate.
12116 @end table
12118 The default is @option{-mfp-mode=caller}
12120 @item -mnosplit-lohi
12121 @itemx -mno-postinc
12122 @itemx -mno-postmodify
12123 @opindex mnosplit-lohi
12124 @opindex mno-postinc
12125 @opindex mno-postmodify
12126 Code generation tweaks that disable, respectively, splitting of 32-bit
12127 loads, generation of post-increment addresses, and generation of
12128 post-modify addresses.  The defaults are @option{msplit-lohi},
12129 @option{-mpost-inc}, and @option{-mpost-modify}.
12131 @item -mnovect-double
12132 @opindex mno-vect-double
12133 Change the preferred SIMD mode to SImode.  The default is
12134 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12136 @item -max-vect-align=@var{num}
12137 @opindex max-vect-align
12138 The maximum alignment for SIMD vector mode types.
12139 @var{num} may be 4 or 8.  The default is 8.
12140 Note that this is an ABI change, even though many library function
12141 interfaces are unaffected if they don't use SIMD vector modes
12142 in places that affect size and/or alignment of relevant types.
12144 @item -msplit-vecmove-early
12145 @opindex msplit-vecmove-early
12146 Split vector moves into single word moves before reload.  In theory this
12147 can give better register allocation, but so far the reverse seems to be
12148 generally the case.
12150 @item -m1reg-@var{reg}
12151 @opindex m1reg-
12152 Specify a register to hold the constant @minus{}1, which makes loading small negative
12153 constants and certain bitmasks faster.
12154 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12155 which specify use of that register as a fixed register,
12156 and @samp{none}, which means that no register is used for this
12157 purpose.  The default is @option{-m1reg-none}.
12159 @end table
12161 @node ARC Options
12162 @subsection ARC Options
12163 @cindex ARC options
12165 The following options control the architecture variant for which code
12166 is being compiled:
12168 @c architecture variants
12169 @table @gcctabopt
12171 @item -mbarrel-shifter
12172 @opindex mbarrel-shifter
12173 Generate instructions supported by barrel shifter.  This is the default
12174 unless @samp{-mcpu=ARC601} is in effect.
12176 @item -mcpu=@var{cpu}
12177 @opindex mcpu
12178 Set architecture type, register usage, and instruction scheduling
12179 parameters for @var{cpu}.  There are also shortcut alias options
12180 available for backward compatibility and convenience.  Supported
12181 values for @var{cpu} are
12183 @table @samp
12184 @opindex mA6
12185 @opindex mARC600
12186 @item ARC600
12187 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12189 @item ARC601
12190 @opindex mARC601
12191 Compile for ARC601.  Alias: @option{-mARC601}.
12193 @item ARC700
12194 @opindex mA7
12195 @opindex mARC700
12196 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12197 This is the default when configured with @samp{--with-cpu=arc700}@.
12198 @end table
12200 @item -mdpfp
12201 @opindex mdpfp
12202 @itemx -mdpfp-compact
12203 @opindex mdpfp-compact
12204 FPX: Generate Double Precision FPX instructions, tuned for the compact
12205 implementation.
12207 @item -mdpfp-fast
12208 @opindex mdpfp-fast
12209 FPX: Generate Double Precision FPX instructions, tuned for the fast
12210 implementation.
12212 @item -mno-dpfp-lrsr
12213 @opindex mno-dpfp-lrsr
12214 Disable LR and SR instructions from using FPX extension aux registers.
12216 @item -mea
12217 @opindex mea
12218 Generate Extended arithmetic instructions.  Currently only
12219 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12220 supported.  This is always enabled for @samp{-mcpu=ARC700}.
12222 @item -mno-mpy
12223 @opindex mno-mpy
12224 Do not generate mpy instructions for ARC700.
12226 @item -mmul32x16
12227 @opindex mmul32x16
12228 Generate 32x16 bit multiply and mac instructions.
12230 @item -mmul64
12231 @opindex mmul64
12232 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
12234 @item -mnorm
12235 @opindex mnorm
12236 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
12237 is in effect.
12239 @item -mspfp
12240 @opindex mspfp
12241 @itemx -mspfp-compact
12242 @opindex mspfp-compact
12243 FPX: Generate Single Precision FPX instructions, tuned for the compact
12244 implementation.
12246 @item -mspfp-fast
12247 @opindex mspfp-fast
12248 FPX: Generate Single Precision FPX instructions, tuned for the fast
12249 implementation.
12251 @item -msimd
12252 @opindex msimd
12253 Enable generation of ARC SIMD instructions via target-specific
12254 builtins.  Only valid for @samp{-mcpu=ARC700}.
12256 @item -msoft-float
12257 @opindex msoft-float
12258 This option ignored; it is provided for compatibility purposes only.
12259 Software floating point code is emitted by default, and this default
12260 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12261 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12262 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12264 @item -mswap
12265 @opindex mswap
12266 Generate swap instructions.
12268 @end table
12270 The following options are passed through to the assembler, and also
12271 define preprocessor macro symbols.
12273 @c Flags used by the assembler, but for which we define preprocessor
12274 @c macro symbols as well.
12275 @table @gcctabopt
12276 @item -mdsp-packa
12277 @opindex mdsp-packa
12278 Passed down to the assembler to enable the DSP Pack A extensions.
12279 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12281 @item -mdvbf
12282 @opindex mdvbf
12283 Passed down to the assembler to enable the dual viterbi butterfly
12284 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12286 @c ARC700 4.10 extension instruction
12287 @item -mlock
12288 @opindex mlock
12289 Passed down to the assembler to enable the Locked Load/Store
12290 Conditional extension.  Also sets the preprocessor symbol
12291 @code{__Xlock}.
12293 @item -mmac-d16
12294 @opindex mmac-d16
12295 Passed down to the assembler.  Also sets the preprocessor symbol
12296 @code{__Xxmac_d16}.
12298 @item -mmac-24
12299 @opindex mmac-24
12300 Passed down to the assembler.  Also sets the preprocessor symbol
12301 @code{__Xxmac_24}.
12303 @c ARC700 4.10 extension instruction
12304 @item -mrtsc
12305 @opindex mrtsc
12306 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12307 extension instruction.  Also sets the preprocessor symbol
12308 @code{__Xrtsc}.
12310 @c ARC700 4.10 extension instruction
12311 @item -mswape
12312 @opindex mswape
12313 Passed down to the assembler to enable the swap byte ordering
12314 extension instruction.  Also sets the preprocessor symbol
12315 @code{__Xswape}.
12317 @item -mtelephony
12318 @opindex mtelephony
12319 Passed down to the assembler to enable dual and single operand
12320 instructions for telephony.  Also sets the preprocessor symbol
12321 @code{__Xtelephony}.
12323 @item -mxy
12324 @opindex mxy
12325 Passed down to the assembler to enable the XY Memory extension.  Also
12326 sets the preprocessor symbol @code{__Xxy}.
12328 @end table
12330 The following options control how the assembly code is annotated:
12332 @c Assembly annotation options
12333 @table @gcctabopt
12334 @item -misize
12335 @opindex misize
12336 Annotate assembler instructions with estimated addresses.
12338 @item -mannotate-align
12339 @opindex mannotate-align
12340 Explain what alignment considerations lead to the decision to make an
12341 instruction short or long.
12343 @end table
12345 The following options are passed through to the linker:
12347 @c options passed through to the linker
12348 @table @gcctabopt
12349 @item -marclinux
12350 @opindex marclinux
12351 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12352 This option is enabled by default in tool chains built for
12353 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12354 when profiling is not requested.
12356 @item -marclinux_prof
12357 @opindex marclinux_prof
12358 Passed through to the linker, to specify use of the
12359 @code{arclinux_prof} emulation.  This option is enabled by default in
12360 tool chains built for @w{@code{arc-linux-uclibc}} and
12361 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12363 @end table
12365 The following options control the semantics of generated code:
12367 @c semantically relevant code generation options
12368 @table @gcctabopt
12369 @item -mepilogue-cfi
12370 @opindex mepilogue-cfi
12371 Enable generation of call frame information for epilogues.
12373 @item -mno-epilogue-cfi
12374 @opindex mno-epilogue-cfi
12375 Disable generation of call frame information for epilogues.
12377 @item -mlong-calls
12378 @opindex mlong-calls
12379 Generate call insns as register indirect calls, thus providing access
12380 to the full 32-bit address range.
12382 @item -mmedium-calls
12383 @opindex mmedium-calls
12384 Don't use less than 25 bit addressing range for calls, which is the
12385 offset available for an unconditional branch-and-link
12386 instruction.  Conditional execution of function calls is suppressed, to
12387 allow use of the 25-bit range, rather than the 21-bit range with
12388 conditional branch-and-link.  This is the default for tool chains built
12389 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12391 @item -mno-sdata
12392 @opindex mno-sdata
12393 Do not generate sdata references.  This is the default for tool chains
12394 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12395 targets.
12397 @item -mucb-mcount
12398 @opindex mucb-mcount
12399 Instrument with mcount calls as used in UCB code.  I.e. do the
12400 counting in the callee, not the caller.  By default ARC instrumentation
12401 counts in the caller.
12403 @item -mvolatile-cache
12404 @opindex mvolatile-cache
12405 Use ordinarily cached memory accesses for volatile references.  This is the
12406 default.
12408 @item -mno-volatile-cache
12409 @opindex mno-volatile-cache
12410 Enable cache bypass for volatile references.
12412 @end table
12414 The following options fine tune code generation:
12415 @c code generation tuning options
12416 @table @gcctabopt
12417 @item -malign-call
12418 @opindex malign-call
12419 Do alignment optimizations for call instructions.
12421 @item -mauto-modify-reg
12422 @opindex mauto-modify-reg
12423 Enable the use of pre/post modify with register displacement.
12425 @item -mbbit-peephole
12426 @opindex mbbit-peephole
12427 Enable bbit peephole2.
12429 @item -mno-brcc
12430 @opindex mno-brcc
12431 This option disables a target-specific pass in @file{arc_reorg} to
12432 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12433 generation driven by the combiner pass.
12435 @item -mcase-vector-pcrel
12436 @opindex mcase-vector-pcrel
12437 Use pc-relative switch case tables - this enables case table shortening.
12438 This is the default for @option{-Os}.
12440 @item -mcompact-casesi
12441 @opindex mcompact-casesi
12442 Enable compact casesi pattern.
12443 This is the default for @option{-Os}.
12445 @item -mno-cond-exec
12446 @opindex mno-cond-exec
12447 Disable ARCompact specific pass to generate conditional execution instructions.
12448 Due to delay slot scheduling and interactions between operand numbers,
12449 literal sizes, instruction lengths, and the support for conditional execution,
12450 the target-independent pass to generate conditional execution is often lacking,
12451 so the ARC port has kept a special pass around that tries to find more
12452 conditional execution generating opportunities after register allocation,
12453 branch shortening, and delay slot scheduling have been done.  This pass
12454 generally, but not always, improves performance and code size, at the cost of
12455 extra compilation time, which is why there is an option to switch it off.
12456 If you have a problem with call instructions exceeding their allowable
12457 offset range because they are conditionalized, you should consider using
12458 @option{-mmedium-calls} instead.
12460 @item -mearly-cbranchsi
12461 @opindex mearly-cbranchsi
12462 Enable pre-reload use of the cbranchsi pattern.
12464 @item -mexpand-adddi
12465 @opindex mexpand-adddi
12466 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12467 @code{add.f}, @code{adc} etc.
12469 @item -mindexed-loads
12470 @opindex mindexed-loads
12471 Enable the use of indexed loads.  This can be problematic because some
12472 optimizers will then assume the that indexed stores exist, which is not
12473 the case.
12475 @item -mlra
12476 @opindex mlra
12477 Enable Local Register Allocation.  This is still experimental for ARC,
12478 so by default the compiler uses standard reload
12479 (i.e. @samp{-mno-lra}).
12481 @item -mlra-priority-none
12482 @opindex mlra-priority-none
12483 Don't indicate any priority for target registers.
12485 @item -mlra-priority-compact
12486 @opindex mlra-priority-compact
12487 Indicate target register priority for r0..r3 / r12..r15.
12489 @item -mlra-priority-noncompact
12490 @opindex mlra-priority-noncompact
12491 Reduce target regsiter priority for r0..r3 / r12..r15.
12493 @item -mno-millicode
12494 @opindex mno-millicode
12495 When optimizing for size (using @option{-Os}), prologues and epilogues
12496 that have to save or restore a large number of registers are often
12497 shortened by using call to a special function in libgcc; this is
12498 referred to as a @emph{millicode} call.  As these calls can pose
12499 performance issues, and/or cause linking issues when linking in a
12500 nonstandard way, this option is provided to turn off millicode call
12501 generation.
12503 @item -mmixed-code
12504 @opindex mmixed-code
12505 Tweak register allocation to help 16-bit instruction generation.
12506 This generally has the effect of decreasing the average instruction size
12507 while increasing the instruction count.
12509 @item -mq-class
12510 @opindex mq-class
12511 Enable 'q' instruction alternatives.
12512 This is the default for @option{-Os}.
12514 @item -mRcq
12515 @opindex mRcq
12516 Enable Rcq constraint handling - most short code generation depends on this.
12517 This is the default.
12519 @item -mRcw
12520 @opindex mRcw
12521 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12522 This is the default.
12524 @item -msize-level=@var{level}
12525 @opindex msize-level
12526 Fine-tune size optimization with regards to instruction lengths and alignment.
12527 The recognized values for @var{level} are:
12528 @table @samp
12529 @item 0
12530 No size optimization.  This level is deprecated and treated like @samp{1}.
12532 @item 1
12533 Short instructions are used opportunistically.
12535 @item 2
12536 In addition, alignment of loops and of code after barriers are dropped.
12538 @item 3
12539 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12541 @end table
12543 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12544 the behavior when this is not set is equivalent to level @samp{1}.
12546 @item -mtune=@var{cpu}
12547 @opindex mtune
12548 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12549 by @option{-mcpu=}.
12551 Supported values for @var{cpu} are
12553 @table @samp
12554 @item ARC600
12555 Tune for ARC600 cpu.
12557 @item ARC601
12558 Tune for ARC601 cpu.
12560 @item ARC700
12561 Tune for ARC700 cpu with standard multiplier block.
12563 @item ARC700-xmac
12564 Tune for ARC700 cpu with XMAC block.
12566 @item ARC725D
12567 Tune for ARC725D cpu.
12569 @item ARC750D
12570 Tune for ARC750D cpu.
12572 @end table
12574 @item -mmultcost=@var{num}
12575 @opindex mmultcost
12576 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12577 normal instruction.
12579 @item -munalign-prob-threshold=@var{probability}
12580 @opindex munalign-prob-threshold
12581 Set probability threshold for unaligning branches.
12582 When tuning for @samp{ARC700} and optimizing for speed, branches without
12583 filled delay slot are preferably emitted unaligned and long, unless
12584 profiling indicates that the probability for the branch to be taken
12585 is below @var{probability}.  @xref{Cross-profiling}.
12586 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12588 @end table
12590 The following options are maintained for backward compatibility, but
12591 are now deprecated and will be removed in a future release:
12593 @c Deprecated options
12594 @table @gcctabopt
12596 @item -margonaut
12597 @opindex margonaut
12598 Obsolete FPX.
12600 @item -mbig-endian
12601 @opindex mbig-endian
12602 @itemx -EB
12603 @opindex EB
12604 Compile code for big endian targets.  Use of these options is now
12605 deprecated.  Users wanting big-endian code, should use the
12606 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12607 building the tool chain, for which big-endian is the default.
12609 @item -mlittle-endian
12610 @opindex mlittle-endian
12611 @itemx -EL
12612 @opindex EL
12613 Compile code for little endian targets.  Use of these options is now
12614 deprecated.  Users wanting little-endian code should use the
12615 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12616 building the tool chain, for which little-endian is the default.
12618 @item -mbarrel_shifter
12619 @opindex mbarrel_shifter
12620 Replaced by @samp{-mbarrel-shifter}
12622 @item -mdpfp_compact
12623 @opindex mdpfp_compact
12624 Replaced by @samp{-mdpfp-compact}
12626 @item -mdpfp_fast
12627 @opindex mdpfp_fast
12628 Replaced by @samp{-mdpfp-fast}
12630 @item -mdsp_packa
12631 @opindex mdsp_packa
12632 Replaced by @samp{-mdsp-packa}
12634 @item -mEA
12635 @opindex mEA
12636 Replaced by @samp{-mea}
12638 @item -mmac_24
12639 @opindex mmac_24
12640 Replaced by @samp{-mmac-24}
12642 @item -mmac_d16
12643 @opindex mmac_d16
12644 Replaced by @samp{-mmac-d16}
12646 @item -mspfp_compact
12647 @opindex mspfp_compact
12648 Replaced by @samp{-mspfp-compact}
12650 @item -mspfp_fast
12651 @opindex mspfp_fast
12652 Replaced by @samp{-mspfp-fast}
12654 @item -mtune=@var{cpu}
12655 @opindex mtune
12656 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12657 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12658 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12660 @item -multcost=@var{num}
12661 @opindex multcost
12662 Replaced by @samp{-mmultcost}.
12664 @end table
12666 @node ARM Options
12667 @subsection ARM Options
12668 @cindex ARM options
12670 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
12671 architectures:
12673 @table @gcctabopt
12674 @item -mabi=@var{name}
12675 @opindex mabi
12676 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12677 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12679 @item -mapcs-frame
12680 @opindex mapcs-frame
12681 Generate a stack frame that is compliant with the ARM Procedure Call
12682 Standard for all functions, even if this is not strictly necessary for
12683 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12684 with this option causes the stack frames not to be generated for
12685 leaf functions.  The default is @option{-mno-apcs-frame}.
12687 @item -mapcs
12688 @opindex mapcs
12689 This is a synonym for @option{-mapcs-frame}.
12691 @ignore
12692 @c not currently implemented
12693 @item -mapcs-stack-check
12694 @opindex mapcs-stack-check
12695 Generate code to check the amount of stack space available upon entry to
12696 every function (that actually uses some stack space).  If there is
12697 insufficient space available then either the function
12698 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12699 called, depending upon the amount of stack space required.  The runtime
12700 system is required to provide these functions.  The default is
12701 @option{-mno-apcs-stack-check}, since this produces smaller code.
12703 @c not currently implemented
12704 @item -mapcs-float
12705 @opindex mapcs-float
12706 Pass floating-point arguments using the floating-point registers.  This is
12707 one of the variants of the APCS@.  This option is recommended if the
12708 target hardware has a floating-point unit or if a lot of floating-point
12709 arithmetic is going to be performed by the code.  The default is
12710 @option{-mno-apcs-float}, since the size of integer-only code is 
12711 slightly increased if @option{-mapcs-float} is used.
12713 @c not currently implemented
12714 @item -mapcs-reentrant
12715 @opindex mapcs-reentrant
12716 Generate reentrant, position-independent code.  The default is
12717 @option{-mno-apcs-reentrant}.
12718 @end ignore
12720 @item -mthumb-interwork
12721 @opindex mthumb-interwork
12722 Generate code that supports calling between the ARM and Thumb
12723 instruction sets.  Without this option, on pre-v5 architectures, the
12724 two instruction sets cannot be reliably used inside one program.  The
12725 default is @option{-mno-thumb-interwork}, since slightly larger code
12726 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12727 configurations this option is meaningless.
12729 @item -mno-sched-prolog
12730 @opindex mno-sched-prolog
12731 Prevent the reordering of instructions in the function prologue, or the
12732 merging of those instruction with the instructions in the function's
12733 body.  This means that all functions start with a recognizable set
12734 of instructions (or in fact one of a choice from a small set of
12735 different function prologues), and this information can be used to
12736 locate the start of functions inside an executable piece of code.  The
12737 default is @option{-msched-prolog}.
12739 @item -mfloat-abi=@var{name}
12740 @opindex mfloat-abi
12741 Specifies which floating-point ABI to use.  Permissible values
12742 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12744 Specifying @samp{soft} causes GCC to generate output containing
12745 library calls for floating-point operations.
12746 @samp{softfp} allows the generation of code using hardware floating-point
12747 instructions, but still uses the soft-float calling conventions.
12748 @samp{hard} allows generation of floating-point instructions
12749 and uses FPU-specific calling conventions.
12751 The default depends on the specific target configuration.  Note that
12752 the hard-float and soft-float ABIs are not link-compatible; you must
12753 compile your entire program with the same ABI, and link with a
12754 compatible set of libraries.
12756 @item -mlittle-endian
12757 @opindex mlittle-endian
12758 Generate code for a processor running in little-endian mode.  This is
12759 the default for all standard configurations.
12761 @item -mbig-endian
12762 @opindex mbig-endian
12763 Generate code for a processor running in big-endian mode; the default is
12764 to compile code for a little-endian processor.
12766 @item -march=@var{name}
12767 @opindex march
12768 This specifies the name of the target ARM architecture.  GCC uses this
12769 name to determine what kind of instructions it can emit when generating
12770 assembly code.  This option can be used in conjunction with or instead
12771 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12772 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12773 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12774 @samp{armv6}, @samp{armv6j},
12775 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12776 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12777 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12778 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12780 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12781 extensions.
12783 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12784 architecture together with the optional CRC32 extensions.
12786 @option{-march=native} causes the compiler to auto-detect the architecture
12787 of the build computer.  At present, this feature is only supported on
12788 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12789 is unsuccessful the option has no effect.
12791 @item -mtune=@var{name}
12792 @opindex mtune
12793 This option specifies the name of the target ARM processor for
12794 which GCC should tune the performance of the code.
12795 For some ARM implementations better performance can be obtained by using
12796 this option.
12797 Permissible names are: @samp{arm2}, @samp{arm250},
12798 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12799 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12800 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12801 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12802 @samp{arm720},
12803 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12804 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12805 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12806 @samp{strongarm1110},
12807 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12808 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12809 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12810 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12811 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12812 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12813 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12814 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12815 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12816 @samp{cortex-r4},
12817 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12818 @samp{cortex-m4},
12819 @samp{cortex-m3},
12820 @samp{cortex-m1},
12821 @samp{cortex-m0},
12822 @samp{cortex-m0plus},
12823 @samp{cortex-m1.small-multiply},
12824 @samp{cortex-m0.small-multiply},
12825 @samp{cortex-m0plus.small-multiply},
12826 @samp{marvell-pj4},
12827 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12828 @samp{fa526}, @samp{fa626},
12829 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12831 Additionally, this option can specify that GCC should tune the performance
12832 of the code for a big.LITTLE system.  Permissible names are:
12833 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12835 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12836 performance for a blend of processors within architecture @var{arch}.
12837 The aim is to generate code that run well on the current most popular
12838 processors, balancing between optimizations that benefit some CPUs in the
12839 range, and avoiding performance pitfalls of other CPUs.  The effects of
12840 this option may change in future GCC versions as CPU models come and go.
12842 @option{-mtune=native} causes the compiler to auto-detect the CPU
12843 of the build computer.  At present, this feature is only supported on
12844 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12845 unsuccessful the option has no effect.
12847 @item -mcpu=@var{name}
12848 @opindex mcpu
12849 This specifies the name of the target ARM processor.  GCC uses this name
12850 to derive the name of the target ARM architecture (as if specified
12851 by @option{-march}) and the ARM processor type for which to tune for
12852 performance (as if specified by @option{-mtune}).  Where this option
12853 is used in conjunction with @option{-march} or @option{-mtune},
12854 those options take precedence over the appropriate part of this option.
12856 Permissible names for this option are the same as those for
12857 @option{-mtune}.
12859 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12860 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12861 See @option{-mtune} for more information.
12863 @option{-mcpu=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
12866 is unsuccessful the option has no effect.
12868 @item -mfpu=@var{name}
12869 @opindex mfpu
12870 This specifies what floating-point hardware (or hardware emulation) is
12871 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12872 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12873 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12874 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12875 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12876 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12878 If @option{-msoft-float} is specified this specifies the format of
12879 floating-point values.
12881 If the selected floating-point hardware includes the NEON extension
12882 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12883 operations are not generated by GCC's auto-vectorization pass unless
12884 @option{-funsafe-math-optimizations} is also specified.  This is
12885 because NEON hardware does not fully implement the IEEE 754 standard for
12886 floating-point arithmetic (in particular denormal values are treated as
12887 zero), so the use of NEON instructions may lead to a loss of precision.
12889 @item -mfp16-format=@var{name}
12890 @opindex mfp16-format
12891 Specify the format of the @code{__fp16} half-precision floating-point type.
12892 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12893 the default is @samp{none}, in which case the @code{__fp16} type is not
12894 defined.  @xref{Half-Precision}, for more information.
12896 @item -mstructure-size-boundary=@var{n}
12897 @opindex mstructure-size-boundary
12898 The sizes of all structures and unions are rounded up to a multiple
12899 of the number of bits set by this option.  Permissible values are 8, 32
12900 and 64.  The default value varies for different toolchains.  For the COFF
12901 targeted toolchain the default value is 8.  A value of 64 is only allowed
12902 if the underlying ABI supports it.
12904 Specifying a larger number can produce faster, more efficient code, but
12905 can also increase the size of the program.  Different values are potentially
12906 incompatible.  Code compiled with one value cannot necessarily expect to
12907 work with code or libraries compiled with another value, if they exchange
12908 information using structures or unions.
12910 @item -mabort-on-noreturn
12911 @opindex mabort-on-noreturn
12912 Generate a call to the function @code{abort} at the end of a
12913 @code{noreturn} function.  It is executed if the function tries to
12914 return.
12916 @item -mlong-calls
12917 @itemx -mno-long-calls
12918 @opindex mlong-calls
12919 @opindex mno-long-calls
12920 Tells the compiler to perform function calls by first loading the
12921 address of the function into a register and then performing a subroutine
12922 call on this register.  This switch is needed if the target function
12923 lies outside of the 64-megabyte addressing range of the offset-based
12924 version of subroutine call instruction.
12926 Even if this switch is enabled, not all function calls are turned
12927 into long calls.  The heuristic is that static functions, functions
12928 that have the @samp{short-call} attribute, functions that are inside
12929 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12930 definitions have already been compiled within the current compilation
12931 unit are not turned into long calls.  The exceptions to this rule are
12932 that weak function definitions, functions with the @samp{long-call}
12933 attribute or the @samp{section} attribute, and functions that are within
12934 the scope of a @samp{#pragma long_calls} directive are always
12935 turned into long calls.
12937 This feature is not enabled by default.  Specifying
12938 @option{-mno-long-calls} restores the default behavior, as does
12939 placing the function calls within the scope of a @samp{#pragma
12940 long_calls_off} directive.  Note these switches have no effect on how
12941 the compiler generates code to handle function calls via function
12942 pointers.
12944 @item -msingle-pic-base
12945 @opindex msingle-pic-base
12946 Treat the register used for PIC addressing as read-only, rather than
12947 loading it in the prologue for each function.  The runtime system is
12948 responsible for initializing this register with an appropriate value
12949 before execution begins.
12951 @item -mpic-register=@var{reg}
12952 @opindex mpic-register
12953 Specify the register to be used for PIC addressing.
12954 For standard PIC base case, the default will be any suitable register
12955 determined by compiler.  For single PIC base case, the default is
12956 @samp{R9} if target is EABI based or stack-checking is enabled,
12957 otherwise the default is @samp{R10}.
12959 @item -mpic-data-is-text-relative
12960 @opindex mpic-data-is-text-relative
12961 Assume that each data segments are relative to text segment at load time.
12962 Therefore, it permits addressing data using PC-relative operations.
12963 This option is on by default for targets other than VxWorks RTP.
12965 @item -mpoke-function-name
12966 @opindex mpoke-function-name
12967 Write the name of each function into the text section, directly
12968 preceding the function prologue.  The generated code is similar to this:
12970 @smallexample
12971      t0
12972          .ascii "arm_poke_function_name", 0
12973          .align
12974      t1
12975          .word 0xff000000 + (t1 - t0)
12976      arm_poke_function_name
12977          mov     ip, sp
12978          stmfd   sp!, @{fp, ip, lr, pc@}
12979          sub     fp, ip, #4
12980 @end smallexample
12982 When performing a stack backtrace, code can inspect the value of
12983 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
12984 location @code{pc - 12} and the top 8 bits are set, then we know that
12985 there is a function name embedded immediately preceding this location
12986 and has length @code{((pc[-3]) & 0xff000000)}.
12988 @item -mthumb
12989 @itemx -marm
12990 @opindex marm
12991 @opindex mthumb
12993 Select between generating code that executes in ARM and Thumb
12994 states.  The default for most configurations is to generate code
12995 that executes in ARM state, but the default can be changed by
12996 configuring GCC with the @option{--with-mode=}@var{state}
12997 configure option.
12999 @item -mtpcs-frame
13000 @opindex mtpcs-frame
13001 Generate a stack frame that is compliant with the Thumb Procedure Call
13002 Standard for all non-leaf functions.  (A leaf function is one that does
13003 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13005 @item -mtpcs-leaf-frame
13006 @opindex mtpcs-leaf-frame
13007 Generate a stack frame that is compliant with the Thumb Procedure Call
13008 Standard for all leaf functions.  (A leaf function is one that does
13009 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13011 @item -mcallee-super-interworking
13012 @opindex mcallee-super-interworking
13013 Gives all externally visible functions in the file being compiled an ARM
13014 instruction set header which switches to Thumb mode before executing the
13015 rest of the function.  This allows these functions to be called from
13016 non-interworking code.  This option is not valid in AAPCS configurations
13017 because interworking is enabled by default.
13019 @item -mcaller-super-interworking
13020 @opindex mcaller-super-interworking
13021 Allows calls via function pointers (including virtual functions) to
13022 execute correctly regardless of whether the target code has been
13023 compiled for interworking or not.  There is a small overhead in the cost
13024 of executing a function pointer if this option is enabled.  This option
13025 is not valid in AAPCS configurations because interworking is enabled
13026 by default.
13028 @item -mtp=@var{name}
13029 @opindex mtp
13030 Specify the access model for the thread local storage pointer.  The valid
13031 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
13032 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
13033 (supported in the arm6k architecture), and @option{auto}, which uses the
13034 best available method for the selected processor.  The default setting is
13035 @option{auto}.
13037 @item -mtls-dialect=@var{dialect}
13038 @opindex mtls-dialect
13039 Specify the dialect to use for accessing thread local storage.  Two
13040 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13041 @samp{gnu} dialect selects the original GNU scheme for supporting
13042 local and global dynamic TLS models.  The @samp{gnu2} dialect
13043 selects the GNU descriptor scheme, which provides better performance
13044 for shared libraries.  The GNU descriptor scheme is compatible with
13045 the original scheme, but does require new assembler, linker and
13046 library support.  Initial and local exec TLS models are unaffected by
13047 this option and always use the original scheme.
13049 @item -mword-relocations
13050 @opindex mword-relocations
13051 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13052 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13053 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13054 is specified.
13056 @item -mfix-cortex-m3-ldrd
13057 @opindex mfix-cortex-m3-ldrd
13058 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13059 with overlapping destination and base registers are used.  This option avoids
13060 generating these instructions.  This option is enabled by default when
13061 @option{-mcpu=cortex-m3} is specified.
13063 @item -munaligned-access
13064 @itemx -mno-unaligned-access
13065 @opindex munaligned-access
13066 @opindex mno-unaligned-access
13067 Enables (or disables) reading and writing of 16- and 32- bit values
13068 from addresses that are not 16- or 32- bit aligned.  By default
13069 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13070 architectures, and enabled for all other architectures.  If unaligned
13071 access is not enabled then words in packed data structures will be
13072 accessed a byte at a time.
13074 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
13075 generated object file to either true or false, depending upon the
13076 setting of this option.  If unaligned access is enabled then the
13077 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
13078 defined.
13080 @item -mneon-for-64bits
13081 @opindex mneon-for-64bits
13082 Enables using Neon to handle scalar 64-bits operations. This is
13083 disabled by default since the cost of moving data from core registers
13084 to Neon is high.
13086 @item -mslow-flash-data
13087 @opindex mslow-flash-data
13088 Assume loading data from flash is slower than fetching instruction.
13089 Therefore literal load is minimized for better performance.
13090 This option is only supported when compiling for ARMv7 M-profile and
13091 off by default.
13093 @item -masm-syntax-unified
13094 @opindex masm-syntax-unified
13095 Assume inline assembler is using unified asm syntax.  The default is
13096 currently off which implies divided syntax.  Currently this option is
13097 available only for Thumb1 and has no effect on ARM state and Thumb2.
13098 However, this may change in future releases of GCC.  Divided syntax
13099 should be considered deprecated.
13101 @item -mrestrict-it
13102 @opindex mrestrict-it
13103 Restricts generation of IT blocks to conform to the rules of ARMv8.
13104 IT blocks can only contain a single 16-bit instruction from a select
13105 set of instructions. This option is on by default for ARMv8 Thumb mode.
13106 @end table
13108 @node AVR Options
13109 @subsection AVR Options
13110 @cindex AVR Options
13112 These options are defined for AVR implementations:
13114 @table @gcctabopt
13115 @item -mmcu=@var{mcu}
13116 @opindex mmcu
13117 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13119 The default for this option is@tie{}@code{avr2}.
13121 GCC supports the following AVR devices and ISAs:
13123 @include avr-mmcu.texi
13125 @item -maccumulate-args
13126 @opindex maccumulate-args
13127 Accumulate outgoing function arguments and acquire/release the needed
13128 stack space for outgoing function arguments once in function
13129 prologue/epilogue.  Without this option, outgoing arguments are pushed
13130 before calling a function and popped afterwards.
13132 Popping the arguments after the function call can be expensive on
13133 AVR so that accumulating the stack space might lead to smaller
13134 executables because arguments need not to be removed from the
13135 stack after such a function call.
13137 This option can lead to reduced code size for functions that perform
13138 several calls to functions that get their arguments on the stack like
13139 calls to printf-like functions.
13141 @item -mbranch-cost=@var{cost}
13142 @opindex mbranch-cost
13143 Set the branch costs for conditional branch instructions to
13144 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13145 integers. The default branch cost is 0.
13147 @item -mcall-prologues
13148 @opindex mcall-prologues
13149 Functions prologues/epilogues are expanded as calls to appropriate
13150 subroutines.  Code size is smaller.
13152 @item -mint8
13153 @opindex mint8
13154 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13155 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13156 and @code{long long} is 4 bytes.  Please note that this option does not
13157 conform to the C standards, but it results in smaller code
13158 size.
13160 @item -mno-interrupts
13161 @opindex mno-interrupts
13162 Generated code is not compatible with hardware interrupts.
13163 Code size is smaller.
13165 @item -mrelax
13166 @opindex mrelax
13167 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13168 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13169 Setting @code{-mrelax} just adds the @code{--relax} option to the
13170 linker command line when the linker is called.
13172 Jump relaxing is performed by the linker because jump offsets are not
13173 known before code is located. Therefore, the assembler code generated by the
13174 compiler is the same, but the instructions in the executable may
13175 differ from instructions in the assembler code.
13177 Relaxing must be turned on if linker stubs are needed, see the
13178 section on @code{EIND} and linker stubs below.
13180 @item -msp8
13181 @opindex msp8
13182 Treat the stack pointer register as an 8-bit register,
13183 i.e.@: assume the high byte of the stack pointer is zero.
13184 In general, you don't need to set this option by hand.
13186 This option is used internally by the compiler to select and
13187 build multilibs for architectures @code{avr2} and @code{avr25}.
13188 These architectures mix devices with and without @code{SPH}.
13189 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
13190 the compiler driver will add or remove this option from the compiler
13191 proper's command line, because the compiler then knows if the device
13192 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13193 register or not.
13195 @item -mstrict-X
13196 @opindex mstrict-X
13197 Use address register @code{X} in a way proposed by the hardware.  This means
13198 that @code{X} is only used in indirect, post-increment or
13199 pre-decrement addressing.
13201 Without this option, the @code{X} register may be used in the same way
13202 as @code{Y} or @code{Z} which then is emulated by additional
13203 instructions.  
13204 For example, loading a value with @code{X+const} addressing with a
13205 small non-negative @code{const < 64} to a register @var{Rn} is
13206 performed as
13208 @example
13209 adiw r26, const   ; X += const
13210 ld   @var{Rn}, X        ; @var{Rn} = *X
13211 sbiw r26, const   ; X -= const
13212 @end example
13214 @item -mtiny-stack
13215 @opindex mtiny-stack
13216 Only change the lower 8@tie{}bits of the stack pointer.
13218 @item -Waddr-space-convert
13219 @opindex Waddr-space-convert
13220 Warn about conversions between address spaces in the case where the
13221 resulting address space is not contained in the incoming address space.
13222 @end table
13224 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
13225 @cindex @code{EIND}
13226 Pointers in the implementation are 16@tie{}bits wide.
13227 The address of a function or label is represented as word address so
13228 that indirect jumps and calls can target any code address in the
13229 range of 64@tie{}Ki words.
13231 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13232 bytes of program memory space, there is a special function register called
13233 @code{EIND} that serves as most significant part of the target address
13234 when @code{EICALL} or @code{EIJMP} instructions are used.
13236 Indirect jumps and calls on these devices are handled as follows by
13237 the compiler and are subject to some limitations:
13239 @itemize @bullet
13241 @item
13242 The compiler never sets @code{EIND}.
13244 @item
13245 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13246 instructions or might read @code{EIND} directly in order to emulate an
13247 indirect call/jump by means of a @code{RET} instruction.
13249 @item
13250 The compiler assumes that @code{EIND} never changes during the startup
13251 code or during the application. In particular, @code{EIND} is not
13252 saved/restored in function or interrupt service routine
13253 prologue/epilogue.
13255 @item
13256 For indirect calls to functions and computed goto, the linker
13257 generates @emph{stubs}. Stubs are jump pads sometimes also called
13258 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13259 The stub contains a direct jump to the desired address.
13261 @item
13262 Linker relaxation must be turned on so that the linker will generate
13263 the stubs correctly an all situaltion. See the compiler option
13264 @code{-mrelax} and the linler option @code{--relax}.
13265 There are corner cases where the linker is supposed to generate stubs
13266 but aborts without relaxation and without a helpful error message.
13268 @item
13269 The default linker script is arranged for code with @code{EIND = 0}.
13270 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13271 linker script has to be used in order to place the sections whose
13272 name start with @code{.trampolines} into the segment where @code{EIND}
13273 points to.
13275 @item
13276 The startup code from libgcc never sets @code{EIND}.
13277 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13278 For the impact of AVR-LibC on @code{EIND}, see the
13279 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13281 @item
13282 It is legitimate for user-specific startup code to set up @code{EIND}
13283 early, for example by means of initialization code located in
13284 section @code{.init3}. Such code runs prior to general startup code
13285 that initializes RAM and calls constructors, but after the bit
13286 of startup code from AVR-LibC that sets @code{EIND} to the segment
13287 where the vector table is located.
13288 @example
13289 #include <avr/io.h>
13291 static void
13292 __attribute__((section(".init3"),naked,used,no_instrument_function))
13293 init3_set_eind (void)
13295   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13296                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13298 @end example
13300 @noindent
13301 The @code{__trampolines_start} symbol is defined in the linker script.
13303 @item
13304 Stubs are generated automatically by the linker if
13305 the following two conditions are met:
13306 @itemize @minus
13308 @item The address of a label is taken by means of the @code{gs} modifier
13309 (short for @emph{generate stubs}) like so:
13310 @example
13311 LDI r24, lo8(gs(@var{func}))
13312 LDI r25, hi8(gs(@var{func}))
13313 @end example
13314 @item The final location of that label is in a code segment
13315 @emph{outside} the segment where the stubs are located.
13316 @end itemize
13318 @item
13319 The compiler emits such @code{gs} modifiers for code labels in the
13320 following situations:
13321 @itemize @minus
13322 @item Taking address of a function or code label.
13323 @item Computed goto.
13324 @item If prologue-save function is used, see @option{-mcall-prologues}
13325 command-line option.
13326 @item Switch/case dispatch tables. If you do not want such dispatch
13327 tables you can specify the @option{-fno-jump-tables} command-line option.
13328 @item C and C++ constructors/destructors called during startup/shutdown.
13329 @item If the tools hit a @code{gs()} modifier explained above.
13330 @end itemize
13332 @item
13333 Jumping to non-symbolic addresses like so is @emph{not} supported:
13335 @example
13336 int main (void)
13338     /* Call function at word address 0x2 */
13339     return ((int(*)(void)) 0x2)();
13341 @end example
13343 Instead, a stub has to be set up, i.e.@: the function has to be called
13344 through a symbol (@code{func_4} in the example):
13346 @example
13347 int main (void)
13349     extern int func_4 (void);
13351     /* Call function at byte address 0x4 */
13352     return func_4();
13354 @end example
13356 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
13357 Alternatively, @code{func_4} can be defined in the linker script.
13358 @end itemize
13360 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13361 @cindex @code{RAMPD}
13362 @cindex @code{RAMPX}
13363 @cindex @code{RAMPY}
13364 @cindex @code{RAMPZ}
13365 Some AVR devices support memories larger than the 64@tie{}KiB range
13366 that can be accessed with 16-bit pointers.  To access memory locations
13367 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13368 register is used as high part of the address:
13369 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13370 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13371 register, respectively, to get a wide address. Similarly,
13372 @code{RAMPD} is used together with direct addressing.
13374 @itemize
13375 @item
13376 The startup code initializes the @code{RAMP} special function
13377 registers with zero.
13379 @item
13380 If a @ref{AVR Named Address Spaces,named address space} other than
13381 generic or @code{__flash} is used, then @code{RAMPZ} is set
13382 as needed before the operation.
13384 @item
13385 If the device supports RAM larger than 64@tie{}KiB and the compiler
13386 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13387 is reset to zero after the operation.
13389 @item
13390 If the device comes with a specific @code{RAMP} register, the ISR
13391 prologue/epilogue saves/restores that SFR and initializes it with
13392 zero in case the ISR code might (implicitly) use it.
13394 @item
13395 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13396 If you use inline assembler to read from locations outside the
13397 16-bit address range and change one of the @code{RAMP} registers,
13398 you must reset it to zero after the access.
13400 @end itemize
13402 @subsubsection AVR Built-in Macros
13404 GCC defines several built-in macros so that the user code can test
13405 for the presence or absence of features.  Almost any of the following
13406 built-in macros are deduced from device capabilities and thus
13407 triggered by the @code{-mmcu=} command-line option.
13409 For even more AVR-specific built-in macros see
13410 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13412 @table @code
13414 @item __AVR_ARCH__
13415 Build-in macro that resolves to a decimal number that identifies the
13416 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13417 Possible values are:
13419 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13420 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13421 @code{105}, @code{106}, @code{107}
13423 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13424 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13425 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13426 @code{avrxmega6}, @code{avrxmega7}, respectively.
13427 If @var{mcu} specifies a device, this built-in macro is set
13428 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13429 defined to @code{4}.
13431 @item __AVR_@var{Device}__
13432 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13433 the device's name. For example, @code{-mmcu=atmega8} defines the
13434 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13435 @code{__AVR_ATtiny261A__}, etc.
13437 The built-in macros' names follow
13438 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13439 the device name as from the AVR user manual. The difference between
13440 @var{Device} in the built-in macro and @var{device} in
13441 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13443 If @var{device} is not a device but only a core architecture like
13444 @code{avr51}, this macro will not be defined.
13446 @item   __AVR_DEVICE_NAME__
13447 Setting @code{-mmcu=@var{device}} defines this built-in macro to
13448 the device's name. For example, with @code{-mmcu=atmega8} the macro
13449 will be defined to @code{atmega8}.
13451 If @var{device} is not a device but only a core architecture like
13452 @code{avr51}, this macro will not be defined.
13454 @item __AVR_XMEGA__
13455 The device / architecture belongs to the XMEGA family of devices.
13457 @item __AVR_HAVE_ELPM__
13458 The device has the the @code{ELPM} instruction.
13460 @item __AVR_HAVE_ELPMX__
13461 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13462 R@var{n},Z+} instructions.
13464 @item __AVR_HAVE_MOVW__
13465 The device has the @code{MOVW} instruction to perform 16-bit
13466 register-register moves.
13468 @item __AVR_HAVE_LPMX__
13469 The device has the @code{LPM R@var{n},Z} and
13470 @code{LPM R@var{n},Z+} instructions.
13472 @item __AVR_HAVE_MUL__
13473 The device has a hardware multiplier. 
13475 @item __AVR_HAVE_JMP_CALL__
13476 The device has the @code{JMP} and @code{CALL} instructions.
13477 This is the case for devices with at least 16@tie{}KiB of program
13478 memory.
13480 @item __AVR_HAVE_EIJMP_EICALL__
13481 @itemx __AVR_3_BYTE_PC__
13482 The device has the @code{EIJMP} and @code{EICALL} instructions.
13483 This is the case for devices with more than 128@tie{}KiB of program memory.
13484 This also means that the program counter
13485 (PC) is 3@tie{}bytes wide.
13487 @item __AVR_2_BYTE_PC__
13488 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13489 with up to 128@tie{}KiB of program memory.
13491 @item __AVR_HAVE_8BIT_SP__
13492 @itemx __AVR_HAVE_16BIT_SP__
13493 The stack pointer (SP) register is treated as 8-bit respectively
13494 16-bit register by the compiler.
13495 The definition of these macros is affected by @code{-mtiny-stack}.
13497 @item __AVR_HAVE_SPH__
13498 @itemx __AVR_SP8__
13499 The device has the SPH (high part of stack pointer) special function
13500 register or has an 8-bit stack pointer, respectively.
13501 The definition of these macros is affected by @code{-mmcu=} and
13502 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13503 by @code{-msp8}.
13505 @item __AVR_HAVE_RAMPD__
13506 @itemx __AVR_HAVE_RAMPX__
13507 @itemx __AVR_HAVE_RAMPY__
13508 @itemx __AVR_HAVE_RAMPZ__
13509 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13510 @code{RAMPZ} special function register, respectively.
13512 @item __NO_INTERRUPTS__
13513 This macro reflects the @code{-mno-interrupts} command line option.
13515 @item __AVR_ERRATA_SKIP__
13516 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13517 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13518 instructions because of a hardware erratum.  Skip instructions are
13519 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13520 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13521 set.
13523 @item __AVR_ISA_RMW__
13524 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13526 @item __AVR_SFR_OFFSET__=@var{offset}
13527 Instructions that can address I/O special function registers directly
13528 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13529 address as if addressed by an instruction to access RAM like @code{LD}
13530 or @code{STS}. This offset depends on the device architecture and has
13531 to be subtracted from the RAM address in order to get the
13532 respective I/O@tie{}address.
13534 @item __WITH_AVRLIBC__
13535 The compiler is configured to be used together with AVR-Libc.
13536 See the @code{--with-avrlibc} configure option.
13538 @end table
13540 @node Blackfin Options
13541 @subsection Blackfin Options
13542 @cindex Blackfin Options
13544 @table @gcctabopt
13545 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13546 @opindex mcpu=
13547 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13548 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13549 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13550 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13551 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13552 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13553 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13554 @samp{bf561}, @samp{bf592}.
13556 The optional @var{sirevision} specifies the silicon revision of the target
13557 Blackfin processor.  Any workarounds available for the targeted silicon revision
13558 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13559 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13560 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13561 hexadecimal digits representing the major and minor numbers in the silicon
13562 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13563 is not defined.  If @var{sirevision} is @samp{any}, the
13564 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13565 If this optional @var{sirevision} is not used, GCC assumes the latest known
13566 silicon revision of the targeted Blackfin processor.
13568 GCC defines a preprocessor macro for the specified @var{cpu}.
13569 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13570 provided by libgloss to be linked in if @option{-msim} is not given.
13572 Without this option, @samp{bf532} is used as the processor by default.
13574 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13575 only the preprocessor macro is defined.
13577 @item -msim
13578 @opindex msim
13579 Specifies that the program will be run on the simulator.  This causes
13580 the simulator BSP provided by libgloss to be linked in.  This option
13581 has effect only for @samp{bfin-elf} toolchain.
13582 Certain other options, such as @option{-mid-shared-library} and
13583 @option{-mfdpic}, imply @option{-msim}.
13585 @item -momit-leaf-frame-pointer
13586 @opindex momit-leaf-frame-pointer
13587 Don't keep the frame pointer in a register for leaf functions.  This
13588 avoids the instructions to save, set up and restore frame pointers and
13589 makes an extra register available in leaf functions.  The option
13590 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13591 which might make debugging harder.
13593 @item -mspecld-anomaly
13594 @opindex mspecld-anomaly
13595 When enabled, the compiler ensures that the generated code does not
13596 contain speculative loads after jump instructions. If this option is used,
13597 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13599 @item -mno-specld-anomaly
13600 @opindex mno-specld-anomaly
13601 Don't generate extra code to prevent speculative loads from occurring.
13603 @item -mcsync-anomaly
13604 @opindex mcsync-anomaly
13605 When enabled, the compiler ensures that the generated code does not
13606 contain CSYNC or SSYNC instructions too soon after conditional branches.
13607 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13609 @item -mno-csync-anomaly
13610 @opindex mno-csync-anomaly
13611 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13612 occurring too soon after a conditional branch.
13614 @item -mlow-64k
13615 @opindex mlow-64k
13616 When enabled, the compiler is free to take advantage of the knowledge that
13617 the entire program fits into the low 64k of memory.
13619 @item -mno-low-64k
13620 @opindex mno-low-64k
13621 Assume that the program is arbitrarily large.  This is the default.
13623 @item -mstack-check-l1
13624 @opindex mstack-check-l1
13625 Do stack checking using information placed into L1 scratchpad memory by the
13626 uClinux kernel.
13628 @item -mid-shared-library
13629 @opindex mid-shared-library
13630 Generate code that supports shared libraries via the library ID method.
13631 This allows for execute in place and shared libraries in an environment
13632 without virtual memory management.  This option implies @option{-fPIC}.
13633 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13635 @item -mno-id-shared-library
13636 @opindex mno-id-shared-library
13637 Generate code that doesn't assume ID-based shared libraries are being used.
13638 This is the default.
13640 @item -mleaf-id-shared-library
13641 @opindex mleaf-id-shared-library
13642 Generate code that supports shared libraries via the library ID method,
13643 but assumes that this library or executable won't link against any other
13644 ID shared libraries.  That allows the compiler to use faster code for jumps
13645 and calls.
13647 @item -mno-leaf-id-shared-library
13648 @opindex mno-leaf-id-shared-library
13649 Do not assume that the code being compiled won't link against any ID shared
13650 libraries.  Slower code is generated for jump and call insns.
13652 @item -mshared-library-id=n
13653 @opindex mshared-library-id
13654 Specifies the identification number of the ID-based shared library being
13655 compiled.  Specifying a value of 0 generates more compact code; specifying
13656 other values forces the allocation of that number to the current
13657 library but is no more space- or time-efficient than omitting this option.
13659 @item -msep-data
13660 @opindex msep-data
13661 Generate code that allows the data segment to be located in a different
13662 area of memory from the text segment.  This allows for execute in place in
13663 an environment without virtual memory management by eliminating relocations
13664 against the text section.
13666 @item -mno-sep-data
13667 @opindex mno-sep-data
13668 Generate code that assumes that the data segment follows the text segment.
13669 This is the default.
13671 @item -mlong-calls
13672 @itemx -mno-long-calls
13673 @opindex mlong-calls
13674 @opindex mno-long-calls
13675 Tells the compiler to perform function calls by first loading the
13676 address of the function into a register and then performing a subroutine
13677 call on this register.  This switch is needed if the target function
13678 lies outside of the 24-bit addressing range of the offset-based
13679 version of subroutine call instruction.
13681 This feature is not enabled by default.  Specifying
13682 @option{-mno-long-calls} restores the default behavior.  Note these
13683 switches have no effect on how the compiler generates code to handle
13684 function calls via function pointers.
13686 @item -mfast-fp
13687 @opindex mfast-fp
13688 Link with the fast floating-point library. This library relaxes some of
13689 the IEEE floating-point standard's rules for checking inputs against
13690 Not-a-Number (NAN), in the interest of performance.
13692 @item -minline-plt
13693 @opindex minline-plt
13694 Enable inlining of PLT entries in function calls to functions that are
13695 not known to bind locally.  It has no effect without @option{-mfdpic}.
13697 @item -mmulticore
13698 @opindex mmulticore
13699 Build a standalone application for multicore Blackfin processors. 
13700 This option causes proper start files and link scripts supporting 
13701 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13702 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13704 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13705 selects the one-application-per-core programming model.  Without
13706 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13707 programming model is used. In this model, the main function of Core B
13708 should be named as @code{coreb_main}.
13710 If this option is not used, the single-core application programming
13711 model is used.
13713 @item -mcorea
13714 @opindex mcorea
13715 Build a standalone application for Core A of BF561 when using
13716 the one-application-per-core programming model. Proper start files
13717 and link scripts are used to support Core A, and the macro
13718 @code{__BFIN_COREA} is defined.
13719 This option can only be used in conjunction with @option{-mmulticore}.
13721 @item -mcoreb
13722 @opindex mcoreb
13723 Build a standalone application for Core B of BF561 when using
13724 the one-application-per-core programming model. Proper start files
13725 and link scripts are used to support Core B, and the macro
13726 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13727 should be used instead of @code{main}. 
13728 This option can only be used in conjunction with @option{-mmulticore}.
13730 @item -msdram
13731 @opindex msdram
13732 Build a standalone application for SDRAM. Proper start files and
13733 link scripts are used to put the application into SDRAM, and the macro
13734 @code{__BFIN_SDRAM} is defined.
13735 The loader should initialize SDRAM before loading the application.
13737 @item -micplb
13738 @opindex micplb
13739 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13740 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13741 are enabled; for standalone applications the default is off.
13742 @end table
13744 @node C6X Options
13745 @subsection C6X Options
13746 @cindex C6X Options
13748 @table @gcctabopt
13749 @item -march=@var{name}
13750 @opindex march
13751 This specifies the name of the target architecture.  GCC uses this
13752 name to determine what kind of instructions it can emit when generating
13753 assembly code.  Permissible names are: @samp{c62x},
13754 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13756 @item -mbig-endian
13757 @opindex mbig-endian
13758 Generate code for a big-endian target.
13760 @item -mlittle-endian
13761 @opindex mlittle-endian
13762 Generate code for a little-endian target.  This is the default.
13764 @item -msim
13765 @opindex msim
13766 Choose startup files and linker script suitable for the simulator.
13768 @item -msdata=default
13769 @opindex msdata=default
13770 Put small global and static data in the @samp{.neardata} section,
13771 which is pointed to by register @code{B14}.  Put small uninitialized
13772 global and static data in the @samp{.bss} section, which is adjacent
13773 to the @samp{.neardata} section.  Put small read-only data into the
13774 @samp{.rodata} section.  The corresponding sections used for large
13775 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13777 @item -msdata=all
13778 @opindex msdata=all
13779 Put all data, not just small objects, into the sections reserved for
13780 small data, and use addressing relative to the @code{B14} register to
13781 access them.
13783 @item -msdata=none
13784 @opindex msdata=none
13785 Make no use of the sections reserved for small data, and use absolute
13786 addresses to access all data.  Put all initialized global and static
13787 data in the @samp{.fardata} section, and all uninitialized data in the
13788 @samp{.far} section.  Put all constant data into the @samp{.const}
13789 section.
13790 @end table
13792 @node CRIS Options
13793 @subsection CRIS Options
13794 @cindex CRIS Options
13796 These options are defined specifically for the CRIS ports.
13798 @table @gcctabopt
13799 @item -march=@var{architecture-type}
13800 @itemx -mcpu=@var{architecture-type}
13801 @opindex march
13802 @opindex mcpu
13803 Generate code for the specified architecture.  The choices for
13804 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13805 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13806 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13807 @samp{v10}.
13809 @item -mtune=@var{architecture-type}
13810 @opindex mtune
13811 Tune to @var{architecture-type} everything applicable about the generated
13812 code, except for the ABI and the set of available instructions.  The
13813 choices for @var{architecture-type} are the same as for
13814 @option{-march=@var{architecture-type}}.
13816 @item -mmax-stack-frame=@var{n}
13817 @opindex mmax-stack-frame
13818 Warn when the stack frame of a function exceeds @var{n} bytes.
13820 @item -metrax4
13821 @itemx -metrax100
13822 @opindex metrax4
13823 @opindex metrax100
13824 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13825 @option{-march=v3} and @option{-march=v8} respectively.
13827 @item -mmul-bug-workaround
13828 @itemx -mno-mul-bug-workaround
13829 @opindex mmul-bug-workaround
13830 @opindex mno-mul-bug-workaround
13831 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13832 models where it applies.  This option is active by default.
13834 @item -mpdebug
13835 @opindex mpdebug
13836 Enable CRIS-specific verbose debug-related information in the assembly
13837 code.  This option also has the effect of turning off the @samp{#NO_APP}
13838 formatted-code indicator to the assembler at the beginning of the
13839 assembly file.
13841 @item -mcc-init
13842 @opindex mcc-init
13843 Do not use condition-code results from previous instruction; always emit
13844 compare and test instructions before use of condition codes.
13846 @item -mno-side-effects
13847 @opindex mno-side-effects
13848 Do not emit instructions with side effects in addressing modes other than
13849 post-increment.
13851 @item -mstack-align
13852 @itemx -mno-stack-align
13853 @itemx -mdata-align
13854 @itemx -mno-data-align
13855 @itemx -mconst-align
13856 @itemx -mno-const-align
13857 @opindex mstack-align
13858 @opindex mno-stack-align
13859 @opindex mdata-align
13860 @opindex mno-data-align
13861 @opindex mconst-align
13862 @opindex mno-const-align
13863 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13864 stack frame, individual data and constants to be aligned for the maximum
13865 single data access size for the chosen CPU model.  The default is to
13866 arrange for 32-bit alignment.  ABI details such as structure layout are
13867 not affected by these options.
13869 @item -m32-bit
13870 @itemx -m16-bit
13871 @itemx -m8-bit
13872 @opindex m32-bit
13873 @opindex m16-bit
13874 @opindex m8-bit
13875 Similar to the stack- data- and const-align options above, these options
13876 arrange for stack frame, writable data and constants to all be 32-bit,
13877 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13879 @item -mno-prologue-epilogue
13880 @itemx -mprologue-epilogue
13881 @opindex mno-prologue-epilogue
13882 @opindex mprologue-epilogue
13883 With @option{-mno-prologue-epilogue}, the normal function prologue and
13884 epilogue which set up the stack frame are omitted and no return
13885 instructions or return sequences are generated in the code.  Use this
13886 option only together with visual inspection of the compiled code: no
13887 warnings or errors are generated when call-saved registers must be saved,
13888 or storage for local variables needs to be allocated.
13890 @item -mno-gotplt
13891 @itemx -mgotplt
13892 @opindex mno-gotplt
13893 @opindex mgotplt
13894 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13895 instruction sequences that load addresses for functions from the PLT part
13896 of the GOT rather than (traditional on other architectures) calls to the
13897 PLT@.  The default is @option{-mgotplt}.
13899 @item -melf
13900 @opindex melf
13901 Legacy no-op option only recognized with the cris-axis-elf and
13902 cris-axis-linux-gnu targets.
13904 @item -mlinux
13905 @opindex mlinux
13906 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13908 @item -sim
13909 @opindex sim
13910 This option, recognized for the cris-axis-elf, arranges
13911 to link with input-output functions from a simulator library.  Code,
13912 initialized data and zero-initialized data are allocated consecutively.
13914 @item -sim2
13915 @opindex sim2
13916 Like @option{-sim}, but pass linker options to locate initialized data at
13917 0x40000000 and zero-initialized data at 0x80000000.
13918 @end table
13920 @node CR16 Options
13921 @subsection CR16 Options
13922 @cindex CR16 Options
13924 These options are defined specifically for the CR16 ports.
13926 @table @gcctabopt
13928 @item -mmac
13929 @opindex mmac
13930 Enable the use of multiply-accumulate instructions. Disabled by default.
13932 @item -mcr16cplus
13933 @itemx -mcr16c
13934 @opindex mcr16cplus
13935 @opindex mcr16c
13936 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13937 is default.
13939 @item -msim
13940 @opindex msim
13941 Links the library libsim.a which is in compatible with simulator. Applicable
13942 to ELF compiler only.
13944 @item -mint32
13945 @opindex mint32
13946 Choose integer type as 32-bit wide.
13948 @item -mbit-ops
13949 @opindex mbit-ops
13950 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13952 @item -mdata-model=@var{model}
13953 @opindex mdata-model
13954 Choose a data model. The choices for @var{model} are @samp{near},
13955 @samp{far} or @samp{medium}. @samp{medium} is default.
13956 However, @samp{far} is not valid with @option{-mcr16c}, as the
13957 CR16C architecture does not support the far data model.
13958 @end table
13960 @node Darwin Options
13961 @subsection Darwin Options
13962 @cindex Darwin options
13964 These options are defined for all architectures running the Darwin operating
13965 system.
13967 FSF GCC on Darwin does not create ``fat'' object files; it creates
13968 an object file for the single architecture that GCC was built to
13969 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13970 @option{-arch} options are used; it does so by running the compiler or
13971 linker multiple times and joining the results together with
13972 @file{lipo}.
13974 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13975 @samp{i686}) is determined by the flags that specify the ISA
13976 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13977 @option{-force_cpusubtype_ALL} option can be used to override this.
13979 The Darwin tools vary in their behavior when presented with an ISA
13980 mismatch.  The assembler, @file{as}, only permits instructions to
13981 be used that are valid for the subtype of the file it is generating,
13982 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
13983 The linker for shared libraries, @file{/usr/bin/libtool}, fails
13984 and prints an error if asked to create a shared library with a less
13985 restrictive subtype than its input files (for instance, trying to put
13986 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
13987 for executables, @command{ld}, quietly gives the executable the most
13988 restrictive subtype of any of its input files.
13990 @table @gcctabopt
13991 @item -F@var{dir}
13992 @opindex F
13993 Add the framework directory @var{dir} to the head of the list of
13994 directories to be searched for header files.  These directories are
13995 interleaved with those specified by @option{-I} options and are
13996 scanned in a left-to-right order.
13998 A framework directory is a directory with frameworks in it.  A
13999 framework is a directory with a @file{Headers} and/or
14000 @file{PrivateHeaders} directory contained directly in it that ends
14001 in @file{.framework}.  The name of a framework is the name of this
14002 directory excluding the @file{.framework}.  Headers associated with
14003 the framework are found in one of those two directories, with
14004 @file{Headers} being searched first.  A subframework is a framework
14005 directory that is in a framework's @file{Frameworks} directory.
14006 Includes of subframework headers can only appear in a header of a
14007 framework that contains the subframework, or in a sibling subframework
14008 header.  Two subframeworks are siblings if they occur in the same
14009 framework.  A subframework should not have the same name as a
14010 framework; a warning is issued if this is violated.  Currently a
14011 subframework cannot have subframeworks; in the future, the mechanism
14012 may be extended to support this.  The standard frameworks can be found
14013 in @file{/System/Library/Frameworks} and
14014 @file{/Library/Frameworks}.  An example include looks like
14015 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14016 the name of the framework and @file{header.h} is found in the
14017 @file{PrivateHeaders} or @file{Headers} directory.
14019 @item -iframework@var{dir}
14020 @opindex iframework
14021 Like @option{-F} except the directory is a treated as a system
14022 directory.  The main difference between this @option{-iframework} and
14023 @option{-F} is that with @option{-iframework} the compiler does not
14024 warn about constructs contained within header files found via
14025 @var{dir}.  This option is valid only for the C family of languages.
14027 @item -gused
14028 @opindex gused
14029 Emit debugging information for symbols that are used.  For stabs
14030 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14031 This is by default ON@.
14033 @item -gfull
14034 @opindex gfull
14035 Emit debugging information for all symbols and types.
14037 @item -mmacosx-version-min=@var{version}
14038 The earliest version of MacOS X that this executable will run on
14039 is @var{version}.  Typical values of @var{version} include @code{10.1},
14040 @code{10.2}, and @code{10.3.9}.
14042 If the compiler was built to use the system's headers by default,
14043 then the default for this option is the system version on which the
14044 compiler is running, otherwise the default is to make choices that
14045 are compatible with as many systems and code bases as possible.
14047 @item -mkernel
14048 @opindex mkernel
14049 Enable kernel development mode.  The @option{-mkernel} option sets
14050 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14051 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14052 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14053 applicable.  This mode also sets @option{-mno-altivec},
14054 @option{-msoft-float}, @option{-fno-builtin} and
14055 @option{-mlong-branch} for PowerPC targets.
14057 @item -mone-byte-bool
14058 @opindex mone-byte-bool
14059 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
14060 By default @samp{sizeof(bool)} is @samp{4} when compiling for
14061 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
14062 option has no effect on x86.
14064 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14065 to generate code that is not binary compatible with code generated
14066 without that switch.  Using this switch may require recompiling all
14067 other modules in a program, including system libraries.  Use this
14068 switch to conform to a non-default data model.
14070 @item -mfix-and-continue
14071 @itemx -ffix-and-continue
14072 @itemx -findirect-data
14073 @opindex mfix-and-continue
14074 @opindex ffix-and-continue
14075 @opindex findirect-data
14076 Generate code suitable for fast turnaround development, such as to
14077 allow GDB to dynamically load @code{.o} files into already-running
14078 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14079 are provided for backwards compatibility.
14081 @item -all_load
14082 @opindex all_load
14083 Loads all members of static archive libraries.
14084 See man ld(1) for more information.
14086 @item -arch_errors_fatal
14087 @opindex arch_errors_fatal
14088 Cause the errors having to do with files that have the wrong architecture
14089 to be fatal.
14091 @item -bind_at_load
14092 @opindex bind_at_load
14093 Causes the output file to be marked such that the dynamic linker will
14094 bind all undefined references when the file is loaded or launched.
14096 @item -bundle
14097 @opindex bundle
14098 Produce a Mach-o bundle format file.
14099 See man ld(1) for more information.
14101 @item -bundle_loader @var{executable}
14102 @opindex bundle_loader
14103 This option specifies the @var{executable} that will load the build
14104 output file being linked.  See man ld(1) for more information.
14106 @item -dynamiclib
14107 @opindex dynamiclib
14108 When passed this option, GCC produces a dynamic library instead of
14109 an executable when linking, using the Darwin @file{libtool} command.
14111 @item -force_cpusubtype_ALL
14112 @opindex force_cpusubtype_ALL
14113 This causes GCC's output file to have the @var{ALL} subtype, instead of
14114 one controlled by the @option{-mcpu} or @option{-march} option.
14116 @item -allowable_client  @var{client_name}
14117 @itemx -client_name
14118 @itemx -compatibility_version
14119 @itemx -current_version
14120 @itemx -dead_strip
14121 @itemx -dependency-file
14122 @itemx -dylib_file
14123 @itemx -dylinker_install_name
14124 @itemx -dynamic
14125 @itemx -exported_symbols_list
14126 @itemx -filelist
14127 @need 800
14128 @itemx -flat_namespace
14129 @itemx -force_flat_namespace
14130 @itemx -headerpad_max_install_names
14131 @itemx -image_base
14132 @itemx -init
14133 @itemx -install_name
14134 @itemx -keep_private_externs
14135 @itemx -multi_module
14136 @itemx -multiply_defined
14137 @itemx -multiply_defined_unused
14138 @need 800
14139 @itemx -noall_load
14140 @itemx -no_dead_strip_inits_and_terms
14141 @itemx -nofixprebinding
14142 @itemx -nomultidefs
14143 @itemx -noprebind
14144 @itemx -noseglinkedit
14145 @itemx -pagezero_size
14146 @itemx -prebind
14147 @itemx -prebind_all_twolevel_modules
14148 @itemx -private_bundle
14149 @need 800
14150 @itemx -read_only_relocs
14151 @itemx -sectalign
14152 @itemx -sectobjectsymbols
14153 @itemx -whyload
14154 @itemx -seg1addr
14155 @itemx -sectcreate
14156 @itemx -sectobjectsymbols
14157 @itemx -sectorder
14158 @itemx -segaddr
14159 @itemx -segs_read_only_addr
14160 @need 800
14161 @itemx -segs_read_write_addr
14162 @itemx -seg_addr_table
14163 @itemx -seg_addr_table_filename
14164 @itemx -seglinkedit
14165 @itemx -segprot
14166 @itemx -segs_read_only_addr
14167 @itemx -segs_read_write_addr
14168 @itemx -single_module
14169 @itemx -static
14170 @itemx -sub_library
14171 @need 800
14172 @itemx -sub_umbrella
14173 @itemx -twolevel_namespace
14174 @itemx -umbrella
14175 @itemx -undefined
14176 @itemx -unexported_symbols_list
14177 @itemx -weak_reference_mismatches
14178 @itemx -whatsloaded
14179 @opindex allowable_client
14180 @opindex client_name
14181 @opindex compatibility_version
14182 @opindex current_version
14183 @opindex dead_strip
14184 @opindex dependency-file
14185 @opindex dylib_file
14186 @opindex dylinker_install_name
14187 @opindex dynamic
14188 @opindex exported_symbols_list
14189 @opindex filelist
14190 @opindex flat_namespace
14191 @opindex force_flat_namespace
14192 @opindex headerpad_max_install_names
14193 @opindex image_base
14194 @opindex init
14195 @opindex install_name
14196 @opindex keep_private_externs
14197 @opindex multi_module
14198 @opindex multiply_defined
14199 @opindex multiply_defined_unused
14200 @opindex noall_load
14201 @opindex no_dead_strip_inits_and_terms
14202 @opindex nofixprebinding
14203 @opindex nomultidefs
14204 @opindex noprebind
14205 @opindex noseglinkedit
14206 @opindex pagezero_size
14207 @opindex prebind
14208 @opindex prebind_all_twolevel_modules
14209 @opindex private_bundle
14210 @opindex read_only_relocs
14211 @opindex sectalign
14212 @opindex sectobjectsymbols
14213 @opindex whyload
14214 @opindex seg1addr
14215 @opindex sectcreate
14216 @opindex sectobjectsymbols
14217 @opindex sectorder
14218 @opindex segaddr
14219 @opindex segs_read_only_addr
14220 @opindex segs_read_write_addr
14221 @opindex seg_addr_table
14222 @opindex seg_addr_table_filename
14223 @opindex seglinkedit
14224 @opindex segprot
14225 @opindex segs_read_only_addr
14226 @opindex segs_read_write_addr
14227 @opindex single_module
14228 @opindex static
14229 @opindex sub_library
14230 @opindex sub_umbrella
14231 @opindex twolevel_namespace
14232 @opindex umbrella
14233 @opindex undefined
14234 @opindex unexported_symbols_list
14235 @opindex weak_reference_mismatches
14236 @opindex whatsloaded
14237 These options are passed to the Darwin linker.  The Darwin linker man page
14238 describes them in detail.
14239 @end table
14241 @node DEC Alpha Options
14242 @subsection DEC Alpha Options
14244 These @samp{-m} options are defined for the DEC Alpha implementations:
14246 @table @gcctabopt
14247 @item -mno-soft-float
14248 @itemx -msoft-float
14249 @opindex mno-soft-float
14250 @opindex msoft-float
14251 Use (do not use) the hardware floating-point instructions for
14252 floating-point operations.  When @option{-msoft-float} is specified,
14253 functions in @file{libgcc.a} are used to perform floating-point
14254 operations.  Unless they are replaced by routines that emulate the
14255 floating-point operations, or compiled in such a way as to call such
14256 emulations routines, these routines issue floating-point
14257 operations.   If you are compiling for an Alpha without floating-point
14258 operations, you must ensure that the library is built so as not to call
14259 them.
14261 Note that Alpha implementations without floating-point operations are
14262 required to have floating-point registers.
14264 @item -mfp-reg
14265 @itemx -mno-fp-regs
14266 @opindex mfp-reg
14267 @opindex mno-fp-regs
14268 Generate code that uses (does not use) the floating-point register set.
14269 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14270 register set is not used, floating-point operands are passed in integer
14271 registers as if they were integers and floating-point results are passed
14272 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14273 so any function with a floating-point argument or return value called by code
14274 compiled with @option{-mno-fp-regs} must also be compiled with that
14275 option.
14277 A typical use of this option is building a kernel that does not use,
14278 and hence need not save and restore, any floating-point registers.
14280 @item -mieee
14281 @opindex mieee
14282 The Alpha architecture implements floating-point hardware optimized for
14283 maximum performance.  It is mostly compliant with the IEEE floating-point
14284 standard.  However, for full compliance, software assistance is
14285 required.  This option generates code fully IEEE-compliant code
14286 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14287 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14288 defined during compilation.  The resulting code is less efficient but is
14289 able to correctly support denormalized numbers and exceptional IEEE
14290 values such as not-a-number and plus/minus infinity.  Other Alpha
14291 compilers call this option @option{-ieee_with_no_inexact}.
14293 @item -mieee-with-inexact
14294 @opindex mieee-with-inexact
14295 This is like @option{-mieee} except the generated code also maintains
14296 the IEEE @var{inexact-flag}.  Turning on this option causes the
14297 generated code to implement fully-compliant IEEE math.  In addition to
14298 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14299 macro.  On some Alpha implementations the resulting code may execute
14300 significantly slower than the code generated by default.  Since there is
14301 very little code that depends on the @var{inexact-flag}, you should
14302 normally not specify this option.  Other Alpha compilers call this
14303 option @option{-ieee_with_inexact}.
14305 @item -mfp-trap-mode=@var{trap-mode}
14306 @opindex mfp-trap-mode
14307 This option controls what floating-point related traps are enabled.
14308 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14309 The trap mode can be set to one of four values:
14311 @table @samp
14312 @item n
14313 This is the default (normal) setting.  The only traps that are enabled
14314 are the ones that cannot be disabled in software (e.g., division by zero
14315 trap).
14317 @item u
14318 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14319 as well.
14321 @item su
14322 Like @samp{u}, but the instructions are marked to be safe for software
14323 completion (see Alpha architecture manual for details).
14325 @item sui
14326 Like @samp{su}, but inexact traps are enabled as well.
14327 @end table
14329 @item -mfp-rounding-mode=@var{rounding-mode}
14330 @opindex mfp-rounding-mode
14331 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14332 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14335 @table @samp
14336 @item n
14337 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14338 the nearest machine number or towards the even machine number in case
14339 of a tie.
14341 @item m
14342 Round towards minus infinity.
14344 @item c
14345 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14347 @item d
14348 Dynamic rounding mode.  A field in the floating-point control register
14349 (@var{fpcr}, see Alpha architecture reference manual) controls the
14350 rounding mode in effect.  The C library initializes this register for
14351 rounding towards plus infinity.  Thus, unless your program modifies the
14352 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14353 @end table
14355 @item -mtrap-precision=@var{trap-precision}
14356 @opindex mtrap-precision
14357 In the Alpha architecture, floating-point traps are imprecise.  This
14358 means without software assistance it is impossible to recover from a
14359 floating trap and program execution normally needs to be terminated.
14360 GCC can generate code that can assist operating system trap handlers
14361 in determining the exact location that caused a floating-point trap.
14362 Depending on the requirements of an application, different levels of
14363 precisions can be selected:
14365 @table @samp
14366 @item p
14367 Program precision.  This option is the default and means a trap handler
14368 can only identify which program caused a floating-point exception.
14370 @item f
14371 Function precision.  The trap handler can determine the function that
14372 caused a floating-point exception.
14374 @item i
14375 Instruction precision.  The trap handler can determine the exact
14376 instruction that caused a floating-point exception.
14377 @end table
14379 Other Alpha compilers provide the equivalent options called
14380 @option{-scope_safe} and @option{-resumption_safe}.
14382 @item -mieee-conformant
14383 @opindex mieee-conformant
14384 This option marks the generated code as IEEE conformant.  You must not
14385 use this option unless you also specify @option{-mtrap-precision=i} and either
14386 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14387 is to emit the line @samp{.eflag 48} in the function prologue of the
14388 generated assembly file.
14390 @item -mbuild-constants
14391 @opindex mbuild-constants
14392 Normally GCC examines a 32- or 64-bit integer constant to
14393 see if it can construct it from smaller constants in two or three
14394 instructions.  If it cannot, it outputs the constant as a literal and
14395 generates code to load it from the data segment at run time.
14397 Use this option to require GCC to construct @emph{all} integer constants
14398 using code, even if it takes more instructions (the maximum is six).
14400 You typically use this option to build a shared library dynamic
14401 loader.  Itself a shared library, it must relocate itself in memory
14402 before it can find the variables and constants in its own data segment.
14404 @item -mbwx
14405 @itemx -mno-bwx
14406 @itemx -mcix
14407 @itemx -mno-cix
14408 @itemx -mfix
14409 @itemx -mno-fix
14410 @itemx -mmax
14411 @itemx -mno-max
14412 @opindex mbwx
14413 @opindex mno-bwx
14414 @opindex mcix
14415 @opindex mno-cix
14416 @opindex mfix
14417 @opindex mno-fix
14418 @opindex mmax
14419 @opindex mno-max
14420 Indicate whether GCC should generate code to use the optional BWX,
14421 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14422 sets supported by the CPU type specified via @option{-mcpu=} option or that
14423 of the CPU on which GCC was built if none is specified.
14425 @item -mfloat-vax
14426 @itemx -mfloat-ieee
14427 @opindex mfloat-vax
14428 @opindex mfloat-ieee
14429 Generate code that uses (does not use) VAX F and G floating-point
14430 arithmetic instead of IEEE single and double precision.
14432 @item -mexplicit-relocs
14433 @itemx -mno-explicit-relocs
14434 @opindex mexplicit-relocs
14435 @opindex mno-explicit-relocs
14436 Older Alpha assemblers provided no way to generate symbol relocations
14437 except via assembler macros.  Use of these macros does not allow
14438 optimal instruction scheduling.  GNU binutils as of version 2.12
14439 supports a new syntax that allows the compiler to explicitly mark
14440 which relocations should apply to which instructions.  This option
14441 is mostly useful for debugging, as GCC detects the capabilities of
14442 the assembler when it is built and sets the default accordingly.
14444 @item -msmall-data
14445 @itemx -mlarge-data
14446 @opindex msmall-data
14447 @opindex mlarge-data
14448 When @option{-mexplicit-relocs} is in effect, static data is
14449 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14450 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14451 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14452 16-bit relocations off of the @code{$gp} register.  This limits the
14453 size of the small data area to 64KB, but allows the variables to be
14454 directly accessed via a single instruction.
14456 The default is @option{-mlarge-data}.  With this option the data area
14457 is limited to just below 2GB@.  Programs that require more than 2GB of
14458 data must use @code{malloc} or @code{mmap} to allocate the data in the
14459 heap instead of in the program's data segment.
14461 When generating code for shared libraries, @option{-fpic} implies
14462 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14464 @item -msmall-text
14465 @itemx -mlarge-text
14466 @opindex msmall-text
14467 @opindex mlarge-text
14468 When @option{-msmall-text} is used, the compiler assumes that the
14469 code of the entire program (or shared library) fits in 4MB, and is
14470 thus reachable with a branch instruction.  When @option{-msmall-data}
14471 is used, the compiler can assume that all local symbols share the
14472 same @code{$gp} value, and thus reduce the number of instructions
14473 required for a function call from 4 to 1.
14475 The default is @option{-mlarge-text}.
14477 @item -mcpu=@var{cpu_type}
14478 @opindex mcpu
14479 Set the instruction set and instruction scheduling parameters for
14480 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14481 style name or the corresponding chip number.  GCC supports scheduling
14482 parameters for the EV4, EV5 and EV6 family of processors and
14483 chooses the default values for the instruction set from the processor
14484 you specify.  If you do not specify a processor type, GCC defaults
14485 to the processor on which the compiler was built.
14487 Supported values for @var{cpu_type} are
14489 @table @samp
14490 @item ev4
14491 @itemx ev45
14492 @itemx 21064
14493 Schedules as an EV4 and has no instruction set extensions.
14495 @item ev5
14496 @itemx 21164
14497 Schedules as an EV5 and has no instruction set extensions.
14499 @item ev56
14500 @itemx 21164a
14501 Schedules as an EV5 and supports the BWX extension.
14503 @item pca56
14504 @itemx 21164pc
14505 @itemx 21164PC
14506 Schedules as an EV5 and supports the BWX and MAX extensions.
14508 @item ev6
14509 @itemx 21264
14510 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14512 @item ev67
14513 @itemx 21264a
14514 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14515 @end table
14517 Native toolchains also support the value @samp{native},
14518 which selects the best architecture option for the host processor.
14519 @option{-mcpu=native} has no effect if GCC does not recognize
14520 the processor.
14522 @item -mtune=@var{cpu_type}
14523 @opindex mtune
14524 Set only the instruction scheduling parameters for machine type
14525 @var{cpu_type}.  The instruction set is not changed.
14527 Native toolchains also support the value @samp{native},
14528 which selects the best architecture option for the host processor.
14529 @option{-mtune=native} has no effect if GCC does not recognize
14530 the processor.
14532 @item -mmemory-latency=@var{time}
14533 @opindex mmemory-latency
14534 Sets the latency the scheduler should assume for typical memory
14535 references as seen by the application.  This number is highly
14536 dependent on the memory access patterns used by the application
14537 and the size of the external cache on the machine.
14539 Valid options for @var{time} are
14541 @table @samp
14542 @item @var{number}
14543 A decimal number representing clock cycles.
14545 @item L1
14546 @itemx L2
14547 @itemx L3
14548 @itemx main
14549 The compiler contains estimates of the number of clock cycles for
14550 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14551 (also called Dcache, Scache, and Bcache), as well as to main memory.
14552 Note that L3 is only valid for EV5.
14554 @end table
14555 @end table
14557 @node FR30 Options
14558 @subsection FR30 Options
14559 @cindex FR30 Options
14561 These options are defined specifically for the FR30 port.
14563 @table @gcctabopt
14565 @item -msmall-model
14566 @opindex msmall-model
14567 Use the small address space model.  This can produce smaller code, but
14568 it does assume that all symbolic values and addresses fit into a
14569 20-bit range.
14571 @item -mno-lsim
14572 @opindex mno-lsim
14573 Assume that runtime support has been provided and so there is no need
14574 to include the simulator library (@file{libsim.a}) on the linker
14575 command line.
14577 @end table
14579 @node FRV Options
14580 @subsection FRV Options
14581 @cindex FRV Options
14583 @table @gcctabopt
14584 @item -mgpr-32
14585 @opindex mgpr-32
14587 Only use the first 32 general-purpose registers.
14589 @item -mgpr-64
14590 @opindex mgpr-64
14592 Use all 64 general-purpose registers.
14594 @item -mfpr-32
14595 @opindex mfpr-32
14597 Use only the first 32 floating-point registers.
14599 @item -mfpr-64
14600 @opindex mfpr-64
14602 Use all 64 floating-point registers.
14604 @item -mhard-float
14605 @opindex mhard-float
14607 Use hardware instructions for floating-point operations.
14609 @item -msoft-float
14610 @opindex msoft-float
14612 Use library routines for floating-point operations.
14614 @item -malloc-cc
14615 @opindex malloc-cc
14617 Dynamically allocate condition code registers.
14619 @item -mfixed-cc
14620 @opindex mfixed-cc
14622 Do not try to dynamically allocate condition code registers, only
14623 use @code{icc0} and @code{fcc0}.
14625 @item -mdword
14626 @opindex mdword
14628 Change ABI to use double word insns.
14630 @item -mno-dword
14631 @opindex mno-dword
14633 Do not use double word instructions.
14635 @item -mdouble
14636 @opindex mdouble
14638 Use floating-point double instructions.
14640 @item -mno-double
14641 @opindex mno-double
14643 Do not use floating-point double instructions.
14645 @item -mmedia
14646 @opindex mmedia
14648 Use media instructions.
14650 @item -mno-media
14651 @opindex mno-media
14653 Do not use media instructions.
14655 @item -mmuladd
14656 @opindex mmuladd
14658 Use multiply and add/subtract instructions.
14660 @item -mno-muladd
14661 @opindex mno-muladd
14663 Do not use multiply and add/subtract instructions.
14665 @item -mfdpic
14666 @opindex mfdpic
14668 Select the FDPIC ABI, which uses function descriptors to represent
14669 pointers to functions.  Without any PIC/PIE-related options, it
14670 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14671 assumes GOT entries and small data are within a 12-bit range from the
14672 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14673 are computed with 32 bits.
14674 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14676 @item -minline-plt
14677 @opindex minline-plt
14679 Enable inlining of PLT entries in function calls to functions that are
14680 not known to bind locally.  It has no effect without @option{-mfdpic}.
14681 It's enabled by default if optimizing for speed and compiling for
14682 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14683 optimization option such as @option{-O3} or above is present in the
14684 command line.
14686 @item -mTLS
14687 @opindex mTLS
14689 Assume a large TLS segment when generating thread-local code.
14691 @item -mtls
14692 @opindex mtls
14694 Do not assume a large TLS segment when generating thread-local code.
14696 @item -mgprel-ro
14697 @opindex mgprel-ro
14699 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14700 that is known to be in read-only sections.  It's enabled by default,
14701 except for @option{-fpic} or @option{-fpie}: even though it may help
14702 make the global offset table smaller, it trades 1 instruction for 4.
14703 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14704 one of which may be shared by multiple symbols, and it avoids the need
14705 for a GOT entry for the referenced symbol, so it's more likely to be a
14706 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14708 @item -multilib-library-pic
14709 @opindex multilib-library-pic
14711 Link with the (library, not FD) pic libraries.  It's implied by
14712 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14713 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14714 it explicitly.
14716 @item -mlinked-fp
14717 @opindex mlinked-fp
14719 Follow the EABI requirement of always creating a frame pointer whenever
14720 a stack frame is allocated.  This option is enabled by default and can
14721 be disabled with @option{-mno-linked-fp}.
14723 @item -mlong-calls
14724 @opindex mlong-calls
14726 Use indirect addressing to call functions outside the current
14727 compilation unit.  This allows the functions to be placed anywhere
14728 within the 32-bit address space.
14730 @item -malign-labels
14731 @opindex malign-labels
14733 Try to align labels to an 8-byte boundary by inserting NOPs into the
14734 previous packet.  This option only has an effect when VLIW packing
14735 is enabled.  It doesn't create new packets; it merely adds NOPs to
14736 existing ones.
14738 @item -mlibrary-pic
14739 @opindex mlibrary-pic
14741 Generate position-independent EABI code.
14743 @item -macc-4
14744 @opindex macc-4
14746 Use only the first four media accumulator registers.
14748 @item -macc-8
14749 @opindex macc-8
14751 Use all eight media accumulator registers.
14753 @item -mpack
14754 @opindex mpack
14756 Pack VLIW instructions.
14758 @item -mno-pack
14759 @opindex mno-pack
14761 Do not pack VLIW instructions.
14763 @item -mno-eflags
14764 @opindex mno-eflags
14766 Do not mark ABI switches in e_flags.
14768 @item -mcond-move
14769 @opindex mcond-move
14771 Enable the use of conditional-move instructions (default).
14773 This switch is mainly for debugging the compiler and will likely be removed
14774 in a future version.
14776 @item -mno-cond-move
14777 @opindex mno-cond-move
14779 Disable the use of conditional-move instructions.
14781 This switch is mainly for debugging the compiler and will likely be removed
14782 in a future version.
14784 @item -mscc
14785 @opindex mscc
14787 Enable the use of conditional set instructions (default).
14789 This switch is mainly for debugging the compiler and will likely be removed
14790 in a future version.
14792 @item -mno-scc
14793 @opindex mno-scc
14795 Disable the use of conditional set instructions.
14797 This switch is mainly for debugging the compiler and will likely be removed
14798 in a future version.
14800 @item -mcond-exec
14801 @opindex mcond-exec
14803 Enable the use of conditional execution (default).
14805 This switch is mainly for debugging the compiler and will likely be removed
14806 in a future version.
14808 @item -mno-cond-exec
14809 @opindex mno-cond-exec
14811 Disable the use of conditional execution.
14813 This switch is mainly for debugging the compiler and will likely be removed
14814 in a future version.
14816 @item -mvliw-branch
14817 @opindex mvliw-branch
14819 Run a pass to pack branches into VLIW instructions (default).
14821 This switch is mainly for debugging the compiler and will likely be removed
14822 in a future version.
14824 @item -mno-vliw-branch
14825 @opindex mno-vliw-branch
14827 Do not run a pass to pack branches into VLIW instructions.
14829 This switch is mainly for debugging the compiler and will likely be removed
14830 in a future version.
14832 @item -mmulti-cond-exec
14833 @opindex mmulti-cond-exec
14835 Enable optimization of @code{&&} and @code{||} in conditional execution
14836 (default).
14838 This switch is mainly for debugging the compiler and will likely be removed
14839 in a future version.
14841 @item -mno-multi-cond-exec
14842 @opindex mno-multi-cond-exec
14844 Disable optimization of @code{&&} and @code{||} in conditional execution.
14846 This switch is mainly for debugging the compiler and will likely be removed
14847 in a future version.
14849 @item -mnested-cond-exec
14850 @opindex mnested-cond-exec
14852 Enable nested conditional execution optimizations (default).
14854 This switch is mainly for debugging the compiler and will likely be removed
14855 in a future version.
14857 @item -mno-nested-cond-exec
14858 @opindex mno-nested-cond-exec
14860 Disable nested conditional execution optimizations.
14862 This switch is mainly for debugging the compiler and will likely be removed
14863 in a future version.
14865 @item -moptimize-membar
14866 @opindex moptimize-membar
14868 This switch removes redundant @code{membar} instructions from the
14869 compiler-generated code.  It is enabled by default.
14871 @item -mno-optimize-membar
14872 @opindex mno-optimize-membar
14874 This switch disables the automatic removal of redundant @code{membar}
14875 instructions from the generated code.
14877 @item -mtomcat-stats
14878 @opindex mtomcat-stats
14880 Cause gas to print out tomcat statistics.
14882 @item -mcpu=@var{cpu}
14883 @opindex mcpu
14885 Select the processor type for which to generate code.  Possible values are
14886 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14887 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14889 @end table
14891 @node GNU/Linux Options
14892 @subsection GNU/Linux Options
14894 These @samp{-m} options are defined for GNU/Linux targets:
14896 @table @gcctabopt
14897 @item -mglibc
14898 @opindex mglibc
14899 Use the GNU C library.  This is the default except
14900 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14902 @item -muclibc
14903 @opindex muclibc
14904 Use uClibc C library.  This is the default on
14905 @samp{*-*-linux-*uclibc*} targets.
14907 @item -mbionic
14908 @opindex mbionic
14909 Use Bionic C library.  This is the default on
14910 @samp{*-*-linux-*android*} targets.
14912 @item -mandroid
14913 @opindex mandroid
14914 Compile code compatible with Android platform.  This is the default on
14915 @samp{*-*-linux-*android*} targets.
14917 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14918 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14919 this option makes the GCC driver pass Android-specific options to the linker.
14920 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14921 to be defined.
14923 @item -tno-android-cc
14924 @opindex tno-android-cc
14925 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14926 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14927 @option{-fno-rtti} by default.
14929 @item -tno-android-ld
14930 @opindex tno-android-ld
14931 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14932 linking options to the linker.
14934 @end table
14936 @node H8/300 Options
14937 @subsection H8/300 Options
14939 These @samp{-m} options are defined for the H8/300 implementations:
14941 @table @gcctabopt
14942 @item -mrelax
14943 @opindex mrelax
14944 Shorten some address references at link time, when possible; uses the
14945 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14946 ld, Using ld}, for a fuller description.
14948 @item -mh
14949 @opindex mh
14950 Generate code for the H8/300H@.
14952 @item -ms
14953 @opindex ms
14954 Generate code for the H8S@.
14956 @item -mn
14957 @opindex mn
14958 Generate code for the H8S and H8/300H in the normal mode.  This switch
14959 must be used either with @option{-mh} or @option{-ms}.
14961 @item -ms2600
14962 @opindex ms2600
14963 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14965 @item -mexr
14966 @opindex mexr
14967 Extended registers are stored on stack before execution of function
14968 with monitor attribute. Default option is @option{-mexr}.
14969 This option is valid only for H8S targets.
14971 @item -mno-exr
14972 @opindex mno-exr
14973 Extended registers are not stored on stack before execution of function 
14974 with monitor attribute. Default option is @option{-mno-exr}. 
14975 This option is valid only for H8S targets.
14977 @item -mint32
14978 @opindex mint32
14979 Make @code{int} data 32 bits by default.
14981 @item -malign-300
14982 @opindex malign-300
14983 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
14984 The default for the H8/300H and H8S is to align longs and floats on
14985 4-byte boundaries.
14986 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
14987 This option has no effect on the H8/300.
14988 @end table
14990 @node HPPA Options
14991 @subsection HPPA Options
14992 @cindex HPPA Options
14994 These @samp{-m} options are defined for the HPPA family of computers:
14996 @table @gcctabopt
14997 @item -march=@var{architecture-type}
14998 @opindex march
14999 Generate code for the specified architecture.  The choices for
15000 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15001 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15002 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15003 architecture option for your machine.  Code compiled for lower numbered
15004 architectures runs on higher numbered architectures, but not the
15005 other way around.
15007 @item -mpa-risc-1-0
15008 @itemx -mpa-risc-1-1
15009 @itemx -mpa-risc-2-0
15010 @opindex mpa-risc-1-0
15011 @opindex mpa-risc-1-1
15012 @opindex mpa-risc-2-0
15013 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15015 @item -mjump-in-delay
15016 @opindex mjump-in-delay
15017 This option is ignored and provided for compatibility purposes only.
15019 @item -mdisable-fpregs
15020 @opindex mdisable-fpregs
15021 Prevent floating-point registers from being used in any manner.  This is
15022 necessary for compiling kernels that perform lazy context switching of
15023 floating-point registers.  If you use this option and attempt to perform
15024 floating-point operations, the compiler aborts.
15026 @item -mdisable-indexing
15027 @opindex mdisable-indexing
15028 Prevent the compiler from using indexing address modes.  This avoids some
15029 rather obscure problems when compiling MIG generated code under MACH@.
15031 @item -mno-space-regs
15032 @opindex mno-space-regs
15033 Generate code that assumes the target has no space registers.  This allows
15034 GCC to generate faster indirect calls and use unscaled index address modes.
15036 Such code is suitable for level 0 PA systems and kernels.
15038 @item -mfast-indirect-calls
15039 @opindex mfast-indirect-calls
15040 Generate code that assumes calls never cross space boundaries.  This
15041 allows GCC to emit code that performs faster indirect calls.
15043 This option does not work in the presence of shared libraries or nested
15044 functions.
15046 @item -mfixed-range=@var{register-range}
15047 @opindex mfixed-range
15048 Generate code treating the given register range as fixed registers.
15049 A fixed register is one that the register allocator cannot use.  This is
15050 useful when compiling kernel code.  A register range is specified as
15051 two registers separated by a dash.  Multiple register ranges can be
15052 specified separated by a comma.
15054 @item -mlong-load-store
15055 @opindex mlong-load-store
15056 Generate 3-instruction load and store sequences as sometimes required by
15057 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15058 the HP compilers.
15060 @item -mportable-runtime
15061 @opindex mportable-runtime
15062 Use the portable calling conventions proposed by HP for ELF systems.
15064 @item -mgas
15065 @opindex mgas
15066 Enable the use of assembler directives only GAS understands.
15068 @item -mschedule=@var{cpu-type}
15069 @opindex mschedule
15070 Schedule code according to the constraints for the machine type
15071 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15072 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15073 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15074 proper scheduling option for your machine.  The default scheduling is
15075 @samp{8000}.
15077 @item -mlinker-opt
15078 @opindex mlinker-opt
15079 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15080 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15081 linkers in which they give bogus error messages when linking some programs.
15083 @item -msoft-float
15084 @opindex msoft-float
15085 Generate output containing library calls for floating point.
15086 @strong{Warning:} the requisite libraries are not available for all HPPA
15087 targets.  Normally the facilities of the machine's usual C compiler are
15088 used, but this cannot be done directly in cross-compilation.  You must make
15089 your own arrangements to provide suitable library functions for
15090 cross-compilation.
15092 @option{-msoft-float} changes the calling convention in the output file;
15093 therefore, it is only useful if you compile @emph{all} of a program with
15094 this option.  In particular, you need to compile @file{libgcc.a}, the
15095 library that comes with GCC, with @option{-msoft-float} in order for
15096 this to work.
15098 @item -msio
15099 @opindex msio
15100 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15101 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15102 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15103 options are available under HP-UX and HI-UX@.
15105 @item -mgnu-ld
15106 @opindex mgnu-ld
15107 Use options specific to GNU @command{ld}.
15108 This passes @option{-shared} to @command{ld} when
15109 building a shared library.  It is the default when GCC is configured,
15110 explicitly or implicitly, with the GNU linker.  This option does not
15111 affect which @command{ld} is called; it only changes what parameters
15112 are passed to that @command{ld}.
15113 The @command{ld} that is called is determined by the
15114 @option{--with-ld} configure option, GCC's program search path, and
15115 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15116 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15117 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15119 @item -mhp-ld
15120 @opindex mhp-ld
15121 Use options specific to HP @command{ld}.
15122 This passes @option{-b} to @command{ld} when building
15123 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15124 links.  It is the default when GCC is configured, explicitly or
15125 implicitly, with the HP linker.  This option does not affect
15126 which @command{ld} is called; it only changes what parameters are passed to that
15127 @command{ld}.
15128 The @command{ld} that is called is determined by the @option{--with-ld}
15129 configure option, GCC's program search path, and finally by the user's
15130 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15131 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15132 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15134 @item -mlong-calls
15135 @opindex mno-long-calls
15136 Generate code that uses long call sequences.  This ensures that a call
15137 is always able to reach linker generated stubs.  The default is to generate
15138 long calls only when the distance from the call site to the beginning
15139 of the function or translation unit, as the case may be, exceeds a
15140 predefined limit set by the branch type being used.  The limits for
15141 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15142 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15143 240,000 bytes.
15145 Distances are measured from the beginning of functions when using the
15146 @option{-ffunction-sections} option, or when using the @option{-mgas}
15147 and @option{-mno-portable-runtime} options together under HP-UX with
15148 the SOM linker.
15150 It is normally not desirable to use this option as it degrades
15151 performance.  However, it may be useful in large applications,
15152 particularly when partial linking is used to build the application.
15154 The types of long calls used depends on the capabilities of the
15155 assembler and linker, and the type of code being generated.  The
15156 impact on systems that support long absolute calls, and long pic
15157 symbol-difference or pc-relative calls should be relatively small.
15158 However, an indirect call is used on 32-bit ELF systems in pic code
15159 and it is quite long.
15161 @item -munix=@var{unix-std}
15162 @opindex march
15163 Generate compiler predefines and select a startfile for the specified
15164 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15165 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15166 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15167 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15168 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15169 and later.
15171 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15172 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15173 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15174 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15175 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15176 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15178 It is @emph{important} to note that this option changes the interfaces
15179 for various library routines.  It also affects the operational behavior
15180 of the C library.  Thus, @emph{extreme} care is needed in using this
15181 option.
15183 Library code that is intended to operate with more than one UNIX
15184 standard must test, set and restore the variable @var{__xpg4_extended_mask}
15185 as appropriate.  Most GNU software doesn't provide this capability.
15187 @item -nolibdld
15188 @opindex nolibdld
15189 Suppress the generation of link options to search libdld.sl when the
15190 @option{-static} option is specified on HP-UX 10 and later.
15192 @item -static
15193 @opindex static
15194 The HP-UX implementation of setlocale in libc has a dependency on
15195 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15196 when the @option{-static} option is specified, special link options
15197 are needed to resolve this dependency.
15199 On HP-UX 10 and later, the GCC driver adds the necessary options to
15200 link with libdld.sl when the @option{-static} option is specified.
15201 This causes the resulting binary to be dynamic.  On the 64-bit port,
15202 the linkers generate dynamic binaries by default in any case.  The
15203 @option{-nolibdld} option can be used to prevent the GCC driver from
15204 adding these link options.
15206 @item -threads
15207 @opindex threads
15208 Add support for multithreading with the @dfn{dce thread} library
15209 under HP-UX@.  This option sets flags for both the preprocessor and
15210 linker.
15211 @end table
15213 @node i386 and x86-64 Options
15214 @subsection Intel 386 and AMD x86-64 Options
15215 @cindex i386 Options
15216 @cindex x86-64 Options
15217 @cindex Intel 386 Options
15218 @cindex AMD x86-64 Options
15220 These @samp{-m} options are defined for the i386 and x86-64 family of
15221 computers:
15223 @table @gcctabopt
15225 @item -march=@var{cpu-type}
15226 @opindex march
15227 Generate instructions for the machine type @var{cpu-type}.  In contrast to
15228 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
15229 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
15230 to generate code that may not run at all on processors other than the one
15231 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
15232 @option{-mtune=@var{cpu-type}}.
15234 The choices for @var{cpu-type} are:
15236 @table @samp
15237 @item native
15238 This selects the CPU to generate code for at compilation time by determining
15239 the processor type of the compiling machine.  Using @option{-march=native}
15240 enables all instruction subsets supported by the local machine (hence
15241 the result might not run on different machines).  Using @option{-mtune=native}
15242 produces code optimized for the local machine under the constraints
15243 of the selected instruction set.  
15245 @item i386
15246 Original Intel i386 CPU@.
15248 @item i486
15249 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
15251 @item i586
15252 @itemx pentium
15253 Intel Pentium CPU with no MMX support.
15255 @item pentium-mmx
15256 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
15258 @item pentiumpro
15259 Intel Pentium Pro CPU@.
15261 @item i686
15262 When used with @option{-march}, the Pentium Pro
15263 instruction set is used, so the code runs on all i686 family chips.
15264 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
15266 @item pentium2
15267 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
15268 support.
15270 @item pentium3
15271 @itemx pentium3m
15272 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
15273 set support.
15275 @item pentium-m
15276 Intel Pentium M; low-power version of Intel Pentium III CPU
15277 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
15279 @item pentium4
15280 @itemx pentium4m
15281 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
15283 @item prescott
15284 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
15285 set support.
15287 @item nocona
15288 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
15289 SSE2 and SSE3 instruction set support.
15291 @item core2
15292 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
15293 instruction set support.
15295 @item nehalem
15296 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15297 SSE4.1, SSE4.2 and POPCNT instruction set support.
15299 @item westmere
15300 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15301 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
15303 @item sandybridge
15304 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15305 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
15307 @item ivybridge
15308 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15309 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
15310 instruction set support.
15312 @item haswell
15313 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15314 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15315 BMI, BMI2 and F16C instruction set support.
15317 @item broadwell
15318 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15319 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15320 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
15322 @item bonnell
15323 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
15324 instruction set support.
15326 @item silvermont
15327 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15328 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
15330 @item k6
15331 AMD K6 CPU with MMX instruction set support.
15333 @item k6-2
15334 @itemx k6-3
15335 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
15337 @item athlon
15338 @itemx athlon-tbird
15339 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
15340 support.
15342 @item athlon-4
15343 @itemx athlon-xp
15344 @itemx athlon-mp
15345 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
15346 instruction set support.
15348 @item k8
15349 @itemx opteron
15350 @itemx athlon64
15351 @itemx athlon-fx
15352 Processors based on the AMD K8 core with x86-64 instruction set support,
15353 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
15354 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
15355 instruction set extensions.)
15357 @item k8-sse3
15358 @itemx opteron-sse3
15359 @itemx athlon64-sse3
15360 Improved versions of AMD K8 cores with SSE3 instruction set support.
15362 @item amdfam10
15363 @itemx barcelona
15364 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
15365 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
15366 instruction set extensions.)
15368 @item bdver1
15369 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
15370 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
15371 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
15372 @item bdver2
15373 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15374 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
15375 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
15376 extensions.)
15377 @item bdver3
15378 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15379 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
15380 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
15381 64-bit instruction set extensions.
15382 @item bdver4
15383 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15384 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
15385 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
15386 SSE4.2, ABM and 64-bit instruction set extensions.
15388 @item btver1
15389 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
15390 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
15391 instruction set extensions.)
15393 @item btver2
15394 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
15395 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
15396 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
15398 @item winchip-c6
15399 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15400 set support.
15402 @item winchip2
15403 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15404 instruction set support.
15406 @item c3
15407 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15408 implemented for this chip.)
15410 @item c3-2
15411 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15412 (No scheduling is
15413 implemented for this chip.)
15415 @item geode
15416 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15417 @end table
15419 @item -mtune=@var{cpu-type}
15420 @opindex mtune
15421 Tune to @var{cpu-type} everything applicable about the generated code, except
15422 for the ABI and the set of available instructions.  
15423 While picking a specific @var{cpu-type} schedules things appropriately
15424 for that particular chip, the compiler does not generate any code that
15425 cannot run on the default machine type unless you use a
15426 @option{-march=@var{cpu-type}} option.
15427 For example, if GCC is configured for i686-pc-linux-gnu
15428 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15429 but still runs on i686 machines.
15431 The choices for @var{cpu-type} are the same as for @option{-march}.
15432 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15434 @table @samp
15435 @item generic
15436 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15437 If you know the CPU on which your code will run, then you should use
15438 the corresponding @option{-mtune} or @option{-march} option instead of
15439 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15440 of your application will have, then you should use this option.
15442 As new processors are deployed in the marketplace, the behavior of this
15443 option will change.  Therefore, if you upgrade to a newer version of
15444 GCC, code generation controlled by this option will change to reflect
15445 the processors
15446 that are most common at the time that version of GCC is released.
15448 There is no @option{-march=generic} option because @option{-march}
15449 indicates the instruction set the compiler can use, and there is no
15450 generic instruction set applicable to all processors.  In contrast,
15451 @option{-mtune} indicates the processor (or, in this case, collection of
15452 processors) for which the code is optimized.
15454 @item intel
15455 Produce code optimized for the most current Intel processors, which are
15456 Haswell and Silvermont for this version of GCC.  If you know the CPU
15457 on which your code will run, then you should use the corresponding
15458 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15459 But, if you want your application performs better on both Haswell and
15460 Silvermont, then you should use this option.
15462 As new Intel processors are deployed in the marketplace, the behavior of
15463 this option will change.  Therefore, if you upgrade to a newer version of
15464 GCC, code generation controlled by this option will change to reflect
15465 the most current Intel processors at the time that version of GCC is
15466 released.
15468 There is no @option{-march=intel} option because @option{-march} indicates
15469 the instruction set the compiler can use, and there is no common
15470 instruction set applicable to all processors.  In contrast,
15471 @option{-mtune} indicates the processor (or, in this case, collection of
15472 processors) for which the code is optimized.
15473 @end table
15475 @item -mcpu=@var{cpu-type}
15476 @opindex mcpu
15477 A deprecated synonym for @option{-mtune}.
15479 @item -mfpmath=@var{unit}
15480 @opindex mfpmath
15481 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15482 for @var{unit} are:
15484 @table @samp
15485 @item 387
15486 Use the standard 387 floating-point coprocessor present on the majority of chips and
15487 emulated otherwise.  Code compiled with this option runs almost everywhere.
15488 The temporary results are computed in 80-bit precision instead of the precision
15489 specified by the type, resulting in slightly different results compared to most
15490 of other chips.  See @option{-ffloat-store} for more detailed description.
15492 This is the default choice for i386 compiler.
15494 @item sse
15495 Use scalar floating-point instructions present in the SSE instruction set.
15496 This instruction set is supported by Pentium III and newer chips,
15497 and in the AMD line
15498 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15499 instruction set supports only single-precision arithmetic, thus the double and
15500 extended-precision arithmetic are still done using 387.  A later version, present
15501 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15502 arithmetic too.
15504 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15505 or @option{-msse2} switches to enable SSE extensions and make this option
15506 effective.  For the x86-64 compiler, these extensions are enabled by default.
15508 The resulting code should be considerably faster in the majority of cases and avoid
15509 the numerical instability problems of 387 code, but may break some existing
15510 code that expects temporaries to be 80 bits.
15512 This is the default choice for the x86-64 compiler.
15514 @item sse,387
15515 @itemx sse+387
15516 @itemx both
15517 Attempt to utilize both instruction sets at once.  This effectively doubles the
15518 amount of available registers, and on chips with separate execution units for
15519 387 and SSE the execution resources too.  Use this option with care, as it is
15520 still experimental, because the GCC register allocator does not model separate
15521 functional units well, resulting in unstable performance.
15522 @end table
15524 @item -masm=@var{dialect}
15525 @opindex masm=@var{dialect}
15526 Output assembly instructions using selected @var{dialect}.  Supported
15527 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15528 not support @samp{intel}.
15530 @item -mieee-fp
15531 @itemx -mno-ieee-fp
15532 @opindex mieee-fp
15533 @opindex mno-ieee-fp
15534 Control whether or not the compiler uses IEEE floating-point
15535 comparisons.  These correctly handle the case where the result of a
15536 comparison is unordered.
15538 @item -msoft-float
15539 @opindex msoft-float
15540 Generate output containing library calls for floating point.
15542 @strong{Warning:} the requisite libraries are not part of GCC@.
15543 Normally the facilities of the machine's usual C compiler are used, but
15544 this can't be done directly in cross-compilation.  You must make your
15545 own arrangements to provide suitable library functions for
15546 cross-compilation.
15548 On machines where a function returns floating-point results in the 80387
15549 register stack, some floating-point opcodes may be emitted even if
15550 @option{-msoft-float} is used.
15552 @item -mno-fp-ret-in-387
15553 @opindex mno-fp-ret-in-387
15554 Do not use the FPU registers for return values of functions.
15556 The usual calling convention has functions return values of types
15557 @code{float} and @code{double} in an FPU register, even if there
15558 is no FPU@.  The idea is that the operating system should emulate
15559 an FPU@.
15561 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15562 in ordinary CPU registers instead.
15564 @item -mno-fancy-math-387
15565 @opindex mno-fancy-math-387
15566 Some 387 emulators do not support the @code{sin}, @code{cos} and
15567 @code{sqrt} instructions for the 387.  Specify this option to avoid
15568 generating those instructions.  This option is the default on FreeBSD,
15569 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15570 indicates that the target CPU always has an FPU and so the
15571 instruction does not need emulation.  These
15572 instructions are not generated unless you also use the
15573 @option{-funsafe-math-optimizations} switch.
15575 @item -malign-double
15576 @itemx -mno-align-double
15577 @opindex malign-double
15578 @opindex mno-align-double
15579 Control whether GCC aligns @code{double}, @code{long double}, and
15580 @code{long long} variables on a two-word boundary or a one-word
15581 boundary.  Aligning @code{double} variables on a two-word boundary
15582 produces code that runs somewhat faster on a Pentium at the
15583 expense of more memory.
15585 On x86-64, @option{-malign-double} is enabled by default.
15587 @strong{Warning:} if you use the @option{-malign-double} switch,
15588 structures containing the above types are aligned differently than
15589 the published application binary interface specifications for the 386
15590 and are not binary compatible with structures in code compiled
15591 without that switch.
15593 @item -m96bit-long-double
15594 @itemx -m128bit-long-double
15595 @opindex m96bit-long-double
15596 @opindex m128bit-long-double
15597 These switches control the size of @code{long double} type.  The i386
15598 application binary interface specifies the size to be 96 bits,
15599 so @option{-m96bit-long-double} is the default in 32-bit mode.
15601 Modern architectures (Pentium and newer) prefer @code{long double}
15602 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15603 conforming to the ABI, this is not possible.  So specifying
15604 @option{-m128bit-long-double} aligns @code{long double}
15605 to a 16-byte boundary by padding the @code{long double} with an additional
15606 32-bit zero.
15608 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15609 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15611 Notice that neither of these options enable any extra precision over the x87
15612 standard of 80 bits for a @code{long double}.
15614 @strong{Warning:} if you override the default value for your target ABI, this
15615 changes the size of 
15616 structures and arrays containing @code{long double} variables,
15617 as well as modifying the function calling convention for functions taking
15618 @code{long double}.  Hence they are not binary-compatible
15619 with code compiled without that switch.
15621 @item -mlong-double-64
15622 @itemx -mlong-double-80
15623 @itemx -mlong-double-128
15624 @opindex mlong-double-64
15625 @opindex mlong-double-80
15626 @opindex mlong-double-128
15627 These switches control the size of @code{long double} type. A size
15628 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15629 type. This is the default for 32-bit Bionic C library.  A size
15630 of 128 bits makes the @code{long double} type equivalent to the
15631 @code{__float128} type. This is the default for 64-bit Bionic C library.
15633 @strong{Warning:} if you override the default value for your target ABI, this
15634 changes the size of
15635 structures and arrays containing @code{long double} variables,
15636 as well as modifying the function calling convention for functions taking
15637 @code{long double}.  Hence they are not binary-compatible
15638 with code compiled without that switch.
15640 @item -mlarge-data-threshold=@var{threshold}
15641 @opindex mlarge-data-threshold
15642 When @option{-mcmodel=medium} is specified, data objects larger than
15643 @var{threshold} are placed in the large data section.  This value must be the
15644 same across all objects linked into the binary, and defaults to 65535.
15646 @item -mrtd
15647 @opindex mrtd
15648 Use a different function-calling convention, in which functions that
15649 take a fixed number of arguments return with the @code{ret @var{num}}
15650 instruction, which pops their arguments while returning.  This saves one
15651 instruction in the caller since there is no need to pop the arguments
15652 there.
15654 You can specify that an individual function is called with this calling
15655 sequence with the function attribute @samp{stdcall}.  You can also
15656 override the @option{-mrtd} option by using the function attribute
15657 @samp{cdecl}.  @xref{Function Attributes}.
15659 @strong{Warning:} this calling convention is incompatible with the one
15660 normally used on Unix, so you cannot use it if you need to call
15661 libraries compiled with the Unix compiler.
15663 Also, you must provide function prototypes for all functions that
15664 take variable numbers of arguments (including @code{printf});
15665 otherwise incorrect code is generated for calls to those
15666 functions.
15668 In addition, seriously incorrect code results if you call a
15669 function with too many arguments.  (Normally, extra arguments are
15670 harmlessly ignored.)
15672 @item -mregparm=@var{num}
15673 @opindex mregparm
15674 Control how many registers are used to pass integer arguments.  By
15675 default, no registers are used to pass arguments, and at most 3
15676 registers can be used.  You can control this behavior for a specific
15677 function by using the function attribute @samp{regparm}.
15678 @xref{Function Attributes}.
15680 @strong{Warning:} if you use this switch, and
15681 @var{num} is nonzero, then you must build all modules with the same
15682 value, including any libraries.  This includes the system libraries and
15683 startup modules.
15685 @item -msseregparm
15686 @opindex msseregparm
15687 Use SSE register passing conventions for float and double arguments
15688 and return values.  You can control this behavior for a specific
15689 function by using the function attribute @samp{sseregparm}.
15690 @xref{Function Attributes}.
15692 @strong{Warning:} if you use this switch then you must build all
15693 modules with the same value, including any libraries.  This includes
15694 the system libraries and startup modules.
15696 @item -mvect8-ret-in-mem
15697 @opindex mvect8-ret-in-mem
15698 Return 8-byte vectors in memory instead of MMX registers.  This is the
15699 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15700 Studio compilers until version 12.  Later compiler versions (starting
15701 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15702 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15703 you need to remain compatible with existing code produced by those
15704 previous compiler versions or older versions of GCC@.
15706 @item -mpc32
15707 @itemx -mpc64
15708 @itemx -mpc80
15709 @opindex mpc32
15710 @opindex mpc64
15711 @opindex mpc80
15713 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15714 is specified, the significands of results of floating-point operations are
15715 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15716 significands of results of floating-point operations to 53 bits (double
15717 precision) and @option{-mpc80} rounds the significands of results of
15718 floating-point operations to 64 bits (extended double precision), which is
15719 the default.  When this option is used, floating-point operations in higher
15720 precisions are not available to the programmer without setting the FPU
15721 control word explicitly.
15723 Setting the rounding of floating-point operations to less than the default
15724 80 bits can speed some programs by 2% or more.  Note that some mathematical
15725 libraries assume that extended-precision (80-bit) floating-point operations
15726 are enabled by default; routines in such libraries could suffer significant
15727 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15728 when this option is used to set the precision to less than extended precision.
15730 @item -mstackrealign
15731 @opindex mstackrealign
15732 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15733 option generates an alternate prologue and epilogue that realigns the
15734 run-time stack if necessary.  This supports mixing legacy codes that keep
15735 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15736 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15737 applicable to individual functions.
15739 @item -mpreferred-stack-boundary=@var{num}
15740 @opindex mpreferred-stack-boundary
15741 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15742 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15743 the default is 4 (16 bytes or 128 bits).
15745 @strong{Warning:} When generating code for the x86-64 architecture with
15746 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15747 used to keep the stack boundary aligned to 8 byte boundary.  Since
15748 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15749 intended to be used in controlled environment where stack space is
15750 important limitation.  This option will lead to wrong code when functions
15751 compiled with 16 byte stack alignment (such as functions from a standard
15752 library) are called with misaligned stack.  In this case, SSE
15753 instructions may lead to misaligned memory access traps.  In addition,
15754 variable arguments will be handled incorrectly for 16 byte aligned
15755 objects (including x87 long double and __int128), leading to wrong
15756 results.  You must build all modules with
15757 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15758 includes the system libraries and startup modules.
15760 @item -mincoming-stack-boundary=@var{num}
15761 @opindex mincoming-stack-boundary
15762 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15763 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15764 the one specified by @option{-mpreferred-stack-boundary} is used.
15766 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15767 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15768 suffer significant run time performance penalties.  On Pentium III, the
15769 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15770 properly if it is not 16-byte aligned.
15772 To ensure proper alignment of this values on the stack, the stack boundary
15773 must be as aligned as that required by any value stored on the stack.
15774 Further, every function must be generated such that it keeps the stack
15775 aligned.  Thus calling a function compiled with a higher preferred
15776 stack boundary from a function compiled with a lower preferred stack
15777 boundary most likely misaligns the stack.  It is recommended that
15778 libraries that use callbacks always use the default setting.
15780 This extra alignment does consume extra stack space, and generally
15781 increases code size.  Code that is sensitive to stack space usage, such
15782 as embedded systems and operating system kernels, may want to reduce the
15783 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15785 @item -mmmx
15786 @itemx -mno-mmx
15787 @itemx -msse
15788 @itemx -mno-sse
15789 @itemx -msse2
15790 @itemx -mno-sse2
15791 @itemx -msse3
15792 @itemx -mno-sse3
15793 @itemx -mssse3
15794 @itemx -mno-ssse3
15795 @itemx -msse4.1
15796 @need 800
15797 @itemx -mno-sse4.1
15798 @itemx -msse4.2
15799 @itemx -mno-sse4.2
15800 @itemx -msse4
15801 @itemx -mno-sse4
15802 @itemx -mavx
15803 @itemx -mno-avx
15804 @itemx -mavx2
15805 @itemx -mno-avx2
15806 @itemx -mavx512f
15807 @itemx -mno-avx512f
15808 @need 800
15809 @itemx -mavx512pf
15810 @itemx -mno-avx512pf
15811 @itemx -mavx512er
15812 @itemx -mno-avx512er
15813 @itemx -mavx512cd
15814 @itemx -mno-avx512cd
15815 @itemx -msha
15816 @itemx -mno-sha
15817 @itemx -maes
15818 @itemx -mno-aes
15819 @itemx -mpclmul
15820 @itemx -mno-pclmul
15821 @itemx -mclfushopt
15822 @itemx -mno-clflsuhopt
15823 @need 800
15824 @itemx -mfsgsbase
15825 @itemx -mno-fsgsbase
15826 @itemx -mrdrnd
15827 @itemx -mno-rdrnd
15828 @itemx -mf16c
15829 @itemx -mno-f16c
15830 @itemx -mfma
15831 @itemx -mno-fma
15832 @itemx -mprefetchwt1
15833 @itemx -mno-prefetchwt1
15834 @itemx -msse4a
15835 @itemx -mno-sse4a
15836 @itemx -mfma4
15837 @itemx -mno-fma4
15838 @need 800
15839 @itemx -mxop
15840 @itemx -mno-xop
15841 @itemx -mlwp
15842 @itemx -mno-lwp
15843 @itemx -m3dnow
15844 @itemx -mno-3dnow
15845 @itemx -mpopcnt
15846 @itemx -mno-popcnt
15847 @itemx -mabm
15848 @itemx -mno-abm
15849 @itemx -mbmi
15850 @itemx -mbmi2
15851 @itemx -mno-bmi
15852 @itemx -mno-bmi2
15853 @itemx -mlzcnt
15854 @itemx -mno-lzcnt
15855 @itemx -mfxsr
15856 @itemx -mxsave
15857 @itemx -mxsaveopt
15858 @itemx -mrtm
15859 @itemx -mtbm
15860 @itemx -mno-tbm
15861 @itemx -mxsavec
15862 @itemx -mno-xsavec
15863 @itemx -mxsaves
15864 @itemx -mno-xsaves
15865 @itemx -mmpx
15866 @itemx -mno-mpx
15867 @opindex mmmx
15868 @opindex mno-mmx
15869 @opindex msse
15870 @opindex mno-sse
15871 @opindex m3dnow
15872 @opindex mno-3dnow
15873 These switches enable or disable the use of instructions in the MMX, SSE,
15874 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15875 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15876 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
15877 extended instruction sets.
15878 These extensions are also available as built-in functions: see
15879 @ref{X86 Built-in Functions}, for details of the functions enabled and
15880 disabled by these switches.
15882 To generate SSE/SSE2 instructions automatically from floating-point
15883 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15885 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15886 generates new AVX instructions or AVX equivalence for all SSEx instructions
15887 when needed.
15889 These options enable GCC to use these extended instructions in
15890 generated code, even without @option{-mfpmath=sse}.  Applications that
15891 perform run-time CPU detection must compile separate files for each
15892 supported architecture, using the appropriate flags.  In particular,
15893 the file containing the CPU detection code should be compiled without
15894 these options.
15896 @item -mdump-tune-features
15897 @opindex mdump-tune-features
15898 This option instructs GCC to dump the names of the x86 performance 
15899 tuning features and default settings. The names can be used in 
15900 @option{-mtune-ctrl=@var{feature-list}}.
15902 @item -mtune-ctrl=@var{feature-list}
15903 @opindex mtune-ctrl=@var{feature-list}
15904 This option is used to do fine grain control of x86 code generation features.
15905 @var{feature-list} is a comma separated list of @var{feature} names. See also
15906 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15907 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15908 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15909 developers. Using it may lead to code paths not covered by testing and can
15910 potentially result in compiler ICEs or runtime errors.
15912 @item -mno-default
15913 @opindex mno-default
15914 This option instructs GCC to turn off all tunable features. See also 
15915 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15917 @item -mcld
15918 @opindex mcld
15919 This option instructs GCC to emit a @code{cld} instruction in the prologue
15920 of functions that use string instructions.  String instructions depend on
15921 the DF flag to select between autoincrement or autodecrement mode.  While the
15922 ABI specifies the DF flag to be cleared on function entry, some operating
15923 systems violate this specification by not clearing the DF flag in their
15924 exception dispatchers.  The exception handler can be invoked with the DF flag
15925 set, which leads to wrong direction mode when string instructions are used.
15926 This option can be enabled by default on 32-bit x86 targets by configuring
15927 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15928 instructions can be suppressed with the @option{-mno-cld} compiler option
15929 in this case.
15931 @item -mvzeroupper
15932 @opindex mvzeroupper
15933 This option instructs GCC to emit a @code{vzeroupper} instruction
15934 before a transfer of control flow out of the function to minimize
15935 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15936 intrinsics.
15938 @item -mprefer-avx128
15939 @opindex mprefer-avx128
15940 This option instructs GCC to use 128-bit AVX instructions instead of
15941 256-bit AVX instructions in the auto-vectorizer.
15943 @item -mcx16
15944 @opindex mcx16
15945 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15946 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15947 (or oword) data types.  
15948 This is useful for high-resolution counters that can be updated
15949 by multiple processors (or cores).  This instruction is generated as part of
15950 atomic built-in functions: see @ref{__sync Builtins} or
15951 @ref{__atomic Builtins} for details.
15953 @item -msahf
15954 @opindex msahf
15955 This option enables generation of @code{SAHF} instructions in 64-bit code.
15956 Early Intel Pentium 4 CPUs with Intel 64 support,
15957 prior to the introduction of Pentium 4 G1 step in December 2005,
15958 lacked the @code{LAHF} and @code{SAHF} instructions
15959 which were supported by AMD64.
15960 These are load and store instructions, respectively, for certain status flags.
15961 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15962 @code{drem}, and @code{remainder} built-in functions;
15963 see @ref{Other Builtins} for details.
15965 @item -mmovbe
15966 @opindex mmovbe
15967 This option enables use of the @code{movbe} instruction to implement
15968 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15970 @item -mcrc32
15971 @opindex mcrc32
15972 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15973 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15974 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15976 @item -mrecip
15977 @opindex mrecip
15978 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
15979 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
15980 with an additional Newton-Raphson step
15981 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
15982 (and their vectorized
15983 variants) for single-precision floating-point arguments.  These instructions
15984 are generated only when @option{-funsafe-math-optimizations} is enabled
15985 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
15986 Note that while the throughput of the sequence is higher than the throughput
15987 of the non-reciprocal instruction, the precision of the sequence can be
15988 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
15990 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
15991 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
15992 combination), and doesn't need @option{-mrecip}.
15994 Also note that GCC emits the above sequence with additional Newton-Raphson step
15995 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
15996 already with @option{-ffast-math} (or the above option combination), and
15997 doesn't need @option{-mrecip}.
15999 @item -mrecip=@var{opt}
16000 @opindex mrecip=opt
16001 This option controls which reciprocal estimate instructions
16002 may be used.  @var{opt} is a comma-separated list of options, which may
16003 be preceded by a @samp{!} to invert the option:
16005 @table @samp
16006 @item all
16007 Enable all estimate instructions.
16009 @item default
16010 Enable the default instructions, equivalent to @option{-mrecip}.
16012 @item none
16013 Disable all estimate instructions, equivalent to @option{-mno-recip}.
16015 @item div
16016 Enable the approximation for scalar division.
16018 @item vec-div
16019 Enable the approximation for vectorized division.
16021 @item sqrt
16022 Enable the approximation for scalar square root.
16024 @item vec-sqrt
16025 Enable the approximation for vectorized square root.
16026 @end table
16028 So, for example, @option{-mrecip=all,!sqrt} enables
16029 all of the reciprocal approximations, except for square root.
16031 @item -mveclibabi=@var{type}
16032 @opindex mveclibabi
16033 Specifies the ABI type to use for vectorizing intrinsics using an
16034 external library.  Supported values for @var{type} are @samp{svml} 
16035 for the Intel short
16036 vector math library and @samp{acml} for the AMD math core library.
16037 To use this option, both @option{-ftree-vectorize} and
16038 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
16039 ABI-compatible library must be specified at link time.
16041 GCC currently emits calls to @code{vmldExp2},
16042 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
16043 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
16044 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
16045 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
16046 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
16047 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
16048 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
16049 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
16050 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
16051 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
16052 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
16053 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
16054 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
16055 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
16056 when @option{-mveclibabi=acml} is used.  
16058 @item -mabi=@var{name}
16059 @opindex mabi
16060 Generate code for the specified calling convention.  Permissible values
16061 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
16062 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
16063 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
16064 You can control this behavior for a specific function by
16065 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
16066 @xref{Function Attributes}.
16068 @item -mtls-dialect=@var{type}
16069 @opindex mtls-dialect
16070 Generate code to access thread-local storage using the @samp{gnu} or
16071 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
16072 @samp{gnu2} is more efficient, but it may add compile- and run-time
16073 requirements that cannot be satisfied on all systems.
16075 @item -mpush-args
16076 @itemx -mno-push-args
16077 @opindex mpush-args
16078 @opindex mno-push-args
16079 Use PUSH operations to store outgoing parameters.  This method is shorter
16080 and usually equally fast as method using SUB/MOV operations and is enabled
16081 by default.  In some cases disabling it may improve performance because of
16082 improved scheduling and reduced dependencies.
16084 @item -maccumulate-outgoing-args
16085 @opindex maccumulate-outgoing-args
16086 If enabled, the maximum amount of space required for outgoing arguments is
16087 computed in the function prologue.  This is faster on most modern CPUs
16088 because of reduced dependencies, improved scheduling and reduced stack usage
16089 when the preferred stack boundary is not equal to 2.  The drawback is a notable
16090 increase in code size.  This switch implies @option{-mno-push-args}.
16092 @item -mthreads
16093 @opindex mthreads
16094 Support thread-safe exception handling on MinGW.  Programs that rely
16095 on thread-safe exception handling must compile and link all code with the
16096 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
16097 @code{-D_MT}; when linking, it links in a special thread helper library
16098 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
16100 @item -mno-align-stringops
16101 @opindex mno-align-stringops
16102 Do not align the destination of inlined string operations.  This switch reduces
16103 code size and improves performance in case the destination is already aligned,
16104 but GCC doesn't know about it.
16106 @item -minline-all-stringops
16107 @opindex minline-all-stringops
16108 By default GCC inlines string operations only when the destination is 
16109 known to be aligned to least a 4-byte boundary.  
16110 This enables more inlining and increases code
16111 size, but may improve performance of code that depends on fast
16112 @code{memcpy}, @code{strlen},
16113 and @code{memset} for short lengths.
16115 @item -minline-stringops-dynamically
16116 @opindex minline-stringops-dynamically
16117 For string operations of unknown size, use run-time checks with
16118 inline code for small blocks and a library call for large blocks.
16120 @item -mstringop-strategy=@var{alg}
16121 @opindex mstringop-strategy=@var{alg}
16122 Override the internal decision heuristic for the particular algorithm to use
16123 for inlining string operations.  The allowed values for @var{alg} are:
16125 @table @samp
16126 @item rep_byte
16127 @itemx rep_4byte
16128 @itemx rep_8byte
16129 Expand using i386 @code{rep} prefix of the specified size.
16131 @item byte_loop
16132 @itemx loop
16133 @itemx unrolled_loop
16134 Expand into an inline loop.
16136 @item libcall
16137 Always use a library call.
16138 @end table
16140 @item -mmemcpy-strategy=@var{strategy}
16141 @opindex mmemcpy-strategy=@var{strategy}
16142 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
16143 should be inlined and what inline algorithm to use when the expected size
16144 of the copy operation is known. @var{strategy} 
16145 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
16146 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
16147 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
16148 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
16149 in the list must be specified in increasing order.  The minimal byte size for 
16150 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
16151 preceding range.
16153 @item -mmemset-strategy=@var{strategy}
16154 @opindex mmemset-strategy=@var{strategy}
16155 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
16156 @code{__builtin_memset} expansion.
16158 @item -momit-leaf-frame-pointer
16159 @opindex momit-leaf-frame-pointer
16160 Don't keep the frame pointer in a register for leaf functions.  This
16161 avoids the instructions to save, set up, and restore frame pointers and
16162 makes an extra register available in leaf functions.  The option
16163 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
16164 which might make debugging harder.
16166 @item -mtls-direct-seg-refs
16167 @itemx -mno-tls-direct-seg-refs
16168 @opindex mtls-direct-seg-refs
16169 Controls whether TLS variables may be accessed with offsets from the
16170 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
16171 or whether the thread base pointer must be added.  Whether or not this
16172 is valid depends on the operating system, and whether it maps the
16173 segment to cover the entire TLS area.
16175 For systems that use the GNU C Library, the default is on.
16177 @item -msse2avx
16178 @itemx -mno-sse2avx
16179 @opindex msse2avx
16180 Specify that the assembler should encode SSE instructions with VEX
16181 prefix.  The option @option{-mavx} turns this on by default.
16183 @item -mfentry
16184 @itemx -mno-fentry
16185 @opindex mfentry
16186 If profiling is active (@option{-pg}), put the profiling
16187 counter call before the prologue.
16188 Note: On x86 architectures the attribute @code{ms_hook_prologue}
16189 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
16191 @item -mrecord-mcount
16192 @itemx -mno-record-mcount
16193 @opindex mrecord-mcount
16194 If profiling is active (@option{-pg}), generate a __mcount_loc section
16195 that contains pointers to each profiling call. This is useful for
16196 automatically patching and out calls.
16198 @item -mnop-mcount
16199 @itemx -mno-nop-mcount
16200 @opindex mnop-mcount
16201 If profiling is active (@option{-pg}), generate the calls to
16202 the profiling functions as nops. This is useful when they
16203 should be patched in later dynamically. This is likely only
16204 useful together with @option{-mrecord-mcount}.
16206 @item -m8bit-idiv
16207 @itemx -mno-8bit-idiv
16208 @opindex 8bit-idiv
16209 On some processors, like Intel Atom, 8-bit unsigned integer divide is
16210 much faster than 32-bit/64-bit integer divide.  This option generates a
16211 run-time check.  If both dividend and divisor are within range of 0
16212 to 255, 8-bit unsigned integer divide is used instead of
16213 32-bit/64-bit integer divide.
16215 @item -mavx256-split-unaligned-load
16216 @itemx -mavx256-split-unaligned-store
16217 @opindex avx256-split-unaligned-load
16218 @opindex avx256-split-unaligned-store
16219 Split 32-byte AVX unaligned load and store.
16221 @item -mstack-protector-guard=@var{guard}
16222 @opindex mstack-protector-guard=@var{guard}
16223 Generate stack protection code using canary at @var{guard}.  Supported
16224 locations are @samp{global} for global canary or @samp{tls} for per-thread
16225 canary in the TLS block (the default).  This option has effect only when
16226 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
16228 @end table
16230 These @samp{-m} switches are supported in addition to the above
16231 on x86-64 processors in 64-bit environments.
16233 @table @gcctabopt
16234 @item -m32
16235 @itemx -m64
16236 @itemx -mx32
16237 @itemx -m16
16238 @opindex m32
16239 @opindex m64
16240 @opindex mx32
16241 @opindex m16
16242 Generate code for a 16-bit, 32-bit or 64-bit environment.
16243 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
16244 to 32 bits, and
16245 generates code that runs on any i386 system.
16247 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
16248 types to 64 bits, and generates code for the x86-64 architecture.
16249 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
16250 and @option{-mdynamic-no-pic} options.
16252 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
16253 to 32 bits, and
16254 generates code for the x86-64 architecture.
16256 The @option{-m16} option is the same as @option{-m32}, except for that
16257 it outputs the @code{.code16gcc} assembly directive at the beginning of
16258 the assembly output so that the binary can run in 16-bit mode.
16260 @item -mno-red-zone
16261 @opindex mno-red-zone
16262 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
16263 by the x86-64 ABI; it is a 128-byte area beyond the location of the
16264 stack pointer that is not modified by signal or interrupt handlers
16265 and therefore can be used for temporary data without adjusting the stack
16266 pointer.  The flag @option{-mno-red-zone} disables this red zone.
16268 @item -mcmodel=small
16269 @opindex mcmodel=small
16270 Generate code for the small code model: the program and its symbols must
16271 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
16272 Programs can be statically or dynamically linked.  This is the default
16273 code model.
16275 @item -mcmodel=kernel
16276 @opindex mcmodel=kernel
16277 Generate code for the kernel code model.  The kernel runs in the
16278 negative 2 GB of the address space.
16279 This model has to be used for Linux kernel code.
16281 @item -mcmodel=medium
16282 @opindex mcmodel=medium
16283 Generate code for the medium model: the program is linked in the lower 2
16284 GB of the address space.  Small symbols are also placed there.  Symbols
16285 with sizes larger than @option{-mlarge-data-threshold} are put into
16286 large data or BSS sections and can be located above 2GB.  Programs can
16287 be statically or dynamically linked.
16289 @item -mcmodel=large
16290 @opindex mcmodel=large
16291 Generate code for the large model.  This model makes no assumptions
16292 about addresses and sizes of sections.
16294 @item -maddress-mode=long
16295 @opindex maddress-mode=long
16296 Generate code for long address mode.  This is only supported for 64-bit
16297 and x32 environments.  It is the default address mode for 64-bit
16298 environments.
16300 @item -maddress-mode=short
16301 @opindex maddress-mode=short
16302 Generate code for short address mode.  This is only supported for 32-bit
16303 and x32 environments.  It is the default address mode for 32-bit and
16304 x32 environments.
16305 @end table
16307 @node i386 and x86-64 Windows Options
16308 @subsection i386 and x86-64 Windows Options
16309 @cindex i386 and x86-64 Windows Options
16311 These additional options are available for Microsoft Windows targets:
16313 @table @gcctabopt
16314 @item -mconsole
16315 @opindex mconsole
16316 This option
16317 specifies that a console application is to be generated, by
16318 instructing the linker to set the PE header subsystem type
16319 required for console applications.
16320 This option is available for Cygwin and MinGW targets and is
16321 enabled by default on those targets.
16323 @item -mdll
16324 @opindex mdll
16325 This option is available for Cygwin and MinGW targets.  It
16326 specifies that a DLL---a dynamic link library---is to be
16327 generated, enabling the selection of the required runtime
16328 startup object and entry point.
16330 @item -mnop-fun-dllimport
16331 @opindex mnop-fun-dllimport
16332 This option is available for Cygwin and MinGW targets.  It
16333 specifies that the @code{dllimport} attribute should be ignored.
16335 @item -mthread
16336 @opindex mthread
16337 This option is available for MinGW targets. It specifies
16338 that MinGW-specific thread support is to be used.
16340 @item -municode
16341 @opindex municode
16342 This option is available for MinGW-w64 targets.  It causes
16343 the @code{UNICODE} preprocessor macro to be predefined, and
16344 chooses Unicode-capable runtime startup code.
16346 @item -mwin32
16347 @opindex mwin32
16348 This option is available for Cygwin and MinGW targets.  It
16349 specifies that the typical Microsoft Windows predefined macros are to
16350 be set in the pre-processor, but does not influence the choice
16351 of runtime library/startup code.
16353 @item -mwindows
16354 @opindex mwindows
16355 This option is available for Cygwin and MinGW targets.  It
16356 specifies that a GUI application is to be generated by
16357 instructing the linker to set the PE header subsystem type
16358 appropriately.
16360 @item -fno-set-stack-executable
16361 @opindex fno-set-stack-executable
16362 This option is available for MinGW targets. It specifies that
16363 the executable flag for the stack used by nested functions isn't
16364 set. This is necessary for binaries running in kernel mode of
16365 Microsoft Windows, as there the User32 API, which is used to set executable
16366 privileges, isn't available.
16368 @item -fwritable-relocated-rdata
16369 @opindex fno-writable-relocated-rdata
16370 This option is available for MinGW and Cygwin targets.  It specifies
16371 that relocated-data in read-only section is put into .data
16372 section.  This is a necessary for older runtimes not supporting
16373 modification of .rdata sections for pseudo-relocation.
16375 @item -mpe-aligned-commons
16376 @opindex mpe-aligned-commons
16377 This option is available for Cygwin and MinGW targets.  It
16378 specifies that the GNU extension to the PE file format that
16379 permits the correct alignment of COMMON variables should be
16380 used when generating code.  It is enabled by default if
16381 GCC detects that the target assembler found during configuration
16382 supports the feature.
16383 @end table
16385 See also under @ref{i386 and x86-64 Options} for standard options.
16387 @node IA-64 Options
16388 @subsection IA-64 Options
16389 @cindex IA-64 Options
16391 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16393 @table @gcctabopt
16394 @item -mbig-endian
16395 @opindex mbig-endian
16396 Generate code for a big-endian target.  This is the default for HP-UX@.
16398 @item -mlittle-endian
16399 @opindex mlittle-endian
16400 Generate code for a little-endian target.  This is the default for AIX5
16401 and GNU/Linux.
16403 @item -mgnu-as
16404 @itemx -mno-gnu-as
16405 @opindex mgnu-as
16406 @opindex mno-gnu-as
16407 Generate (or don't) code for the GNU assembler.  This is the default.
16408 @c Also, this is the default if the configure option @option{--with-gnu-as}
16409 @c is used.
16411 @item -mgnu-ld
16412 @itemx -mno-gnu-ld
16413 @opindex mgnu-ld
16414 @opindex mno-gnu-ld
16415 Generate (or don't) code for the GNU linker.  This is the default.
16416 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16417 @c is used.
16419 @item -mno-pic
16420 @opindex mno-pic
16421 Generate code that does not use a global pointer register.  The result
16422 is not position independent code, and violates the IA-64 ABI@.
16424 @item -mvolatile-asm-stop
16425 @itemx -mno-volatile-asm-stop
16426 @opindex mvolatile-asm-stop
16427 @opindex mno-volatile-asm-stop
16428 Generate (or don't) a stop bit immediately before and after volatile asm
16429 statements.
16431 @item -mregister-names
16432 @itemx -mno-register-names
16433 @opindex mregister-names
16434 @opindex mno-register-names
16435 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16436 the stacked registers.  This may make assembler output more readable.
16438 @item -mno-sdata
16439 @itemx -msdata
16440 @opindex mno-sdata
16441 @opindex msdata
16442 Disable (or enable) optimizations that use the small data section.  This may
16443 be useful for working around optimizer bugs.
16445 @item -mconstant-gp
16446 @opindex mconstant-gp
16447 Generate code that uses a single constant global pointer value.  This is
16448 useful when compiling kernel code.
16450 @item -mauto-pic
16451 @opindex mauto-pic
16452 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16453 This is useful when compiling firmware code.
16455 @item -minline-float-divide-min-latency
16456 @opindex minline-float-divide-min-latency
16457 Generate code for inline divides of floating-point values
16458 using the minimum latency algorithm.
16460 @item -minline-float-divide-max-throughput
16461 @opindex minline-float-divide-max-throughput
16462 Generate code for inline divides of floating-point values
16463 using the maximum throughput algorithm.
16465 @item -mno-inline-float-divide
16466 @opindex mno-inline-float-divide
16467 Do not generate inline code for divides of floating-point values.
16469 @item -minline-int-divide-min-latency
16470 @opindex minline-int-divide-min-latency
16471 Generate code for inline divides of integer values
16472 using the minimum latency algorithm.
16474 @item -minline-int-divide-max-throughput
16475 @opindex minline-int-divide-max-throughput
16476 Generate code for inline divides of integer values
16477 using the maximum throughput algorithm.
16479 @item -mno-inline-int-divide
16480 @opindex mno-inline-int-divide
16481 Do not generate inline code for divides of integer values.
16483 @item -minline-sqrt-min-latency
16484 @opindex minline-sqrt-min-latency
16485 Generate code for inline square roots
16486 using the minimum latency algorithm.
16488 @item -minline-sqrt-max-throughput
16489 @opindex minline-sqrt-max-throughput
16490 Generate code for inline square roots
16491 using the maximum throughput algorithm.
16493 @item -mno-inline-sqrt
16494 @opindex mno-inline-sqrt
16495 Do not generate inline code for @code{sqrt}.
16497 @item -mfused-madd
16498 @itemx -mno-fused-madd
16499 @opindex mfused-madd
16500 @opindex mno-fused-madd
16501 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16502 instructions.  The default is to use these instructions.
16504 @item -mno-dwarf2-asm
16505 @itemx -mdwarf2-asm
16506 @opindex mno-dwarf2-asm
16507 @opindex mdwarf2-asm
16508 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16509 info.  This may be useful when not using the GNU assembler.
16511 @item -mearly-stop-bits
16512 @itemx -mno-early-stop-bits
16513 @opindex mearly-stop-bits
16514 @opindex mno-early-stop-bits
16515 Allow stop bits to be placed earlier than immediately preceding the
16516 instruction that triggered the stop bit.  This can improve instruction
16517 scheduling, but does not always do so.
16519 @item -mfixed-range=@var{register-range}
16520 @opindex mfixed-range
16521 Generate code treating the given register range as fixed registers.
16522 A fixed register is one that the register allocator cannot use.  This is
16523 useful when compiling kernel code.  A register range is specified as
16524 two registers separated by a dash.  Multiple register ranges can be
16525 specified separated by a comma.
16527 @item -mtls-size=@var{tls-size}
16528 @opindex mtls-size
16529 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16532 @item -mtune=@var{cpu-type}
16533 @opindex mtune
16534 Tune the instruction scheduling for a particular CPU, Valid values are
16535 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16536 and @samp{mckinley}.
16538 @item -milp32
16539 @itemx -mlp64
16540 @opindex milp32
16541 @opindex mlp64
16542 Generate code for a 32-bit or 64-bit environment.
16543 The 32-bit environment sets int, long and pointer to 32 bits.
16544 The 64-bit environment sets int to 32 bits and long and pointer
16545 to 64 bits.  These are HP-UX specific flags.
16547 @item -mno-sched-br-data-spec
16548 @itemx -msched-br-data-spec
16549 @opindex mno-sched-br-data-spec
16550 @opindex msched-br-data-spec
16551 (Dis/En)able data speculative scheduling before reload.
16552 This results in generation of @code{ld.a} instructions and
16553 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16554 The default is 'disable'.
16556 @item -msched-ar-data-spec
16557 @itemx -mno-sched-ar-data-spec
16558 @opindex msched-ar-data-spec
16559 @opindex mno-sched-ar-data-spec
16560 (En/Dis)able data speculative scheduling after reload.
16561 This results in generation of @code{ld.a} instructions and
16562 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16563 The default is 'enable'.
16565 @item -mno-sched-control-spec
16566 @itemx -msched-control-spec
16567 @opindex mno-sched-control-spec
16568 @opindex msched-control-spec
16569 (Dis/En)able control speculative scheduling.  This feature is
16570 available only during region scheduling (i.e.@: before reload).
16571 This results in generation of the @code{ld.s} instructions and
16572 the corresponding check instructions @code{chk.s}.
16573 The default is 'disable'.
16575 @item -msched-br-in-data-spec
16576 @itemx -mno-sched-br-in-data-spec
16577 @opindex msched-br-in-data-spec
16578 @opindex mno-sched-br-in-data-spec
16579 (En/Dis)able speculative scheduling of the instructions that
16580 are dependent on the data speculative loads before reload.
16581 This is effective only with @option{-msched-br-data-spec} enabled.
16582 The default is 'enable'.
16584 @item -msched-ar-in-data-spec
16585 @itemx -mno-sched-ar-in-data-spec
16586 @opindex msched-ar-in-data-spec
16587 @opindex mno-sched-ar-in-data-spec
16588 (En/Dis)able speculative scheduling of the instructions that
16589 are dependent on the data speculative loads after reload.
16590 This is effective only with @option{-msched-ar-data-spec} enabled.
16591 The default is 'enable'.
16593 @item -msched-in-control-spec
16594 @itemx -mno-sched-in-control-spec
16595 @opindex msched-in-control-spec
16596 @opindex mno-sched-in-control-spec
16597 (En/Dis)able speculative scheduling of the instructions that
16598 are dependent on the control speculative loads.
16599 This is effective only with @option{-msched-control-spec} enabled.
16600 The default is 'enable'.
16602 @item -mno-sched-prefer-non-data-spec-insns
16603 @itemx -msched-prefer-non-data-spec-insns
16604 @opindex mno-sched-prefer-non-data-spec-insns
16605 @opindex msched-prefer-non-data-spec-insns
16606 If enabled, data-speculative instructions are chosen for schedule
16607 only if there are no other choices at the moment.  This makes
16608 the use of the data speculation much more conservative.
16609 The default is 'disable'.
16611 @item -mno-sched-prefer-non-control-spec-insns
16612 @itemx -msched-prefer-non-control-spec-insns
16613 @opindex mno-sched-prefer-non-control-spec-insns
16614 @opindex msched-prefer-non-control-spec-insns
16615 If enabled, control-speculative instructions are chosen for schedule
16616 only if there are no other choices at the moment.  This makes
16617 the use of the control speculation much more conservative.
16618 The default is 'disable'.
16620 @item -mno-sched-count-spec-in-critical-path
16621 @itemx -msched-count-spec-in-critical-path
16622 @opindex mno-sched-count-spec-in-critical-path
16623 @opindex msched-count-spec-in-critical-path
16624 If enabled, speculative dependencies are considered during
16625 computation of the instructions priorities.  This makes the use of the
16626 speculation a bit more conservative.
16627 The default is 'disable'.
16629 @item -msched-spec-ldc
16630 @opindex msched-spec-ldc
16631 Use a simple data speculation check.  This option is on by default.
16633 @item -msched-control-spec-ldc
16634 @opindex msched-spec-ldc
16635 Use a simple check for control speculation.  This option is on by default.
16637 @item -msched-stop-bits-after-every-cycle
16638 @opindex msched-stop-bits-after-every-cycle
16639 Place a stop bit after every cycle when scheduling.  This option is on
16640 by default.
16642 @item -msched-fp-mem-deps-zero-cost
16643 @opindex msched-fp-mem-deps-zero-cost
16644 Assume that floating-point stores and loads are not likely to cause a conflict
16645 when placed into the same instruction group.  This option is disabled by
16646 default.
16648 @item -msel-sched-dont-check-control-spec
16649 @opindex msel-sched-dont-check-control-spec
16650 Generate checks for control speculation in selective scheduling.
16651 This flag is disabled by default.
16653 @item -msched-max-memory-insns=@var{max-insns}
16654 @opindex msched-max-memory-insns
16655 Limit on the number of memory insns per instruction group, giving lower
16656 priority to subsequent memory insns attempting to schedule in the same
16657 instruction group. Frequently useful to prevent cache bank conflicts.
16658 The default value is 1.
16660 @item -msched-max-memory-insns-hard-limit
16661 @opindex msched-max-memory-insns-hard-limit
16662 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16663 disallowing more than that number in an instruction group.
16664 Otherwise, the limit is ``soft'', meaning that non-memory operations
16665 are preferred when the limit is reached, but memory operations may still
16666 be scheduled.
16668 @end table
16670 @node LM32 Options
16671 @subsection LM32 Options
16672 @cindex LM32 options
16674 These @option{-m} options are defined for the LatticeMico32 architecture:
16676 @table @gcctabopt
16677 @item -mbarrel-shift-enabled
16678 @opindex mbarrel-shift-enabled
16679 Enable barrel-shift instructions.
16681 @item -mdivide-enabled
16682 @opindex mdivide-enabled
16683 Enable divide and modulus instructions.
16685 @item -mmultiply-enabled
16686 @opindex multiply-enabled
16687 Enable multiply instructions.
16689 @item -msign-extend-enabled
16690 @opindex msign-extend-enabled
16691 Enable sign extend instructions.
16693 @item -muser-enabled
16694 @opindex muser-enabled
16695 Enable user-defined instructions.
16697 @end table
16699 @node M32C Options
16700 @subsection M32C Options
16701 @cindex M32C options
16703 @table @gcctabopt
16704 @item -mcpu=@var{name}
16705 @opindex mcpu=
16706 Select the CPU for which code is generated.  @var{name} may be one of
16707 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16708 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16709 the M32C/80 series.
16711 @item -msim
16712 @opindex msim
16713 Specifies that the program will be run on the simulator.  This causes
16714 an alternate runtime library to be linked in which supports, for
16715 example, file I/O@.  You must not use this option when generating
16716 programs that will run on real hardware; you must provide your own
16717 runtime library for whatever I/O functions are needed.
16719 @item -memregs=@var{number}
16720 @opindex memregs=
16721 Specifies the number of memory-based pseudo-registers GCC uses
16722 during code generation.  These pseudo-registers are used like real
16723 registers, so there is a tradeoff between GCC's ability to fit the
16724 code into available registers, and the performance penalty of using
16725 memory instead of registers.  Note that all modules in a program must
16726 be compiled with the same value for this option.  Because of that, you
16727 must not use this option with GCC's default runtime libraries.
16729 @end table
16731 @node M32R/D Options
16732 @subsection M32R/D Options
16733 @cindex M32R/D options
16735 These @option{-m} options are defined for Renesas M32R/D architectures:
16737 @table @gcctabopt
16738 @item -m32r2
16739 @opindex m32r2
16740 Generate code for the M32R/2@.
16742 @item -m32rx
16743 @opindex m32rx
16744 Generate code for the M32R/X@.
16746 @item -m32r
16747 @opindex m32r
16748 Generate code for the M32R@.  This is the default.
16750 @item -mmodel=small
16751 @opindex mmodel=small
16752 Assume all objects live in the lower 16MB of memory (so that their addresses
16753 can be loaded with the @code{ld24} instruction), and assume all subroutines
16754 are reachable with the @code{bl} instruction.
16755 This is the default.
16757 The addressability of a particular object can be set with the
16758 @code{model} attribute.
16760 @item -mmodel=medium
16761 @opindex mmodel=medium
16762 Assume objects may be anywhere in the 32-bit address space (the compiler
16763 generates @code{seth/add3} instructions to load their addresses), and
16764 assume all subroutines are reachable with the @code{bl} instruction.
16766 @item -mmodel=large
16767 @opindex mmodel=large
16768 Assume objects may be anywhere in the 32-bit address space (the compiler
16769 generates @code{seth/add3} instructions to load their addresses), and
16770 assume subroutines may not be reachable with the @code{bl} instruction
16771 (the compiler generates the much slower @code{seth/add3/jl}
16772 instruction sequence).
16774 @item -msdata=none
16775 @opindex msdata=none
16776 Disable use of the small data area.  Variables are put into
16777 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16778 @code{section} attribute has been specified).
16779 This is the default.
16781 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16782 Objects may be explicitly put in the small data area with the
16783 @code{section} attribute using one of these sections.
16785 @item -msdata=sdata
16786 @opindex msdata=sdata
16787 Put small global and static data in the small data area, but do not
16788 generate special code to reference them.
16790 @item -msdata=use
16791 @opindex msdata=use
16792 Put small global and static data in the small data area, and generate
16793 special instructions to reference them.
16795 @item -G @var{num}
16796 @opindex G
16797 @cindex smaller data references
16798 Put global and static objects less than or equal to @var{num} bytes
16799 into the small data or BSS sections instead of the normal data or BSS
16800 sections.  The default value of @var{num} is 8.
16801 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16802 for this option to have any effect.
16804 All modules should be compiled with the same @option{-G @var{num}} value.
16805 Compiling with different values of @var{num} may or may not work; if it
16806 doesn't the linker gives an error message---incorrect code is not
16807 generated.
16809 @item -mdebug
16810 @opindex mdebug
16811 Makes the M32R-specific code in the compiler display some statistics
16812 that might help in debugging programs.
16814 @item -malign-loops
16815 @opindex malign-loops
16816 Align all loops to a 32-byte boundary.
16818 @item -mno-align-loops
16819 @opindex mno-align-loops
16820 Do not enforce a 32-byte alignment for loops.  This is the default.
16822 @item -missue-rate=@var{number}
16823 @opindex missue-rate=@var{number}
16824 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16825 or 2.
16827 @item -mbranch-cost=@var{number}
16828 @opindex mbranch-cost=@var{number}
16829 @var{number} can only be 1 or 2.  If it is 1 then branches are
16830 preferred over conditional code, if it is 2, then the opposite applies.
16832 @item -mflush-trap=@var{number}
16833 @opindex mflush-trap=@var{number}
16834 Specifies the trap number to use to flush the cache.  The default is
16835 12.  Valid numbers are between 0 and 15 inclusive.
16837 @item -mno-flush-trap
16838 @opindex mno-flush-trap
16839 Specifies that the cache cannot be flushed by using a trap.
16841 @item -mflush-func=@var{name}
16842 @opindex mflush-func=@var{name}
16843 Specifies the name of the operating system function to call to flush
16844 the cache.  The default is @emph{_flush_cache}, but a function call
16845 is only used if a trap is not available.
16847 @item -mno-flush-func
16848 @opindex mno-flush-func
16849 Indicates that there is no OS function for flushing the cache.
16851 @end table
16853 @node M680x0 Options
16854 @subsection M680x0 Options
16855 @cindex M680x0 options
16857 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16858 The default settings depend on which architecture was selected when
16859 the compiler was configured; the defaults for the most common choices
16860 are given below.
16862 @table @gcctabopt
16863 @item -march=@var{arch}
16864 @opindex march
16865 Generate code for a specific M680x0 or ColdFire instruction set
16866 architecture.  Permissible values of @var{arch} for M680x0
16867 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16868 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16869 architectures are selected according to Freescale's ISA classification
16870 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16871 @samp{isab} and @samp{isac}.
16873 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16874 code for a ColdFire target.  The @var{arch} in this macro is one of the
16875 @option{-march} arguments given above.
16877 When used together, @option{-march} and @option{-mtune} select code
16878 that runs on a family of similar processors but that is optimized
16879 for a particular microarchitecture.
16881 @item -mcpu=@var{cpu}
16882 @opindex mcpu
16883 Generate code for a specific M680x0 or ColdFire processor.
16884 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16885 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16886 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16887 below, which also classifies the CPUs into families:
16889 @multitable @columnfractions 0.20 0.80
16890 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16891 @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}
16892 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16893 @item @samp{5206e} @tab @samp{5206e}
16894 @item @samp{5208} @tab @samp{5207} @samp{5208}
16895 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16896 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16897 @item @samp{5216} @tab @samp{5214} @samp{5216}
16898 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16899 @item @samp{5225} @tab @samp{5224} @samp{5225}
16900 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16901 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16902 @item @samp{5249} @tab @samp{5249}
16903 @item @samp{5250} @tab @samp{5250}
16904 @item @samp{5271} @tab @samp{5270} @samp{5271}
16905 @item @samp{5272} @tab @samp{5272}
16906 @item @samp{5275} @tab @samp{5274} @samp{5275}
16907 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16908 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16909 @item @samp{5307} @tab @samp{5307}
16910 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16911 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16912 @item @samp{5407} @tab @samp{5407}
16913 @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}
16914 @end multitable
16916 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16917 @var{arch} is compatible with @var{cpu}.  Other combinations of
16918 @option{-mcpu} and @option{-march} are rejected.
16920 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16921 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16922 where the value of @var{family} is given by the table above.
16924 @item -mtune=@var{tune}
16925 @opindex mtune
16926 Tune the code for a particular microarchitecture within the
16927 constraints set by @option{-march} and @option{-mcpu}.
16928 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16929 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16930 and @samp{cpu32}.  The ColdFire microarchitectures
16931 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16933 You can also use @option{-mtune=68020-40} for code that needs
16934 to run relatively well on 68020, 68030 and 68040 targets.
16935 @option{-mtune=68020-60} is similar but includes 68060 targets
16936 as well.  These two options select the same tuning decisions as
16937 @option{-m68020-40} and @option{-m68020-60} respectively.
16939 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16940 when tuning for 680x0 architecture @var{arch}.  It also defines
16941 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16942 option is used.  If GCC is tuning for a range of architectures,
16943 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16944 it defines the macros for every architecture in the range.
16946 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16947 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16948 of the arguments given above.
16950 @item -m68000
16951 @itemx -mc68000
16952 @opindex m68000
16953 @opindex mc68000
16954 Generate output for a 68000.  This is the default
16955 when the compiler is configured for 68000-based systems.
16956 It is equivalent to @option{-march=68000}.
16958 Use this option for microcontrollers with a 68000 or EC000 core,
16959 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16961 @item -m68010
16962 @opindex m68010
16963 Generate output for a 68010.  This is the default
16964 when the compiler is configured for 68010-based systems.
16965 It is equivalent to @option{-march=68010}.
16967 @item -m68020
16968 @itemx -mc68020
16969 @opindex m68020
16970 @opindex mc68020
16971 Generate output for a 68020.  This is the default
16972 when the compiler is configured for 68020-based systems.
16973 It is equivalent to @option{-march=68020}.
16975 @item -m68030
16976 @opindex m68030
16977 Generate output for a 68030.  This is the default when the compiler is
16978 configured for 68030-based systems.  It is equivalent to
16979 @option{-march=68030}.
16981 @item -m68040
16982 @opindex m68040
16983 Generate output for a 68040.  This is the default when the compiler is
16984 configured for 68040-based systems.  It is equivalent to
16985 @option{-march=68040}.
16987 This option inhibits the use of 68881/68882 instructions that have to be
16988 emulated by software on the 68040.  Use this option if your 68040 does not
16989 have code to emulate those instructions.
16991 @item -m68060
16992 @opindex m68060
16993 Generate output for a 68060.  This is the default when the compiler is
16994 configured for 68060-based systems.  It is equivalent to
16995 @option{-march=68060}.
16997 This option inhibits the use of 68020 and 68881/68882 instructions that
16998 have to be emulated by software on the 68060.  Use this option if your 68060
16999 does not have code to emulate those instructions.
17001 @item -mcpu32
17002 @opindex mcpu32
17003 Generate output for a CPU32.  This is the default
17004 when the compiler is configured for CPU32-based systems.
17005 It is equivalent to @option{-march=cpu32}.
17007 Use this option for microcontrollers with a
17008 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
17009 68336, 68340, 68341, 68349 and 68360.
17011 @item -m5200
17012 @opindex m5200
17013 Generate output for a 520X ColdFire CPU@.  This is the default
17014 when the compiler is configured for 520X-based systems.
17015 It is equivalent to @option{-mcpu=5206}, and is now deprecated
17016 in favor of that option.
17018 Use this option for microcontroller with a 5200 core, including
17019 the MCF5202, MCF5203, MCF5204 and MCF5206.
17021 @item -m5206e
17022 @opindex m5206e
17023 Generate output for a 5206e ColdFire CPU@.  The option is now
17024 deprecated in favor of the equivalent @option{-mcpu=5206e}.
17026 @item -m528x
17027 @opindex m528x
17028 Generate output for a member of the ColdFire 528X family.
17029 The option is now deprecated in favor of the equivalent
17030 @option{-mcpu=528x}.
17032 @item -m5307
17033 @opindex m5307
17034 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
17035 in favor of the equivalent @option{-mcpu=5307}.
17037 @item -m5407
17038 @opindex m5407
17039 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
17040 in favor of the equivalent @option{-mcpu=5407}.
17042 @item -mcfv4e
17043 @opindex mcfv4e
17044 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
17045 This includes use of hardware floating-point instructions.
17046 The option is equivalent to @option{-mcpu=547x}, and is now
17047 deprecated in favor of that option.
17049 @item -m68020-40
17050 @opindex m68020-40
17051 Generate output for a 68040, without using any of the new instructions.
17052 This results in code that can run relatively efficiently on either a
17053 68020/68881 or a 68030 or a 68040.  The generated code does use the
17054 68881 instructions that are emulated on the 68040.
17056 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
17058 @item -m68020-60
17059 @opindex m68020-60
17060 Generate output for a 68060, without using any of the new instructions.
17061 This results in code that can run relatively efficiently on either a
17062 68020/68881 or a 68030 or a 68040.  The generated code does use the
17063 68881 instructions that are emulated on the 68060.
17065 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
17067 @item -mhard-float
17068 @itemx -m68881
17069 @opindex mhard-float
17070 @opindex m68881
17071 Generate floating-point instructions.  This is the default for 68020
17072 and above, and for ColdFire devices that have an FPU@.  It defines the
17073 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
17074 on ColdFire targets.
17076 @item -msoft-float
17077 @opindex msoft-float
17078 Do not generate floating-point instructions; use library calls instead.
17079 This is the default for 68000, 68010, and 68832 targets.  It is also
17080 the default for ColdFire devices that have no FPU.
17082 @item -mdiv
17083 @itemx -mno-div
17084 @opindex mdiv
17085 @opindex mno-div
17086 Generate (do not generate) ColdFire hardware divide and remainder
17087 instructions.  If @option{-march} is used without @option{-mcpu},
17088 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
17089 architectures.  Otherwise, the default is taken from the target CPU
17090 (either the default CPU, or the one specified by @option{-mcpu}).  For
17091 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
17092 @option{-mcpu=5206e}.
17094 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
17096 @item -mshort
17097 @opindex mshort
17098 Consider type @code{int} to be 16 bits wide, like @code{short int}.
17099 Additionally, parameters passed on the stack are also aligned to a
17100 16-bit boundary even on targets whose API mandates promotion to 32-bit.
17102 @item -mno-short
17103 @opindex mno-short
17104 Do not consider type @code{int} to be 16 bits wide.  This is the default.
17106 @item -mnobitfield
17107 @itemx -mno-bitfield
17108 @opindex mnobitfield
17109 @opindex mno-bitfield
17110 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
17111 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
17113 @item -mbitfield
17114 @opindex mbitfield
17115 Do use the bit-field instructions.  The @option{-m68020} option implies
17116 @option{-mbitfield}.  This is the default if you use a configuration
17117 designed for a 68020.
17119 @item -mrtd
17120 @opindex mrtd
17121 Use a different function-calling convention, in which functions
17122 that take a fixed number of arguments return with the @code{rtd}
17123 instruction, which pops their arguments while returning.  This
17124 saves one instruction in the caller since there is no need to pop
17125 the arguments there.
17127 This calling convention is incompatible with the one normally
17128 used on Unix, so you cannot use it if you need to call libraries
17129 compiled with the Unix compiler.
17131 Also, you must provide function prototypes for all functions that
17132 take variable numbers of arguments (including @code{printf});
17133 otherwise incorrect code is generated for calls to those
17134 functions.
17136 In addition, seriously incorrect code results if you call a
17137 function with too many arguments.  (Normally, extra arguments are
17138 harmlessly ignored.)
17140 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
17141 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
17143 @item -mno-rtd
17144 @opindex mno-rtd
17145 Do not use the calling conventions selected by @option{-mrtd}.
17146 This is the default.
17148 @item -malign-int
17149 @itemx -mno-align-int
17150 @opindex malign-int
17151 @opindex mno-align-int
17152 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
17153 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
17154 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
17155 Aligning variables on 32-bit boundaries produces code that runs somewhat
17156 faster on processors with 32-bit busses at the expense of more memory.
17158 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
17159 aligns structures containing the above types differently than
17160 most published application binary interface specifications for the m68k.
17162 @item -mpcrel
17163 @opindex mpcrel
17164 Use the pc-relative addressing mode of the 68000 directly, instead of
17165 using a global offset table.  At present, this option implies @option{-fpic},
17166 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
17167 not presently supported with @option{-mpcrel}, though this could be supported for
17168 68020 and higher processors.
17170 @item -mno-strict-align
17171 @itemx -mstrict-align
17172 @opindex mno-strict-align
17173 @opindex mstrict-align
17174 Do not (do) assume that unaligned memory references are handled by
17175 the system.
17177 @item -msep-data
17178 Generate code that allows the data segment to be located in a different
17179 area of memory from the text segment.  This allows for execute-in-place in
17180 an environment without virtual memory management.  This option implies
17181 @option{-fPIC}.
17183 @item -mno-sep-data
17184 Generate code that assumes that the data segment follows the text segment.
17185 This is the default.
17187 @item -mid-shared-library
17188 Generate code that supports shared libraries via the library ID method.
17189 This allows for execute-in-place and shared libraries in an environment
17190 without virtual memory management.  This option implies @option{-fPIC}.
17192 @item -mno-id-shared-library
17193 Generate code that doesn't assume ID-based shared libraries are being used.
17194 This is the default.
17196 @item -mshared-library-id=n
17197 Specifies the identification number of the ID-based shared library being
17198 compiled.  Specifying a value of 0 generates more compact code; specifying
17199 other values forces the allocation of that number to the current
17200 library, but is no more space- or time-efficient than omitting this option.
17202 @item -mxgot
17203 @itemx -mno-xgot
17204 @opindex mxgot
17205 @opindex mno-xgot
17206 When generating position-independent code for ColdFire, generate code
17207 that works if the GOT has more than 8192 entries.  This code is
17208 larger and slower than code generated without this option.  On M680x0
17209 processors, this option is not needed; @option{-fPIC} suffices.
17211 GCC normally uses a single instruction to load values from the GOT@.
17212 While this is relatively efficient, it only works if the GOT
17213 is smaller than about 64k.  Anything larger causes the linker
17214 to report an error such as:
17216 @cindex relocation truncated to fit (ColdFire)
17217 @smallexample
17218 relocation truncated to fit: R_68K_GOT16O foobar
17219 @end smallexample
17221 If this happens, you should recompile your code with @option{-mxgot}.
17222 It should then work with very large GOTs.  However, code generated with
17223 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17224 the value of a global symbol.
17226 Note that some linkers, including newer versions of the GNU linker,
17227 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17228 you should only need to use @option{-mxgot} when compiling a single
17229 object file that accesses more than 8192 GOT entries.  Very few do.
17231 These options have no effect unless GCC is generating
17232 position-independent code.
17234 @end table
17236 @node MCore Options
17237 @subsection MCore Options
17238 @cindex MCore options
17240 These are the @samp{-m} options defined for the Motorola M*Core
17241 processors.
17243 @table @gcctabopt
17245 @item -mhardlit
17246 @itemx -mno-hardlit
17247 @opindex mhardlit
17248 @opindex mno-hardlit
17249 Inline constants into the code stream if it can be done in two
17250 instructions or less.
17252 @item -mdiv
17253 @itemx -mno-div
17254 @opindex mdiv
17255 @opindex mno-div
17256 Use the divide instruction.  (Enabled by default).
17258 @item -mrelax-immediate
17259 @itemx -mno-relax-immediate
17260 @opindex mrelax-immediate
17261 @opindex mno-relax-immediate
17262 Allow arbitrary-sized immediates in bit operations.
17264 @item -mwide-bitfields
17265 @itemx -mno-wide-bitfields
17266 @opindex mwide-bitfields
17267 @opindex mno-wide-bitfields
17268 Always treat bit-fields as @code{int}-sized.
17270 @item -m4byte-functions
17271 @itemx -mno-4byte-functions
17272 @opindex m4byte-functions
17273 @opindex mno-4byte-functions
17274 Force all functions to be aligned to a 4-byte boundary.
17276 @item -mcallgraph-data
17277 @itemx -mno-callgraph-data
17278 @opindex mcallgraph-data
17279 @opindex mno-callgraph-data
17280 Emit callgraph information.
17282 @item -mslow-bytes
17283 @itemx -mno-slow-bytes
17284 @opindex mslow-bytes
17285 @opindex mno-slow-bytes
17286 Prefer word access when reading byte quantities.
17288 @item -mlittle-endian
17289 @itemx -mbig-endian
17290 @opindex mlittle-endian
17291 @opindex mbig-endian
17292 Generate code for a little-endian target.
17294 @item -m210
17295 @itemx -m340
17296 @opindex m210
17297 @opindex m340
17298 Generate code for the 210 processor.
17300 @item -mno-lsim
17301 @opindex mno-lsim
17302 Assume that runtime support has been provided and so omit the
17303 simulator library (@file{libsim.a)} from the linker command line.
17305 @item -mstack-increment=@var{size}
17306 @opindex mstack-increment
17307 Set the maximum amount for a single stack increment operation.  Large
17308 values can increase the speed of programs that contain functions
17309 that need a large amount of stack space, but they can also trigger a
17310 segmentation fault if the stack is extended too much.  The default
17311 value is 0x1000.
17313 @end table
17315 @node MeP Options
17316 @subsection MeP Options
17317 @cindex MeP options
17319 @table @gcctabopt
17321 @item -mabsdiff
17322 @opindex mabsdiff
17323 Enables the @code{abs} instruction, which is the absolute difference
17324 between two registers.
17326 @item -mall-opts
17327 @opindex mall-opts
17328 Enables all the optional instructions---average, multiply, divide, bit
17329 operations, leading zero, absolute difference, min/max, clip, and
17330 saturation.
17333 @item -maverage
17334 @opindex maverage
17335 Enables the @code{ave} instruction, which computes the average of two
17336 registers.
17338 @item -mbased=@var{n}
17339 @opindex mbased=
17340 Variables of size @var{n} bytes or smaller are placed in the
17341 @code{.based} section by default.  Based variables use the @code{$tp}
17342 register as a base register, and there is a 128-byte limit to the
17343 @code{.based} section.
17345 @item -mbitops
17346 @opindex mbitops
17347 Enables the bit operation instructions---bit test (@code{btstm}), set
17348 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17349 test-and-set (@code{tas}).
17351 @item -mc=@var{name}
17352 @opindex mc=
17353 Selects which section constant data is placed in.  @var{name} may
17354 be @code{tiny}, @code{near}, or @code{far}.
17356 @item -mclip
17357 @opindex mclip
17358 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
17359 useful unless you also provide @code{-mminmax}.
17361 @item -mconfig=@var{name}
17362 @opindex mconfig=
17363 Selects one of the built-in core configurations.  Each MeP chip has
17364 one or more modules in it; each module has a core CPU and a variety of
17365 coprocessors, optional instructions, and peripherals.  The
17366 @code{MeP-Integrator} tool, not part of GCC, provides these
17367 configurations through this option; using this option is the same as
17368 using all the corresponding command-line options.  The default
17369 configuration is @code{default}.
17371 @item -mcop
17372 @opindex mcop
17373 Enables the coprocessor instructions.  By default, this is a 32-bit
17374 coprocessor.  Note that the coprocessor is normally enabled via the
17375 @code{-mconfig=} option.
17377 @item -mcop32
17378 @opindex mcop32
17379 Enables the 32-bit coprocessor's instructions.
17381 @item -mcop64
17382 @opindex mcop64
17383 Enables the 64-bit coprocessor's instructions.
17385 @item -mivc2
17386 @opindex mivc2
17387 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17389 @item -mdc
17390 @opindex mdc
17391 Causes constant variables to be placed in the @code{.near} section.
17393 @item -mdiv
17394 @opindex mdiv
17395 Enables the @code{div} and @code{divu} instructions.
17397 @item -meb
17398 @opindex meb
17399 Generate big-endian code.
17401 @item -mel
17402 @opindex mel
17403 Generate little-endian code.
17405 @item -mio-volatile
17406 @opindex mio-volatile
17407 Tells the compiler that any variable marked with the @code{io}
17408 attribute is to be considered volatile.
17410 @item -ml
17411 @opindex ml
17412 Causes variables to be assigned to the @code{.far} section by default.
17414 @item -mleadz
17415 @opindex mleadz
17416 Enables the @code{leadz} (leading zero) instruction.
17418 @item -mm
17419 @opindex mm
17420 Causes variables to be assigned to the @code{.near} section by default.
17422 @item -mminmax
17423 @opindex mminmax
17424 Enables the @code{min} and @code{max} instructions.
17426 @item -mmult
17427 @opindex mmult
17428 Enables the multiplication and multiply-accumulate instructions.
17430 @item -mno-opts
17431 @opindex mno-opts
17432 Disables all the optional instructions enabled by @code{-mall-opts}.
17434 @item -mrepeat
17435 @opindex mrepeat
17436 Enables the @code{repeat} and @code{erepeat} instructions, used for
17437 low-overhead looping.
17439 @item -ms
17440 @opindex ms
17441 Causes all variables to default to the @code{.tiny} section.  Note
17442 that there is a 65536-byte limit to this section.  Accesses to these
17443 variables use the @code{%gp} base register.
17445 @item -msatur
17446 @opindex msatur
17447 Enables the saturation instructions.  Note that the compiler does not
17448 currently generate these itself, but this option is included for
17449 compatibility with other tools, like @code{as}.
17451 @item -msdram
17452 @opindex msdram
17453 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17455 @item -msim
17456 @opindex msim
17457 Link the simulator run-time libraries.
17459 @item -msimnovec
17460 @opindex msimnovec
17461 Link the simulator runtime libraries, excluding built-in support
17462 for reset and exception vectors and tables.
17464 @item -mtf
17465 @opindex mtf
17466 Causes all functions to default to the @code{.far} section.  Without
17467 this option, functions default to the @code{.near} section.
17469 @item -mtiny=@var{n}
17470 @opindex mtiny=
17471 Variables that are @var{n} bytes or smaller are allocated to the
17472 @code{.tiny} section.  These variables use the @code{$gp} base
17473 register.  The default for this option is 4, but note that there's a
17474 65536-byte limit to the @code{.tiny} section.
17476 @end table
17478 @node MicroBlaze Options
17479 @subsection MicroBlaze Options
17480 @cindex MicroBlaze Options
17482 @table @gcctabopt
17484 @item -msoft-float
17485 @opindex msoft-float
17486 Use software emulation for floating point (default).
17488 @item -mhard-float
17489 @opindex mhard-float
17490 Use hardware floating-point instructions.
17492 @item -mmemcpy
17493 @opindex mmemcpy
17494 Do not optimize block moves, use @code{memcpy}.
17496 @item -mno-clearbss
17497 @opindex mno-clearbss
17498 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17500 @item -mcpu=@var{cpu-type}
17501 @opindex mcpu=
17502 Use features of, and schedule code for, the given CPU.
17503 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17504 where @var{X} is a major version, @var{YY} is the minor version, and
17505 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17506 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17508 @item -mxl-soft-mul
17509 @opindex mxl-soft-mul
17510 Use software multiply emulation (default).
17512 @item -mxl-soft-div
17513 @opindex mxl-soft-div
17514 Use software emulation for divides (default).
17516 @item -mxl-barrel-shift
17517 @opindex mxl-barrel-shift
17518 Use the hardware barrel shifter.
17520 @item -mxl-pattern-compare
17521 @opindex mxl-pattern-compare
17522 Use pattern compare instructions.
17524 @item -msmall-divides
17525 @opindex msmall-divides
17526 Use table lookup optimization for small signed integer divisions.
17528 @item -mxl-stack-check
17529 @opindex mxl-stack-check
17530 This option is deprecated.  Use @option{-fstack-check} instead.
17532 @item -mxl-gp-opt
17533 @opindex mxl-gp-opt
17534 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17536 @item -mxl-multiply-high
17537 @opindex mxl-multiply-high
17538 Use multiply high instructions for high part of 32x32 multiply.
17540 @item -mxl-float-convert
17541 @opindex mxl-float-convert
17542 Use hardware floating-point conversion instructions.
17544 @item -mxl-float-sqrt
17545 @opindex mxl-float-sqrt
17546 Use hardware floating-point square root instruction.
17548 @item -mbig-endian
17549 @opindex mbig-endian
17550 Generate code for a big-endian target.
17552 @item -mlittle-endian
17553 @opindex mlittle-endian
17554 Generate code for a little-endian target.
17556 @item -mxl-reorder
17557 @opindex mxl-reorder
17558 Use reorder instructions (swap and byte reversed load/store).
17560 @item -mxl-mode-@var{app-model}
17561 Select application model @var{app-model}.  Valid models are
17562 @table @samp
17563 @item executable
17564 normal executable (default), uses startup code @file{crt0.o}.
17566 @item xmdstub
17567 for use with Xilinx Microprocessor Debugger (XMD) based
17568 software intrusive debug agent called xmdstub. This uses startup file
17569 @file{crt1.o} and sets the start address of the program to 0x800.
17571 @item bootstrap
17572 for applications that are loaded using a bootloader.
17573 This model uses startup file @file{crt2.o} which does not contain a processor
17574 reset vector handler. This is suitable for transferring control on a
17575 processor reset to the bootloader rather than the application.
17577 @item novectors
17578 for applications that do not require any of the
17579 MicroBlaze vectors. This option may be useful for applications running
17580 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17581 @end table
17583 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17584 @option{-mxl-mode-@var{app-model}}.
17586 @end table
17588 @node MIPS Options
17589 @subsection MIPS Options
17590 @cindex MIPS options
17592 @table @gcctabopt
17594 @item -EB
17595 @opindex EB
17596 Generate big-endian code.
17598 @item -EL
17599 @opindex EL
17600 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17601 configurations.
17603 @item -march=@var{arch}
17604 @opindex march
17605 Generate code that runs on @var{arch}, which can be the name of a
17606 generic MIPS ISA, or the name of a particular processor.
17607 The ISA names are:
17608 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17609 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5}, 
17610 @samp{mips64}, @samp{mips64r2}, @samp{mips64r3} and @samp{mips64r5}.
17611 The processor names are:
17612 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17613 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17614 @samp{5kc}, @samp{5kf},
17615 @samp{20kc},
17616 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17617 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17618 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17619 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17620 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17621 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17622 @samp{m4k},
17623 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17624 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17625 @samp{orion},
17626 @samp{p5600},
17627 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17628 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17629 @samp{rm7000}, @samp{rm9000},
17630 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17631 @samp{sb1},
17632 @samp{sr71000},
17633 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17634 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17635 @samp{xlr} and @samp{xlp}.
17636 The special value @samp{from-abi} selects the
17637 most compatible architecture for the selected ABI (that is,
17638 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17640 The native Linux/GNU toolchain also supports the value @samp{native},
17641 which selects the best architecture option for the host processor.
17642 @option{-march=native} has no effect if GCC does not recognize
17643 the processor.
17645 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17646 (for example, @option{-march=r2k}).  Prefixes are optional, and
17647 @samp{vr} may be written @samp{r}.
17649 Names of the form @samp{@var{n}f2_1} refer to processors with
17650 FPUs clocked at half the rate of the core, names of the form
17651 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17652 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17653 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17654 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17655 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17656 accepted as synonyms for @samp{@var{n}f1_1}.
17658 GCC defines two macros based on the value of this option.  The first
17659 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17660 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17661 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17662 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17663 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17665 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17666 above.  In other words, it has the full prefix and does not
17667 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17668 the macro names the resolved architecture (either @samp{"mips1"} or
17669 @samp{"mips3"}).  It names the default architecture when no
17670 @option{-march} option is given.
17672 @item -mtune=@var{arch}
17673 @opindex mtune
17674 Optimize for @var{arch}.  Among other things, this option controls
17675 the way instructions are scheduled, and the perceived cost of arithmetic
17676 operations.  The list of @var{arch} values is the same as for
17677 @option{-march}.
17679 When this option is not used, GCC optimizes for the processor
17680 specified by @option{-march}.  By using @option{-march} and
17681 @option{-mtune} together, it is possible to generate code that
17682 runs on a family of processors, but optimize the code for one
17683 particular member of that family.
17685 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17686 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17687 @option{-march} ones described above.
17689 @item -mips1
17690 @opindex mips1
17691 Equivalent to @option{-march=mips1}.
17693 @item -mips2
17694 @opindex mips2
17695 Equivalent to @option{-march=mips2}.
17697 @item -mips3
17698 @opindex mips3
17699 Equivalent to @option{-march=mips3}.
17701 @item -mips4
17702 @opindex mips4
17703 Equivalent to @option{-march=mips4}.
17705 @item -mips32
17706 @opindex mips32
17707 Equivalent to @option{-march=mips32}.
17709 @item -mips32r3
17710 @opindex mips32r3
17711 Equivalent to @option{-march=mips32r3}.
17713 @item -mips32r5
17714 @opindex mips32r5
17715 Equivalent to @option{-march=mips32r5}.
17717 @item -mips64
17718 @opindex mips64
17719 Equivalent to @option{-march=mips64}.
17721 @item -mips64r2
17722 @opindex mips64r2
17723 Equivalent to @option{-march=mips64r2}.
17725 @item -mips64r3
17726 @opindex mips64r3
17727 Equivalent to @option{-march=mips64r3}.
17729 @item -mips64r5
17730 @opindex mips64r5
17731 Equivalent to @option{-march=mips64r5}.
17733 @item -mips16
17734 @itemx -mno-mips16
17735 @opindex mips16
17736 @opindex mno-mips16
17737 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17738 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17740 MIPS16 code generation can also be controlled on a per-function basis
17741 by means of @code{mips16} and @code{nomips16} attributes.
17742 @xref{Function Attributes}, for more information.
17744 @item -mflip-mips16
17745 @opindex mflip-mips16
17746 Generate MIPS16 code on alternating functions.  This option is provided
17747 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17748 not intended for ordinary use in compiling user code.
17750 @item -minterlink-compressed
17751 @item -mno-interlink-compressed
17752 @opindex minterlink-compressed
17753 @opindex mno-interlink-compressed
17754 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17755 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17757 For example, code using the standard ISA encoding cannot jump directly
17758 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17759 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17760 knows that the target of the jump is not compressed.
17762 @item -minterlink-mips16
17763 @itemx -mno-interlink-mips16
17764 @opindex minterlink-mips16
17765 @opindex mno-interlink-mips16
17766 Aliases of @option{-minterlink-compressed} and
17767 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17768 and are retained for backwards compatibility.
17770 @item -mabi=32
17771 @itemx -mabi=o64
17772 @itemx -mabi=n32
17773 @itemx -mabi=64
17774 @itemx -mabi=eabi
17775 @opindex mabi=32
17776 @opindex mabi=o64
17777 @opindex mabi=n32
17778 @opindex mabi=64
17779 @opindex mabi=eabi
17780 Generate code for the given ABI@.
17782 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17783 generates 64-bit code when you select a 64-bit architecture, but you
17784 can use @option{-mgp32} to get 32-bit code instead.
17786 For information about the O64 ABI, see
17787 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17789 GCC supports a variant of the o32 ABI in which floating-point registers
17790 are 64 rather than 32 bits wide.  You can select this combination with
17791 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17792 and @code{mfhc1} instructions and is therefore only supported for
17793 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17795 The register assignments for arguments and return values remain the
17796 same, but each scalar value is passed in a single 64-bit register
17797 rather than a pair of 32-bit registers.  For example, scalar
17798 floating-point values are returned in @samp{$f0} only, not a
17799 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17800 remains the same in that the even-numbered double-precision registers
17801 are saved.
17803 Two additional variants of the o32 ABI are supported to enable
17804 a transition from 32-bit to 64-bit registers.  These are FPXX
17805 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17806 The FPXX extension mandates that all code must execute correctly
17807 when run using 32-bit or 64-bit registers.  The code can be interlinked
17808 with either FP32 or FP64, but not both.
17809 The FP64A extension is similar to the FP64 extension but forbids the
17810 use of odd-numbered single-precision registers.  This can be used
17811 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17812 processors and allows both FP32 and FP64A code to interlink and
17813 run in the same process without changing FPU modes.
17815 @item -mabicalls
17816 @itemx -mno-abicalls
17817 @opindex mabicalls
17818 @opindex mno-abicalls
17819 Generate (do not generate) code that is suitable for SVR4-style
17820 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17821 systems.
17823 @item -mshared
17824 @itemx -mno-shared
17825 Generate (do not generate) code that is fully position-independent,
17826 and that can therefore be linked into shared libraries.  This option
17827 only affects @option{-mabicalls}.
17829 All @option{-mabicalls} code has traditionally been position-independent,
17830 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17831 as an extension, the GNU toolchain allows executables to use absolute
17832 accesses for locally-binding symbols.  It can also use shorter GP
17833 initialization sequences and generate direct calls to locally-defined
17834 functions.  This mode is selected by @option{-mno-shared}.
17836 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17837 objects that can only be linked by the GNU linker.  However, the option
17838 does not affect the ABI of the final executable; it only affects the ABI
17839 of relocatable objects.  Using @option{-mno-shared} generally makes
17840 executables both smaller and quicker.
17842 @option{-mshared} is the default.
17844 @item -mplt
17845 @itemx -mno-plt
17846 @opindex mplt
17847 @opindex mno-plt
17848 Assume (do not assume) that the static and dynamic linkers
17849 support PLTs and copy relocations.  This option only affects
17850 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17851 has no effect without @option{-msym32}.
17853 You can make @option{-mplt} the default by configuring
17854 GCC with @option{--with-mips-plt}.  The default is
17855 @option{-mno-plt} otherwise.
17857 @item -mxgot
17858 @itemx -mno-xgot
17859 @opindex mxgot
17860 @opindex mno-xgot
17861 Lift (do not lift) the usual restrictions on the size of the global
17862 offset table.
17864 GCC normally uses a single instruction to load values from the GOT@.
17865 While this is relatively efficient, it only works if the GOT
17866 is smaller than about 64k.  Anything larger causes the linker
17867 to report an error such as:
17869 @cindex relocation truncated to fit (MIPS)
17870 @smallexample
17871 relocation truncated to fit: R_MIPS_GOT16 foobar
17872 @end smallexample
17874 If this happens, you should recompile your code with @option{-mxgot}.
17875 This works with very large GOTs, although the code is also
17876 less efficient, since it takes three instructions to fetch the
17877 value of a global symbol.
17879 Note that some linkers can create multiple GOTs.  If you have such a
17880 linker, you should only need to use @option{-mxgot} when a single object
17881 file accesses more than 64k's worth of GOT entries.  Very few do.
17883 These options have no effect unless GCC is generating position
17884 independent code.
17886 @item -mgp32
17887 @opindex mgp32
17888 Assume that general-purpose registers are 32 bits wide.
17890 @item -mgp64
17891 @opindex mgp64
17892 Assume that general-purpose registers are 64 bits wide.
17894 @item -mfp32
17895 @opindex mfp32
17896 Assume that floating-point registers are 32 bits wide.
17898 @item -mfp64
17899 @opindex mfp64
17900 Assume that floating-point registers are 64 bits wide.
17902 @item -mfpxx
17903 @opindex mfpxx
17904 Do not assume the width of floating-point registers.
17906 @item -mhard-float
17907 @opindex mhard-float
17908 Use floating-point coprocessor instructions.
17910 @item -msoft-float
17911 @opindex msoft-float
17912 Do not use floating-point coprocessor instructions.  Implement
17913 floating-point calculations using library calls instead.
17915 @item -mno-float
17916 @opindex mno-float
17917 Equivalent to @option{-msoft-float}, but additionally asserts that the
17918 program being compiled does not perform any floating-point operations.
17919 This option is presently supported only by some bare-metal MIPS
17920 configurations, where it may select a special set of libraries
17921 that lack all floating-point support (including, for example, the
17922 floating-point @code{printf} formats).  
17923 If code compiled with @code{-mno-float} accidentally contains
17924 floating-point operations, it is likely to suffer a link-time
17925 or run-time failure.
17927 @item -msingle-float
17928 @opindex msingle-float
17929 Assume that the floating-point coprocessor only supports single-precision
17930 operations.
17932 @item -mdouble-float
17933 @opindex mdouble-float
17934 Assume that the floating-point coprocessor supports double-precision
17935 operations.  This is the default.
17937 @item -modd-spreg
17938 @itemx -mno-odd-spreg
17939 @opindex modd-spreg
17940 @opindex mno-odd-spreg
17941 Enable the use of odd-numbered single-precision floating-point registers
17942 for the o32 ABI.  This is the default for processors that are known to
17943 support these registers.  When using the o32 FPXX ABI, @code{-mno-odd-spreg}
17944 is set by default.
17946 @item -mabs=2008
17947 @itemx -mabs=legacy
17948 @opindex mabs=2008
17949 @opindex mabs=legacy
17950 These options control the treatment of the special not-a-number (NaN)
17951 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17952 @code{neg.@i{fmt}} machine instructions.
17954 By default or when the @option{-mabs=legacy} is used the legacy
17955 treatment is selected.  In this case these instructions are considered
17956 arithmetic and avoided where correct operation is required and the
17957 input operand might be a NaN.  A longer sequence of instructions that
17958 manipulate the sign bit of floating-point datum manually is used
17959 instead unless the @option{-ffinite-math-only} option has also been
17960 specified.
17962 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17963 this case these instructions are considered non-arithmetic and therefore
17964 operating correctly in all cases, including in particular where the
17965 input operand is a NaN.  These instructions are therefore always used
17966 for the respective operations.
17968 @item -mnan=2008
17969 @itemx -mnan=legacy
17970 @opindex mnan=2008
17971 @opindex mnan=legacy
17972 These options control the encoding of the special not-a-number (NaN)
17973 IEEE 754 floating-point data.
17975 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17976 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17977 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17978 by the first bit of their trailing significand field being 1.
17980 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17981 this case qNaNs are denoted by the first bit of their trailing
17982 significand field being 1, whereas sNaNs are denoted by the first bit of
17983 their trailing significand field being 0.
17985 The default is @option{-mnan=legacy} unless GCC has been configured with
17986 @option{--with-nan=2008}.
17988 @item -mllsc
17989 @itemx -mno-llsc
17990 @opindex mllsc
17991 @opindex mno-llsc
17992 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17993 implement atomic memory built-in functions.  When neither option is
17994 specified, GCC uses the instructions if the target architecture
17995 supports them.
17997 @option{-mllsc} is useful if the runtime environment can emulate the
17998 instructions and @option{-mno-llsc} can be useful when compiling for
17999 nonstandard ISAs.  You can make either option the default by
18000 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
18001 respectively.  @option{--with-llsc} is the default for some
18002 configurations; see the installation documentation for details.
18004 @item -mdsp
18005 @itemx -mno-dsp
18006 @opindex mdsp
18007 @opindex mno-dsp
18008 Use (do not use) revision 1 of the MIPS DSP ASE@.
18009 @xref{MIPS DSP Built-in Functions}.  This option defines the
18010 preprocessor macro @samp{__mips_dsp}.  It also defines
18011 @samp{__mips_dsp_rev} to 1.
18013 @item -mdspr2
18014 @itemx -mno-dspr2
18015 @opindex mdspr2
18016 @opindex mno-dspr2
18017 Use (do not use) revision 2 of the MIPS DSP ASE@.
18018 @xref{MIPS DSP Built-in Functions}.  This option defines the
18019 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
18020 It also defines @samp{__mips_dsp_rev} to 2.
18022 @item -msmartmips
18023 @itemx -mno-smartmips
18024 @opindex msmartmips
18025 @opindex mno-smartmips
18026 Use (do not use) the MIPS SmartMIPS ASE.
18028 @item -mpaired-single
18029 @itemx -mno-paired-single
18030 @opindex mpaired-single
18031 @opindex mno-paired-single
18032 Use (do not use) paired-single floating-point instructions.
18033 @xref{MIPS Paired-Single Support}.  This option requires
18034 hardware floating-point support to be enabled.
18036 @item -mdmx
18037 @itemx -mno-mdmx
18038 @opindex mdmx
18039 @opindex mno-mdmx
18040 Use (do not use) MIPS Digital Media Extension instructions.
18041 This option can only be used when generating 64-bit code and requires
18042 hardware floating-point support to be enabled.
18044 @item -mips3d
18045 @itemx -mno-mips3d
18046 @opindex mips3d
18047 @opindex mno-mips3d
18048 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
18049 The option @option{-mips3d} implies @option{-mpaired-single}.
18051 @item -mmicromips
18052 @itemx -mno-micromips
18053 @opindex mmicromips
18054 @opindex mno-mmicromips
18055 Generate (do not generate) microMIPS code.
18057 MicroMIPS code generation can also be controlled on a per-function basis
18058 by means of @code{micromips} and @code{nomicromips} attributes.
18059 @xref{Function Attributes}, for more information.
18061 @item -mmt
18062 @itemx -mno-mt
18063 @opindex mmt
18064 @opindex mno-mt
18065 Use (do not use) MT Multithreading instructions.
18067 @item -mmcu
18068 @itemx -mno-mcu
18069 @opindex mmcu
18070 @opindex mno-mcu
18071 Use (do not use) the MIPS MCU ASE instructions.
18073 @item -meva
18074 @itemx -mno-eva
18075 @opindex meva
18076 @opindex mno-eva
18077 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
18079 @item -mvirt
18080 @itemx -mno-virt
18081 @opindex mvirt
18082 @opindex mno-virt
18083 Use (do not use) the MIPS Virtualization Application Specific instructions.
18085 @item -mxpa
18086 @itemx -mno-xpa
18087 @opindex mxpa
18088 @opindex mno-xpa
18089 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
18091 @item -mlong64
18092 @opindex mlong64
18093 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
18094 an explanation of the default and the way that the pointer size is
18095 determined.
18097 @item -mlong32
18098 @opindex mlong32
18099 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
18101 The default size of @code{int}s, @code{long}s and pointers depends on
18102 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
18103 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
18104 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
18105 or the same size as integer registers, whichever is smaller.
18107 @item -msym32
18108 @itemx -mno-sym32
18109 @opindex msym32
18110 @opindex mno-sym32
18111 Assume (do not assume) that all symbols have 32-bit values, regardless
18112 of the selected ABI@.  This option is useful in combination with
18113 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
18114 to generate shorter and faster references to symbolic addresses.
18116 @item -G @var{num}
18117 @opindex G
18118 Put definitions of externally-visible data in a small data section
18119 if that data is no bigger than @var{num} bytes.  GCC can then generate
18120 more efficient accesses to the data; see @option{-mgpopt} for details.
18122 The default @option{-G} option depends on the configuration.
18124 @item -mlocal-sdata
18125 @itemx -mno-local-sdata
18126 @opindex mlocal-sdata
18127 @opindex mno-local-sdata
18128 Extend (do not extend) the @option{-G} behavior to local data too,
18129 such as to static variables in C@.  @option{-mlocal-sdata} is the
18130 default for all configurations.
18132 If the linker complains that an application is using too much small data,
18133 you might want to try rebuilding the less performance-critical parts with
18134 @option{-mno-local-sdata}.  You might also want to build large
18135 libraries with @option{-mno-local-sdata}, so that the libraries leave
18136 more room for the main program.
18138 @item -mextern-sdata
18139 @itemx -mno-extern-sdata
18140 @opindex mextern-sdata
18141 @opindex mno-extern-sdata
18142 Assume (do not assume) that externally-defined data is in
18143 a small data section if the size of that data is within the @option{-G} limit.
18144 @option{-mextern-sdata} is the default for all configurations.
18146 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
18147 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
18148 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
18149 is placed in a small data section.  If @var{Var} is defined by another
18150 module, you must either compile that module with a high-enough
18151 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
18152 definition.  If @var{Var} is common, you must link the application
18153 with a high-enough @option{-G} setting.
18155 The easiest way of satisfying these restrictions is to compile
18156 and link every module with the same @option{-G} option.  However,
18157 you may wish to build a library that supports several different
18158 small data limits.  You can do this by compiling the library with
18159 the highest supported @option{-G} setting and additionally using
18160 @option{-mno-extern-sdata} to stop the library from making assumptions
18161 about externally-defined data.
18163 @item -mgpopt
18164 @itemx -mno-gpopt
18165 @opindex mgpopt
18166 @opindex mno-gpopt
18167 Use (do not use) GP-relative accesses for symbols that are known to be
18168 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
18169 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
18170 configurations.
18172 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
18173 might not hold the value of @code{_gp}.  For example, if the code is
18174 part of a library that might be used in a boot monitor, programs that
18175 call boot monitor routines pass an unknown value in @code{$gp}.
18176 (In such situations, the boot monitor itself is usually compiled
18177 with @option{-G0}.)
18179 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
18180 @option{-mno-extern-sdata}.
18182 @item -membedded-data
18183 @itemx -mno-embedded-data
18184 @opindex membedded-data
18185 @opindex mno-embedded-data
18186 Allocate variables to the read-only data section first if possible, then
18187 next in the small data section if possible, otherwise in data.  This gives
18188 slightly slower code than the default, but reduces the amount of RAM required
18189 when executing, and thus may be preferred for some embedded systems.
18191 @item -muninit-const-in-rodata
18192 @itemx -mno-uninit-const-in-rodata
18193 @opindex muninit-const-in-rodata
18194 @opindex mno-uninit-const-in-rodata
18195 Put uninitialized @code{const} variables in the read-only data section.
18196 This option is only meaningful in conjunction with @option{-membedded-data}.
18198 @item -mcode-readable=@var{setting}
18199 @opindex mcode-readable
18200 Specify whether GCC may generate code that reads from executable sections.
18201 There are three possible settings:
18203 @table @gcctabopt
18204 @item -mcode-readable=yes
18205 Instructions may freely access executable sections.  This is the
18206 default setting.
18208 @item -mcode-readable=pcrel
18209 MIPS16 PC-relative load instructions can access executable sections,
18210 but other instructions must not do so.  This option is useful on 4KSc
18211 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
18212 It is also useful on processors that can be configured to have a dual
18213 instruction/data SRAM interface and that, like the M4K, automatically
18214 redirect PC-relative loads to the instruction RAM.
18216 @item -mcode-readable=no
18217 Instructions must not access executable sections.  This option can be
18218 useful on targets that are configured to have a dual instruction/data
18219 SRAM interface but that (unlike the M4K) do not automatically redirect
18220 PC-relative loads to the instruction RAM.
18221 @end table
18223 @item -msplit-addresses
18224 @itemx -mno-split-addresses
18225 @opindex msplit-addresses
18226 @opindex mno-split-addresses
18227 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18228 relocation operators.  This option has been superseded by
18229 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18231 @item -mexplicit-relocs
18232 @itemx -mno-explicit-relocs
18233 @opindex mexplicit-relocs
18234 @opindex mno-explicit-relocs
18235 Use (do not use) assembler relocation operators when dealing with symbolic
18236 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18237 is to use assembler macros instead.
18239 @option{-mexplicit-relocs} is the default if GCC was configured
18240 to use an assembler that supports relocation operators.
18242 @item -mcheck-zero-division
18243 @itemx -mno-check-zero-division
18244 @opindex mcheck-zero-division
18245 @opindex mno-check-zero-division
18246 Trap (do not trap) on integer division by zero.
18248 The default is @option{-mcheck-zero-division}.
18250 @item -mdivide-traps
18251 @itemx -mdivide-breaks
18252 @opindex mdivide-traps
18253 @opindex mdivide-breaks
18254 MIPS systems check for division by zero by generating either a
18255 conditional trap or a break instruction.  Using traps results in
18256 smaller code, but is only supported on MIPS II and later.  Also, some
18257 versions of the Linux kernel have a bug that prevents trap from
18258 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18259 allow conditional traps on architectures that support them and
18260 @option{-mdivide-breaks} to force the use of breaks.
18262 The default is usually @option{-mdivide-traps}, but this can be
18263 overridden at configure time using @option{--with-divide=breaks}.
18264 Divide-by-zero checks can be completely disabled using
18265 @option{-mno-check-zero-division}.
18267 @item -mmemcpy
18268 @itemx -mno-memcpy
18269 @opindex mmemcpy
18270 @opindex mno-memcpy
18271 Force (do not force) the use of @code{memcpy()} for non-trivial block
18272 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18273 most constant-sized copies.
18275 @item -mlong-calls
18276 @itemx -mno-long-calls
18277 @opindex mlong-calls
18278 @opindex mno-long-calls
18279 Disable (do not disable) use of the @code{jal} instruction.  Calling
18280 functions using @code{jal} is more efficient but requires the caller
18281 and callee to be in the same 256 megabyte segment.
18283 This option has no effect on abicalls code.  The default is
18284 @option{-mno-long-calls}.
18286 @item -mmad
18287 @itemx -mno-mad
18288 @opindex mmad
18289 @opindex mno-mad
18290 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18291 instructions, as provided by the R4650 ISA@.
18293 @item -mimadd
18294 @itemx -mno-imadd
18295 @opindex mimadd
18296 @opindex mno-imadd
18297 Enable (disable) use of the @code{madd} and @code{msub} integer
18298 instructions.  The default is @option{-mimadd} on architectures
18299 that support @code{madd} and @code{msub} except for the 74k 
18300 architecture where it was found to generate slower code.
18302 @item -mfused-madd
18303 @itemx -mno-fused-madd
18304 @opindex mfused-madd
18305 @opindex mno-fused-madd
18306 Enable (disable) use of the floating-point multiply-accumulate
18307 instructions, when they are available.  The default is
18308 @option{-mfused-madd}.
18310 On the R8000 CPU when multiply-accumulate instructions are used,
18311 the intermediate product is calculated to infinite precision
18312 and is not subject to the FCSR Flush to Zero bit.  This may be
18313 undesirable in some circumstances.  On other processors the result
18314 is numerically identical to the equivalent computation using
18315 separate multiply, add, subtract and negate instructions.
18317 @item -nocpp
18318 @opindex nocpp
18319 Tell the MIPS assembler to not run its preprocessor over user
18320 assembler files (with a @samp{.s} suffix) when assembling them.
18322 @item -mfix-24k
18323 @item -mno-fix-24k
18324 @opindex mfix-24k
18325 @opindex mno-fix-24k
18326 Work around the 24K E48 (lost data on stores during refill) errata.
18327 The workarounds are implemented by the assembler rather than by GCC@.
18329 @item -mfix-r4000
18330 @itemx -mno-fix-r4000
18331 @opindex mfix-r4000
18332 @opindex mno-fix-r4000
18333 Work around certain R4000 CPU errata:
18334 @itemize @minus
18335 @item
18336 A double-word or a variable shift may give an incorrect result if executed
18337 immediately after starting an integer division.
18338 @item
18339 A double-word or a variable shift may give an incorrect result if executed
18340 while an integer multiplication is in progress.
18341 @item
18342 An integer division may give an incorrect result if started in a delay slot
18343 of a taken branch or a jump.
18344 @end itemize
18346 @item -mfix-r4400
18347 @itemx -mno-fix-r4400
18348 @opindex mfix-r4400
18349 @opindex mno-fix-r4400
18350 Work around certain R4400 CPU errata:
18351 @itemize @minus
18352 @item
18353 A double-word or a variable shift may give an incorrect result if executed
18354 immediately after starting an integer division.
18355 @end itemize
18357 @item -mfix-r10000
18358 @itemx -mno-fix-r10000
18359 @opindex mfix-r10000
18360 @opindex mno-fix-r10000
18361 Work around certain R10000 errata:
18362 @itemize @minus
18363 @item
18364 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18365 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18366 @end itemize
18368 This option can only be used if the target architecture supports
18369 branch-likely instructions.  @option{-mfix-r10000} is the default when
18370 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18371 otherwise.
18373 @item -mfix-rm7000
18374 @itemx -mno-fix-rm7000
18375 @opindex mfix-rm7000
18376 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18377 workarounds are implemented by the assembler rather than by GCC@.
18379 @item -mfix-vr4120
18380 @itemx -mno-fix-vr4120
18381 @opindex mfix-vr4120
18382 Work around certain VR4120 errata:
18383 @itemize @minus
18384 @item
18385 @code{dmultu} does not always produce the correct result.
18386 @item
18387 @code{div} and @code{ddiv} do not always produce the correct result if one
18388 of the operands is negative.
18389 @end itemize
18390 The workarounds for the division errata rely on special functions in
18391 @file{libgcc.a}.  At present, these functions are only provided by
18392 the @code{mips64vr*-elf} configurations.
18394 Other VR4120 errata require a NOP to be inserted between certain pairs of
18395 instructions.  These errata are handled by the assembler, not by GCC itself.
18397 @item -mfix-vr4130
18398 @opindex mfix-vr4130
18399 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18400 workarounds are implemented by the assembler rather than by GCC,
18401 although GCC avoids using @code{mflo} and @code{mfhi} if the
18402 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18403 instructions are available instead.
18405 @item -mfix-sb1
18406 @itemx -mno-fix-sb1
18407 @opindex mfix-sb1
18408 Work around certain SB-1 CPU core errata.
18409 (This flag currently works around the SB-1 revision 2
18410 ``F1'' and ``F2'' floating-point errata.)
18412 @item -mr10k-cache-barrier=@var{setting}
18413 @opindex mr10k-cache-barrier
18414 Specify whether GCC should insert cache barriers to avoid the
18415 side-effects of speculation on R10K processors.
18417 In common with many processors, the R10K tries to predict the outcome
18418 of a conditional branch and speculatively executes instructions from
18419 the ``taken'' branch.  It later aborts these instructions if the
18420 predicted outcome is wrong.  However, on the R10K, even aborted
18421 instructions can have side effects.
18423 This problem only affects kernel stores and, depending on the system,
18424 kernel loads.  As an example, a speculatively-executed store may load
18425 the target memory into cache and mark the cache line as dirty, even if
18426 the store itself is later aborted.  If a DMA operation writes to the
18427 same area of memory before the ``dirty'' line is flushed, the cached
18428 data overwrites the DMA-ed data.  See the R10K processor manual
18429 for a full description, including other potential problems.
18431 One workaround is to insert cache barrier instructions before every memory
18432 access that might be speculatively executed and that might have side
18433 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18434 controls GCC's implementation of this workaround.  It assumes that
18435 aborted accesses to any byte in the following regions does not have
18436 side effects:
18438 @enumerate
18439 @item
18440 the memory occupied by the current function's stack frame;
18442 @item
18443 the memory occupied by an incoming stack argument;
18445 @item
18446 the memory occupied by an object with a link-time-constant address.
18447 @end enumerate
18449 It is the kernel's responsibility to ensure that speculative
18450 accesses to these regions are indeed safe.
18452 If the input program contains a function declaration such as:
18454 @smallexample
18455 void foo (void);
18456 @end smallexample
18458 then the implementation of @code{foo} must allow @code{j foo} and
18459 @code{jal foo} to be executed speculatively.  GCC honors this
18460 restriction for functions it compiles itself.  It expects non-GCC
18461 functions (such as hand-written assembly code) to do the same.
18463 The option has three forms:
18465 @table @gcctabopt
18466 @item -mr10k-cache-barrier=load-store
18467 Insert a cache barrier before a load or store that might be
18468 speculatively executed and that might have side effects even
18469 if aborted.
18471 @item -mr10k-cache-barrier=store
18472 Insert a cache barrier before a store that might be speculatively
18473 executed and that might have side effects even if aborted.
18475 @item -mr10k-cache-barrier=none
18476 Disable the insertion of cache barriers.  This is the default setting.
18477 @end table
18479 @item -mflush-func=@var{func}
18480 @itemx -mno-flush-func
18481 @opindex mflush-func
18482 Specifies the function to call to flush the I and D caches, or to not
18483 call any such function.  If called, the function must take the same
18484 arguments as the common @code{_flush_func()}, that is, the address of the
18485 memory range for which the cache is being flushed, the size of the
18486 memory range, and the number 3 (to flush both caches).  The default
18487 depends on the target GCC was configured for, but commonly is either
18488 @samp{_flush_func} or @samp{__cpu_flush}.
18490 @item mbranch-cost=@var{num}
18491 @opindex mbranch-cost
18492 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18493 This cost is only a heuristic and is not guaranteed to produce
18494 consistent results across releases.  A zero cost redundantly selects
18495 the default, which is based on the @option{-mtune} setting.
18497 @item -mbranch-likely
18498 @itemx -mno-branch-likely
18499 @opindex mbranch-likely
18500 @opindex mno-branch-likely
18501 Enable or disable use of Branch Likely instructions, regardless of the
18502 default for the selected architecture.  By default, Branch Likely
18503 instructions may be generated if they are supported by the selected
18504 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18505 and processors that implement those architectures; for those, Branch
18506 Likely instructions are not be generated by default because the MIPS32
18507 and MIPS64 architectures specifically deprecate their use.
18509 @item -mfp-exceptions
18510 @itemx -mno-fp-exceptions
18511 @opindex mfp-exceptions
18512 Specifies whether FP exceptions are enabled.  This affects how
18513 FP instructions are scheduled for some processors.
18514 The default is that FP exceptions are
18515 enabled.
18517 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18518 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18519 FP pipe.
18521 @item -mvr4130-align
18522 @itemx -mno-vr4130-align
18523 @opindex mvr4130-align
18524 The VR4130 pipeline is two-way superscalar, but can only issue two
18525 instructions together if the first one is 8-byte aligned.  When this
18526 option is enabled, GCC aligns pairs of instructions that it
18527 thinks should execute in parallel.
18529 This option only has an effect when optimizing for the VR4130.
18530 It normally makes code faster, but at the expense of making it bigger.
18531 It is enabled by default at optimization level @option{-O3}.
18533 @item -msynci
18534 @itemx -mno-synci
18535 @opindex msynci
18536 Enable (disable) generation of @code{synci} instructions on
18537 architectures that support it.  The @code{synci} instructions (if
18538 enabled) are generated when @code{__builtin___clear_cache()} is
18539 compiled.
18541 This option defaults to @code{-mno-synci}, but the default can be
18542 overridden by configuring with @code{--with-synci}.
18544 When compiling code for single processor systems, it is generally safe
18545 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18546 does not invalidate the instruction caches on all cores and may lead
18547 to undefined behavior.
18549 @item -mrelax-pic-calls
18550 @itemx -mno-relax-pic-calls
18551 @opindex mrelax-pic-calls
18552 Try to turn PIC calls that are normally dispatched via register
18553 @code{$25} into direct calls.  This is only possible if the linker can
18554 resolve the destination at link-time and if the destination is within
18555 range for a direct call.
18557 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18558 an assembler and a linker that support the @code{.reloc} assembly
18559 directive and @code{-mexplicit-relocs} is in effect.  With
18560 @code{-mno-explicit-relocs}, this optimization can be performed by the
18561 assembler and the linker alone without help from the compiler.
18563 @item -mmcount-ra-address
18564 @itemx -mno-mcount-ra-address
18565 @opindex mmcount-ra-address
18566 @opindex mno-mcount-ra-address
18567 Emit (do not emit) code that allows @code{_mcount} to modify the
18568 calling function's return address.  When enabled, this option extends
18569 the usual @code{_mcount} interface with a new @var{ra-address}
18570 parameter, which has type @code{intptr_t *} and is passed in register
18571 @code{$12}.  @code{_mcount} can then modify the return address by
18572 doing both of the following:
18573 @itemize
18574 @item
18575 Returning the new address in register @code{$31}.
18576 @item
18577 Storing the new address in @code{*@var{ra-address}},
18578 if @var{ra-address} is nonnull.
18579 @end itemize
18581 The default is @option{-mno-mcount-ra-address}.
18583 @end table
18585 @node MMIX Options
18586 @subsection MMIX Options
18587 @cindex MMIX Options
18589 These options are defined for the MMIX:
18591 @table @gcctabopt
18592 @item -mlibfuncs
18593 @itemx -mno-libfuncs
18594 @opindex mlibfuncs
18595 @opindex mno-libfuncs
18596 Specify that intrinsic library functions are being compiled, passing all
18597 values in registers, no matter the size.
18599 @item -mepsilon
18600 @itemx -mno-epsilon
18601 @opindex mepsilon
18602 @opindex mno-epsilon
18603 Generate floating-point comparison instructions that compare with respect
18604 to the @code{rE} epsilon register.
18606 @item -mabi=mmixware
18607 @itemx -mabi=gnu
18608 @opindex mabi=mmixware
18609 @opindex mabi=gnu
18610 Generate code that passes function parameters and return values that (in
18611 the called function) are seen as registers @code{$0} and up, as opposed to
18612 the GNU ABI which uses global registers @code{$231} and up.
18614 @item -mzero-extend
18615 @itemx -mno-zero-extend
18616 @opindex mzero-extend
18617 @opindex mno-zero-extend
18618 When reading data from memory in sizes shorter than 64 bits, use (do not
18619 use) zero-extending load instructions by default, rather than
18620 sign-extending ones.
18622 @item -mknuthdiv
18623 @itemx -mno-knuthdiv
18624 @opindex mknuthdiv
18625 @opindex mno-knuthdiv
18626 Make the result of a division yielding a remainder have the same sign as
18627 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18628 remainder follows the sign of the dividend.  Both methods are
18629 arithmetically valid, the latter being almost exclusively used.
18631 @item -mtoplevel-symbols
18632 @itemx -mno-toplevel-symbols
18633 @opindex mtoplevel-symbols
18634 @opindex mno-toplevel-symbols
18635 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18636 code can be used with the @code{PREFIX} assembly directive.
18638 @item -melf
18639 @opindex melf
18640 Generate an executable in the ELF format, rather than the default
18641 @samp{mmo} format used by the @command{mmix} simulator.
18643 @item -mbranch-predict
18644 @itemx -mno-branch-predict
18645 @opindex mbranch-predict
18646 @opindex mno-branch-predict
18647 Use (do not use) the probable-branch instructions, when static branch
18648 prediction indicates a probable branch.
18650 @item -mbase-addresses
18651 @itemx -mno-base-addresses
18652 @opindex mbase-addresses
18653 @opindex mno-base-addresses
18654 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18655 base address automatically generates a request (handled by the assembler
18656 and the linker) for a constant to be set up in a global register.  The
18657 register is used for one or more base address requests within the range 0
18658 to 255 from the value held in the register.  The generally leads to short
18659 and fast code, but the number of different data items that can be
18660 addressed is limited.  This means that a program that uses lots of static
18661 data may require @option{-mno-base-addresses}.
18663 @item -msingle-exit
18664 @itemx -mno-single-exit
18665 @opindex msingle-exit
18666 @opindex mno-single-exit
18667 Force (do not force) generated code to have a single exit point in each
18668 function.
18669 @end table
18671 @node MN10300 Options
18672 @subsection MN10300 Options
18673 @cindex MN10300 options
18675 These @option{-m} options are defined for Matsushita MN10300 architectures:
18677 @table @gcctabopt
18678 @item -mmult-bug
18679 @opindex mmult-bug
18680 Generate code to avoid bugs in the multiply instructions for the MN10300
18681 processors.  This is the default.
18683 @item -mno-mult-bug
18684 @opindex mno-mult-bug
18685 Do not generate code to avoid bugs in the multiply instructions for the
18686 MN10300 processors.
18688 @item -mam33
18689 @opindex mam33
18690 Generate code using features specific to the AM33 processor.
18692 @item -mno-am33
18693 @opindex mno-am33
18694 Do not generate code using features specific to the AM33 processor.  This
18695 is the default.
18697 @item -mam33-2
18698 @opindex mam33-2
18699 Generate code using features specific to the AM33/2.0 processor.
18701 @item -mam34
18702 @opindex mam34
18703 Generate code using features specific to the AM34 processor.
18705 @item -mtune=@var{cpu-type}
18706 @opindex mtune
18707 Use the timing characteristics of the indicated CPU type when
18708 scheduling instructions.  This does not change the targeted processor
18709 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18710 @samp{am33-2} or @samp{am34}.
18712 @item -mreturn-pointer-on-d0
18713 @opindex mreturn-pointer-on-d0
18714 When generating a function that returns a pointer, return the pointer
18715 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18716 only in @code{a0}, and attempts to call such functions without a prototype
18717 result in errors.  Note that this option is on by default; use
18718 @option{-mno-return-pointer-on-d0} to disable it.
18720 @item -mno-crt0
18721 @opindex mno-crt0
18722 Do not link in the C run-time initialization object file.
18724 @item -mrelax
18725 @opindex mrelax
18726 Indicate to the linker that it should perform a relaxation optimization pass
18727 to shorten branches, calls and absolute memory addresses.  This option only
18728 has an effect when used on the command line for the final link step.
18730 This option makes symbolic debugging impossible.
18732 @item -mliw
18733 @opindex mliw
18734 Allow the compiler to generate @emph{Long Instruction Word}
18735 instructions if the target is the @samp{AM33} or later.  This is the
18736 default.  This option defines the preprocessor macro @samp{__LIW__}.
18738 @item -mnoliw
18739 @opindex mnoliw
18740 Do not allow the compiler to generate @emph{Long Instruction Word}
18741 instructions.  This option defines the preprocessor macro
18742 @samp{__NO_LIW__}.
18744 @item -msetlb
18745 @opindex msetlb
18746 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18747 instructions if the target is the @samp{AM33} or later.  This is the
18748 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18750 @item -mnosetlb
18751 @opindex mnosetlb
18752 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18753 instructions.  This option defines the preprocessor macro
18754 @samp{__NO_SETLB__}.
18756 @end table
18758 @node Moxie Options
18759 @subsection Moxie Options
18760 @cindex Moxie Options
18762 @table @gcctabopt
18764 @item -meb
18765 @opindex meb
18766 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18767 configurations.
18769 @item -mel
18770 @opindex mel
18771 Generate little-endian code.
18773 @item -mno-crt0
18774 @opindex mno-crt0
18775 Do not link in the C run-time initialization object file.
18777 @end table
18779 @node MSP430 Options
18780 @subsection MSP430 Options
18781 @cindex MSP430 Options
18783 These options are defined for the MSP430:
18785 @table @gcctabopt
18787 @item -masm-hex
18788 @opindex masm-hex
18789 Force assembly output to always use hex constants.  Normally such
18790 constants are signed decimals, but this option is available for
18791 testsuite and/or aesthetic purposes.
18793 @item -mmcu=
18794 @opindex mmcu=
18795 Select the MCU to target.  This is used to create a C preprocessor
18796 symbol based upon the MCU name, converted to upper case and pre- and
18797 post- fixed with @code{__}.  This in turn will be used by the
18798 @code{msp430.h} header file to select an MCU specific supplimentary
18799 header file.
18801 The option also sets the ISA to use.  If the MCU name is one that is
18802 known to only support the 430 ISA then that is selected, otherwise the
18803 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18804 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18805 name will select the 430X ISA.
18807 In addition an MCU specific linker script will be added to the linker
18808 command line.  The script's name is the name of the MCU with
18809 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18810 command line will define the C preprocessor symbol @code{__XXX__} and
18811 cause the linker to search for a script called @file{xxx.ld}.
18813 This option is also passed on to the assembler.
18815 @item -mcpu=
18816 @opindex -mcpu=
18817 Specifies the ISA to use.  Accepted values are @code{msp430},
18818 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18819 @option{-mmcu=} option should be used to select the ISA.
18821 @item -msim
18822 @opindex msim
18823 Link to the simulator runtime libraries and linker script.  Overrides
18824 any scripts that would be selected by the @option{-mmcu=} option.
18826 @item -mlarge
18827 @opindex mlarge
18828 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18830 @item -msmall
18831 @opindex msmall
18832 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18834 @item -mrelax
18835 @opindex mrelax
18836 This option is passed to the assembler and linker, and allows the
18837 linker to perform certain optimizations that cannot be done until
18838 the final link.
18840 @item mhwmult=
18841 @opindex mhwmult=
18842 Describes the type of hardware multiply supported by the target.
18843 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18844 for the original 16-bit-only multiply supported by early MCUs.
18845 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18846 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18847 A value of @code{auto} can also be given.  This tells GCC to deduce
18848 the hardware multiply support based upon the MCU name provided by the
18849 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18850 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18851 default setting.
18853 Hardware multiplies are normally performed by calling a library
18854 routine.  This saves space in the generated code.  When compiling at
18855 @code{-O3} or higher however the hardware multiplier is invoked
18856 inline.  This makes for bigger, but faster code.
18858 The hardware multiply routines disable interrupts whilst running and
18859 restore the previous interrupt state when they finish.  This makes
18860 them safe to use inside interrupt handlers as well as in normal code.
18862 @item -minrt
18863 @opindex minrt
18864 Enable the use of a minimum runtime environment - no static
18865 initializers or constructors.  This is intended for memory-constrained
18866 devices.  The compiler will include special symbols in some objects
18867 that tell the linker and runtime which code fragments are required.
18869 @end table
18871 @node NDS32 Options
18872 @subsection NDS32 Options
18873 @cindex NDS32 Options
18875 These options are defined for NDS32 implementations:
18877 @table @gcctabopt
18879 @item -mbig-endian
18880 @opindex mbig-endian
18881 Generate code in big-endian mode.
18883 @item -mlittle-endian
18884 @opindex mlittle-endian
18885 Generate code in little-endian mode.
18887 @item -mreduced-regs
18888 @opindex mreduced-regs
18889 Use reduced-set registers for register allocation.
18891 @item -mfull-regs
18892 @opindex mfull-regs
18893 Use full-set registers for register allocation.
18895 @item -mcmov
18896 @opindex mcmov
18897 Generate conditional move instructions.
18899 @item -mno-cmov
18900 @opindex mno-cmov
18901 Do not generate conditional move instructions.
18903 @item -mperf-ext
18904 @opindex mperf-ext
18905 Generate performance extension instructions.
18907 @item -mno-perf-ext
18908 @opindex mno-perf-ext
18909 Do not generate performance extension instructions.
18911 @item -mv3push
18912 @opindex mv3push
18913 Generate v3 push25/pop25 instructions.
18915 @item -mno-v3push
18916 @opindex mno-v3push
18917 Do not generate v3 push25/pop25 instructions.
18919 @item -m16-bit
18920 @opindex m16-bit
18921 Generate 16-bit instructions.
18923 @item -mno-16-bit
18924 @opindex mno-16-bit
18925 Do not generate 16-bit instructions.
18927 @item -mgp-direct
18928 @opindex mgp-direct
18929 Generate GP base instructions directly.
18931 @item -mno-gp-direct
18932 @opindex mno-gp-direct
18933 Do no generate GP base instructions directly.
18935 @item -misr-vector-size=@var{num}
18936 @opindex misr-vector-size
18937 Specify the size of each interrupt vector, which must be 4 or 16.
18939 @item -mcache-block-size=@var{num}
18940 @opindex mcache-block-size
18941 Specify the size of each cache block,
18942 which must be a power of 2 between 4 and 512.
18944 @item -march=@var{arch}
18945 @opindex march
18946 Specify the name of the target architecture.
18948 @item -mforce-fp-as-gp
18949 @opindex mforce-fp-as-gp
18950 Prevent $fp being allocated during register allocation so that compiler
18951 is able to force performing fp-as-gp optimization.
18953 @item -mforbid-fp-as-gp
18954 @opindex mforbid-fp-as-gp
18955 Forbid using $fp to access static and global variables.
18956 This option strictly forbids fp-as-gp optimization
18957 regardless of @option{-mforce-fp-as-gp}.
18959 @item -mex9
18960 @opindex mex9
18961 Use special directives to guide linker doing ex9 optimization.
18963 @item -mctor-dtor
18964 @opindex mctor-dtor
18965 Enable constructor/destructor feature.
18967 @item -mrelax
18968 @opindex mrelax
18969 Guide linker to relax instructions.
18971 @end table
18973 @node Nios II Options
18974 @subsection Nios II Options
18975 @cindex Nios II options
18976 @cindex Altera Nios II options
18978 These are the options defined for the Altera Nios II processor.
18980 @table @gcctabopt
18982 @item -G @var{num}
18983 @opindex G
18984 @cindex smaller data references
18985 Put global and static objects less than or equal to @var{num} bytes
18986 into the small data or BSS sections instead of the normal data or BSS
18987 sections.  The default value of @var{num} is 8.
18989 @item -mgpopt
18990 @itemx -mno-gpopt
18991 @opindex mgpopt
18992 @opindex mno-gpopt
18993 Generate (do not generate) GP-relative accesses for objects in the
18994 small data or BSS sections.  The default is @option{-mgpopt} except
18995 when @option{-fpic} or @option{-fPIC} is specified to generate
18996 position-independent code.  Note that the Nios II ABI does not permit
18997 GP-relative accesses from shared libraries.
18999 You may need to specify @option{-mno-gpopt} explicitly when building
19000 programs that include large amounts of small data, including large
19001 GOT data sections.  In this case, the 16-bit offset for GP-relative
19002 addressing may not be large enough to allow access to the entire 
19003 small data section.
19005 @item -mel
19006 @itemx -meb
19007 @opindex mel
19008 @opindex meb
19009 Generate little-endian (default) or big-endian (experimental) code,
19010 respectively.
19012 @item -mbypass-cache
19013 @itemx -mno-bypass-cache
19014 @opindex mno-bypass-cache
19015 @opindex mbypass-cache
19016 Force all load and store instructions to always bypass cache by 
19017 using I/O variants of the instructions. The default is not to
19018 bypass the cache.
19020 @item -mno-cache-volatile 
19021 @itemx -mcache-volatile       
19022 @opindex mcache-volatile 
19023 @opindex mno-cache-volatile
19024 Volatile memory access bypass the cache using the I/O variants of 
19025 the load and store instructions. The default is not to bypass the cache.
19027 @item -mno-fast-sw-div
19028 @itemx -mfast-sw-div
19029 @opindex mno-fast-sw-div
19030 @opindex mfast-sw-div
19031 Do not use table-based fast divide for small numbers. The default 
19032 is to use the fast divide at @option{-O3} and above.
19034 @item -mno-hw-mul
19035 @itemx -mhw-mul
19036 @itemx -mno-hw-mulx
19037 @itemx -mhw-mulx
19038 @itemx -mno-hw-div
19039 @itemx -mhw-div
19040 @opindex mno-hw-mul
19041 @opindex mhw-mul
19042 @opindex mno-hw-mulx
19043 @opindex mhw-mulx
19044 @opindex mno-hw-div
19045 @opindex mhw-div
19046 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
19047 instructions by the compiler. The default is to emit @code{mul}
19048 and not emit @code{div} and @code{mulx}.
19050 @item -mcustom-@var{insn}=@var{N}
19051 @itemx -mno-custom-@var{insn}
19052 @opindex mcustom-@var{insn}
19053 @opindex mno-custom-@var{insn}
19054 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
19055 custom instruction with encoding @var{N} when generating code that uses 
19056 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
19057 instruction 253 for single-precision floating-point add operations instead
19058 of the default behavior of using a library call.
19060 The following values of @var{insn} are supported.  Except as otherwise
19061 noted, floating-point operations are expected to be implemented with
19062 normal IEEE 754 semantics and correspond directly to the C operators or the
19063 equivalent GCC built-in functions (@pxref{Other Builtins}).
19065 Single-precision floating point:
19066 @table @asis
19068 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
19069 Binary arithmetic operations.
19071 @item @samp{fnegs}
19072 Unary negation.
19074 @item @samp{fabss}
19075 Unary absolute value.
19077 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
19078 Comparison operations.
19080 @item @samp{fmins}, @samp{fmaxs}
19081 Floating-point minimum and maximum.  These instructions are only
19082 generated if @option{-ffinite-math-only} is specified.
19084 @item @samp{fsqrts}
19085 Unary square root operation.
19087 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
19088 Floating-point trigonometric and exponential functions.  These instructions
19089 are only generated if @option{-funsafe-math-optimizations} is also specified.
19091 @end table
19093 Double-precision floating point:
19094 @table @asis
19096 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
19097 Binary arithmetic operations.
19099 @item @samp{fnegd}
19100 Unary negation.
19102 @item @samp{fabsd}
19103 Unary absolute value.
19105 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
19106 Comparison operations.
19108 @item @samp{fmind}, @samp{fmaxd}
19109 Double-precision minimum and maximum.  These instructions are only
19110 generated if @option{-ffinite-math-only} is specified.
19112 @item @samp{fsqrtd}
19113 Unary square root operation.
19115 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
19116 Double-precision trigonometric and exponential functions.  These instructions
19117 are only generated if @option{-funsafe-math-optimizations} is also specified.
19119 @end table
19121 Conversions:
19122 @table @asis
19123 @item @samp{fextsd}
19124 Conversion from single precision to double precision.
19126 @item @samp{ftruncds}
19127 Conversion from double precision to single precision.
19129 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
19130 Conversion from floating point to signed or unsigned integer types, with
19131 truncation towards zero.
19133 @item @samp{round}
19134 Conversion from single-precision floating point to signed integer,
19135 rounding to the nearest integer and ties away from zero.
19136 This corresponds to the @code{__builtin_lroundf} function when
19137 @option{-fno-math-errno} is used.
19139 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
19140 Conversion from signed or unsigned integer types to floating-point types.
19142 @end table
19144 In addition, all of the following transfer instructions for internal
19145 registers X and Y must be provided to use any of the double-precision
19146 floating-point instructions.  Custom instructions taking two
19147 double-precision source operands expect the first operand in the
19148 64-bit register X.  The other operand (or only operand of a unary
19149 operation) is given to the custom arithmetic instruction with the
19150 least significant half in source register @var{src1} and the most
19151 significant half in @var{src2}.  A custom instruction that returns a
19152 double-precision result returns the most significant 32 bits in the
19153 destination register and the other half in 32-bit register Y.  
19154 GCC automatically generates the necessary code sequences to write
19155 register X and/or read register Y when double-precision floating-point
19156 instructions are used.
19158 @table @asis
19160 @item @samp{fwrx}
19161 Write @var{src1} into the least significant half of X and @var{src2} into
19162 the most significant half of X.
19164 @item @samp{fwry}
19165 Write @var{src1} into Y.
19167 @item @samp{frdxhi}, @samp{frdxlo}
19168 Read the most or least (respectively) significant half of X and store it in
19169 @var{dest}.
19171 @item @samp{frdy}
19172 Read the value of Y and store it into @var{dest}.
19173 @end table
19175 Note that you can gain more local control over generation of Nios II custom
19176 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
19177 and @code{target("no-custom-@var{insn}")} function attributes
19178 (@pxref{Function Attributes})
19179 or pragmas (@pxref{Function Specific Option Pragmas}).
19181 @item -mcustom-fpu-cfg=@var{name}
19182 @opindex mcustom-fpu-cfg
19184 This option enables a predefined, named set of custom instruction encodings
19185 (see @option{-mcustom-@var{insn}} above).  
19186 Currently, the following sets are defined:
19188 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
19189 @gccoptlist{-mcustom-fmuls=252 @gol
19190 -mcustom-fadds=253 @gol
19191 -mcustom-fsubs=254 @gol
19192 -fsingle-precision-constant}
19194 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
19195 @gccoptlist{-mcustom-fmuls=252 @gol
19196 -mcustom-fadds=253 @gol
19197 -mcustom-fsubs=254 @gol
19198 -mcustom-fdivs=255 @gol
19199 -fsingle-precision-constant}
19201 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
19202 @gccoptlist{-mcustom-floatus=243 @gol
19203 -mcustom-fixsi=244 @gol
19204 -mcustom-floatis=245 @gol
19205 -mcustom-fcmpgts=246 @gol
19206 -mcustom-fcmples=249 @gol
19207 -mcustom-fcmpeqs=250 @gol
19208 -mcustom-fcmpnes=251 @gol
19209 -mcustom-fmuls=252 @gol
19210 -mcustom-fadds=253 @gol
19211 -mcustom-fsubs=254 @gol
19212 -mcustom-fdivs=255 @gol
19213 -fsingle-precision-constant}
19215 Custom instruction assignments given by individual
19216 @option{-mcustom-@var{insn}=} options override those given by
19217 @option{-mcustom-fpu-cfg=}, regardless of the
19218 order of the options on the command line.
19220 Note that you can gain more local control over selection of a FPU
19221 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19222 function attribute (@pxref{Function Attributes})
19223 or pragma (@pxref{Function Specific Option Pragmas}).
19225 @end table
19227 These additional @samp{-m} options are available for the Altera Nios II
19228 ELF (bare-metal) target:
19230 @table @gcctabopt
19232 @item -mhal
19233 @opindex mhal
19234 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19235 startup and termination code, and is typically used in conjunction with
19236 @option{-msys-crt0=} to specify the location of the alternate startup code
19237 provided by the HAL BSP.
19239 @item -msmallc
19240 @opindex msmallc
19241 Link with a limited version of the C library, @option{-lsmallc}, rather than
19242 Newlib.
19244 @item -msys-crt0=@var{startfile}
19245 @opindex msys-crt0
19246 @var{startfile} is the file name of the startfile (crt0) to use 
19247 when linking.  This option is only useful in conjunction with @option{-mhal}.
19249 @item -msys-lib=@var{systemlib}
19250 @opindex msys-lib
19251 @var{systemlib} is the library name of the library that provides
19252 low-level system calls required by the C library,
19253 e.g. @code{read} and @code{write}.
19254 This option is typically used to link with a library provided by a HAL BSP.
19256 @end table
19258 @node PDP-11 Options
19259 @subsection PDP-11 Options
19260 @cindex PDP-11 Options
19262 These options are defined for the PDP-11:
19264 @table @gcctabopt
19265 @item -mfpu
19266 @opindex mfpu
19267 Use hardware FPP floating point.  This is the default.  (FIS floating
19268 point on the PDP-11/40 is not supported.)
19270 @item -msoft-float
19271 @opindex msoft-float
19272 Do not use hardware floating point.
19274 @item -mac0
19275 @opindex mac0
19276 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19278 @item -mno-ac0
19279 @opindex mno-ac0
19280 Return floating-point results in memory.  This is the default.
19282 @item -m40
19283 @opindex m40
19284 Generate code for a PDP-11/40.
19286 @item -m45
19287 @opindex m45
19288 Generate code for a PDP-11/45.  This is the default.
19290 @item -m10
19291 @opindex m10
19292 Generate code for a PDP-11/10.
19294 @item -mbcopy-builtin
19295 @opindex mbcopy-builtin
19296 Use inline @code{movmemhi} patterns for copying memory.  This is the
19297 default.
19299 @item -mbcopy
19300 @opindex mbcopy
19301 Do not use inline @code{movmemhi} patterns for copying memory.
19303 @item -mint16
19304 @itemx -mno-int32
19305 @opindex mint16
19306 @opindex mno-int32
19307 Use 16-bit @code{int}.  This is the default.
19309 @item -mint32
19310 @itemx -mno-int16
19311 @opindex mint32
19312 @opindex mno-int16
19313 Use 32-bit @code{int}.
19315 @item -mfloat64
19316 @itemx -mno-float32
19317 @opindex mfloat64
19318 @opindex mno-float32
19319 Use 64-bit @code{float}.  This is the default.
19321 @item -mfloat32
19322 @itemx -mno-float64
19323 @opindex mfloat32
19324 @opindex mno-float64
19325 Use 32-bit @code{float}.
19327 @item -mabshi
19328 @opindex mabshi
19329 Use @code{abshi2} pattern.  This is the default.
19331 @item -mno-abshi
19332 @opindex mno-abshi
19333 Do not use @code{abshi2} pattern.
19335 @item -mbranch-expensive
19336 @opindex mbranch-expensive
19337 Pretend that branches are expensive.  This is for experimenting with
19338 code generation only.
19340 @item -mbranch-cheap
19341 @opindex mbranch-cheap
19342 Do not pretend that branches are expensive.  This is the default.
19344 @item -munix-asm
19345 @opindex munix-asm
19346 Use Unix assembler syntax.  This is the default when configured for
19347 @samp{pdp11-*-bsd}.
19349 @item -mdec-asm
19350 @opindex mdec-asm
19351 Use DEC assembler syntax.  This is the default when configured for any
19352 PDP-11 target other than @samp{pdp11-*-bsd}.
19353 @end table
19355 @node picoChip Options
19356 @subsection picoChip Options
19357 @cindex picoChip options
19359 These @samp{-m} options are defined for picoChip implementations:
19361 @table @gcctabopt
19363 @item -mae=@var{ae_type}
19364 @opindex mcpu
19365 Set the instruction set, register set, and instruction scheduling
19366 parameters for array element type @var{ae_type}.  Supported values
19367 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19369 @option{-mae=ANY} selects a completely generic AE type.  Code
19370 generated with this option runs on any of the other AE types.  The
19371 code is not as efficient as it would be if compiled for a specific
19372 AE type, and some types of operation (e.g., multiplication) do not
19373 work properly on all types of AE.
19375 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19376 for compiled code, and is the default.
19378 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19379 option may suffer from poor performance of byte (char) manipulation,
19380 since the DSP AE does not provide hardware support for byte load/stores.
19382 @item -msymbol-as-address
19383 Enable the compiler to directly use a symbol name as an address in a
19384 load/store instruction, without first loading it into a
19385 register.  Typically, the use of this option generates larger
19386 programs, which run faster than when the option isn't used.  However, the
19387 results vary from program to program, so it is left as a user option,
19388 rather than being permanently enabled.
19390 @item -mno-inefficient-warnings
19391 Disables warnings about the generation of inefficient code.  These
19392 warnings can be generated, for example, when compiling code that
19393 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19394 no hardware support for byte-level memory operations, so all byte
19395 load/stores must be synthesized from word load/store operations.  This is
19396 inefficient and a warning is generated to indicate
19397 that you should rewrite the code to avoid byte operations, or to target
19398 an AE type that has the necessary hardware support.  This option disables
19399 these warnings.
19401 @end table
19403 @node PowerPC Options
19404 @subsection PowerPC Options
19405 @cindex PowerPC options
19407 These are listed under @xref{RS/6000 and PowerPC Options}.
19409 @node RL78 Options
19410 @subsection RL78 Options
19411 @cindex RL78 Options
19413 @table @gcctabopt
19415 @item -msim
19416 @opindex msim
19417 Links in additional target libraries to support operation within a
19418 simulator.
19420 @item -mmul=none
19421 @itemx -mmul=g13
19422 @itemx -mmul=rl78
19423 @opindex mmul
19424 Specifies the type of hardware multiplication support to be used.  The
19425 default is @code{none}, which uses software multiplication functions.
19426 The @code{g13} option is for the hardware multiply/divide peripheral
19427 only on the RL78/G13 targets.  The @code{rl78} option is for the
19428 standard hardware multiplication defined in the RL78 software manual.
19430 @item -m64bit-doubles
19431 @itemx -m32bit-doubles
19432 @opindex m64bit-doubles
19433 @opindex m32bit-doubles
19434 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19435 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19436 @option{-m32bit-doubles}.
19438 @end table
19440 @node RS/6000 and PowerPC Options
19441 @subsection IBM RS/6000 and PowerPC Options
19442 @cindex RS/6000 and PowerPC Options
19443 @cindex IBM RS/6000 and PowerPC Options
19445 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19446 @table @gcctabopt
19447 @item -mpowerpc-gpopt
19448 @itemx -mno-powerpc-gpopt
19449 @itemx -mpowerpc-gfxopt
19450 @itemx -mno-powerpc-gfxopt
19451 @need 800
19452 @itemx -mpowerpc64
19453 @itemx -mno-powerpc64
19454 @itemx -mmfcrf
19455 @itemx -mno-mfcrf
19456 @itemx -mpopcntb
19457 @itemx -mno-popcntb
19458 @itemx -mpopcntd
19459 @itemx -mno-popcntd
19460 @itemx -mfprnd
19461 @itemx -mno-fprnd
19462 @need 800
19463 @itemx -mcmpb
19464 @itemx -mno-cmpb
19465 @itemx -mmfpgpr
19466 @itemx -mno-mfpgpr
19467 @itemx -mhard-dfp
19468 @itemx -mno-hard-dfp
19469 @opindex mpowerpc-gpopt
19470 @opindex mno-powerpc-gpopt
19471 @opindex mpowerpc-gfxopt
19472 @opindex mno-powerpc-gfxopt
19473 @opindex mpowerpc64
19474 @opindex mno-powerpc64
19475 @opindex mmfcrf
19476 @opindex mno-mfcrf
19477 @opindex mpopcntb
19478 @opindex mno-popcntb
19479 @opindex mpopcntd
19480 @opindex mno-popcntd
19481 @opindex mfprnd
19482 @opindex mno-fprnd
19483 @opindex mcmpb
19484 @opindex mno-cmpb
19485 @opindex mmfpgpr
19486 @opindex mno-mfpgpr
19487 @opindex mhard-dfp
19488 @opindex mno-hard-dfp
19489 You use these options to specify which instructions are available on the
19490 processor you are using.  The default value of these options is
19491 determined when configuring GCC@.  Specifying the
19492 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19493 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19494 rather than the options listed above.
19496 Specifying @option{-mpowerpc-gpopt} allows
19497 GCC to use the optional PowerPC architecture instructions in the
19498 General Purpose group, including floating-point square root.  Specifying
19499 @option{-mpowerpc-gfxopt} allows GCC to
19500 use the optional PowerPC architecture instructions in the Graphics
19501 group, including floating-point select.
19503 The @option{-mmfcrf} option allows GCC to generate the move from
19504 condition register field instruction implemented on the POWER4
19505 processor and other processors that support the PowerPC V2.01
19506 architecture.
19507 The @option{-mpopcntb} option allows GCC to generate the popcount and
19508 double-precision FP reciprocal estimate instruction implemented on the
19509 POWER5 processor and other processors that support the PowerPC V2.02
19510 architecture.
19511 The @option{-mpopcntd} option allows GCC to generate the popcount
19512 instruction implemented on the POWER7 processor and other processors
19513 that support the PowerPC V2.06 architecture.
19514 The @option{-mfprnd} option allows GCC to generate the FP round to
19515 integer instructions implemented on the POWER5+ processor and other
19516 processors that support the PowerPC V2.03 architecture.
19517 The @option{-mcmpb} option allows GCC to generate the compare bytes
19518 instruction implemented on the POWER6 processor and other processors
19519 that support the PowerPC V2.05 architecture.
19520 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19521 general-purpose register instructions implemented on the POWER6X
19522 processor and other processors that support the extended PowerPC V2.05
19523 architecture.
19524 The @option{-mhard-dfp} option allows GCC to generate the decimal
19525 floating-point instructions implemented on some POWER processors.
19527 The @option{-mpowerpc64} option allows GCC to generate the additional
19528 64-bit instructions that are found in the full PowerPC64 architecture
19529 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19530 @option{-mno-powerpc64}.
19532 @item -mcpu=@var{cpu_type}
19533 @opindex mcpu
19534 Set architecture type, register usage, and
19535 instruction scheduling parameters for machine type @var{cpu_type}.
19536 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19537 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19538 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19539 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19540 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19541 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19542 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19543 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19544 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19545 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19546 @samp{powerpc64}, and @samp{rs64}.
19548 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19549 PowerPC and 64-bit PowerPC architecture machine
19550 types, with an appropriate, generic processor model assumed for
19551 scheduling purposes.
19553 The other options specify a specific processor.  Code generated under
19554 those options runs best on that processor, and may not run at all on
19555 others.
19557 The @option{-mcpu} options automatically enable or disable the
19558 following options:
19560 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19561 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19562 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19563 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19564 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19565 -mquad-memory -mquad-memory-atomic}
19567 The particular options set for any particular CPU varies between
19568 compiler versions, depending on what setting seems to produce optimal
19569 code for that CPU; it doesn't necessarily reflect the actual hardware's
19570 capabilities.  If you wish to set an individual option to a particular
19571 value, you may specify it after the @option{-mcpu} option, like
19572 @option{-mcpu=970 -mno-altivec}.
19574 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19575 not enabled or disabled by the @option{-mcpu} option at present because
19576 AIX does not have full support for these options.  You may still
19577 enable or disable them individually if you're sure it'll work in your
19578 environment.
19580 @item -mtune=@var{cpu_type}
19581 @opindex mtune
19582 Set the instruction scheduling parameters for machine type
19583 @var{cpu_type}, but do not set the architecture type or register usage,
19584 as @option{-mcpu=@var{cpu_type}} does.  The same
19585 values for @var{cpu_type} are used for @option{-mtune} as for
19586 @option{-mcpu}.  If both are specified, the code generated uses the
19587 architecture and registers set by @option{-mcpu}, but the
19588 scheduling parameters set by @option{-mtune}.
19590 @item -mcmodel=small
19591 @opindex mcmodel=small
19592 Generate PowerPC64 code for the small model: The TOC is limited to
19593 64k.
19595 @item -mcmodel=medium
19596 @opindex mcmodel=medium
19597 Generate PowerPC64 code for the medium model: The TOC and other static
19598 data may be up to a total of 4G in size.
19600 @item -mcmodel=large
19601 @opindex mcmodel=large
19602 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19603 in size.  Other data and code is only limited by the 64-bit address
19604 space.
19606 @item -maltivec
19607 @itemx -mno-altivec
19608 @opindex maltivec
19609 @opindex mno-altivec
19610 Generate code that uses (does not use) AltiVec instructions, and also
19611 enable the use of built-in functions that allow more direct access to
19612 the AltiVec instruction set.  You may also need to set
19613 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19614 enhancements.
19616 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19617 @option{-maltivec=be}, the element order for Altivec intrinsics such
19618 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19619 match array element order corresponding to the endianness of the
19620 target.  That is, element zero identifies the leftmost element in a
19621 vector register when targeting a big-endian platform, and identifies
19622 the rightmost element in a vector register when targeting a
19623 little-endian platform.
19625 @item -maltivec=be
19626 @opindex maltivec=be
19627 Generate Altivec instructions using big-endian element order,
19628 regardless of whether the target is big- or little-endian.  This is
19629 the default when targeting a big-endian platform.
19631 The element order is used to interpret element numbers in Altivec
19632 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19633 @code{vec_insert}.  By default, these will match array element order
19634 corresponding to the endianness for the target.
19636 @item -maltivec=le
19637 @opindex maltivec=le
19638 Generate Altivec instructions using little-endian element order,
19639 regardless of whether the target is big- or little-endian.  This is
19640 the default when targeting a little-endian platform.  This option is
19641 currently ignored when targeting a big-endian platform.
19643 The element order is used to interpret element numbers in Altivec
19644 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19645 @code{vec_insert}.  By default, these will match array element order
19646 corresponding to the endianness for the target.
19648 @item -mvrsave
19649 @itemx -mno-vrsave
19650 @opindex mvrsave
19651 @opindex mno-vrsave
19652 Generate VRSAVE instructions when generating AltiVec code.
19654 @item -mgen-cell-microcode
19655 @opindex mgen-cell-microcode
19656 Generate Cell microcode instructions.
19658 @item -mwarn-cell-microcode
19659 @opindex mwarn-cell-microcode
19660 Warn when a Cell microcode instruction is emitted.  An example
19661 of a Cell microcode instruction is a variable shift.
19663 @item -msecure-plt
19664 @opindex msecure-plt
19665 Generate code that allows @command{ld} and @command{ld.so}
19666 to build executables and shared
19667 libraries with non-executable @code{.plt} and @code{.got} sections.
19668 This is a PowerPC
19669 32-bit SYSV ABI option.
19671 @item -mbss-plt
19672 @opindex mbss-plt
19673 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19674 fills in, and
19675 requires @code{.plt} and @code{.got}
19676 sections that are both writable and executable.
19677 This is a PowerPC 32-bit SYSV ABI option.
19679 @item -misel
19680 @itemx -mno-isel
19681 @opindex misel
19682 @opindex mno-isel
19683 This switch enables or disables the generation of ISEL instructions.
19685 @item -misel=@var{yes/no}
19686 This switch has been deprecated.  Use @option{-misel} and
19687 @option{-mno-isel} instead.
19689 @item -mspe
19690 @itemx -mno-spe
19691 @opindex mspe
19692 @opindex mno-spe
19693 This switch enables or disables the generation of SPE simd
19694 instructions.
19696 @item -mpaired
19697 @itemx -mno-paired
19698 @opindex mpaired
19699 @opindex mno-paired
19700 This switch enables or disables the generation of PAIRED simd
19701 instructions.
19703 @item -mspe=@var{yes/no}
19704 This option has been deprecated.  Use @option{-mspe} and
19705 @option{-mno-spe} instead.
19707 @item -mvsx
19708 @itemx -mno-vsx
19709 @opindex mvsx
19710 @opindex mno-vsx
19711 Generate code that uses (does not use) vector/scalar (VSX)
19712 instructions, and also enable the use of built-in functions that allow
19713 more direct access to the VSX instruction set.
19715 @item -mcrypto
19716 @itemx -mno-crypto
19717 @opindex mcrypto
19718 @opindex mno-crypto
19719 Enable the use (disable) of the built-in functions that allow direct
19720 access to the cryptographic instructions that were added in version
19721 2.07 of the PowerPC ISA.
19723 @item -mdirect-move
19724 @itemx -mno-direct-move
19725 @opindex mdirect-move
19726 @opindex mno-direct-move
19727 Generate code that uses (does not use) the instructions to move data
19728 between the general purpose registers and the vector/scalar (VSX)
19729 registers that were added in version 2.07 of the PowerPC ISA.
19731 @item -mpower8-fusion
19732 @itemx -mno-power8-fusion
19733 @opindex mpower8-fusion
19734 @opindex mno-power8-fusion
19735 Generate code that keeps (does not keeps) some integer operations
19736 adjacent so that the instructions can be fused together on power8 and
19737 later processors.
19739 @item -mpower8-vector
19740 @itemx -mno-power8-vector
19741 @opindex mpower8-vector
19742 @opindex mno-power8-vector
19743 Generate code that uses (does not use) the vector and scalar
19744 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19745 enable the use of built-in functions that allow more direct access to
19746 the vector instructions.
19748 @item -mquad-memory
19749 @itemx -mno-quad-memory
19750 @opindex mquad-memory
19751 @opindex mno-quad-memory
19752 Generate code that uses (does not use) the non-atomic quad word memory
19753 instructions.  The @option{-mquad-memory} option requires use of
19754 64-bit mode.
19756 @item -mquad-memory-atomic
19757 @itemx -mno-quad-memory-atomic
19758 @opindex mquad-memory-atomic
19759 @opindex mno-quad-memory-atomic
19760 Generate code that uses (does not use) the atomic quad word memory
19761 instructions.  The @option{-mquad-memory-atomic} option requires use of
19762 64-bit mode.
19764 @item -mupper-regs-df
19765 @itemx -mno-upper-regs-df
19766 @opindex mupper-regs-df
19767 @opindex mno-upper-regs-df
19768 Generate code that uses (does not use) the scalar double precision
19769 instructions that target all 64 registers in the vector/scalar
19770 floating point register set that were added in version 2.06 of the
19771 PowerPC ISA.  The @option{-mupper-regs-df} turned on by default if you
19772 use either of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19773 @option{-mvsx} options.
19775 @item -mupper-regs-sf
19776 @itemx -mno-upper-regs-sf
19777 @opindex mupper-regs-sf
19778 @opindex mno-upper-regs-sf
19779 Generate code that uses (does not use) the scalar single precision
19780 instructions that target all 64 registers in the vector/scalar
19781 floating point register set that were added in version 2.07 of the
19782 PowerPC ISA.  The @option{-mupper-regs-sf} turned on by default if you
19783 use either of the @option{-mcpu=power8}, or @option{-mpower8-vector}
19784 options.
19786 @item -mupper-regs
19787 @itemx -mno-upper-regs
19788 @opindex mupper-regs
19789 @opindex mno-upper-regs
19790 Generate code that uses (does not use) the scalar
19791 instructions that target all 64 registers in the vector/scalar
19792 floating point register set, depending on the model of the machine.
19794 If the @option{-mno-upper-regs} option was used, it will turn off both
19795 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19797 @item -mfloat-gprs=@var{yes/single/double/no}
19798 @itemx -mfloat-gprs
19799 @opindex mfloat-gprs
19800 This switch enables or disables the generation of floating-point
19801 operations on the general-purpose registers for architectures that
19802 support it.
19804 The argument @var{yes} or @var{single} enables the use of
19805 single-precision floating-point operations.
19807 The argument @var{double} enables the use of single and
19808 double-precision floating-point operations.
19810 The argument @var{no} disables floating-point operations on the
19811 general-purpose registers.
19813 This option is currently only available on the MPC854x.
19815 @item -m32
19816 @itemx -m64
19817 @opindex m32
19818 @opindex m64
19819 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19820 targets (including GNU/Linux).  The 32-bit environment sets int, long
19821 and pointer to 32 bits and generates code that runs on any PowerPC
19822 variant.  The 64-bit environment sets int to 32 bits and long and
19823 pointer to 64 bits, and generates code for PowerPC64, as for
19824 @option{-mpowerpc64}.
19826 @item -mfull-toc
19827 @itemx -mno-fp-in-toc
19828 @itemx -mno-sum-in-toc
19829 @itemx -mminimal-toc
19830 @opindex mfull-toc
19831 @opindex mno-fp-in-toc
19832 @opindex mno-sum-in-toc
19833 @opindex mminimal-toc
19834 Modify generation of the TOC (Table Of Contents), which is created for
19835 every executable file.  The @option{-mfull-toc} option is selected by
19836 default.  In that case, GCC allocates at least one TOC entry for
19837 each unique non-automatic variable reference in your program.  GCC
19838 also places floating-point constants in the TOC@.  However, only
19839 16,384 entries are available in the TOC@.
19841 If you receive a linker error message that saying you have overflowed
19842 the available TOC space, you can reduce the amount of TOC space used
19843 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19844 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19845 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19846 generate code to calculate the sum of an address and a constant at
19847 run time instead of putting that sum into the TOC@.  You may specify one
19848 or both of these options.  Each causes GCC to produce very slightly
19849 slower and larger code at the expense of conserving TOC space.
19851 If you still run out of space in the TOC even when you specify both of
19852 these options, specify @option{-mminimal-toc} instead.  This option causes
19853 GCC to make only one TOC entry for every file.  When you specify this
19854 option, GCC produces code that is slower and larger but which
19855 uses extremely little TOC space.  You may wish to use this option
19856 only on files that contain less frequently-executed code.
19858 @item -maix64
19859 @itemx -maix32
19860 @opindex maix64
19861 @opindex maix32
19862 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19863 @code{long} type, and the infrastructure needed to support them.
19864 Specifying @option{-maix64} implies @option{-mpowerpc64},
19865 while @option{-maix32} disables the 64-bit ABI and
19866 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19868 @item -mxl-compat
19869 @itemx -mno-xl-compat
19870 @opindex mxl-compat
19871 @opindex mno-xl-compat
19872 Produce code that conforms more closely to IBM XL compiler semantics
19873 when using AIX-compatible ABI@.  Pass floating-point arguments to
19874 prototyped functions beyond the register save area (RSA) on the stack
19875 in addition to argument FPRs.  Do not assume that most significant
19876 double in 128-bit long double value is properly rounded when comparing
19877 values and converting to double.  Use XL symbol names for long double
19878 support routines.
19880 The AIX calling convention was extended but not initially documented to
19881 handle an obscure K&R C case of calling a function that takes the
19882 address of its arguments with fewer arguments than declared.  IBM XL
19883 compilers access floating-point arguments that do not fit in the
19884 RSA from the stack when a subroutine is compiled without
19885 optimization.  Because always storing floating-point arguments on the
19886 stack is inefficient and rarely needed, this option is not enabled by
19887 default and only is necessary when calling subroutines compiled by IBM
19888 XL compilers without optimization.
19890 @item -mpe
19891 @opindex mpe
19892 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19893 application written to use message passing with special startup code to
19894 enable the application to run.  The system must have PE installed in the
19895 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19896 must be overridden with the @option{-specs=} option to specify the
19897 appropriate directory location.  The Parallel Environment does not
19898 support threads, so the @option{-mpe} option and the @option{-pthread}
19899 option are incompatible.
19901 @item -malign-natural
19902 @itemx -malign-power
19903 @opindex malign-natural
19904 @opindex malign-power
19905 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19906 @option{-malign-natural} overrides the ABI-defined alignment of larger
19907 types, such as floating-point doubles, on their natural size-based boundary.
19908 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19909 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19911 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19912 is not supported.
19914 @item -msoft-float
19915 @itemx -mhard-float
19916 @opindex msoft-float
19917 @opindex mhard-float
19918 Generate code that does not use (uses) the floating-point register set.
19919 Software floating-point emulation is provided if you use the
19920 @option{-msoft-float} option, and pass the option to GCC when linking.
19922 @item -msingle-float
19923 @itemx -mdouble-float
19924 @opindex msingle-float
19925 @opindex mdouble-float
19926 Generate code for single- or double-precision floating-point operations.
19927 @option{-mdouble-float} implies @option{-msingle-float}.
19929 @item -msimple-fpu
19930 @opindex msimple-fpu
19931 Do not generate @code{sqrt} and @code{div} instructions for hardware
19932 floating-point unit.
19934 @item -mfpu=@var{name}
19935 @opindex mfpu
19936 Specify type of floating-point unit.  Valid values for @var{name} are
19937 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19938 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19939 @samp{sp_full} (equivalent to @option{-msingle-float}),
19940 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19942 @item -mxilinx-fpu
19943 @opindex mxilinx-fpu
19944 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19946 @item -mmultiple
19947 @itemx -mno-multiple
19948 @opindex mmultiple
19949 @opindex mno-multiple
19950 Generate code that uses (does not use) the load multiple word
19951 instructions and the store multiple word instructions.  These
19952 instructions are generated by default on POWER systems, and not
19953 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19954 PowerPC systems, since those instructions do not work when the
19955 processor is in little-endian mode.  The exceptions are PPC740 and
19956 PPC750 which permit these instructions in little-endian mode.
19958 @item -mstring
19959 @itemx -mno-string
19960 @opindex mstring
19961 @opindex mno-string
19962 Generate code that uses (does not use) the load string instructions
19963 and the store string word instructions to save multiple registers and
19964 do small block moves.  These instructions are generated by default on
19965 POWER systems, and not generated on PowerPC systems.  Do not use
19966 @option{-mstring} on little-endian PowerPC systems, since those
19967 instructions do not work when the processor is in little-endian mode.
19968 The exceptions are PPC740 and PPC750 which permit these instructions
19969 in little-endian mode.
19971 @item -mupdate
19972 @itemx -mno-update
19973 @opindex mupdate
19974 @opindex mno-update
19975 Generate code that uses (does not use) the load or store instructions
19976 that update the base register to the address of the calculated memory
19977 location.  These instructions are generated by default.  If you use
19978 @option{-mno-update}, there is a small window between the time that the
19979 stack pointer is updated and the address of the previous frame is
19980 stored, which means code that walks the stack frame across interrupts or
19981 signals may get corrupted data.
19983 @item -mavoid-indexed-addresses
19984 @itemx -mno-avoid-indexed-addresses
19985 @opindex mavoid-indexed-addresses
19986 @opindex mno-avoid-indexed-addresses
19987 Generate code that tries to avoid (not avoid) the use of indexed load
19988 or store instructions. These instructions can incur a performance
19989 penalty on Power6 processors in certain situations, such as when
19990 stepping through large arrays that cross a 16M boundary.  This option
19991 is enabled by default when targeting Power6 and disabled otherwise.
19993 @item -mfused-madd
19994 @itemx -mno-fused-madd
19995 @opindex mfused-madd
19996 @opindex mno-fused-madd
19997 Generate code that uses (does not use) the floating-point multiply and
19998 accumulate instructions.  These instructions are generated by default
19999 if hardware floating point is used.  The machine-dependent
20000 @option{-mfused-madd} option is now mapped to the machine-independent
20001 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20002 mapped to @option{-ffp-contract=off}.
20004 @item -mmulhw
20005 @itemx -mno-mulhw
20006 @opindex mmulhw
20007 @opindex mno-mulhw
20008 Generate code that uses (does not use) the half-word multiply and
20009 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
20010 These instructions are generated by default when targeting those
20011 processors.
20013 @item -mdlmzb
20014 @itemx -mno-dlmzb
20015 @opindex mdlmzb
20016 @opindex mno-dlmzb
20017 Generate code that uses (does not use) the string-search @samp{dlmzb}
20018 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
20019 generated by default when targeting those processors.
20021 @item -mno-bit-align
20022 @itemx -mbit-align
20023 @opindex mno-bit-align
20024 @opindex mbit-align
20025 On System V.4 and embedded PowerPC systems do not (do) force structures
20026 and unions that contain bit-fields to be aligned to the base type of the
20027 bit-field.
20029 For example, by default a structure containing nothing but 8
20030 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
20031 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
20032 the structure is aligned to a 1-byte boundary and is 1 byte in
20033 size.
20035 @item -mno-strict-align
20036 @itemx -mstrict-align
20037 @opindex mno-strict-align
20038 @opindex mstrict-align
20039 On System V.4 and embedded PowerPC systems do not (do) assume that
20040 unaligned memory references are handled by the system.
20042 @item -mrelocatable
20043 @itemx -mno-relocatable
20044 @opindex mrelocatable
20045 @opindex mno-relocatable
20046 Generate code that allows (does not allow) a static executable to be
20047 relocated to a different address at run time.  A simple embedded
20048 PowerPC system loader should relocate the entire contents of
20049 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
20050 a table of 32-bit addresses generated by this option.  For this to
20051 work, all objects linked together must be compiled with
20052 @option{-mrelocatable} or @option{-mrelocatable-lib}.
20053 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
20055 @item -mrelocatable-lib
20056 @itemx -mno-relocatable-lib
20057 @opindex mrelocatable-lib
20058 @opindex mno-relocatable-lib
20059 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
20060 @code{.fixup} section to allow static executables to be relocated at
20061 run time, but @option{-mrelocatable-lib} does not use the smaller stack
20062 alignment of @option{-mrelocatable}.  Objects compiled with
20063 @option{-mrelocatable-lib} may be linked with objects compiled with
20064 any combination of the @option{-mrelocatable} options.
20066 @item -mno-toc
20067 @itemx -mtoc
20068 @opindex mno-toc
20069 @opindex mtoc
20070 On System V.4 and embedded PowerPC systems do not (do) assume that
20071 register 2 contains a pointer to a global area pointing to the addresses
20072 used in the program.
20074 @item -mlittle
20075 @itemx -mlittle-endian
20076 @opindex mlittle
20077 @opindex mlittle-endian
20078 On System V.4 and embedded PowerPC systems compile code for the
20079 processor in little-endian mode.  The @option{-mlittle-endian} option is
20080 the same as @option{-mlittle}.
20082 @item -mbig
20083 @itemx -mbig-endian
20084 @opindex mbig
20085 @opindex mbig-endian
20086 On System V.4 and embedded PowerPC systems compile code for the
20087 processor in big-endian mode.  The @option{-mbig-endian} option is
20088 the same as @option{-mbig}.
20090 @item -mdynamic-no-pic
20091 @opindex mdynamic-no-pic
20092 On Darwin and Mac OS X systems, compile code so that it is not
20093 relocatable, but that its external references are relocatable.  The
20094 resulting code is suitable for applications, but not shared
20095 libraries.
20097 @item -msingle-pic-base
20098 @opindex msingle-pic-base
20099 Treat the register used for PIC addressing as read-only, rather than
20100 loading it in the prologue for each function.  The runtime system is
20101 responsible for initializing this register with an appropriate value
20102 before execution begins.
20104 @item -mprioritize-restricted-insns=@var{priority}
20105 @opindex mprioritize-restricted-insns
20106 This option controls the priority that is assigned to
20107 dispatch-slot restricted instructions during the second scheduling
20108 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
20109 or @samp{2} to assign no, highest, or second-highest (respectively) 
20110 priority to dispatch-slot restricted
20111 instructions.
20113 @item -msched-costly-dep=@var{dependence_type}
20114 @opindex msched-costly-dep
20115 This option controls which dependences are considered costly
20116 by the target during instruction scheduling.  The argument
20117 @var{dependence_type} takes one of the following values:
20119 @table @asis
20120 @item @samp{no}
20121 No dependence is costly.
20123 @item @samp{all}
20124 All dependences are costly.
20126 @item @samp{true_store_to_load}
20127 A true dependence from store to load is costly.
20129 @item @samp{store_to_load}
20130 Any dependence from store to load is costly.
20132 @item @var{number}
20133 Any dependence for which the latency is greater than or equal to 
20134 @var{number} is costly.
20135 @end table
20137 @item -minsert-sched-nops=@var{scheme}
20138 @opindex minsert-sched-nops
20139 This option controls which NOP insertion scheme is used during
20140 the second scheduling pass.  The argument @var{scheme} takes one of the
20141 following values:
20143 @table @asis
20144 @item @samp{no}
20145 Don't insert NOPs.
20147 @item @samp{pad}
20148 Pad with NOPs any dispatch group that has vacant issue slots,
20149 according to the scheduler's grouping.
20151 @item @samp{regroup_exact}
20152 Insert NOPs to force costly dependent insns into
20153 separate groups.  Insert exactly as many NOPs as needed to force an insn
20154 to a new group, according to the estimated processor grouping.
20156 @item @var{number}
20157 Insert NOPs to force costly dependent insns into
20158 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
20159 @end table
20161 @item -mcall-sysv
20162 @opindex mcall-sysv
20163 On System V.4 and embedded PowerPC systems compile code using calling
20164 conventions that adhere to the March 1995 draft of the System V
20165 Application Binary Interface, PowerPC processor supplement.  This is the
20166 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
20168 @item -mcall-sysv-eabi
20169 @itemx -mcall-eabi
20170 @opindex mcall-sysv-eabi
20171 @opindex mcall-eabi
20172 Specify both @option{-mcall-sysv} and @option{-meabi} options.
20174 @item -mcall-sysv-noeabi
20175 @opindex mcall-sysv-noeabi
20176 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
20178 @item -mcall-aixdesc
20179 @opindex m
20180 On System V.4 and embedded PowerPC systems compile code for the AIX
20181 operating system.
20183 @item -mcall-linux
20184 @opindex mcall-linux
20185 On System V.4 and embedded PowerPC systems compile code for the
20186 Linux-based GNU system.
20188 @item -mcall-freebsd
20189 @opindex mcall-freebsd
20190 On System V.4 and embedded PowerPC systems compile code for the
20191 FreeBSD operating system.
20193 @item -mcall-netbsd
20194 @opindex mcall-netbsd
20195 On System V.4 and embedded PowerPC systems compile code for the
20196 NetBSD operating system.
20198 @item -mcall-openbsd
20199 @opindex mcall-netbsd
20200 On System V.4 and embedded PowerPC systems compile code for the
20201 OpenBSD operating system.
20203 @item -maix-struct-return
20204 @opindex maix-struct-return
20205 Return all structures in memory (as specified by the AIX ABI)@.
20207 @item -msvr4-struct-return
20208 @opindex msvr4-struct-return
20209 Return structures smaller than 8 bytes in registers (as specified by the
20210 SVR4 ABI)@.
20212 @item -mabi=@var{abi-type}
20213 @opindex mabi
20214 Extend the current ABI with a particular extension, or remove such extension.
20215 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
20216 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
20217 @var{elfv1}, @var{elfv2}@.
20219 @item -mabi=spe
20220 @opindex mabi=spe
20221 Extend the current ABI with SPE ABI extensions.  This does not change
20222 the default ABI, instead it adds the SPE ABI extensions to the current
20223 ABI@.
20225 @item -mabi=no-spe
20226 @opindex mabi=no-spe
20227 Disable Book-E SPE ABI extensions for the current ABI@.
20229 @item -mabi=ibmlongdouble
20230 @opindex mabi=ibmlongdouble
20231 Change the current ABI to use IBM extended-precision long double.
20232 This is a PowerPC 32-bit SYSV ABI option.
20234 @item -mabi=ieeelongdouble
20235 @opindex mabi=ieeelongdouble
20236 Change the current ABI to use IEEE extended-precision long double.
20237 This is a PowerPC 32-bit Linux ABI option.
20239 @item -mabi=elfv1
20240 @opindex mabi=elfv1
20241 Change the current ABI to use the ELFv1 ABI.
20242 This is the default ABI for big-endian PowerPC 64-bit Linux.
20243 Overriding the default ABI requires special system support and is
20244 likely to fail in spectacular ways.
20246 @item -mabi=elfv2
20247 @opindex mabi=elfv2
20248 Change the current ABI to use the ELFv2 ABI.
20249 This is the default ABI for little-endian PowerPC 64-bit Linux.
20250 Overriding the default ABI requires special system support and is
20251 likely to fail in spectacular ways.
20253 @item -mprototype
20254 @itemx -mno-prototype
20255 @opindex mprototype
20256 @opindex mno-prototype
20257 On System V.4 and embedded PowerPC systems assume that all calls to
20258 variable argument functions are properly prototyped.  Otherwise, the
20259 compiler must insert an instruction before every non-prototyped call to
20260 set or clear bit 6 of the condition code register (@var{CR}) to
20261 indicate whether floating-point values are passed in the floating-point
20262 registers in case the function takes variable arguments.  With
20263 @option{-mprototype}, only calls to prototyped variable argument functions
20264 set or clear the bit.
20266 @item -msim
20267 @opindex msim
20268 On embedded PowerPC systems, assume that the startup module is called
20269 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20270 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20271 configurations.
20273 @item -mmvme
20274 @opindex mmvme
20275 On embedded PowerPC systems, assume that the startup module is called
20276 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20277 @file{libc.a}.
20279 @item -mads
20280 @opindex mads
20281 On embedded PowerPC systems, assume that the startup module is called
20282 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20283 @file{libc.a}.
20285 @item -myellowknife
20286 @opindex myellowknife
20287 On embedded PowerPC systems, assume that the startup module is called
20288 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20289 @file{libc.a}.
20291 @item -mvxworks
20292 @opindex mvxworks
20293 On System V.4 and embedded PowerPC systems, specify that you are
20294 compiling for a VxWorks system.
20296 @item -memb
20297 @opindex memb
20298 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
20299 header to indicate that @samp{eabi} extended relocations are used.
20301 @item -meabi
20302 @itemx -mno-eabi
20303 @opindex meabi
20304 @opindex mno-eabi
20305 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20306 Embedded Applications Binary Interface (EABI), which is a set of
20307 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20308 means that the stack is aligned to an 8-byte boundary, a function
20309 @code{__eabi} is called from @code{main} to set up the EABI
20310 environment, and the @option{-msdata} option can use both @code{r2} and
20311 @code{r13} to point to two separate small data areas.  Selecting
20312 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20313 no EABI initialization function is called from @code{main}, and the
20314 @option{-msdata} option only uses @code{r13} to point to a single
20315 small data area.  The @option{-meabi} option is on by default if you
20316 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20318 @item -msdata=eabi
20319 @opindex msdata=eabi
20320 On System V.4 and embedded PowerPC systems, put small initialized
20321 @code{const} global and static data in the @samp{.sdata2} section, which
20322 is pointed to by register @code{r2}.  Put small initialized
20323 non-@code{const} global and static data in the @samp{.sdata} section,
20324 which is pointed to by register @code{r13}.  Put small uninitialized
20325 global and static data in the @samp{.sbss} section, which is adjacent to
20326 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
20327 incompatible with the @option{-mrelocatable} option.  The
20328 @option{-msdata=eabi} option also sets the @option{-memb} option.
20330 @item -msdata=sysv
20331 @opindex msdata=sysv
20332 On System V.4 and embedded PowerPC systems, put small global and static
20333 data in the @samp{.sdata} section, which is pointed to by register
20334 @code{r13}.  Put small uninitialized global and static data in the
20335 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
20336 The @option{-msdata=sysv} option is incompatible with the
20337 @option{-mrelocatable} option.
20339 @item -msdata=default
20340 @itemx -msdata
20341 @opindex msdata=default
20342 @opindex msdata
20343 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20344 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20345 same as @option{-msdata=sysv}.
20347 @item -msdata=data
20348 @opindex msdata=data
20349 On System V.4 and embedded PowerPC systems, put small global
20350 data in the @samp{.sdata} section.  Put small uninitialized global
20351 data in the @samp{.sbss} section.  Do not use register @code{r13}
20352 to address small data however.  This is the default behavior unless
20353 other @option{-msdata} options are used.
20355 @item -msdata=none
20356 @itemx -mno-sdata
20357 @opindex msdata=none
20358 @opindex mno-sdata
20359 On embedded PowerPC systems, put all initialized global and static data
20360 in the @samp{.data} section, and all uninitialized data in the
20361 @samp{.bss} section.
20363 @item -mblock-move-inline-limit=@var{num}
20364 @opindex mblock-move-inline-limit
20365 Inline all block moves (such as calls to @code{memcpy} or structure
20366 copies) less than or equal to @var{num} bytes.  The minimum value for
20367 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20368 targets.  The default value is target-specific.
20370 @item -G @var{num}
20371 @opindex G
20372 @cindex smaller data references (PowerPC)
20373 @cindex .sdata/.sdata2 references (PowerPC)
20374 On embedded PowerPC systems, put global and static items less than or
20375 equal to @var{num} bytes into the small data or BSS sections instead of
20376 the normal data or BSS section.  By default, @var{num} is 8.  The
20377 @option{-G @var{num}} switch is also passed to the linker.
20378 All modules should be compiled with the same @option{-G @var{num}} value.
20380 @item -mregnames
20381 @itemx -mno-regnames
20382 @opindex mregnames
20383 @opindex mno-regnames
20384 On System V.4 and embedded PowerPC systems do (do not) emit register
20385 names in the assembly language output using symbolic forms.
20387 @item -mlongcall
20388 @itemx -mno-longcall
20389 @opindex mlongcall
20390 @opindex mno-longcall
20391 By default assume that all calls are far away so that a longer and more
20392 expensive calling sequence is required.  This is required for calls
20393 farther than 32 megabytes (33,554,432 bytes) from the current location.
20394 A short call is generated if the compiler knows
20395 the call cannot be that far away.  This setting can be overridden by
20396 the @code{shortcall} function attribute, or by @code{#pragma
20397 longcall(0)}.
20399 Some linkers are capable of detecting out-of-range calls and generating
20400 glue code on the fly.  On these systems, long calls are unnecessary and
20401 generate slower code.  As of this writing, the AIX linker can do this,
20402 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20403 to the GNU linker for 32-bit PowerPC systems as well.
20405 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20406 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20407 addresses represent the callee and the branch island.  The
20408 Darwin/PPC linker prefers the first address and generates a @code{bl
20409 callee} if the PPC @code{bl} instruction reaches the callee directly;
20410 otherwise, the linker generates @code{bl L42} to call the branch
20411 island.  The branch island is appended to the body of the
20412 calling function; it computes the full 32-bit address of the callee
20413 and jumps to it.
20415 On Mach-O (Darwin) systems, this option directs the compiler emit to
20416 the glue for every direct call, and the Darwin linker decides whether
20417 to use or discard it.
20419 In the future, GCC may ignore all longcall specifications
20420 when the linker is known to generate glue.
20422 @item -mtls-markers
20423 @itemx -mno-tls-markers
20424 @opindex mtls-markers
20425 @opindex mno-tls-markers
20426 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20427 specifying the function argument.  The relocation allows the linker to
20428 reliably associate function call with argument setup instructions for
20429 TLS optimization, which in turn allows GCC to better schedule the
20430 sequence.
20432 @item -pthread
20433 @opindex pthread
20434 Adds support for multithreading with the @dfn{pthreads} library.
20435 This option sets flags for both the preprocessor and linker.
20437 @item -mrecip
20438 @itemx -mno-recip
20439 @opindex mrecip
20440 This option enables use of the reciprocal estimate and
20441 reciprocal square root estimate instructions with additional
20442 Newton-Raphson steps to increase precision instead of doing a divide or
20443 square root and divide for floating-point arguments.  You should use
20444 the @option{-ffast-math} option when using @option{-mrecip} (or at
20445 least @option{-funsafe-math-optimizations},
20446 @option{-finite-math-only}, @option{-freciprocal-math} and
20447 @option{-fno-trapping-math}).  Note that while the throughput of the
20448 sequence is generally higher than the throughput of the non-reciprocal
20449 instruction, the precision of the sequence can be decreased by up to 2
20450 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20451 roots.
20453 @item -mrecip=@var{opt}
20454 @opindex mrecip=opt
20455 This option controls which reciprocal estimate instructions
20456 may be used.  @var{opt} is a comma-separated list of options, which may
20457 be preceded by a @code{!} to invert the option:
20458 @code{all}: enable all estimate instructions,
20459 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
20460 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
20461 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
20462 @code{divf}: enable the single-precision reciprocal approximation instructions;
20463 @code{divd}: enable the double-precision reciprocal approximation instructions;
20464 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
20465 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
20466 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
20468 So, for example, @option{-mrecip=all,!rsqrtd} enables
20469 all of the reciprocal estimate instructions, except for the
20470 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20471 which handle the double-precision reciprocal square root calculations.
20473 @item -mrecip-precision
20474 @itemx -mno-recip-precision
20475 @opindex mrecip-precision
20476 Assume (do not assume) that the reciprocal estimate instructions
20477 provide higher-precision estimates than is mandated by the PowerPC
20478 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20479 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20480 The double-precision square root estimate instructions are not generated by
20481 default on low-precision machines, since they do not provide an
20482 estimate that converges after three steps.
20484 @item -mveclibabi=@var{type}
20485 @opindex mveclibabi
20486 Specifies the ABI type to use for vectorizing intrinsics using an
20487 external library.  The only type supported at present is @code{mass},
20488 which specifies to use IBM's Mathematical Acceleration Subsystem
20489 (MASS) libraries for vectorizing intrinsics using external libraries.
20490 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20491 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20492 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20493 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20494 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20495 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20496 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20497 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20498 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20499 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20500 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20501 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20502 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20503 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20504 for power7.  Both @option{-ftree-vectorize} and
20505 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20506 libraries must be specified at link time.
20508 @item -mfriz
20509 @itemx -mno-friz
20510 @opindex mfriz
20511 Generate (do not generate) the @code{friz} instruction when the
20512 @option{-funsafe-math-optimizations} option is used to optimize
20513 rounding of floating-point values to 64-bit integer and back to floating
20514 point.  The @code{friz} instruction does not return the same value if
20515 the floating-point number is too large to fit in an integer.
20517 @item -mpointers-to-nested-functions
20518 @itemx -mno-pointers-to-nested-functions
20519 @opindex mpointers-to-nested-functions
20520 Generate (do not generate) code to load up the static chain register
20521 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20522 systems where a function pointer points to a 3-word descriptor giving
20523 the function address, TOC value to be loaded in register @var{r2}, and
20524 static chain value to be loaded in register @var{r11}.  The
20525 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20526 call through pointers to nested functions or pointers
20527 to functions compiled in other languages that use the static chain if
20528 you use the @option{-mno-pointers-to-nested-functions}.
20530 @item -msave-toc-indirect
20531 @itemx -mno-save-toc-indirect
20532 @opindex msave-toc-indirect
20533 Generate (do not generate) code to save the TOC value in the reserved
20534 stack location in the function prologue if the function calls through
20535 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20536 saved in the prologue, it is saved just before the call through the
20537 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20539 @item -mcompat-align-parm
20540 @itemx -mno-compat-align-parm
20541 @opindex mcompat-align-parm
20542 Generate (do not generate) code to pass structure parameters with a
20543 maximum alignment of 64 bits, for compatibility with older versions
20544 of GCC.
20546 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20547 structure parameter on a 128-bit boundary when that structure contained
20548 a member requiring 128-bit alignment.  This is corrected in more
20549 recent versions of GCC.  This option may be used to generate code
20550 that is compatible with functions compiled with older versions of
20551 GCC.
20553 The @option{-mno-compat-align-parm} option is the default.
20554 @end table
20556 @node RX Options
20557 @subsection RX Options
20558 @cindex RX Options
20560 These command-line options are defined for RX targets:
20562 @table @gcctabopt
20563 @item -m64bit-doubles
20564 @itemx -m32bit-doubles
20565 @opindex m64bit-doubles
20566 @opindex m32bit-doubles
20567 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20568 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20569 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20570 works on 32-bit values, which is why the default is
20571 @option{-m32bit-doubles}.
20573 @item -fpu
20574 @itemx -nofpu
20575 @opindex fpu
20576 @opindex nofpu
20577 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20578 floating-point hardware.  The default is enabled for the @var{RX600}
20579 series and disabled for the @var{RX200} series.
20581 Floating-point instructions are only generated for 32-bit floating-point 
20582 values, however, so the FPU hardware is not used for doubles if the
20583 @option{-m64bit-doubles} option is used.
20585 @emph{Note} If the @option{-fpu} option is enabled then
20586 @option{-funsafe-math-optimizations} is also enabled automatically.
20587 This is because the RX FPU instructions are themselves unsafe.
20589 @item -mcpu=@var{name}
20590 @opindex -mcpu
20591 Selects the type of RX CPU to be targeted.  Currently three types are
20592 supported, the generic @var{RX600} and @var{RX200} series hardware and
20593 the specific @var{RX610} CPU.  The default is @var{RX600}.
20595 The only difference between @var{RX600} and @var{RX610} is that the
20596 @var{RX610} does not support the @code{MVTIPL} instruction.
20598 The @var{RX200} series does not have a hardware floating-point unit
20599 and so @option{-nofpu} is enabled by default when this type is
20600 selected.
20602 @item -mbig-endian-data
20603 @itemx -mlittle-endian-data
20604 @opindex mbig-endian-data
20605 @opindex mlittle-endian-data
20606 Store data (but not code) in the big-endian format.  The default is
20607 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20608 format.
20610 @item -msmall-data-limit=@var{N}
20611 @opindex msmall-data-limit
20612 Specifies the maximum size in bytes of global and static variables
20613 which can be placed into the small data area.  Using the small data
20614 area can lead to smaller and faster code, but the size of area is
20615 limited and it is up to the programmer to ensure that the area does
20616 not overflow.  Also when the small data area is used one of the RX's
20617 registers (usually @code{r13}) is reserved for use pointing to this
20618 area, so it is no longer available for use by the compiler.  This
20619 could result in slower and/or larger code if variables are pushed onto
20620 the stack instead of being held in this register.
20622 Note, common variables (variables that have not been initialized) and
20623 constants are not placed into the small data area as they are assigned
20624 to other sections in the output executable.
20626 The default value is zero, which disables this feature.  Note, this
20627 feature is not enabled by default with higher optimization levels
20628 (@option{-O2} etc) because of the potentially detrimental effects of
20629 reserving a register.  It is up to the programmer to experiment and
20630 discover whether this feature is of benefit to their program.  See the
20631 description of the @option{-mpid} option for a description of how the
20632 actual register to hold the small data area pointer is chosen.
20634 @item -msim
20635 @itemx -mno-sim
20636 @opindex msim
20637 @opindex mno-sim
20638 Use the simulator runtime.  The default is to use the libgloss
20639 board-specific runtime.
20641 @item -mas100-syntax
20642 @itemx -mno-as100-syntax
20643 @opindex mas100-syntax
20644 @opindex mno-as100-syntax
20645 When generating assembler output use a syntax that is compatible with
20646 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20647 assembler, but it has some restrictions so it is not generated by default.
20649 @item -mmax-constant-size=@var{N}
20650 @opindex mmax-constant-size
20651 Specifies the maximum size, in bytes, of a constant that can be used as
20652 an operand in a RX instruction.  Although the RX instruction set does
20653 allow constants of up to 4 bytes in length to be used in instructions,
20654 a longer value equates to a longer instruction.  Thus in some
20655 circumstances it can be beneficial to restrict the size of constants
20656 that are used in instructions.  Constants that are too big are instead
20657 placed into a constant pool and referenced via register indirection.
20659 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20660 or 4 means that constants of any size are allowed.
20662 @item -mrelax
20663 @opindex mrelax
20664 Enable linker relaxation.  Linker relaxation is a process whereby the
20665 linker attempts to reduce the size of a program by finding shorter
20666 versions of various instructions.  Disabled by default.
20668 @item -mint-register=@var{N}
20669 @opindex mint-register
20670 Specify the number of registers to reserve for fast interrupt handler
20671 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20672 means that register @code{r13} is reserved for the exclusive use
20673 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20674 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20675 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20676 A value of 0, the default, does not reserve any registers.
20678 @item -msave-acc-in-interrupts
20679 @opindex msave-acc-in-interrupts
20680 Specifies that interrupt handler functions should preserve the
20681 accumulator register.  This is only necessary if normal code might use
20682 the accumulator register, for example because it performs 64-bit
20683 multiplications.  The default is to ignore the accumulator as this
20684 makes the interrupt handlers faster.
20686 @item -mpid
20687 @itemx -mno-pid
20688 @opindex mpid
20689 @opindex mno-pid
20690 Enables the generation of position independent data.  When enabled any
20691 access to constant data is done via an offset from a base address
20692 held in a register.  This allows the location of constant data to be
20693 determined at run time without requiring the executable to be
20694 relocated, which is a benefit to embedded applications with tight
20695 memory constraints.  Data that can be modified is not affected by this
20696 option.
20698 Note, using this feature reserves a register, usually @code{r13}, for
20699 the constant data base address.  This can result in slower and/or
20700 larger code, especially in complicated functions.
20702 The actual register chosen to hold the constant data base address
20703 depends upon whether the @option{-msmall-data-limit} and/or the
20704 @option{-mint-register} command-line options are enabled.  Starting
20705 with register @code{r13} and proceeding downwards, registers are
20706 allocated first to satisfy the requirements of @option{-mint-register},
20707 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20708 is possible for the small data area register to be @code{r8} if both
20709 @option{-mint-register=4} and @option{-mpid} are specified on the
20710 command line.
20712 By default this feature is not enabled.  The default can be restored
20713 via the @option{-mno-pid} command-line option.
20715 @item -mno-warn-multiple-fast-interrupts
20716 @itemx -mwarn-multiple-fast-interrupts
20717 @opindex mno-warn-multiple-fast-interrupts
20718 @opindex mwarn-multiple-fast-interrupts
20719 Prevents GCC from issuing a warning message if it finds more than one
20720 fast interrupt handler when it is compiling a file.  The default is to
20721 issue a warning for each extra fast interrupt handler found, as the RX
20722 only supports one such interrupt.
20724 @end table
20726 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20727 has special significance to the RX port when used with the
20728 @code{interrupt} function attribute.  This attribute indicates a
20729 function intended to process fast interrupts.  GCC ensures
20730 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20731 and/or @code{r13} and only provided that the normal use of the
20732 corresponding registers have been restricted via the
20733 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20734 options.
20736 @node S/390 and zSeries Options
20737 @subsection S/390 and zSeries Options
20738 @cindex S/390 and zSeries Options
20740 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20742 @table @gcctabopt
20743 @item -mhard-float
20744 @itemx -msoft-float
20745 @opindex mhard-float
20746 @opindex msoft-float
20747 Use (do not use) the hardware floating-point instructions and registers
20748 for floating-point operations.  When @option{-msoft-float} is specified,
20749 functions in @file{libgcc.a} are used to perform floating-point
20750 operations.  When @option{-mhard-float} is specified, the compiler
20751 generates IEEE floating-point instructions.  This is the default.
20753 @item -mhard-dfp
20754 @itemx -mno-hard-dfp
20755 @opindex mhard-dfp
20756 @opindex mno-hard-dfp
20757 Use (do not use) the hardware decimal-floating-point instructions for
20758 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20759 specified, functions in @file{libgcc.a} are used to perform
20760 decimal-floating-point operations.  When @option{-mhard-dfp} is
20761 specified, the compiler generates decimal-floating-point hardware
20762 instructions.  This is the default for @option{-march=z9-ec} or higher.
20764 @item -mlong-double-64
20765 @itemx -mlong-double-128
20766 @opindex mlong-double-64
20767 @opindex mlong-double-128
20768 These switches control the size of @code{long double} type. A size
20769 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20770 type. This is the default.
20772 @item -mbackchain
20773 @itemx -mno-backchain
20774 @opindex mbackchain
20775 @opindex mno-backchain
20776 Store (do not store) the address of the caller's frame as backchain pointer
20777 into the callee's stack frame.
20778 A backchain may be needed to allow debugging using tools that do not understand
20779 DWARF 2 call frame information.
20780 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20781 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20782 the backchain is placed into the topmost word of the 96/160 byte register
20783 save area.
20785 In general, code compiled with @option{-mbackchain} is call-compatible with
20786 code compiled with @option{-mmo-backchain}; however, use of the backchain
20787 for debugging purposes usually requires that the whole binary is built with
20788 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20789 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20790 to build a linux kernel use @option{-msoft-float}.
20792 The default is to not maintain the backchain.
20794 @item -mpacked-stack
20795 @itemx -mno-packed-stack
20796 @opindex mpacked-stack
20797 @opindex mno-packed-stack
20798 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20799 specified, the compiler uses the all fields of the 96/160 byte register save
20800 area only for their default purpose; unused fields still take up stack space.
20801 When @option{-mpacked-stack} is specified, register save slots are densely
20802 packed at the top of the register save area; unused space is reused for other
20803 purposes, allowing for more efficient use of the available stack space.
20804 However, when @option{-mbackchain} is also in effect, the topmost word of
20805 the save area is always used to store the backchain, and the return address
20806 register is always saved two words below the backchain.
20808 As long as the stack frame backchain is not used, code generated with
20809 @option{-mpacked-stack} is call-compatible with code generated with
20810 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20811 S/390 or zSeries generated code that uses the stack frame backchain at run
20812 time, not just for debugging purposes.  Such code is not call-compatible
20813 with code compiled with @option{-mpacked-stack}.  Also, note that the
20814 combination of @option{-mbackchain},
20815 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20816 to build a linux kernel use @option{-msoft-float}.
20818 The default is to not use the packed stack layout.
20820 @item -msmall-exec
20821 @itemx -mno-small-exec
20822 @opindex msmall-exec
20823 @opindex mno-small-exec
20824 Generate (or do not generate) code using the @code{bras} instruction
20825 to do subroutine calls.
20826 This only works reliably if the total executable size does not
20827 exceed 64k.  The default is to use the @code{basr} instruction instead,
20828 which does not have this limitation.
20830 @item -m64
20831 @itemx -m31
20832 @opindex m64
20833 @opindex m31
20834 When @option{-m31} is specified, generate code compliant to the
20835 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20836 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20837 particular to generate 64-bit instructions.  For the @samp{s390}
20838 targets, the default is @option{-m31}, while the @samp{s390x}
20839 targets default to @option{-m64}.
20841 @item -mzarch
20842 @itemx -mesa
20843 @opindex mzarch
20844 @opindex mesa
20845 When @option{-mzarch} is specified, generate code using the
20846 instructions available on z/Architecture.
20847 When @option{-mesa} is specified, generate code using the
20848 instructions available on ESA/390.  Note that @option{-mesa} is
20849 not possible with @option{-m64}.
20850 When generating code compliant to the GNU/Linux for S/390 ABI,
20851 the default is @option{-mesa}.  When generating code compliant
20852 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20854 @item -mmvcle
20855 @itemx -mno-mvcle
20856 @opindex mmvcle
20857 @opindex mno-mvcle
20858 Generate (or do not generate) code using the @code{mvcle} instruction
20859 to perform block moves.  When @option{-mno-mvcle} is specified,
20860 use a @code{mvc} loop instead.  This is the default unless optimizing for
20861 size.
20863 @item -mdebug
20864 @itemx -mno-debug
20865 @opindex mdebug
20866 @opindex mno-debug
20867 Print (or do not print) additional debug information when compiling.
20868 The default is to not print debug information.
20870 @item -march=@var{cpu-type}
20871 @opindex march
20872 Generate code that runs on @var{cpu-type}, which is the name of a system
20873 representing a certain processor type.  Possible values for
20874 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20875 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20876 When generating code using the instructions available on z/Architecture,
20877 the default is @option{-march=z900}.  Otherwise, the default is
20878 @option{-march=g5}.
20880 @item -mtune=@var{cpu-type}
20881 @opindex mtune
20882 Tune to @var{cpu-type} everything applicable about the generated code,
20883 except for the ABI and the set of available instructions.
20884 The list of @var{cpu-type} values is the same as for @option{-march}.
20885 The default is the value used for @option{-march}.
20887 @item -mtpf-trace
20888 @itemx -mno-tpf-trace
20889 @opindex mtpf-trace
20890 @opindex mno-tpf-trace
20891 Generate code that adds (does not add) in TPF OS specific branches to trace
20892 routines in the operating system.  This option is off by default, even
20893 when compiling for the TPF OS@.
20895 @item -mfused-madd
20896 @itemx -mno-fused-madd
20897 @opindex mfused-madd
20898 @opindex mno-fused-madd
20899 Generate code that uses (does not use) the floating-point multiply and
20900 accumulate instructions.  These instructions are generated by default if
20901 hardware floating point is used.
20903 @item -mwarn-framesize=@var{framesize}
20904 @opindex mwarn-framesize
20905 Emit a warning if the current function exceeds the given frame size.  Because
20906 this is a compile-time check it doesn't need to be a real problem when the program
20907 runs.  It is intended to identify functions that most probably cause
20908 a stack overflow.  It is useful to be used in an environment with limited stack
20909 size e.g.@: the linux kernel.
20911 @item -mwarn-dynamicstack
20912 @opindex mwarn-dynamicstack
20913 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20914 arrays.  This is generally a bad idea with a limited stack size.
20916 @item -mstack-guard=@var{stack-guard}
20917 @itemx -mstack-size=@var{stack-size}
20918 @opindex mstack-guard
20919 @opindex mstack-size
20920 If these options are provided the S/390 back end emits additional instructions in
20921 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20922 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20923 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20924 the frame size of the compiled function is chosen.
20925 These options are intended to be used to help debugging stack overflow problems.
20926 The additionally emitted code causes only little overhead and hence can also be
20927 used in production-like systems without greater performance degradation.  The given
20928 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20929 @var{stack-guard} without exceeding 64k.
20930 In order to be efficient the extra code makes the assumption that the stack starts
20931 at an address aligned to the value given by @var{stack-size}.
20932 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20934 @item -mhotpatch[=@var{halfwords}]
20935 @itemx -mno-hotpatch
20936 @opindex mhotpatch
20937 If the hotpatch option is enabled, a ``hot-patching'' function
20938 prologue is generated for all functions in the compilation unit.
20939 The funtion label is prepended with the given number of two-byte
20940 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
20941 instructions if no argument is present.  Functions with a
20942 hot-patching prologue are never inlined automatically, and a
20943 hot-patching prologue is never generated for functions
20944 that are explicitly inline.
20946 This option can be overridden for individual functions with the
20947 @code{hotpatch} attribute.
20948 @end table
20950 @node Score Options
20951 @subsection Score Options
20952 @cindex Score Options
20954 These options are defined for Score implementations:
20956 @table @gcctabopt
20957 @item -meb
20958 @opindex meb
20959 Compile code for big-endian mode.  This is the default.
20961 @item -mel
20962 @opindex mel
20963 Compile code for little-endian mode.
20965 @item -mnhwloop
20966 @opindex mnhwloop
20967 Disable generation of @code{bcnz} instructions.
20969 @item -muls
20970 @opindex muls
20971 Enable generation of unaligned load and store instructions.
20973 @item -mmac
20974 @opindex mmac
20975 Enable the use of multiply-accumulate instructions. Disabled by default.
20977 @item -mscore5
20978 @opindex mscore5
20979 Specify the SCORE5 as the target architecture.
20981 @item -mscore5u
20982 @opindex mscore5u
20983 Specify the SCORE5U of the target architecture.
20985 @item -mscore7
20986 @opindex mscore7
20987 Specify the SCORE7 as the target architecture. This is the default.
20989 @item -mscore7d
20990 @opindex mscore7d
20991 Specify the SCORE7D as the target architecture.
20992 @end table
20994 @node SH Options
20995 @subsection SH Options
20997 These @samp{-m} options are defined for the SH implementations:
20999 @table @gcctabopt
21000 @item -m1
21001 @opindex m1
21002 Generate code for the SH1.
21004 @item -m2
21005 @opindex m2
21006 Generate code for the SH2.
21008 @item -m2e
21009 Generate code for the SH2e.
21011 @item -m2a-nofpu
21012 @opindex m2a-nofpu
21013 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
21014 that the floating-point unit is not used.
21016 @item -m2a-single-only
21017 @opindex m2a-single-only
21018 Generate code for the SH2a-FPU, in such a way that no double-precision
21019 floating-point operations are used.
21021 @item -m2a-single
21022 @opindex m2a-single
21023 Generate code for the SH2a-FPU assuming the floating-point unit is in
21024 single-precision mode by default.
21026 @item -m2a
21027 @opindex m2a
21028 Generate code for the SH2a-FPU assuming the floating-point unit is in
21029 double-precision mode by default.
21031 @item -m3
21032 @opindex m3
21033 Generate code for the SH3.
21035 @item -m3e
21036 @opindex m3e
21037 Generate code for the SH3e.
21039 @item -m4-nofpu
21040 @opindex m4-nofpu
21041 Generate code for the SH4 without a floating-point unit.
21043 @item -m4-single-only
21044 @opindex m4-single-only
21045 Generate code for the SH4 with a floating-point unit that only
21046 supports single-precision arithmetic.
21048 @item -m4-single
21049 @opindex m4-single
21050 Generate code for the SH4 assuming the floating-point unit is in
21051 single-precision mode by default.
21053 @item -m4
21054 @opindex m4
21055 Generate code for the SH4.
21057 @item -m4-100
21058 @opindex m4-100
21059 Generate code for SH4-100.
21061 @item -m4-100-nofpu
21062 @opindex m4-100-nofpu
21063 Generate code for SH4-100 in such a way that the
21064 floating-point unit is not used.
21066 @item -m4-100-single
21067 @opindex m4-100-single
21068 Generate code for SH4-100 assuming the floating-point unit is in
21069 single-precision mode by default.
21071 @item -m4-100-single-only
21072 @opindex m4-100-single-only
21073 Generate code for SH4-100 in such a way that no double-precision
21074 floating-point operations are used.
21076 @item -m4-200
21077 @opindex m4-200
21078 Generate code for SH4-200.
21080 @item -m4-200-nofpu
21081 @opindex m4-200-nofpu
21082 Generate code for SH4-200 without in such a way that the
21083 floating-point unit is not used.
21085 @item -m4-200-single
21086 @opindex m4-200-single
21087 Generate code for SH4-200 assuming the floating-point unit is in
21088 single-precision mode by default.
21090 @item -m4-200-single-only
21091 @opindex m4-200-single-only
21092 Generate code for SH4-200 in such a way that no double-precision
21093 floating-point operations are used.
21095 @item -m4-300
21096 @opindex m4-300
21097 Generate code for SH4-300.
21099 @item -m4-300-nofpu
21100 @opindex m4-300-nofpu
21101 Generate code for SH4-300 without in such a way that the
21102 floating-point unit is not used.
21104 @item -m4-300-single
21105 @opindex m4-300-single
21106 Generate code for SH4-300 in such a way that no double-precision
21107 floating-point operations are used.
21109 @item -m4-300-single-only
21110 @opindex m4-300-single-only
21111 Generate code for SH4-300 in such a way that no double-precision
21112 floating-point operations are used.
21114 @item -m4-340
21115 @opindex m4-340
21116 Generate code for SH4-340 (no MMU, no FPU).
21118 @item -m4-500
21119 @opindex m4-500
21120 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
21121 assembler.
21123 @item -m4a-nofpu
21124 @opindex m4a-nofpu
21125 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
21126 floating-point unit is not used.
21128 @item -m4a-single-only
21129 @opindex m4a-single-only
21130 Generate code for the SH4a, in such a way that no double-precision
21131 floating-point operations are used.
21133 @item -m4a-single
21134 @opindex m4a-single
21135 Generate code for the SH4a assuming the floating-point unit is in
21136 single-precision mode by default.
21138 @item -m4a
21139 @opindex m4a
21140 Generate code for the SH4a.
21142 @item -m4al
21143 @opindex m4al
21144 Same as @option{-m4a-nofpu}, except that it implicitly passes
21145 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
21146 instructions at the moment.
21148 @item -m5-32media
21149 @opindex m5-32media
21150 Generate 32-bit code for SHmedia.
21152 @item -m5-32media-nofpu
21153 @opindex m5-32media-nofpu
21154 Generate 32-bit code for SHmedia in such a way that the
21155 floating-point unit is not used.
21157 @item -m5-64media
21158 @opindex m5-64media
21159 Generate 64-bit code for SHmedia.
21161 @item -m5-64media-nofpu
21162 @opindex m5-64media-nofpu
21163 Generate 64-bit code for SHmedia in such a way that the
21164 floating-point unit is not used.
21166 @item -m5-compact
21167 @opindex m5-compact
21168 Generate code for SHcompact.
21170 @item -m5-compact-nofpu
21171 @opindex m5-compact-nofpu
21172 Generate code for SHcompact in such a way that the
21173 floating-point unit is not used.
21175 @item -mb
21176 @opindex mb
21177 Compile code for the processor in big-endian mode.
21179 @item -ml
21180 @opindex ml
21181 Compile code for the processor in little-endian mode.
21183 @item -mdalign
21184 @opindex mdalign
21185 Align doubles at 64-bit boundaries.  Note that this changes the calling
21186 conventions, and thus some functions from the standard C library do
21187 not work unless you recompile it first with @option{-mdalign}.
21189 @item -mrelax
21190 @opindex mrelax
21191 Shorten some address references at link time, when possible; uses the
21192 linker option @option{-relax}.
21194 @item -mbigtable
21195 @opindex mbigtable
21196 Use 32-bit offsets in @code{switch} tables.  The default is to use
21197 16-bit offsets.
21199 @item -mbitops
21200 @opindex mbitops
21201 Enable the use of bit manipulation instructions on SH2A.
21203 @item -mfmovd
21204 @opindex mfmovd
21205 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21206 alignment constraints.
21208 @item -mrenesas
21209 @opindex mrenesas
21210 Comply with the calling conventions defined by Renesas.
21212 @item -mno-renesas
21213 @opindex mno-renesas
21214 Comply with the calling conventions defined for GCC before the Renesas
21215 conventions were available.  This option is the default for all
21216 targets of the SH toolchain.
21218 @item -mnomacsave
21219 @opindex mnomacsave
21220 Mark the @code{MAC} register as call-clobbered, even if
21221 @option{-mrenesas} is given.
21223 @item -mieee
21224 @itemx -mno-ieee
21225 @opindex mieee
21226 @opindex mno-ieee
21227 Control the IEEE compliance of floating-point comparisons, which affects the
21228 handling of cases where the result of a comparison is unordered.  By default
21229 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21230 enabled @option{-mno-ieee} is implicitly set, which results in faster
21231 floating-point greater-equal and less-equal comparisons.  The implcit settings
21232 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21234 @item -minline-ic_invalidate
21235 @opindex minline-ic_invalidate
21236 Inline code to invalidate instruction cache entries after setting up
21237 nested function trampolines.
21238 This option has no effect if @option{-musermode} is in effect and the selected
21239 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21240 instruction.
21241 If the selected code generation option does not allow the use of the @code{icbi}
21242 instruction, and @option{-musermode} is not in effect, the inlined code
21243 manipulates the instruction cache address array directly with an associative
21244 write.  This not only requires privileged mode at run time, but it also
21245 fails if the cache line had been mapped via the TLB and has become unmapped.
21247 @item -misize
21248 @opindex misize
21249 Dump instruction size and location in the assembly code.
21251 @item -mpadstruct
21252 @opindex mpadstruct
21253 This option is deprecated.  It pads structures to multiple of 4 bytes,
21254 which is incompatible with the SH ABI@.
21256 @item -matomic-model=@var{model}
21257 @opindex matomic-model=@var{model}
21258 Sets the model of atomic operations and additional parameters as a comma
21259 separated list.  For details on the atomic built-in functions see
21260 @ref{__atomic Builtins}.  The following models and parameters are supported:
21262 @table @samp
21264 @item none
21265 Disable compiler generated atomic sequences and emit library calls for atomic
21266 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21268 @item soft-gusa
21269 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21270 built-in functions.  The generated atomic sequences require additional support
21271 from the interrupt/exception handling code of the system and are only suitable
21272 for SH3* and SH4* single-core systems.  This option is enabled by default when
21273 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21274 this option will also partially utilize the hardware atomic instructions
21275 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21276 @samp{strict} is specified.  
21278 @item soft-tcb
21279 Generate software atomic sequences that use a variable in the thread control
21280 block.  This is a variation of the gUSA sequences which can also be used on
21281 SH1* and SH2* targets.  The generated atomic sequences require additional
21282 support from the interrupt/exception handling code of the system and are only
21283 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21284 parameter has to be specified as well.
21286 @item soft-imask
21287 Generate software atomic sequences that temporarily disable interrupts by
21288 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21289 in privileged mode and is only suitable for single-core systems.  Additional
21290 support from the interrupt/exception handling code of the system is not
21291 required.  This model is enabled by default when the target is
21292 @code{sh*-*-linux*} and SH1* or SH2*.
21294 @item hard-llcs
21295 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21296 instructions only.  This is only available on SH4A and is suitable for
21297 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21298 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21299 Code compiled with this option will also be compatible with other software
21300 atomic model interrupt/exception handling systems if executed on an SH4A
21301 system.  Additional support from the interrupt/exception handling code of the
21302 system is not required for this model.
21304 @item gbr-offset=
21305 This parameter specifies the offset in bytes of the variable in the thread
21306 control block structure that should be used by the generated atomic sequences
21307 when the @samp{soft-tcb} model has been selected.  For other models this
21308 parameter is ignored.  The specified value must be an integer multiple of four
21309 and in the range 0-1020.
21311 @item strict
21312 This parameter prevents mixed usage of multiple atomic models, even though they
21313 would be compatible, and will make the compiler generate atomic sequences of the
21314 specified model only.
21316 @end table
21318 @item -mtas
21319 @opindex mtas
21320 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21321 Notice that depending on the particular hardware and software configuration
21322 this can degrade overall performance due to the operand cache line flushes
21323 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21324 processors the @code{tas.b} instruction must be used with caution since it
21325 can result in data corruption for certain cache configurations.
21327 @item -mprefergot
21328 @opindex mprefergot
21329 When generating position-independent code, emit function calls using
21330 the Global Offset Table instead of the Procedure Linkage Table.
21332 @item -musermode
21333 @itemx -mno-usermode
21334 @opindex musermode
21335 @opindex mno-usermode
21336 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21337 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21338 inlined code would not work in user mode.  @option{-musermode} is the default
21339 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21340 @option{-musermode} has no effect, since there is no user mode.
21342 @item -multcost=@var{number}
21343 @opindex multcost=@var{number}
21344 Set the cost to assume for a multiply insn.
21346 @item -mdiv=@var{strategy}
21347 @opindex mdiv=@var{strategy}
21348 Set the division strategy to be used for integer division operations.
21349 For SHmedia @var{strategy} can be one of: 
21351 @table @samp
21353 @item fp 
21354 Performs the operation in floating point.  This has a very high latency,
21355 but needs only a few instructions, so it might be a good choice if
21356 your code has enough easily-exploitable ILP to allow the compiler to
21357 schedule the floating-point instructions together with other instructions.
21358 Division by zero causes a floating-point exception.
21360 @item inv
21361 Uses integer operations to calculate the inverse of the divisor,
21362 and then multiplies the dividend with the inverse.  This strategy allows
21363 CSE and hoisting of the inverse calculation.  Division by zero calculates
21364 an unspecified result, but does not trap.
21366 @item inv:minlat
21367 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21368 have been found, or if the entire operation has been hoisted to the same
21369 place, the last stages of the inverse calculation are intertwined with the
21370 final multiply to reduce the overall latency, at the expense of using a few
21371 more instructions, and thus offering fewer scheduling opportunities with
21372 other code.
21374 @item call
21375 Calls a library function that usually implements the @samp{inv:minlat}
21376 strategy.
21377 This gives high code density for @code{m5-*media-nofpu} compilations.
21379 @item call2
21380 Uses a different entry point of the same library function, where it
21381 assumes that a pointer to a lookup table has already been set up, which
21382 exposes the pointer load to CSE and code hoisting optimizations.
21384 @item inv:call
21385 @itemx inv:call2
21386 @itemx inv:fp
21387 Use the @samp{inv} algorithm for initial
21388 code generation, but if the code stays unoptimized, revert to the @samp{call},
21389 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21390 potentially-trapping side effect of division by zero is carried by a
21391 separate instruction, so it is possible that all the integer instructions
21392 are hoisted out, but the marker for the side effect stays where it is.
21393 A recombination to floating-point operations or a call is not possible
21394 in that case.
21396 @item inv20u
21397 @itemx inv20l
21398 Variants of the @samp{inv:minlat} strategy.  In the case
21399 that the inverse calculation is not separated from the multiply, they speed
21400 up division where the dividend fits into 20 bits (plus sign where applicable)
21401 by inserting a test to skip a number of operations in this case; this test
21402 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21403 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21405 @end table
21407 For targets other than SHmedia @var{strategy} can be one of:
21409 @table @samp
21411 @item call-div1
21412 Calls a library function that uses the single-step division instruction
21413 @code{div1} to perform the operation.  Division by zero calculates an
21414 unspecified result and does not trap.  This is the default except for SH4,
21415 SH2A and SHcompact.
21417 @item call-fp
21418 Calls a library function that performs the operation in double precision
21419 floating point.  Division by zero causes a floating-point exception.  This is
21420 the default for SHcompact with FPU.  Specifying this for targets that do not
21421 have a double precision FPU will default to @code{call-div1}.
21423 @item call-table
21424 Calls a library function that uses a lookup table for small divisors and
21425 the @code{div1} instruction with case distinction for larger divisors.  Division
21426 by zero calculates an unspecified result and does not trap.  This is the default
21427 for SH4.  Specifying this for targets that do not have dynamic shift
21428 instructions will default to @code{call-div1}.
21430 @end table
21432 When a division strategy has not been specified the default strategy will be
21433 selected based on the current target.  For SH2A the default strategy is to
21434 use the @code{divs} and @code{divu} instructions instead of library function
21435 calls.
21437 @item -maccumulate-outgoing-args
21438 @opindex maccumulate-outgoing-args
21439 Reserve space once for outgoing arguments in the function prologue rather
21440 than around each call.  Generally beneficial for performance and size.  Also
21441 needed for unwinding to avoid changing the stack frame around conditional code.
21443 @item -mdivsi3_libfunc=@var{name}
21444 @opindex mdivsi3_libfunc=@var{name}
21445 Set the name of the library function used for 32-bit signed division to
21446 @var{name}.
21447 This only affects the name used in the @samp{call} and @samp{inv:call}
21448 division strategies, and the compiler still expects the same
21449 sets of input/output/clobbered registers as if this option were not present.
21451 @item -mfixed-range=@var{register-range}
21452 @opindex mfixed-range
21453 Generate code treating the given register range as fixed registers.
21454 A fixed register is one that the register allocator can not use.  This is
21455 useful when compiling kernel code.  A register range is specified as
21456 two registers separated by a dash.  Multiple register ranges can be
21457 specified separated by a comma.
21459 @item -mindexed-addressing
21460 @opindex mindexed-addressing
21461 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21462 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21463 semantics for the indexed addressing mode.  The architecture allows the
21464 implementation of processors with 64-bit MMU, which the OS could use to
21465 get 32-bit addressing, but since no current hardware implementation supports
21466 this or any other way to make the indexed addressing mode safe to use in
21467 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21469 @item -mgettrcost=@var{number}
21470 @opindex mgettrcost=@var{number}
21471 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21472 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21474 @item -mpt-fixed
21475 @opindex mpt-fixed
21476 Assume @code{pt*} instructions won't trap.  This generally generates
21477 better-scheduled code, but is unsafe on current hardware.
21478 The current architecture
21479 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21480 anded with 3 is 3.
21481 This has the unintentional effect of making it unsafe to schedule these
21482 instructions before a branch, or hoist them out of a loop.  For example,
21483 @code{__do_global_ctors}, a part of @file{libgcc}
21484 that runs constructors at program
21485 startup, calls functions in a list which is delimited by @minus{}1.  With the
21486 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21487 That means that all the constructors run a bit more quickly, but when
21488 the loop comes to the end of the list, the program crashes because @code{ptabs}
21489 loads @minus{}1 into a target register.  
21491 Since this option is unsafe for any
21492 hardware implementing the current architecture specification, the default
21493 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21494 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21495 this deters register allocation from using target registers for storing
21496 ordinary integers.
21498 @item -minvalid-symbols
21499 @opindex minvalid-symbols
21500 Assume symbols might be invalid.  Ordinary function symbols generated by
21501 the compiler are always valid to load with
21502 @code{movi}/@code{shori}/@code{ptabs} or
21503 @code{movi}/@code{shori}/@code{ptrel},
21504 but with assembler and/or linker tricks it is possible
21505 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21506 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21507 It prevents cross-basic-block CSE, hoisting and most scheduling
21508 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21510 @item -mbranch-cost=@var{num}
21511 @opindex mbranch-cost=@var{num}
21512 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21513 make the compiler try to generate more branch-free code if possible.  
21514 If not specified the value is selected depending on the processor type that
21515 is being compiled for.
21517 @item -mzdcbranch
21518 @itemx -mno-zdcbranch
21519 @opindex mzdcbranch
21520 @opindex mno-zdcbranch
21521 Assume (do not assume) that zero displacement conditional branch instructions
21522 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21523 compiler will try to prefer zero displacement branch code sequences.  This is
21524 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21525 disabled by specifying @option{-mno-zdcbranch}.
21527 @item -mfused-madd
21528 @itemx -mno-fused-madd
21529 @opindex mfused-madd
21530 @opindex mno-fused-madd
21531 Generate code that uses (does not use) the floating-point multiply and
21532 accumulate instructions.  These instructions are generated by default
21533 if hardware floating point is used.  The machine-dependent
21534 @option{-mfused-madd} option is now mapped to the machine-independent
21535 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21536 mapped to @option{-ffp-contract=off}.
21538 @item -mfsca
21539 @itemx -mno-fsca
21540 @opindex mfsca
21541 @opindex mno-fsca
21542 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21543 and cosine approximations.  The option @code{-mfsca} must be used in
21544 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
21545 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
21546 approximations even if @code{-funsafe-math-optimizations} is in effect.
21548 @item -mfsrra
21549 @itemx -mno-fsrra
21550 @opindex mfsrra
21551 @opindex mno-fsrra
21552 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21553 reciprocal square root approximations.  The option @code{-mfsrra} must be used
21554 in combination with @code{-funsafe-math-optimizations} and
21555 @code{-ffinite-math-only}.  It is enabled by default when generating code for
21556 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
21557 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
21558 in effect.
21560 @item -mpretend-cmove
21561 @opindex mpretend-cmove
21562 Prefer zero-displacement conditional branches for conditional move instruction
21563 patterns.  This can result in faster code on the SH4 processor.
21565 @end table
21567 @node Solaris 2 Options
21568 @subsection Solaris 2 Options
21569 @cindex Solaris 2 options
21571 These @samp{-m} options are supported on Solaris 2:
21573 @table @gcctabopt
21574 @item -mclear-hwcap
21575 @opindex mclear-hwcap
21576 @option{-mclear-hwcap} tells the compiler to remove the hardware
21577 capabilities generated by the Solaris assembler.  This is only necessary
21578 when object files use ISA extensions not supported by the current
21579 machine, but check at runtime whether or not to use them.
21581 @item -mimpure-text
21582 @opindex mimpure-text
21583 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21584 the compiler to not pass @option{-z text} to the linker when linking a
21585 shared object.  Using this option, you can link position-dependent
21586 code into a shared object.
21588 @option{-mimpure-text} suppresses the ``relocations remain against
21589 allocatable but non-writable sections'' linker error message.
21590 However, the necessary relocations trigger copy-on-write, and the
21591 shared object is not actually shared across processes.  Instead of
21592 using @option{-mimpure-text}, you should compile all source code with
21593 @option{-fpic} or @option{-fPIC}.
21595 @end table
21597 These switches are supported in addition to the above on Solaris 2:
21599 @table @gcctabopt
21600 @item -pthreads
21601 @opindex pthreads
21602 Add support for multithreading using the POSIX threads library.  This
21603 option sets flags for both the preprocessor and linker.  This option does
21604 not affect the thread safety of object code produced  by the compiler or
21605 that of libraries supplied with it.
21607 @item -pthread
21608 @opindex pthread
21609 This is a synonym for @option{-pthreads}.
21610 @end table
21612 @node SPARC Options
21613 @subsection SPARC Options
21614 @cindex SPARC options
21616 These @samp{-m} options are supported on the SPARC:
21618 @table @gcctabopt
21619 @item -mno-app-regs
21620 @itemx -mapp-regs
21621 @opindex mno-app-regs
21622 @opindex mapp-regs
21623 Specify @option{-mapp-regs} to generate output using the global registers
21624 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21625 global register 1, each global register 2 through 4 is then treated as an
21626 allocable register that is clobbered by function calls.  This is the default.
21628 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21629 specify @option{-mno-app-regs}.  You should compile libraries and system
21630 software with this option.
21632 @item -mflat
21633 @itemx -mno-flat
21634 @opindex mflat
21635 @opindex mno-flat
21636 With @option{-mflat}, the compiler does not generate save/restore instructions
21637 and uses a ``flat'' or single register window model.  This model is compatible
21638 with the regular register window model.  The local registers and the input
21639 registers (0--5) are still treated as ``call-saved'' registers and are
21640 saved on the stack as needed.
21642 With @option{-mno-flat} (the default), the compiler generates save/restore
21643 instructions (except for leaf functions).  This is the normal operating mode.
21645 @item -mfpu
21646 @itemx -mhard-float
21647 @opindex mfpu
21648 @opindex mhard-float
21649 Generate output containing floating-point instructions.  This is the
21650 default.
21652 @item -mno-fpu
21653 @itemx -msoft-float
21654 @opindex mno-fpu
21655 @opindex msoft-float
21656 Generate output containing library calls for floating point.
21657 @strong{Warning:} the requisite libraries are not available for all SPARC
21658 targets.  Normally the facilities of the machine's usual C compiler are
21659 used, but this cannot be done directly in cross-compilation.  You must make
21660 your own arrangements to provide suitable library functions for
21661 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21662 @samp{sparclite-*-*} do provide software floating-point support.
21664 @option{-msoft-float} changes the calling convention in the output file;
21665 therefore, it is only useful if you compile @emph{all} of a program with
21666 this option.  In particular, you need to compile @file{libgcc.a}, the
21667 library that comes with GCC, with @option{-msoft-float} in order for
21668 this to work.
21670 @item -mhard-quad-float
21671 @opindex mhard-quad-float
21672 Generate output containing quad-word (long double) floating-point
21673 instructions.
21675 @item -msoft-quad-float
21676 @opindex msoft-quad-float
21677 Generate output containing library calls for quad-word (long double)
21678 floating-point instructions.  The functions called are those specified
21679 in the SPARC ABI@.  This is the default.
21681 As of this writing, there are no SPARC implementations that have hardware
21682 support for the quad-word floating-point instructions.  They all invoke
21683 a trap handler for one of these instructions, and then the trap handler
21684 emulates the effect of the instruction.  Because of the trap handler overhead,
21685 this is much slower than calling the ABI library routines.  Thus the
21686 @option{-msoft-quad-float} option is the default.
21688 @item -mno-unaligned-doubles
21689 @itemx -munaligned-doubles
21690 @opindex mno-unaligned-doubles
21691 @opindex munaligned-doubles
21692 Assume that doubles have 8-byte alignment.  This is the default.
21694 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21695 alignment only if they are contained in another type, or if they have an
21696 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21697 Specifying this option avoids some rare compatibility problems with code
21698 generated by other compilers.  It is not the default because it results
21699 in a performance loss, especially for floating-point code.
21701 @item -muser-mode
21702 @itemx -mno-user-mode
21703 @opindex muser-mode
21704 @opindex mno-user-mode
21705 Do not generate code that can only run in supervisor mode.  This is relevant
21706 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21707 default is @option{-mno-user-mode}.
21709 @item -mno-faster-structs
21710 @itemx -mfaster-structs
21711 @opindex mno-faster-structs
21712 @opindex mfaster-structs
21713 With @option{-mfaster-structs}, the compiler assumes that structures
21714 should have 8-byte alignment.  This enables the use of pairs of
21715 @code{ldd} and @code{std} instructions for copies in structure
21716 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21717 However, the use of this changed alignment directly violates the SPARC
21718 ABI@.  Thus, it's intended only for use on targets where the developer
21719 acknowledges that their resulting code is not directly in line with
21720 the rules of the ABI@.
21722 @item -mcpu=@var{cpu_type}
21723 @opindex mcpu
21724 Set the instruction set, register set, and instruction scheduling parameters
21725 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21726 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21727 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21728 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21729 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21730 @samp{niagara3} and @samp{niagara4}.
21732 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21733 which selects the best architecture option for the host processor.
21734 @option{-mcpu=native} has no effect if GCC does not recognize
21735 the processor.
21737 Default instruction scheduling parameters are used for values that select
21738 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21739 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21741 Here is a list of each supported architecture and their supported
21742 implementations.
21744 @table @asis
21745 @item v7
21746 cypress, leon3v7
21748 @item v8
21749 supersparc, hypersparc, leon, leon3
21751 @item sparclite
21752 f930, f934, sparclite86x
21754 @item sparclet
21755 tsc701
21757 @item v9
21758 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21759 @end table
21761 By default (unless configured otherwise), GCC generates code for the V7
21762 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21763 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21764 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21765 SPARCStation 1, 2, IPX etc.
21767 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21768 architecture.  The only difference from V7 code is that the compiler emits
21769 the integer multiply and integer divide instructions which exist in SPARC-V8
21770 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21771 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21772 2000 series.
21774 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21775 the SPARC architecture.  This adds the integer multiply, integer divide step
21776 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21777 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21778 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21779 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21780 MB86934 chip, which is the more recent SPARClite with FPU@.
21782 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21783 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21784 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21785 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21786 optimizes it for the TEMIC SPARClet chip.
21788 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21789 architecture.  This adds 64-bit integer and floating-point move instructions,
21790 3 additional floating-point condition code registers and conditional move
21791 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21792 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21793 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21794 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21795 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21796 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21797 additionally optimizes it for Sun UltraSPARC T2 chips. With
21798 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21799 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21800 additionally optimizes it for Sun UltraSPARC T4 chips.
21802 @item -mtune=@var{cpu_type}
21803 @opindex mtune
21804 Set the instruction scheduling parameters for machine type
21805 @var{cpu_type}, but do not set the instruction set or register set that the
21806 option @option{-mcpu=@var{cpu_type}} does.
21808 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21809 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21810 that select a particular CPU implementation.  Those are @samp{cypress},
21811 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21812 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21813 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21814 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21815 toolchains, @samp{native} can also be used.
21817 @item -mv8plus
21818 @itemx -mno-v8plus
21819 @opindex mv8plus
21820 @opindex mno-v8plus
21821 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21822 difference from the V8 ABI is that the global and out registers are
21823 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21824 mode for all SPARC-V9 processors.
21826 @item -mvis
21827 @itemx -mno-vis
21828 @opindex mvis
21829 @opindex mno-vis
21830 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21831 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21833 @item -mvis2
21834 @itemx -mno-vis2
21835 @opindex mvis2
21836 @opindex mno-vis2
21837 With @option{-mvis2}, GCC generates code that takes advantage of
21838 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21839 default is @option{-mvis2} when targeting a cpu that supports such
21840 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21841 also sets @option{-mvis}.
21843 @item -mvis3
21844 @itemx -mno-vis3
21845 @opindex mvis3
21846 @opindex mno-vis3
21847 With @option{-mvis3}, GCC generates code that takes advantage of
21848 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21849 default is @option{-mvis3} when targeting a cpu that supports such
21850 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21851 also sets @option{-mvis2} and @option{-mvis}.
21853 @item -mcbcond
21854 @itemx -mno-cbcond
21855 @opindex mcbcond
21856 @opindex mno-cbcond
21857 With @option{-mcbcond}, GCC generates code that takes advantage of
21858 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21859 The default is @option{-mcbcond} when targeting a cpu that supports such
21860 instructions, such as niagara-4 and later.
21862 @item -mpopc
21863 @itemx -mno-popc
21864 @opindex mpopc
21865 @opindex mno-popc
21866 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21867 population count instruction.  The default is @option{-mpopc}
21868 when targeting a cpu that supports such instructions, such as Niagara-2 and
21869 later.
21871 @item -mfmaf
21872 @itemx -mno-fmaf
21873 @opindex mfmaf
21874 @opindex mno-fmaf
21875 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21876 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21877 when targeting a cpu that supports such instructions, such as Niagara-3 and
21878 later.
21880 @item -mfix-at697f
21881 @opindex mfix-at697f
21882 Enable the documented workaround for the single erratum of the Atmel AT697F
21883 processor (which corresponds to erratum #13 of the AT697E processor).
21885 @item -mfix-ut699
21886 @opindex mfix-ut699
21887 Enable the documented workarounds for the floating-point errata and the data
21888 cache nullify errata of the UT699 processor.
21889 @end table
21891 These @samp{-m} options are supported in addition to the above
21892 on SPARC-V9 processors in 64-bit environments:
21894 @table @gcctabopt
21895 @item -m32
21896 @itemx -m64
21897 @opindex m32
21898 @opindex m64
21899 Generate code for a 32-bit or 64-bit environment.
21900 The 32-bit environment sets int, long and pointer to 32 bits.
21901 The 64-bit environment sets int to 32 bits and long and pointer
21902 to 64 bits.
21904 @item -mcmodel=@var{which}
21905 @opindex mcmodel
21906 Set the code model to one of
21908 @table @samp
21909 @item medlow
21910 The Medium/Low code model: 64-bit addresses, programs
21911 must be linked in the low 32 bits of memory.  Programs can be statically
21912 or dynamically linked.
21914 @item medmid
21915 The Medium/Middle code model: 64-bit addresses, programs
21916 must be linked in the low 44 bits of memory, the text and data segments must
21917 be less than 2GB in size and the data segment must be located within 2GB of
21918 the text segment.
21920 @item medany
21921 The Medium/Anywhere code model: 64-bit addresses, programs
21922 may be linked anywhere in memory, the text and data segments must be less
21923 than 2GB in size and the data segment must be located within 2GB of the
21924 text segment.
21926 @item embmedany
21927 The Medium/Anywhere code model for embedded systems:
21928 64-bit addresses, the text and data segments must be less than 2GB in
21929 size, both starting anywhere in memory (determined at link time).  The
21930 global register %g4 points to the base of the data segment.  Programs
21931 are statically linked and PIC is not supported.
21932 @end table
21934 @item -mmemory-model=@var{mem-model}
21935 @opindex mmemory-model
21936 Set the memory model in force on the processor to one of
21938 @table @samp
21939 @item default
21940 The default memory model for the processor and operating system.
21942 @item rmo
21943 Relaxed Memory Order
21945 @item pso
21946 Partial Store Order
21948 @item tso
21949 Total Store Order
21951 @item sc
21952 Sequential Consistency
21953 @end table
21955 These memory models are formally defined in Appendix D of the Sparc V9
21956 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21958 @item -mstack-bias
21959 @itemx -mno-stack-bias
21960 @opindex mstack-bias
21961 @opindex mno-stack-bias
21962 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21963 frame pointer if present, are offset by @minus{}2047 which must be added back
21964 when making stack frame references.  This is the default in 64-bit mode.
21965 Otherwise, assume no such offset is present.
21966 @end table
21968 @node SPU Options
21969 @subsection SPU Options
21970 @cindex SPU options
21972 These @samp{-m} options are supported on the SPU:
21974 @table @gcctabopt
21975 @item -mwarn-reloc
21976 @itemx -merror-reloc
21977 @opindex mwarn-reloc
21978 @opindex merror-reloc
21980 The loader for SPU does not handle dynamic relocations.  By default, GCC
21981 gives an error when it generates code that requires a dynamic
21982 relocation.  @option{-mno-error-reloc} disables the error,
21983 @option{-mwarn-reloc} generates a warning instead.
21985 @item -msafe-dma
21986 @itemx -munsafe-dma
21987 @opindex msafe-dma
21988 @opindex munsafe-dma
21990 Instructions that initiate or test completion of DMA must not be
21991 reordered with respect to loads and stores of the memory that is being
21992 accessed.
21993 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21994 memory accesses, but that can lead to inefficient code in places where the
21995 memory is known to not change.  Rather than mark the memory as volatile,
21996 you can use @option{-msafe-dma} to tell the compiler to treat
21997 the DMA instructions as potentially affecting all memory.  
21999 @item -mbranch-hints
22000 @opindex mbranch-hints
22002 By default, GCC generates a branch hint instruction to avoid
22003 pipeline stalls for always-taken or probably-taken branches.  A hint
22004 is not generated closer than 8 instructions away from its branch.
22005 There is little reason to disable them, except for debugging purposes,
22006 or to make an object a little bit smaller.
22008 @item -msmall-mem
22009 @itemx -mlarge-mem
22010 @opindex msmall-mem
22011 @opindex mlarge-mem
22013 By default, GCC generates code assuming that addresses are never larger
22014 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
22015 a full 32-bit address.
22017 @item -mstdmain
22018 @opindex mstdmain
22020 By default, GCC links against startup code that assumes the SPU-style
22021 main function interface (which has an unconventional parameter list).
22022 With @option{-mstdmain}, GCC links your program against startup
22023 code that assumes a C99-style interface to @code{main}, including a
22024 local copy of @code{argv} strings.
22026 @item -mfixed-range=@var{register-range}
22027 @opindex mfixed-range
22028 Generate code treating the given register range as fixed registers.
22029 A fixed register is one that the register allocator cannot use.  This is
22030 useful when compiling kernel code.  A register range is specified as
22031 two registers separated by a dash.  Multiple register ranges can be
22032 specified separated by a comma.
22034 @item -mea32
22035 @itemx -mea64
22036 @opindex mea32
22037 @opindex mea64
22038 Compile code assuming that pointers to the PPU address space accessed
22039 via the @code{__ea} named address space qualifier are either 32 or 64
22040 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
22041 all object code in an executable must be compiled with the same setting.
22043 @item -maddress-space-conversion
22044 @itemx -mno-address-space-conversion
22045 @opindex maddress-space-conversion
22046 @opindex mno-address-space-conversion
22047 Allow/disallow treating the @code{__ea} address space as superset
22048 of the generic address space.  This enables explicit type casts
22049 between @code{__ea} and generic pointer as well as implicit
22050 conversions of generic pointers to @code{__ea} pointers.  The
22051 default is to allow address space pointer conversions.
22053 @item -mcache-size=@var{cache-size}
22054 @opindex mcache-size
22055 This option controls the version of libgcc that the compiler links to an
22056 executable and selects a software-managed cache for accessing variables
22057 in the @code{__ea} address space with a particular cache size.  Possible
22058 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
22059 and @samp{128}.  The default cache size is 64KB.
22061 @item -matomic-updates
22062 @itemx -mno-atomic-updates
22063 @opindex matomic-updates
22064 @opindex mno-atomic-updates
22065 This option controls the version of libgcc that the compiler links to an
22066 executable and selects whether atomic updates to the software-managed
22067 cache of PPU-side variables are used.  If you use atomic updates, changes
22068 to a PPU variable from SPU code using the @code{__ea} named address space
22069 qualifier do not interfere with changes to other PPU variables residing
22070 in the same cache line from PPU code.  If you do not use atomic updates,
22071 such interference may occur; however, writing back cache lines is
22072 more efficient.  The default behavior is to use atomic updates.
22074 @item -mdual-nops
22075 @itemx -mdual-nops=@var{n}
22076 @opindex mdual-nops
22077 By default, GCC inserts nops to increase dual issue when it expects
22078 it to increase performance.  @var{n} can be a value from 0 to 10.  A
22079 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
22080 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
22082 @item -mhint-max-nops=@var{n}
22083 @opindex mhint-max-nops
22084 Maximum number of nops to insert for a branch hint.  A branch hint must
22085 be at least 8 instructions away from the branch it is affecting.  GCC
22086 inserts up to @var{n} nops to enforce this, otherwise it does not
22087 generate the branch hint.
22089 @item -mhint-max-distance=@var{n}
22090 @opindex mhint-max-distance
22091 The encoding of the branch hint instruction limits the hint to be within
22092 256 instructions of the branch it is affecting.  By default, GCC makes
22093 sure it is within 125.
22095 @item -msafe-hints
22096 @opindex msafe-hints
22097 Work around a hardware bug that causes the SPU to stall indefinitely.
22098 By default, GCC inserts the @code{hbrp} instruction to make sure
22099 this stall won't happen.
22101 @end table
22103 @node System V Options
22104 @subsection Options for System V
22106 These additional options are available on System V Release 4 for
22107 compatibility with other compilers on those systems:
22109 @table @gcctabopt
22110 @item -G
22111 @opindex G
22112 Create a shared object.
22113 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
22115 @item -Qy
22116 @opindex Qy
22117 Identify the versions of each tool used by the compiler, in a
22118 @code{.ident} assembler directive in the output.
22120 @item -Qn
22121 @opindex Qn
22122 Refrain from adding @code{.ident} directives to the output file (this is
22123 the default).
22125 @item -YP,@var{dirs}
22126 @opindex YP
22127 Search the directories @var{dirs}, and no others, for libraries
22128 specified with @option{-l}.
22130 @item -Ym,@var{dir}
22131 @opindex Ym
22132 Look in the directory @var{dir} to find the M4 preprocessor.
22133 The assembler uses this option.
22134 @c This is supposed to go with a -Yd for predefined M4 macro files, but
22135 @c the generic assembler that comes with Solaris takes just -Ym.
22136 @end table
22138 @node TILE-Gx Options
22139 @subsection TILE-Gx Options
22140 @cindex TILE-Gx options
22142 These @samp{-m} options are supported on the TILE-Gx:
22144 @table @gcctabopt
22145 @item -mcmodel=small
22146 @opindex mcmodel=small
22147 Generate code for the small model.  The distance for direct calls is
22148 limited to 500M in either direction.  PC-relative addresses are 32
22149 bits.  Absolute addresses support the full address range.
22151 @item -mcmodel=large
22152 @opindex mcmodel=large
22153 Generate code for the large model.  There is no limitation on call
22154 distance, pc-relative addresses, or absolute addresses.
22156 @item -mcpu=@var{name}
22157 @opindex mcpu
22158 Selects the type of CPU to be targeted.  Currently the only supported
22159 type is @samp{tilegx}.
22161 @item -m32
22162 @itemx -m64
22163 @opindex m32
22164 @opindex m64
22165 Generate code for a 32-bit or 64-bit environment.  The 32-bit
22166 environment sets int, long, and pointer to 32 bits.  The 64-bit
22167 environment sets int to 32 bits and long and pointer to 64 bits.
22169 @item -mbig-endian
22170 @itemx -mlittle-endian
22171 @opindex mbig-endian
22172 @opindex mlittle-endian
22173 Generate code in big/little endian mode, respectively.
22174 @end table
22176 @node TILEPro Options
22177 @subsection TILEPro Options
22178 @cindex TILEPro options
22180 These @samp{-m} options are supported on the TILEPro:
22182 @table @gcctabopt
22183 @item -mcpu=@var{name}
22184 @opindex mcpu
22185 Selects the type of CPU to be targeted.  Currently the only supported
22186 type is @samp{tilepro}.
22188 @item -m32
22189 @opindex m32
22190 Generate code for a 32-bit environment, which sets int, long, and
22191 pointer to 32 bits.  This is the only supported behavior so the flag
22192 is essentially ignored.
22193 @end table
22195 @node V850 Options
22196 @subsection V850 Options
22197 @cindex V850 Options
22199 These @samp{-m} options are defined for V850 implementations:
22201 @table @gcctabopt
22202 @item -mlong-calls
22203 @itemx -mno-long-calls
22204 @opindex mlong-calls
22205 @opindex mno-long-calls
22206 Treat all calls as being far away (near).  If calls are assumed to be
22207 far away, the compiler always loads the function's address into a
22208 register, and calls indirect through the pointer.
22210 @item -mno-ep
22211 @itemx -mep
22212 @opindex mno-ep
22213 @opindex mep
22214 Do not optimize (do optimize) basic blocks that use the same index
22215 pointer 4 or more times to copy pointer into the @code{ep} register, and
22216 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
22217 option is on by default if you optimize.
22219 @item -mno-prolog-function
22220 @itemx -mprolog-function
22221 @opindex mno-prolog-function
22222 @opindex mprolog-function
22223 Do not use (do use) external functions to save and restore registers
22224 at the prologue and epilogue of a function.  The external functions
22225 are slower, but use less code space if more than one function saves
22226 the same number of registers.  The @option{-mprolog-function} option
22227 is on by default if you optimize.
22229 @item -mspace
22230 @opindex mspace
22231 Try to make the code as small as possible.  At present, this just turns
22232 on the @option{-mep} and @option{-mprolog-function} options.
22234 @item -mtda=@var{n}
22235 @opindex mtda
22236 Put static or global variables whose size is @var{n} bytes or less into
22237 the tiny data area that register @code{ep} points to.  The tiny data
22238 area can hold up to 256 bytes in total (128 bytes for byte references).
22240 @item -msda=@var{n}
22241 @opindex msda
22242 Put static or global variables whose size is @var{n} bytes or less into
22243 the small data area that register @code{gp} points to.  The small data
22244 area can hold up to 64 kilobytes.
22246 @item -mzda=@var{n}
22247 @opindex mzda
22248 Put static or global variables whose size is @var{n} bytes or less into
22249 the first 32 kilobytes of memory.
22251 @item -mv850
22252 @opindex mv850
22253 Specify that the target processor is the V850.
22255 @item -mv850e3v5
22256 @opindex mv850e3v5
22257 Specify that the target processor is the V850E3V5.  The preprocessor
22258 constant @samp{__v850e3v5__} is defined if this option is used.
22260 @item -mv850e2v4
22261 @opindex mv850e2v4
22262 Specify that the target processor is the V850E3V5.  This is an alias for
22263 the @option{-mv850e3v5} option.
22265 @item -mv850e2v3
22266 @opindex mv850e2v3
22267 Specify that the target processor is the V850E2V3.  The preprocessor
22268 constant @samp{__v850e2v3__} is defined if this option is used.
22270 @item -mv850e2
22271 @opindex mv850e2
22272 Specify that the target processor is the V850E2.  The preprocessor
22273 constant @samp{__v850e2__} is defined if this option is used.
22275 @item -mv850e1
22276 @opindex mv850e1
22277 Specify that the target processor is the V850E1.  The preprocessor
22278 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
22279 this option is used.
22281 @item -mv850es
22282 @opindex mv850es
22283 Specify that the target processor is the V850ES.  This is an alias for
22284 the @option{-mv850e1} option.
22286 @item -mv850e
22287 @opindex mv850e
22288 Specify that the target processor is the V850E@.  The preprocessor
22289 constant @samp{__v850e__} is defined if this option is used.
22291 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22292 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22293 are defined then a default target processor is chosen and the
22294 relevant @samp{__v850*__} preprocessor constant is defined.
22296 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
22297 defined, regardless of which processor variant is the target.
22299 @item -mdisable-callt
22300 @itemx -mno-disable-callt
22301 @opindex mdisable-callt
22302 @opindex mno-disable-callt
22303 This option suppresses generation of the @code{CALLT} instruction for the
22304 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22305 architecture.
22307 This option is enabled by default when the RH850 ABI is
22308 in use (see @option{-mrh850-abi}), and disabled by default when the
22309 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22310 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
22312 @item -mrelax
22313 @itemx -mno-relax
22314 @opindex mrelax
22315 @opindex mno-relax
22316 Pass on (or do not pass on) the @option{-mrelax} command line option
22317 to the assembler.
22319 @item -mlong-jumps
22320 @itemx -mno-long-jumps
22321 @opindex mlong-jumps
22322 @opindex mno-long-jumps
22323 Disable (or re-enable) the generation of PC-relative jump instructions.
22325 @item -msoft-float
22326 @itemx -mhard-float
22327 @opindex msoft-float
22328 @opindex mhard-float
22329 Disable (or re-enable) the generation of hardware floating point
22330 instructions.  This option is only significant when the target
22331 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22332 instructions are being generated then the C preprocessor symbol
22333 @code{__FPU_OK__} will be defined, otherwise the symbol
22334 @code{__NO_FPU__} will be defined.
22336 @item -mloop
22337 @opindex mloop
22338 Enables the use of the e3v5 LOOP instruction.  The use of this
22339 instruction is not enabled by default when the e3v5 architecture is
22340 selected because its use is still experimental.
22342 @item -mrh850-abi
22343 @itemx -mghs
22344 @opindex mrh850-abi
22345 @opindex mghs
22346 Enables support for the RH850 version of the V850 ABI.  This is the
22347 default.  With this version of the ABI the following rules apply:
22349 @itemize
22350 @item
22351 Integer sized structures and unions are returned via a memory pointer
22352 rather than a register.
22354 @item
22355 Large structures and unions (more than 8 bytes in size) are passed by
22356 value.
22358 @item
22359 Functions are aligned to 16-bit boundaries.
22361 @item
22362 The @option{-m8byte-align} command line option is supported.
22364 @item
22365 The @option{-mdisable-callt} command line option is enabled by
22366 default.  The @option{-mno-disable-callt} command line option is not
22367 supported.
22368 @end itemize
22370 When this version of the ABI is enabled the C preprocessor symbol
22371 @code{__V850_RH850_ABI__} is defined.
22373 @item -mgcc-abi
22374 @opindex mgcc-abi
22375 Enables support for the old GCC version of the V850 ABI.  With this
22376 version of the ABI the following rules apply:
22378 @itemize
22379 @item
22380 Integer sized structures and unions are returned in register @code{r10}.
22382 @item
22383 Large structures and unions (more than 8 bytes in size) are passed by
22384 reference.
22386 @item
22387 Functions are aligned to 32-bit boundaries, unless optimizing for
22388 size.
22390 @item
22391 The @option{-m8byte-align} command line option is not supported.
22393 @item
22394 The @option{-mdisable-callt} command line option is supported but not
22395 enabled by default.
22396 @end itemize
22398 When this version of the ABI is enabled the C preprocessor symbol
22399 @code{__V850_GCC_ABI__} is defined.
22401 @item -m8byte-align
22402 @itemx -mno-8byte-align
22403 @opindex m8byte-align
22404 @opindex mno-8byte-align
22405 Enables support for @code{doubles} and @code{long long} types to be
22406 aligned on 8-byte boundaries.  The default is to restrict the
22407 alignment of all objects to at most 4-bytes.  When
22408 @option{-m8byte-align} is in effect the C preprocessor symbol
22409 @code{__V850_8BYTE_ALIGN__} will be defined.
22411 @item -mbig-switch
22412 @opindex mbig-switch
22413 Generate code suitable for big switch tables.  Use this option only if
22414 the assembler/linker complain about out of range branches within a switch
22415 table.
22417 @item -mapp-regs
22418 @opindex mapp-regs
22419 This option causes r2 and r5 to be used in the code generated by
22420 the compiler.  This setting is the default.
22422 @item -mno-app-regs
22423 @opindex mno-app-regs
22424 This option causes r2 and r5 to be treated as fixed registers.
22426 @end table
22428 @node VAX Options
22429 @subsection VAX Options
22430 @cindex VAX options
22432 These @samp{-m} options are defined for the VAX:
22434 @table @gcctabopt
22435 @item -munix
22436 @opindex munix
22437 Do not output certain jump instructions (@code{aobleq} and so on)
22438 that the Unix assembler for the VAX cannot handle across long
22439 ranges.
22441 @item -mgnu
22442 @opindex mgnu
22443 Do output those jump instructions, on the assumption that the
22444 GNU assembler is being used.
22446 @item -mg
22447 @opindex mg
22448 Output code for G-format floating-point numbers instead of D-format.
22449 @end table
22451 @node VMS Options
22452 @subsection VMS Options
22454 These @samp{-m} options are defined for the VMS implementations:
22456 @table @gcctabopt
22457 @item -mvms-return-codes
22458 @opindex mvms-return-codes
22459 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22460 condition (e.g.@ error) codes.
22462 @item -mdebug-main=@var{prefix}
22463 @opindex mdebug-main=@var{prefix}
22464 Flag the first routine whose name starts with @var{prefix} as the main
22465 routine for the debugger.
22467 @item -mmalloc64
22468 @opindex mmalloc64
22469 Default to 64-bit memory allocation routines.
22471 @item -mpointer-size=@var{size}
22472 @opindex -mpointer-size=@var{size}
22473 Set the default size of pointers. Possible options for @var{size} are
22474 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22475 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22476 The later option disables @code{pragma pointer_size}.
22477 @end table
22479 @node VxWorks Options
22480 @subsection VxWorks Options
22481 @cindex VxWorks Options
22483 The options in this section are defined for all VxWorks targets.
22484 Options specific to the target hardware are listed with the other
22485 options for that target.
22487 @table @gcctabopt
22488 @item -mrtp
22489 @opindex mrtp
22490 GCC can generate code for both VxWorks kernels and real time processes
22491 (RTPs).  This option switches from the former to the latter.  It also
22492 defines the preprocessor macro @code{__RTP__}.
22494 @item -non-static
22495 @opindex non-static
22496 Link an RTP executable against shared libraries rather than static
22497 libraries.  The options @option{-static} and @option{-shared} can
22498 also be used for RTPs (@pxref{Link Options}); @option{-static}
22499 is the default.
22501 @item -Bstatic
22502 @itemx -Bdynamic
22503 @opindex Bstatic
22504 @opindex Bdynamic
22505 These options are passed down to the linker.  They are defined for
22506 compatibility with Diab.
22508 @item -Xbind-lazy
22509 @opindex Xbind-lazy
22510 Enable lazy binding of function calls.  This option is equivalent to
22511 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22513 @item -Xbind-now
22514 @opindex Xbind-now
22515 Disable lazy binding of function calls.  This option is the default and
22516 is defined for compatibility with Diab.
22517 @end table
22519 @node x86-64 Options
22520 @subsection x86-64 Options
22521 @cindex x86-64 options
22523 These are listed under @xref{i386 and x86-64 Options}.
22525 @node Xstormy16 Options
22526 @subsection Xstormy16 Options
22527 @cindex Xstormy16 Options
22529 These options are defined for Xstormy16:
22531 @table @gcctabopt
22532 @item -msim
22533 @opindex msim
22534 Choose startup files and linker script suitable for the simulator.
22535 @end table
22537 @node Xtensa Options
22538 @subsection Xtensa Options
22539 @cindex Xtensa Options
22541 These options are supported for Xtensa targets:
22543 @table @gcctabopt
22544 @item -mconst16
22545 @itemx -mno-const16
22546 @opindex mconst16
22547 @opindex mno-const16
22548 Enable or disable use of @code{CONST16} instructions for loading
22549 constant values.  The @code{CONST16} instruction is currently not a
22550 standard option from Tensilica.  When enabled, @code{CONST16}
22551 instructions are always used in place of the standard @code{L32R}
22552 instructions.  The use of @code{CONST16} is enabled by default only if
22553 the @code{L32R} instruction is not available.
22555 @item -mfused-madd
22556 @itemx -mno-fused-madd
22557 @opindex mfused-madd
22558 @opindex mno-fused-madd
22559 Enable or disable use of fused multiply/add and multiply/subtract
22560 instructions in the floating-point option.  This has no effect if the
22561 floating-point option is not also enabled.  Disabling fused multiply/add
22562 and multiply/subtract instructions forces the compiler to use separate
22563 instructions for the multiply and add/subtract operations.  This may be
22564 desirable in some cases where strict IEEE 754-compliant results are
22565 required: the fused multiply add/subtract instructions do not round the
22566 intermediate result, thereby producing results with @emph{more} bits of
22567 precision than specified by the IEEE standard.  Disabling fused multiply
22568 add/subtract instructions also ensures that the program output is not
22569 sensitive to the compiler's ability to combine multiply and add/subtract
22570 operations.
22572 @item -mserialize-volatile
22573 @itemx -mno-serialize-volatile
22574 @opindex mserialize-volatile
22575 @opindex mno-serialize-volatile
22576 When this option is enabled, GCC inserts @code{MEMW} instructions before
22577 @code{volatile} memory references to guarantee sequential consistency.
22578 The default is @option{-mserialize-volatile}.  Use
22579 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22581 @item -mforce-no-pic
22582 @opindex mforce-no-pic
22583 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22584 position-independent code (PIC), this option disables PIC for compiling
22585 kernel code.
22587 @item -mtext-section-literals
22588 @itemx -mno-text-section-literals
22589 @opindex mtext-section-literals
22590 @opindex mno-text-section-literals
22591 Control the treatment of literal pools.  The default is
22592 @option{-mno-text-section-literals}, which places literals in a separate
22593 section in the output file.  This allows the literal pool to be placed
22594 in a data RAM/ROM, and it also allows the linker to combine literal
22595 pools from separate object files to remove redundant literals and
22596 improve code size.  With @option{-mtext-section-literals}, the literals
22597 are interspersed in the text section in order to keep them as close as
22598 possible to their references.  This may be necessary for large assembly
22599 files.
22601 @item -mtarget-align
22602 @itemx -mno-target-align
22603 @opindex mtarget-align
22604 @opindex mno-target-align
22605 When this option is enabled, GCC instructs the assembler to
22606 automatically align instructions to reduce branch penalties at the
22607 expense of some code density.  The assembler attempts to widen density
22608 instructions to align branch targets and the instructions following call
22609 instructions.  If there are not enough preceding safe density
22610 instructions to align a target, no widening is performed.  The
22611 default is @option{-mtarget-align}.  These options do not affect the
22612 treatment of auto-aligned instructions like @code{LOOP}, which the
22613 assembler always aligns, either by widening density instructions or
22614 by inserting NOP instructions.
22616 @item -mlongcalls
22617 @itemx -mno-longcalls
22618 @opindex mlongcalls
22619 @opindex mno-longcalls
22620 When this option is enabled, GCC instructs the assembler to translate
22621 direct calls to indirect calls unless it can determine that the target
22622 of a direct call is in the range allowed by the call instruction.  This
22623 translation typically occurs for calls to functions in other source
22624 files.  Specifically, the assembler translates a direct @code{CALL}
22625 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22626 The default is @option{-mno-longcalls}.  This option should be used in
22627 programs where the call target can potentially be out of range.  This
22628 option is implemented in the assembler, not the compiler, so the
22629 assembly code generated by GCC still shows direct call
22630 instructions---look at the disassembled object code to see the actual
22631 instructions.  Note that the assembler uses an indirect call for
22632 every cross-file call, not just those that really are out of range.
22633 @end table
22635 @node zSeries Options
22636 @subsection zSeries Options
22637 @cindex zSeries options
22639 These are listed under @xref{S/390 and zSeries Options}.
22641 @node Code Gen Options
22642 @section Options for Code Generation Conventions
22643 @cindex code generation conventions
22644 @cindex options, code generation
22645 @cindex run-time options
22647 These machine-independent options control the interface conventions
22648 used in code generation.
22650 Most of them have both positive and negative forms; the negative form
22651 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22652 one of the forms is listed---the one that is not the default.  You
22653 can figure out the other form by either removing @samp{no-} or adding
22656 @table @gcctabopt
22657 @item -fbounds-check
22658 @opindex fbounds-check
22659 For front ends that support it, generate additional code to check that
22660 indices used to access arrays are within the declared range.  This is
22661 currently only supported by the Java and Fortran front ends, where
22662 this option defaults to true and false respectively.
22664 @item -fstack-reuse=@var{reuse-level}
22665 @opindex fstack_reuse
22666 This option controls stack space reuse for user declared local/auto variables
22667 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22668 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22669 local variables and temporaries, @samp{named_vars} enables the reuse only for
22670 user defined local variables with names, and @samp{none} disables stack reuse
22671 completely. The default value is @samp{all}. The option is needed when the
22672 program extends the lifetime of a scoped local variable or a compiler generated
22673 temporary beyond the end point defined by the language.  When a lifetime of
22674 a variable ends, and if the variable lives in memory, the optimizing compiler
22675 has the freedom to reuse its stack space with other temporaries or scoped
22676 local variables whose live range does not overlap with it. Legacy code extending
22677 local lifetime will likely to break with the stack reuse optimization.
22679 For example,
22681 @smallexample
22682    int *p;
22683    @{
22684      int local1;
22686      p = &local1;
22687      local1 = 10;
22688      ....
22689    @}
22690    @{
22691       int local2;
22692       local2 = 20;
22693       ...
22694    @}
22696    if (*p == 10)  // out of scope use of local1
22697      @{
22699      @}
22700 @end smallexample
22702 Another example:
22703 @smallexample
22705    struct A
22706    @{
22707        A(int k) : i(k), j(k) @{ @}
22708        int i;
22709        int j;
22710    @};
22712    A *ap;
22714    void foo(const A& ar)
22715    @{
22716       ap = &ar;
22717    @}
22719    void bar()
22720    @{
22721       foo(A(10)); // temp object's lifetime ends when foo returns
22723       @{
22724         A a(20);
22725         ....
22726       @}
22727       ap->i+= 10;  // ap references out of scope temp whose space
22728                    // is reused with a. What is the value of ap->i?
22729    @}
22731 @end smallexample
22733 The lifetime of a compiler generated temporary is well defined by the C++
22734 standard. When a lifetime of a temporary ends, and if the temporary lives
22735 in memory, the optimizing compiler has the freedom to reuse its stack
22736 space with other temporaries or scoped local variables whose live range
22737 does not overlap with it. However some of the legacy code relies on
22738 the behavior of older compilers in which temporaries' stack space is
22739 not reused, the aggressive stack reuse can lead to runtime errors. This
22740 option is used to control the temporary stack reuse optimization.
22742 @item -ftrapv
22743 @opindex ftrapv
22744 This option generates traps for signed overflow on addition, subtraction,
22745 multiplication operations.
22747 @item -fwrapv
22748 @opindex fwrapv
22749 This option instructs the compiler to assume that signed arithmetic
22750 overflow of addition, subtraction and multiplication wraps around
22751 using twos-complement representation.  This flag enables some optimizations
22752 and disables others.  This option is enabled by default for the Java
22753 front end, as required by the Java language specification.
22755 @item -fexceptions
22756 @opindex fexceptions
22757 Enable exception handling.  Generates extra code needed to propagate
22758 exceptions.  For some targets, this implies GCC generates frame
22759 unwind information for all functions, which can produce significant data
22760 size overhead, although it does not affect execution.  If you do not
22761 specify this option, GCC enables it by default for languages like
22762 C++ that normally require exception handling, and disables it for
22763 languages like C that do not normally require it.  However, you may need
22764 to enable this option when compiling C code that needs to interoperate
22765 properly with exception handlers written in C++.  You may also wish to
22766 disable this option if you are compiling older C++ programs that don't
22767 use exception handling.
22769 @item -fnon-call-exceptions
22770 @opindex fnon-call-exceptions
22771 Generate code that allows trapping instructions to throw exceptions.
22772 Note that this requires platform-specific runtime support that does
22773 not exist everywhere.  Moreover, it only allows @emph{trapping}
22774 instructions to throw exceptions, i.e.@: memory references or floating-point
22775 instructions.  It does not allow exceptions to be thrown from
22776 arbitrary signal handlers such as @code{SIGALRM}.
22778 @item -fdelete-dead-exceptions
22779 @opindex fdelete-dead-exceptions
22780 Consider that instructions that may throw exceptions but don't otherwise
22781 contribute to the execution of the program can be optimized away.
22782 This option is enabled by default for the Ada front end, as permitted by
22783 the Ada language specification.
22784 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22786 @item -funwind-tables
22787 @opindex funwind-tables
22788 Similar to @option{-fexceptions}, except that it just generates any needed
22789 static data, but does not affect the generated code in any other way.
22790 You normally do not need to enable this option; instead, a language processor
22791 that needs this handling enables it on your behalf.
22793 @item -fasynchronous-unwind-tables
22794 @opindex fasynchronous-unwind-tables
22795 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22796 table is exact at each instruction boundary, so it can be used for stack
22797 unwinding from asynchronous events (such as debugger or garbage collector).
22799 @item -fno-gnu-unique
22800 @opindex fno-gnu-unique
22801 On systems with recent GNU assembler and C library, the C++ compiler
22802 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22803 of template static data members and static local variables in inline
22804 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22805 is necessary to avoid problems with a library used by two different
22806 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22807 therefore disagreeing with the other one about the binding of the
22808 symbol.  But this causes @code{dlclose} to be ignored for affected
22809 DSOs; if your program relies on reinitialization of a DSO via
22810 @code{dlclose} and @code{dlopen}, you can use
22811 @option{-fno-gnu-unique}.
22813 @item -fpcc-struct-return
22814 @opindex fpcc-struct-return
22815 Return ``short'' @code{struct} and @code{union} values in memory like
22816 longer ones, rather than in registers.  This convention is less
22817 efficient, but it has the advantage of allowing intercallability between
22818 GCC-compiled files and files compiled with other compilers, particularly
22819 the Portable C Compiler (pcc).
22821 The precise convention for returning structures in memory depends
22822 on the target configuration macros.
22824 Short structures and unions are those whose size and alignment match
22825 that of some integer type.
22827 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22828 switch is not binary compatible with code compiled with the
22829 @option{-freg-struct-return} switch.
22830 Use it to conform to a non-default application binary interface.
22832 @item -freg-struct-return
22833 @opindex freg-struct-return
22834 Return @code{struct} and @code{union} values in registers when possible.
22835 This is more efficient for small structures than
22836 @option{-fpcc-struct-return}.
22838 If you specify neither @option{-fpcc-struct-return} nor
22839 @option{-freg-struct-return}, GCC defaults to whichever convention is
22840 standard for the target.  If there is no standard convention, GCC
22841 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22842 the principal compiler.  In those cases, we can choose the standard, and
22843 we chose the more efficient register return alternative.
22845 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22846 switch is not binary compatible with code compiled with the
22847 @option{-fpcc-struct-return} switch.
22848 Use it to conform to a non-default application binary interface.
22850 @item -fshort-enums
22851 @opindex fshort-enums
22852 Allocate to an @code{enum} type only as many bytes as it needs for the
22853 declared range of possible values.  Specifically, the @code{enum} type
22854 is equivalent to the smallest integer type that has enough room.
22856 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22857 code that is not binary compatible with code generated without that switch.
22858 Use it to conform to a non-default application binary interface.
22860 @item -fshort-double
22861 @opindex fshort-double
22862 Use the same size for @code{double} as for @code{float}.
22864 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22865 code that is not binary compatible with code generated without that switch.
22866 Use it to conform to a non-default application binary interface.
22868 @item -fshort-wchar
22869 @opindex fshort-wchar
22870 Override the underlying type for @samp{wchar_t} to be @samp{short
22871 unsigned int} instead of the default for the target.  This option is
22872 useful for building programs to run under WINE@.
22874 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22875 code that is not binary compatible with code generated without that switch.
22876 Use it to conform to a non-default application binary interface.
22878 @item -fno-common
22879 @opindex fno-common
22880 In C code, controls the placement of uninitialized global variables.
22881 Unix C compilers have traditionally permitted multiple definitions of
22882 such variables in different compilation units by placing the variables
22883 in a common block.
22884 This is the behavior specified by @option{-fcommon}, and is the default
22885 for GCC on most targets.
22886 On the other hand, this behavior is not required by ISO C, and on some
22887 targets may carry a speed or code size penalty on variable references.
22888 The @option{-fno-common} option specifies that the compiler should place
22889 uninitialized global variables in the data section of the object file,
22890 rather than generating them as common blocks.
22891 This has the effect that if the same variable is declared
22892 (without @code{extern}) in two different compilations,
22893 you get a multiple-definition error when you link them.
22894 In this case, you must compile with @option{-fcommon} instead.
22895 Compiling with @option{-fno-common} is useful on targets for which
22896 it provides better performance, or if you wish to verify that the
22897 program will work on other systems that always treat uninitialized
22898 variable declarations this way.
22900 @item -fno-ident
22901 @opindex fno-ident
22902 Ignore the @samp{#ident} directive.
22904 @item -finhibit-size-directive
22905 @opindex finhibit-size-directive
22906 Don't output a @code{.size} assembler directive, or anything else that
22907 would cause trouble if the function is split in the middle, and the
22908 two halves are placed at locations far apart in memory.  This option is
22909 used when compiling @file{crtstuff.c}; you should not need to use it
22910 for anything else.
22912 @item -fverbose-asm
22913 @opindex fverbose-asm
22914 Put extra commentary information in the generated assembly code to
22915 make it more readable.  This option is generally only of use to those
22916 who actually need to read the generated assembly code (perhaps while
22917 debugging the compiler itself).
22919 @option{-fno-verbose-asm}, the default, causes the
22920 extra information to be omitted and is useful when comparing two assembler
22921 files.
22923 @item -frecord-gcc-switches
22924 @opindex frecord-gcc-switches
22925 This switch causes the command line used to invoke the
22926 compiler to be recorded into the object file that is being created.
22927 This switch is only implemented on some targets and the exact format
22928 of the recording is target and binary file format dependent, but it
22929 usually takes the form of a section containing ASCII text.  This
22930 switch is related to the @option{-fverbose-asm} switch, but that
22931 switch only records information in the assembler output file as
22932 comments, so it never reaches the object file.
22933 See also @option{-grecord-gcc-switches} for another
22934 way of storing compiler options into the object file.
22936 @item -fpic
22937 @opindex fpic
22938 @cindex global offset table
22939 @cindex PIC
22940 Generate position-independent code (PIC) suitable for use in a shared
22941 library, if supported for the target machine.  Such code accesses all
22942 constant addresses through a global offset table (GOT)@.  The dynamic
22943 loader resolves the GOT entries when the program starts (the dynamic
22944 loader is not part of GCC; it is part of the operating system).  If
22945 the GOT size for the linked executable exceeds a machine-specific
22946 maximum size, you get an error message from the linker indicating that
22947 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
22948 instead.  (These maximums are 8k on the SPARC and 32k
22949 on the m68k and RS/6000.  The 386 has no such limit.)
22951 Position-independent code requires special support, and therefore works
22952 only on certain machines.  For the 386, GCC supports PIC for System V
22953 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
22954 position-independent.
22956 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22957 are defined to 1.
22959 @item -fPIC
22960 @opindex fPIC
22961 If supported for the target machine, emit position-independent code,
22962 suitable for dynamic linking and avoiding any limit on the size of the
22963 global offset table.  This option makes a difference on the m68k,
22964 PowerPC and SPARC@.
22966 Position-independent code requires special support, and therefore works
22967 only on certain machines.
22969 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22970 are defined to 2.
22972 @item -fpie
22973 @itemx -fPIE
22974 @opindex fpie
22975 @opindex fPIE
22976 These options are similar to @option{-fpic} and @option{-fPIC}, but
22977 generated position independent code can be only linked into executables.
22978 Usually these options are used when @option{-pie} GCC option is
22979 used during linking.
22981 @option{-fpie} and @option{-fPIE} both define the macros
22982 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
22983 for @option{-fpie} and 2 for @option{-fPIE}.
22985 @item -fno-jump-tables
22986 @opindex fno-jump-tables
22987 Do not use jump tables for switch statements even where it would be
22988 more efficient than other code generation strategies.  This option is
22989 of use in conjunction with @option{-fpic} or @option{-fPIC} for
22990 building code that forms part of a dynamic linker and cannot
22991 reference the address of a jump table.  On some targets, jump tables
22992 do not require a GOT and this option is not needed.
22994 @item -ffixed-@var{reg}
22995 @opindex ffixed
22996 Treat the register named @var{reg} as a fixed register; generated code
22997 should never refer to it (except perhaps as a stack pointer, frame
22998 pointer or in some other fixed role).
23000 @var{reg} must be the name of a register.  The register names accepted
23001 are machine-specific and are defined in the @code{REGISTER_NAMES}
23002 macro in the machine description macro file.
23004 This flag does not have a negative form, because it specifies a
23005 three-way choice.
23007 @item -fcall-used-@var{reg}
23008 @opindex fcall-used
23009 Treat the register named @var{reg} as an allocable register that is
23010 clobbered by function calls.  It may be allocated for temporaries or
23011 variables that do not live across a call.  Functions compiled this way
23012 do not save and restore the register @var{reg}.
23014 It is an error to use this flag with the frame pointer or stack pointer.
23015 Use of this flag for other registers that have fixed pervasive roles in
23016 the machine's execution model produces disastrous results.
23018 This flag does not have a negative form, because it specifies a
23019 three-way choice.
23021 @item -fcall-saved-@var{reg}
23022 @opindex fcall-saved
23023 Treat the register named @var{reg} as an allocable register saved by
23024 functions.  It may be allocated even for temporaries or variables that
23025 live across a call.  Functions compiled this way save and restore
23026 the register @var{reg} if they use it.
23028 It is an error to use this flag with the frame pointer or stack pointer.
23029 Use of this flag for other registers that have fixed pervasive roles in
23030 the machine's execution model produces disastrous results.
23032 A different sort of disaster results from the use of this flag for
23033 a register in which function values may be returned.
23035 This flag does not have a negative form, because it specifies a
23036 three-way choice.
23038 @item -fpack-struct[=@var{n}]
23039 @opindex fpack-struct
23040 Without a value specified, pack all structure members together without
23041 holes.  When a value is specified (which must be a small power of two), pack
23042 structure members according to this value, representing the maximum
23043 alignment (that is, objects with default alignment requirements larger than
23044 this are output potentially unaligned at the next fitting location.
23046 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23047 code that is not binary compatible with code generated without that switch.
23048 Additionally, it makes the code suboptimal.
23049 Use it to conform to a non-default application binary interface.
23051 @item -finstrument-functions
23052 @opindex finstrument-functions
23053 Generate instrumentation calls for entry and exit to functions.  Just
23054 after function entry and just before function exit, the following
23055 profiling functions are called with the address of the current
23056 function and its call site.  (On some platforms,
23057 @code{__builtin_return_address} does not work beyond the current
23058 function, so the call site information may not be available to the
23059 profiling functions otherwise.)
23061 @smallexample
23062 void __cyg_profile_func_enter (void *this_fn,
23063                                void *call_site);
23064 void __cyg_profile_func_exit  (void *this_fn,
23065                                void *call_site);
23066 @end smallexample
23068 The first argument is the address of the start of the current function,
23069 which may be looked up exactly in the symbol table.
23071 This instrumentation is also done for functions expanded inline in other
23072 functions.  The profiling calls indicate where, conceptually, the
23073 inline function is entered and exited.  This means that addressable
23074 versions of such functions must be available.  If all your uses of a
23075 function are expanded inline, this may mean an additional expansion of
23076 code size.  If you use @samp{extern inline} in your C code, an
23077 addressable version of such functions must be provided.  (This is
23078 normally the case anyway, but if you get lucky and the optimizer always
23079 expands the functions inline, you might have gotten away without
23080 providing static copies.)
23082 A function may be given the attribute @code{no_instrument_function}, in
23083 which case this instrumentation is not done.  This can be used, for
23084 example, for the profiling functions listed above, high-priority
23085 interrupt routines, and any functions from which the profiling functions
23086 cannot safely be called (perhaps signal handlers, if the profiling
23087 routines generate output or allocate memory).
23089 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
23090 @opindex finstrument-functions-exclude-file-list
23092 Set the list of functions that are excluded from instrumentation (see
23093 the description of @code{-finstrument-functions}).  If the file that
23094 contains a function definition matches with one of @var{file}, then
23095 that function is not instrumented.  The match is done on substrings:
23096 if the @var{file} parameter is a substring of the file name, it is
23097 considered to be a match.
23099 For example:
23101 @smallexample
23102 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
23103 @end smallexample
23105 @noindent
23106 excludes any inline function defined in files whose pathnames
23107 contain @code{/bits/stl} or @code{include/sys}.
23109 If, for some reason, you want to include letter @code{','} in one of
23110 @var{sym}, write @code{'\,'}. For example,
23111 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
23112 (note the single quote surrounding the option).
23114 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
23115 @opindex finstrument-functions-exclude-function-list
23117 This is similar to @code{-finstrument-functions-exclude-file-list},
23118 but this option sets the list of function names to be excluded from
23119 instrumentation.  The function name to be matched is its user-visible
23120 name, such as @code{vector<int> blah(const vector<int> &)}, not the
23121 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
23122 match is done on substrings: if the @var{sym} parameter is a substring
23123 of the function name, it is considered to be a match.  For C99 and C++
23124 extended identifiers, the function name must be given in UTF-8, not
23125 using universal character names.
23127 @item -fstack-check
23128 @opindex fstack-check
23129 Generate code to verify that you do not go beyond the boundary of the
23130 stack.  You should specify this flag if you are running in an
23131 environment with multiple threads, but you only rarely need to specify it in
23132 a single-threaded environment since stack overflow is automatically
23133 detected on nearly all systems if there is only one stack.
23135 Note that this switch does not actually cause checking to be done; the
23136 operating system or the language runtime must do that.  The switch causes
23137 generation of code to ensure that they see the stack being extended.
23139 You can additionally specify a string parameter: @code{no} means no
23140 checking, @code{generic} means force the use of old-style checking,
23141 @code{specific} means use the best checking method and is equivalent
23142 to bare @option{-fstack-check}.
23144 Old-style checking is a generic mechanism that requires no specific
23145 target support in the compiler but comes with the following drawbacks:
23147 @enumerate
23148 @item
23149 Modified allocation strategy for large objects: they are always
23150 allocated dynamically if their size exceeds a fixed threshold.
23152 @item
23153 Fixed limit on the size of the static frame of functions: when it is
23154 topped by a particular function, stack checking is not reliable and
23155 a warning is issued by the compiler.
23157 @item
23158 Inefficiency: because of both the modified allocation strategy and the
23159 generic implementation, code performance is hampered.
23160 @end enumerate
23162 Note that old-style stack checking is also the fallback method for
23163 @code{specific} if no target support has been added in the compiler.
23165 @item -fstack-limit-register=@var{reg}
23166 @itemx -fstack-limit-symbol=@var{sym}
23167 @itemx -fno-stack-limit
23168 @opindex fstack-limit-register
23169 @opindex fstack-limit-symbol
23170 @opindex fno-stack-limit
23171 Generate code to ensure that the stack does not grow beyond a certain value,
23172 either the value of a register or the address of a symbol.  If a larger
23173 stack is required, a signal is raised at run time.  For most targets,
23174 the signal is raised before the stack overruns the boundary, so
23175 it is possible to catch the signal without taking special precautions.
23177 For instance, if the stack starts at absolute address @samp{0x80000000}
23178 and grows downwards, you can use the flags
23179 @option{-fstack-limit-symbol=__stack_limit} and
23180 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
23181 of 128KB@.  Note that this may only work with the GNU linker.
23183 @item -fsplit-stack
23184 @opindex fsplit-stack
23185 Generate code to automatically split the stack before it overflows.
23186 The resulting program has a discontiguous stack which can only
23187 overflow if the program is unable to allocate any more memory.  This
23188 is most useful when running threaded programs, as it is no longer
23189 necessary to calculate a good stack size to use for each thread.  This
23190 is currently only implemented for the i386 and x86_64 back ends running
23191 GNU/Linux.
23193 When code compiled with @option{-fsplit-stack} calls code compiled
23194 without @option{-fsplit-stack}, there may not be much stack space
23195 available for the latter code to run.  If compiling all code,
23196 including library code, with @option{-fsplit-stack} is not an option,
23197 then the linker can fix up these calls so that the code compiled
23198 without @option{-fsplit-stack} always has a large stack.  Support for
23199 this is implemented in the gold linker in GNU binutils release 2.21
23200 and later.
23202 @item -fleading-underscore
23203 @opindex fleading-underscore
23204 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
23205 change the way C symbols are represented in the object file.  One use
23206 is to help link with legacy assembly code.
23208 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
23209 generate code that is not binary compatible with code generated without that
23210 switch.  Use it to conform to a non-default application binary interface.
23211 Not all targets provide complete support for this switch.
23213 @item -ftls-model=@var{model}
23214 @opindex ftls-model
23215 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
23216 The @var{model} argument should be one of @code{global-dynamic},
23217 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
23218 Note that the choice is subject to optimization: the compiler may use
23219 a more efficient model for symbols not visible outside of the translation
23220 unit, or if @option{-fpic} is not given on the command line.
23222 The default without @option{-fpic} is @code{initial-exec}; with
23223 @option{-fpic} the default is @code{global-dynamic}.
23225 @item -fvisibility=@var{default|internal|hidden|protected}
23226 @opindex fvisibility
23227 Set the default ELF image symbol visibility to the specified option---all
23228 symbols are marked with this unless overridden within the code.
23229 Using this feature can very substantially improve linking and
23230 load times of shared object libraries, produce more optimized
23231 code, provide near-perfect API export and prevent symbol clashes.
23232 It is @strong{strongly} recommended that you use this in any shared objects
23233 you distribute.
23235 Despite the nomenclature, @code{default} always means public; i.e.,
23236 available to be linked against from outside the shared object.
23237 @code{protected} and @code{internal} are pretty useless in real-world
23238 usage so the only other commonly used option is @code{hidden}.
23239 The default if @option{-fvisibility} isn't specified is
23240 @code{default}, i.e., make every
23241 symbol public---this causes the same behavior as previous versions of
23242 GCC@.
23244 A good explanation of the benefits offered by ensuring ELF
23245 symbols have the correct visibility is given by ``How To Write
23246 Shared Libraries'' by Ulrich Drepper (which can be found at
23247 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
23248 solution made possible by this option to marking things hidden when
23249 the default is public is to make the default hidden and mark things
23250 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
23251 and @code{__attribute__ ((visibility("default")))} instead of
23252 @code{__declspec(dllexport)} you get almost identical semantics with
23253 identical syntax.  This is a great boon to those working with
23254 cross-platform projects.
23256 For those adding visibility support to existing code, you may find
23257 @samp{#pragma GCC visibility} of use.  This works by you enclosing
23258 the declarations you wish to set visibility for with (for example)
23259 @samp{#pragma GCC visibility push(hidden)} and
23260 @samp{#pragma GCC visibility pop}.
23261 Bear in mind that symbol visibility should be viewed @strong{as
23262 part of the API interface contract} and thus all new code should
23263 always specify visibility when it is not the default; i.e., declarations
23264 only for use within the local DSO should @strong{always} be marked explicitly
23265 as hidden as so to avoid PLT indirection overheads---making this
23266 abundantly clear also aids readability and self-documentation of the code.
23267 Note that due to ISO C++ specification requirements, @code{operator new} and
23268 @code{operator delete} must always be of default visibility.
23270 Be aware that headers from outside your project, in particular system
23271 headers and headers from any other library you use, may not be
23272 expecting to be compiled with visibility other than the default.  You
23273 may need to explicitly say @samp{#pragma GCC visibility push(default)}
23274 before including any such headers.
23276 @samp{extern} declarations are not affected by @option{-fvisibility}, so
23277 a lot of code can be recompiled with @option{-fvisibility=hidden} with
23278 no modifications.  However, this means that calls to @code{extern}
23279 functions with no explicit visibility use the PLT, so it is more
23280 effective to use @code{__attribute ((visibility))} and/or
23281 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
23282 declarations should be treated as hidden.
23284 Note that @option{-fvisibility} does affect C++ vague linkage
23285 entities. This means that, for instance, an exception class that is
23286 be thrown between DSOs must be explicitly marked with default
23287 visibility so that the @samp{type_info} nodes are unified between
23288 the DSOs.
23290 An overview of these techniques, their benefits and how to use them
23291 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
23293 @item -fstrict-volatile-bitfields
23294 @opindex fstrict-volatile-bitfields
23295 This option should be used if accesses to volatile bit-fields (or other
23296 structure fields, although the compiler usually honors those types
23297 anyway) should use a single access of the width of the
23298 field's type, aligned to a natural alignment if possible.  For
23299 example, targets with memory-mapped peripheral registers might require
23300 all such accesses to be 16 bits wide; with this flag you can
23301 declare all peripheral bit-fields as @code{unsigned short} (assuming short
23302 is 16 bits on these targets) to force GCC to use 16-bit accesses
23303 instead of, perhaps, a more efficient 32-bit access.
23305 If this option is disabled, the compiler uses the most efficient
23306 instruction.  In the previous example, that might be a 32-bit load
23307 instruction, even though that accesses bytes that do not contain
23308 any portion of the bit-field, or memory-mapped registers unrelated to
23309 the one being updated.
23311 In some cases, such as when the @code{packed} attribute is applied to a 
23312 structure field, it may not be possible to access the field with a single
23313 read or write that is correctly aligned for the target machine.  In this
23314 case GCC falls back to generating multiple accesses rather than code that 
23315 will fault or truncate the result at run time.
23317 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
23318 not allowed to touch non bit-field members.  It is therefore recommended
23319 to define all bits of the field's type as bit-field members.
23321 The default value of this option is determined by the application binary
23322 interface for the target processor.
23324 @item -fsync-libcalls
23325 @opindex fsync-libcalls
23326 This option controls whether any out-of-line instance of the @code{__sync}
23327 family of functions may be used to implement the C++11 @code{__atomic}
23328 family of functions.
23330 The default value of this option is enabled, thus the only useful form
23331 of the option is @option{-fno-sync-libcalls}.  This option is used in
23332 the implementation of the @file{libatomic} runtime library.
23334 @end table
23336 @c man end
23338 @node Environment Variables
23339 @section Environment Variables Affecting GCC
23340 @cindex environment variables
23342 @c man begin ENVIRONMENT
23343 This section describes several environment variables that affect how GCC
23344 operates.  Some of them work by specifying directories or prefixes to use
23345 when searching for various kinds of files.  Some are used to specify other
23346 aspects of the compilation environment.
23348 Note that you can also specify places to search using options such as
23349 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
23350 take precedence over places specified using environment variables, which
23351 in turn take precedence over those specified by the configuration of GCC@.
23352 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
23353 GNU Compiler Collection (GCC) Internals}.
23355 @table @env
23356 @item LANG
23357 @itemx LC_CTYPE
23358 @c @itemx LC_COLLATE
23359 @itemx LC_MESSAGES
23360 @c @itemx LC_MONETARY
23361 @c @itemx LC_NUMERIC
23362 @c @itemx LC_TIME
23363 @itemx LC_ALL
23364 @findex LANG
23365 @findex LC_CTYPE
23366 @c @findex LC_COLLATE
23367 @findex LC_MESSAGES
23368 @c @findex LC_MONETARY
23369 @c @findex LC_NUMERIC
23370 @c @findex LC_TIME
23371 @findex LC_ALL
23372 @cindex locale
23373 These environment variables control the way that GCC uses
23374 localization information which allows GCC to work with different
23375 national conventions.  GCC inspects the locale categories
23376 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
23377 so.  These locale categories can be set to any value supported by your
23378 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
23379 Kingdom encoded in UTF-8.
23381 The @env{LC_CTYPE} environment variable specifies character
23382 classification.  GCC uses it to determine the character boundaries in
23383 a string; this is needed for some multibyte encodings that contain quote
23384 and escape characters that are otherwise interpreted as a string
23385 end or escape.
23387 The @env{LC_MESSAGES} environment variable specifies the language to
23388 use in diagnostic messages.
23390 If the @env{LC_ALL} environment variable is set, it overrides the value
23391 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
23392 and @env{LC_MESSAGES} default to the value of the @env{LANG}
23393 environment variable.  If none of these variables are set, GCC
23394 defaults to traditional C English behavior.
23396 @item TMPDIR
23397 @findex TMPDIR
23398 If @env{TMPDIR} is set, it specifies the directory to use for temporary
23399 files.  GCC uses temporary files to hold the output of one stage of
23400 compilation which is to be used as input to the next stage: for example,
23401 the output of the preprocessor, which is the input to the compiler
23402 proper.
23404 @item GCC_COMPARE_DEBUG
23405 @findex GCC_COMPARE_DEBUG
23406 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
23407 @option{-fcompare-debug} to the compiler driver.  See the documentation
23408 of this option for more details.
23410 @item GCC_EXEC_PREFIX
23411 @findex GCC_EXEC_PREFIX
23412 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
23413 names of the subprograms executed by the compiler.  No slash is added
23414 when this prefix is combined with the name of a subprogram, but you can
23415 specify a prefix that ends with a slash if you wish.
23417 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
23418 an appropriate prefix to use based on the pathname it is invoked with.
23420 If GCC cannot find the subprogram using the specified prefix, it
23421 tries looking in the usual places for the subprogram.
23423 The default value of @env{GCC_EXEC_PREFIX} is
23424 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
23425 the installed compiler. In many cases @var{prefix} is the value
23426 of @code{prefix} when you ran the @file{configure} script.
23428 Other prefixes specified with @option{-B} take precedence over this prefix.
23430 This prefix is also used for finding files such as @file{crt0.o} that are
23431 used for linking.
23433 In addition, the prefix is used in an unusual way in finding the
23434 directories to search for header files.  For each of the standard
23435 directories whose name normally begins with @samp{/usr/local/lib/gcc}
23436 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
23437 replacing that beginning with the specified prefix to produce an
23438 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
23439 @file{foo/bar} just before it searches the standard directory 
23440 @file{/usr/local/lib/bar}.
23441 If a standard directory begins with the configured
23442 @var{prefix} then the value of @var{prefix} is replaced by
23443 @env{GCC_EXEC_PREFIX} when looking for header files.
23445 @item COMPILER_PATH
23446 @findex COMPILER_PATH
23447 The value of @env{COMPILER_PATH} is a colon-separated list of
23448 directories, much like @env{PATH}.  GCC tries the directories thus
23449 specified when searching for subprograms, if it can't find the
23450 subprograms using @env{GCC_EXEC_PREFIX}.
23452 @item LIBRARY_PATH
23453 @findex LIBRARY_PATH
23454 The value of @env{LIBRARY_PATH} is a colon-separated list of
23455 directories, much like @env{PATH}.  When configured as a native compiler,
23456 GCC tries the directories thus specified when searching for special
23457 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
23458 using GCC also uses these directories when searching for ordinary
23459 libraries for the @option{-l} option (but directories specified with
23460 @option{-L} come first).
23462 @item LANG
23463 @findex LANG
23464 @cindex locale definition
23465 This variable is used to pass locale information to the compiler.  One way in
23466 which this information is used is to determine the character set to be used
23467 when character literals, string literals and comments are parsed in C and C++.
23468 When the compiler is configured to allow multibyte characters,
23469 the following values for @env{LANG} are recognized:
23471 @table @samp
23472 @item C-JIS
23473 Recognize JIS characters.
23474 @item C-SJIS
23475 Recognize SJIS characters.
23476 @item C-EUCJP
23477 Recognize EUCJP characters.
23478 @end table
23480 If @env{LANG} is not defined, or if it has some other value, then the
23481 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
23482 recognize and translate multibyte characters.
23483 @end table
23485 @noindent
23486 Some additional environment variables affect the behavior of the
23487 preprocessor.
23489 @include cppenv.texi
23491 @c man end
23493 @node Precompiled Headers
23494 @section Using Precompiled Headers
23495 @cindex precompiled headers
23496 @cindex speed of compilation
23498 Often large projects have many header files that are included in every
23499 source file.  The time the compiler takes to process these header files
23500 over and over again can account for nearly all of the time required to
23501 build the project.  To make builds faster, GCC allows you to
23502 @dfn{precompile} a header file.
23504 To create a precompiled header file, simply compile it as you would any
23505 other file, if necessary using the @option{-x} option to make the driver
23506 treat it as a C or C++ header file.  You may want to use a
23507 tool like @command{make} to keep the precompiled header up-to-date when
23508 the headers it contains change.
23510 A precompiled header file is searched for when @code{#include} is
23511 seen in the compilation.  As it searches for the included file
23512 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
23513 compiler looks for a precompiled header in each directory just before it
23514 looks for the include file in that directory.  The name searched for is
23515 the name specified in the @code{#include} with @samp{.gch} appended.  If
23516 the precompiled header file can't be used, it is ignored.
23518 For instance, if you have @code{#include "all.h"}, and you have
23519 @file{all.h.gch} in the same directory as @file{all.h}, then the
23520 precompiled header file is used if possible, and the original
23521 header is used otherwise.
23523 Alternatively, you might decide to put the precompiled header file in a
23524 directory and use @option{-I} to ensure that directory is searched
23525 before (or instead of) the directory containing the original header.
23526 Then, if you want to check that the precompiled header file is always
23527 used, you can put a file of the same name as the original header in this
23528 directory containing an @code{#error} command.
23530 This also works with @option{-include}.  So yet another way to use
23531 precompiled headers, good for projects not designed with precompiled
23532 header files in mind, is to simply take most of the header files used by
23533 a project, include them from another header file, precompile that header
23534 file, and @option{-include} the precompiled header.  If the header files
23535 have guards against multiple inclusion, they are skipped because
23536 they've already been included (in the precompiled header).
23538 If you need to precompile the same header file for different
23539 languages, targets, or compiler options, you can instead make a
23540 @emph{directory} named like @file{all.h.gch}, and put each precompiled
23541 header in the directory, perhaps using @option{-o}.  It doesn't matter
23542 what you call the files in the directory; every precompiled header in
23543 the directory is considered.  The first precompiled header
23544 encountered in the directory that is valid for this compilation is
23545 used; they're searched in no particular order.
23547 There are many other possibilities, limited only by your imagination,
23548 good sense, and the constraints of your build system.
23550 A precompiled header file can be used only when these conditions apply:
23552 @itemize
23553 @item
23554 Only one precompiled header can be used in a particular compilation.
23556 @item
23557 A precompiled header can't be used once the first C token is seen.  You
23558 can have preprocessor directives before a precompiled header; you cannot
23559 include a precompiled header from inside another header.
23561 @item
23562 The precompiled header file must be produced for the same language as
23563 the current compilation.  You can't use a C precompiled header for a C++
23564 compilation.
23566 @item
23567 The precompiled header file must have been produced by the same compiler
23568 binary as the current compilation is using.
23570 @item
23571 Any macros defined before the precompiled header is included must
23572 either be defined in the same way as when the precompiled header was
23573 generated, or must not affect the precompiled header, which usually
23574 means that they don't appear in the precompiled header at all.
23576 The @option{-D} option is one way to define a macro before a
23577 precompiled header is included; using a @code{#define} can also do it.
23578 There are also some options that define macros implicitly, like
23579 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23580 defined this way.
23582 @item If debugging information is output when using the precompiled
23583 header, using @option{-g} or similar, the same kind of debugging information
23584 must have been output when building the precompiled header.  However,
23585 a precompiled header built using @option{-g} can be used in a compilation
23586 when no debugging information is being output.
23588 @item The same @option{-m} options must generally be used when building
23589 and using the precompiled header.  @xref{Submodel Options},
23590 for any cases where this rule is relaxed.
23592 @item Each of the following options must be the same when building and using
23593 the precompiled header:
23595 @gccoptlist{-fexceptions}
23597 @item
23598 Some other command-line options starting with @option{-f},
23599 @option{-p}, or @option{-O} must be defined in the same way as when
23600 the precompiled header was generated.  At present, it's not clear
23601 which options are safe to change and which are not; the safest choice
23602 is to use exactly the same options when generating and using the
23603 precompiled header.  The following are known to be safe:
23605 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23606 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23607 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23608 -pedantic-errors}
23610 @end itemize
23612 For all of these except the last, the compiler automatically
23613 ignores the precompiled header if the conditions aren't met.  If you
23614 find an option combination that doesn't work and doesn't cause the
23615 precompiled header to be ignored, please consider filing a bug report,
23616 see @ref{Bugs}.
23618 If you do use differing options when generating and using the
23619 precompiled header, the actual behavior is a mixture of the
23620 behavior for the options.  For instance, if you use @option{-g} to
23621 generate the precompiled header but not when using it, you may or may
23622 not get debugging information for routines in the precompiled header.