]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/doc/invoke.texi
re PR target/24837 (move dynamic linker names out of LINK_SPEC and into new DYNAMIC_L...
[thirdparty/gcc.git] / gcc / doc / invoke.texi
CommitLineData
d0a5eb32 1@c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
79cf5994 2@c 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
74291a4b
MM
3@c This is part of the GCC manual.
4@c For copying conditions, see the file gcc.texi.
5
9d86bffc 6@ignore
9d530538
MM
7@c man begin INCLUDE
8@include gcc-vers.texi
9@c man end
10
9d86bffc 11@c man begin COPYRIGHT
2b6dd222
JM
12Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
131999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
9d86bffc 14
77bd67cb 15Permission is granted to copy, distribute and/or modify this document
b3a8389d 16under the terms of the GNU Free Documentation License, Version 1.2 or
77bd67cb
JM
17any later version published by the Free Software Foundation; with the
18Invariant Sections being ``GNU General Public License'' and ``Funding
19Free Software'', the Front-Cover texts being (a) (see below), and with
20the Back-Cover Texts being (b) (see below). A copy of the license is
21included in the gfdl(7) man page.
9d86bffc 22
77bd67cb 23(a) The FSF's Front-Cover Text is:
9d86bffc 24
77bd67cb
JM
25 A GNU Manual
26
27(b) The FSF's Back-Cover Text is:
28
29 You have freedom to copy and modify this GNU Manual, like GNU
30 software. Copies published by the Free Software Foundation raise
31 funds for GNU development.
9d86bffc
JM
32@c man end
33@c Set file name and title for the man page.
34@setfilename gcc
35@settitle GNU project C and C++ compiler
36@c man begin SYNOPSIS
630d3d5a
JM
37gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
9d530538 43 [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
9d86bffc
JM
44
45Only the most useful options are listed here; see below for the
46remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
47@c man end
48@c man begin SEEALSO
77bd67cb 49gpl(7), gfdl(7), fsf-funding(7),
b4117c30
ZW
50cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51and the Info entries for @file{gcc}, @file{cpp}, @file{as},
9d86bffc
JM
52@file{ld}, @file{binutils} and @file{gdb}.
53@c man end
2642624b
JM
54@c man begin BUGS
55For instructions on reporting bugs, see
ee86feaf 56@w{@uref{http://gcc.gnu.org/bugs.html}}.
2642624b
JM
57@c man end
58@c man begin AUTHOR
24dbb440
GP
59See the Info entry for @command{gcc}, or
60@w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61for contributors to GCC@.
2642624b 62@c man end
9d86bffc
JM
63@end ignore
64
74291a4b 65@node Invoking GCC
0c2d1a2a
JB
66@chapter GCC Command Options
67@cindex GCC command options
74291a4b 68@cindex command options
0c2d1a2a 69@cindex options, GCC command
74291a4b 70
9d86bffc 71@c man begin DESCRIPTION
0c2d1a2a 72When you invoke GCC, it normally does preprocessing, compilation,
74291a4b 73assembly and linking. The ``overall options'' allow you to stop this
630d3d5a 74process at an intermediate stage. For example, the @option{-c} option
74291a4b
MM
75says not to run the linker. Then the output consists of object files
76output by the assembler.
77
78Other options are passed on to one stage of processing. Some options
79control the preprocessor and others the compiler itself. Yet other
80options control the assembler and linker; most of these are not
81documented here, since you rarely need to use any of them.
82
83@cindex C compilation options
0c2d1a2a 84Most of the command line options that you can use with GCC are useful
74291a4b
MM
85for C programs; when an option is only useful with another language
86(usually C++), the explanation says so explicitly. If the description
87for a particular option does not mention a source language, you can use
88that option with all supported languages.
89
90@cindex C++ compilation options
91@xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92options for compiling C++ programs.
93
94@cindex grouping options
95@cindex options, grouping
bedc7537 96The @command{gcc} program accepts options and file names as operands. Many
b192711e 97options have multi-letter names; therefore multiple single-letter options
630d3d5a 98may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
74291a4b
MM
99-r}}.
100
101@cindex order of options
102@cindex options, order
103You can mix options and other arguments. For the most part, the order
104you use doesn't matter. Order does matter when you use several options
630d3d5a 105of the same kind; for example, if you specify @option{-L} more than once,
74291a4b
MM
106the directories are searched in the order specified.
107
108Many options have long names starting with @samp{-f} or with
1d8eeb63 109@samp{-W}---for example,
630d3d5a 110@option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
74291a4b 111these have both positive and negative forms; the negative form of
630d3d5a 112@option{-ffoo} would be @option{-fno-foo}. This manual documents
74291a4b
MM
113only one of these two forms, whichever one is not the default.
114
9d86bffc
JM
115@c man end
116
cd3bb277
JM
117@xref{Option Index}, for an index to GCC's options.
118
74291a4b
MM
119@menu
120* Option Summary:: Brief list of all options, without explanations.
121* Overall Options:: Controlling the kind of output:
122 an executable, object files, assembler files,
123 or preprocessed source.
124* Invoking G++:: Compiling C++ programs.
125* C Dialect Options:: Controlling the variant of C language compiled.
126* C++ Dialect Options:: Variations on C++.
46e34f96
ZL
127* Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128 and Objective-C++.
764dbbf2 129* Language Independent Options:: Controlling how diagnostics should be
02f52e19 130 formatted.
74291a4b
MM
131* Warning Options:: How picky should the compiler be?
132* Debugging Options:: Symbol tables, measurements, and debugging dumps.
133* Optimize Options:: How much optimization?
134* Preprocessor Options:: Controlling header files and macro definitions.
135 Also, getting dependency information for Make.
136* Assembler Options:: Passing options to the assembler.
137* Link Options:: Specifying libraries and so on.
138* Directory Options:: Where to find header files and libraries.
139 Where to find the compiler executable files.
a743d340 140* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 141* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
142* Submodel Options:: Specifying minor hardware or convention variations,
143 such as 68010 vs 68020.
144* Code Gen Options:: Specifying conventions for function calls, data layout
145 and register usage.
0c2d1a2a 146* Environment Variables:: Env vars that affect GCC.
17211ab5 147* Precompiled Headers:: Compiling a header once, and using it many times.
74291a4b
MM
148* Running Protoize:: Automatically adding or removing function prototypes.
149@end menu
150
4bc1997b
JM
151@c man begin OPTIONS
152
74291a4b
MM
153@node Option Summary
154@section Option Summary
155
156Here is a summary of all the options, grouped by type. Explanations are
157in the following sections.
158
159@table @emph
160@item Overall Options
161@xref{Overall Options,,Options Controlling the Kind of Output}.
0855eab7 162@gccoptlist{-c -S -E -o @var{file} -combine -pipe -pass-exit-codes @gol
9d530538 163-x @var{language} -v -### --help --target-help --version @@@var{file}}
74291a4b
MM
164
165@item C Language Options
166@xref{C Dialect Options,,Options Controlling C Dialect}.
9a94f7f3
JM
167@gccoptlist{-ansi -std=@var{standard} -aux-info @var{filename} @gol
168-fno-asm -fno-builtin -fno-builtin-@var{function} @gol
750491fc 169-fhosted -ffreestanding -fms-extensions @gol
8a035a6b 170-trigraphs -no-integrated-cpp -traditional -traditional-cpp @gol
4bc1997b
JM
171-fallow-single-precision -fcond-mismatch @gol
172-fsigned-bitfields -fsigned-char @gol
3521b33c 173-funsigned-bitfields -funsigned-char}
74291a4b
MM
174
175@item C++ Language Options
176@xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
9a94f7f3 177@gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
cfb10bd3 178-fconserve-space -ffriend-injection @gol
aa0cc562 179-fno-elide-constructors @gol
7813d14c 180-fno-enforce-eh-specs @gol
1dbb6023 181-ffor-scope -fno-for-scope -fno-gnu-keywords @gol
90ecce3e 182-fno-implicit-templates @gol
4bc1997b
JM
183-fno-implicit-inline-templates @gol
184-fno-implement-inlines -fms-extensions @gol
aa0cc562 185-fno-nonansi-builtins -fno-operator-names @gol
4bc1997b 186-fno-optional-diags -fpermissive @gol
aa0cc562 187-frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
40aac948 188-fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
d7afec4b
ND
189-fno-default-inline -fvisibility-inlines-hidden @gol
190-Wabi -Wctor-dtor-privacy @gol
4bc1997b 191-Wnon-virtual-dtor -Wreorder @gol
b2f97e4a 192-Weffc++ -Wno-deprecated -Wstrict-null-sentinel @gol
4bc1997b
JM
193-Wno-non-template-friend -Wold-style-cast @gol
194-Woverloaded-virtual -Wno-pmf-conversions @gol
4e2db7a8 195-Wsign-promo}
74291a4b 196
46e34f96
ZL
197@item Objective-C and Objective-C++ Language Options
198@xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
199Objective-C and Objective-C++ Dialects}.
264fa2db
ZL
200@gccoptlist{
201-fconstant-string-class=@var{class-name} @gol
202-fgnu-runtime -fnext-runtime @gol
203-fno-nil-receivers @gol
6e955430
ZL
204-fobjc-call-cxx-cdtors @gol
205-fobjc-direct-dispatch @gol
264fa2db 206-fobjc-exceptions @gol
6e955430 207-fobjc-gc @gol
264fa2db
ZL
208-freplace-objc-classes @gol
209-fzero-link @gol
210-gen-decls @gol
6e955430
ZL
211-Wassign-intercept @gol
212-Wno-protocol -Wselector @gol
213-Wstrict-selector-match @gol
214-Wundeclared-selector}
60de6385 215
764dbbf2
GDR
216@item Language Independent Options
217@xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
9a94f7f3 218@gccoptlist{-fmessage-length=@var{n} @gol
ccf08a6e
DD
219-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
220-fdiagnostics-show-options
764dbbf2 221
74291a4b
MM
222@item Warning Options
223@xref{Warning Options,,Options to Request or Suppress Warnings}.
9a94f7f3 224@gccoptlist{-fsyntax-only -pedantic -pedantic-errors @gol
690a704a 225-w -Wextra -Wall -Waggregate-return -Walways-true -Wno-attributes @gol
b7e20b53 226-Wc++-compat -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
e23bd218 227-Wconversion -Wno-deprecated-declarations @gol
90689ae1 228-Wdisabled-optimization -Wno-div-by-zero -Wno-endif-labels @gol
79cf5994 229-Werror -Werror-* -Werror-implicit-function-declaration @gol
c65a01af 230-Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
fb0317c6 231-Wno-format-extra-args -Wformat-nonliteral @gol
c76f4e8e 232-Wformat-security -Wformat-y2k @gol
fb0317c6
VR
233-Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
234-Wimport -Wno-import -Winit-self -Winline @gol
53a2494e 235-Wno-int-to-pointer-cast @gol
fb0317c6 236-Wno-invalid-offsetof -Winvalid-pch @gol
f9cc1a70 237-Wlarger-than-@var{len} -Wunsafe-loop-optimizations -Wlong-long @gol
eaac4679 238-Wmain -Wmissing-braces -Wmissing-field-initializers @gol
b02398bd
BE
239-Wmissing-format-attribute -Wmissing-include-dirs @gol
240-Wmissing-noreturn @gol
89a42ac8 241-Wno-multichar -Wnonnull -Woverlength-strings -Wpacked -Wpadded @gol
53a2494e
JM
242-Wparentheses -Wpointer-arith -Wno-pointer-to-int-cast @gol
243-Wredundant-decls @gol
4bc1997b 244-Wreturn-type -Wsequence-point -Wshadow @gol
0aca9021
JW
245-Wsign-compare -Wstack-protector @gol
246-Wstrict-aliasing -Wstrict-aliasing=2 @gol
d77314ec 247-Wstring-literal-comparison @gol
9a94f7f3
JM
248-Wswitch -Wswitch-default -Wswitch-enum @gol
249-Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
b9b8dde3 250-Wunknown-pragmas -Wno-pragmas -Wunreachable-code @gol
4bc1997b 251-Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
0aca9021 252-Wunused-value -Wunused-variable -Wvariadic-macros @gol
d35a40fc 253-Wvolatile-register-var -Wwrite-strings}
74291a4b 254
fe50c0eb 255@item C-only Warning Options
9a94f7f3 256@gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
fb0317c6 257-Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
85617eba 258-Wstrict-prototypes -Wtraditional @gol
f4e9414e 259-Wdeclaration-after-statement -Wpointer-sign}
fe50c0eb 260
74291a4b
MM
261@item Debugging Options
262@xref{Debugging Options,,Options for Debugging Your Program or GCC}.
9a94f7f3
JM
263@gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
264-fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
aee96fe9 265-fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
9b3e897d 266-fdump-ipa-all -fdump-ipa-cgraph @gol
6de9cd9a 267-fdump-tree-all @gol
9a94f7f3
JM
268-fdump-tree-original@r{[}-@var{n}@r{]} @gol
269-fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
22367161 270-fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
6de9cd9a
DN
271-fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
272-fdump-tree-ch @gol
273-fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
274-fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
275-fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
276-fdump-tree-dom@r{[}-@var{n}@r{]} @gol
277-fdump-tree-dse@r{[}-@var{n}@r{]} @gol
278-fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
279-fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
280-fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
79fe1b3b 281-fdump-tree-nrv -fdump-tree-vect @gol
fa555252 282-fdump-tree-sink @gol
6de9cd9a 283-fdump-tree-sra@r{[}-@var{n}@r{]} @gol
c75ab022 284-fdump-tree-salias @gol
ff2ad0f7 285-fdump-tree-fre@r{[}-@var{n}@r{]} @gol
08873e96 286-fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
c866976a 287-ftree-vectorizer-verbose=@var{n} @gol
0bca51f0 288-fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
a37db56b 289-feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
8a76829c 290-feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
a37db56b 291-frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
014a1138 292-ftest-coverage -ftime-report -fvar-tracking @gol
def66b10 293-g -g@var{level} -gcoff -gdwarf-2 @gol
5f98259a 294-ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
4bc1997b 295-p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
b1018de6 296-print-multi-directory -print-multi-lib @gol
4bc1997b
JM
297-print-prog-name=@var{program} -print-search-dirs -Q @gol
298-save-temps -time}
74291a4b
MM
299
300@item Optimization Options
301@xref{Optimize Options,,Options that Control Optimization}.
9a94f7f3 302@gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
4bc1997b 303-falign-labels=@var{n} -falign-loops=@var{n} @gol
6de9cd9a 304-fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
fca9dc00 305-fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
1194fc79 306-fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
c7463669 307-fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
3450cbc4 308-fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
d63db217 309-fdelayed-branch -fdelete-null-pointer-checks -fearly-inlining @gol
4bc1997b 310-fexpensive-optimizations -ffast-math -ffloat-store @gol
1d8eeb63 311-fforce-addr -ffunction-sections @gol
db643b91
SH
312-fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
313-floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 @gol
355866de
RG
314-finline-functions -finline-functions-called-once @gol
315-finline-limit=@var{n} -fkeep-inline-functions @gol
201556f0 316-fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
cd280abb 317-fmodulo-sched -fno-branch-count-reg @gol
1f922264 318-fno-default-inline -fno-defer-pop -fmove-loop-invariants @gol
feb48bde 319-fno-function-cse -fno-guess-branch-probability @gol
6cfc0341 320-fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
f9cc1a70 321-funsafe-math-optimizations -funsafe-loop-optimizations -ffinite-math-only @gol
474eccc6 322-fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
4bc1997b 323-fomit-frame-pointer -foptimize-register-move @gol
17684618 324-foptimize-sibling-calls -fprefetch-loop-arrays -fprefetch-loop-arrays-rtl @gol
a8a5f53a 325-fprofile-generate -fprofile-use @gol
a924fe34 326-fregmove -frename-registers @gol
750054a2 327-freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
4bc1997b 328-frerun-cse-after-loop -frerun-loop-opt @gol
38109dab
GL
329-frounding-math -frtl-abstract-sequences @gol
330-fschedule-insns -fschedule-insns2 @gol
e03b7153 331-fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
569fa502 332-fsched-spec-load-dangerous @gol
0aca9021 333-fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
569fa502 334-fsched2-use-superblocks @gol
d72372e4 335-fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
8a76829c 336-fsignaling-nans -fsingle-precision-constant @gol
0aca9021 337-fstack-protector -fstack-protector-all @gol
9a94f7f3
JM
338-fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
339-funroll-all-loops -funroll-loops -fpeel-loops @gol
113d659a 340-fsplit-ivs-in-unroller -funswitch-loops @gol
f37a4f14 341-fvariable-expansion-in-unroller @gol
c66b6c66 342-ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
599eabdb 343-ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
fa555252 344-ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
79fe1b3b 345-ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
c12cc930 346-ftree-vect-loop-version -ftree-salias -fweb @gol
ce91e74c 347-ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
3af64fd6 348--param @var{name}=@var{value}
4bc1997b 349-O -O0 -O1 -O2 -O3 -Os}
74291a4b
MM
350
351@item Preprocessor Options
352@xref{Preprocessor Options,,Options Controlling the Preprocessor}.
c2d635bc 353@gccoptlist{-A@var{question}=@var{answer} @gol
9a94f7f3 354-A-@var{question}@r{[}=@var{answer}@r{]} @gol
4bc1997b
JM
355-C -dD -dI -dM -dN @gol
356-D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
357-idirafter @var{dir} @gol
358-include @var{file} -imacros @var{file} @gol
359-iprefix @var{file} -iwithprefix @var{dir} @gol
bdd42dd9 360-iwithprefixbefore @var{dir} -isystem @var{dir} @gol
2b6dd222 361-imultilib @var{dir} -isysroot @var{dir} @gol
b20d9f0c
AO
362-M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
363-P -fworking-directory -remap @gol
9a94f7f3
JM
364-trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
365-Xpreprocessor @var{option}}
74291a4b
MM
366
367@item Assembler Option
368@xref{Assembler Options,,Passing Options to the Assembler}.
9a94f7f3 369@gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
74291a4b
MM
370
371@item Linker Options
372@xref{Link Options,,Options for Linking}.
9a94f7f3 373@gccoptlist{@var{object-file-name} -l@var{library} @gol
0cbc4d77 374-nostartfiles -nodefaultlibs -nostdlib -pie -rdynamic @gol
4bc1997b 375-s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
aee96fe9 376-Wl,@var{option} -Xlinker @var{option} @gol
4bc1997b 377-u @var{symbol}}
74291a4b
MM
378
379@item Directory Options
380@xref{Directory Options,,Options for Directory Search}.
160633c6
MM
381@gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir}
382-specs=@var{file} -I- --sysroot=@var{dir}}
74291a4b
MM
383
384@item Target Options
385@c I wrote this xref this way to avoid overfull hbox. -- rms
386@xref{Target Options}.
9a94f7f3 387@gccoptlist{-V @var{version} -b @var{machine}}
74291a4b
MM
388
389@item Machine Dependent Options
390@xref{Submodel Options,,Hardware Models and Configurations}.
39bc1876
NS
391@c This list is ordered alphanumerically by subsection name.
392@c Try and put the significant identifier (CPU or system) first,
393@c so users have a clue at guessing where the ones they want will be.
5d22c1a5 394
39bc1876
NS
395@emph{ARC Options}
396@gccoptlist{-EB -EL @gol
397-mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
398-mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
74291a4b 399
74291a4b 400@emph{ARM Options}
9a94f7f3 401@gccoptlist{-mapcs-frame -mno-apcs-frame @gol
5848830f 402-mabi=@var{name} @gol
310668e8
JM
403-mapcs-stack-check -mno-apcs-stack-check @gol
404-mapcs-float -mno-apcs-float @gol
405-mapcs-reentrant -mno-apcs-reentrant @gol
406-msched-prolog -mno-sched-prolog @gol
407-mlittle-endian -mbig-endian -mwords-little-endian @gol
34a86306 408-mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
310668e8 409-mthumb-interwork -mno-thumb-interwork @gol
9b66ebb1 410-mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
247f8561 411-mstructure-size-boundary=@var{n} @gol
4bc1997b 412-mabort-on-noreturn @gol
310668e8
JM
413-mlong-calls -mno-long-calls @gol
414-msingle-pic-base -mno-single-pic-base @gol
247f8561
PB
415-mpic-register=@var{reg} @gol
416-mnop-fun-dllimport @gol
9b6b54e2 417-mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
247f8561 418-mpoke-function-name @gol
310668e8
JM
419-mthumb -marm @gol
420-mtpcs-frame -mtpcs-leaf-frame @gol
d3585b76
DJ
421-mcaller-super-interworking -mcallee-super-interworking @gol
422-mtp=@var{name}}
74291a4b 423
39bc1876
NS
424@emph{AVR Options}
425@gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
426-mcall-prologues -mno-tablejump -mtiny-stack -mint8}
861bb6c1 427
0d4a78eb 428@emph{Blackfin Options}
3fb192d2
BS
429@gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
430-mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
431-mlow-64k -mno-low64k -mid-shared-library @gol
b6877196
BS
432-mno-id-shared-library -mshared-library-id=@var{n} @gol
433-mlong-calls -mno-long-calls}
0d4a78eb 434
39bc1876
NS
435@emph{CRIS Options}
436@gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
437-mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
438-metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
439-mstack-align -mdata-align -mconst-align @gol
440-m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
441-melf -maout -melinux -mlinux -sim -sim2 @gol
442-mmul-bug-workaround -mno-mul-bug-workaround}
74291a4b 443
53054e77
PW
444@emph{CRX Options}
445@gccoptlist{-mmac -mpush-args}
446
48aec0bc 447@emph{Darwin Options}
6d2f9dd3
JM
448@gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
449-arch_only -bind_at_load -bundle -bundle_loader @gol
450-client_name -compatibility_version -current_version @gol
5079843a 451-dead_strip @gol
6d2f9dd3
JM
452-dependency-file -dylib_file -dylinker_install_name @gol
453-dynamic -dynamiclib -exported_symbols_list @gol
454-filelist -flat_namespace -force_cpusubtype_ALL @gol
455-force_flat_namespace -headerpad_max_install_names @gol
456-image_base -init -install_name -keep_private_externs @gol
457-multi_module -multiply_defined -multiply_defined_unused @gol
5079843a
DP
458-noall_load -no_dead_strip_inits_and_terms @gol
459-nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
6d2f9dd3
JM
460-pagezero_size -prebind -prebind_all_twolevel_modules @gol
461-private_bundle -read_only_relocs -sectalign @gol
462-sectobjectsymbols -whyload -seg1addr @gol
463-sectcreate -sectobjectsymbols -sectorder @gol
5826770c 464-segaddr -segs_read_only_addr -segs_read_write_addr @gol
6d2f9dd3
JM
465-seg_addr_table -seg_addr_table_filename -seglinkedit @gol
466-segprot -segs_read_only_addr -segs_read_write_addr @gol
467-single_module -static -sub_library -sub_umbrella @gol
468-twolevel_namespace -umbrella -undefined @gol
469-unexported_symbols_list -weak_reference_mismatches @gol
337f2a22 470-whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
ed5b9f96 471-mone-byte-bool}
48aec0bc 472
74291a4b 473@emph{DEC Alpha Options}
9a94f7f3 474@gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
4bc1997b
JM
475-mieee -mieee-with-inexact -mieee-conformant @gol
476-mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
477-mtrap-precision=@var{mode} -mbuild-constants @gol
58605ba0
RH
478-mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
479-mbwx -mmax -mfix -mcix @gol
480-mfloat-vax -mfloat-ieee @gol
9a94f7f3
JM
481-mexplicit-relocs -msmall-data -mlarge-data @gol
482-msmall-text -mlarge-text @gol
4bc1997b 483-mmemory-latency=@var{time}}
74291a4b 484
d7c23cdc 485@emph{DEC Alpha/VMS Options}
9a94f7f3 486@gccoptlist{-mvms-return-codes}
d7c23cdc 487
39bc1876
NS
488@emph{FRV Options}
489@gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
490-mhard-float -msoft-float @gol
491-malloc-cc -mfixed-cc -mdword -mno-dword @gol
492-mdouble -mno-double @gol
493-mmedia -mno-media -mmuladd -mno-muladd @gol
c557edf4
RS
494-mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
495-mlinked-fp -mlong-calls -malign-labels @gol
496-mlibrary-pic -macc-4 -macc-8 @gol
39bc1876 497-mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
38c28a25 498-moptimize-membar -mno-optimize-membar @gol
39bc1876
NS
499-mscc -mno-scc -mcond-exec -mno-cond-exec @gol
500-mvliw-branch -mno-vliw-branch @gol
501-mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
502-mno-nested-cond-exec -mtomcat-stats @gol
e4dd71de 503-mTLS -mtls @gol
39bc1876
NS
504-mcpu=@var{cpu}}
505
464aea98
JM
506@emph{GNU/Linux Options}
507@gccoptlist{-muclibc}
508
74291a4b 509@emph{H8/300 Options}
9a94f7f3 510@gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
74291a4b 511
39bc1876
NS
512@emph{HPPA Options}
513@gccoptlist{-march=@var{architecture-type} @gol
514-mbig-switch -mdisable-fpregs -mdisable-indexing @gol
515-mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
a2017852 516-mfixed-range=@var{register-range} @gol
39bc1876
NS
517-mjump-in-delay -mlinker-opt -mlong-calls @gol
518-mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
519-mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
520-mno-jump-in-delay -mno-long-load-store @gol
521-mno-portable-runtime -mno-soft-float @gol
522-mno-space-regs -msoft-float -mpa-risc-1-0 @gol
523-mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
524-mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
d711cf67 525-munix=@var{unix-std} -nolibdld -static -threads}
74291a4b 526
39bc1876
NS
527@emph{i386 and x86-64 Options}
528@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
529-mfpmath=@var{unit} @gol
530-masm=@var{dialect} -mno-fancy-math-387 @gol
531-mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
532-mno-wide-multiply -mrtd -malign-double @gol
533-mpreferred-stack-boundary=@var{num} @gol
ee963181 534-mmmx -msse -msse2 -msse3 -m3dnow -msselibm @gol
39bc1876
NS
535-mthreads -mno-align-stringops -minline-all-stringops @gol
536-mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
1f97667f
RG
537-m96bit-long-double -mregparm=@var{num} -msseregparm @gol
538-momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
39bc1876 539-mcmodel=@var{code-model} @gol
7dcbf659 540-m32 -m64 -mlarge-data-threshold=@var{num}}
56b2d7a7 541
39bc1876
NS
542@emph{IA-64 Options}
543@gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
4c334b37 544-mvolatile-asm-stop -mregister-names -mno-sdata @gol
39bc1876
NS
545-mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
546-minline-float-divide-max-throughput @gol
547-minline-int-divide-min-latency @gol
28b43def
SE
548-minline-int-divide-max-throughput @gol
549-minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
550-mno-dwarf2-asm -mearly-stop-bits @gol
551-mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
552-mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
282a61e6 553
39bc1876
NS
554@emph{M32R/D Options}
555@gccoptlist{-m32r2 -m32rx -m32r @gol
556-mdebug @gol
557-malign-loops -mno-align-loops @gol
558-missue-rate=@var{number} @gol
559-mbranch-cost=@var{number} @gol
560-mmodel=@var{code-size-model-type} @gol
561-msdata=@var{sdata-type} @gol
562-mno-flush-func -mflush-func=@var{name} @gol
563-mno-flush-trap -mflush-trap=@var{number} @gol
564-G @var{num}}
83575957 565
38b2d076
DD
566@emph{M32C Options}
567@gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
568
39bc1876
NS
569@emph{M680x0 Options}
570@gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
dcc21c4c
PB
571-m68060 -mcpu32 -m5200 -mcfv4e -m68881 -mbitfield @gol
572-mc68000 -mc68020 @gol
39bc1876
NS
573-mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
574-malign-int -mstrict-align -msep-data -mno-sep-data @gol
575-mshared-library-id=n -mid-shared-library -mno-id-shared-library}
789a3090 576
39bc1876
NS
577@emph{M68hc1x Options}
578@gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
579-mauto-incdec -minmax -mlong-calls -mshort @gol
580-msoft-reg-count=@var{count}}
052a4b28 581
789a3090 582@emph{MCore Options}
9a94f7f3 583@gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
310668e8
JM
584-mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
585-m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
586-mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
587-mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
f84271d9 588
39bc1876
NS
589@emph{MIPS Options}
590@gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
591-mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
592-mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
593-mxgot -mno-xgot -mgp32 -mgp64 -mfp32 -mfp64 @gol
594-mhard-float -msoft-float -msingle-float -mdouble-float @gol
118ea793 595-mdsp -mpaired-single -mips3d @gol
fb8136b2 596-mlong64 -mlong32 -msym32 -mno-sym32 @gol
39bc1876
NS
597-G@var{num} -membedded-data -mno-embedded-data @gol
598-muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
599-msplit-addresses -mno-split-addresses @gol
600-mexplicit-relocs -mno-explicit-relocs @gol
39bc1876 601-mcheck-zero-division -mno-check-zero-division @gol
9f0df97a 602-mdivide-traps -mdivide-breaks @gol
39bc1876
NS
603-mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
604-mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
605-mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
0ac40e7a
RS
606-mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
607-mfix-sb1 -mno-fix-sb1 @gol
39bc1876
NS
608-mflush-func=@var{func} -mno-flush-func @gol
609-mbranch-likely -mno-branch-likely @gol
610-mfp-exceptions -mno-fp-exceptions @gol
611-mvr4130-align -mno-vr4130-align}
bcf684c7 612
39bc1876
NS
613@emph{MMIX Options}
614@gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
615-mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
616-melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
617-mno-base-addresses -msingle-exit -mno-single-exit}
df6194d4 618
39bc1876
NS
619@emph{MN10300 Options}
620@gccoptlist{-mmult-bug -mno-mult-bug @gol
621-mam33 -mno-am33 @gol
622-mam33-2 -mno-am33-2 @gol
b1eb8119 623-mreturn-pointer-on-d0 @gol
39bc1876 624-mno-crt0 -mrelax}
91abf72d 625
6c9ac67a
NS
626@emph{MT Options}
627@gccoptlist{-mno-crt0 -mbacc -msim @gol
c85ba4fb
AH
628-march=@var{cpu-type} }
629
9f85bca7 630@emph{PDP-11 Options}
9a94f7f3 631@gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
9f85bca7
JM
632-mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
633-mint16 -mno-int32 -mfloat32 -mno-float64 @gol
634-mfloat64 -mno-float32 -mabshi -mno-abshi @gol
635-mbranch-expensive -mbranch-cheap @gol
636-msplit -mno-split -munix-asm -mdec-asm}
637
39bc1876
NS
638@emph{PowerPC Options}
639See RS/6000 and PowerPC Options.
640
641@emph{RS/6000 and PowerPC Options}
642@gccoptlist{-mcpu=@var{cpu-type} @gol
643-mtune=@var{cpu-type} @gol
644-mpower -mno-power -mpower2 -mno-power2 @gol
645-mpowerpc -mpowerpc64 -mno-powerpc @gol
646-maltivec -mno-altivec @gol
647-mpowerpc-gpopt -mno-powerpc-gpopt @gol
648-mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
9719f3b7 649-mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mfprnd -mno-fprnd @gol
39bc1876
NS
650-mnew-mnemonics -mold-mnemonics @gol
651-mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
de17c25f 652-m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
39bc1876
NS
653-malign-power -malign-natural @gol
654-msoft-float -mhard-float -mmultiple -mno-multiple @gol
655-mstring -mno-string -mupdate -mno-update @gol
656-mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
657-mstrict-align -mno-strict-align -mrelocatable @gol
658-mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
659-mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
ef765ea9 660-mdynamic-no-pic -maltivec -mswdiv @gol
39bc1876
NS
661-mprioritize-restricted-insns=@var{priority} @gol
662-msched-costly-dep=@var{dependence_type} @gol
663-minsert-sched-nops=@var{scheme} @gol
664-mcall-sysv -mcall-netbsd @gol
665-maix-struct-return -msvr4-struct-return @gol
7f970b70 666-mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
78f5898b 667-misel -mno-isel @gol
39bc1876 668-misel=yes -misel=no @gol
78f5898b 669-mspe -mno-spe @gol
39bc1876 670-mspe=yes -mspe=no @gol
78f5898b 671-mvrsave -mno-vrsave @gol
131aeb82 672-mmulhw -mno-mulhw @gol
4d4cbc0e 673-mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
39bc1876
NS
674-mprototype -mno-prototype @gol
675-msim -mmvme -mads -myellowknife -memb -msdata @gol
676-msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
677
678@emph{S/390 and zSeries Options}
679@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
f61a2c7d
AK
680-mhard-float -msoft-float -mlong-double-64 -mlong-double-128 @gol
681-mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
39bc1876
NS
682-msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
683-m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
d75f90f1
AK
684-mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
685-mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
39bc1876
NS
686
687@emph{SH Options}
688@gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
689-m4-nofpu -m4-single-only -m4-single -m4 @gol
312209c6 690-m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
39bc1876
NS
691-m5-64media -m5-64media-nofpu @gol
692-m5-32media -m5-32media-nofpu @gol
693-m5-compact -m5-compact-nofpu @gol
694-mb -ml -mdalign -mrelax @gol
2acc29bd 695-mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
39bc1876 696-mieee -misize -mpadstruct -mspace @gol
73a4d10b
R
697-mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
698-mdivsi3_libfunc=@var{name} @gol
699-madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
700 -minvalid-symbols}
39bc1876
NS
701
702@emph{SPARC Options}
703@gccoptlist{-mcpu=@var{cpu-type} @gol
704-mtune=@var{cpu-type} @gol
705-mcmodel=@var{code-model} @gol
706-m32 -m64 -mapp-regs -mno-app-regs @gol
707-mfaster-structs -mno-faster-structs @gol
708-mfpu -mno-fpu -mhard-float -msoft-float @gol
709-mhard-quad-float -msoft-quad-float @gol
710-mimpure-text -mno-impure-text -mlittle-endian @gol
711-mstack-bias -mno-stack-bias @gol
712-munaligned-doubles -mno-unaligned-doubles @gol
6bfb2f93 713-mv8plus -mno-v8plus -mvis -mno-vis
f5e2061b 714-threads -pthreads -pthread}
39bc1876
NS
715
716@emph{System V Options}
717@gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
718
719@emph{TMS320C3x/C4x Options}
720@gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
721-mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
722-mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
723-mparallel-insns -mparallel-mpy -mpreserve-float}
724
725@emph{V850 Options}
726@gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
727-mprolog-function -mno-prolog-function -mspace @gol
728-mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
729-mapp-regs -mno-app-regs @gol
730-mdisable-callt -mno-disable-callt @gol
731-mv850e1 @gol
732-mv850e @gol
733-mv850 -mbig-switch}
734
735@emph{VAX Options}
736@gccoptlist{-mg -mgnu -munix}
737
738@emph{x86-64 Options}
739See i386 and x86-64 Options.
740
69a0611f 741@emph{Xstormy16 Options}
9a94f7f3 742@gccoptlist{-msim}
69a0611f 743
03984308 744@emph{Xtensa Options}
6cedbe44 745@gccoptlist{-mconst16 -mno-const16 @gol
9a94f7f3 746-mfused-madd -mno-fused-madd @gol
9a94f7f3
JM
747-mtext-section-literals -mno-text-section-literals @gol
748-mtarget-align -mno-target-align @gol
749-mlongcalls -mno-longcalls}
03984308 750
39bc1876
NS
751@emph{zSeries Options}
752See S/390 and zSeries Options.
70899148 753
74291a4b
MM
754@item Code Generation Options
755@xref{Code Gen Options,,Options for Code Generation Conventions}.
9a94f7f3
JM
756@gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
757-ffixed-@var{reg} -fexceptions @gol
5d22c1a5 758-fnon-call-exceptions -funwind-tables @gol
a944ceb9 759-fasynchronous-unwind-tables @gol
4bc1997b 760-finhibit-size-directive -finstrument-functions @gol
dc170a87 761-fno-common -fno-ident @gol
24a4dd31 762-fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
82c0180d 763-fno-jump-tables @gol
4bc1997b 764-freg-struct-return -fshared-data -fshort-enums @gol
271bd540 765-fshort-double -fshort-wchar @gol
467cecf3 766-fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
4bc1997b
JM
767-fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
768-fargument-alias -fargument-noalias @gol
478c9e72 769-fargument-noalias-global -fleading-underscore @gol
d4463dfc 770-ftls-model=@var{model} @gol
d7afec4b 771-ftrapv -fwrapv -fbounds-check @gol
953ff289 772-fvisibility -fopenmp}
74291a4b
MM
773@end table
774
775@menu
776* Overall Options:: Controlling the kind of output:
777 an executable, object files, assembler files,
778 or preprocessed source.
779* C Dialect Options:: Controlling the variant of C language compiled.
780* C++ Dialect Options:: Variations on C++.
46e34f96
ZL
781* Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
782 and Objective-C++.
764dbbf2 783* Language Independent Options:: Controlling how diagnostics should be
02f52e19 784 formatted.
74291a4b
MM
785* Warning Options:: How picky should the compiler be?
786* Debugging Options:: Symbol tables, measurements, and debugging dumps.
787* Optimize Options:: How much optimization?
788* Preprocessor Options:: Controlling header files and macro definitions.
789 Also, getting dependency information for Make.
790* Assembler Options:: Passing options to the assembler.
791* Link Options:: Specifying libraries and so on.
792* Directory Options:: Where to find header files and libraries.
793 Where to find the compiler executable files.
a743d340 794* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 795* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
796@end menu
797
798@node Overall Options
799@section Options Controlling the Kind of Output
800
801Compilation can involve up to four stages: preprocessing, compilation
d1bd0ded
GK
802proper, assembly and linking, always in that order. GCC is capable of
803preprocessing and compiling several files either into several
804assembler input files, or into one assembler input file; then each
805assembler input file produces an object file, and linking combines all
806the object files (those newly compiled, and those specified as input)
807into an executable file.
74291a4b
MM
808
809@cindex file name suffix
810For any given input file, the file name suffix determines what kind of
811compilation is done:
812
2642624b 813@table @gcctabopt
74291a4b
MM
814@item @var{file}.c
815C source code which must be preprocessed.
816
817@item @var{file}.i
818C source code which should not be preprocessed.
819
820@item @var{file}.ii
821C++ source code which should not be preprocessed.
822
823@item @var{file}.m
46e34f96
ZL
824Objective-C source code. Note that you must link with the @file{libobjc}
825library to make an Objective-C program work.
74291a4b 826
b9265ec1
JM
827@item @var{file}.mi
828Objective-C source code which should not be preprocessed.
829
46e34f96
ZL
830@item @var{file}.mm
831@itemx @var{file}.M
832Objective-C++ source code. Note that you must link with the @file{libobjc}
833library to make an Objective-C++ program work. Note that @samp{.M} refers
834to a literal capital M@.
835
836@item @var{file}.mii
837Objective-C++ source code which should not be preprocessed.
838
74291a4b 839@item @var{file}.h
46e34f96
ZL
840C, C++, Objective-C or Objective-C++ header file to be turned into a
841precompiled header.
74291a4b
MM
842
843@item @var{file}.cc
b9265ec1 844@itemx @var{file}.cp
74291a4b
MM
845@itemx @var{file}.cxx
846@itemx @var{file}.cpp
ee8acf89 847@itemx @var{file}.CPP
b9265ec1 848@itemx @var{file}.c++
74291a4b
MM
849@itemx @var{file}.C
850C++ source code which must be preprocessed. Note that in @samp{.cxx},
851the last two letters must both be literally @samp{x}. Likewise,
161d7b59 852@samp{.C} refers to a literal capital C@.
74291a4b 853
6e955430
ZL
854@item @var{file}.mm
855@itemx @var{file}.M
856Objective-C++ source code which must be preprocessed.
857
858@item @var{file}.mii
859Objective-C++ source code which should not be preprocessed.
860
17211ab5
GK
861@item @var{file}.hh
862@itemx @var{file}.H
863C++ header file to be turned into a precompiled header.
864
b9265ec1
JM
865@item @var{file}.f
866@itemx @var{file}.for
867@itemx @var{file}.FOR
80a0c50a 868Fixed form Fortran source code which should not be preprocessed.
b9265ec1
JM
869
870@item @var{file}.F
871@itemx @var{file}.fpp
872@itemx @var{file}.FPP
80a0c50a 873Fixed form Fortran source code which must be preprocessed (with the traditional
b9265ec1
JM
874preprocessor).
875
6de9cd9a
DN
876@item @var{file}.f90
877@itemx @var{file}.f95
80a0c50a 878Free form Fortran source code which should not be preprocessed.
6de9cd9a 879
5a006700
MR
880@item @var{file}.F90
881@itemx @var{file}.F95
80a0c50a 882Free form Fortran source code which must be preprocessed (with the
5a006700
MR
883traditional preprocessor).
884
b9265ec1
JM
885@c FIXME: Descriptions of Java file types.
886@c @var{file}.java
887@c @var{file}.class
888@c @var{file}.zip
889@c @var{file}.jar
890
e23381df
GB
891@item @var{file}.ads
892Ada source code file which contains a library unit declaration (a
893declaration of a package, subprogram, or generic, or a generic
894instantiation), or a library unit renaming declaration (a package,
895generic, or subprogram renaming declaration). Such files are also
896called @dfn{specs}.
897
898@itemx @var{file}.adb
899Ada source code file containing a library unit body (a subprogram or
900package body). Such files are also called @dfn{bodies}.
901
b9265ec1 902@c GCC also knows about some suffixes for languages not yet included:
b9265ec1
JM
903@c Pascal:
904@c @var{file}.p
905@c @var{file}.pas
80a0c50a
TS
906@c Ratfor:
907@c @var{file}.r
b9265ec1 908
74291a4b
MM
909@item @var{file}.s
910Assembler code.
911
912@item @var{file}.S
913Assembler code which must be preprocessed.
914
915@item @var{other}
916An object file to be fed straight into linking.
917Any file name with no recognized suffix is treated this way.
918@end table
919
cd3bb277 920@opindex x
630d3d5a 921You can specify the input language explicitly with the @option{-x} option:
74291a4b 922
2642624b 923@table @gcctabopt
74291a4b
MM
924@item -x @var{language}
925Specify explicitly the @var{language} for the following input files
926(rather than letting the compiler choose a default based on the file
927name suffix). This option applies to all following input files until
630d3d5a 928the next @option{-x} option. Possible values for @var{language} are:
3ab51846 929@smallexample
46e34f96 930c c-header c-cpp-output
17211ab5 931c++ c++-header c++-cpp-output
46e34f96
ZL
932objective-c objective-c-header objective-c-cpp-output
933objective-c++ objective-c++-header objective-c++-cpp-output
74291a4b 934assembler assembler-with-cpp
e23381df 935ada
80a0c50a 936f77 f77-cpp-input
acd1a829 937f95 f95-cpp-input
e23381df 938java
b38b97c4 939treelang
3ab51846 940@end smallexample
74291a4b
MM
941
942@item -x none
943Turn off any specification of a language, so that subsequent files are
630d3d5a 944handled according to their file name suffixes (as they are if @option{-x}
74291a4b 945has not been used at all).
14a774a9
RK
946
947@item -pass-exit-codes
cd3bb277 948@opindex pass-exit-codes
bedc7537 949Normally the @command{gcc} program will exit with the code of 1 if any
14a774a9 950phase of the compiler returns a non-success return code. If you specify
630d3d5a 951@option{-pass-exit-codes}, the @command{gcc} program will instead return with
14a774a9
RK
952numerically highest error produced by any phase that returned an error
953indication.
74291a4b
MM
954@end table
955
956If you only want some of the stages of compilation, you can use
630d3d5a
JM
957@option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
958one of the options @option{-c}, @option{-S}, or @option{-E} to say where
bedc7537
NC
959@command{gcc} is to stop. Note that some combinations (for example,
960@samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
74291a4b 961
2642624b 962@table @gcctabopt
74291a4b 963@item -c
cd3bb277 964@opindex c
74291a4b
MM
965Compile or assemble the source files, but do not link. The linking
966stage simply is not done. The ultimate output is in the form of an
967object file for each source file.
968
969By default, the object file name for a source file is made by replacing
970the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
971
972Unrecognized input files, not requiring compilation or assembly, are
973ignored.
974
975@item -S
cd3bb277 976@opindex S
74291a4b
MM
977Stop after the stage of compilation proper; do not assemble. The output
978is in the form of an assembler code file for each non-assembler input
979file specified.
980
981By default, the assembler file name for a source file is made by
982replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
983
984Input files that don't require compilation are ignored.
985
986@item -E
cd3bb277 987@opindex E
74291a4b
MM
988Stop after the preprocessing stage; do not run the compiler proper. The
989output is in the form of preprocessed source code, which is sent to the
990standard output.
991
992Input files which don't require preprocessing are ignored.
993
994@cindex output file option
995@item -o @var{file}
cd3bb277 996@opindex o
74291a4b
MM
997Place output in file @var{file}. This applies regardless to whatever
998sort of output is being produced, whether it be an executable file,
999an object file, an assembler file or preprocessed C code.
1000
488061c8
GK
1001If @option{-o} is not specified, the default is to put an executable
1002file in @file{a.out}, the object file for
1003@file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1004assembler file in @file{@var{source}.s}, a precompiled header file in
1005@file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1006standard output.
74291a4b
MM
1007
1008@item -v
cd3bb277 1009@opindex v
74291a4b
MM
1010Print (on standard error output) the commands executed to run the stages
1011of compilation. Also print the version number of the compiler driver
1012program and of the preprocessor and the compiler proper.
1013
e8b3c8ac
IR
1014@item -###
1015@opindex ###
1016Like @option{-v} except the commands are not executed and all command
1017arguments are quoted. This is useful for shell scripts to capture the
1018driver-generated command lines.
1019
74291a4b 1020@item -pipe
cd3bb277 1021@opindex pipe
74291a4b
MM
1022Use pipes rather than temporary files for communication between the
1023various stages of compilation. This fails to work on some systems where
1024the assembler is unable to read from a pipe; but the GNU assembler has
1025no trouble.
844642e6 1026
0855eab7
CT
1027@item -combine
1028@opindex combine
1029If you are compiling multiple source files, this option tells the driver
f26c1794 1030to pass all the source files to the compiler at once (for those
0855eab7
CT
1031languages for which the compiler can handle this). This will allow
1032intermodule analysis (IMA) to be performed by the compiler. Currently the only
78466c0e 1033language for which this is supported is C@. If you pass source files for
0855eab7
CT
1034multiple languages to the driver, using this option, the driver will invoke
1035the compiler(s) that support IMA once each, passing each compiler all the
1036source files appropriate for it. For those languages that do not support
1037IMA this option will be ignored, and the compiler will be invoked once for
1038each source file in that language. If you use this option in conjunction
78466c0e
JM
1039with @option{-save-temps}, the compiler will generate multiple
1040pre-processed files
1041(one for each source file), but only one (combined) @file{.o} or
1042@file{.s} file.
0855eab7 1043
844642e6 1044@item --help
cd3bb277 1045@opindex help
844642e6 1046Print (on the standard output) a description of the command line options
bedc7537
NC
1047understood by @command{gcc}. If the @option{-v} option is also specified
1048then @option{--help} will also be passed on to the various processes
1049invoked by @command{gcc}, so that they can display the command line options
65ca2d60 1050they accept. If the @option{-Wextra} option is also specified then command
844642e6
NC
1051line options which have no documentation associated with them will also
1052be displayed.
10501d8f
CC
1053
1054@item --target-help
cd3bb277 1055@opindex target-help
10501d8f
CC
1056Print (on the standard output) a description of target specific command
1057line options for each tool.
e03b7153
RS
1058
1059@item --version
1060@opindex version
8a36672b 1061Display the version number and copyrights of the invoked GCC@.
9d530538
MM
1062
1063@include @value{srcdir}/../libiberty/at-file.texi
74291a4b
MM
1064@end table
1065
1066@node Invoking G++
1067@section Compiling C++ Programs
1068
1069@cindex suffixes for C++ source
1070@cindex C++ source file suffixes
1071C++ source files conventionally use one of the suffixes @samp{.C},
17211ab5
GK
1072@samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1073@samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
0c2d1a2a 1074preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
bba975d4 1075files with these names and compiles them as C++ programs even if you
17211ab5
GK
1076call the compiler the same way as for compiling C programs (usually
1077with the name @command{gcc}).
74291a4b
MM
1078
1079@findex g++
1080@findex c++
1081However, C++ programs often require class libraries as well as a
1082compiler that understands the C++ language---and under some
17211ab5
GK
1083circumstances, you might want to compile programs or header files from
1084standard input, or otherwise without a suffix that flags them as C++
1085programs. You might also like to precompile a C header file with a
1086@samp{.h} extension to be used in C++ compilations. @command{g++} is a
1087program that calls GCC with the default language set to C++, and
1088automatically specifies linking against the C++ library. On many
1089systems, @command{g++} is also installed with the name @command{c++}.
74291a4b 1090
bedc7537 1091@cindex invoking @command{g++}
74291a4b
MM
1092When you compile C++ programs, you may specify many of the same
1093command-line options that you use for compiling programs in any
1094language; or command-line options meaningful for C and related
1095languages; or options that are meaningful only for C++ programs.
1096@xref{C Dialect Options,,Options Controlling C Dialect}, for
161d7b59 1097explanations of options for languages related to C@.
74291a4b
MM
1098@xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1099explanations of options that are meaningful only for C++ programs.
1100
1101@node C Dialect Options
1102@section Options Controlling C Dialect
1103@cindex dialect options
1104@cindex language dialect options
1105@cindex options, dialect
1106
1107The following options control the dialect of C (or languages derived
46e34f96
ZL
1108from C, such as C++, Objective-C and Objective-C++) that the compiler
1109accepts:
74291a4b 1110
2642624b 1111@table @gcctabopt
74291a4b 1112@cindex ANSI support
c1030c7c 1113@cindex ISO support
74291a4b 1114@item -ansi
cd3bb277 1115@opindex ansi
3764f879 1116In C mode, support all ISO C90 programs. In C++ mode,
775afb25 1117remove GNU extensions that conflict with ISO C++.
74291a4b 1118
c1030c7c 1119This turns off certain features of GCC that are incompatible with ISO
3764f879 1120C90 (when compiling C code), or of standard C++ (when compiling C++ code),
0c2d1a2a 1121such as the @code{asm} and @code{typeof} keywords, and
74291a4b
MM
1122predefined macros such as @code{unix} and @code{vax} that identify the
1123type of system you are using. It also enables the undesirable and
02f52e19 1124rarely used ISO trigraph feature. For the C compiler,
0c2d1a2a 1125it disables recognition of C++ style @samp{//} comments as well as
775afb25 1126the @code{inline} keyword.
74291a4b
MM
1127
1128The alternate keywords @code{__asm__}, @code{__extension__},
1129@code{__inline__} and @code{__typeof__} continue to work despite
630d3d5a 1130@option{-ansi}. You would not want to use them in an ISO C program, of
74291a4b 1131course, but it is useful to put them in header files that might be included
630d3d5a 1132in compilations done with @option{-ansi}. Alternate predefined macros
74291a4b 1133such as @code{__unix__} and @code{__vax__} are also available, with or
630d3d5a 1134without @option{-ansi}.
74291a4b 1135
630d3d5a
JM
1136The @option{-ansi} option does not cause non-ISO programs to be
1137rejected gratuitously. For that, @option{-pedantic} is required in
1138addition to @option{-ansi}. @xref{Warning Options}.
74291a4b 1139
630d3d5a 1140The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
74291a4b
MM
1141option is used. Some header files may notice this macro and refrain
1142from declaring certain functions or defining certain macros that the
c1030c7c 1143ISO standard doesn't call for; this is to avoid interfering with any
74291a4b
MM
1144programs that might use these names for other things.
1145
c771326b
JM
1146Functions which would normally be built in but do not have semantics
1147defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
630d3d5a 1148functions with @option{-ansi} is used. @xref{Other Builtins,,Other
f0523f02 1149built-in functions provided by GCC}, for details of the functions
01702459 1150affected.
74291a4b 1151
49419c8f 1152@item -std=
cd3bb277 1153@opindex std
aee96fe9 1154Determine the language standard. This option is currently only
f749a36b
NB
1155supported when compiling C or C++. A value for this option must be
1156provided; possible values are
3932261a 1157
ee457005 1158@table @samp
aee96fe9
JM
1159@item c89
1160@itemx iso9899:1990
3764f879 1161ISO C90 (same as @option{-ansi}).
3043b30e
ML
1162
1163@item iso9899:199409
3764f879 1164ISO C90 as modified in amendment 1.
3043b30e 1165
49419c8f 1166@item c99
aee96fe9
JM
1167@itemx c9x
1168@itemx iso9899:1999
1169@itemx iso9899:199x
1170ISO C99. Note that this standard is not yet fully supported; see
1171@w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1172names @samp{c9x} and @samp{iso9899:199x} are deprecated.
3043b30e
ML
1173
1174@item gnu89
3764f879 1175Default, ISO C90 plus GNU extensions (including some C99 features).
3043b30e 1176
49419c8f 1177@item gnu99
31775d31 1178@itemx gnu9x
d15a05b3
EC
1179ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1180this will become the default. The name @samp{gnu9x} is deprecated.
49419c8f 1181
f749a36b
NB
1182@item c++98
1183The 1998 ISO C++ standard plus amendments.
1184
1185@item gnu++98
1186The same as @option{-std=c++98} plus GNU extensions. This is the
1187default for C++ code.
ee457005 1188@end table
3043b30e
ML
1189
1190Even when this option is not specified, you can still use some of the
1191features of newer standards in so far as they do not conflict with
1192previous C standards. For example, you may use @code{__restrict__} even
bedc7537 1193when @option{-std=c99} is not specified.
3932261a 1194
5490d604 1195The @option{-std} options specifying some version of ISO C have the same
3764f879 1196effects as @option{-ansi}, except that features that were not in ISO C90
5490d604
JM
1197but are in the specified version (for example, @samp{//} comments and
1198the @code{inline} keyword in ISO C99) are not disabled.
1199
c1030c7c
JM
1200@xref{Standards,,Language Standards Supported by GCC}, for details of
1201these standard versions.
1202
b1018de6
AO
1203@item -aux-info @var{filename}
1204@opindex aux-info
1205Output to the given filename prototyped declarations for all functions
1206declared and/or defined in a translation unit, including those in header
161d7b59 1207files. This option is silently ignored in any language other than C@.
b1018de6
AO
1208
1209Besides declarations, the file indicates, in comments, the origin of
1210each declaration (source file and line), whether the declaration was
1211implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1212@samp{O} for old, respectively, in the first character after the line
1213number and the colon), and whether it came from a declaration or a
1214definition (@samp{C} or @samp{F}, respectively, in the following
1215character). In the case of function definitions, a K&R-style list of
1216arguments followed by their declarations is also provided, inside
1217comments, after the declaration.
1218
74291a4b 1219@item -fno-asm
cd3bb277 1220@opindex fno-asm
74291a4b
MM
1221Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1222keyword, so that code can use these words as identifiers. You can use
1223the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
630d3d5a 1224instead. @option{-ansi} implies @option{-fno-asm}.
74291a4b
MM
1225
1226In C++, this switch only affects the @code{typeof} keyword, since
1227@code{asm} and @code{inline} are standard keywords. You may want to
630d3d5a 1228use the @option{-fno-gnu-keywords} flag instead, which has the same
5490d604
JM
1229effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1230switch only affects the @code{asm} and @code{typeof} keywords, since
1231@code{inline} is a standard keyword in ISO C99.
74291a4b
MM
1232
1233@item -fno-builtin
a3926fe1 1234@itemx -fno-builtin-@var{function}
cd3bb277 1235@opindex fno-builtin
c771326b
JM
1236@cindex built-in functions
1237Don't recognize built-in functions that do not begin with
01702459 1238@samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
f0523f02 1239functions provided by GCC}, for details of the functions affected,
c771326b 1240including those which are not built-in functions when @option{-ansi} or
5490d604
JM
1241@option{-std} options for strict ISO C conformance are used because they
1242do not have an ISO standard meaning.
74291a4b 1243
c771326b 1244GCC normally generates special code to handle certain built-in functions
74291a4b
MM
1245more efficiently; for instance, calls to @code{alloca} may become single
1246instructions that adjust the stack directly, and calls to @code{memcpy}
1247may become inline copy loops. The resulting code is often both smaller
1248and faster, but since the function calls no longer appear as such, you
1249cannot set a breakpoint on those calls, nor can you change the behavior
e6e931b7
JM
1250of the functions by linking with a different library. In addition,
1251when a function is recognized as a built-in function, GCC may use
1252information about that function to warn about problems with calls to
1253that function, or to generate more efficient code, even if the
1254resulting code still contains calls to that function. For example,
1255warnings are given with @option{-Wformat} for bad calls to
1256@code{printf}, when @code{printf} is built in, and @code{strlen} is
1257known not to modify global memory.
74291a4b 1258
a3926fe1
RS
1259With the @option{-fno-builtin-@var{function}} option
1260only the built-in function @var{function} is
7d14c755
JM
1261disabled. @var{function} must not begin with @samp{__builtin_}. If a
1262function is named this is not built-in in this version of GCC, this
1263option is ignored. There is no corresponding
1264@option{-fbuiltin-@var{function}} option; if you wish to enable
1265built-in functions selectively when using @option{-fno-builtin} or
1266@option{-ffreestanding}, you may define macros such as:
1267
1268@smallexample
1269#define abs(n) __builtin_abs ((n))
1270#define strcpy(d, s) __builtin_strcpy ((d), (s))
1271@end smallexample
1272
861bb6c1 1273@item -fhosted
cd3bb277 1274@opindex fhosted
861bb6c1
JL
1275@cindex hosted environment
1276
1277Assert that compilation takes place in a hosted environment. This implies
630d3d5a 1278@option{-fbuiltin}. A hosted environment is one in which the
861bb6c1
JL
1279entire standard library is available, and in which @code{main} has a return
1280type of @code{int}. Examples are nearly everything except a kernel.
630d3d5a 1281This is equivalent to @option{-fno-freestanding}.
861bb6c1
JL
1282
1283@item -ffreestanding
cd3bb277 1284@opindex ffreestanding
861bb6c1
JL
1285@cindex hosted environment
1286
1287Assert that compilation takes place in a freestanding environment. This
630d3d5a 1288implies @option{-fno-builtin}. A freestanding environment
861bb6c1
JL
1289is one in which the standard library may not exist, and program startup may
1290not necessarily be at @code{main}. The most obvious example is an OS kernel.
630d3d5a 1291This is equivalent to @option{-fno-hosted}.
861bb6c1 1292
c1030c7c
JM
1293@xref{Standards,,Language Standards Supported by GCC}, for details of
1294freestanding and hosted environments.
1295
750491fc
RH
1296@item -fms-extensions
1297@opindex fms-extensions
1298Accept some non-standard constructs used in Microsoft header files.
1299
2fbebc71
JM
1300Some cases of unnamed fields in structures and unions are only
1301accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1302fields within structs/unions}, for details.
1303
74291a4b 1304@item -trigraphs
cd3bb277 1305@opindex trigraphs
3bce8a01
NB
1306Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1307options for strict ISO C conformance) implies @option{-trigraphs}.
74291a4b 1308
8a035a6b
AH
1309@item -no-integrated-cpp
1310@opindex no-integrated-cpp
1311Performs a compilation in two passes: preprocessing and compiling. This
1312option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
8a36672b 1313@option{-B} option. The user supplied compilation step can then add in
8a035a6b 1314an additional preprocessing step after normal preprocessing but before
8a36672b 1315compiling. The default is to use the integrated cpp (internal cpp)
8a035a6b
AH
1316
1317The semantics of this option will change if "cc1", "cc1plus", and
1318"cc1obj" are merged.
1319
74291a4b
MM
1320@cindex traditional C language
1321@cindex C language, traditional
1322@item -traditional
f458d1d5 1323@itemx -traditional-cpp
cd3bb277 1324@opindex traditional-cpp
f458d1d5
ZW
1325@opindex traditional
1326Formerly, these options caused GCC to attempt to emulate a pre-standard
1327C compiler. They are now only supported with the @option{-E} switch.
1328The preprocessor continues to support a pre-standard mode. See the GNU
1329CPP manual for details.
74291a4b
MM
1330
1331@item -fcond-mismatch
cd3bb277 1332@opindex fcond-mismatch
74291a4b 1333Allow conditional expressions with mismatched types in the second and
a7537031
JM
1334third arguments. The value of such an expression is void. This option
1335is not supported for C++.
74291a4b
MM
1336
1337@item -funsigned-char
cd3bb277 1338@opindex funsigned-char
74291a4b
MM
1339Let the type @code{char} be unsigned, like @code{unsigned char}.
1340
1341Each kind of machine has a default for what @code{char} should
1342be. It is either like @code{unsigned char} by default or like
1343@code{signed char} by default.
1344
1345Ideally, a portable program should always use @code{signed char} or
1346@code{unsigned char} when it depends on the signedness of an object.
1347But many programs have been written to use plain @code{char} and
1348expect it to be signed, or expect it to be unsigned, depending on the
1349machines they were written for. This option, and its inverse, let you
1350make such a program work with the opposite default.
1351
1352The type @code{char} is always a distinct type from each of
1353@code{signed char} or @code{unsigned char}, even though its behavior
1354is always just like one of those two.
1355
1356@item -fsigned-char
cd3bb277 1357@opindex fsigned-char
74291a4b
MM
1358Let the type @code{char} be signed, like @code{signed char}.
1359
630d3d5a
JM
1360Note that this is equivalent to @option{-fno-unsigned-char}, which is
1361the negative form of @option{-funsigned-char}. Likewise, the option
1362@option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
74291a4b 1363
74291a4b
MM
1364@item -fsigned-bitfields
1365@itemx -funsigned-bitfields
1366@itemx -fno-signed-bitfields
1367@itemx -fno-unsigned-bitfields
cd3bb277
JM
1368@opindex fsigned-bitfields
1369@opindex funsigned-bitfields
1370@opindex fno-signed-bitfields
1371@opindex fno-unsigned-bitfields
c771326b 1372These options control whether a bit-field is signed or unsigned, when the
74291a4b 1373declaration does not use either @code{signed} or @code{unsigned}. By
c771326b 1374default, such a bit-field is signed, because this is consistent: the
74291a4b 1375basic integer types such as @code{int} are signed types.
74291a4b
MM
1376@end table
1377
1378@node C++ Dialect Options
1379@section Options Controlling C++ Dialect
1380
1381@cindex compiler options, C++
1382@cindex C++ options, command line
1383@cindex options, C++
1384This section describes the command-line options that are only meaningful
1385for C++ programs; but you can also use most of the GNU compiler options
1386regardless of what language your program is in. For example, you
1387might compile a file @code{firstClass.C} like this:
1388
3ab51846 1389@smallexample
1dc5fc4b 1390g++ -g -frepo -O -c firstClass.C
3ab51846 1391@end smallexample
74291a4b
MM
1392
1393@noindent
630d3d5a 1394In this example, only @option{-frepo} is an option meant
74291a4b 1395only for C++ programs; you can use the other options with any
161d7b59 1396language supported by GCC@.
74291a4b
MM
1397
1398Here is a list of options that are @emph{only} for compiling C++ programs:
1399
2642624b 1400@table @gcctabopt
2d3e278d
MM
1401
1402@item -fabi-version=@var{n}
1403@opindex fabi-version
8a36672b 1404Use version @var{n} of the C++ ABI@. Version 2 is the version of the
57702a80
MM
1405C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1406the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1407the version that conforms most closely to the C++ ABI specification.
1408Therefore, the ABI obtained using version 0 will change as ABI bugs
1409are fixed.
2d3e278d 1410
d150ccef 1411The default is version 2.
46c83bce 1412
74291a4b 1413@item -fno-access-control
cd3bb277 1414@opindex fno-access-control
74291a4b
MM
1415Turn off all access checking. This switch is mainly useful for working
1416around bugs in the access control code.
1417
74291a4b 1418@item -fcheck-new
cd3bb277 1419@opindex fcheck-new
74291a4b 1420Check that the pointer returned by @code{operator new} is non-null
6d9c4c83
JW
1421before attempting to modify the storage allocated. This check is
1422normally unnecessary because the C++ standard specifies that
1423@code{operator new} will only return @code{0} if it is declared
1424@samp{throw()}, in which case the compiler will always check the
1425return value even without this option. In all other cases, when
1426@code{operator new} has a non-empty exception specification, memory
1427exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1428@samp{new (nothrow)}.
1dc5fc4b 1429
74291a4b 1430@item -fconserve-space
cd3bb277 1431@opindex fconserve-space
74291a4b
MM
1432Put uninitialized or runtime-initialized global variables into the
1433common segment, as C does. This saves space in the executable at the
1434cost of not diagnosing duplicate definitions. If you compile with this
1435flag and your program mysteriously crashes after @code{main()} has
1436completed, you may have an object that is being destroyed twice because
1437two definitions were merged.
1438
1dc5fc4b
JM
1439This option is no longer useful on most targets, now that support has
1440been added for putting variables into BSS without making them common.
1441
d63d5d0c
ILT
1442@item -ffriend-injection
1443@opindex ffriend-injection
1444Inject friend functions into the enclosing namespace, so that they are
1445visible outside the scope of the class in which they are declared.
1446Friend functions were documented to work this way in the old Annotated
1447C++ Reference Manual, and versions of G++ before 4.1 always worked
1448that way. However, in ISO C++ a friend function which is not declared
1449in an enclosing scope can only be found using argument dependent
1450lookup. This option causes friends to be injected as they were in
1451earlier releases.
1452
1453This option is for compatibility, and may be removed in a future
1454release of G++.
1455
1dc5fc4b 1456@item -fno-elide-constructors
cd3bb277 1457@opindex fno-elide-constructors
1dc5fc4b
JM
1458The C++ standard allows an implementation to omit creating a temporary
1459which is only used to initialize another object of the same type.
aee96fe9 1460Specifying this option disables that optimization, and forces G++ to
1dc5fc4b 1461call the copy constructor in all cases.
74291a4b 1462
dd1ba632 1463@item -fno-enforce-eh-specs
cd3bb277 1464@opindex fno-enforce-eh-specs
4381020e
JM
1465Don't generate code to check for violation of exception specifications
1466at runtime. This option violates the C++ standard, but may be useful
1467for reducing code size in production builds, much like defining
1468@samp{NDEBUG}. This does not give user code permission to throw
1469exceptions in violation of the exception specifications; the compiler
1470will still optimize based on the specifications, so throwing an
1471unexpected exception will result in undefined behavior.
dd1ba632 1472
74291a4b 1473@item -ffor-scope
8c81598d 1474@itemx -fno-for-scope
cd3bb277
JM
1475@opindex ffor-scope
1476@opindex fno-for-scope
695ac33f 1477If @option{-ffor-scope} is specified, the scope of variables declared in
74291a4b 1478a @i{for-init-statement} is limited to the @samp{for} loop itself,
34527c47 1479as specified by the C++ standard.
695ac33f 1480If @option{-fno-for-scope} is specified, the scope of variables declared in
74291a4b 1481a @i{for-init-statement} extends to the end of the enclosing scope,
aee96fe9 1482as was the case in old versions of G++, and other (traditional)
74291a4b
MM
1483implementations of C++.
1484
1485The default if neither flag is given to follow the standard,
1486but to allow and give a warning for old-style code that would
1487otherwise be invalid, or have different behavior.
1488
1489@item -fno-gnu-keywords
cd3bb277 1490@opindex fno-gnu-keywords
9762e8a4 1491Do not recognize @code{typeof} as a keyword, so that code can use this
767094dd 1492word as an identifier. You can use the keyword @code{__typeof__} instead.
630d3d5a 1493@option{-ansi} implies @option{-fno-gnu-keywords}.
74291a4b 1494
1dc5fc4b 1495@item -fno-implicit-templates
cd3bb277 1496@opindex fno-implicit-templates
bba975d4 1497Never emit code for non-inline templates which are instantiated
e979f9e8 1498implicitly (i.e.@: by use); only emit code for explicit instantiations.
bba975d4
JM
1499@xref{Template Instantiation}, for more information.
1500
1501@item -fno-implicit-inline-templates
cd3bb277 1502@opindex fno-implicit-inline-templates
bba975d4
JM
1503Don't emit code for implicit instantiations of inline templates, either.
1504The default is to handle inlines differently so that compiles with and
1505without optimization will need the same set of explicit instantiations.
1dc5fc4b 1506
74291a4b 1507@item -fno-implement-inlines
cd3bb277 1508@opindex fno-implement-inlines
74291a4b
MM
1509To save space, do not emit out-of-line copies of inline functions
1510controlled by @samp{#pragma implementation}. This will cause linker
1511errors if these functions are not inlined everywhere they are called.
1512
631cf95d 1513@item -fms-extensions
cd3bb277 1514@opindex fms-extensions
32fb1fb2
PE
1515Disable pedantic warnings about constructs used in MFC, such as implicit
1516int and getting a pointer to member function via non-standard syntax.
631cf95d 1517
fcca588c 1518@item -fno-nonansi-builtins
cd3bb277 1519@opindex fno-nonansi-builtins
c771326b 1520Disable built-in declarations of functions that are not mandated by
161d7b59 1521ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
fcca588c
MM
1522@code{index}, @code{bzero}, @code{conjf}, and other related functions.
1523
775afb25 1524@item -fno-operator-names
cd3bb277 1525@opindex fno-operator-names
775afb25 1526Do not treat the operator name keywords @code{and}, @code{bitand},
74291a4b 1527@code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
775afb25 1528synonyms as keywords.
74291a4b 1529
4f8b4fd9 1530@item -fno-optional-diags
cd3bb277 1531@opindex fno-optional-diags
4f8b4fd9 1532Disable diagnostics that the standard says a compiler does not need to
aee96fe9 1533issue. Currently, the only such diagnostic issued by G++ is the one for
bba975d4 1534a name having multiple meanings within a class.
4f8b4fd9 1535
8c7707b0 1536@item -fpermissive
cd3bb277 1537@opindex fpermissive
4a386498
MM
1538Downgrade some diagnostics about nonconformant code from errors to
1539warnings. Thus, using @option{-fpermissive} will allow some
1540nonconforming code to compile.
8c7707b0 1541
8c81598d 1542@item -frepo
cd3bb277 1543@opindex frepo
9c34dbbf
ZW
1544Enable automatic template instantiation at link time. This option also
1545implies @option{-fno-implicit-templates}. @xref{Template
1546Instantiation}, for more information.
8c81598d 1547
8c7707b0 1548@item -fno-rtti
cd3bb277 1549@opindex fno-rtti
a7fbfcf9
JM
1550Disable generation of information about every class with virtual
1551functions for use by the C++ runtime type identification features
1552(@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1553of the language, you can save some space by using this flag. Note that
1554exception handling uses the same information, but it will generate it as
1555needed.
8c7707b0 1556
fcca588c 1557@item -fstats
cd3bb277 1558@opindex fstats
fcca588c
MM
1559Emit statistics about front-end processing at the end of the compilation.
1560This information is generally only useful to the G++ development team.
1561
1dc5fc4b 1562@item -ftemplate-depth-@var{n}
cd3bb277 1563@opindex ftemplate-depth
1dc5fc4b
JM
1564Set the maximum instantiation depth for template classes to @var{n}.
1565A limit on the template instantiation depth is needed to detect
767094dd 1566endless recursions during template class instantiation. ANSI/ISO C++
1dc5fc4b
JM
1567conforming programs must not rely on a maximum depth greater than 17.
1568
40aac948
JM
1569@item -fno-threadsafe-statics
1570@opindex fno-threadsafe-statics
1571Do not emit the extra code to use the routines specified in the C++
1572ABI for thread-safe initialization of local statics. You can use this
1573option to reduce code size slightly in code that doesn't need to be
1574thread-safe.
1575
fc693822 1576@item -fuse-cxa-atexit
cd3bb277 1577@opindex fuse-cxa-atexit
fc693822
MM
1578Register destructors for objects with static storage duration with the
1579@code{__cxa_atexit} function rather than the @code{atexit} function.
1580This option is required for fully standards-compliant handling of static
1581destructors, but will only work if your C library supports
1582@code{__cxa_atexit}.
1583
d7afec4b
ND
1584@item -fvisibility-inlines-hidden
1585@opindex fvisibility-inlines-hidden
1586Causes all inlined methods to be marked with
1587@code{__attribute__ ((visibility ("hidden")))} so that they do not
1588appear in the export table of a DSO and do not require a PLT indirection
8a36672b 1589when used within the DSO@. Enabling this option can have a dramatic effect
d7afec4b 1590on load and link times of a DSO as it massively reduces the size of the
8a36672b 1591dynamic export table when the library makes heavy use of templates. While
d7afec4b
ND
1592it can cause bloating through duplication of code within each DSO where
1593it is used, often the wastage is less than the considerable space occupied
1594by a long symbol name in the export table which is typical when using
8a36672b 1595templates and namespaces. For even more savings, combine with the
4ec7afd7 1596@option{-fvisibility=hidden} switch.
d7afec4b 1597
02f52e19 1598@item -fno-weak
cd3bb277 1599@opindex fno-weak
90ecce3e 1600Do not use weak symbol support, even if it is provided by the linker.
fcca588c
MM
1601By default, G++ will use weak symbols if they are available. This
1602option exists only for testing, and should not be used by end-users;
1603it will result in inferior code and has no benefits. This option may
1604be removed in a future release of G++.
1605
74291a4b 1606@item -nostdinc++
cd3bb277 1607@opindex nostdinc++
74291a4b
MM
1608Do not search for header files in the standard directories specific to
1609C++, but do still search the other standard directories. (This option
e5e809f4 1610is used when building the C++ library.)
74291a4b
MM
1611@end table
1612
1613In addition, these optimization, warning, and code generation options
1614have meanings only for C++ programs:
1615
2642624b 1616@table @gcctabopt
74291a4b 1617@item -fno-default-inline
cd3bb277 1618@opindex fno-default-inline
74291a4b 1619Do not assume @samp{inline} for functions defined inside a class scope.
1dc5fc4b
JM
1620@xref{Optimize Options,,Options That Control Optimization}. Note that these
1621functions will have linkage like inline functions; they just won't be
1622inlined by default.
74291a4b 1623
eca7f13c
MM
1624@item -Wabi @r{(C++ only)}
1625@opindex Wabi
1626Warn when G++ generates code that is probably not compatible with the
8a36672b 1627vendor-neutral C++ ABI@. Although an effort has been made to warn about
daf2f129 1628all such cases, there are probably some cases that are not warned about,
eca7f13c
MM
1629even though G++ is generating incompatible code. There may also be
1630cases where warnings are emitted even though the code that is generated
1631will be compatible.
1632
1633You should rewrite your code to avoid these warnings if you are
1634concerned about the fact that code generated by G++ may not be binary
1635compatible with code generated by other compilers.
1636
3364c33b 1637The known incompatibilities at this point include:
eca7f13c
MM
1638
1639@itemize @bullet
1640
1641@item
1642Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1643pack data into the same byte as a base class. For example:
1644
1645@smallexample
1646struct A @{ virtual void f(); int f1 : 1; @};
1647struct B : public A @{ int f2 : 1; @};
1648@end smallexample
1649
1650@noindent
1651In this case, G++ will place @code{B::f2} into the same byte
daf2f129 1652as@code{A::f1}; other compilers will not. You can avoid this problem
eca7f13c
MM
1653by explicitly padding @code{A} so that its size is a multiple of the
1654byte size on your platform; that will cause G++ and other compilers to
1655layout @code{B} identically.
1656
1657@item
1658Incorrect handling of tail-padding for virtual bases. G++ does not use
1659tail padding when laying out virtual bases. For example:
1660
1661@smallexample
1662struct A @{ virtual void f(); char c1; @};
1663struct B @{ B(); char c2; @};
1664struct C : public A, public virtual B @{@};
1665@end smallexample
1666
1667@noindent
1668In this case, G++ will not place @code{B} into the tail-padding for
1669@code{A}; other compilers will. You can avoid this problem by
1670explicitly padding @code{A} so that its size is a multiple of its
1671alignment (ignoring virtual base classes); that will cause G++ and other
1672compilers to layout @code{C} identically.
1673
2d3e278d
MM
1674@item
1675Incorrect handling of bit-fields with declared widths greater than that
1676of their underlying types, when the bit-fields appear in a union. For
1677example:
1678
1679@smallexample
1680union U @{ int i : 4096; @};
1681@end smallexample
1682
1683@noindent
1684Assuming that an @code{int} does not have 4096 bits, G++ will make the
1685union too small by the number of bits in an @code{int}.
1686
956d9305
MM
1687@item
1688Empty classes can be placed at incorrect offsets. For example:
daf2f129 1689
956d9305
MM
1690@smallexample
1691struct A @{@};
1692
1693struct B @{
1694 A a;
1695 virtual void f ();
1696@};
1697
1698struct C : public B, public A @{@};
1699@end smallexample
1700
1701@noindent
c0478a66 1702G++ will place the @code{A} base class of @code{C} at a nonzero offset;
956d9305
MM
1703it should be placed at offset zero. G++ mistakenly believes that the
1704@code{A} data member of @code{B} is already at offset zero.
1705
6397d80b
MM
1706@item
1707Names of template functions whose types involve @code{typename} or
1708template template parameters can be mangled incorrectly.
1709
1710@smallexample
1711template <typename Q>
1712void f(typename Q::X) @{@}
1713
1714template <template <typename> class Q>
1715void f(typename Q<int>::X) @{@}
1716@end smallexample
1717
1718@noindent
3364c33b 1719Instantiations of these templates may be mangled incorrectly.
6397d80b 1720
eca7f13c
MM
1721@end itemize
1722
aee96fe9 1723@item -Wctor-dtor-privacy @r{(C++ only)}
cd3bb277 1724@opindex Wctor-dtor-privacy
9eff22bc
LG
1725Warn when a class seems unusable because all the constructors or
1726destructors in that class are private, and it has neither friends nor
78d0a54d 1727public static member functions.
bba975d4 1728
aee96fe9 1729@item -Wnon-virtual-dtor @r{(C++ only)}
cd3bb277 1730@opindex Wnon-virtual-dtor
9eff22bc 1731Warn when a class appears to be polymorphic, thereby requiring a virtual
efee9ded
GDR
1732destructor, yet it declares a non-virtual one. This warning is also
1733enabled if -Weffc++ is specified.
bba975d4 1734
aee96fe9 1735@item -Wreorder @r{(C++ only)}
cd3bb277 1736@opindex Wreorder
bba975d4
JM
1737@cindex reordering, warning
1738@cindex warning for reordering of member initializers
1739Warn when the order of member initializers given in the code does not
1740match the order in which they must be executed. For instance:
1741
1742@smallexample
1743struct A @{
1744 int i;
1745 int j;
1746 A(): j (0), i (1) @{ @}
1747@};
1748@end smallexample
1749
9eff22bc
LG
1750The compiler will rearrange the member initializers for @samp{i}
1751and @samp{j} to match the declaration order of the members, emitting
1752a warning to that effect. This warning is enabled by @option{-Wall}.
bba975d4
JM
1753@end table
1754
630d3d5a 1755The following @option{-W@dots{}} options are not affected by @option{-Wall}.
bba975d4 1756
2642624b 1757@table @gcctabopt
aee96fe9 1758@item -Weffc++ @r{(C++ only)}
cd3bb277 1759@opindex Weffc++
77f6c1eb
RS
1760Warn about violations of the following style guidelines from Scott Meyers'
1761@cite{Effective C++} book:
1762
1763@itemize @bullet
1764@item
1765Item 11: Define a copy constructor and an assignment operator for classes
1766with dynamically allocated memory.
1767
1768@item
1769Item 12: Prefer initialization to assignment in constructors.
1770
1771@item
1772Item 14: Make destructors virtual in base classes.
1773
1774@item
1775Item 15: Have @code{operator=} return a reference to @code{*this}.
1776
1777@item
1778Item 23: Don't try to return a reference when you must return an object.
1779
1780@end itemize
1781
daf2f129 1782Also warn about violations of the following style guidelines from
9eff22bc 1783Scott Meyers' @cite{More Effective C++} book:
77f6c1eb
RS
1784
1785@itemize @bullet
1786@item
1787Item 6: Distinguish between prefix and postfix forms of increment and
1788decrement operators.
1789
1790@item
1791Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1792
1793@end itemize
1794
9eff22bc
LG
1795When selecting this option, be aware that the standard library
1796headers do not obey all of these guidelines; use @samp{grep -v}
77f6c1eb 1797to filter out those warnings.
bba975d4 1798
aee96fe9 1799@item -Wno-deprecated @r{(C++ only)}
cd3bb277 1800@opindex Wno-deprecated
767094dd 1801Do not warn about usage of deprecated features. @xref{Deprecated Features}.
2de45c06 1802
b2f97e4a
MM
1803@item -Wstrict-null-sentinel @r{(C++ only)}
1804@opindex Wstrict-null-sentinel
1805Warn also about the use of an uncasted @code{NULL} as sentinel. When
1806compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1807to @code{__null}. Although it is a null pointer constant not a null pointer,
1808it is guaranteed to of the same size as a pointer. But this use is
1809not portable across different compilers.
1810
aee96fe9 1811@item -Wno-non-template-friend @r{(C++ only)}
cd3bb277 1812@opindex Wno-non-template-friend
bba975d4 1813Disable warnings when non-templatized friend functions are declared
9eff22bc 1814within a template. Since the advent of explicit template specification
aee96fe9 1815support in G++, if the name of the friend is an unqualified-id (i.e.,
bba975d4 1816@samp{friend foo(int)}), the C++ language specification demands that the
767094dd 1817friend declare or define an ordinary, nontemplate function. (Section
aee96fe9 181814.5.3). Before G++ implemented explicit specification, unqualified-ids
bba975d4 1819could be interpreted as a particular specialization of a templatized
767094dd 1820function. Because this non-conforming behavior is no longer the default
aee96fe9 1821behavior for G++, @option{-Wnon-template-friend} allows the compiler to
9eff22bc 1822check existing code for potential trouble spots and is on by default.
2228d450 1823This new compiler behavior can be turned off with
630d3d5a 1824@option{-Wno-non-template-friend} which keeps the conformant compiler code
2228d450 1825but disables the helpful warning.
bba975d4 1826
aee96fe9 1827@item -Wold-style-cast @r{(C++ only)}
cd3bb277 1828@opindex Wold-style-cast
323728aa 1829Warn if an old-style (C-style) cast to a non-void type is used within
7cd5c075
GP
1830a C++ program. The new-style casts (@samp{dynamic_cast},
1831@samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1832less vulnerable to unintended effects and much easier to search for.
bba975d4 1833
aee96fe9 1834@item -Woverloaded-virtual @r{(C++ only)}
cd3bb277 1835@opindex Woverloaded-virtual
bba975d4
JM
1836@cindex overloaded virtual fn, warning
1837@cindex warning for overloaded virtual fn
3747f3dc
MM
1838Warn when a function declaration hides virtual functions from a
1839base class. For example, in:
1840
1841@smallexample
1842struct A @{
1843 virtual void f();
1844@};
1845
1846struct B: public A @{
1847 void f(int);
1848@};
1849@end smallexample
1850
1851the @code{A} class version of @code{f} is hidden in @code{B}, and code
9eff22bc 1852like:
3747f3dc
MM
1853
1854@smallexample
1855B* b;
1856b->f();
1857@end smallexample
1858
1859will fail to compile.
bba975d4 1860
aee96fe9 1861@item -Wno-pmf-conversions @r{(C++ only)}
cd3bb277 1862@opindex Wno-pmf-conversions
bba975d4
JM
1863Disable the diagnostic for converting a bound pointer to member function
1864to a plain pointer.
1865
aee96fe9 1866@item -Wsign-promo @r{(C++ only)}
cd3bb277 1867@opindex Wsign-promo
bba975d4 1868Warn when overload resolution chooses a promotion from unsigned or
2eac577f 1869enumerated type to a signed type, over a conversion to an unsigned type of
aee96fe9 1870the same size. Previous versions of G++ would try to preserve
bba975d4
JM
1871unsignedness, but the standard mandates the current behavior.
1872
bba975d4
JM
1873@smallexample
1874struct A @{
1875 operator int ();
1876 A& operator = (int);
1877@};
1878
1879main ()
1880@{
1881 A a,b;
1882 a = b;
1883@}
1884@end smallexample
74291a4b 1885
aee96fe9 1886In this example, G++ will synthesize a default @samp{A& operator =
bba975d4 1887(const A&);}, while cfront will use the user-defined @samp{operator =}.
74291a4b
MM
1888@end table
1889
46e34f96
ZL
1890@node Objective-C and Objective-C++ Dialect Options
1891@section Options Controlling Objective-C and Objective-C++ Dialects
60de6385 1892
46e34f96
ZL
1893@cindex compiler options, Objective-C and Objective-C++
1894@cindex Objective-C and Objective-C++ options, command line
1895@cindex options, Objective-C and Objective-C++
1896(NOTE: This manual does not describe the Objective-C and Objective-C++
1897languages themselves. See @xref{Standards,,Language Standards
1898Supported by GCC}, for references.)
264fa2db 1899
60de6385 1900This section describes the command-line options that are only meaningful
46e34f96
ZL
1901for Objective-C and Objective-C++ programs, but you can also use most of
1902the language-independent GNU compiler options.
1903For example, you might compile a file @code{some_class.m} like this:
60de6385 1904
3ab51846 1905@smallexample
60de6385 1906gcc -g -fgnu-runtime -O -c some_class.m
3ab51846 1907@end smallexample
60de6385
SS
1908
1909@noindent
9eff22bc 1910In this example, @option{-fgnu-runtime} is an option meant only for
46e34f96
ZL
1911Objective-C and Objective-C++ programs; you can use the other options with
1912any language supported by GCC@.
1913
1914Note that since Objective-C is an extension of the C language, Objective-C
f0eb93a8 1915compilations may also use options specific to the C front-end (e.g.,
46e34f96
ZL
1916@option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1917C++-specific options (e.g., @option{-Wabi}).
60de6385
SS
1918
1919Here is a list of options that are @emph{only} for compiling Objective-C
46e34f96 1920and Objective-C++ programs:
60de6385
SS
1921
1922@table @gcctabopt
630d3d5a 1923@item -fconstant-string-class=@var{class-name}
cd3bb277 1924@opindex fconstant-string-class
630d3d5a 1925Use @var{class-name} as the name of the class to instantiate for each
695ac33f 1926literal string specified with the syntax @code{@@"@dots{}"}. The default
264fa2db
ZL
1927class name is @code{NXConstantString} if the GNU runtime is being used, and
1928@code{NSConstantString} if the NeXT runtime is being used (see below). The
1929@option{-fconstant-cfstrings} option, if also present, will override the
1930@option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1931to be laid out as constant CoreFoundation strings.
60de6385
SS
1932
1933@item -fgnu-runtime
cd3bb277 1934@opindex fgnu-runtime
60de6385
SS
1935Generate object code compatible with the standard GNU Objective-C
1936runtime. This is the default for most types of systems.
1937
1938@item -fnext-runtime
cd3bb277 1939@opindex fnext-runtime
60de6385 1940Generate output compatible with the NeXT runtime. This is the default
1f676100
NP
1941for NeXT-based systems, including Darwin and Mac OS X@. The macro
1942@code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1943used.
60de6385 1944
264fa2db 1945@item -fno-nil-receivers
5ad7ae7f 1946@opindex fno-nil-receivers
daf2f129
JM
1947Assume that all Objective-C message dispatches (e.g.,
1948@code{[receiver message:arg]}) in this translation unit ensure that the receiver
46e34f96
ZL
1949is not @code{nil}. This allows for more efficient entry points in the runtime
1950to be used. Currently, this option is only available in conjunction with
264fa2db
ZL
1951the NeXT runtime on Mac OS X 10.3 and later.
1952
6e955430
ZL
1953@item -fobjc-call-cxx-cdtors
1954@opindex fobjc-call-cxx-cdtors
1955For each Objective-C class, check if any of its instance variables is a
1956C++ object with a non-trivial default constructor. If so, synthesize a
1957special @code{- (id) .cxx_construct} instance method that will run
1958non-trivial default constructors on any such instance variables, in order,
1959and then return @code{self}. Similarly, check if any instance variable
1960is a C++ object with a non-trivial destructor, and if so, synthesize a
1961special @code{- (void) .cxx_destruct} method that will run
1962all such default destructors, in reverse order.
1963
1964The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1965thusly generated will only operate on instance variables declared in the
1966current Objective-C class, and not those inherited from superclasses. It
1967is the responsibility of the Objective-C runtime to invoke all such methods
1968in an object's inheritance hierarchy. The @code{- (id) .cxx_construct} methods
1969will be invoked by the runtime immediately after a new object
1970instance is allocated; the @code{- (void) .cxx_destruct} methods will
1971be invoked immediately before the runtime deallocates an object instance.
1972
1973As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1974support for invoking the @code{- (id) .cxx_construct} and
1975@code{- (void) .cxx_destruct} methods.
1976
1977@item -fobjc-direct-dispatch
1978@opindex fobjc-direct-dispatch
1979Allow fast jumps to the message dispatcher. On Darwin this is
128a79fb 1980accomplished via the comm page.
6e955430 1981
264fa2db 1982@item -fobjc-exceptions
5ad7ae7f 1983@opindex fobjc-exceptions
daf2f129 1984Enable syntactic support for structured exception handling in Objective-C,
3dd9b65f
MS
1985similar to what is offered by C++ and Java. This option is
1986unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
1987earlier.
264fa2db
ZL
1988
1989@smallexample
1990 @@try @{
1991 @dots{}
1992 @@throw expr;
1993 @dots{}
1994 @}
1995 @@catch (AnObjCClass *exc) @{
1996 @dots{}
1997 @@throw expr;
1998 @dots{}
1999 @@throw;
2000 @dots{}
2001 @}
2002 @@catch (AnotherClass *exc) @{
2003 @dots{}
2004 @}
2005 @@catch (id allOthers) @{
2006 @dots{}
2007 @}
2008 @@finally @{
2009 @dots{}
2010 @@throw expr;
2011 @dots{}
2012 @}
2013@end smallexample
2014
2015The @code{@@throw} statement may appear anywhere in an Objective-C or
daf2f129
JM
2016Objective-C++ program; when used inside of a @code{@@catch} block, the
2017@code{@@throw} may appear without an argument (as shown above), in which case
264fa2db
ZL
2018the object caught by the @code{@@catch} will be rethrown.
2019
2020Note that only (pointers to) Objective-C objects may be thrown and
2021caught using this scheme. When an object is thrown, it will be caught
2022by the nearest @code{@@catch} clause capable of handling objects of that type,
daf2f129
JM
2023analogously to how @code{catch} blocks work in C++ and Java. A
2024@code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
264fa2db
ZL
2025any and all Objective-C exceptions not caught by previous @code{@@catch}
2026clauses (if any).
2027
2028The @code{@@finally} clause, if present, will be executed upon exit from the
2029immediately preceding @code{@@try @dots{} @@catch} section. This will happen
2030regardless of whether any exceptions are thrown, caught or rethrown
2031inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2032of the @code{finally} clause in Java.
2033
2034There are several caveats to using the new exception mechanism:
2035
2036@itemize @bullet
2037@item
daf2f129 2038Although currently designed to be binary compatible with @code{NS_HANDLER}-style
264fa2db
ZL
2039idioms provided by the @code{NSException} class, the new
2040exceptions can only be used on Mac OS X 10.3 (Panther) and later
2041systems, due to additional functionality needed in the (NeXT) Objective-C
2042runtime.
2043
2044@item
2045As mentioned above, the new exceptions do not support handling
daf2f129 2046types other than Objective-C objects. Furthermore, when used from
264fa2db
ZL
2047Objective-C++, the Objective-C exception model does not interoperate with C++
2048exceptions at this time. This means you cannot @code{@@throw} an exception
daf2f129 2049from Objective-C and @code{catch} it in C++, or vice versa
264fa2db
ZL
2050(i.e., @code{throw @dots{} @@catch}).
2051@end itemize
daf2f129 2052
264fa2db
ZL
2053The @option{-fobjc-exceptions} switch also enables the use of synchronization
2054blocks for thread-safe execution:
2055
2056@smallexample
2057 @@synchronized (ObjCClass *guard) @{
2058 @dots{}
2059 @}
2060@end smallexample
2061
2062Upon entering the @code{@@synchronized} block, a thread of execution shall
2063first check whether a lock has been placed on the corresponding @code{guard}
2064object by another thread. If it has, the current thread shall wait until
daf2f129 2065the other thread relinquishes its lock. Once @code{guard} becomes available,
264fa2db
ZL
2066the current thread will place its own lock on it, execute the code contained in
2067the @code{@@synchronized} block, and finally relinquish the lock (thereby
2068making @code{guard} available to other threads).
2069
2070Unlike Java, Objective-C does not allow for entire methods to be marked
2071@code{@@synchronized}. Note that throwing exceptions out of
2072@code{@@synchronized} blocks is allowed, and will cause the guarding object
2073to be unlocked properly.
2074
6e955430
ZL
2075@item -fobjc-gc
2076@opindex fobjc-gc
2077Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2078
264fa2db 2079@item -freplace-objc-classes
5ad7ae7f 2080@opindex freplace-objc-classes
264fa2db
ZL
2081Emit a special marker instructing @command{ld(1)} not to statically link in
2082the resulting object file, and allow @command{dyld(1)} to load it in at
2083run time instead. This is used in conjunction with the Fix-and-Continue
daf2f129 2084debugging mode, where the object file in question may be recompiled and
264fa2db
ZL
2085dynamically reloaded in the course of program execution, without the need
2086to restart the program itself. Currently, Fix-and-Continue functionality
daf2f129 2087is only available in conjunction with the NeXT runtime on Mac OS X 10.3
264fa2db
ZL
2088and later.
2089
2090@item -fzero-link
5ad7ae7f 2091@opindex fzero-link
264fa2db
ZL
2092When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2093to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2094compile time) with static class references that get initialized at load time,
2095which improves run-time performance. Specifying the @option{-fzero-link} flag
2096suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
daf2f129 2097to be retained. This is useful in Zero-Link debugging mode, since it allows
264fa2db
ZL
2098for individual class implementations to be modified during program execution.
2099
60de6385 2100@item -gen-decls
cd3bb277 2101@opindex gen-decls
60de6385
SS
2102Dump interface declarations for all classes seen in the source file to a
2103file named @file{@var{sourcename}.decl}.
2104
6e955430
ZL
2105@item -Wassign-intercept
2106@opindex Wassign-intercept
2107Warn whenever an Objective-C assignment is being intercepted by the
2108garbage collector.
2109
60de6385 2110@item -Wno-protocol
cd3bb277 2111@opindex Wno-protocol
1f676100
NP
2112If a class is declared to implement a protocol, a warning is issued for
2113every method in the protocol that is not implemented by the class. The
6335b0aa 2114default behavior is to issue a warning for every method not explicitly
1f676100 2115implemented in the class, even if a method implementation is inherited
4ec7afd7 2116from the superclass. If you use the @option{-Wno-protocol} option, then
1f676100
NP
2117methods inherited from the superclass are considered to be implemented,
2118and no warning is issued for them.
60de6385
SS
2119
2120@item -Wselector
cd3bb277 2121@opindex Wselector
1f676100
NP
2122Warn if multiple methods of different types for the same selector are
2123found during compilation. The check is performed on the list of methods
2124in the final stage of compilation. Additionally, a check is performed
9eff22bc
LG
2125for each selector appearing in a @code{@@selector(@dots{})}
2126expression, and a corresponding method for that selector has been found
1f676100
NP
2127during compilation. Because these checks scan the method table only at
2128the end of compilation, these warnings are not produced if the final
2129stage of compilation is not reached, for example because an error is
4ec7afd7 2130found during compilation, or because the @option{-fsyntax-only} option is
1f676100
NP
2131being used.
2132
6e955430
ZL
2133@item -Wstrict-selector-match
2134@opindex Wstrict-selector-match
2135Warn if multiple methods with differing argument and/or return types are
2136found for a given selector when attempting to send a message using this
2137selector to a receiver of type @code{id} or @code{Class}. When this flag
2138is off (which is the default behavior), the compiler will omit such warnings
2139if any differences found are confined to types which share the same size
2140and alignment.
2141
1f676100
NP
2142@item -Wundeclared-selector
2143@opindex Wundeclared-selector
2144Warn if a @code{@@selector(@dots{})} expression referring to an
2145undeclared selector is found. A selector is considered undeclared if no
daf2f129 2146method with that name has been declared before the
9eff22bc
LG
2147@code{@@selector(@dots{})} expression, either explicitly in an
2148@code{@@interface} or @code{@@protocol} declaration, or implicitly in
2149an @code{@@implementation} section. This option always performs its
2150checks as soon as a @code{@@selector(@dots{})} expression is found,
4ec7afd7 2151while @option{-Wselector} only performs its checks in the final stage of
9eff22bc 2152compilation. This also enforces the coding style convention
1f676100 2153that methods and selectors must be declared before being used.
60de6385 2154
7989e4dc 2155@item -print-objc-runtime-info
5ad7ae7f 2156@opindex print-objc-runtime-info
7989e4dc
RO
2157Generate C header describing the largest structure that is passed by
2158value, if any.
60de6385
SS
2159
2160@end table
2161
764dbbf2
GDR
2162@node Language Independent Options
2163@section Options to Control Diagnostic Messages Formatting
2164@cindex options to control diagnostics formatting
2165@cindex diagnostic messages
2166@cindex message formatting
2167
b192711e 2168Traditionally, diagnostic messages have been formatted irrespective of
e979f9e8 2169the output device's aspect (e.g.@: its width, @dots{}). The options described
764dbbf2 2170below can be used to control the diagnostic messages formatting
e979f9e8 2171algorithm, e.g.@: how many characters per line, how often source location
6c0a4eab 2172information should be reported. Right now, only the C++ front end can
764dbbf2 2173honor these options. However it is expected, in the near future, that
6c0a4eab 2174the remaining front ends would be able to digest them correctly.
764dbbf2 2175
2642624b 2176@table @gcctabopt
764dbbf2 2177@item -fmessage-length=@var{n}
cd3bb277 2178@opindex fmessage-length
764dbbf2 2179Try to format error messages so that they fit on lines of about @var{n}
aee96fe9 2180characters. The default is 72 characters for @command{g++} and 0 for the rest of
161d7b59 2181the front ends supported by GCC@. If @var{n} is zero, then no
02f52e19 2182line-wrapping will be done; each error message will appear on a single
764dbbf2
GDR
2183line.
2184
cd3bb277 2185@opindex fdiagnostics-show-location
764dbbf2 2186@item -fdiagnostics-show-location=once
b192711e 2187Only meaningful in line-wrapping mode. Instructs the diagnostic messages
764dbbf2
GDR
2188reporter to emit @emph{once} source location information; that is, in
2189case the message is too long to fit on a single physical line and has to
2190be wrapped, the source location won't be emitted (as prefix) again,
2191over and over, in subsequent continuation lines. This is the default
c21cd8b1 2192behavior.
764dbbf2
GDR
2193
2194@item -fdiagnostics-show-location=every-line
2195Only meaningful in line-wrapping mode. Instructs the diagnostic
2196messages reporter to emit the same source location information (as
4fe9b91c 2197prefix) for physical lines that result from the process of breaking
b192711e 2198a message which is too long to fit on a single line.
764dbbf2 2199
ccf08a6e
DD
2200@item -fdiagnostics-show-options
2201@opindex fdiagnostics-show-options
2202This option instructs the diagnostic machinery to add text to each
2203diagnostic emitted, which indicates which command line option directly
2204controls that diagnostic, when such an option is known to the
2205diagnostic machinery.
2206
764dbbf2
GDR
2207@end table
2208
74291a4b
MM
2209@node Warning Options
2210@section Options to Request or Suppress Warnings
2211@cindex options to control warnings
2212@cindex warning messages
2213@cindex messages, warning
2214@cindex suppressing warnings
2215
2216Warnings are diagnostic messages that report constructions which
2217are not inherently erroneous but which are risky or suggest there
2218may have been an error.
2219
2220You can request many specific warnings with options beginning @samp{-W},
630d3d5a 2221for example @option{-Wimplicit} to request warnings on implicit
74291a4b
MM
2222declarations. Each of these specific warning options also has a
2223negative form beginning @samp{-Wno-} to turn off warnings;
630d3d5a 2224for example, @option{-Wno-implicit}. This manual lists only one of the
74291a4b
MM
2225two forms, whichever is not the default.
2226
62aaa62c
GP
2227The following options control the amount and kinds of warnings produced
2228by GCC; for further, language-specific options also refer to
46e34f96
ZL
2229@ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2230Options}.
74291a4b 2231
2642624b 2232@table @gcctabopt
74291a4b
MM
2233@cindex syntax checking
2234@item -fsyntax-only
cd3bb277 2235@opindex fsyntax-only
74291a4b
MM
2236Check the code for syntax errors, but don't do anything beyond that.
2237
2238@item -pedantic
cd3bb277 2239@opindex pedantic
074e95e3
JM
2240Issue all the warnings demanded by strict ISO C and ISO C++;
2241reject all programs that use forbidden extensions, and some other
2242programs that do not follow ISO C and ISO C++. For ISO C, follows the
630d3d5a 2243version of the ISO C standard specified by any @option{-std} option used.
74291a4b 2244
074e95e3 2245Valid ISO C and ISO C++ programs should compile properly with or without
5490d604 2246this option (though a rare few will require @option{-ansi} or a
161d7b59 2247@option{-std} option specifying the required version of ISO C)@. However,
b1d16193
JL
2248without this option, certain GNU extensions and traditional C and C++
2249features are supported as well. With this option, they are rejected.
74291a4b 2250
630d3d5a 2251@option{-pedantic} does not cause warning messages for use of the
74291a4b
MM
2252alternate keywords whose names begin and end with @samp{__}. Pedantic
2253warnings are also disabled in the expression that follows
2254@code{__extension__}. However, only system header files should use
2255these escape routes; application programs should avoid them.
2256@xref{Alternate Keywords}.
2257
630d3d5a 2258Some users try to use @option{-pedantic} to check programs for strict ISO
74291a4b 2259C conformance. They soon find that it does not do quite what they want:
c1030c7c 2260it finds some non-ISO practices, but not all---only those for which
074e95e3
JM
2261ISO C @emph{requires} a diagnostic, and some others for which
2262diagnostics have been added.
74291a4b 2263
074e95e3 2264A feature to report any failure to conform to ISO C might be useful in
74291a4b 2265some instances, but would require considerable additional work and would
630d3d5a 2266be quite different from @option{-pedantic}. We don't have plans to
892d0a6d 2267support such a feature in the near future.
74291a4b 2268
91ea548a
JM
2269Where the standard specified with @option{-std} represents a GNU
2270extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2271corresponding @dfn{base standard}, the version of ISO C on which the GNU
2272extended dialect is based. Warnings from @option{-pedantic} are given
2273where they are required by the base standard. (It would not make sense
2274for such warnings to be given only for features not in the specified GNU
2275C dialect, since by definition the GNU dialects of C include all
2276features the compiler supports with the given option, and there would be
2277nothing to warn about.)
2278
74291a4b 2279@item -pedantic-errors
cd3bb277 2280@opindex pedantic-errors
630d3d5a 2281Like @option{-pedantic}, except that errors are produced rather than
74291a4b
MM
2282warnings.
2283
2284@item -w
cd3bb277 2285@opindex w
74291a4b
MM
2286Inhibit all warning messages.
2287
2288@item -Wno-import
cd3bb277 2289@opindex Wno-import
74291a4b
MM
2290Inhibit warning messages about the use of @samp{#import}.
2291
2292@item -Wchar-subscripts
cd3bb277 2293@opindex Wchar-subscripts
74291a4b
MM
2294Warn if an array subscript has type @code{char}. This is a common cause
2295of error, as programmers often forget that this type is signed on some
2296machines.
69cdf050 2297This warning is enabled by @option{-Wall}.
74291a4b
MM
2298
2299@item -Wcomment
cd3bb277 2300@opindex Wcomment
74291a4b
MM
2301Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2302comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
69cdf050 2303This warning is enabled by @option{-Wall}.
74291a4b 2304
c65a01af
RG
2305@item -Wfatal-errors
2306@opindex Wfatal-errors
2307This option causes the compiler to abort compilation on the first error
2308occurred rather than trying to keep going and printing further error
2309messages.
2310
74291a4b 2311@item -Wformat
cd3bb277 2312@opindex Wformat
e6e931b7
JM
2313@opindex ffreestanding
2314@opindex fno-builtin
74291a4b
MM
2315Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2316the arguments supplied have types appropriate to the format string
26f6672d
JM
2317specified, and that the conversions specified in the format string make
2318sense. This includes standard functions, and others specified by format
2319attributes (@pxref{Function Attributes}), in the @code{printf},
2320@code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
a2bec818 2321not in the C standard) families (or other target-specific families).
e6e931b7
JM
2322Which functions are checked without format attributes having been
2323specified depends on the standard version selected, and such checks of
2324functions without the attribute specified are disabled by
2325@option{-ffreestanding} or @option{-fno-builtin}.
74291a4b 2326
8308e0b7 2327The formats are checked against the format features supported by GNU
3764f879 2328libc version 2.2. These include all ISO C90 and C99 features, as well
8308e0b7
JM
2329as features from the Single Unix Specification and some BSD and GNU
2330extensions. Other library implementations may not support all these
2331features; GCC does not support warning about features that go beyond a
630d3d5a
JM
2332particular library's limitations. However, if @option{-pedantic} is used
2333with @option{-Wformat}, warnings will be given about format features not
26f6672d
JM
2334in the selected standard version (but not for @code{strfmon} formats,
2335since those are not in any version of the C standard). @xref{C Dialect
2336Options,,Options Controlling C Dialect}.
8308e0b7 2337
b34c7881
JT
2338Since @option{-Wformat} also checks for null format arguments for
2339several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2340
630d3d5a 2341@option{-Wformat} is included in @option{-Wall}. For more control over some
c76f4e8e 2342aspects of format checking, the options @option{-Wformat-y2k},
e964a556
JT
2343@option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2344@option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2345@option{-Wformat=2} are available, but are not included in @option{-Wall}.
4d808927 2346
c76f4e8e
JM
2347@item -Wformat-y2k
2348@opindex Wformat-y2k
2349If @option{-Wformat} is specified, also warn about @code{strftime}
4d808927
JM
2350formats which may yield only a two-digit year.
2351
2352@item -Wno-format-extra-args
cd3bb277 2353@opindex Wno-format-extra-args
630d3d5a 2354If @option{-Wformat} is specified, do not warn about excess arguments to a
4d808927
JM
2355@code{printf} or @code{scanf} format function. The C standard specifies
2356that such arguments are ignored.
2357
7e5fb12f
JM
2358Where the unused arguments lie between used arguments that are
2359specified with @samp{$} operand number specifications, normally
2360warnings are still given, since the implementation could not know what
2361type to pass to @code{va_arg} to skip the unused arguments. However,
2362in the case of @code{scanf} formats, this option will suppress the
2363warning if the unused arguments are all pointers, since the Single
2364Unix Specification says that such unused arguments are allowed.
2365
e964a556
JT
2366@item -Wno-format-zero-length
2367@opindex Wno-format-zero-length
2368If @option{-Wformat} is specified, do not warn about zero-length formats.
2369The C standard specifies that zero-length formats are allowed.
2370
4d808927 2371@item -Wformat-nonliteral
cd3bb277 2372@opindex Wformat-nonliteral
630d3d5a 2373If @option{-Wformat} is specified, also warn if the format string is not a
4d808927
JM
2374string literal and so cannot be checked, unless the format function
2375takes its format arguments as a @code{va_list}.
2376
c907e684 2377@item -Wformat-security
cd3bb277 2378@opindex Wformat-security
630d3d5a 2379If @option{-Wformat} is specified, also warn about uses of format
c907e684
JM
2380functions that represent possible security problems. At present, this
2381warns about calls to @code{printf} and @code{scanf} functions where the
2382format string is not a string literal and there are no format arguments,
2383as in @code{printf (foo);}. This may be a security hole if the format
2384string came from untrusted input and contains @samp{%n}. (This is
630d3d5a
JM
2385currently a subset of what @option{-Wformat-nonliteral} warns about, but
2386in future warnings may be added to @option{-Wformat-security} that are not
2387included in @option{-Wformat-nonliteral}.)
c907e684 2388
4d808927 2389@item -Wformat=2
cd3bb277 2390@opindex Wformat=2
630d3d5a
JM
2391Enable @option{-Wformat} plus format checks not included in
2392@option{-Wformat}. Currently equivalent to @samp{-Wformat
c76f4e8e 2393-Wformat-nonliteral -Wformat-security -Wformat-y2k}.
4d808927 2394
b34c7881
JT
2395@item -Wnonnull
2396@opindex Wnonnull
f6d9224f 2397Warn about passing a null pointer for arguments marked as
b34c7881
JT
2398requiring a non-null value by the @code{nonnull} function attribute.
2399
2400@option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2401can be disabled with the @option{-Wno-nonnull} option.
2402
46e34f96 2403@item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3390f9c9 2404@opindex Winit-self
f6d9224f
GP
2405Warn about uninitialized variables which are initialized with themselves.
2406Note this option can only be used with the @option{-Wuninitialized} option,
2407which in turn only works with @option{-O1} and above.
3390f9c9 2408
f6d9224f
GP
2409For example, GCC will warn about @code{i} being uninitialized in the
2410following snippet only when @option{-Winit-self} has been specified:
3390f9c9
AP
2411@smallexample
2412@group
2413int f()
2414@{
2415 int i = i;
2416 return i;
2417@}
2418@end group
2419@end smallexample
2420
e9a25f70 2421@item -Wimplicit-int
cd3bb277 2422@opindex Wimplicit-int
e9a25f70 2423Warn when a declaration does not specify a type.
69cdf050 2424This warning is enabled by @option{-Wall}.
e9a25f70 2425
f5963e61
JL
2426@item -Wimplicit-function-declaration
2427@itemx -Werror-implicit-function-declaration
cd3bb277
JM
2428@opindex Wimplicit-function-declaration
2429@opindex Werror-implicit-function-declaration
f5963e61 2430Give a warning (or error) whenever a function is used before being
b99cfc22
JM
2431declared. The form @option{-Wno-error-implicit-function-declaration}
2432is not supported.
69cdf050 2433This warning is enabled by @option{-Wall} (as a warning, not an error).
e9a25f70 2434
74291a4b 2435@item -Wimplicit
cd3bb277 2436@opindex Wimplicit
630d3d5a 2437Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
69cdf050 2438This warning is enabled by @option{-Wall}.
861bb6c1
JL
2439
2440@item -Wmain
cd3bb277 2441@opindex Wmain
861bb6c1
JL
2442Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2443function with external linkage, returning int, taking either zero
2444arguments, two, or three arguments of appropriate types.
69cdf050 2445This warning is enabled by @option{-Wall}.
4a870dba 2446
1f0c3120 2447@item -Wmissing-braces
cd3bb277 2448@opindex Wmissing-braces
1f0c3120
JM
2449Warn if an aggregate or union initializer is not fully bracketed. In
2450the following example, the initializer for @samp{a} is not fully
2451bracketed, but that for @samp{b} is fully bracketed.
2452
2453@smallexample
2454int a[2][2] = @{ 0, 1, 2, 3 @};
2455int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2456@end smallexample
2457
69cdf050
JM
2458This warning is enabled by @option{-Wall}.
2459
46e34f96 2460@item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
b02398bd
BE
2461@opindex Wmissing-include-dirs
2462Warn if a user-supplied include directory does not exist.
2463
74291a4b 2464@item -Wparentheses
cd3bb277 2465@opindex Wparentheses
74291a4b
MM
2466Warn if parentheses are omitted in certain contexts, such
2467as when there is an assignment in a context where a truth value
2468is expected, or when operators are nested whose precedence people
3e3970a2
JM
2469often get confused about. Only the warning for an assignment used as
2470a truth value is supported when compiling C++; the other warnings are
2471only supported when compiling C@.
2472
2473Also warn if a comparison like @samp{x<=y<=z} appears; this is
2474equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2475interpretation from that of ordinary mathematical notation.
74291a4b 2476
e9a25f70
JL
2477Also warn about constructions where there may be confusion to which
2478@code{if} statement an @code{else} branch belongs. Here is an example of
2479such a case:
2480
2481@smallexample
aee96fe9 2482@group
e9a25f70
JL
2483@{
2484 if (a)
2485 if (b)
2486 foo ();
2487 else
2488 bar ();
2489@}
aee96fe9 2490@end group
e9a25f70
JL
2491@end smallexample
2492
2493In C, every @code{else} branch belongs to the innermost possible @code{if}
2494statement, which in this example is @code{if (b)}. This is often not
2495what the programmer expected, as illustrated in the above example by
2496indentation the programmer chose. When there is the potential for this
f0523f02 2497confusion, GCC will issue a warning when this flag is specified.
e9a25f70
JL
2498To eliminate the warning, add explicit braces around the innermost
2499@code{if} statement so there is no way the @code{else} could belong to
2500the enclosing @code{if}. The resulting code would look like this:
2501
2502@smallexample
aee96fe9 2503@group
e9a25f70
JL
2504@{
2505 if (a)
2506 @{
2507 if (b)
2508 foo ();
2509 else
2510 bar ();
2511 @}
2512@}
aee96fe9 2513@end group
e9a25f70
JL
2514@end smallexample
2515
69cdf050
JM
2516This warning is enabled by @option{-Wall}.
2517
bb58bec5 2518@item -Wsequence-point
cd3bb277 2519@opindex Wsequence-point
bb58bec5 2520Warn about code that may have undefined semantics because of violations
7127d9c7
DM
2521of sequence point rules in the C and C++ standards.
2522
2523The C and C++ standards defines the order in which expressions in a C/C++
2524program are evaluated in terms of @dfn{sequence points}, which represent
2525a partial ordering between the execution of parts of the program: those
2526executed before the sequence point, and those executed after it. These
2527occur after the evaluation of a full expression (one which is not part
2528of a larger expression), after the evaluation of the first operand of a
bb58bec5
JM
2529@code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2530function is called (but after the evaluation of its arguments and the
2531expression denoting the called function), and in certain other places.
2532Other than as expressed by the sequence point rules, the order of
2533evaluation of subexpressions of an expression is not specified. All
2534these rules describe only a partial order rather than a total order,
2535since, for example, if two functions are called within one expression
2536with no sequence point between them, the order in which the functions
2537are called is not specified. However, the standards committee have
2538ruled that function calls do not overlap.
2539
2540It is not specified when between sequence points modifications to the
2541values of objects take effect. Programs whose behavior depends on this
7127d9c7
DM
2542have undefined behavior; the C and C++ standards specify that ``Between
2543the previous and next sequence point an object shall have its stored
2544value modified at most once by the evaluation of an expression.
2545Furthermore, the prior value shall be read only to determine the value
2546to be stored.''. If a program breaks these rules, the results on any
bb58bec5
JM
2547particular implementation are entirely unpredictable.
2548
2549Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2550= b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2551diagnosed by this option, and it may give an occasional false positive
2552result, but in general it has been found fairly effective at detecting
2553this sort of problem in programs.
2554
7127d9c7 2555The standard is worded confusingly, therefore there is some debate
9c34dbbf
ZW
2556over the precise meaning of the sequence point rules in subtle cases.
2557Links to discussions of the problem, including proposed formal
962e6e00 2558definitions, may be found on the GCC readings page, at
c5122d75 2559@w{@uref{http://gcc.gnu.org/readings.html}}.
bb58bec5 2560
7127d9c7 2561This warning is enabled by @option{-Wall} for C and C++.
69cdf050 2562
74291a4b 2563@item -Wreturn-type
cd3bb277 2564@opindex Wreturn-type
32c4c36c
ML
2565Warn whenever a function is defined with a return-type that defaults to
2566@code{int}. Also warn about any @code{return} statement with no
02f52e19 2567return-value in a function whose return-type is not @code{void}.
32c4c36c 2568
e508a019
JM
2569For C, also warn if the return type of a function has a type qualifier
2570such as @code{const}. Such a type qualifier has no effect, since the
2571value returned by a function is not an lvalue. ISO C prohibits
2572qualified @code{void} return types on function definitions, so such
2573return types always receive a warning even without this option.
2574
32c4c36c 2575For C++, a function without return type always produces a diagnostic
767094dd 2576message, even when @option{-Wno-return-type} is specified. The only
32c4c36c 2577exceptions are @samp{main} and functions defined in system headers.
74291a4b 2578
69cdf050
JM
2579This warning is enabled by @option{-Wall}.
2580
74291a4b 2581@item -Wswitch
cd3bb277 2582@opindex Wswitch
2eac577f 2583Warn whenever a @code{switch} statement has an index of enumerated type
74291a4b
MM
2584and lacks a @code{case} for one or more of the named codes of that
2585enumeration. (The presence of a @code{default} label prevents this
2586warning.) @code{case} labels outside the enumeration range also
2587provoke warnings when this option is used.
69cdf050 2588This warning is enabled by @option{-Wall}.
74291a4b 2589
d6961341
AC
2590@item -Wswitch-default
2591@opindex Wswitch-switch
2592Warn whenever a @code{switch} statement does not have a @code{default}
2593case.
2594
173028e5
AC
2595@item -Wswitch-enum
2596@opindex Wswitch-enum
2eac577f 2597Warn whenever a @code{switch} statement has an index of enumerated type
173028e5
AC
2598and lacks a @code{case} for one or more of the named codes of that
2599enumeration. @code{case} labels outside the enumeration range also
2600provoke warnings when this option is used.
2601
74291a4b 2602@item -Wtrigraphs
cd3bb277 2603@opindex Wtrigraphs
f2ecb02d
JM
2604Warn if any trigraphs are encountered that might change the meaning of
2605the program (trigraphs within comments are not warned about).
69cdf050 2606This warning is enabled by @option{-Wall}.
74291a4b 2607
078721e1 2608@item -Wunused-function
cd3bb277 2609@opindex Wunused-function
078721e1 2610Warn whenever a static function is declared but not defined or a
aa58883c 2611non-inline static function is unused.
69cdf050 2612This warning is enabled by @option{-Wall}.
74291a4b 2613
078721e1 2614@item -Wunused-label
cd3bb277 2615@opindex Wunused-label
078721e1 2616Warn whenever a label is declared but not used.
69cdf050 2617This warning is enabled by @option{-Wall}.
078721e1
AC
2618
2619To suppress this warning use the @samp{unused} attribute
2620(@pxref{Variable Attributes}).
2621
2622@item -Wunused-parameter
cd3bb277 2623@opindex Wunused-parameter
078721e1
AC
2624Warn whenever a function parameter is unused aside from its declaration.
2625
2626To suppress this warning use the @samp{unused} attribute
2627(@pxref{Variable Attributes}).
956d6950 2628
078721e1 2629@item -Wunused-variable
cd3bb277 2630@opindex Wunused-variable
078721e1
AC
2631Warn whenever a local variable or non-constant static variable is unused
2632aside from its declaration
69cdf050 2633This warning is enabled by @option{-Wall}.
078721e1
AC
2634
2635To suppress this warning use the @samp{unused} attribute
74291a4b
MM
2636(@pxref{Variable Attributes}).
2637
078721e1 2638@item -Wunused-value
cd3bb277 2639@opindex Wunused-value
078721e1 2640Warn whenever a statement computes a result that is explicitly not used.
69cdf050 2641This warning is enabled by @option{-Wall}.
078721e1
AC
2642
2643To suppress this warning cast the expression to @samp{void}.
2644
2645@item -Wunused
cd3bb277 2646@opindex Wunused
d3075b6c 2647All the above @option{-Wunused} options combined.
078721e1
AC
2648
2649In order to get a warning about an unused function parameter, you must
65ca2d60
PE
2650either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2651@samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
078721e1 2652
74291a4b 2653@item -Wuninitialized
cd3bb277 2654@opindex Wuninitialized
c5c76735
JL
2655Warn if an automatic variable is used without first being initialized or
2656if a variable may be clobbered by a @code{setjmp} call.
74291a4b
MM
2657
2658These warnings are possible only in optimizing compilation,
2659because they require data flow information that is computed only
630d3d5a 2660when optimizing. If you don't specify @option{-O}, you simply won't
74291a4b
MM
2661get these warnings.
2662
3390f9c9
AP
2663If you want to warn about code which uses the uninitialized value of the
2664variable in its own initializer, use the @option{-Winit-self} option.
2665
8ceac9f8
JM
2666These warnings occur for individual uninitialized or clobbered
2667elements of structure, union or array variables as well as for
2668variables which are uninitialized or clobbered as a whole. They do
2669not occur for variables or elements declared @code{volatile}. Because
2670these warnings depend on optimization, the exact variables or elements
2671for which there are warnings will depend on the precise optimization
2672options and version of GCC used.
74291a4b
MM
2673
2674Note that there may be no warning about a variable that is used only
2675to compute a value that itself is never used, because such
2676computations may be deleted by data flow analysis before the warnings
2677are printed.
2678
0c2d1a2a 2679These warnings are made optional because GCC is not smart
74291a4b
MM
2680enough to see all the reasons why the code might be correct
2681despite appearing to have an error. Here is one example of how
2682this can happen:
2683
2684@smallexample
aee96fe9 2685@group
74291a4b
MM
2686@{
2687 int x;
2688 switch (y)
2689 @{
2690 case 1: x = 1;
2691 break;
2692 case 2: x = 4;
2693 break;
2694 case 3: x = 5;
2695 @}
2696 foo (x);
2697@}
aee96fe9 2698@end group
74291a4b
MM
2699@end smallexample
2700
2701@noindent
2702If the value of @code{y} is always 1, 2 or 3, then @code{x} is
0c2d1a2a 2703always initialized, but GCC doesn't know this. Here is
74291a4b
MM
2704another common case:
2705
2706@smallexample
2707@{
2708 int save_y;
2709 if (change_y) save_y = y, y = new_y;
2710 @dots{}
2711 if (change_y) y = save_y;
2712@}
2713@end smallexample
2714
2715@noindent
2716This has no bug because @code{save_y} is used only if it is set.
2717
20300b05 2718@cindex @code{longjmp} warnings
b192711e 2719This option also warns when a non-volatile automatic variable might be
c5c76735
JL
2720changed by a call to @code{longjmp}. These warnings as well are possible
2721only in optimizing compilation.
20300b05
GK
2722
2723The compiler sees only the calls to @code{setjmp}. It cannot know
2724where @code{longjmp} will be called; in fact, a signal handler could
2725call it at any point in the code. As a result, you may get a warning
2726even when there is in fact no problem because @code{longjmp} cannot
2727in fact be called at the place which would cause a problem.
2728
74291a4b
MM
2729Some spurious warnings can be avoided if you declare all the functions
2730you use that never return as @code{noreturn}. @xref{Function
2731Attributes}.
2732
69cdf050
JM
2733This warning is enabled by @option{-Wall}.
2734
d300e551 2735@item -Wunknown-pragmas
cd3bb277 2736@opindex Wunknown-pragmas
d300e551
NC
2737@cindex warning for unknown pragmas
2738@cindex unknown pragmas, warning
2739@cindex pragmas, warning of unknown
2740Warn when a #pragma directive is encountered which is not understood by
161d7b59 2741GCC@. If this command line option is used, warnings will even be issued
d300e551 2742for unknown pragmas in system header files. This is not the case if
630d3d5a 2743the warnings were only enabled by the @option{-Wall} command line option.
d300e551 2744
b9b8dde3
DD
2745@item -Wno-pragmas
2746@opindex Wno-pragmas
2747@opindex Wpragmas
2748Do not warn about misuses of pragmas, such as incorrect parameters,
2749invalid syntax, or conflicts between pragmas. See also
2750@samp{-Wunknown-pragmas}.
2751
bf52f899
NS
2752@item -Wstrict-aliasing
2753@opindex Wstrict-aliasing
2754This option is only active when @option{-fstrict-aliasing} is active.
2755It warns about code which might break the strict aliasing rules that the
8a36672b
JM
2756compiler is using for optimization. The warning does not catch all
2757cases, but does attempt to catch the more common pitfalls. It is
bf52f899
NS
2758included in @option{-Wall}.
2759
5399d643
JW
2760@item -Wstrict-aliasing=2
2761@opindex Wstrict-aliasing=2
2762This option is only active when @option{-fstrict-aliasing} is active.
66f33c03
JW
2763It warns about code which might break the strict aliasing rules that the
2764compiler is using for optimization. This warning catches more cases than
2765@option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2766cases that are safe.
5399d643 2767
74291a4b 2768@item -Wall
cd3bb277 2769@opindex Wall
74291a4b
MM
2770All of the above @samp{-W} options combined. This enables all the
2771warnings about constructions that some users consider questionable, and
2772that are easy to avoid (or modify to prevent the warning), even in
bd8f9aec
SP
2773conjunction with macros. This also enables some language-specific
2774warnings described in @ref{C++ Dialect Options} and
46e34f96 2775@ref{Objective-C and Objective-C++ Dialect Options}.
74291a4b
MM
2776@end table
2777
630d3d5a 2778The following @option{-W@dots{}} options are not implied by @option{-Wall}.
74291a4b
MM
2779Some of them warn about constructions that users generally do not
2780consider questionable, but which occasionally you might wish to check
2781for; others warn about constructions that are necessary or hard to avoid
2782in some cases, and there is no simple way to modify the code to suppress
2783the warning.
2784
2642624b 2785@table @gcctabopt
65ca2d60 2786@item -Wextra
cd3bb277 2787@opindex W
65ca2d60
PE
2788@opindex Wextra
2789(This option used to be called @option{-W}. The older name is still
2790supported, but the newer name is more descriptive.) Print extra warning
2791messages for these events:
74291a4b
MM
2792
2793@itemize @bullet
74291a4b
MM
2794@item
2795A function can return either with or without a value. (Falling
2796off the end of the function body is considered returning without
2797a value.) For example, this function would evoke such a
2798warning:
2799
2800@smallexample
2801@group
2802foo (a)
2803@{
2804 if (a > 0)
2805 return a;
2806@}
2807@end group
2808@end smallexample
2809
2810@item
2811An expression-statement or the left-hand side of a comma expression
2812contains no side effects.
2813To suppress the warning, cast the unused expression to void.
2814For example, an expression such as @samp{x[i,j]} will cause a warning,
2815but @samp{x[(void)i,j]} will not.
2816
2817@item
65ca2d60 2818An unsigned value is compared against zero with @samp{<} or @samp{>=}.
74291a4b 2819
74291a4b
MM
2820@item
2821Storage-class specifiers like @code{static} are not the first things in
2822a declaration. According to the C Standard, this usage is obsolescent.
2823
2824@item
630d3d5a 2825If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
74291a4b
MM
2826arguments.
2827
e9a25f70
JL
2828@item
2829A comparison between signed and unsigned values could produce an
2830incorrect result when the signed value is converted to unsigned.
630d3d5a 2831(But don't warn if @option{-Wno-sign-compare} is also specified.)
e9a25f70 2832
dbde0d5d
BH
2833@item
2834An aggregate has an initializer which does not initialize all members.
eaac4679
RS
2835This warning can be independently controlled by
2836@option{-Wmissing-field-initializers}.
65ca2d60
PE
2837
2838@item
2839A function parameter is declared without a type specifier in K&R-style
2840functions:
2841
2842@smallexample
2843void foo(bar) @{ @}
2844@end smallexample
2845
2846@item
2847An empty body occurs in an @samp{if} or @samp{else} statement.
2848
2849@item
2850A pointer is compared against integer zero with @samp{<}, @samp{<=},
2851@samp{>}, or @samp{>=}.
2852
2853@item
2854A variable might be changed by @samp{longjmp} or @samp{vfork}.
2855
2856@item
2857Any of several floating-point events that often indicate errors, such as
2858overflow, underflow, loss of precision, etc.
2859
2860@item @r{(C++ only)}
2861An enumerator and a non-enumerator both appear in a conditional expression.
2862
2863@item @r{(C++ only)}
2864A non-static reference or non-static @samp{const} member appears in a
2865class without constructors.
2866
2867@item @r{(C++ only)}
2868Ambiguous virtual bases.
2869
2870@item @r{(C++ only)}
2871Subscripting an array which has been declared @samp{register}.
2872
2873@item @r{(C++ only)}
2874Taking the address of a variable which has been declared @samp{register}.
2875
2876@item @r{(C++ only)}
62b9c42c 2877A base class is not initialized in a derived class' copy constructor.
74291a4b
MM
2878@end itemize
2879
75227a33
GK
2880@item -Wno-div-by-zero
2881@opindex Wno-div-by-zero
2882@opindex Wdiv-by-zero
2883Do not warn about compile-time integer division by zero. Floating point
2884division by zero is not warned about, as it can be a legitimate way of
2885obtaining infinities and NaNs.
2886
2887@item -Wsystem-headers
2888@opindex Wsystem-headers
2889@cindex warnings from system headers
2890@cindex system headers, warnings from
2891Print warning messages for constructs found in system header files.
2892Warnings from system headers are normally suppressed, on the assumption
2893that they usually do not indicate real problems and would only make the
2894compiler output harder to read. Using this command line option tells
2895GCC to emit warnings from system headers as if they occurred in user
2896code. However, note that using @option{-Wall} in conjunction with this
2897option will @emph{not} warn about unknown pragmas in system
2898headers---for that, @option{-Wunknown-pragmas} must also be used.
2899
f793a95e 2900@item -Wfloat-equal
cd3bb277 2901@opindex Wfloat-equal
f793a95e
JL
2902Warn if floating point values are used in equality comparisons.
2903
488d3985
GK
2904The idea behind this is that sometimes it is convenient (for the
2905programmer) to consider floating-point values as approximations to
2906infinitely precise real numbers. If you are doing this, then you need
c0478a66 2907to compute (by analyzing the code, or in some other way) the maximum or
488d3985
GK
2908likely maximum error that the computation introduces, and allow for it
2909when performing comparisons (and when producing output, but that's a
2910different problem). In particular, instead of testing for equality, you
2911would check to see whether the two values have ranges that overlap; and
2912this is done with the relational operators, so equality comparisons are
2913probably mistaken.
2914
aee96fe9 2915@item -Wtraditional @r{(C only)}
cd3bb277 2916@opindex Wtraditional
74291a4b 2917Warn about certain constructs that behave differently in traditional and
161d7b59 2918ISO C@. Also warn about ISO C constructs that have no traditional C
c8abc684 2919equivalent, and/or problematic constructs which should be avoided.
74291a4b
MM
2920
2921@itemize @bullet
2922@item
da312b55
NB
2923Macro parameters that appear within string literals in the macro body.
2924In traditional C macro replacement takes place within string literals,
161d7b59 2925but does not in ISO C@.
da312b55
NB
2926
2927@item
2928In traditional C, some preprocessor directives did not exist.
2929Traditional preprocessors would only consider a line to be a directive
2930if the @samp{#} appeared in column 1 on the line. Therefore
630d3d5a 2931@option{-Wtraditional} warns about directives that traditional C
da312b55
NB
2932understands but would ignore because the @samp{#} does not appear as the
2933first character on the line. It also suggests you hide directives like
2934@samp{#pragma} not understood by traditional C by indenting them. Some
c21cd8b1 2935traditional implementations would not recognize @samp{#elif}, so it
da312b55
NB
2936suggests avoiding it altogether.
2937
2938@item
2939A function-like macro that appears without arguments.
2940
2941@item
2942The unary plus operator.
2943
2944@item
c771326b
JM
2945The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2946constant suffixes. (Traditional C does support the @samp{L} suffix on integer
da312b55 2947constants.) Note, these suffixes appear in macros defined in the system
e979f9e8 2948headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
c8abc684 2949Use of these macros in user code might normally lead to spurious
2dd76960 2950warnings, however GCC's integrated preprocessor has enough context to
c8abc684 2951avoid warning in these cases.
74291a4b
MM
2952
2953@item
2954A function declared external in one block and then used after the end of
2955the block.
2956
2957@item
2958A @code{switch} statement has an operand of type @code{long}.
db838bb8
KG
2959
2960@item
2961A non-@code{static} function declaration follows a @code{static} one.
2962This construct is not accepted by some traditional C compilers.
48776cde
KG
2963
2964@item
c1030c7c 2965The ISO type of an integer constant has a different width or
48776cde 2966signedness from its traditional type. This warning is only issued if
e979f9e8 2967the base of the constant is ten. I.e.@: hexadecimal or octal values, which
48776cde 2968typically represent bit patterns, are not warned about.
bb66adca
KG
2969
2970@item
c1030c7c 2971Usage of ISO string concatenation is detected.
7f094a94 2972
895ea614
KG
2973@item
2974Initialization of automatic aggregates.
2975
2976@item
2977Identifier conflicts with labels. Traditional C lacks a separate
2978namespace for labels.
253b6b82
KG
2979
2980@item
2981Initialization of unions. If the initializer is zero, the warning is
2982omitted. This is done under the assumption that the zero initializer in
e979f9e8 2983user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
253b6b82
KG
2984initializer warnings and relies on default initialization to zero in the
2985traditional C case.
03829ad2
KG
2986
2987@item
3ed56f8a
KG
2988Conversions by prototypes between fixed/floating point values and vice
2989versa. The absence of these prototypes when compiling with traditional
2990C would cause serious problems. This is a subset of the possible
630d3d5a 2991conversion warnings, for the full set use @option{-Wconversion}.
622d3731
KG
2992
2993@item
2994Use of ISO C style function definitions. This warning intentionally is
2995@emph{not} issued for prototype declarations or variadic functions
2996because these ISO C features will appear in your code when using
2997libiberty's traditional C compatibility macros, @code{PARAMS} and
2998@code{VPARAMS}. This warning is also bypassed for nested functions
2dd76960 2999because that feature is already a GCC extension and thus not relevant to
622d3731 3000traditional C compatibility.
74291a4b
MM
3001@end itemize
3002
85617eba
HPN
3003@item -Wdeclaration-after-statement @r{(C only)}
3004@opindex Wdeclaration-after-statement
3005Warn when a declaration is found after a statement in a block. This
3006construct, known from C++, was introduced with ISO C99 and is by default
3007allowed in GCC@. It is not supported by ISO C90 and was not supported by
3008GCC versions before GCC 3.0. @xref{Mixed Declarations}.
3009
861bb6c1 3010@item -Wundef
cd3bb277 3011@opindex Wundef
861bb6c1
JL
3012Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3013
90689ae1
JM
3014@item -Wno-endif-labels
3015@opindex Wno-endif-labels
909de5da 3016@opindex Wendif-labels
90689ae1 3017Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
909de5da 3018
74291a4b 3019@item -Wshadow
cd3bb277 3020@opindex Wshadow
d773df5a
DB
3021Warn whenever a local variable shadows another local variable, parameter or
3022global variable or whenever a built-in function is shadowed.
74291a4b 3023
74291a4b 3024@item -Wlarger-than-@var{len}
cd3bb277 3025@opindex Wlarger-than
74291a4b
MM
3026Warn whenever an object of larger than @var{len} bytes is defined.
3027
f9cc1a70
PB
3028@item -Wunsafe-loop-optimizations
3029@opindex Wunsafe-loop-optimizations
3030Warn if the loop cannot be optimized because the compiler could not
3031assume anything on the bounds of the loop indices. With
3032@option{-funsafe-loop-optimizations} warn if the compiler made
3033such assumptions.
3034
74291a4b 3035@item -Wpointer-arith
cd3bb277 3036@opindex Wpointer-arith
74291a4b
MM
3037Warn about anything that depends on the ``size of'' a function type or
3038of @code{void}. GNU C assigns these types a size of 1, for
3039convenience in calculations with @code{void *} pointers and pointers
3040to functions.
3041
aee96fe9 3042@item -Wbad-function-cast @r{(C only)}
cd3bb277 3043@opindex Wbad-function-cast
74291a4b
MM
3044Warn whenever a function call is cast to a non-matching type.
3045For example, warn if @code{int malloc()} is cast to @code{anything *}.
3046
b7e20b53
GDR
3047@item -Wc++-compat
3048Warn about ISO C constructs that are outside of the common subset of
3049ISO C and ISO C++, e.g.@: request for implicit conversion from
3050@code{void *} to a pointer to non-@code{void} type.
3051
74291a4b 3052@item -Wcast-qual
cd3bb277 3053@opindex Wcast-qual
74291a4b
MM
3054Warn whenever a pointer is cast so as to remove a type qualifier from
3055the target type. For example, warn if a @code{const char *} is cast
3056to an ordinary @code{char *}.
3057
3058@item -Wcast-align
cd3bb277 3059@opindex Wcast-align
74291a4b
MM
3060Warn whenever a pointer is cast such that the required alignment of the
3061target is increased. For example, warn if a @code{char *} is cast to
3062an @code{int *} on machines where integers can only be accessed at
3063two- or four-byte boundaries.
3064
3065@item -Wwrite-strings
cd3bb277 3066@opindex Wwrite-strings
aee96fe9
JM
3067When compiling C, give string constants the type @code{const
3068char[@var{length}]} so that
74291a4b 3069copying the address of one into a non-@code{const} @code{char *}
aee96fe9 3070pointer will get a warning; when compiling C++, warn about the
d539b114
GDR
3071deprecated conversion from string literals to @code{char *}. This
3072warning, by default, is enabled for C++ programs.
aee96fe9 3073These warnings will help you find at
74291a4b
MM
3074compile time code that can try to write into a string constant, but
3075only if you have been very careful about using @code{const} in
3076declarations and prototypes. Otherwise, it will just be a nuisance;
630d3d5a 3077this is why we did not make @option{-Wall} request these warnings.
74291a4b
MM
3078
3079@item -Wconversion
cd3bb277 3080@opindex Wconversion
74291a4b
MM
3081Warn if a prototype causes a type conversion that is different from what
3082would happen to the same argument in the absence of a prototype. This
3083includes conversions of fixed point to floating and vice versa, and
3084conversions changing the width or signedness of a fixed point argument
3085except when the same as the default promotion.
3086
3087Also, warn if a negative integer constant expression is implicitly
3088converted to an unsigned type. For example, warn about the assignment
3089@code{x = -1} if @code{x} is unsigned. But do not warn about explicit
3090casts like @code{(unsigned) -1}.
3091
e9a25f70 3092@item -Wsign-compare
cd3bb277 3093@opindex Wsign-compare
e9a25f70
JL
3094@cindex warning for comparison of signed and unsigned values
3095@cindex comparison of signed and unsigned values, warning
3096@cindex signed and unsigned values, comparison warning
3097Warn when a comparison between signed and unsigned values could produce
3098an incorrect result when the signed value is converted to unsigned.
65ca2d60
PE
3099This warning is also enabled by @option{-Wextra}; to get the other warnings
3100of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
e9a25f70 3101
74291a4b 3102@item -Waggregate-return
cd3bb277 3103@opindex Waggregate-return
74291a4b
MM
3104Warn if any functions that return structures or unions are defined or
3105called. (In languages where you can return an array, this also elicits
3106a warning.)
3107
690a704a
BE
3108@item -Walways-true
3109@opindex Walways-true
03237161
BE
3110Warn about comparisons which are always true such as testing if
3111unsigned values are greater than or equal to zero. This warning is
3112enabled by @option{-Wall}.
690a704a 3113
5c498b10
DD
3114@item -Wno-attributes
3115@opindex Wno-attributes
3116@opindex Wattributes
3117Do not warn if an unexpected @code{__attribute__} is used, such as
3118unrecognized attributes, function attributes applied to variables,
3119etc. This will not stop errors for incorrect use of supported
3120attributes.
3121
aee96fe9 3122@item -Wstrict-prototypes @r{(C only)}
cd3bb277 3123@opindex Wstrict-prototypes
74291a4b
MM
3124Warn if a function is declared or defined without specifying the
3125argument types. (An old-style function definition is permitted without
3126a warning if preceded by a declaration which specifies the argument
3127types.)
3128
c034f121
AJ
3129@item -Wold-style-definition @r{(C only)}
3130@opindex Wold-style-definition
3131Warn if an old-style function definition is used. A warning is given
3132even if there is a previous prototype.
3133
aee96fe9 3134@item -Wmissing-prototypes @r{(C only)}
cd3bb277 3135@opindex Wmissing-prototypes
74291a4b
MM
3136Warn if a global function is defined without a previous prototype
3137declaration. This warning is issued even if the definition itself
3138provides a prototype. The aim is to detect global functions that fail
3139to be declared in header files.
3140
da635858 3141@item -Wmissing-declarations @r{(C only)}
cd3bb277 3142@opindex Wmissing-declarations
74291a4b
MM
3143Warn if a global function is defined without a previous declaration.
3144Do so even if the definition itself provides a prototype.
3145Use this option to detect global functions that are not declared in
3146header files.
3147
eaac4679
RS
3148@item -Wmissing-field-initializers
3149@opindex Wmissing-field-initializers
3150@opindex W
3151@opindex Wextra
3152Warn if a structure's initializer has some fields missing. For
3153example, the following code would cause such a warning, because
3154@code{x.h} is implicitly zero:
3155
3156@smallexample
3157struct s @{ int f, g, h; @};
3158struct s x = @{ 3, 4 @};
3159@end smallexample
3160
3161This option does not warn about designated initializers, so the following
3162modification would not trigger a warning:
3163
3164@smallexample
3165struct s @{ int f, g, h; @};
3166struct s x = @{ .f = 3, .g = 4 @};
3167@end smallexample
3168
3169This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3170warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3171
0ca3fb0a 3172@item -Wmissing-noreturn
cd3bb277 3173@opindex Wmissing-noreturn
0ca3fb0a
KG
3174Warn about functions which might be candidates for attribute @code{noreturn}.
3175Note these are only possible candidates, not absolute ones. Care should
3176be taken to manually verify functions actually do not ever return before
3177adding the @code{noreturn} attribute, otherwise subtle code generation
21c7361e
AJ
3178bugs could be introduced. You will not get a warning for @code{main} in
3179hosted C environments.
0ca3fb0a 3180
74ff4629 3181@item -Wmissing-format-attribute
cd3bb277
JM
3182@opindex Wmissing-format-attribute
3183@opindex Wformat
7876a414
KG
3184Warn about function pointers which might be candidates for @code{format}
3185attributes. Note these are only possible candidates, not absolute ones.
3186GCC will guess that function pointers with @code{format} attributes that
3187are used in assignment, initialization, parameter passing or return
3188statements should have a corresponding @code{format} attribute in the
3189resulting type. I.e.@: the left-hand side of the assignment or
3190initialization, the type of the parameter variable, or the return type
3191of the containing function respectively should also have a @code{format}
3192attribute to avoid the warning.
3193
3194GCC will also warn about function definitions which might be
3195candidates for @code{format} attributes. Again, these are only
3196possible candidates. GCC will guess that @code{format} attributes
3197might be appropriate for any function that calls a function like
3198@code{vprintf} or @code{vscanf}, but this might not always be the
74ff4629 3199case, and some functions for which @code{format} attributes are
7876a414 3200appropriate may not be detected.
74ff4629 3201
75227a33
GK
3202@item -Wno-multichar
3203@opindex Wno-multichar
3204@opindex Wmultichar
3205Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3206Usually they indicate a typo in the user's code, as they have
3207implementation-defined values, and should not be used in portable code.
3208
50668cf6
GK
3209@item -Wnormalized=<none|id|nfc|nfkc>
3210@opindex Wnormalized
3211@cindex NFC
3212@cindex NFKC
3213@cindex character set, input normalization
3214In ISO C and ISO C++, two identifiers are different if they are
3215different sequences of characters. However, sometimes when characters
3216outside the basic ASCII character set are used, you can have two
3217different character sequences that look the same. To avoid confusion,
3218the ISO 10646 standard sets out some @dfn{normalization rules} which
3219when applied ensure that two sequences that look the same are turned into
3220the same sequence. GCC can warn you if you are using identifiers which
3221have not been normalized; this option controls that warning.
3222
3223There are four levels of warning that GCC supports. The default is
3224@option{-Wnormalized=nfc}, which warns about any identifier which is
3225not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
3226recommended form for most uses.
3227
3228Unfortunately, there are some characters which ISO C and ISO C++ allow
3229in identifiers that when turned into NFC aren't allowable as
3230identifiers. That is, there's no way to use these symbols in portable
3231ISO C or C++ and have all your identifiers in NFC.
3232@option{-Wnormalized=id} suppresses the warning for these characters.
3233It is hoped that future versions of the standards involved will correct
3234this, which is why this option is not the default.
3235
3236You can switch the warning off for all characters by writing
3237@option{-Wnormalized=none}. You would only want to do this if you
3238were using some other normalization scheme (like ``D''), because
3239otherwise you can easily create bugs that are literally impossible to see.
3240
3241Some characters in ISO 10646 have distinct meanings but look identical
3242in some fonts or display methodologies, especially once formatting has
3243been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3244LETTER N'', will display just like a regular @code{n} which has been
3245placed in a superscript. ISO 10646 defines the @dfn{NFKC}
3246normalisation scheme to convert all these into a standard form as
3247well, and GCC will warn if your code is not in NFKC if you use
3248@option{-Wnormalized=nfkc}. This warning is comparable to warning
3249about every identifier that contains the letter O because it might be
3250confused with the digit 0, and so is not the default, but may be
3251useful as a local coding convention if the programming environment is
3252unable to be fixed to display these characters distinctly.
3253
e23bd218
IR
3254@item -Wno-deprecated-declarations
3255@opindex Wno-deprecated-declarations
3256Do not warn about uses of functions, variables, and types marked as
f282ffb3 3257deprecated by using the @code{deprecated} attribute.
e23bd218
IR
3258(@pxref{Function Attributes}, @pxref{Variable Attributes},
3259@pxref{Type Attributes}.)
3260
3c12fcc2 3261@item -Wpacked
cd3bb277 3262@opindex Wpacked
3c12fcc2 3263Warn if a structure is given the packed attribute, but the packed
02f52e19 3264attribute has no effect on the layout or size of the structure.
3c12fcc2
GM
3265Such structures may be mis-aligned for little benefit. For
3266instance, in this code, the variable @code{f.x} in @code{struct bar}
3267will be misaligned even though @code{struct bar} does not itself
3268have the packed attribute:
3269
3270@smallexample
3271@group
3272struct foo @{
3273 int x;
3274 char a, b, c, d;
3275@} __attribute__((packed));
3276struct bar @{
3277 char z;
3278 struct foo f;
3279@};
3280@end group
3281@end smallexample
3282
3283@item -Wpadded
cd3bb277 3284@opindex Wpadded
3c12fcc2
GM
3285Warn if padding is included in a structure, either to align an element
3286of the structure or to align the whole structure. Sometimes when this
3287happens it is possible to rearrange the fields of the structure to
3288reduce the padding and so make the structure smaller.
3289
74291a4b 3290@item -Wredundant-decls
cd3bb277 3291@opindex Wredundant-decls
74291a4b
MM
3292Warn if anything is declared more than once in the same scope, even in
3293cases where multiple declaration is valid and changes nothing.
3294
aee96fe9 3295@item -Wnested-externs @r{(C only)}
cd3bb277 3296@opindex Wnested-externs
252215a7 3297Warn if an @code{extern} declaration is encountered within a function.
74291a4b 3298
312f6255 3299@item -Wunreachable-code
cd3bb277 3300@opindex Wunreachable-code
312f6255
GK
3301Warn if the compiler detects that code will never be executed.
3302
3303This option is intended to warn when the compiler detects that at
3304least a whole line of source code will never be executed, because
3305some condition is never satisfied or because it is after a
3306procedure that never returns.
3307
3308It is possible for this option to produce a warning even though there
3309are circumstances under which part of the affected line can be executed,
3310so care should be taken when removing apparently-unreachable code.
3311
3312For instance, when a function is inlined, a warning may mean that the
02f52e19 3313line is unreachable in only one inlined copy of the function.
312f6255 3314
630d3d5a 3315This option is not made part of @option{-Wall} because in a debugging
312f6255
GK
3316version of a program there is often substantial code which checks
3317correct functioning of the program and is, hopefully, unreachable
3318because the program does work. Another common use of unreachable
c21cd8b1 3319code is to provide behavior which is selectable at compile-time.
312f6255 3320
74291a4b 3321@item -Winline
cd3bb277 3322@opindex Winline
c5c76735 3323Warn if a function can not be inlined and it was declared as inline.
ae4a7155 3324Even with this option, the compiler will not warn about failures to
daf2f129 3325inline functions declared in system headers.
ae4a7155
MM
3326
3327The compiler uses a variety of heuristics to determine whether or not
3328to inline a function. For example, the compiler takes into account
0bdcd332 3329the size of the function being inlined and the amount of inlining
ae4a7155
MM
3330that has already been done in the current function. Therefore,
3331seemingly insignificant changes in the source program can cause the
3332warnings produced by @option{-Winline} to appear or disappear.
74291a4b 3333
a01fff59
MA
3334@item -Wno-invalid-offsetof @r{(C++ only)}
3335@opindex Wno-invalid-offsetof
3336Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3337type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3338to a non-POD type is undefined. In existing C++ implementations,
3339however, @samp{offsetof} typically gives meaningful results even when
3340applied to certain kinds of non-POD types. (Such as a simple
3341@samp{struct} that fails to be a POD type only by virtue of having a
3342constructor.) This flag is for users who are aware that they are
3343writing nonportable code and who have deliberately chosen to ignore the
3344warning about it.
3345
3346The restrictions on @samp{offsetof} may be relaxed in a future version
3347of the C++ standard.
3348
53a2494e
JM
3349@item -Wno-int-to-pointer-cast @r{(C only)}
3350@opindex Wno-int-to-pointer-cast
3351Suppress warnings from casts to pointer type of an integer of a
3352different size.
3353
3354@item -Wno-pointer-to-int-cast @r{(C only)}
3355@opindex Wno-pointer-to-int-cast
3356Suppress warnings from casts from a pointer to an integer type of a
3357different size.
3358
17211ab5
GK
3359@item -Winvalid-pch
3360@opindex Winvalid-pch
3361Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3362the search path but can't be used.
3363
795add94 3364@item -Wlong-long
cd3bb277
JM
3365@opindex Wlong-long
3366@opindex Wno-long-long
795add94 3367Warn if @samp{long long} type is used. This is default. To inhibit
630d3d5a
JM
3368the warning messages, use @option{-Wno-long-long}. Flags
3369@option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3370only when @option{-pedantic} flag is used.
795add94 3371
7c4d376d
RH
3372@item -Wvariadic-macros
3373@opindex Wvariadic-macros
3374@opindex Wno-variadic-macros
3375Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3376alternate syntax when in pedantic ISO C99 mode. This is default.
3377To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3378
d35a40fc
DE
3379@item -Wvolatile-register-var
3380@opindex Wvolatile-register-var
3381@opindex Wno-volatile-register-var
3382Warn if a register variable is declared volatile. The volatile
3383modifier does not inhibit all optimizations that may eliminate reads
3384and/or writes to register variables.
3385
18424ae1 3386@item -Wdisabled-optimization
cd3bb277 3387@opindex Wdisabled-optimization
18424ae1
BL
3388Warn if a requested optimization pass is disabled. This warning does
3389not generally indicate that there is anything wrong with your code; it
3390merely indicates that GCC's optimizers were unable to handle the code
3391effectively. Often, the problem is that your code is too big or too
3392complex; GCC will refuse to optimize programs when the optimization
3393itself is likely to take inordinate amounts of time.
3394
f4e9414e
AO
3395@item -Wpointer-sign
3396@opindex Wpointer-sign
f2fd3821 3397@opindex Wno-pointer-sign
f4e9414e
AO
3398Warn for pointer argument passing or assignment with different signedness.
3399This option is only supported for C and Objective-C@. It is implied by
3400@option{-Wall} and by @option{-pedantic}, which can be disabled with
3401@option{-Wno-pointer-sign}.
f2fd3821 3402
74291a4b 3403@item -Werror
cd3bb277 3404@opindex Werror
74291a4b 3405Make all warnings into errors.
0aca9021 3406
79cf5994
DD
3407@item -Werror=
3408@opindex Werror=
3409Make the specified warning into an errors. The specifier for a
3410warning is appended, for example @option{-Werror=switch} turns the
3411warnings controlled by @option{-Wswitch} into errors. This switch
3412takes a negative form, to be used to negate @option{-Werror} for
3413specific warnings, for example @option{-Wno-error=switch} makes
3414@option{-Wswitch} warnings not be errors, even when @option{-Werror}
3415is in effect. You can use the @option{-fdiagnostics-show-option}
3416option to have each controllable warning amended with the option which
3417controls it, to determine what to use with this option.
3418
3419Note that specifying @option{-Werror=}@var{foo} automatically implies
3420@option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
3421imply anything.
3422
0aca9021 3423@item -Wstack-protector
d77314ec 3424@opindex Wstack-protector
0aca9021
JW
3425This option is only active when @option{-fstack-protector} is active. It
3426warns about functions that will not be protected against stack smashing.
3427
d77314ec
RS
3428@item -Wstring-literal-comparison
3429@opindex Wstring-literal-comparison
3430Warn about suspicious comparisons to string literal constants. In C,
3431direct comparisons against the memory address of a string literal, such
3432as @code{if (x == "abc")}, typically indicate a programmer error, and
3433even when intentional, result in unspecified behavior and are not portable.
3434Usually these warnings alert that the programmer intended to use
3435@code{strcmp}. This warning is enabled by @option{-Wall}.
3436
89a42ac8
ZW
3437@item -Woverlength-strings
3438@opindex Woverlength-strings
3439Warn about string constants which are longer than the ``minimum
3440maximum'' length specified in the C standard. Modern compilers
3441generally allow string constants which are much longer than the
3442standard's minimum limit, but very portable programs should avoid
3443using longer strings.
3444
3445The limit applies @emph{after} string constant concatenation, and does
3446not count the trailing NUL@. In C89, the limit was 509 characters; in
3447C99, it was raised to 4095. C++98 does not specify a normative
3448minimum maximum, so we do not diagnose overlength strings in C++@.
3449
3450This option is implied by @option{-pedantic}, and can be disabled with
3451@option{-Wno-overlength-strings}.
74291a4b
MM
3452@end table
3453
3454@node Debugging Options
0c2d1a2a 3455@section Options for Debugging Your Program or GCC
74291a4b
MM
3456@cindex options, debugging
3457@cindex debugging information options
3458
0c2d1a2a 3459GCC has various special options that are used for debugging
74291a4b
MM
3460either your program or GCC:
3461
2642624b 3462@table @gcctabopt
74291a4b 3463@item -g
cd3bb277 3464@opindex g
74291a4b 3465Produce debugging information in the operating system's native format
f8ca7e49 3466(stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
74291a4b
MM
3467information.
3468
630d3d5a 3469On most systems that use stabs format, @option{-g} enables use of extra
74291a4b
MM
3470debugging information that only GDB can use; this extra information
3471makes debugging work better in GDB but will probably make other debuggers
3472crash or
3473refuse to read the program. If you want to control for certain whether
630d3d5a 3474to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
def66b10 3475@option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
74291a4b 3476
f8ca7e49 3477GCC allows you to use @option{-g} with
630d3d5a 3478@option{-O}. The shortcuts taken by optimized code may occasionally
74291a4b
MM
3479produce surprising results: some variables you declared may not exist
3480at all; flow of control may briefly move where you did not expect it;
3481some statements may not be executed because they compute constant
3482results or their values were already at hand; some statements may
3483execute in different places because they were moved out of loops.
3484
3485Nevertheless it proves possible to debug optimized output. This makes
3486it reasonable to use the optimizer for programs that might have bugs.
3487
0c2d1a2a 3488The following options are useful when GCC is generated with the
74291a4b
MM
3489capability for more than one debugging format.
3490
3491@item -ggdb
cd3bb277 3492@opindex ggdb
161d7b59 3493Produce debugging information for use by GDB@. This means to use the
861bb6c1
JL
3494most expressive format available (DWARF 2, stabs, or the native format
3495if neither of those are supported), including GDB extensions if at all
3496possible.
74291a4b
MM
3497
3498@item -gstabs
cd3bb277 3499@opindex gstabs
74291a4b
MM
3500Produce debugging information in stabs format (if that is supported),
3501without GDB extensions. This is the format used by DBX on most BSD
3502systems. On MIPS, Alpha and System V Release 4 systems this option
161d7b59 3503produces stabs debugging output which is not understood by DBX or SDB@.
74291a4b
MM
3504On System V Release 4 systems this option requires the GNU assembler.
3505
6a08f7b3
DP
3506@item -feliminate-unused-debug-symbols
3507@opindex feliminate-unused-debug-symbols
3508Produce debugging information in stabs format (if that is supported),
c0cbdbd9 3509for only symbols that are actually used.
6a08f7b3 3510
74291a4b 3511@item -gstabs+
cd3bb277 3512@opindex gstabs+
74291a4b 3513Produce debugging information in stabs format (if that is supported),
161d7b59 3514using GNU extensions understood only by the GNU debugger (GDB)@. The
74291a4b
MM
3515use of these extensions is likely to make other debuggers crash or
3516refuse to read the program.
3517
3518@item -gcoff
cd3bb277 3519@opindex gcoff
74291a4b
MM
3520Produce debugging information in COFF format (if that is supported).
3521This is the format used by SDB on most System V systems prior to
3522System V Release 4.
3523
3524@item -gxcoff
cd3bb277 3525@opindex gxcoff
74291a4b
MM
3526Produce debugging information in XCOFF format (if that is supported).
3527This is the format used by the DBX debugger on IBM RS/6000 systems.
3528
3529@item -gxcoff+
cd3bb277 3530@opindex gxcoff+
74291a4b 3531Produce debugging information in XCOFF format (if that is supported),
161d7b59 3532using GNU extensions understood only by the GNU debugger (GDB)@. The
74291a4b
MM
3533use of these extensions is likely to make other debuggers crash or
3534refuse to read the program, and may cause assemblers other than the GNU
3535assembler (GAS) to fail with an error.
3536
861bb6c1 3537@item -gdwarf-2
cd3bb277 3538@opindex gdwarf-2
861bb6c1 3539Produce debugging information in DWARF version 2 format (if that is
f8ca7e49
ZW
3540supported). This is the format used by DBX on IRIX 6. With this
3541option, GCC uses features of DWARF version 3 when they are useful;
3542version 3 is upward compatible with version 2, but may still cause
3543problems for older debuggers.
74291a4b 3544
5f98259a
RK
3545@item -gvms
3546@opindex gvms
3547Produce debugging information in VMS debug format (if that is
3548supported). This is the format used by DEBUG on VMS systems.
3549
74291a4b
MM
3550@item -g@var{level}
3551@itemx -ggdb@var{level}
3552@itemx -gstabs@var{level}
3553@itemx -gcoff@var{level}
3554@itemx -gxcoff@var{level}
5f98259a 3555@itemx -gvms@var{level}
74291a4b
MM
3556Request debugging information and also use @var{level} to specify how
3557much information. The default level is 2.
3558
3559Level 1 produces minimal information, enough for making backtraces in
3560parts of the program that you don't plan to debug. This includes
3561descriptions of functions and external variables, but no information
3562about local variables and no line numbers.
3563
3564Level 3 includes extra information, such as all the macro definitions
3565present in the program. Some debuggers support macro expansion when
630d3d5a 3566you use @option{-g3}.
74291a4b 3567
f8ca7e49
ZW
3568@option{-gdwarf-2} does not accept a concatenated debug level, because
3569GCC used to support an option @option{-gdwarf} that meant to generate
3570debug information in version 1 of the DWARF format (which is very
3571different from version 2), and it would have been too confusing. That
3572debug format is long obsolete, but the option cannot be changed now.
3573Instead use an additional @option{-g@var{level}} option to change the
3574debug level for DWARF2.
eb7715a4 3575
e03b7153
RS
3576@item -feliminate-dwarf2-dups
3577@opindex feliminate-dwarf2-dups
3578Compress DWARF2 debugging information by eliminating duplicated
3579information about each symbol. This option only makes sense when
3580generating DWARF2 debugging information with @option{-gdwarf-2}.
3581
05739753 3582@cindex @command{prof}
74291a4b 3583@item -p
cd3bb277 3584@opindex p
74291a4b 3585Generate extra code to write profile information suitable for the
05739753 3586analysis program @command{prof}. You must use this option when compiling
74291a4b
MM
3587the source files you want data about, and you must also use it when
3588linking.
3589
05739753 3590@cindex @command{gprof}
74291a4b 3591@item -pg
cd3bb277 3592@opindex pg
74291a4b 3593Generate extra code to write profile information suitable for the
05739753 3594analysis program @command{gprof}. You must use this option when compiling
74291a4b
MM
3595the source files you want data about, and you must also use it when
3596linking.
3597
898f531b 3598@item -Q
cd3bb277 3599@opindex Q
898f531b
JL
3600Makes the compiler print out each function name as it is compiled, and
3601print some statistics about each pass when it finishes.
3602
1f0c3120 3603@item -ftime-report
cd3bb277 3604@opindex ftime-report
1f0c3120
JM
3605Makes the compiler print some statistics about the time consumed by each
3606pass when it finishes.
3607
3608@item -fmem-report
cd3bb277 3609@opindex fmem-report
1f0c3120
JM
3610Makes the compiler print some statistics about permanent memory
3611allocation when it finishes.
3612
861bb6c1 3613@item -fprofile-arcs
cd3bb277 3614@opindex fprofile-arcs
23af32e6
NS
3615Add code so that program flow @dfn{arcs} are instrumented. During
3616execution the program records how many times each branch and call is
3617executed and how many times it is taken or returns. When the compiled
3618program exits it saves this data to a file called
8a36672b 3619@file{@var{auxname}.gcda} for each source file. The data may be used for
23af32e6 3620profile-directed optimizations (@option{-fbranch-probabilities}), or for
8a36672b 3621test coverage analysis (@option{-ftest-coverage}). Each object file's
23af32e6
NS
3622@var{auxname} is generated from the name of the output file, if
3623explicitly specified and it is not the final executable, otherwise it is
8a36672b 3624the basename of the source file. In both cases any suffix is removed
431ae0bf 3625(e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
a4878735 3626@file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
992f396f 3627@xref{Cross-profiling}.
23af32e6 3628
ee4c708e
BE
3629@cindex @command{gcov}
3630@item --coverage
3631@opindex coverage
3632
3633This option is used to compile and link code instrumented for coverage
3634analysis. The option is a synonym for @option{-fprofile-arcs}
3635@option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3636linking). See the documentation for those options for more details.
3637
23af32e6
NS
3638@itemize
3639
3640@item
3641Compile the source files with @option{-fprofile-arcs} plus optimization
8a36672b
JM
3642and code generation options. For test coverage analysis, use the
3643additional @option{-ftest-coverage} option. You do not need to profile
23af32e6
NS
3644every source file in a program.
3645
3646@item
8555daff
NS
3647Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3648(the latter implies the former).
23af32e6
NS
3649
3650@item
3651Run the program on a representative workload to generate the arc profile
8a36672b 3652information. This may be repeated any number of times. You can run
8555daff 3653concurrent instances of your program, and provided that the file system
8a36672b 3654supports locking, the data files will be correctly updated. Also
8555daff
NS
3655@code{fork} calls are detected and correctly handled (double counting
3656will not happen).
23af32e6
NS
3657
3658@item
3659For profile-directed optimizations, compile the source files again with
3660the same optimization and code generation options plus
630d3d5a 3661@option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3de87bf2
JJ
3662Control Optimization}).
3663
23af32e6
NS
3664@item
3665For test coverage analysis, use @command{gcov} to produce human readable
8a36672b 3666information from the @file{.gcno} and @file{.gcda} files. Refer to the
23af32e6
NS
3667@command{gcov} documentation for further information.
3668
3669@end itemize
3de87bf2
JJ
3670
3671With @option{-fprofile-arcs}, for each function of your program GCC
3672creates a program flow graph, then finds a spanning tree for the graph.
3673Only arcs that are not on the spanning tree have to be instrumented: the
3674compiler adds code to count the number of times that these arcs are
3675executed. When an arc is the only exit or only entrance to a block, the
3676instrumentation code can be added to the block; otherwise, a new basic
3677block must be created to hold the instrumentation code.
3678
861bb6c1
JL
3679@need 2000
3680@item -ftest-coverage
cd3bb277 3681@opindex ftest-coverage
a4878735 3682Produce a notes file that the @command{gcov} code-coverage utility
23af32e6 3683(@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
8a36672b
JM
3684show program coverage. Each source file's note file is called
3685@file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
23af32e6 3686above for a description of @var{auxname} and instructions on how to
8a36672b 3687generate test coverage data. Coverage data will match the source files
23af32e6 3688more closely, if you do not optimize.
3de87bf2 3689
74291a4b 3690@item -d@var{letters}
9f8628ba 3691@item -fdump-rtl-@var{pass}
cd3bb277 3692@opindex d
74291a4b 3693Says to make debugging dumps during compilation at times specified by
9f8628ba
PB
3694@var{letters}. This is used for debugging the RTL-based passes of the
3695compiler. The file names for most of the dumps are made by appending a
3696pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3697from the name of the output file, if explicitly specified and it is not
3698an executable, otherwise it is the basename of the source file.
74291a4b 3699
9f8628ba
PB
3700Most debug dumps can be enabled either passing a letter to the @option{-d}
3701option, or with a long @option{-fdump-rtl} switch; here are the possible
3702letters for use in @var{letters} and @var{pass}, and their meanings:
3703
3704@table @gcctabopt
3705@item -dA
cd3bb277 3706@opindex dA
375e2d5c 3707Annotate the assembler output with miscellaneous debugging information.
9f8628ba
PB
3708
3709@item -db
3710@itemx -fdump-rtl-bp
cd3bb277 3711@opindex db
9f8628ba
PB
3712@opindex fdump-rtl-bp
3713Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3714
3715@item -dB
3716@itemx -fdump-rtl-bbro
cd3bb277 3717@opindex dB
9f8628ba
PB
3718@opindex fdump-rtl-bbro
3719Dump after block reordering, to @file{@var{file}.30.bbro}.
3720
3721@item -dc
3722@itemx -fdump-rtl-combine
cd3bb277 3723@opindex dc
9f8628ba
PB
3724@opindex fdump-rtl-combine
3725Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3726
3727@item -dC
3728@itemx -fdump-rtl-ce1
3729@itemx -fdump-rtl-ce2
cd3bb277 3730@opindex dC
9f8628ba
PB
3731@opindex fdump-rtl-ce1
3732@opindex fdump-rtl-ce2
3733@option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3734first if conversion, to the file @file{@var{file}.11.ce1}. @option{-dC}
3735and @option{-fdump-rtl-ce2} enable dumping after the second if
3736conversion, to the file @file{@var{file}.18.ce2}.
3737
3738@item -dd
3739@itemx -fdump-rtl-btl
3740@itemx -fdump-rtl-dbr
cd3bb277 3741@opindex dd
9f8628ba
PB
3742@opindex fdump-rtl-btl
3743@opindex fdump-rtl-dbr
3744@option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
0bdcd332 3745target load optimization, to @file{@var{file}.31.btl}. @option{-dd}
9f8628ba
PB
3746and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3747scheduling, to @file{@var{file}.36.dbr}.
3748
3749@item -dD
cd3bb277 3750@opindex dD
f5963e61
JL
3751Dump all macro definitions, at the end of preprocessing, in addition to
3752normal output.
9f8628ba
PB
3753
3754@item -dE
3755@itemx -fdump-rtl-ce3
cd3bb277 3756@opindex dE
9f8628ba
PB
3757@opindex fdump-rtl-ce3
3758Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3759
3760@item -df
3761@itemx -fdump-rtl-cfg
3762@itemx -fdump-rtl-life
cd3bb277 3763@opindex df
9f8628ba
PB
3764@opindex fdump-rtl-cfg
3765@opindex fdump-rtl-life
3766@option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3767and data flow analysis, to @file{@var{file}.08.cfg}. @option{-df}
3768and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3769to @file{@var{file}.16.life}.
3770
3771@item -dg
3772@itemx -fdump-rtl-greg
cd3bb277 3773@opindex dg
9f8628ba
PB
3774@opindex fdump-rtl-greg
3775Dump after global register allocation, to @file{@var{file}.23.greg}.
3776
3777@item -dG
3778@itemx -fdump-rtl-gcse
3779@itemx -fdump-rtl-bypass
cd3bb277 3780@opindex dG
9f8628ba
PB
3781@opindex fdump-rtl-gcse
3782@opindex fdump-rtl-bypass
3783@option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3784@file{@var{file}.05.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3785enable dumping after jump bypassing and control flow optimizations, to
3786@file{@var{file}.07.bypass}.
3787
3788@item -dh
3789@itemx -fdump-rtl-eh
7fedea11 3790@opindex dh
9f8628ba
PB
3791@opindex fdump-rtl-eh
3792Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3793
3794@item -di
3795@itemx -fdump-rtl-sibling
cd3bb277 3796@opindex di
9f8628ba
PB
3797@opindex fdump-rtl-sibling
3798Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3799
3800@item -dj
3801@itemx -fdump-rtl-jump
cd3bb277 3802@opindex dj
9f8628ba
PB
3803@opindex fdump-rtl-jump
3804Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3805
3806@item -dk
3807@itemx -fdump-rtl-stack
cd3bb277 3808@opindex dk
9f8628ba
PB
3809@opindex fdump-rtl-stack
3810Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3811
3812@item -dl
3813@itemx -fdump-rtl-lreg
cd3bb277 3814@opindex dl
9f8628ba
PB
3815@opindex fdump-rtl-lreg
3816Dump after local register allocation, to @file{@var{file}.22.lreg}.
3817
3818@item -dL
3819@itemx -fdump-rtl-loop
3820@itemx -fdump-rtl-loop2
cd3bb277 3821@opindex dL
9f8628ba
PB
3822@opindex fdump-rtl-loop
3823@opindex fdump-rtl-loop2
3824@option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3825loop optimization pass, to @file{@var{file}.06.loop}. @option{-dL} and
3826@option{-fdump-rtl-loop2} enable dumping after the second pass, to
3827@file{@var{file}.13.loop2}.
3828
3829@item -dm
3830@itemx -fdump-rtl-sms
e5626198 3831@opindex dm
9f8628ba 3832@opindex fdump-rtl-sms
f0eb93a8 3833Dump after modulo scheduling, to @file{@var{file}.20.sms}.
9f8628ba
PB
3834
3835@item -dM
3836@itemx -fdump-rtl-mach
cd3bb277 3837@opindex dM
9f8628ba 3838@opindex fdump-rtl-mach
c0478a66 3839Dump after performing the machine dependent reorganization pass, to
9f8628ba
PB
3840@file{@var{file}.35.mach}.
3841
3842@item -dn
3843@itemx -fdump-rtl-rnreg
cd3bb277 3844@opindex dn
9f8628ba
PB
3845@opindex fdump-rtl-rnreg
3846Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3847
3848@item -dN
3849@itemx -fdump-rtl-regmove
cd3bb277 3850@opindex dN
9f8628ba
PB
3851@opindex fdump-rtl-regmove
3852Dump after the register move pass, to @file{@var{file}.19.regmove}.
3853
3854@item -do
3855@itemx -fdump-rtl-postreload
7fedea11 3856@opindex do
9f8628ba
PB
3857@opindex fdump-rtl-postreload
3858Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3859
3860@item -dr
3861@itemx -fdump-rtl-expand
cd3bb277 3862@opindex dr
9f8628ba
PB
3863@opindex fdump-rtl-expand
3864Dump after RTL generation, to @file{@var{file}.00.expand}.
3865
3866@item -dR
3867@itemx -fdump-rtl-sched2
cd3bb277 3868@opindex dR
9f8628ba
PB
3869@opindex fdump-rtl-sched2
3870Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3871
3872@item -ds
3873@itemx -fdump-rtl-cse
cd3bb277 3874@opindex ds
9f8628ba 3875@opindex fdump-rtl-cse
032713aa 3876Dump after CSE (including the jump optimization that sometimes follows
9f8628ba
PB
3877CSE), to @file{@var{file}.04.cse}.
3878
3879@item -dS
3880@itemx -fdump-rtl-sched
cd3bb277 3881@opindex dS
9f8628ba
PB
3882@opindex fdump-rtl-sched
3883Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3884
3885@item -dt
3886@itemx -fdump-rtl-cse2
cd3bb277 3887@opindex dt
9f8628ba 3888@opindex fdump-rtl-cse2
032713aa 3889Dump after the second CSE pass (including the jump optimization that
9f8628ba
PB
3890sometimes follows CSE), to @file{@var{file}.15.cse2}.
3891
3892@item -dT
3893@itemx -fdump-rtl-tracer
4319ef2a 3894@opindex dT
9f8628ba
PB
3895@opindex fdump-rtl-tracer
3896Dump after running tracer, to @file{@var{file}.12.tracer}.
3897
3898@item -dV
3899@itemx -fdump-rtl-vpt
3900@itemx -fdump-rtl-vartrack
9313cfdd 3901@opindex dV
9f8628ba
PB
3902@opindex fdump-rtl-vpt
3903@opindex fdump-rtl-vartrack
3904@option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3905profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
3906and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3907to @file{@var{file}.34.vartrack}.
3908
3909@item -dw
3910@itemx -fdump-rtl-flow2
cd3bb277 3911@opindex dw
9f8628ba
PB
3912@opindex fdump-rtl-flow2
3913Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3914
3915@item -dz
3916@itemx -fdump-rtl-peephole2
cd3bb277 3917@opindex dz
9f8628ba
PB
3918@opindex fdump-rtl-peephole2
3919Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3920
3921@item -dZ
3922@itemx -fdump-rtl-web
9313cfdd 3923@opindex dZ
9f8628ba
PB
3924@opindex fdump-rtl-web
3925Dump after live range splitting, to @file{@var{file}.14.web}.
3926
3927@item -da
3928@itemx -fdump-rtl-all
cd3bb277 3929@opindex da
9f8628ba 3930@opindex fdump-rtl-all
74291a4b 3931Produce all the dumps listed above.
9f8628ba
PB
3932
3933@item -dH
886e0865
GK
3934@opindex dH
3935Produce a core dump whenever an error occurs.
9f8628ba
PB
3936
3937@item -dm
cd3bb277 3938@opindex dm
74291a4b
MM
3939Print statistics on memory usage, at the end of the run, to
3940standard error.
9f8628ba
PB
3941
3942@item -dp
cd3bb277 3943@opindex dp
74291a4b 3944Annotate the assembler output with a comment indicating which
f20b5577
MM
3945pattern and alternative was used. The length of each instruction is
3946also printed.
9f8628ba
PB
3947
3948@item -dP
cd3bb277 3949@opindex dP
2856c3e3 3950Dump the RTL in the assembler output as a comment before each instruction.
630d3d5a 3951Also turns on @option{-dp} annotation.
9f8628ba
PB
3952
3953@item -dv
cd3bb277 3954@opindex dv
9f8628ba
PB
3955For each of the other indicated dump files (either with @option{-d} or
3956@option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3957graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3958
3959@item -dx
cd3bb277 3960@opindex dx
62a1403d 3961Just generate RTL for a function instead of compiling it. Usually used
9f8628ba
PB
3962with @samp{r} (@option{-fdump-rtl-expand}).
3963
3964@item -dy
cd3bb277 3965@opindex dy
032713aa 3966Dump debugging information during parsing, to standard error.
74291a4b
MM
3967@end table
3968
b707b450 3969@item -fdump-unnumbered
cd3bb277 3970@opindex fdump-unnumbered
695ac33f 3971When doing debugging dumps (see @option{-d} option above), suppress instruction
b707b450 3972numbers and line number note output. This makes it more feasible to
b192711e 3973use diff on debugging dumps for compiler invocations with different
695ac33f 3974options, in particular with and without @option{-g}.
b707b450 3975
223dcf1c
AN
3976@item -fdump-translation-unit @r{(C++ only)}
3977@itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
f70a54cb
CR
3978@opindex fdump-translation-unit
3979Dump a representation of the tree structure for the entire translation
3980unit to a file. The file name is made by appending @file{.tu} to the
3981source file name. If the @samp{-@var{options}} form is used, @var{options}
3982controls the details of the dump as described for the
3983@option{-fdump-tree} options.
3984
aee96fe9 3985@item -fdump-class-hierarchy @r{(C++ only)}
22367161 3986@itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
cd3bb277 3987@opindex fdump-class-hierarchy
e76b4820 3988Dump a representation of each class's hierarchy and virtual function
767094dd 3989table layout to a file. The file name is made by appending @file{.class}
22367161
NS
3990to the source file name. If the @samp{-@var{options}} form is used,
3991@var{options} controls the details of the dump as described for the
3992@option{-fdump-tree} options.
3993
9b3e897d
PB
3994@item -fdump-ipa-@var{switch}
3995@opindex fdump-ipa
83c99486 3996Control the dumping at various stages of inter-procedural analysis
9b3e897d 3997language tree to a file. The file name is generated by appending a switch
8a36672b 3998specific suffix to the source file name. The following dumps are possible:
9b3e897d
PB
3999
4000@table @samp
4001@item all
4002Enables all inter-procedural analysis dumps; currently the only produced
4003dump is the @samp{cgraph} dump.
4004
4005@item cgraph
4006Dumps information about call-graph optimization, unused function removal,
4007and inlining decisions.
4008@end table
4009
0c8c236b
JJ
4010@item -fdump-tree-@var{switch}
4011@itemx -fdump-tree-@var{switch}-@var{options}
22367161
NS
4012@opindex fdump-tree
4013Control the dumping at various stages of processing the intermediate
4014language tree to a file. The file name is generated by appending a switch
4015specific suffix to the source file name. If the @samp{-@var{options}}
4016form is used, @var{options} is a list of @samp{-} separated options that
8a36672b
JM
4017control the details of the dump. Not all options are applicable to all
4018dumps, those which are not meaningful will be ignored. The following
22367161 4019options are available
f71f87f9 4020
e76b4820 4021@table @samp
22367161 4022@item address
767094dd 4023Print the address of each node. Usually this is not meaningful as it
8a36672b 4024changes according to the environment and source file. Its primary use
22367161
NS
4025is for tying up a dump file with a debug environment.
4026@item slim
4027Inhibit dumping of members of a scope or body of a function merely
6de9cd9a
DN
4028because that scope has been reached. Only dump such items when they
4029are directly reachable by some other path. When dumping pretty-printed
4030trees, this option inhibits dumping the bodies of control structures.
4031@item raw
4032Print a raw representation of the tree. By default, trees are
4033pretty-printed into a C-like representation.
4034@item details
4035Enable more detailed dumps (not honored by every dump option).
4036@item stats
4037Enable dumping various statistics about the pass (not honored by every dump
4038option).
4039@item blocks
4040Enable showing basic block boundaries (disabled in raw dumps).
4041@item vops
4042Enable showing virtual operands for every statement.
4043@item lineno
4044Enable showing line numbers for statements.
4045@item uid
4046Enable showing the unique ID (@code{DECL_UID}) for each variable.
22367161 4047@item all
6de9cd9a 4048Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
e76b4820
NS
4049@end table
4050
4051The following tree dumps are possible:
4052@table @samp
6de9cd9a 4053
e76b4820
NS
4054@item original
4055Dump before any tree based optimization, to @file{@var{file}.original}.
6de9cd9a 4056
e76b4820
NS
4057@item optimized
4058Dump after all tree based optimization, to @file{@var{file}.optimized}.
6de9cd9a 4059
6be77748 4060@item inlined
9c34dbbf 4061Dump after function inlining, to @file{@var{file}.inlined}.
6de9cd9a
DN
4062
4063@item gimple
4064@opindex fdump-tree-gimple
4065Dump each function before and after the gimplification pass to a file. The
4066file name is made by appending @file{.gimple} to the source file name.
4067
4068@item cfg
4069@opindex fdump-tree-cfg
4070Dump the control flow graph of each function to a file. The file name is
4071made by appending @file{.cfg} to the source file name.
4072
4073@item vcg
4074@opindex fdump-tree-vcg
4075Dump the control flow graph of each function to a file in VCG format. The
4076file name is made by appending @file{.vcg} to the source file name. Note
4077that if the file contains more than one function, the generated file cannot
8a36672b 4078be used directly by VCG@. You will need to cut and paste each function's
6de9cd9a
DN
4079graph into its own separate file first.
4080
4081@item ch
4082@opindex fdump-tree-ch
4083Dump each function after copying loop headers. The file name is made by
4084appending @file{.ch} to the source file name.
4085
4086@item ssa
4087@opindex fdump-tree-ssa
4088Dump SSA related information to a file. The file name is made by appending
4089@file{.ssa} to the source file name.
4090
c75ab022
DB
4091@item salias
4092@opindex fdump-tree-salias
4093Dump structure aliasing variable information to a file. This file name
4094is made by appending @file{.salias} to the source file name.
4095
6de9cd9a
DN
4096@item alias
4097@opindex fdump-tree-alias
4098Dump aliasing information for each function. The file name is made by
4099appending @file{.alias} to the source file name.
4100
4101@item ccp
4102@opindex fdump-tree-ccp
8a36672b 4103Dump each function after CCP@. The file name is made by appending
6de9cd9a
DN
4104@file{.ccp} to the source file name.
4105
0bca51f0
DN
4106@item storeccp
4107@opindex fdump-tree-storeccp
4108Dump each function after STORE-CCP. The file name is made by appending
4109@file{.storeccp} to the source file name.
4110
6de9cd9a
DN
4111@item pre
4112@opindex fdump-tree-pre
4113Dump trees after partial redundancy elimination. The file name is made
4114by appending @file{.pre} to the source file name.
4115
ff2ad0f7
DN
4116@item fre
4117@opindex fdump-tree-fre
4118Dump trees after full redundancy elimination. The file name is made
4119by appending @file{.fre} to the source file name.
4120
0bca51f0
DN
4121@item copyprop
4122@opindex fdump-tree-copyprop
4123Dump trees after copy propagation. The file name is made
4124by appending @file{.copyprop} to the source file name.
4125
4126@item store_copyprop
4127@opindex fdump-tree-store_copyprop
4128Dump trees after store copy-propagation. The file name is made
4129by appending @file{.store_copyprop} to the source file name.
4130
6de9cd9a
DN
4131@item dce
4132@opindex fdump-tree-dce
4133Dump each function after dead code elimination. The file name is made by
4134appending @file{.dce} to the source file name.
4135
4136@item mudflap
4137@opindex fdump-tree-mudflap
4138Dump each function after adding mudflap instrumentation. The file name is
4139made by appending @file{.mudflap} to the source file name.
4140
4141@item sra
4142@opindex fdump-tree-sra
4143Dump each function after performing scalar replacement of aggregates. The
4144file name is made by appending @file{.sra} to the source file name.
4145
fa555252
DB
4146@item sink
4147@opindex fdump-tree-sink
4148Dump each function after performing code sinking. The file name is made
4149by appending @file{.sink} to the source file name.
4150
6de9cd9a
DN
4151@item dom
4152@opindex fdump-tree-dom
4153Dump each function after applying dominator tree optimizations. The file
4154name is made by appending @file{.dom} to the source file name.
4155
4156@item dse
4157@opindex fdump-tree-dse
4158Dump each function after applying dead store elimination. The file
4159name is made by appending @file{.dse} to the source file name.
4160
4161@item phiopt
4162@opindex fdump-tree-phiopt
4163Dump each function after optimizing PHI nodes into straightline code. The file
4164name is made by appending @file{.phiopt} to the source file name.
4165
4166@item forwprop
4167@opindex fdump-tree-forwprop
4168Dump each function after forward propagating single use variables. The file
4169name is made by appending @file{.forwprop} to the source file name.
4170
4171@item copyrename
4172@opindex fdump-tree-copyrename
4173Dump each function after applying the copy rename optimization. The file
4174name is made by appending @file{.copyrename} to the source file name.
4175
4176@item nrv
4177@opindex fdump-tree-nrv
4178Dump each function after applying the named return value optimization on
4179generic trees. The file name is made by appending @file{.nrv} to the source
4180file name.
4181
79fe1b3b
DN
4182@item vect
4183@opindex fdump-tree-vect
f0eb93a8 4184Dump each function after applying vectorization of loops. The file name is
79fe1b3b
DN
4185made by appending @file{.vect} to the source file name.
4186
08873e96
DN
4187@item vrp
4188@opindex fdump-tree-vrp
4189Dump each function after Value Range Propagation (VRP). The file name
4190is made by appending @file{.vrp} to the source file name.
4191
6de9cd9a
DN
4192@item all
4193@opindex fdump-tree-all
4194Enable all the available tree dumps with the flags provided in this option.
e76b4820 4195@end table
9965d119 4196
c866976a
LB
4197@item -ftree-vectorizer-verbose=@var{n}
4198@opindex ftree-vectorizer-verbose
4199This option controls the amount of debugging output the vectorizer prints.
4200This information is written to standard error, unless @option{-fdump-tree-all}
4201or @option{-fdump-tree-vect} is specified, in which case it is output to the
4202usual dump listing file, @file{.vect}.
4203
a37db56b
GK
4204@item -frandom-seed=@var{string}
4205@opindex frandom-string
4206This option provides a seed that GCC uses when it would otherwise use
e61a2eb7 4207random numbers. It is used to generate certain symbol names
8a36672b 4208that have to be different in every compiled file. It is also used to
e61a2eb7 4209place unique stamps in coverage data files and the object files that
8a36672b 4210produce them. You can use the @option{-frandom-seed} option to produce
e61a2eb7 4211reproducibly identical object files.
a37db56b
GK
4212
4213The @var{string} should be different for every file you compile.
4214
e03b7153
RS
4215@item -fsched-verbose=@var{n}
4216@opindex fsched-verbose
4217On targets that use instruction scheduling, this option controls the
4218amount of debugging output the scheduler prints. This information is
4219written to standard error, unless @option{-dS} or @option{-dR} is
4220specified, in which case it is output to the usual dump
4221listing file, @file{.sched} or @file{.sched2} respectively. However
4222for @var{n} greater than nine, the output is always printed to standard
4223error.
4224
4225For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4226same information as @option{-dRS}. For @var{n} greater than one, it
4227also output basic block probabilities, detailed ready list information
4228and unit/insn info. For @var{n} greater than two, it includes RTL
4229at abort point, control-flow and regions info. And for @var{n} over
4230four, @option{-fsched-verbose} also includes dependence info.
4231
74291a4b 4232@item -save-temps
cd3bb277 4233@opindex save-temps
74291a4b
MM
4234Store the usual ``temporary'' intermediate files permanently; place them
4235in the current directory and name them based on the source file. Thus,
4236compiling @file{foo.c} with @samp{-c -save-temps} would produce files
f2ecb02d
JM
4237@file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
4238preprocessed @file{foo.i} output file even though the compiler now
4239normally uses an integrated preprocessor.
74291a4b 4240
1f7edb8b
RS
4241When used in combination with the @option{-x} command line option,
4242@option{-save-temps} is sensible enough to avoid over writing an
4243input source file with the same extension as an intermediate file.
4244The corresponding intermediate file may be obtained by renaming the
4245source file before using @option{-save-temps}.
4246
03c41c05 4247@item -time
cd3bb277 4248@opindex time
03c41c05 4249Report the CPU time taken by each subprocess in the compilation
f2ecb02d
JM
4250sequence. For C source files, this is the compiler proper and assembler
4251(plus the linker if linking is done). The output looks like this:
03c41c05
ZW
4252
4253@smallexample
03c41c05
ZW
4254# cc1 0.12 0.01
4255# as 0.00 0.01
4256@end smallexample
4257
d78aa55c
JM
4258The first number on each line is the ``user time'', that is time spent
4259executing the program itself. The second number is ``system time'',
03c41c05
ZW
4260time spent executing operating system routines on behalf of the program.
4261Both numbers are in seconds.
4262
014a1138
JZ
4263@item -fvar-tracking
4264@opindex fvar-tracking
8a36672b
JM
4265Run variable tracking pass. It computes where variables are stored at each
4266position in code. Better debugging information is then generated
014a1138
JZ
4267(if the debugging information format supports this information).
4268
4269It is enabled by default when compiling with optimization (@option{-Os},
4270@option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4271the debug info format supports it.
4272
74291a4b 4273@item -print-file-name=@var{library}
cd3bb277 4274@opindex print-file-name
74291a4b
MM
4275Print the full absolute name of the library file @var{library} that
4276would be used when linking---and don't do anything else. With this
0c2d1a2a 4277option, GCC does not compile or link anything; it just prints the
74291a4b
MM
4278file name.
4279
b1018de6
AO
4280@item -print-multi-directory
4281@opindex print-multi-directory
4282Print the directory name corresponding to the multilib selected by any
4283other switches present in the command line. This directory is supposed
4284to exist in @env{GCC_EXEC_PREFIX}.
4285
4286@item -print-multi-lib
4287@opindex print-multi-lib
4288Print the mapping from multilib directory names to compiler switches
4289that enable them. The directory name is separated from the switches by
4290@samp{;}, and each switch starts with an @samp{@@} instead of the
4291@samp{-}, without spaces between multiple switches. This is supposed to
4292ease shell-processing.
4293
74291a4b 4294@item -print-prog-name=@var{program}
cd3bb277 4295@opindex print-prog-name
630d3d5a 4296Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
74291a4b
MM
4297
4298@item -print-libgcc-file-name
cd3bb277 4299@opindex print-libgcc-file-name
630d3d5a 4300Same as @option{-print-file-name=libgcc.a}.
74291a4b 4301
630d3d5a 4302This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
74291a4b
MM
4303but you do want to link with @file{libgcc.a}. You can do
4304
3ab51846 4305@smallexample
74291a4b 4306gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3ab51846 4307@end smallexample
74291a4b
MM
4308
4309@item -print-search-dirs
cd3bb277 4310@opindex print-search-dirs
74291a4b 4311Print the name of the configured installation directory and a list of
2dd76960 4312program and library directories @command{gcc} will search---and don't do anything else.
74291a4b 4313
2dd76960 4314This is useful when @command{gcc} prints the error message
3c0b7970
JM
4315@samp{installation problem, cannot exec cpp0: No such file or directory}.
4316To resolve this you either need to put @file{cpp0} and the other compiler
2dd76960 4317components where @command{gcc} expects to find them, or you can set the environment
bedc7537 4318variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
78466c0e 4319Don't forget the trailing @samp{/}.
74291a4b 4320@xref{Environment Variables}.
1f0c3120
JM
4321
4322@item -dumpmachine
cd3bb277 4323@opindex dumpmachine
1f0c3120
JM
4324Print the compiler's target machine (for example,
4325@samp{i686-pc-linux-gnu})---and don't do anything else.
4326
4327@item -dumpversion
cd3bb277 4328@opindex dumpversion
1f0c3120
JM
4329Print the compiler version (for example, @samp{3.0})---and don't do
4330anything else.
4331
4332@item -dumpspecs
cd3bb277 4333@opindex dumpspecs
1f0c3120
JM
4334Print the compiler's built-in specs---and don't do anything else. (This
4335is used when GCC itself is being built.) @xref{Spec Files}.
73c68f61
SS
4336
4337@item -feliminate-unused-debug-types
4338@opindex feliminate-unused-debug-types
4339Normally, when producing DWARF2 output, GCC will emit debugging
4340information for all types declared in a compilation
4341unit, regardless of whether or not they are actually used
4342in that compilation unit. Sometimes this is useful, such as
4343if, in the debugger, you want to cast a value to a type that is
4344not actually used in your program (but is declared). More often,
4345however, this results in a significant amount of wasted space.
4346With this option, GCC will avoid producing debug symbol output
4347for types that are nowhere used in the source file being compiled.
74291a4b
MM
4348@end table
4349
4350@node Optimize Options
4351@section Options That Control Optimization
4352@cindex optimize options
4353@cindex options, optimization
4354
147d1cd3
JQ
4355These options control various sorts of optimizations.
4356
4357Without any optimization option, the compiler's goal is to reduce the
4358cost of compilation and to make debugging produce the expected
4359results. Statements are independent: if you stop the program with a
4360breakpoint between statements, you can then assign a new value to any
4361variable or change the program counter to any other statement in the
4362function and get exactly the results you would expect from the source
4363code.
4364
4365Turning on optimization flags makes the compiler attempt to improve
4366the performance and/or code size at the expense of compilation time
4367and possibly the ability to debug the program.
4368
a451b0bd 4369The compiler performs optimization based on the knowledge it has of
7797ff53
PB
4370the program. Optimization levels @option{-O2} and above, in
4371particular, enable @emph{unit-at-a-time} mode, which allows the
4372compiler to consider information gained from later functions in
4373the file when compiling a function. Compiling multiple files at
4374once to a single output file in @emph{unit-at-a-time} mode allows
d1bd0ded
GK
4375the compiler to use information gained from all of the files when
4376compiling each of them.
4377
147d1cd3
JQ
4378Not all optimizations are controlled directly by a flag. Only
4379optimizations that have a flag are listed.
74291a4b 4380
2642624b 4381@table @gcctabopt
74291a4b
MM
4382@item -O
4383@itemx -O1
cd3bb277
JM
4384@opindex O
4385@opindex O1
74291a4b
MM
4386Optimize. Optimizing compilation takes somewhat more time, and a lot
4387more memory for a large function.
4388
630d3d5a 4389With @option{-O}, the compiler tries to reduce code size and execution
9c34dbbf
ZW
4390time, without performing any optimizations that take a great deal of
4391compilation time.
74291a4b 4392
daf2f129 4393@option{-O} turns on the following optimization flags:
9a94f7f3 4394@gccoptlist{-fdefer-pop @gol
08711fdf
SB
4395-fdelayed-branch @gol
4396-fguess-branch-probability @gol
4397-fcprop-registers @gol
9a94f7f3 4398-floop-optimize @gol
9a94f7f3
JM
4399-fif-conversion @gol
4400-fif-conversion2 @gol
08711fdf
SB
4401-ftree-ccp @gol
4402-ftree-dce @gol
ec7dea0a 4403-ftree-dominator-opts @gol
08711fdf
SB
4404-ftree-dse @gol
4405-ftree-ter @gol
3c632d89 4406-ftree-lrs @gol
08711fdf
SB
4407-ftree-sra @gol
4408-ftree-copyrename @gol
4409-ftree-fre @gol
4410-ftree-ch @gol
4411-fmerge-constants}
fad893da
JQ
4412
4413@option{-O} also turns on @option{-fomit-frame-pointer} on machines
4414where doing so does not interfere with debugging.
4415
74291a4b 4416@item -O2
cd3bb277 4417@opindex O2
0c2d1a2a 4418Optimize even more. GCC performs nearly all supported optimizations
74291a4b 4419that do not involve a space-speed tradeoff. The compiler does not
630d3d5a
JM
4420perform loop unrolling or function inlining when you specify @option{-O2}.
4421As compared to @option{-O}, this option increases both compilation time
74291a4b
MM
4422and the performance of the generated code.
4423
fad893da
JQ
4424@option{-O2} turns on all optimization flags specified by @option{-O}. It
4425also turns on the following optimization flags:
08711fdf
SB
4426@gccoptlist{-fthread-jumps @gol
4427-fcrossjumping @gol
9a94f7f3 4428-foptimize-sibling-calls @gol
9a94f7f3 4429-fcse-follow-jumps -fcse-skip-blocks @gol
08711fdf 4430-fgcse -fgcse-lm @gol
9a94f7f3 4431-fexpensive-optimizations @gol
08711fdf
SB
4432-fstrength-reduce @gol
4433-frerun-cse-after-loop -frerun-loop-opt @gol
9a94f7f3
JM
4434-fcaller-saves @gol
4435-fpeephole2 @gol
08711fdf
SB
4436-fschedule-insns -fschedule-insns2 @gol
4437-fsched-interblock -fsched-spec @gol
4438-fregmove @gol
9a94f7f3 4439-fstrict-aliasing @gol
08711fdf
SB
4440-fdelete-null-pointer-checks @gol
4441-freorder-blocks -freorder-functions @gol
23a44080 4442-funit-at-a-time @gol
9a94f7f3 4443-falign-functions -falign-jumps @gol
b684a3df 4444-falign-loops -falign-labels @gol
08873e96 4445-ftree-vrp @gol
08711fdf 4446-ftree-pre}
74291a4b 4447
081ca317
BL
4448Please note the warning under @option{-fgcse} about
4449invoking @option{-O2} on programs that use computed gotos.
4450
74291a4b 4451@item -O3
cd3bb277 4452@opindex O3
630d3d5a 4453Optimize yet more. @option{-O3} turns on all optimizations specified by
dafc5b82 4454@option{-O2} and also turns on the @option{-finline-functions},
08711fdf 4455@option{-funswitch-loops} and @option{-fgcse-after-reload} options.
74291a4b
MM
4456
4457@item -O0
cd3bb277 4458@opindex O0
fad893da 4459Do not optimize. This is the default.
74291a4b 4460
c6aded7c 4461@item -Os
cd3bb277 4462@opindex Os
630d3d5a 4463Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
c6aded7c
AG
4464do not typically increase code size. It also performs further
4465optimizations designed to reduce code size.
4466
fad893da 4467@option{-Os} disables the following optimization flags:
9a94f7f3 4468@gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
c12cc930
KB
4469-falign-labels -freorder-blocks -freorder-blocks-and-partition @gol
4470-fprefetch-loop-arrays -ftree-vect-loop-version}
fad893da 4471
630d3d5a 4472If you use multiple @option{-O} options, with or without level numbers,
74291a4b
MM
4473the last such option is the one that is effective.
4474@end table
4475
630d3d5a 4476Options of the form @option{-f@var{flag}} specify machine-independent
74291a4b 4477flags. Most flags have both positive and negative forms; the negative
147d1cd3
JQ
4478form of @option{-ffoo} would be @option{-fno-foo}. In the table
4479below, only one of the forms is listed---the one you typically will
4480use. You can figure out the other form by either removing @samp{no-}
4481or adding it.
4482
4483The following options control specific optimizations. They are either
4484activated by @option{-O} options or are related to ones that are. You
4485can use the following flags in the rare cases when ``fine-tuning'' of
4486optimizations to be performed is desired.
74291a4b 4487
2642624b 4488@table @gcctabopt
74291a4b 4489@item -fno-default-inline
cd3bb277 4490@opindex fno-default-inline
74291a4b
MM
4491Do not make member functions inline by default merely because they are
4492defined inside the class scope (C++ only). Otherwise, when you specify
630d3d5a 4493@w{@option{-O}}, member functions defined inside class scope are compiled
74291a4b
MM
4494inline by default; i.e., you don't need to add @samp{inline} in front of
4495the member function name.
4496
4497@item -fno-defer-pop
cd3bb277 4498@opindex fno-defer-pop
74291a4b
MM
4499Always pop the arguments to each function call as soon as that function
4500returns. For machines which must pop arguments after a function call,
4501the compiler normally lets arguments accumulate on the stack for several
4502function calls and pops them all at once.
4503
38df970e
JQ
4504Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4505
74291a4b 4506@item -fforce-mem
cd3bb277 4507@opindex fforce-mem
74291a4b
MM
4508Force memory operands to be copied into registers before doing
4509arithmetic on them. This produces better code by making all memory
4510references potential common subexpressions. When they are not common
4511subexpressions, instruction combination should eliminate the separate
1d8eeb63 4512register-load. This option is now a nop and will be removed in 4.2.
74291a4b
MM
4513
4514@item -fforce-addr
cd3bb277 4515@opindex fforce-addr
74291a4b 4516Force memory address constants to be copied into registers before
1d8eeb63 4517doing arithmetic on them.
74291a4b
MM
4518
4519@item -fomit-frame-pointer
cd3bb277 4520@opindex fomit-frame-pointer
74291a4b
MM
4521Don't keep the frame pointer in a register for functions that
4522don't need one. This avoids the instructions to save, set up and
4523restore frame pointers; it also makes an extra register available
4524in many functions. @strong{It also makes debugging impossible on
4525some machines.}
4526
8aeea6e6 4527On some machines, such as the VAX, this flag has no effect, because
74291a4b
MM
4528the standard calling sequence automatically handles the frame pointer
4529and nothing is saved by pretending it doesn't exist. The
4530machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4531whether a target machine supports this flag. @xref{Registers,,Register
b11cc610 4532Usage, gccint, GNU Compiler Collection (GCC) Internals}.
74291a4b 4533
38df970e
JQ
4534Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4535
1aaef9c1 4536@item -foptimize-sibling-calls
cd3bb277 4537@opindex foptimize-sibling-calls
1aaef9c1
JH
4538Optimize sibling and tail recursive calls.
4539
38df970e
JQ
4540Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4541
74291a4b 4542@item -fno-inline
cd3bb277 4543@opindex fno-inline
74291a4b
MM
4544Don't pay attention to the @code{inline} keyword. Normally this option
4545is used to keep the compiler from expanding any functions inline.
4546Note that if you are not optimizing, no functions can be expanded inline.
4547
4548@item -finline-functions
cd3bb277 4549@opindex finline-functions
74291a4b
MM
4550Integrate all simple functions into their callers. The compiler
4551heuristically decides which functions are simple enough to be worth
4552integrating in this way.
4553
4554If all calls to a given function are integrated, and the function is
4555declared @code{static}, then the function is normally not output as
4556assembler code in its own right.
4557
38df970e 4558Enabled at level @option{-O3}.
355866de
RG
4559
4560@item -finline-functions-called-once
4561@opindex finline-functions-called-once
4562Consider all @code{static} functions called once for inlining into their
4563caller even if they are not marked @code{inline}. If a call to a given
4564function is integrated, then the function is not output as assembler code
4565in its own right.
4566
4567Enabled if @option{-funit-at-a-time} is enabled.
38df970e 4568
d63db217
JH
4569@item -fearly-inlining
4570@opindex fearly-inlining
4571Inline functions marked by @code{always_inline} and functions whose body seems
4572smaller than the function call overhead early before doing
4573@option{-fprofile-generate} instrumentation and real inlining pass. Doing so
4574makes profiling significantly cheaper and usually inlining faster on programs
4575having large chains of nested wrapper functions.
4576
4577Enabled by default.
4578
efa3896a 4579@item -finline-limit=@var{n}
cd3bb277 4580@opindex finline-limit
2dd76960 4581By default, GCC limits the size of functions that can be inlined. This flag
f9e814f1 4582allows the control of this limit for functions that are explicitly marked as
3364c33b 4583inline (i.e., marked with the inline keyword or defined within the class
02f52e19 4584definition in c++). @var{n} is the size of functions that can be inlined in
f9e814f1 4585number of pseudo instructions (not counting parameter handling). The default
93ee12c4
GP
4586value of @var{n} is 600.
4587Increasing this value can result in more inlined code at
f9e814f1 4588the cost of compilation time and memory consumption. Decreasing usually makes
02f52e19
AJ
4589the compilation faster and less code will be inlined (which presumably
4590means slower programs). This option is particularly useful for programs that
aee96fe9 4591use inlining heavily such as those based on recursive templates with C++.
f9e814f1 4592
bc522472
KG
4593Inlining is actually controlled by a number of parameters, which may be
4594specified individually by using @option{--param @var{name}=@var{value}}.
daf2f129 4595The @option{-finline-limit=@var{n}} option sets some of these parameters
bc522472
KG
4596as follows:
4597
4598@table @gcctabopt
bc522472
KG
4599 @item max-inline-insns-single
4600 is set to @var{n}/2.
6d7fe8b3 4601 @item max-inline-insns-auto
bc522472
KG
4602 is set to @var{n}/2.
4603 @item min-inline-insns
4604 is set to 130 or @var{n}/4, whichever is smaller.
4605 @item max-inline-insns-rtl
4606 is set to @var{n}.
4607@end table
4608
f7a01847 4609See below for a documentation of the individual
bc522472
KG
4610parameters controlling inlining.
4611
f9e814f1 4612@emph{Note:} pseudo instruction represents, in this particular context, an
0fa2e4df 4613abstract measurement of function's size. In no way does it represent a count
f9e814f1
TP
4614of assembly instructions and as such its exact meaning might change from one
4615release to an another.
4616
74291a4b 4617@item -fkeep-inline-functions
cd3bb277 4618@opindex fkeep-inline-functions
1a10290c
MM
4619In C, emit @code{static} functions that are declared @code{inline}
4620into the object file, even if the function has been inlined into all
4621of its callers. This switch does not affect functions using the
8a36672b 4622@code{extern inline} extension in GNU C@. In C++, emit any and all
1a10290c 4623inline functions into the object file.
74291a4b
MM
4624
4625@item -fkeep-static-consts
cd3bb277 4626@opindex fkeep-static-consts
74291a4b
MM
4627Emit variables declared @code{static const} when optimization isn't turned
4628on, even if the variables aren't referenced.
4629
0c2d1a2a 4630GCC enables this option by default. If you want to force the compiler to
74291a4b 4631check if the variable was referenced, regardless of whether or not
630d3d5a 4632optimization is turned on, use the @option{-fno-keep-static-consts} option.
74291a4b 4633
201556f0
JJ
4634@item -fmerge-constants
4635Attempt to merge identical constants (string constants and floating point
3364c33b 4636constants) across compilation units.
201556f0 4637
3364c33b
JQ
4638This option is the default for optimized compilation if the assembler and
4639linker support it. Use @option{-fno-merge-constants} to inhibit this
4640behavior.
201556f0 4641
38df970e
JQ
4642Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4643
201556f0
JJ
4644@item -fmerge-all-constants
4645Attempt to merge identical constants and identical variables.
4646
4647This option implies @option{-fmerge-constants}. In addition to
431ae0bf 4648@option{-fmerge-constants} this considers e.g.@: even constant initialized
201556f0
JJ
4649arrays or initialized constant variables with integral or floating point
4650types. Languages like C or C++ require each non-automatic variable to
4651have distinct location, so using this option will result in non-conforming
c21cd8b1 4652behavior.
201556f0 4653
e5626198
AZ
4654@item -fmodulo-sched
4655@opindex fmodulo-sched
4656Perform swing modulo scheduling immediately before the first scheduling
4657pass. This pass looks at innermost loops and reorders their
4658instructions by overlapping different iterations.
4659
e03b7153
RS
4660@item -fno-branch-count-reg
4661@opindex fno-branch-count-reg
4662Do not use ``decrement and branch'' instructions on a count register,
4663but instead generate a sequence of instructions that decrement a
4664register, compare it against zero, then branch based upon the result.
4665This option is only meaningful on architectures that support such
4666instructions, which include x86, PowerPC, IA-64 and S/390.
4667
38df970e
JQ
4668The default is @option{-fbranch-count-reg}, enabled when
4669@option{-fstrength-reduce} is enabled.
4670
74291a4b 4671@item -fno-function-cse
cd3bb277 4672@opindex fno-function-cse
74291a4b
MM
4673Do not put function addresses in registers; make each instruction that
4674calls a constant function contain the function's address explicitly.
4675
4676This option results in less efficient code, but some strange hacks
4677that alter the assembler output may be confused by the optimizations
4678performed when this option is not used.
4679
38df970e
JQ
4680The default is @option{-ffunction-cse}
4681
27b41650
KG
4682@item -fno-zero-initialized-in-bss
4683@opindex fno-zero-initialized-in-bss
4684If the target supports a BSS section, GCC by default puts variables that
4685are initialized to zero into BSS@. This can save space in the resulting
4686code.
4687
4688This option turns off this behavior because some programs explicitly
4689rely on variables going to the data section. E.g., so that the
4690resulting executable can find the beginning of that section and/or make
4691assumptions based on that.
4692
4693The default is @option{-fzero-initialized-in-bss}.
e03b7153 4694
6de9cd9a
DN
4695@item -fbounds-check
4696@opindex fbounds-check
4697For front-ends that support it, generate additional code to check that
4698indices used to access arrays are within the declared range. This is
4699currently only supported by the Java and Fortran front-ends, where
4700this option defaults to true and false respectively.
4701
4702@item -fmudflap -fmudflapth -fmudflapir
4703@opindex fmudflap
4704@opindex fmudflapth
4705@opindex fmudflapir
4706@cindex bounds checking
4707@cindex mudflap
4708For front-ends that support it (C and C++), instrument all risky
4709pointer/array dereferencing operations, some standard library
4710string/heap functions, and some other associated constructs with
4711range/validity tests. Modules so instrumented should be immune to
4712buffer overflows, invalid heap use, and some other classes of C/C++
4713programming errors. The instrumentation relies on a separate runtime
4714library (@file{libmudflap}), which will be linked into a program if
4715@option{-fmudflap} is given at link time. Run-time behavior of the
4716instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4717environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4718for its options.
4719
4720Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4721link if your program is multi-threaded. Use @option{-fmudflapir}, in
4722addition to @option{-fmudflap} or @option{-fmudflapth}, if
4723instrumentation should ignore pointer reads. This produces less
4724instrumentation (and therefore faster execution) and still provides
4725some protection against outright memory corrupting writes, but allows
4726erroneously read data to propagate within a program.
4727
953ff289
DN
4728@item -fopenmp
4729@opindex fopenmp
4730@cindex openmp parallel
4731Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
4732@code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
4733compiler generates parallel code according to the OpenMP Application
4734Program Interface v2.5. To generate the final exectuable, the runtime
4735library @code{libgomp} must be linked in using @option{-lgomp}.
4736
74291a4b 4737@item -fstrength-reduce
cd3bb277 4738@opindex fstrength-reduce
74291a4b
MM
4739Perform the optimizations of loop strength reduction and
4740elimination of iteration variables.
4741
38df970e
JQ
4742Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4743
74291a4b 4744@item -fthread-jumps
cd3bb277 4745@opindex fthread-jumps
74291a4b
MM
4746Perform optimizations where we check to see if a jump branches to a
4747location where another comparison subsumed by the first is found. If
4748so, the first branch is redirected to either the destination of the
4749second branch or a point immediately following it, depending on whether
4750the condition is known to be true or false.
4751
08711fdf 4752Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
38df970e 4753
74291a4b 4754@item -fcse-follow-jumps
cd3bb277 4755@opindex fcse-follow-jumps
74291a4b
MM
4756In common subexpression elimination, scan through jump instructions
4757when the target of the jump is not reached by any other path. For
4758example, when CSE encounters an @code{if} statement with an
4759@code{else} clause, CSE will follow the jump when the condition
4760tested is false.
4761
38df970e
JQ
4762Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4763
74291a4b 4764@item -fcse-skip-blocks
cd3bb277 4765@opindex fcse-skip-blocks
630d3d5a 4766This is similar to @option{-fcse-follow-jumps}, but causes CSE to
74291a4b
MM
4767follow jumps which conditionally skip over blocks. When CSE
4768encounters a simple @code{if} statement with no else clause,
630d3d5a 4769@option{-fcse-skip-blocks} causes CSE to follow the jump around the
74291a4b
MM
4770body of the @code{if}.
4771
38df970e
JQ
4772Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4773
74291a4b 4774@item -frerun-cse-after-loop
cd3bb277 4775@opindex frerun-cse-after-loop
74291a4b
MM
4776Re-run common subexpression elimination after loop optimizations has been
4777performed.
4778
38df970e
JQ
4779Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4780
6d6d0fa0 4781@item -frerun-loop-opt
cd3bb277 4782@opindex frerun-loop-opt
6d6d0fa0
JL
4783Run the loop optimizer twice.
4784
38df970e
JQ
4785Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4786
7506f491 4787@item -fgcse
cd3bb277 4788@opindex fgcse
7506f491
DE
4789Perform a global common subexpression elimination pass.
4790This pass also performs global constant and copy propagation.
4791
081ca317
BL
4792@emph{Note:} When compiling a program using computed gotos, a GCC
4793extension, you may get better runtime performance if you disable
3364c33b 4794the global common subexpression elimination pass by adding
081ca317
BL
4795@option{-fno-gcse} to the command line.
4796
38df970e
JQ
4797Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4798
a13d4ebf 4799@item -fgcse-lm
cd3bb277 4800@opindex fgcse-lm
695ac33f 4801When @option{-fgcse-lm} is enabled, global common subexpression elimination will
767094dd 4802attempt to move loads which are only killed by stores into themselves. This
a13d4ebf 4803allows a loop containing a load/store sequence to be changed to a load outside
02f52e19 4804the loop, and a copy/store within the loop.
a13d4ebf 4805
38df970e
JQ
4806Enabled by default when gcse is enabled.
4807
a13d4ebf 4808@item -fgcse-sm
cd3bb277 4809@opindex fgcse-sm
f5f2e3cd
MH
4810When @option{-fgcse-sm} is enabled, a store motion pass is run after
4811global common subexpression elimination. This pass will attempt to move
4812stores out of loops. When used in conjunction with @option{-fgcse-lm},
4813loops containing a load/store sequence can be changed to a load before
4814the loop and a store after the loop.
4815
08711fdf 4816Not enabled at any optimization level.
f5f2e3cd
MH
4817
4818@item -fgcse-las
4819@opindex fgcse-las
4820When @option{-fgcse-las} is enabled, the global common subexpression
4821elimination pass eliminates redundant loads that come after stores to the
2206e783 4822same memory location (both partial and full redundancies).
a13d4ebf 4823
08711fdf 4824Not enabled at any optimization level.
38df970e 4825
db643b91
SH
4826@item -fgcse-after-reload
4827@opindex fgcse-after-reload
4828When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8a36672b 4829pass is performed after reload. The purpose of this pass is to cleanup
db643b91
SH
4830redundant spilling.
4831
96327cdc
JH
4832@item -floop-optimize
4833@opindex floop-optimize
4834Perform loop optimizations: move constant expressions out of loops, simplify
c94583fe 4835exit test conditions and optionally do strength-reduction as well.
96327cdc 4836
38df970e
JQ
4837Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4838
f9cc1a70
PB
4839@item -funsafe-loop-optimizations
4840@opindex funsafe-loop-optimizations
4841If given, the loop optimizer will assume that loop indices do not
4842overflow, and that the loops with nontrivial exit condition are not
4843infinite. This enables a wider range of loop optimizations even if
4844the loop optimizer itself cannot prove that these assumptions are valid.
4845Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4846if it finds this kind of loop.
4847
96327cdc
JH
4848@item -fcrossjumping
4849@opindex crossjumping
8a36672b 4850Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
96327cdc
JH
4851resulting code may or may not perform better than without cross-jumping.
4852
53071270 4853Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
38df970e 4854
2c4b77f3
JH
4855@item -fif-conversion
4856@opindex if-conversion
4857Attempt to transform conditional jumps into branch-less equivalents. This
4858include use of conditional moves, min, max, set flags and abs instructions, and
4859some tricks doable by standard arithmetics. The use of conditional execution
4860on chips where it is available is controlled by @code{if-conversion2}.
4861
38df970e
JQ
4862Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4863
2c4b77f3
JH
4864@item -fif-conversion2
4865@opindex if-conversion2
4866Use conditional execution (where available) to transform conditional jumps into
4867branch-less equivalents.
4868
38df970e
JQ
4869Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4870
b6d24183 4871@item -fdelete-null-pointer-checks
cd3bb277 4872@opindex fdelete-null-pointer-checks
9c34dbbf
ZW
4873Use global dataflow analysis to identify and eliminate useless checks
4874for null pointers. The compiler assumes that dereferencing a null
4875pointer would have halted the program. If a pointer is checked after
4876it has already been dereferenced, it cannot be null.
4877
4878In some environments, this assumption is not true, and programs can
4879safely dereference null pointers. Use
4880@option{-fno-delete-null-pointer-checks} to disable this optimization
4881for programs which depend on that behavior.
b6d24183 4882
38df970e
JQ
4883Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4884
74291a4b 4885@item -fexpensive-optimizations
cd3bb277 4886@opindex fexpensive-optimizations
74291a4b
MM
4887Perform a number of minor optimizations that are relatively expensive.
4888
38df970e
JQ
4889Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4890
639726ba 4891@item -foptimize-register-move
59d40964 4892@itemx -fregmove
cd3bb277
JM
4893@opindex foptimize-register-move
4894@opindex fregmove
9ec36da5
JL
4895Attempt to reassign register numbers in move instructions and as
4896operands of other simple instructions in order to maximize the amount of
56159047 4897register tying. This is especially helpful on machines with two-operand
38df970e 4898instructions.
9ec36da5 4899
bedc7537 4900Note @option{-fregmove} and @option{-foptimize-register-move} are the same
9ec36da5
JL
4901optimization.
4902
38df970e
JQ
4903Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4904
74291a4b 4905@item -fdelayed-branch
cd3bb277 4906@opindex fdelayed-branch
74291a4b
MM
4907If supported for the target machine, attempt to reorder instructions
4908to exploit instruction slots available after delayed branch
4909instructions.
4910
38df970e
JQ
4911Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4912
74291a4b 4913@item -fschedule-insns
cd3bb277 4914@opindex fschedule-insns
74291a4b
MM
4915If supported for the target machine, attempt to reorder instructions to
4916eliminate execution stalls due to required data being unavailable. This
4917helps machines that have slow floating point or memory load instructions
4918by allowing other instructions to be issued until the result of the load
4919or floating point instruction is required.
4920
38df970e
JQ
4921Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4922
74291a4b 4923@item -fschedule-insns2
cd3bb277 4924@opindex fschedule-insns2
630d3d5a 4925Similar to @option{-fschedule-insns}, but requests an additional pass of
74291a4b
MM
4926instruction scheduling after register allocation has been done. This is
4927especially useful on machines with a relatively small number of
4928registers and where memory load instructions take more than one cycle.
4929
38df970e
JQ
4930Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4931
e03b7153
RS
4932@item -fno-sched-interblock
4933@opindex fno-sched-interblock
4934Don't schedule instructions across basic blocks. This is normally
4935enabled by default when scheduling before register allocation, i.e.@:
4936with @option{-fschedule-insns} or at @option{-O2} or higher.
4937
4938@item -fno-sched-spec
4939@opindex fno-sched-spec
4940Don't allow speculative motion of non-load instructions. This is normally
4941enabled by default when scheduling before register allocation, i.e.@:
4942with @option{-fschedule-insns} or at @option{-O2} or higher.
4943
4944@item -fsched-spec-load
4945@opindex fsched-spec-load
4946Allow speculative motion of some load instructions. This only makes
4947sense when scheduling before register allocation, i.e.@: with
4948@option{-fschedule-insns} or at @option{-O2} or higher.
4949
4950@item -fsched-spec-load-dangerous
4951@opindex fsched-spec-load-dangerous
4952Allow speculative motion of more load instructions. This only makes
4953sense when scheduling before register allocation, i.e.@: with
4954@option{-fschedule-insns} or at @option{-O2} or higher.
4955
569fa502
DN
4956@item -fsched-stalled-insns=@var{n}
4957@opindex fsched-stalled-insns
4958Define how many insns (if any) can be moved prematurely from the queue
4959of stalled insns into the ready list, during the second scheduling pass.
4960
4961@item -fsched-stalled-insns-dep=@var{n}
4962@opindex fsched-stalled-insns-dep
daf2f129
JM
4963Define how many insn groups (cycles) will be examined for a dependency
4964on a stalled insn that is candidate for premature removal from the queue
4965of stalled insns. Has an effect only during the second scheduling pass,
569fa502
DN
4966and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4967
b9422b69
JH
4968@item -fsched2-use-superblocks
4969@opindex fsched2-use-superblocks
61aeb06f 4970When scheduling after register allocation, do use superblock scheduling
62b9c42c 4971algorithm. Superblock scheduling allows motion across basic block boundaries
b9422b69 4972resulting on faster schedules. This option is experimental, as not all machine
62b9c42c 4973descriptions used by GCC model the CPU closely enough to avoid unreliable
daf2f129 4974results from the algorithm.
b9422b69
JH
4975
4976This only makes sense when scheduling after register allocation, i.e.@: with
4977@option{-fschedule-insns2} or at @option{-O2} or higher.
4978
4979@item -fsched2-use-traces
4980@opindex fsched2-use-traces
4981Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4982allocation and additionally perform code duplication in order to increase the
4983size of superblocks using tracer pass. See @option{-ftracer} for details on
4984trace formation.
4985
62b9c42c 4986This mode should produce faster but significantly longer programs. Also
4ec7afd7
KH
4987without @option{-fbranch-probabilities} the traces constructed may not
4988match the reality and hurt the performance. This only makes
b9422b69
JH
4989sense when scheduling after register allocation, i.e.@: with
4990@option{-fschedule-insns2} or at @option{-O2} or higher.
4991
d72372e4
MH
4992@item -freschedule-modulo-scheduled-loops
4993@opindex fscheduling-in-modulo-scheduled-loops
4994The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4995we may want to prevent the later scheduling passes from changing its schedule, we use this
4996option to control that.
4997
74291a4b 4998@item -fcaller-saves
cd3bb277 4999@opindex fcaller-saves
74291a4b
MM
5000Enable values to be allocated in registers that will be clobbered by
5001function calls, by emitting extra instructions to save and restore the
5002registers around such calls. Such allocation is done only when it
5003seems to result in better code than would otherwise be produced.
5004
81610a0d
HPN
5005This option is always enabled by default on certain machines, usually
5006those which have no call-preserved registers to use instead.
5007
38df970e 5008Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
74291a4b 5009
6de9cd9a
DN
5010@item -ftree-pre
5011Perform Partial Redundancy Elimination (PRE) on trees. This flag is
08711fdf 5012enabled by default at @option{-O2} and @option{-O3}.
ff2ad0f7
DN
5013
5014@item -ftree-fre
5015Perform Full Redundancy Elimination (FRE) on trees. The difference
5016between FRE and PRE is that FRE only considers expressions
5017that are computed on all paths leading to the redundant computation.
5018This analysis faster than PRE, though it exposes fewer redundancies.
4ec7afd7 5019This flag is enabled by default at @option{-O} and higher.
6de9cd9a 5020
0bca51f0
DN
5021@item -ftree-copy-prop
5022Perform copy propagation on trees. This pass eliminates unnecessary
5023copy operations. This flag is enabled by default at @option{-O} and
5024higher.
5025
5026@item -ftree-store-copy-prop
5027Perform copy propagation of memory loads and stores. This pass
5028eliminates unnecessary copy operations in memory references
5029(structures, global variables, arrays, etc). This flag is enabled by
5030default at @option{-O2} and higher.
5031
c75ab022
DB
5032@item -ftree-salias
5033Perform structural alias analysis on trees. This flag
5034is enabled by default at @option{-O} and higher.
5035
fa555252
DB
5036@item -ftree-sink
5037Perform forward store motion on trees. This flag is
5038enabled by default at @option{-O} and higher.
5039
6de9cd9a 5040@item -ftree-ccp
0bca51f0
DN
5041Perform sparse conditional constant propagation (CCP) on trees. This
5042pass only operates on local scalar variables and is enabled by default
5043at @option{-O} and higher.
5044
5045@item -ftree-store-ccp
5046Perform sparse conditional constant propagation (CCP) on trees. This
5047pass operates on both local scalar variables and memory stores and
5048loads (global variables, structures, arrays, etc). This flag is
5049enabled by default at @option{-O2} and higher.
6de9cd9a
DN
5050
5051@item -ftree-dce
5052Perform dead code elimination (DCE) on trees. This flag is enabled by
4ec7afd7 5053default at @option{-O} and higher.
6de9cd9a
DN
5054
5055@item -ftree-dominator-opts
5c1c631e
DN
5056Perform a variety of simple scalar cleanups (constant/copy
5057propagation, redundancy elimination, range propagation and expression
5058simplification) based on a dominator tree traversal. This also
5059performs jump threading (to reduce jumps to jumps). This flag is
5060enabled by default at @option{-O} and higher.
6de9cd9a
DN
5061
5062@item -ftree-ch
5063Perform loop header copying on trees. This is beneficial since it increases
83c99486 5064effectiveness of code motion optimizations. It also saves one jump. This flag
4ec7afd7
KH
5065is enabled by default at @option{-O} and higher. It is not enabled
5066for @option{-Os}, since it usually increases code size.
6de9cd9a 5067
c66b6c66 5068@item -ftree-loop-optimize
4ec7afd7
KH
5069Perform loop optimizations on trees. This flag is enabled by default
5070at @option{-O} and higher.
c66b6c66 5071
599eabdb 5072@item -ftree-loop-linear
8a36672b 5073Perform linear loop transformations on tree. This flag can improve cache
599eabdb
DB
5074performance and allow further loop optimizations to take place.
5075
3450cbc4
DJ
5076@item -ftree-loop-im
5077Perform loop invariant motion on trees. This pass moves only invariants that
ec7dea0a 5078would be hard to handle at RTL level (function calls, operations that expand to
a7e5372d
ZD
5079nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
5080operands of conditions that are invariant out of the loop, so that we can use
5081just trivial invariantness analysis in loop unswitching. The pass also includes
5082store motion.
5083
3450cbc4 5084@item -ftree-loop-ivcanon
82b85a85
ZD
5085Create a canonical counter for number of iterations in the loop for that
5086determining number of iterations requires complicated analysis. Later
5087optimizations then may determine the number easily. Useful especially
5088in connection with unrolling.
5089
8b11a64c
ZD
5090@item -fivopts
5091Perform induction variable optimizations (strength reduction, induction
5092variable merging and induction variable elimination) on trees.
5093
6de9cd9a
DN
5094@item -ftree-sra
5095Perform scalar replacement of aggregates. This pass replaces structure
5096references with scalars to prevent committing structures to memory too
4ec7afd7 5097early. This flag is enabled by default at @option{-O} and higher.
6de9cd9a
DN
5098
5099@item -ftree-copyrename
f26c1794
EC
5100Perform copy renaming on trees. This pass attempts to rename compiler
5101temporaries to other variables at copy locations, usually resulting in
5102variable names which more closely resemble the original variables. This flag
4ec7afd7 5103is enabled by default at @option{-O} and higher.
6de9cd9a
DN
5104
5105@item -ftree-ter
5106Perform temporary expression replacement during the SSA->normal phase. Single
f26c1794
EC
5107use/single def temporaries are replaced at their use location with their
5108defining expression. This results in non-GIMPLE code, but gives the expanders
6de9cd9a 5109much more complex trees to work on resulting in better RTL generation. This is
4ec7afd7 5110enabled by default at @option{-O} and higher.
6de9cd9a
DN
5111
5112@item -ftree-lrs
f26c1794
EC
5113Perform live range splitting during the SSA->normal phase. Distinct live
5114ranges of a variable are split into unique variables, allowing for better
4ec7afd7 5115optimization later. This is enabled by default at @option{-O} and higher.
6de9cd9a 5116
79fe1b3b
DN
5117@item -ftree-vectorize
5118Perform loop vectorization on trees.
5119
c12cc930
KB
5120@item -ftree-vect-loop-version
5121@opindex ftree-vect-loop-version
5122Perform loop versioning when doing loop vectorization on trees. When a loop
5123appears to be vectorizable except that data alignment or data dependence cannot
5124be determined at compile time then vectorized and non-vectorized versions of
5125the loop are generated along with runtime checks for alignment or dependence
5126to control which version is executed. This option is enabled by default
5127except at level @option{-Os} where it is disabled.
5128
08873e96
DN
5129@item -ftree-vrp
5130Perform Value Range Propagation on trees. This is similar to the
5131constant propagation pass, but instead of values, ranges of values are
5132propagated. This allows the optimizers to remove unnecessary range
5133checks like array bound checks and null pointer checks. This is
5134enabled by default at @option{-O2} and higher. Null pointer check
5135elimination is only done if @option{-fdelete-null-pointer-checks} is
5136enabled.
5137
6de9cd9a
DN
5138@item -ftracer
5139@opindex ftracer
8a36672b 5140Perform tail duplication to enlarge superblock size. This transformation
6de9cd9a
DN
5141simplifies the control flow of the function allowing other optimizations to do
5142better job.
5143
5144@item -funroll-loops
5145@opindex funroll-loops
5146Unroll loops whose number of iterations can be determined at compile
5147time or upon entry to the loop. @option{-funroll-loops} implies both
5148@option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
5149option makes code larger, and may or may not make it run faster.
5150
5151@item -funroll-all-loops
5152@opindex funroll-all-loops
5153Unroll all loops, even if their number of iterations is uncertain when
5154the loop is entered. This usually makes programs run more slowly.
5155@option{-funroll-all-loops} implies the same options as
5156@option{-funroll-loops},
5157
113d659a
ZD
5158@item -fsplit-ivs-in-unroller
5159@opindex -fsplit-ivs-in-unroller
5160Enables expressing of values of induction variables in later iterations
5161of the unrolled loop using the value in the first iteration. This breaks
7869fe47 5162long dependency chains, thus improving efficiency of the scheduling passes.
113d659a
ZD
5163
5164Combination of @option{-fweb} and CSE is often sufficient to obtain the
8a36672b 5165same effect. However in cases the loop body is more complicated than
113d659a
ZD
5166a single basic block, this is not reliable. It also does not work at all
5167on some of the architectures due to restrictions in the CSE pass.
5168
5169This optimization is enabled by default.
5170
f37a4f14
RE
5171@item -fvariable-expansion-in-unroller
5172@opindex -fvariable-expansion-in-unroller
f0eb93a8 5173With this option, the compiler will create multiple copies of some
f37a4f14
RE
5174local variables when unrolling a loop which can result in superior code.
5175
6de9cd9a 5176@item -fprefetch-loop-arrays
17684618 5177@itemx -fprefetch-loop-arrays-rtl
6de9cd9a 5178@opindex fprefetch-loop-arrays
17684618 5179@opindex fprefetch-loop-arrays-rtl
6de9cd9a
DN
5180If supported by the target machine, generate instructions to prefetch
5181memory to improve the performance of loops that access large arrays.
5182
e5eb27e5
JL
5183These options may generate better or worse code; results are highly
5184dependent on the structure of loops within the source code.
5185
74291a4b 5186@item -fno-peephole
6cfc0341 5187@itemx -fno-peephole2
cd3bb277 5188@opindex fno-peephole
6cfc0341
RH
5189@opindex fno-peephole2
5190Disable any machine-specific peephole optimizations. The difference
630d3d5a 5191between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6cfc0341
RH
5192are implemented in the compiler; some targets use one, some use the
5193other, a few use both.
861bb6c1 5194
38df970e
JQ
5195@option{-fpeephole} is enabled by default.
5196@option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5197
454d0cc7 5198@item -fno-guess-branch-probability
cd3bb277 5199@opindex fno-guess-branch-probability
ddd8e3ca
JW
5200Do not guess branch probabilities using heuristics.
5201
5202GCC will use heuristics to guess branch probabilities if they are
5203not provided by profiling feedback (@option{-fprofile-arcs}). These
5204heuristics are based on the control flow graph. If some branch probabilities
5205are specified by @samp{__builtin_expect}, then the heuristics will be
5206used to guess branch probabilities for the rest of the control flow graph,
5207taking the @samp{__builtin_expect} info into account. The interactions
5208between the heuristics and @samp{__builtin_expect} can be complex, and in
5209some cases, it may be useful to disable the heuristics so that the effects
5210of @samp{__builtin_expect} are easier to understand.
454d0cc7 5211
38df970e
JQ
5212The default is @option{-fguess-branch-probability} at levels
5213@option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5214
194734e9
JH
5215@item -freorder-blocks
5216@opindex freorder-blocks
5217Reorder basic blocks in the compiled function in order to reduce number of
5218taken branches and improve code locality.
5219
3f8b659d 5220Enabled at levels @option{-O2}, @option{-O3}.
38df970e 5221
750054a2
CT
5222@item -freorder-blocks-and-partition
5223@opindex freorder-blocks-and-partition
5224In addition to reordering basic blocks in the compiled function, in order
5225to reduce number of taken branches, partitions hot and cold basic blocks
5226into separate sections of the assembly and .o files, to improve
5227paging and cache locality performance.
5228
8e8d5162
CT
5229This optimization is automatically turned off in the presence of
5230exception handling, for linkonce sections, for functions with a user-defined
5231section attribute and on any architecture that does not support named
5232sections.
5233
194734e9
JH
5234@item -freorder-functions
5235@opindex freorder-functions
3e8cb558
JM
5236Reorder functions in the object file in order to
5237improve code locality. This is implemented by using special
3a4bdd05
RH
5238subsections @code{.text.hot} for most frequently executed functions and
5239@code{.text.unlikely} for unlikely executed functions. Reordering is done by
194734e9 5240the linker so object file format must support named sections and linker must
3364c33b 5241place them in a reasonable way.
194734e9
JH
5242
5243Also profile feedback must be available in to make this option effective. See
5244@option{-fprofile-arcs} for details.
5245
38df970e
JQ
5246Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5247
41472af8 5248@item -fstrict-aliasing
cd3bb277 5249@opindex fstrict-aliasing
41472af8
MM
5250Allows the compiler to assume the strictest aliasing rules applicable to
5251the language being compiled. For C (and C++), this activates
5252optimizations based on the type of expressions. In particular, an
5253object of one type is assumed never to reside at the same address as an
5254object of a different type, unless the types are almost the same. For
5255example, an @code{unsigned int} can alias an @code{int}, but not a
5256@code{void*} or a @code{double}. A character type may alias any other
02f52e19 5257type.
41472af8
MM
5258
5259Pay special attention to code like this:
3ab51846 5260@smallexample
02f52e19 5261union a_union @{
41472af8
MM
5262 int i;
5263 double d;
5264@};
5265
5266int f() @{
5267 a_union t;
5268 t.d = 3.0;
5269 return t.i;
5270@}
3ab51846 5271@end smallexample
41472af8
MM
5272The practice of reading from a different union member than the one most
5273recently written to (called ``type-punning'') is common. Even with
630d3d5a 5274@option{-fstrict-aliasing}, type-punning is allowed, provided the memory
41472af8
MM
5275is accessed through the union type. So, the code above will work as
5276expected. However, this code might not:
3ab51846 5277@smallexample
02f52e19 5278int f() @{
41472af8
MM
5279 a_union t;
5280 int* ip;
5281 t.d = 3.0;
5282 ip = &t.i;
5283 return *ip;
5284@}
3ab51846 5285@end smallexample
41472af8 5286
41472af8
MM
5287Every language that wishes to perform language-specific alias analysis
5288should define a function that computes, given an @code{tree}
5289node, an alias set for the node. Nodes in different alias sets are not
5290allowed to alias. For an example, see the C front-end function
5291@code{c_get_alias_set}.
41472af8 5292
38df970e 5293Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
852b81bb 5294
efa3896a
GK
5295@item -falign-functions
5296@itemx -falign-functions=@var{n}
cd3bb277 5297@opindex falign-functions
efa3896a
GK
5298Align the start of functions to the next power-of-two greater than
5299@var{n}, skipping up to @var{n} bytes. For instance,
630d3d5a
JM
5300@option{-falign-functions=32} aligns functions to the next 32-byte
5301boundary, but @option{-falign-functions=24} would align to the next
efa3896a
GK
530232-byte boundary only if this can be done by skipping 23 bytes or less.
5303
630d3d5a 5304@option{-fno-align-functions} and @option{-falign-functions=1} are
efa3896a
GK
5305equivalent and mean that functions will not be aligned.
5306
5307Some assemblers only support this flag when @var{n} is a power of two;
5308in that case, it is rounded up.
5309
561913cb 5310If @var{n} is not specified or is zero, use a machine-dependent default.
efa3896a 5311
38df970e
JQ
5312Enabled at levels @option{-O2}, @option{-O3}.
5313
efa3896a
GK
5314@item -falign-labels
5315@itemx -falign-labels=@var{n}
cd3bb277 5316@opindex falign-labels
efa3896a 5317Align all branch targets to a power-of-two boundary, skipping up to
630d3d5a 5318@var{n} bytes like @option{-falign-functions}. This option can easily
efa3896a
GK
5319make code slower, because it must insert dummy operations for when the
5320branch target is reached in the usual flow of the code.
5321
561913cb
AP
5322@option{-fno-align-labels} and @option{-falign-labels=1} are
5323equivalent and mean that labels will not be aligned.
5324
630d3d5a 5325If @option{-falign-loops} or @option{-falign-jumps} are applicable and
efa3896a
GK
5326are greater than this value, then their values are used instead.
5327
561913cb
AP
5328If @var{n} is not specified or is zero, use a machine-dependent default
5329which is very likely to be @samp{1}, meaning no alignment.
efa3896a 5330
38df970e
JQ
5331Enabled at levels @option{-O2}, @option{-O3}.
5332
efa3896a
GK
5333@item -falign-loops
5334@itemx -falign-loops=@var{n}
cd3bb277 5335@opindex falign-loops
efa3896a 5336Align loops to a power-of-two boundary, skipping up to @var{n} bytes
630d3d5a 5337like @option{-falign-functions}. The hope is that the loop will be
efa3896a
GK
5338executed many times, which will make up for any execution of the dummy
5339operations.
5340
561913cb
AP
5341@option{-fno-align-loops} and @option{-falign-loops=1} are
5342equivalent and mean that loops will not be aligned.
5343
5344If @var{n} is not specified or is zero, use a machine-dependent default.
efa3896a 5345
38df970e
JQ
5346Enabled at levels @option{-O2}, @option{-O3}.
5347
efa3896a
GK
5348@item -falign-jumps
5349@itemx -falign-jumps=@var{n}
cd3bb277 5350@opindex falign-jumps
efa3896a
GK
5351Align branch targets to a power-of-two boundary, for branch targets
5352where the targets can only be reached by jumping, skipping up to @var{n}
630d3d5a 5353bytes like @option{-falign-functions}. In this case, no dummy operations
efa3896a
GK
5354need be executed.
5355
561913cb
AP
5356@option{-fno-align-jumps} and @option{-falign-jumps=1} are
5357equivalent and mean that loops will not be aligned.
5358
5359If @var{n} is not specified or is zero, use a machine-dependent default.
efa3896a 5360
38df970e
JQ
5361Enabled at levels @option{-O2}, @option{-O3}.
5362
7797ff53
PB
5363@item -funit-at-a-time
5364@opindex funit-at-a-time
5365Parse the whole compilation unit before starting to produce code.
5366This allows some extra optimizations to take place but consumes
5367more memory (in general). There are some compatibility issues
474eccc6 5368with @emph{unit-at-a-time} mode:
7797ff53
PB
5369@itemize @bullet
5370@item
5371enabling @emph{unit-at-a-time} mode may change the order
5372in which functions, variables, and top-level @code{asm} statements
5373are emitted, and will likely break code relying on some particular
5374ordering. The majority of such top-level @code{asm} statements,
474eccc6
ILT
5375though, can be replaced by @code{section} attributes. The
5376@option{fno-toplevel-reorder} option may be used to keep the ordering
5377used in the input file, at the cost of some optimizations.
7797ff53
PB
5378
5379@item
5380@emph{unit-at-a-time} mode removes unreferenced static variables
60d436c9 5381and functions. This may result in undefined references
7797ff53
PB
5382when an @code{asm} statement refers directly to variables or functions
5383that are otherwise unused. In that case either the variable/function
5384shall be listed as an operand of the @code{asm} statement operand or,
5385in the case of top-level @code{asm} statements the attribute @code{used}
5386shall be used on the declaration.
5387
5388@item
5389Static functions now can use non-standard passing conventions that
8a36672b 5390may break @code{asm} statements calling functions directly. Again,
7797ff53
PB
5391attribute @code{used} will prevent this behavior.
5392@end itemize
5393
5394As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
8a36672b 5395but this scheme may not be supported by future releases of GCC@.
7797ff53
PB
5396
5397Enabled at levels @option{-O2}, @option{-O3}.
5398
474eccc6
ILT
5399@item -fno-toplevel-reorder
5400Do not reorder top-level functions, variables, and @code{asm}
5401statements. Output them in the same order that they appear in the
5402input file. When this option is used, unreferenced static variables
5403will not be removed. This option is intended to support existing code
5404which relies on a particular ordering. For new code, it is better to
5405use attributes.
5406
7260e9a0
JH
5407@item -fweb
5408@opindex fweb
5409Constructs webs as commonly used for register allocation purposes and assign
962e6e00 5410each web individual pseudo register. This allows the register allocation pass
7260e9a0
JH
5411to operate on pseudos directly, but also strengthens several other optimization
5412passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5413however, make debugging impossible, since variables will no longer stay in a
5414``home register''.
5415
7869fe47 5416Enabled by default with @option{-funroll-loops}.
d4463dfc 5417
ce91e74c
JH
5418@item -fwhole-program
5419@opindex fwhole-program
5420Assume that the current compilation unit represents whole program being
5421compiled. All public functions and variables with the exception of @code{main}
f341de7b
KH
5422and those merged by attribute @code{externally_visible} become static functions
5423and in a affect gets more aggressively optimized by interprocedural optimizers.
ce91e74c 5424While this option is equivalent to proper use of @code{static} keyword for
f341de7b 5425programs consisting of single file, in combination with option
ce91e74c
JH
5426@option{--combine} this flag can be used to compile most of smaller scale C
5427programs since the functions and variables become local for the whole combined
5428compilation unit, not for the single source file itself.
5429
5430
d4463dfc
JQ
5431@item -fno-cprop-registers
5432@opindex fno-cprop-registers
5433After register allocation and post-register allocation instruction splitting,
5434we perform a copy-propagation pass to try to reduce scheduling dependencies
5435and occasionally eliminate the copy.
5436
5437Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5438
a8a5f53a
JH
5439@item -fprofile-generate
5440@opindex fprofile-generate
a8a5f53a 5441
33adcb6c
MM
5442Enable options usually used for instrumenting application to produce
5443profile useful for later recompilation with profile feedback based
4ec7afd7 5444optimization. You must use @option{-fprofile-generate} both when
33adcb6c
MM
5445compiling and when linking your program.
5446
5447The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
a8a5f53a
JH
5448
5449@item -fprofile-use
5450@opindex fprofile-use
5451Enable profile feedback directed optimizations, and optimizations
5452generally profitable only with profile feedback available.
5453
8a76829c
JH
5454The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5455@code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5456@code{-fno-loop-optimize}.
a8a5f53a 5457
d4463dfc
JQ
5458@end table
5459
5460The following options control compiler behavior regarding floating
5461point arithmetic. These options trade off between speed and
5462correctness. All must be specifically enabled.
5463
5464@table @gcctabopt
5465@item -ffloat-store
5466@opindex ffloat-store
5467Do not store floating point variables in registers, and inhibit other
5468options that might change whether a floating point value is taken from a
5469register or memory.
5470
5471@cindex floating point precision
5472This option prevents undesirable excess precision on machines such as
5473the 68000 where the floating registers (of the 68881) keep more
5474precision than a @code{double} is supposed to have. Similarly for the
5475x86 architecture. For most programs, the excess precision does only
5476good, but a few programs rely on the precise definition of IEEE floating
5477point. Use @option{-ffloat-store} for such programs, after modifying
5478them to store all pertinent intermediate computations into variables.
5479
5480@item -ffast-math
5481@opindex ffast-math
5482Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
039c3d42 5483@option{-fno-trapping-math}, @option{-ffinite-math-only},
c7463669
RH
5484@option{-fno-rounding-math}, @option{-fno-signaling-nans}
5485and @option{fcx-limited-range}.
d4463dfc
JQ
5486
5487This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5488
5489This option should never be turned on by any @option{-O} option since
5490it can result in incorrect output for programs which depend on
5491an exact implementation of IEEE or ISO rules/specifications for
5492math functions.
5493
5494@item -fno-math-errno
5495@opindex fno-math-errno
5496Do not set ERRNO after calling math functions that are executed
5497with a single instruction, e.g., sqrt. A program that relies on
5498IEEE exceptions for math error handling may want to use this flag
5499for speed while maintaining IEEE arithmetic compatibility.
5500
5501This option should never be turned on by any @option{-O} option since
5502it can result in incorrect output for programs which depend on
5503an exact implementation of IEEE or ISO rules/specifications for
5504math functions.
5505
5506The default is @option{-fmath-errno}.
5507
2e3f0db6
DJ
5508On Darwin systems, the math library never sets @code{errno}. There is therefore
5509no reason for the compiler to consider the possibility that it might,
5510and @option{-fno-math-errno} is the default.
5511
d4463dfc
JQ
5512@item -funsafe-math-optimizations
5513@opindex funsafe-math-optimizations
5514Allow optimizations for floating-point arithmetic that (a) assume
5515that arguments and results are valid and (b) may violate IEEE or
5516ANSI standards. When used at link-time, it may include libraries
5517or startup files that change the default FPU control word or other
5518similar optimizations.
5519
5520This option should never be turned on by any @option{-O} option since
5521it can result in incorrect output for programs which depend on
5522an exact implementation of IEEE or ISO rules/specifications for
5523math functions.
5524
5525The default is @option{-fno-unsafe-math-optimizations}.
5526
5527@item -ffinite-math-only
5528@opindex ffinite-math-only
5529Allow optimizations for floating-point arithmetic that assume
5530that arguments and results are not NaNs or +-Infs.
5531
5532This option should never be turned on by any @option{-O} option since
5533it can result in incorrect output for programs which depend on
5534an exact implementation of IEEE or ISO rules/specifications.
5535
5536The default is @option{-fno-finite-math-only}.
5537
5538@item -fno-trapping-math
5539@opindex fno-trapping-math
5540Compile code assuming that floating-point operations cannot generate
5541user-visible traps. These traps include division by zero, overflow,
5542underflow, inexact result and invalid operation. This option implies
5543@option{-fno-signaling-nans}. Setting this option may allow faster
5544code if one relies on ``non-stop'' IEEE arithmetic, for example.
5545
5546This option should never be turned on by any @option{-O} option since
5547it can result in incorrect output for programs which depend on
5548an exact implementation of IEEE or ISO rules/specifications for
5549math functions.
5550
5551The default is @option{-ftrapping-math}.
5552
039c3d42
RS
5553@item -frounding-math
5554@opindex frounding-math
5555Disable transformations and optimizations that assume default floating
5556point rounding behavior. This is round-to-zero for all floating point
5557to integer conversions, and round-to-nearest for all other arithmetic
5558truncations. This option should be specified for programs that change
5559the FP rounding mode dynamically, or that may be executed with a
5560non-default rounding mode. This option disables constant folding of
5561floating point expressions at compile-time (which may be affected by
5562rounding mode) and arithmetic transformations that are unsafe in the
5563presence of sign-dependent rounding modes.
5564
5565The default is @option{-fno-rounding-math}.
5566
5567This option is experimental and does not currently guarantee to
5568disable all GCC optimizations that are affected by rounding mode.
2dd76960 5569Future versions of GCC may provide finer control of this setting
039c3d42
RS
5570using C99's @code{FENV_ACCESS} pragma. This command line option
5571will be used to specify the default state for @code{FENV_ACCESS}.
5572
38109dab
GL
5573@item -frtl-abstract-sequences
5574@opindex frtl-abstract-sequences
5575It is a size optimization method. This option is to find identical
5576sequences of code, which can be turned into pseudo-procedures and
5577then replace all occurrences with calls to the newly created
5578subroutine. It is kind of an opposite of @option{-finline-functions}.
5579This optimization runs at RTL level.
5580
d4463dfc
JQ
5581@item -fsignaling-nans
5582@opindex fsignaling-nans
5583Compile code assuming that IEEE signaling NaNs may generate user-visible
5584traps during floating-point operations. Setting this option disables
5585optimizations that may change the number of exceptions visible with
5586signaling NaNs. This option implies @option{-ftrapping-math}.
5587
5588This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5589be defined.
5590
5591The default is @option{-fno-signaling-nans}.
5592
5593This option is experimental and does not currently guarantee to
5594disable all GCC optimizations that affect signaling NaN behavior.
5595
5596@item -fsingle-precision-constant
5597@opindex fsingle-precision-constant
5598Treat floating point constant as single precision constant instead of
5599implicitly converting it to double precision constant.
5600
c7463669
RH
5601@item -fcx-limited-range
5602@itemx -fno-cx-limited-range
5603@opindex fcx-limited-range
5604@opindex fno-cx-limited-range
5605When enabled, this option states that a range reduction step is not
5606needed when performing complex division. The default is
5607@option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5608
5609This option controls the default setting of the ISO C99
5610@code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5611all languages.
d4463dfc
JQ
5612
5613@end table
5614
5615The following options control optimizations that may improve
5616performance, but are not enabled by any @option{-O} options. This
5617section includes experimental options that may produce broken code.
5618
5619@table @gcctabopt
5620@item -fbranch-probabilities
5621@opindex fbranch-probabilities
5622After running a program compiled with @option{-fprofile-arcs}
5623(@pxref{Debugging Options,, Options for Debugging Your Program or
5624@command{gcc}}), you can compile it a second time using
5625@option{-fbranch-probabilities}, to improve optimizations based on
5626the number of times each branch was taken. When the program
5627compiled with @option{-fprofile-arcs} exits it saves arc execution
a4878735 5628counts to a file called @file{@var{sourcename}.gcda} for each source
d4463dfc
JQ
5629file The information in this data file is very dependent on the
5630structure of the generated code, so you must use the same source code
5631and the same optimization options for both compilations.
5632
daf2f129 5633With @option{-fbranch-probabilities}, GCC puts a
d4463dfc
JQ
5634@samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5635These can be used to improve optimization. Currently, they are only
5636used in one place: in @file{reorg.c}, instead of guessing which path a
5637branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5638exactly determine which path is taken more often.
5639
fc5eb4a1
ZD
5640@item -fprofile-values
5641@opindex fprofile-values
5642If combined with @option{-fprofile-arcs}, it adds code so that some
5643data about values of expressions in the program is gathered.
5644
6e885ee3
ZD
5645With @option{-fbranch-probabilities}, it reads back the data gathered
5646from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5647notes to instructions for their later usage in optimizations.
5648
7797ff53 5649Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8d3b3fb7 5650
fca9dc00
ZD
5651@item -fvpt
5652@opindex fvpt
5653If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5654a code to gather information about values of expressions.
5655
5656With @option{-fbranch-probabilities}, it reads back the data gathered
5657and actually performs the optimizations based on them.
5658Currently the optimizations include specialization of division operation
5659using the knowledge about the value of the denominator.
5660
a7b1dc36
PB
5661@item -frename-registers
5662@opindex frename-registers
5663Attempt to avoid false dependencies in scheduled code by making use
5664of registers left over after register allocation. This optimization
5665will most benefit processors with lots of registers. Depending on the
5666debug information format adopted by the target, however, it can
5667make debugging impossible, since variables will no longer stay in
5668a ``home register''.
5669
7869fe47 5670Enabled by default with @option{-funroll-loops}.
a7b1dc36 5671
d4463dfc
JQ
5672@item -ftracer
5673@opindex ftracer
8a36672b 5674Perform tail duplication to enlarge superblock size. This transformation
d4463dfc
JQ
5675simplifies the control flow of the function allowing other optimizations to do
5676better job.
5677
7797ff53 5678Enabled with @option{-fprofile-use}.
8d3b3fb7 5679
d4463dfc
JQ
5680@item -funroll-loops
5681@opindex funroll-loops
b17d5d7c
ZD
5682Unroll loops whose number of iterations can be determined at compile time or
5683upon entry to the loop. @option{-funroll-loops} implies
7869fe47
ZD
5684@option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
5685It also turns on complete loop peeling (i.e.@: complete removal of loops with
5686small constant number of iterations). This option makes code larger, and may
5687or may not make it run faster.
d4463dfc 5688
7797ff53 5689Enabled with @option{-fprofile-use}.
8d3b3fb7 5690
d4463dfc
JQ
5691@item -funroll-all-loops
5692@opindex funroll-all-loops
5693Unroll all loops, even if their number of iterations is uncertain when
5694the loop is entered. This usually makes programs run more slowly.
5695@option{-funroll-all-loops} implies the same options as
b17d5d7c
ZD
5696@option{-funroll-loops}.
5697
5698@item -fpeel-loops
5699@opindex fpeel-loops
5700Peels the loops for that there is enough information that they do not
5701roll much (from profile feedback). It also turns on complete loop peeling
431ae0bf 5702(i.e.@: complete removal of loops with small constant number of iterations).
b17d5d7c 5703
7797ff53 5704Enabled with @option{-fprofile-use}.
8d3b3fb7 5705
5e962776
ZD
5706@item -fmove-loop-invariants
5707@opindex fmove-loop-invariants
5708Enables the loop invariant motion pass in the new loop optimizer. Enabled
5709at level @option{-O1}
5710
b17d5d7c
ZD
5711@item -funswitch-loops
5712@opindex funswitch-loops
5713Move branches with loop invariant conditions out of the loop, with duplicates
5714of the loop on both branches (modified according to result of the condition).
5715
d4463dfc 5716@item -fprefetch-loop-arrays
17684618 5717@itemx -fprefetch-loop-arrays-rtl
d4463dfc 5718@opindex fprefetch-loop-arrays
17684618 5719@opindex fprefetch-loop-arrays-rtl
d4463dfc
JQ
5720If supported by the target machine, generate instructions to prefetch
5721memory to improve the performance of loops that access large arrays.
5722
5723Disabled at level @option{-Os}.
5724
5725@item -ffunction-sections
5726@itemx -fdata-sections
5727@opindex ffunction-sections
5728@opindex fdata-sections
5729Place each function or data item into its own section in the output
5730file if the target supports arbitrary sections. The name of the
5731function or the name of the data item determines the section's name
5732in the output file.
5733
5734Use these options on systems where the linker can perform optimizations
f401d0f5
JDA
5735to improve locality of reference in the instruction space. Most systems
5736using the ELF object format and SPARC processors running Solaris 2 have
5737linkers with such optimizations. AIX may have these optimizations in
5738the future.
d4463dfc
JQ
5739
5740Only use these options when there are significant benefits from doing
5741so. When you specify these options, the assembler and linker will
5742create larger object and executable files and will also be slower.
5743You will not be able to use @code{gprof} on all systems if you
5744specify this option and you may have problems with debugging if
5745you specify both this option and @option{-g}.
5746
fe3ad572
SC
5747@item -fbranch-target-load-optimize
5748@opindex fbranch-target-load-optimize
5749Perform branch target register load optimization before prologue / epilogue
5750threading.
5751The use of target registers can typically be exposed only during reload,
5752thus hoisting loads out of loops and doing inter-block scheduling needs
5753a separate optimization pass.
5754
5755@item -fbranch-target-load-optimize2
5756@opindex fbranch-target-load-optimize2
5757Perform branch target register load optimization after prologue / epilogue
5758threading.
5759
1194fc79
R
5760@item -fbtr-bb-exclusive
5761@opindex fbtr-bb-exclusive
8d3b3fb7 5762When performing branch target register load optimization, don't reuse
1194fc79
R
5763branch target registers in within any basic block.
5764
0aca9021
JW
5765@item -fstack-protector
5766Emit extra code to check for buffer overflows, such as stack smashing
5767attacks. This is done by adding a guard variable to functions with
5768vulnerable objects. This includes functions that call alloca, and
5769functions with buffers larger than 8 bytes. The guards are initialized
5770when a function is entered and then checked when the function exits.
5771If a guard check fails, an error message is printed and the program exits.
5772
5773@item -fstack-protector-all
5774Like @option{-fstack-protector} except that all functions are protected.
5775
3af64fd6 5776@item --param @var{name}=@var{value}
cd3bb277 5777@opindex param
3af64fd6
MM
5778In some places, GCC uses various constants to control the amount of
5779optimization that is done. For example, GCC will not inline functions
5780that contain more that a certain number of instructions. You can
5781control some of these constants on the command-line using the
630d3d5a 5782@option{--param} option.
3af64fd6 5783
b00567b0
ILT
5784The names of specific parameters, and the meaning of the values, are
5785tied to the internals of the compiler, and are subject to change
5786without notice in future releases.
5787
4fe9b91c 5788In each case, the @var{value} is an integer. The allowable choices for
3af64fd6
MM
5789@var{name} are given in the following table:
5790
5791@table @gcctabopt
31617ef1
DB
5792@item salias-max-implicit-fields
5793The maximum number of fields in a variable without direct
5794structure accesses for which structure aliasing will consider trying
5795to track each field. The default is 5
5796
a916f21d
RG
5797@item salias-max-array-elements
5798The maximum number of elements an array can have and its elements
5799still be tracked individually by structure aliasing. The default is 4
5800
61b58001
BE
5801@item sra-max-structure-size
5802The maximum structure size, in bytes, at which the scalar replacement
5803of aggregates (SRA) optimization will perform block copies. The
5804default value, 0, implies that GCC will select the most appropriate
5805size itself.
5806
5807@item sra-field-structure-ratio
1c170b5e 5808The threshold ratio (as a percentage) between instantiated fields and
61b58001
BE
5809the complete structure size. We say that if the ratio of the number
5810of bytes in instantiated fields to the number of bytes in the complete
5811structure exceeds this parameter, then block copies are not used. The
5812default is 75.
5813
5f24e0dc
RH
5814@item max-crossjump-edges
5815The maximum number of incoming edges to consider for crossjumping.
d203738b 5816The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5f24e0dc
RH
5817the number of edges incoming to each block. Increasing values mean
5818more aggressive optimization, making the compile time increase with
5819probably small improvement in executable size.
5820
12183e0f
PH
5821@item min-crossjump-insns
5822The minimum number of instructions which must be matched at the end
5823of two blocks before crossjumping will be performed on them. This
5824value is ignored in the case where all instructions in the block being
5825crossjumped from are matched. The default value is 5.
5826
f935b9e0
DE
5827@item max-grow-copy-bb-insns
5828The maximum code size expansion factor when copying basic blocks
5829instead of jumping. The expansion is relative to a jump instruction.
5830The default value is 8.
5831
bbcb0c05
SB
5832@item max-goto-duplication-insns
5833The maximum number of instructions to duplicate to a block that jumps
5834to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5835passes, GCC factors computed gotos early in the compilation process,
5836and unfactors them as late as possible. Only computed jumps at the
5837end of a basic blocks with no more than max-goto-duplication-insns are
5838unfactored. The default value is 8.
5839
1c4c47db
JO
5840@item max-delay-slot-insn-search
5841The maximum number of instructions to consider when looking for an
5842instruction to fill a delay slot. If more than this arbitrary number of
5843instructions is searched, the time savings from filling the delay slot
5844will be minimal so stop searching. Increasing values mean more
5845aggressive optimization, making the compile time increase with probably
5846small improvement in executable run time.
5847
5848@item max-delay-slot-live-search
5849When trying to fill delay slots, the maximum number of instructions to
5850consider when searching for a block with valid live register
5851information. Increasing this arbitrarily chosen value means more
5852aggressive optimization, increasing the compile time. This parameter
5853should be removed when the delay slot code is rewritten to maintain the
5854control-flow graph.
33d3b05b
MM
5855
5856@item max-gcse-memory
5857The approximate maximum amount of memory that will be allocated in
5858order to perform the global common subexpression elimination
5859optimization. If more memory than specified is required, the
5860optimization will not be done.
3af64fd6 5861
740f35a0 5862@item max-gcse-passes
8d3b3fb7 5863The maximum number of passes of GCSE to run. The default is 1.
740f35a0 5864
4a121cc3 5865@item max-pending-list-length
0c688a7d 5866The maximum number of pending dependencies scheduling will allow
4a121cc3
AM
5867before flushing the current state and starting over. Large functions
5868with few branches or calls can create excessively large lists which
5869needlessly consume memory and resources.
5870
bc522472
KG
5871@item max-inline-insns-single
5872Several parameters control the tree inliner used in gcc.
2dd76960 5873This number sets the maximum number of instructions (counted in GCC's
daf2f129 5874internal representation) in a single function that the tree inliner
bc522472
KG
5875will consider for inlining. This only affects functions declared
5876inline and methods implemented in a class declaration (C++).
e5c4f28a 5877The default value is 450.
bc522472
KG
5878
5879@item max-inline-insns-auto
5880When you use @option{-finline-functions} (included in @option{-O3}),
5881a lot of functions that would otherwise not be considered for inlining
5882by the compiler will be investigated. To those functions, a different
5883(more restrictive) limit compared to functions declared inline can
5884be applied.
e5c4f28a 5885The default value is 90.
bc522472 5886
b58b1157 5887@item large-function-insns
74515a0a
RG
5888The limit specifying really large functions. For functions larger than this
5889limit after inlining inlining is constrained by
5890@option{--param large-function-growth}. This parameter is useful primarily
5891to avoid extreme compilation time caused by non-linear algorithms used by the
5892backend.
b58b1157 5893This parameter is ignored when @option{-funit-at-a-time} is not used.
e5c4f28a 5894The default value is 2700.
b58b1157
JH
5895
5896@item large-function-growth
e53e0c56 5897Specifies maximal growth of large function caused by inlining in percents.
b58b1157 5898This parameter is ignored when @option{-funit-at-a-time} is not used.
74515a0a
RG
5899The default value is 100 which limits large function growth to 2.0 times
5900the original size.
b58b1157 5901
b4f32d07
JH
5902@item large-unit-insns
5903The limit specifying large translation unit. Growth caused by inlining of
5904units larger than this limit is limited by @option{--param inline-unit-growth}.
5905For small units this might be too tight (consider unit consisting of function A
5906that is inline and B that just calls A three time. If B is small relative to
5907A, the growth of unit is 300\% and yet such inlining is very sane. For very
5908large units consisting of small inlininable functions however the overall unit
5909growth limit is needed to avoid exponential explosion of code size. Thus for
5910smaller units, the size is increased to @option{--param large-unit-insns}
6416ae7f 5911before applying @option{--param inline-unit-growth}. The default is 10000
b4f32d07 5912
b58b1157
JH
5913@item inline-unit-growth
5914Specifies maximal overall growth of the compilation unit caused by inlining.
5915This parameter is ignored when @option{-funit-at-a-time} is not used.
74515a0a
RG
5916The default value is 50 which limits unit growth to 1.5 times the original
5917size.
b58b1157 5918
6de9cd9a
DN
5919@item max-inline-insns-recursive
5920@itemx max-inline-insns-recursive-auto
5921Specifies maximum number of instructions out-of-line copy of self recursive inline
5922function can grow into by performing recursive inlining.
5923
5924For functions declared inline @option{--param max-inline-insns-recursive} is
5925taken into acount. For function not declared inline, recursive inlining
5926happens only when @option{-finline-functions} (included in @option{-O3}) is
5927enabled and @option{--param max-inline-insns-recursive-auto} is used. The
e5c4f28a 5928default value is 450.
6de9cd9a
DN
5929
5930@item max-inline-recursive-depth
5931@itemx max-inline-recursive-depth-auto
5932Specifies maximum recursion depth used by the recursive inlining.
5933
5934For functions declared inline @option{--param max-inline-recursive-depth} is
5935taken into acount. For function not declared inline, recursive inlining
5936happens only when @option{-finline-functions} (included in @option{-O3}) is
5937enabled and @option{--param max-inline-recursive-depth-auto} is used. The
e5c4f28a
RG
5938default value is 450.
5939
c5a4444c
JH
5940@item min-inline-recursive-probability
5941Recursive inlining is profitable only for function having deep recursion
5942in average and can hurt for function having little recursion depth by
5943increasing the prologue size or complexity of function body to other
5944optimizers.
5945
5946When profile feedback is available (see @option{-fprofile-generate}) the actual
5947recursion depth can be guessed from probability that function will recurse via
5948given call expression. This parameter limits inlining only to call expression
5949whose probability exceeds given threshold (in percents). The default value is
595010.
5951
e5c4f28a
RG
5952@item inline-call-cost
5953Specify cost of call instruction relative to simple arithmetics operations
2e0ea515
KH
5954(having cost of 1). Increasing this cost disqualifies inlining of non-leaf
5955functions and at the same time increases size of leaf function that is believed to
5956reduce function size by being inlined. In effect it increases amount of
e5c4f28a 5957inlining for code having large abstraction penalty (many functions that just
2e0ea515
KH
5958pass the arguments to other functions) and decrease inlining for code with low
5959abstraction penalty. The default value is 16.
6de9cd9a 5960
03e9dbc9
MM
5961@item max-unrolled-insns
5962The maximum number of instructions that a loop should have if that loop
5963is unrolled, and if the loop is unrolled, it determines how many times
5964the loop code is unrolled.
5965
b17d5d7c
ZD
5966@item max-average-unrolled-insns
5967The maximum number of instructions biased by probabilities of their execution
5968that a loop should have if that loop is unrolled, and if the loop is unrolled,
5969it determines how many times the loop code is unrolled.
5970
5971@item max-unroll-times
5972The maximum number of unrollings of a single loop.
5973
5974@item max-peeled-insns
5975The maximum number of instructions that a loop should have if that loop
5976is peeled, and if the loop is peeled, it determines how many times
5977the loop code is peeled.
5978
5979@item max-peel-times
5980The maximum number of peelings of a single loop.
5981
5982@item max-completely-peeled-insns
5983The maximum number of insns of a completely peeled loop.
5984
5985@item max-completely-peel-times
5986The maximum number of iterations of a loop to be suitable for complete peeling.
5987
01a132bb
ZD
5988@item max-unswitch-insns
5989The maximum number of insns of an unswitched loop.
5990
5991@item max-unswitch-level
5992The maximum number of branches unswitched in a single loop.
5993
a7e5372d
ZD
5994@item lim-expensive
5995The minimum cost of an expensive expression in the loop invariant motion.
5996
8b11a64c
ZD
5997@item iv-consider-all-candidates-bound
5998Bound on number of candidates for induction variables below that
5999all candidates are considered for each use in induction variable
6000optimizations. Only the most relevant candidates are considered
6001if there are more candidates, to avoid quadratic time complexity.
6002
6003@item iv-max-considered-uses
6004The induction variable optimizations give up on loops that contain more
6005induction variable uses.
6006
36f5ada1
ZD
6007@item iv-always-prune-cand-set-bound
6008If number of candidates in the set is smaller than this value,
6009we always try to remove unnecessary ivs from the set during its
6010optimization when a new iv is added to the set.
6011
2412d35c
SP
6012@item scev-max-expr-size
6013Bound on size of expressions used in the scalar evolutions analyzer.
6014Large expressions slow the analyzer.
6015
c12cc930 6016@item vect-max-version-checks
5116a5d2 6017The maximum number of runtime checks that can be performed when doing
c12cc930
KB
6018loop versioning in the vectorizer. See option ftree-vect-loop-version
6019for more information.
6020
e9eb809d
ZD
6021@item max-iterations-to-track
6022
6023The maximum number of iterations of a loop the brute force algorithm
6024for analysis of # of iterations of the loop tries to evaluate.
6025
194734e9
JH
6026@item hot-bb-count-fraction
6027Select fraction of the maximal count of repetitions of basic block in program
6028given basic block needs to have to be considered hot.
6029
6030@item hot-bb-frequency-fraction
6031Select fraction of the maximal frequency of executions of basic block in
6032function given basic block needs to have to be considered hot
5c856b23 6033
95b9a3a5
JH
6034@item max-predicted-iterations
6035The maximum number of loop iterations we predict statically. This is useful
6036in cases where function contain single loop with known bound and other loop
6037with unknown. We predict the known number of iterations correctly, while
c83eecad
KH
6038the unknown number of iterations average to roughly 10. This means that the
6039loop without bounds would appear artificially cold relative to the other one.
95b9a3a5 6040
5c856b23
JH
6041@item tracer-dynamic-coverage
6042@itemx tracer-dynamic-coverage-feedback
6043
3364c33b
JQ
6044This value is used to limit superblock formation once the given percentage of
6045executed instructions is covered. This limits unnecessary code size
6046expansion.
5c856b23
JH
6047
6048The @option{tracer-dynamic-coverage-feedback} is used only when profile
6049feedback is available. The real profiles (as opposed to statically estimated
6050ones) are much less balanced allowing the threshold to be larger value.
6051
6052@item tracer-max-code-growth
6053Stop tail duplication once code growth has reached given percentage. This is
3364c33b 6054rather hokey argument, as most of the duplicates will be eliminated later in
5c856b23
JH
6055cross jumping, so it may be set to much higher values than is the desired code
6056growth.
6057
6058@item tracer-min-branch-ratio
6059
6060Stop reverse growth when the reverse probability of best edge is less than this
6061threshold (in percent).
6062
6063@item tracer-min-branch-ratio
6064@itemx tracer-min-branch-ratio-feedback
6065
6066Stop forward growth if the best edge do have probability lower than this
6067threshold.
6068
3364c33b 6069Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5c856b23
JH
6070compilation for profile feedback and one for compilation without. The value
6071for compilation with profile feedback needs to be more conservative (higher) in
6072order to make tracer effective.
6073
c48ec590
ZD
6074@item max-cse-path-length
6075
8d3b3fb7 6076Maximum number of basic blocks on path that cse considers. The default is 10.
c48ec590 6077
95b9a3a5
JH
6078@item max-cse-insns
6079The maximum instructions CSE process before flushing. The default is 1000.
6080
6de9cd9a
DN
6081@item global-var-threshold
6082
8a36672b
JM
6083Counts the number of function calls (@var{n}) and the number of
6084call-clobbered variables (@var{v}). If @var{n}x@var{v} is larger than this limit, a
6de9cd9a
DN
6085single artificial variable will be created to represent all the
6086call-clobbered variables at function call sites. This artificial
6087variable will then be made to alias every call-clobbered variable.
8a36672b 6088(done as @code{int * size_t} on the host machine; beware overflow).
6de9cd9a
DN
6089
6090@item max-aliased-vops
6091
27ef2cdd 6092Maximum number of virtual operands allowed to represent aliases
6de9cd9a
DN
6093before triggering the alias grouping heuristic. Alias grouping
6094reduces compile times and memory consumption needed for aliasing at
6095the expense of precision loss in alias information.
6096
3788cc17
ZW
6097@item ggc-min-expand
6098
6099GCC uses a garbage collector to manage its own memory allocation. This
6100parameter specifies the minimum percentage by which the garbage
6101collector's heap should be allowed to expand between collections.
6102Tuning this may improve compilation speed; it has no effect on code
6103generation.
6104
9ac121af 6105The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8a36672b
JM
6106RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
6107the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
16226f1e
KG
6108GCC is not able to calculate RAM on a particular platform, the lower
6109bound of 30% is used. Setting this parameter and
737c38d1
GK
6110@option{ggc-min-heapsize} to zero causes a full collection to occur at
6111every opportunity. This is extremely slow, but can be useful for
6112debugging.
3788cc17
ZW
6113
6114@item ggc-min-heapsize
6115
6116Minimum size of the garbage collector's heap before it begins bothering
6117to collect garbage. The first collection occurs after the heap expands
6118by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
6119tuning this may improve compilation speed, and has no effect on code
6120generation.
6121
d37e6b50
GK
6122The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6123tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6124with a lower bound of 4096 (four megabytes) and an upper bound of
6125131072 (128 megabytes). If GCC is not able to calculate RAM on a
6126particular platform, the lower bound is used. Setting this parameter
6127very large effectively disables garbage collection. Setting this
6128parameter and @option{ggc-min-expand} to zero causes a full collection
6129to occur at every opportunity.
3788cc17 6130
0bcf8261
JH
6131@item max-reload-search-insns
6132The maximum number of instruction reload should look backward for equivalent
6133register. Increasing values mean more aggressive optimization, making the
6134compile time increase with probably slightly better performance. The default
6135value is 100.
6136
c65ecebc
JH
6137@item max-cselib-memory-location
6138The maximum number of memory locations cselib should take into acount.
6139Increasing values mean more aggressive optimization, making the compile time
6140increase with probably slightly better performance. The default value is 500.
6141
95b9a3a5
JH
6142@item max-flow-memory-location
6143Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6144The default value is 100.
6145
26f74aa3
JH
6146@item reorder-blocks-duplicate
6147@itemx reorder-blocks-duplicate-feedback
6148
65d2d764 6149Used by basic block reordering pass to decide whether to use unconditional
b222f49a 6150branch or duplicate the code on its destination. Code is duplicated when its
26f74aa3 6151estimated size is smaller than this value multiplied by the estimated size of
65d2d764 6152unconditional jump in the hot spots of the program.
26f74aa3
JH
6153
6154The @option{reorder-block-duplicate-feedback} is used only when profile
6155feedback is available and may be set to higher values than
6156@option{reorder-block-duplicate} since information about the hot spots is more
6157accurate.
f72c6b56
DE
6158
6159@item max-sched-region-blocks
6160The maximum number of blocks in a region to be considered for
6161interblock scheduling. The default value is 10.
6162
fbce7685 6163@item max-sched-region-insns
f72c6b56
DE
6164The maximum number of insns in a region to be considered for
6165interblock scheduling. The default value is 100.
31ebd7c8 6166
36968131
PS
6167@item min-spec-prob
6168The minimum probability (in percents) of reaching a source block
6169for interblock speculative scheduling. The default value is 40.
6f48c21a 6170
49c3b9a8
JJ
6171@item max-last-value-rtl
6172
6173The maximum size measured as number of RTLs that can be recorded in an expression
6174in combiner for a pseudo register as last known value of that register. The default
6175is 10000.
6176
31ebd7c8
NS
6177@item integer-share-limit
6178Small integer constants can use a shared data structure, reducing the
6179compiler's memory usage and increasing its speed. This sets the maximum
6180value of a shared integer constant's. The default value is 256.
6181
84d65814
DN
6182@item min-virtual-mappings
6183Specifies the minimum number of virtual mappings in the incremental
6184SSA updater that should be registered to trigger the virtual mappings
6185heuristic defined by virtual-mappings-ratio. The default value is
6186100.
6187
6188@item virtual-mappings-ratio
6189If the number of virtual mappings is virtual-mappings-ratio bigger
6190than the number of virtual symbols to be updated, then the incremental
6191SSA updater switches to a full update for those symbols. The default
6192ratio is 3.
6193
0aca9021
JW
6194@item ssp-buffer-size
6195The minimum size of buffers (i.e. arrays) that will receive stack smashing
6196protection when @option{-fstack-protection} is used.
6197
43f31be5
JL
6198@item max-jump-thread-duplication-stmts
6199Maximum number of statements allowed in a block that needs to be
6200duplicated when threading jumps.
98035a75
DB
6201
6202@item max-fields-for-field-sensitive
6203Maximum number of fields in a structure we will treat in
6204a field sensitive manner during pointer analysis.
6205
1c4c47db 6206@end table
74291a4b
MM
6207@end table
6208
6209@node Preprocessor Options
6210@section Options Controlling the Preprocessor
6211@cindex preprocessor options
6212@cindex options, preprocessor
6213
6214These options control the C preprocessor, which is run on each C source
6215file before actual compilation.
6216
630d3d5a
JM
6217If you use the @option{-E} option, nothing is done except preprocessing.
6218Some of these options make sense only together with @option{-E} because
74291a4b
MM
6219they cause the preprocessor output to be unsuitable for actual
6220compilation.
6221
4977bab6 6222@table @gcctabopt
cd3bb277 6223@opindex Wp
40adaa27
NB
6224You can use @option{-Wp,@var{option}} to bypass the compiler driver
6225and pass @var{option} directly through to the preprocessor. If
6226@var{option} contains commas, it is split into multiple options at the
6227commas. However, many options are modified, translated or interpreted
6228by the compiler driver before being passed to the preprocessor, and
6229@option{-Wp} forcibly bypasses this phase. The preprocessor's direct
6230interface is undocumented and subject to change, so whenever possible
6231you should avoid using @option{-Wp} and let the driver handle the
6232options instead.
6233
4977bab6
ZW
6234@item -Xpreprocessor @var{option}
6235@opindex preprocessor
6236Pass @var{option} as an option to the preprocessor. You can use this to
6237supply system-specific preprocessor options which GCC does not know how to
6238recognize.
6239
6240If you want to pass an option that takes an argument, you must use
6241@option{-Xpreprocessor} twice, once for the option and once for the argument.
6242@end table
6243
40adaa27 6244@include cppopts.texi
74291a4b
MM
6245
6246@node Assembler Options
6247@section Passing Options to the Assembler
6248
6249@c prevent bad page break with this line
6250You can pass options to the assembler.
6251
2642624b 6252@table @gcctabopt
aee96fe9 6253@item -Wa,@var{option}
cd3bb277 6254@opindex Wa
74291a4b
MM
6255Pass @var{option} as an option to the assembler. If @var{option}
6256contains commas, it is split into multiple options at the commas.
4977bab6
ZW
6257
6258@item -Xassembler @var{option}
6259@opindex Xassembler
6260Pass @var{option} as an option to the assembler. You can use this to
6261supply system-specific assembler options which GCC does not know how to
6262recognize.
6263
6264If you want to pass an option that takes an argument, you must use
6265@option{-Xassembler} twice, once for the option and once for the argument.
6266
74291a4b
MM
6267@end table
6268
6269@node Link Options
6270@section Options for Linking
6271@cindex link options
6272@cindex options, linking
6273
6274These options come into play when the compiler links object files into
6275an executable output file. They are meaningless if the compiler is
6276not doing a link step.
6277
2642624b 6278@table @gcctabopt
74291a4b
MM
6279@cindex file names
6280@item @var{object-file-name}
6281A file name that does not end in a special recognized suffix is
6282considered to name an object file or library. (Object files are
6283distinguished from libraries by the linker according to the file
6284contents.) If linking is done, these object files are used as input
6285to the linker.
6286
6287@item -c
6288@itemx -S
6289@itemx -E
cd3bb277
JM
6290@opindex c
6291@opindex S
6292@opindex E
74291a4b
MM
6293If any of these options is used, then the linker is not run, and
6294object file names should not be used as arguments. @xref{Overall
6295Options}.
6296
6297@cindex Libraries
6298@item -l@var{library}
4275c4c4 6299@itemx -l @var{library}
cd3bb277 6300@opindex l
4275c4c4
JS
6301Search the library named @var{library} when linking. (The second
6302alternative with the library as a separate argument is only for
6303POSIX compliance and is not recommended.)
74291a4b
MM
6304
6305It makes a difference where in the command you write this option; the
4275c4c4 6306linker searches and processes libraries and object files in the order they
74291a4b
MM
6307are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6308after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
6309to functions in @samp{z}, those functions may not be loaded.
6310
6311The linker searches a standard list of directories for the library,
6312which is actually a file named @file{lib@var{library}.a}. The linker
6313then uses this file as if it had been specified precisely by name.
6314
6315The directories searched include several standard system directories
630d3d5a 6316plus any that you specify with @option{-L}.
74291a4b
MM
6317
6318Normally the files found this way are library files---archive files
6319whose members are object files. The linker handles an archive file by
6320scanning through it for members which define symbols that have so far
6321been referenced but not defined. But if the file that is found is an
6322ordinary object file, it is linked in the usual fashion. The only
630d3d5a
JM
6323difference between using an @option{-l} option and specifying a file name
6324is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
74291a4b
MM
6325and searches several directories.
6326
6327@item -lobjc
cd3bb277 6328@opindex lobjc
630d3d5a 6329You need this special case of the @option{-l} option in order to
46e34f96 6330link an Objective-C or Objective-C++ program.
74291a4b
MM
6331
6332@item -nostartfiles
cd3bb277 6333@opindex nostartfiles
74291a4b 6334Do not use the standard system startup files when linking.
bedc7537
NC
6335The standard system libraries are used normally, unless @option{-nostdlib}
6336or @option{-nodefaultlibs} is used.
74291a4b
MM
6337
6338@item -nodefaultlibs
cd3bb277 6339@opindex nodefaultlibs
74291a4b
MM
6340Do not use the standard system libraries when linking.
6341Only the libraries you specify will be passed to the linker.
bedc7537 6342The standard startup files are used normally, unless @option{-nostartfiles}
8f99553f
JM
6343is used. The compiler may generate calls to @code{memcmp},
6344@code{memset}, @code{memcpy} and @code{memmove}.
6345These entries are usually resolved by entries in
4754172c
CM
6346libc. These entry points should be supplied through some other
6347mechanism when this option is specified.
74291a4b
MM
6348
6349@item -nostdlib
cd3bb277 6350@opindex nostdlib
74291a4b
MM
6351Do not use the standard system startup files or libraries when linking.
6352No startup files and only the libraries you specify will be passed to
8f99553f
JM
6353the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
6354@code{memcpy} and @code{memmove}.
6355These entries are usually resolved by entries in
4754172c
CM
6356libc. These entry points should be supplied through some other
6357mechanism when this option is specified.
74291a4b 6358
630d3d5a
JM
6359@cindex @option{-lgcc}, use with @option{-nostdlib}
6360@cindex @option{-nostdlib} and unresolved references
6361@cindex unresolved references and @option{-nostdlib}
6362@cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6363@cindex @option{-nodefaultlibs} and unresolved references
6364@cindex unresolved references and @option{-nodefaultlibs}
6365One of the standard libraries bypassed by @option{-nostdlib} and
6366@option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
0c2d1a2a 6367that GCC uses to overcome shortcomings of particular machines, or special
74291a4b 6368needs for some languages.
b11cc610
JM
6369(@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6370Collection (GCC) Internals},
74291a4b 6371for more discussion of @file{libgcc.a}.)
74291a4b 6372In most cases, you need @file{libgcc.a} even when you want to avoid
630d3d5a
JM
6373other standard libraries. In other words, when you specify @option{-nostdlib}
6374or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
0c2d1a2a 6375This ensures that you have no unresolved references to internal GCC
74291a4b 6376library subroutines. (For example, @samp{__main}, used to ensure C++
b11cc610
JM
6377constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6378GNU Compiler Collection (GCC) Internals}.)
74291a4b 6379
24a4dd31
JJ
6380@item -pie
6381@opindex pie
6382Produce a position independent executable on targets which support it.
6383For predictable results, you must also specify the same set of options
6384that were used to generate code (@option{-fpie}, @option{-fPIE},
6385or model suboptions) when you specify this option.
6386
0cbc4d77
WB
6387@item -rdynamic
6388@opindex rdynamic
6389Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6390that support it. This instructs the linker to add all symbols, not
6391only used ones, to the dynamic symbol table. This option is needed
6392for some uses of @code{dlopen} or to allow obtaining backtraces
6393from within a program.
6394
74291a4b 6395@item -s
cd3bb277 6396@opindex s
74291a4b
MM
6397Remove all symbol table and relocation information from the executable.
6398
6399@item -static
cd3bb277 6400@opindex static
74291a4b
MM
6401On systems that support dynamic linking, this prevents linking with the shared
6402libraries. On other systems, this option has no effect.
6403
6404@item -shared
cd3bb277 6405@opindex shared
74291a4b 6406Produce a shared object which can then be linked with other objects to
1d3b0e2c 6407form an executable. Not all systems support this option. For predictable
02f52e19 6408results, you must also specify the same set of options that were used to
630d3d5a 6409generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
2642624b 6410when you specify this option.@footnote{On some systems, @samp{gcc -shared}
767094dd 6411needs to build supplementary stub code for constructors to work. On
2642624b 6412multi-libbed systems, @samp{gcc -shared} must select the correct support
1d3b0e2c 6413libraries to link against. Failing to supply the correct flags may lead
767094dd 6414to subtle defects. Supplying them in cases where they are not necessary
1d3b0e2c 6415is innocuous.}
74291a4b 6416
9db0819e
RH
6417@item -shared-libgcc
6418@itemx -static-libgcc
cd3bb277
JM
6419@opindex shared-libgcc
6420@opindex static-libgcc
9db0819e
RH
6421On systems that provide @file{libgcc} as a shared library, these options
6422force the use of either the shared or static version respectively.
6423If no shared version of @file{libgcc} was built when the compiler was
6424configured, these options have no effect.
6425
6426There are several situations in which an application should use the
6427shared @file{libgcc} instead of the static version. The most common
6428of these is when the application wishes to throw and catch exceptions
6429across different shared libraries. In that case, each of the libraries
6430as well as the application itself should use the shared @file{libgcc}.
6431
5c181756
AO
6432Therefore, the G++ and GCJ drivers automatically add
6433@option{-shared-libgcc} whenever you build a shared library or a main
6434executable, because C++ and Java programs typically use exceptions, so
6435this is the right thing to do.
6436
6437If, instead, you use the GCC driver to create shared libraries, you may
6438find that they will not always be linked with the shared @file{libgcc}.
d3144423
EB
6439If GCC finds, at its configuration time, that you have a non-GNU linker
6440or a GNU linker that does not support option @option{--eh-frame-hdr},
6441it will link the shared version of @file{libgcc} into shared libraries
6442by default. Otherwise, it will take advantage of the linker and optimize
6443away the linking with the shared version of @file{libgcc}, linking with
6444the static version of libgcc by default. This allows exceptions to
6445propagate through such shared libraries, without incurring relocation
6446costs at library load time.
5c181756
AO
6447
6448However, if a library or main executable is supposed to throw or catch
6449exceptions, you must link it using the G++ or GCJ driver, as appropriate
6450for the languages used in the program, or using the option
6451@option{-shared-libgcc}, such that it is linked with the shared
049f6ec9 6452@file{libgcc}.
9db0819e 6453
74291a4b 6454@item -symbolic
cd3bb277 6455@opindex symbolic
74291a4b
MM
6456Bind references to global symbols when building a shared object. Warn
6457about any unresolved references (unless overridden by the link editor
6458option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
6459this option.
6460
6461@item -Xlinker @var{option}
cd3bb277 6462@opindex Xlinker
74291a4b 6463Pass @var{option} as an option to the linker. You can use this to
0c2d1a2a 6464supply system-specific linker options which GCC does not know how to
74291a4b
MM
6465recognize.
6466
6467If you want to pass an option that takes an argument, you must use
630d3d5a
JM
6468@option{-Xlinker} twice, once for the option and once for the argument.
6469For example, to pass @option{-assert definitions}, you must write
74291a4b 6470@samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
630d3d5a 6471@option{-Xlinker "-assert definitions"}, because this passes the entire
74291a4b
MM
6472string as a single argument, which is not what the linker expects.
6473
aee96fe9 6474@item -Wl,@var{option}
cd3bb277 6475@opindex Wl
74291a4b
MM
6476Pass @var{option} as an option to the linker. If @var{option} contains
6477commas, it is split into multiple options at the commas.
6478
6479@item -u @var{symbol}
cd3bb277 6480@opindex u
74291a4b 6481Pretend the symbol @var{symbol} is undefined, to force linking of
630d3d5a 6482library modules to define it. You can use @option{-u} multiple times with
74291a4b
MM
6483different symbols to force loading of additional library modules.
6484@end table
6485
6486@node Directory Options
6487@section Options for Directory Search
6488@cindex directory options
6489@cindex options, directory search
6490@cindex search path
6491
6492These options specify directories to search for header files, for
6493libraries and for parts of the compiler:
6494
2642624b 6495@table @gcctabopt
74291a4b 6496@item -I@var{dir}
cd3bb277 6497@opindex I
861bb6c1
JL
6498Add the directory @var{dir} to the head of the list of directories to be
6499searched for header files. This can be used to override a system header
6500file, substituting your own version, since these directories are
d0a5eb32
RK
6501searched before the system header file directories. However, you should
6502not use this option to add directories that contain vendor-supplied
767094dd 6503system header files (use @option{-isystem} for that). If you use more than
630d3d5a 6504one @option{-I} option, the directories are scanned in left-to-right
74291a4b
MM
6505order; the standard system directories come after.
6506
dbead49c 6507If a standard system include directory, or a directory specified with
48209ce5
JDA
6508@option{-isystem}, is also specified with @option{-I}, the @option{-I}
6509option will be ignored. The directory will still be searched but as a
6510system directory at its normal position in the system include chain.
6511This is to ensure that GCC's procedure to fix buggy system headers and
3364c33b 6512the ordering for the include_next directive are not inadvertently changed.
48209ce5
JDA
6513If you really need to change the search order for system directories,
6514use the @option{-nostdinc} and/or @option{-isystem} options.
dbead49c 6515
4bed3787
MS
6516@item -iquote@var{dir}
6517@opindex iquote
6518Add the directory @var{dir} to the head of the list of directories to
6519be searched for header files only for the case of @samp{#include
6520"@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6521otherwise just like @option{-I}.
74291a4b
MM
6522
6523@item -L@var{dir}
cd3bb277 6524@opindex L
74291a4b 6525Add directory @var{dir} to the list of directories to be searched
630d3d5a 6526for @option{-l}.
74291a4b
MM
6527
6528@item -B@var{prefix}
cd3bb277 6529@opindex B
74291a4b
MM
6530This option specifies where to find the executables, libraries,
6531include files, and data files of the compiler itself.
6532
6533The compiler driver program runs one or more of the subprograms
6534@file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6535@var{prefix} as a prefix for each program it tries to run, both with and
6536without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6537
6538For each subprogram to be run, the compiler driver first tries the
630d3d5a 6539@option{-B} prefix, if any. If that name is not found, or if @option{-B}
74291a4b 6540was not specified, the driver tries two standard prefixes, which are
8e5f33ff 6541@file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
74291a4b
MM
6542those results in a file name that is found, the unmodified program
6543name is searched for using the directories specified in your
bedc7537 6544@env{PATH} environment variable.
74291a4b 6545
07804c3b
NC
6546The compiler will check to see if the path provided by the @option{-B}
6547refers to a directory, and if necessary it will add a directory
6548separator character at the end of the path.
6549
630d3d5a 6550@option{-B} prefixes that effectively specify directory names also apply
74291a4b 6551to libraries in the linker, because the compiler translates these
630d3d5a 6552options into @option{-L} options for the linker. They also apply to
74291a4b 6553includes files in the preprocessor, because the compiler translates these
630d3d5a 6554options into @option{-isystem} options for the preprocessor. In this case,
74291a4b
MM
6555the compiler appends @samp{include} to the prefix.
6556
6557The run-time support file @file{libgcc.a} can also be searched for using
630d3d5a 6558the @option{-B} prefix, if needed. If it is not found there, the two
74291a4b
MM
6559standard prefixes above are tried, and that is all. The file is left
6560out of the link if it is not found by those means.
6561
630d3d5a 6562Another way to specify a prefix much like the @option{-B} prefix is to use
bedc7537 6563the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
74291a4b 6564Variables}.
861bb6c1 6565
07804c3b 6566As a special kludge, if the path provided by @option{-B} is
bf4eebe0
NC
6567@file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
65689, then it will be replaced by @file{[dir/]include}. This is to help
7dac2f89 6569with boot-strapping the compiler.
07804c3b 6570
861bb6c1 6571@item -specs=@var{file}
cd3bb277 6572@opindex specs
861bb6c1
JL
6573Process @var{file} after the compiler reads in the standard @file{specs}
6574file, in order to override the defaults that the @file{gcc} driver
6575program uses when determining what switches to pass to @file{cc1},
6576@file{cc1plus}, @file{as}, @file{ld}, etc. More than one
630d3d5a 6577@option{-specs=@var{file}} can be specified on the command line, and they
861bb6c1 6578are processed in order, from left to right.
4bed3787 6579
160633c6
MM
6580@item --sysroot=@var{dir}
6581@opindex sysroot
6582Use @var{dir} as the logical root directory for headers and libraries.
6583For example, if the compiler would normally search for headers in
6584@file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6585search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
6586
6587If you use both this option and the @option{-isysroot} option, then
6588the @option{--sysroot} option will apply to libraries, but the
6589@option{-isysroot} option will apply to header files.
6590
6591The GNU linker (beginning with version 2.16) has the necessary support
6592for this option. If your linker does not support this option, the
6593header file aspect of @option{--sysroot} will still work, but the
6594library aspect will not.
6595
4bed3787
MS
6596@item -I-
6597@opindex I-
6598This option has been deprecated. Please use @option{-iquote} instead for
6599@option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6600Any directories you specify with @option{-I} options before the @option{-I-}
6601option are searched only for the case of @samp{#include "@var{file}"};
6602they are not searched for @samp{#include <@var{file}>}.
6603
6604If additional directories are specified with @option{-I} options after
6605the @option{-I-}, these directories are searched for all @samp{#include}
6606directives. (Ordinarily @emph{all} @option{-I} directories are used
6607this way.)
6608
6609In addition, the @option{-I-} option inhibits the use of the current
6610directory (where the current input file came from) as the first search
6611directory for @samp{#include "@var{file}"}. There is no way to
6612override this effect of @option{-I-}. With @option{-I.} you can specify
6613searching the directory which was current when the compiler was
6614invoked. That is not exactly the same as what the preprocessor does
6615by default, but it is often satisfactory.
6616
6617@option{-I-} does not inhibit the use of the standard system directories
6618for header files. Thus, @option{-I-} and @option{-nostdinc} are
6619independent.
74291a4b
MM
6620@end table
6621
ee457005
JM
6622@c man end
6623
a743d340
NC
6624@node Spec Files
6625@section Specifying subprocesses and the switches to pass to them
6626@cindex Spec Files
d2d42a91 6627
bedc7537 6628@command{gcc} is a driver program. It performs its job by invoking a
a743d340
NC
6629sequence of other programs to do the work of compiling, assembling and
6630linking. GCC interprets its command-line parameters and uses these to
6631deduce which programs it should invoke, and which command-line options
c21cd8b1 6632it ought to place on their command lines. This behavior is controlled
a743d340
NC
6633by @dfn{spec strings}. In most cases there is one spec string for each
6634program that GCC can invoke, but a few programs have multiple spec
c21cd8b1 6635strings to control their behavior. The spec strings built into GCC can
630d3d5a 6636be overridden by using the @option{-specs=} command-line switch to specify
a743d340
NC
6637a spec file.
6638
6639@dfn{Spec files} are plaintext files that are used to construct spec
6640strings. They consist of a sequence of directives separated by blank
6641lines. The type of directive is determined by the first non-whitespace
6642character on the line and it can be one of the following:
6643
6644@table @code
6645@item %@var{command}
6646Issues a @var{command} to the spec file processor. The commands that can
02f52e19 6647appear here are:
a743d340
NC
6648
6649@table @code
6650@item %include <@var{file}>
6651@cindex %include
6652Search for @var{file} and insert its text at the current point in the
6653specs file.
6654
6655@item %include_noerr <@var{file}>
6656@cindex %include_noerr
6657Just like @samp{%include}, but do not generate an error message if the include
6658file cannot be found.
6659
6660@item %rename @var{old_name} @var{new_name}
6661@cindex %rename
6662Rename the spec string @var{old_name} to @var{new_name}.
6663
6664@end table
6665
6666@item *[@var{spec_name}]:
6667This tells the compiler to create, override or delete the named spec
6668string. All lines after this directive up to the next directive or
6669blank line are considered to be the text for the spec string. If this
6670results in an empty string then the spec will be deleted. (Or, if the
6671spec did not exist, then nothing will happened.) Otherwise, if the spec
6672does not currently exist a new spec will be created. If the spec does
6673exist then its contents will be overridden by the text of this
6674directive, unless the first character of that text is the @samp{+}
6675character, in which case the text will be appended to the spec.
6676
6677@item [@var{suffix}]:
6678Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6679and up to the next directive or blank line are considered to make up the
02f52e19 6680spec string for the indicated suffix. When the compiler encounters an
a743d340
NC
6681input file with the named suffix, it will processes the spec string in
6682order to work out how to compile that file. For example:
6683
6684@smallexample
6685.ZZ:
6686z-compile -input %i
6687@end smallexample
6688
6689This says that any input file whose name ends in @samp{.ZZ} should be
6690passed to the program @samp{z-compile}, which should be invoked with the
630d3d5a 6691command-line switch @option{-input} and with the result of performing the
a743d340
NC
6692@samp{%i} substitution. (See below.)
6693
6694As an alternative to providing a spec string, the text that follows a
6695suffix directive can be one of the following:
6696
6697@table @code
6698@item @@@var{language}
6699This says that the suffix is an alias for a known @var{language}. This is
bedc7537 6700similar to using the @option{-x} command-line switch to GCC to specify a
a743d340
NC
6701language explicitly. For example:
6702
6703@smallexample
6704.ZZ:
6705@@c++
6706@end smallexample
6707
6708Says that .ZZ files are, in fact, C++ source files.
6709
6710@item #@var{name}
6711This causes an error messages saying:
6712
6713@smallexample
6714@var{name} compiler not installed on this system.
6715@end smallexample
6716@end table
6717
6718GCC already has an extensive list of suffixes built into it.
6719This directive will add an entry to the end of the list of suffixes, but
6720since the list is searched from the end backwards, it is effectively
6721possible to override earlier entries using this technique.
6722
6723@end table
6724
6725GCC has the following spec strings built into it. Spec files can
6726override these strings or create their own. Note that individual
02f52e19 6727targets can also add their own spec strings to this list.
a743d340
NC
6728
6729@smallexample
6730asm Options to pass to the assembler
6731asm_final Options to pass to the assembler post-processor
6732cpp Options to pass to the C preprocessor
6733cc1 Options to pass to the C compiler
6734cc1plus Options to pass to the C++ compiler
6735endfile Object files to include at the end of the link
6736link Options to pass to the linker
6737lib Libraries to include on the command line to the linker
6738libgcc Decides which GCC support library to pass to the linker
6739linker Sets the name of the linker
6740predefines Defines to be passed to the C preprocessor
310668e8
JM
6741signed_char Defines to pass to CPP to say whether @code{char} is signed
6742 by default
a743d340
NC
6743startfile Object files to include at the start of the link
6744@end smallexample
6745
6746Here is a small example of a spec file:
6747
6748@smallexample
6749%rename lib old_lib
6750
6751*lib:
6752--start-group -lgcc -lc -leval1 --end-group %(old_lib)
6753@end smallexample
6754
6755This example renames the spec called @samp{lib} to @samp{old_lib} and
6756then overrides the previous definition of @samp{lib} with a new one.
6757The new definition adds in some extra command-line options before
6758including the text of the old definition.
6759
6760@dfn{Spec strings} are a list of command-line options to be passed to their
6761corresponding program. In addition, the spec strings can contain
6762@samp{%}-prefixed sequences to substitute variable text or to
6763conditionally insert text into the command line. Using these constructs
6764it is possible to generate quite complex command lines.
6765
6766Here is a table of all defined @samp{%}-sequences for spec
6767strings. Note that spaces are not generated automatically around the
6768results of expanding these sequences. Therefore you can concatenate them
02f52e19 6769together or combine them with constant text in a single argument.
a743d340
NC
6770
6771@table @code
6772@item %%
6773Substitute one @samp{%} into the program name or argument.
6774
6775@item %i
6776Substitute the name of the input file being processed.
6777
6778@item %b
6779Substitute the basename of the input file being processed.
6780This is the substring up to (and not including) the last period
6781and not including the directory.
6782
371e300b
NC
6783@item %B
6784This is the same as @samp{%b}, but include the file suffix (text after
6785the last period).
6786
a743d340
NC
6787@item %d
6788Marks the argument containing or following the @samp{%d} as a
6789temporary file name, so that that file will be deleted if GCC exits
6790successfully. Unlike @samp{%g}, this contributes no text to the
02f52e19 6791argument.
a743d340
NC
6792
6793@item %g@var{suffix}
6794Substitute a file name that has suffix @var{suffix} and is chosen
6795once per compilation, and mark the argument in the same way as
6796@samp{%d}. To reduce exposure to denial-of-service attacks, the file
02f52e19 6797name is now chosen in a way that is hard to predict even when previously
695ac33f 6798chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
a743d340
NC
6799might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
6800the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6801treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
6802was simply substituted with a file name chosen once per compilation,
6803without regard to any appended suffix (which was therefore treated
6804just like ordinary text), making such attacks more likely to succeed.
6805
6806@item %u@var{suffix}
6807Like @samp{%g}, but generates a new temporary file name even if
6808@samp{%u@var{suffix}} was already seen.
6809
6810@item %U@var{suffix}
6811Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6812new one if there is no such last file name. In the absence of any
6813@samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
695ac33f 6814the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
a743d340
NC
6815would involve the generation of two distinct file names, one
6816for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
6817simply substituted with a file name chosen for the previous @samp{%u},
6818without regard to any appended suffix.
6819
4977bab6 6820@item %j@var{suffix}
aee96fe9 6821Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
371e300b
NC
6822writable, and if save-temps is off; otherwise, substitute the name
6823of a temporary file, just like @samp{%u}. This temporary file is not
6824meant for communication between processes, but rather as a junk
6825disposal mechanism.
6826
4977bab6
ZW
6827@item %|@var{suffix}
6828@itemx %m@var{suffix}
6829Like @samp{%g}, except if @option{-pipe} is in effect. In that case
6830@samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6831all. These are the two most common ways to instruct a program that it
6832should read from standard input or write to standard output. If you
6833need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6834construct: see for example @file{f/lang-specs.h}.
6835
371e300b
NC
6836@item %.@var{SUFFIX}
6837Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
767094dd 6838when it is subsequently output with @samp{%*}. @var{SUFFIX} is
371e300b
NC
6839terminated by the next space or %.
6840
a743d340
NC
6841@item %w
6842Marks the argument containing or following the @samp{%w} as the
6843designated output file of this compilation. This puts the argument
6844into the sequence of arguments that @samp{%o} will substitute later.
6845
6846@item %o
6847Substitutes the names of all the output files, with spaces
6848automatically placed around them. You should write spaces
6849around the @samp{%o} as well or the results are undefined.
6850@samp{%o} is for use in the specs for running the linker.
6851Input files whose names have no recognized suffix are not compiled
6852at all, but they are included among the output files, so they will
6853be linked.
6854
6855@item %O
6856Substitutes the suffix for object files. Note that this is
6857handled specially when it immediately follows @samp{%g, %u, or %U},
6858because of the need for those to form complete file names. The
6859handling is such that @samp{%O} is treated exactly as if it had already
6860been substituted, except that @samp{%g, %u, and %U} do not currently
6861support additional @var{suffix} characters following @samp{%O} as they would
6862following, for example, @samp{.o}.
6863
6864@item %p
6865Substitutes the standard macro predefinitions for the
6866current target machine. Use this when running @code{cpp}.
6867
6868@item %P
6869Like @samp{%p}, but puts @samp{__} before and after the name of each
6870predefined macro, except for macros that start with @samp{__} or with
c1030c7c 6871@samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
161d7b59 6872C@.
a743d340
NC
6873
6874@item %I
047d636f 6875Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
2b6dd222 6876@option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
047d636f 6877@option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
2b6dd222 6878and @option{-imultilib} as necessary.
a743d340
NC
6879
6880@item %s
6881Current argument is the name of a library or startup file of some sort.
6882Search for that file in a standard list of directories and substitute
02f52e19 6883the full name found.
a743d340
NC
6884
6885@item %e@var{str}
6886Print @var{str} as an error message. @var{str} is terminated by a newline.
6887Use this when inconsistent options are detected.
6888
a743d340
NC
6889@item %(@var{name})
6890Substitute the contents of spec string @var{name} at this point.
6891
6892@item %[@var{name}]
630d3d5a 6893Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
a743d340
NC
6894
6895@item %x@{@var{option}@}
6896Accumulate an option for @samp{%X}.
6897
6898@item %X
630d3d5a 6899Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
a743d340
NC
6900spec string.
6901
6902@item %Y
630d3d5a 6903Output the accumulated assembler options specified by @option{-Wa}.
a743d340
NC
6904
6905@item %Z
630d3d5a 6906Output the accumulated preprocessor options specified by @option{-Wp}.
a743d340 6907
a743d340
NC
6908@item %a
6909Process the @code{asm} spec. This is used to compute the
6910switches to be passed to the assembler.
6911
6912@item %A
6913Process the @code{asm_final} spec. This is a spec string for
6914passing switches to an assembler post-processor, if such a program is
6915needed.
6916
6917@item %l
6918Process the @code{link} spec. This is the spec for computing the
6919command line passed to the linker. Typically it will make use of the
6920@samp{%L %G %S %D and %E} sequences.
6921
6922@item %D
630d3d5a 6923Dump out a @option{-L} option for each directory that GCC believes might
a743d340 6924contain startup files. If the target supports multilibs then the
02f52e19 6925current multilib directory will be prepended to each of these paths.
a743d340
NC
6926
6927@item %L
6928Process the @code{lib} spec. This is a spec string for deciding which
02f52e19 6929libraries should be included on the command line to the linker.
a743d340
NC
6930
6931@item %G
6932Process the @code{libgcc} spec. This is a spec string for deciding
02f52e19 6933which GCC support library should be included on the command line to the linker.
a743d340
NC
6934
6935@item %S
6936Process the @code{startfile} spec. This is a spec for deciding which
6937object files should be the first ones passed to the linker. Typically
02f52e19 6938this might be a file named @file{crt0.o}.
a743d340
NC
6939
6940@item %E
6941Process the @code{endfile} spec. This is a spec string that specifies
02f52e19 6942the last object files that will be passed to the linker.
a743d340
NC
6943
6944@item %C
6945Process the @code{cpp} spec. This is used to construct the arguments
6946to be passed to the C preprocessor.
6947
a743d340
NC
6948@item %1
6949Process the @code{cc1} spec. This is used to construct the options to be
6950passed to the actual C compiler (@samp{cc1}).
6951
6952@item %2
6953Process the @code{cc1plus} spec. This is used to construct the options to be
6954passed to the actual C++ compiler (@samp{cc1plus}).
6955
6956@item %*
6957Substitute the variable part of a matched option. See below.
6958Note that each comma in the substituted string is replaced by
6959a single space.
6960
4977bab6
ZW
6961@item %<@code{S}
6962Remove all occurrences of @code{-S} from the command line. Note---this
6963command is position dependent. @samp{%} commands in the spec string
6964before this one will see @code{-S}, @samp{%} commands in the spec string
6965after this one will not.
6966
f3226a90
JT
6967@item %:@var{function}(@var{args})
6968Call the named function @var{function}, passing it @var{args}.
6969@var{args} is first processed as a nested spec string, then split
6970into an argument vector in the usual fashion. The function returns
6971a string which is processed as if it had appeared literally as part
6972of the current spec.
6973
6974The following built-in spec functions are provided:
6975
6976@table @code
6977@item @code{if-exists}
6978The @code{if-exists} spec function takes one argument, an absolute
6979pathname to a file. If the file exists, @code{if-exists} returns the
6980pathname. Here is a small example of its usage:
6981
6982@smallexample
6983*startfile:
6984crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6985@end smallexample
152a5a9c
JT
6986
6987@item @code{if-exists-else}
6988The @code{if-exists-else} spec function is similar to the @code{if-exists}
6989spec function, except that it takes two arguments. The first argument is
6990an absolute pathname to a file. If the file exists, @code{if-exists-else}
6991returns the pathname. If it does not exist, it returns the second argument.
6992This way, @code{if-exists-else} can be used to select one file or another,
6993based on the existence of the first. Here is a small example of its usage:
6994
daf2f129 6995@smallexample
152a5a9c 6996*startfile:
f5034c5e
JM
6997crt0%O%s %:if-exists(crti%O%s) \
6998%:if-exists-else(crtbeginT%O%s crtbegin%O%s)
152a5a9c 6999@end smallexample
3dd53121
AP
7000
7001@item @code{replace-outfile}
7002The @code{replace-outfile} spec function takes two arguments. It looks for the
7003first argument in the outfiles array and replaces it with the second argument. Here
7004is a small example of its usage:
7005
7006@smallexample
7007%@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7008@end smallexample
7009
daf2f129 7010@end table
f3226a90 7011
a743d340 7012@item %@{@code{S}@}
161d7b59 7013Substitutes the @code{-S} switch, if that switch was given to GCC@.
a743d340
NC
7014If that switch was not specified, this substitutes nothing. Note that
7015the leading dash is omitted when specifying this option, and it is
7016automatically inserted if the substitution is performed. Thus the spec
630d3d5a
JM
7017string @samp{%@{foo@}} would match the command-line option @option{-foo}
7018and would output the command line option @option{-foo}.
a743d340
NC
7019
7020@item %W@{@code{S}@}
7021Like %@{@code{S}@} but mark last argument supplied within as a file to be
02f52e19 7022deleted on failure.
a743d340
NC
7023
7024@item %@{@code{S}*@}
7025Substitutes all the switches specified to GCC whose names start
7026with @code{-S}, but which also take an argument. This is used for
695ac33f 7027switches like @option{-o}, @option{-D}, @option{-I}, etc.
630d3d5a 7028GCC considers @option{-o foo} as being
a743d340 7029one switch whose names starts with @samp{o}. %@{o*@} would substitute this
02f52e19 7030text, including the space. Thus two arguments would be generated.
a743d340 7031
371e300b
NC
7032@item %@{@code{S}*&@code{T}*@}
7033Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7034(the order of @code{S} and @code{T} in the spec is not significant).
7035There can be any number of ampersand-separated variables; for each the
7036wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
7037
a743d340 7038@item %@{@code{S}:@code{X}@}
4977bab6 7039Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
a743d340
NC
7040
7041@item %@{!@code{S}:@code{X}@}
4977bab6 7042Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
a743d340 7043
4977bab6
ZW
7044@item %@{@code{S}*:@code{X}@}
7045Substitutes @code{X} if one or more switches whose names start with
7046@code{-S} are specified to GCC@. Normally @code{X} is substituted only
7047once, no matter how many such switches appeared. However, if @code{%*}
7048appears somewhere in @code{X}, then @code{X} will be substituted once
7049for each matching switch, with the @code{%*} replaced by the part of
7050that switch that matched the @code{*}.
a743d340
NC
7051
7052@item %@{.@code{S}:@code{X}@}
4977bab6 7053Substitutes @code{X}, if processing a file with suffix @code{S}.
a743d340
NC
7054
7055@item %@{!.@code{S}:@code{X}@}
4977bab6 7056Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
a743d340
NC
7057
7058@item %@{@code{S}|@code{P}:@code{X}@}
4977bab6
ZW
7059Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7060This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7061although they have a stronger binding than the @samp{|}. If @code{%*}
7062appears in @code{X}, all of the alternatives must be starred, and only
7063the first matching alternative is substituted.
7064
7065For example, a spec string like this:
a743d340
NC
7066
7067@smallexample
7068%@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7069@end smallexample
7070
7071will output the following command-line options from the following input
7072command-line options:
7073
7074@smallexample
7075fred.c -foo -baz
7076jim.d -bar -boggle
7077-d fred.c -foo -baz -boggle
7078-d jim.d -bar -baz -boggle
7079@end smallexample
7080
4977bab6
ZW
7081@item %@{S:X; T:Y; :D@}
7082
c0cbdbd9
KH
7083If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7084given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
daf2f129 7085be as many clauses as you need. This may be combined with @code{.},
4977bab6
ZW
7086@code{!}, @code{|}, and @code{*} as needed.
7087
7088
a743d340
NC
7089@end table
7090
4977bab6
ZW
7091The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7092construct may contain other nested @samp{%} constructs or spaces, or
7093even newlines. They are processed as usual, as described above.
7094Trailing white space in @code{X} is ignored. White space may also
7095appear anywhere on the left side of the colon in these constructs,
7096except between @code{.} or @code{*} and the corresponding word.
a743d340 7097
4977bab6
ZW
7098The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7099handled specifically in these constructs. If another value of
7100@option{-O} or the negated form of a @option{-f}, @option{-m}, or
7101@option{-W} switch is found later in the command line, the earlier
7102switch value is ignored, except with @{@code{S}*@} where @code{S} is
7103just one letter, which passes all matching options.
a743d340 7104
4977bab6
ZW
7105The character @samp{|} at the beginning of the predicate text is used to
7106indicate that a command should be piped to the following command, but
7107only if @option{-pipe} is specified.
a743d340
NC
7108
7109It is built into GCC which switches take arguments and which do not.
7110(You might think it would be useful to generalize this to allow each
7111compiler's spec to say which switches take arguments. But this cannot
7112be done in a consistent fashion. GCC cannot even decide which input
7113files have been specified without knowing which switches take arguments,
7114and it must know which input files to compile in order to tell which
02f52e19 7115compilers to run).
a743d340 7116
630d3d5a 7117GCC also knows implicitly that arguments starting in @option{-l} are to be
a743d340
NC
7118treated as compiler output files, and passed to the linker in their
7119proper position among the other output files.
7120
ee457005
JM
7121@c man begin OPTIONS
7122
74291a4b
MM
7123@node Target Options
7124@section Specifying Target Machine and Compiler Version
7125@cindex target options
7126@cindex cross compiling
7127@cindex specifying machine version
7128@cindex specifying compiler version and target machine
7129@cindex compiler version, specifying
7130@cindex target machine, specifying
7131
37a4aa31
GK
7132The usual way to run GCC is to run the executable called @file{gcc}, or
7133@file{<machine>-gcc} when cross-compiling, or
7134@file{<machine>-gcc-<version>} to run a version other than the one that
7135was installed last. Sometimes this is inconvenient, so GCC provides
7136options that will switch to another cross-compiler or version.
74291a4b 7137
2642624b 7138@table @gcctabopt
74291a4b 7139@item -b @var{machine}
cd3bb277 7140@opindex b
74291a4b 7141The argument @var{machine} specifies the target machine for compilation.
74291a4b
MM
7142
7143The value to use for @var{machine} is the same as was specified as the
0c2d1a2a 7144machine type when configuring GCC as a cross-compiler. For
74291a4b 7145example, if a cross-compiler was configured with @samp{configure
3300bf07
PG
7146arm-elf}, meaning to compile for an arm processor with elf binaries,
7147then you would specify @option{-b arm-elf} to run that cross compiler.
7148Because there are other options beginning with @option{-b}, the
7149configuration must contain a hyphen.
74291a4b 7150
37a4aa31
GK
7151@item -V @var{version}
7152@opindex V
7153The argument @var{version} specifies which version of GCC to run.
7154This is useful when multiple versions are installed. For example,
3300bf07 7155@var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
74291a4b
MM
7156@end table
7157
37a4aa31
GK
7158The @option{-V} and @option{-b} options work by running the
7159@file{<machine>-gcc-<version>} executable, so there's no real reason to
7160use them if you can just run that directly.
74291a4b
MM
7161
7162@node Submodel Options
7163@section Hardware Models and Configurations
7164@cindex submodel options
7165@cindex specifying hardware config
7166@cindex hardware models and configurations, specifying
7167@cindex machine dependent options
7168
630d3d5a 7169Earlier we discussed the standard option @option{-b} which chooses among
74291a4b 7170different installed compilers for completely different target
8aeea6e6 7171machines, such as VAX vs.@: 68000 vs.@: 80386.
74291a4b
MM
7172
7173In addition, each of these target machine types can have its own
7174special options, starting with @samp{-m}, to choose among various
7175hardware models or configurations---for example, 68010 vs 68020,
7176floating coprocessor or none. A single installed version of the
7177compiler can compile for any model or configuration, according to the
7178options specified.
7179
7180Some configurations of the compiler also support additional special
7181options, usually for compatibility with other compilers on the same
7182platform.
7183
39bc1876
NS
7184@c This list is ordered alphanumerically by subsection name.
7185@c It should be the same order and spelling as these options are listed
7186@c in Machine Dependent Options
7187
74291a4b 7188@menu
39bc1876 7189* ARC Options::
74291a4b 7190* ARM Options::
39bc1876 7191* AVR Options::
0d4a78eb 7192* Blackfin Options::
39bc1876 7193* CRIS Options::
53054e77 7194* CRX Options::
48aec0bc 7195* Darwin Options::
74291a4b 7196* DEC Alpha Options::
d7c23cdc 7197* DEC Alpha/VMS Options::
39bc1876 7198* FRV Options::
464aea98 7199* GNU/Linux Options::
74291a4b 7200* H8/300 Options::
39bc1876
NS
7201* HPPA Options::
7202* i386 and x86-64 Options::
7203* IA-64 Options::
38b2d076 7204* M32C Options::
39bc1876
NS
7205* M32R/D Options::
7206* M680x0 Options::
7207* M68hc1x Options::
7208* MCore Options::
7209* MIPS Options::
7210* MMIX Options::
7211* MN10300 Options::
6c9ac67a 7212* MT Options::
39bc1876
NS
7213* PDP-11 Options::
7214* PowerPC Options::
7215* RS/6000 and PowerPC Options::
7216* S/390 and zSeries Options::
74291a4b 7217* SH Options::
39bc1876 7218* SPARC Options::
74291a4b 7219* System V Options::
282a61e6 7220* TMS320C3x/C4x Options::
f84271d9 7221* V850 Options::
39bc1876
NS
7222* VAX Options::
7223* x86-64 Options::
69a0611f 7224* Xstormy16 Options::
03984308 7225* Xtensa Options::
39bc1876 7226* zSeries Options::
74291a4b
MM
7227@end menu
7228
39bc1876
NS
7229@node ARC Options
7230@subsection ARC Options
7231@cindex ARC Options
74291a4b 7232
39bc1876 7233These options are defined for ARC implementations:
74291a4b 7234
2642624b 7235@table @gcctabopt
39bc1876
NS
7236@item -EL
7237@opindex EL
7238Compile code for little endian mode. This is the default.
74cf1c6d 7239
39bc1876
NS
7240@item -EB
7241@opindex EB
7242Compile code for big endian mode.
74291a4b 7243
39bc1876
NS
7244@item -mmangle-cpu
7245@opindex mmangle-cpu
7246Prepend the name of the cpu to all public symbol names.
7247In multiple-processor systems, there are many ARC variants with different
7248instruction and register set characteristics. This flag prevents code
7249compiled for one cpu to be linked with code compiled for another.
7250No facility exists for handling variants that are ``almost identical''.
7251This is an all or nothing option.
74291a4b 7252
39bc1876
NS
7253@item -mcpu=@var{cpu}
7254@opindex mcpu
7255Compile code for ARC variant @var{cpu}.
7256Which variants are supported depend on the configuration.
7257All variants support @option{-mcpu=base}, this is the default.
74291a4b 7258
39bc1876
NS
7259@item -mtext=@var{text-section}
7260@itemx -mdata=@var{data-section}
7261@itemx -mrodata=@var{readonly-data-section}
7262@opindex mtext
7263@opindex mdata
7264@opindex mrodata
7265Put functions, data, and readonly data in @var{text-section},
7266@var{data-section}, and @var{readonly-data-section} respectively
7267by default. This can be overridden with the @code{section} attribute.
7268@xref{Variable Attributes}.
74291a4b 7269
39bc1876 7270@end table
74291a4b 7271
39bc1876
NS
7272@node ARM Options
7273@subsection ARM Options
7274@cindex ARM options
74291a4b 7275
39bc1876
NS
7276These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7277architectures:
74cf1c6d 7278
39bc1876
NS
7279@table @gcctabopt
7280@item -mabi=@var{name}
7281@opindex mabi
8a36672b 7282Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
077fc835 7283@samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
74cf1c6d 7284
39bc1876
NS
7285@item -mapcs-frame
7286@opindex mapcs-frame
7287Generate a stack frame that is compliant with the ARM Procedure Call
7288Standard for all functions, even if this is not strictly necessary for
7289correct execution of the code. Specifying @option{-fomit-frame-pointer}
7290with this option will cause the stack frames not to be generated for
7291leaf functions. The default is @option{-mno-apcs-frame}.
74291a4b 7292
39bc1876
NS
7293@item -mapcs
7294@opindex mapcs
7295This is a synonym for @option{-mapcs-frame}.
74291a4b 7296
39bc1876
NS
7297@ignore
7298@c not currently implemented
7299@item -mapcs-stack-check
7300@opindex mapcs-stack-check
7301Generate code to check the amount of stack space available upon entry to
7302every function (that actually uses some stack space). If there is
7303insufficient space available then either the function
7304@samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7305called, depending upon the amount of stack space required. The run time
7306system is required to provide these functions. The default is
7307@option{-mno-apcs-stack-check}, since this produces smaller code.
74cf1c6d 7308
39bc1876
NS
7309@c not currently implemented
7310@item -mapcs-float
7311@opindex mapcs-float
7312Pass floating point arguments using the float point registers. This is
7313one of the variants of the APCS@. This option is recommended if the
7314target hardware has a floating point unit or if a lot of floating point
7315arithmetic is going to be performed by the code. The default is
7316@option{-mno-apcs-float}, since integer only code is slightly increased in
7317size if @option{-mapcs-float} is used.
74291a4b 7318
39bc1876
NS
7319@c not currently implemented
7320@item -mapcs-reentrant
7321@opindex mapcs-reentrant
7322Generate reentrant, position independent code. The default is
7323@option{-mno-apcs-reentrant}.
7324@end ignore
74291a4b 7325
39bc1876
NS
7326@item -mthumb-interwork
7327@opindex mthumb-interwork
7328Generate code which supports calling between the ARM and Thumb
7329instruction sets. Without this option the two instruction sets cannot
7330be reliably used inside one program. The default is
7331@option{-mno-thumb-interwork}, since slightly larger code is generated
7332when @option{-mthumb-interwork} is specified.
7333
7334@item -mno-sched-prolog
7335@opindex mno-sched-prolog
7336Prevent the reordering of instructions in the function prolog, or the
7337merging of those instruction with the instructions in the function's
7338body. This means that all functions will start with a recognizable set
7339of instructions (or in fact one of a choice from a small set of
7340different function prologues), and this information can be used to
7341locate the start if functions inside an executable piece of code. The
7342default is @option{-msched-prolog}.
7343
7344@item -mhard-float
7345@opindex mhard-float
7346Generate output containing floating point instructions. This is the
7347default.
861bb6c1 7348
74291a4b 7349@item -msoft-float
cd3bb277 7350@opindex msoft-float
74291a4b 7351Generate output containing library calls for floating point.
39bc1876 7352@strong{Warning:} the requisite libraries are not available for all ARM
74291a4b 7353targets. Normally the facilities of the machine's usual C compiler are
39bc1876
NS
7354used, but this cannot be done directly in cross-compilation. You must make
7355your own arrangements to provide suitable library functions for
7356cross-compilation.
74291a4b 7357
39bc1876
NS
7358@option{-msoft-float} changes the calling convention in the output file;
7359therefore, it is only useful if you compile @emph{all} of a program with
7360this option. In particular, you need to compile @file{libgcc.a}, the
7361library that comes with GCC, with @option{-msoft-float} in order for
7362this to work.
74291a4b 7363
39bc1876
NS
7364@item -mfloat-abi=@var{name}
7365@opindex mfloat-abi
7366Specifies which ABI to use for floating point values. Permissible values
7367are: @samp{soft}, @samp{softfp} and @samp{hard}.
74291a4b 7368
39bc1876
NS
7369@samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7370and @option{-mhard-float} respectively. @samp{softfp} allows the generation
7371of floating point instructions, but still uses the soft-float calling
7372conventions.
74291a4b 7373
39bc1876
NS
7374@item -mlittle-endian
7375@opindex mlittle-endian
7376Generate code for a processor running in little-endian mode. This is
7377the default for all standard configurations.
74291a4b 7378
39bc1876
NS
7379@item -mbig-endian
7380@opindex mbig-endian
7381Generate code for a processor running in big-endian mode; the default is
7382to compile code for a little-endian processor.
74291a4b 7383
39bc1876
NS
7384@item -mwords-little-endian
7385@opindex mwords-little-endian
7386This option only applies when generating code for big-endian processors.
7387Generate code for a little-endian word order but a big-endian byte
7388order. That is, a byte order of the form @samp{32107654}. Note: this
7389option should only be used if you require compatibility with code for
7390big-endian ARM processors generated by versions of the compiler prior to
73912.8.
74291a4b 7392
39bc1876
NS
7393@item -mcpu=@var{name}
7394@opindex mcpu
7395This specifies the name of the target ARM processor. GCC uses this name
7396to determine what kind of instructions it can emit when generating
7397assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
7398@samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7399@samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7400@samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7401@samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
d98a72fd
RE
7402@samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7403@samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
39bc1876 7404@samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
d98a72fd
RE
7405@samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7406@samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7407@samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
f9e8581a 7408@samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
fa91adc6
PB
7409@samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7410@samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
39bc1876 7411@samp{ep9312}.
74291a4b 7412
39bc1876
NS
7413@itemx -mtune=@var{name}
7414@opindex mtune
7415This option is very similar to the @option{-mcpu=} option, except that
7416instead of specifying the actual target processor type, and hence
7417restricting which instructions can be used, it specifies that GCC should
7418tune the performance of the code as if the target were of the type
7419specified in this option, but still choosing the instructions that it
7420will generate based on the cpu specified by a @option{-mcpu=} option.
7421For some ARM implementations better performance can be obtained by using
7422this option.
861bb6c1 7423
39bc1876
NS
7424@item -march=@var{name}
7425@opindex march
7426This specifies the name of the target ARM architecture. GCC uses this
7427name to determine what kind of instructions it can emit when generating
7428assembly code. This option can be used in conjunction with or instead
7429of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
7430@samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7431@samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7432@samp{iwmmxt}, @samp{ep9312}.
861bb6c1 7433
39bc1876
NS
7434@item -mfpu=@var{name}
7435@itemx -mfpe=@var{number}
7436@itemx -mfp=@var{number}
7437@opindex mfpu
7438@opindex mfpe
7439@opindex mfp
7440This specifies what floating point hardware (or hardware emulation) is
7441available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
7442@samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
7443are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7444with older versions of GCC@.
861bb6c1 7445
39bc1876
NS
7446If @option{-msoft-float} is specified this specifies the format of
7447floating point values.
fb868474 7448
39bc1876
NS
7449@item -mstructure-size-boundary=@var{n}
7450@opindex mstructure-size-boundary
7451The size of all structures and unions will be rounded up to a multiple
7452of the number of bits set by this option. Permissible values are 8, 32
7453and 64. The default value varies for different toolchains. For the COFF
7454targeted toolchain the default value is 8. A value of 64 is only allowed
7455if the underlying ABI supports it.
b71733d5 7456
39bc1876
NS
7457Specifying the larger number can produce faster, more efficient code, but
7458can also increase the size of the program. Different values are potentially
7459incompatible. Code compiled with one value cannot necessarily expect to
7460work with code or libraries compiled with another value, if they exchange
7461information using structures or unions.
24f9c4df 7462
39bc1876
NS
7463@item -mabort-on-noreturn
7464@opindex mabort-on-noreturn
7465Generate a call to the function @code{abort} at the end of a
7466@code{noreturn} function. It will be executed if the function tries to
7467return.
24f9c4df 7468
39bc1876
NS
7469@item -mlong-calls
7470@itemx -mno-long-calls
7471@opindex mlong-calls
7472@opindex mno-long-calls
7473Tells the compiler to perform function calls by first loading the
7474address of the function into a register and then performing a subroutine
7475call on this register. This switch is needed if the target function
7476will lie outside of the 64 megabyte addressing range of the offset based
7477version of subroutine call instruction.
24f9c4df 7478
39bc1876
NS
7479Even if this switch is enabled, not all function calls will be turned
7480into long calls. The heuristic is that static functions, functions
7481which have the @samp{short-call} attribute, functions that are inside
7482the scope of a @samp{#pragma no_long_calls} directive and functions whose
7483definitions have already been compiled within the current compilation
7484unit, will not be turned into long calls. The exception to this rule is
7485that weak function definitions, functions with the @samp{long-call}
7486attribute or the @samp{section} attribute, and functions that are within
7487the scope of a @samp{#pragma long_calls} directive, will always be
7488turned into long calls.
24f9c4df 7489
39bc1876
NS
7490This feature is not enabled by default. Specifying
7491@option{-mno-long-calls} will restore the default behavior, as will
7492placing the function calls within the scope of a @samp{#pragma
7493long_calls_off} directive. Note these switches have no effect on how
7494the compiler generates code to handle function calls via function
7495pointers.
24f9c4df 7496
39bc1876
NS
7497@item -mnop-fun-dllimport
7498@opindex mnop-fun-dllimport
7499Disable support for the @code{dllimport} attribute.
74291a4b 7500
39bc1876
NS
7501@item -msingle-pic-base
7502@opindex msingle-pic-base
7503Treat the register used for PIC addressing as read-only, rather than
7504loading it in the prologue for each function. The run-time system is
7505responsible for initializing this register with an appropriate value
7506before execution begins.
2856c3e3 7507
39bc1876
NS
7508@item -mpic-register=@var{reg}
7509@opindex mpic-register
7510Specify the register to be used for PIC addressing. The default is R10
7511unless stack-checking is enabled, when R9 is used.
2856c3e3 7512
39bc1876
NS
7513@item -mcirrus-fix-invalid-insns
7514@opindex mcirrus-fix-invalid-insns
7515@opindex mno-cirrus-fix-invalid-insns
7516Insert NOPs into the instruction stream to in order to work around
7517problems with invalid Maverick instruction combinations. This option
7518is only valid if the @option{-mcpu=ep9312} option has been used to
7519enable generation of instructions for the Cirrus Maverick floating
7520point co-processor. This option is not enabled by default, since the
7521problem is only present in older Maverick implementations. The default
7522can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7523switch.
2856c3e3 7524
39bc1876
NS
7525@item -mpoke-function-name
7526@opindex mpoke-function-name
7527Write the name of each function into the text section, directly
7528preceding the function prologue. The generated code is similar to this:
2856c3e3 7529
39bc1876
NS
7530@smallexample
7531 t0
7532 .ascii "arm_poke_function_name", 0
7533 .align
7534 t1
7535 .word 0xff000000 + (t1 - t0)
7536 arm_poke_function_name
7537 mov ip, sp
7538 stmfd sp!, @{fp, ip, lr, pc@}
7539 sub fp, ip, #4
7540@end smallexample
f077f169 7541
39bc1876
NS
7542When performing a stack backtrace, code can inspect the value of
7543@code{pc} stored at @code{fp + 0}. If the trace function then looks at
7544location @code{pc - 12} and the top 8 bits are set, then we know that
7545there is a function name embedded immediately preceding this location
7546and has length @code{((pc[-3]) & 0xff000000)}.
2856c3e3 7547
39bc1876
NS
7548@item -mthumb
7549@opindex mthumb
7550Generate code for the 16-bit Thumb instruction set. The default is to
7551use the 32-bit ARM instruction set.
8a0b86f5 7552
39bc1876
NS
7553@item -mtpcs-frame
7554@opindex mtpcs-frame
7555Generate a stack frame that is compliant with the Thumb Procedure Call
7556Standard for all non-leaf functions. (A leaf function is one that does
7557not call any other functions.) The default is @option{-mno-tpcs-frame}.
058edcdb 7558
39bc1876
NS
7559@item -mtpcs-leaf-frame
7560@opindex mtpcs-leaf-frame
7561Generate a stack frame that is compliant with the Thumb Procedure Call
7562Standard for all leaf functions. (A leaf function is one that does
7563not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
2856c3e3 7564
39bc1876
NS
7565@item -mcallee-super-interworking
7566@opindex mcallee-super-interworking
7567Gives all externally visible functions in the file being compiled an ARM
7568instruction set header which switches to Thumb mode before executing the
7569rest of the function. This allows these functions to be called from
7570non-interworking code.
7571
7572@item -mcaller-super-interworking
7573@opindex mcaller-super-interworking
7574Allows calls via function pointers (including virtual functions) to
7575execute correctly regardless of whether the target code has been
7576compiled for interworking or not. There is a small overhead in the cost
7577of executing a function pointer if this option is enabled.
2856c3e3 7578
d3585b76
DJ
7579@item -mtp=@var{name}
7580@opindex mtp
7581Specify the access model for the thread local storage pointer. The valid
7582models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7583@option{cp15}, which fetches the thread pointer from @code{cp15} directly
7584(supported in the arm6k architecture), and @option{auto}, which uses the
7585best available method for the selected processor. The default setting is
7586@option{auto}.
7587
2856c3e3
SC
7588@end table
7589
39bc1876
NS
7590@node AVR Options
7591@subsection AVR Options
7592@cindex AVR Options
74291a4b 7593
39bc1876 7594These options are defined for AVR implementations:
74291a4b 7595
2642624b 7596@table @gcctabopt
39bc1876
NS
7597@item -mmcu=@var{mcu}
7598@opindex mmcu
7599Specify ATMEL AVR instruction set or MCU type.
74291a4b 7600
39bc1876
NS
7601Instruction set avr1 is for the minimal AVR core, not supported by the C
7602compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7603attiny11, attiny12, attiny15, attiny28).
74291a4b 7604
39bc1876
NS
7605Instruction set avr2 (default) is for the classic AVR core with up to
76068K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7607at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7608at90c8534, at90s8535).
74291a4b 7609
39bc1876
NS
7610Instruction set avr3 is for the classic AVR core with up to 128K program
7611memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
74291a4b 7612
39bc1876
NS
7613Instruction set avr4 is for the enhanced AVR core with up to 8K program
7614memory space (MCU types: atmega8, atmega83, atmega85).
74291a4b 7615
39bc1876
NS
7616Instruction set avr5 is for the enhanced AVR core with up to 128K program
7617memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7618atmega64, atmega128, at43usb355, at94k).
74291a4b 7619
39bc1876
NS
7620@item -msize
7621@opindex msize
7622Output instruction sizes to the asm file.
74291a4b 7623
39bc1876
NS
7624@item -minit-stack=@var{N}
7625@opindex minit-stack
7626Specify the initial stack address, which may be a symbol or numeric value,
7627@samp{__stack} is the default.
74291a4b 7628
39bc1876
NS
7629@item -mno-interrupts
7630@opindex mno-interrupts
7631Generated code is not compatible with hardware interrupts.
7632Code size will be smaller.
74291a4b 7633
39bc1876
NS
7634@item -mcall-prologues
7635@opindex mcall-prologues
7636Functions prologues/epilogues expanded as call to appropriate
7637subroutines. Code size will be smaller.
74291a4b 7638
39bc1876
NS
7639@item -mno-tablejump
7640@opindex mno-tablejump
7641Do not generate tablejump insns which sometimes increase code size.
74291a4b 7642
39bc1876
NS
7643@item -mtiny-stack
7644@opindex mtiny-stack
7645Change only the low 8 bits of the stack pointer.
74291a4b 7646
39bc1876
NS
7647@item -mint8
7648@opindex mint8
8a36672b 7649Assume int to be 8 bit integer. This affects the sizes of all types: A
39bc1876 7650char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8a36672b 7651and long long will be 4 bytes. Please note that this option does not
39bc1876
NS
7652comply to the C standards, but it will provide you with smaller code
7653size.
7654@end table
74291a4b 7655
0d4a78eb
BS
7656@node Blackfin Options
7657@subsection Blackfin Options
7658@cindex Blackfin Options
7659
7660@table @gcctabopt
7661@item -momit-leaf-frame-pointer
7662@opindex momit-leaf-frame-pointer
7663Don't keep the frame pointer in a register for leaf functions. This
7664avoids the instructions to save, set up and restore frame pointers and
7665makes an extra register available in leaf functions. The option
7666@option{-fomit-frame-pointer} removes the frame pointer for all functions
7667which might make debugging harder.
7668
3fb192d2
BS
7669@item -mspecld-anomaly
7670@opindex mspecld-anomaly
0d4a78eb
BS
7671When enabled, the compiler will ensure that the generated code does not
7672contain speculative loads after jump instructions. This option is enabled
7673by default.
7674
3fb192d2
BS
7675@item -mno-specld-anomaly
7676@opindex mno-specld-anomaly
0d4a78eb
BS
7677Don't generate extra code to prevent speculative loads from occurring.
7678
3fb192d2 7679@item -mcsync-anomaly
161c21b6 7680@opindex mcsync-anomaly
3fb192d2
BS
7681When enabled, the compiler will ensure that the generated code does not
7682contain CSYNC or SSYNC instructions too soon after conditional branches.
7683This option is enabled by default.
7684
7685@item -mno-csync-anomaly
161c21b6 7686@opindex mno-csync-anomaly
3fb192d2
BS
7687Don't generate extra code to prevent CSYNC or SSYNC instructions from
7688occurring too soon after a conditional branch.
7689
0d4a78eb 7690@item -mlow-64k
9821b257 7691@opindex mlow-64k
0d4a78eb
BS
7692When enabled, the compiler is free to take advantage of the knowledge that
7693the entire program fits into the low 64k of memory.
7694
7695@item -mno-low-64k
7696@opindex mno-low-64k
7697Assume that the program is arbitrarily large. This is the default.
7698
7699@item -mid-shared-library
7700@opindex mid-shared-library
7701Generate code that supports shared libraries via the library ID method.
7702This allows for execute in place and shared libraries in an environment
7703without virtual memory management. This option implies @option{-fPIC}.
7704
7705@item -mno-id-shared-library
7706@opindex mno-id-shared-library
7707Generate code that doesn't assume ID based shared libraries are being used.
7708This is the default.
7709
7710@item -mshared-library-id=n
7711@opindex mshared-library-id
7712Specified the identification number of the ID based shared library being
7713compiled. Specifying a value of 0 will generate more compact code, specifying
7714other values will force the allocation of that number to the current
7715library but is no more space or time efficient than omitting this option.
b6877196
BS
7716
7717@item -mlong-calls
7718@itemx -mno-long-calls
7719@opindex mlong-calls
7720@opindex mno-long-calls
7721Tells the compiler to perform function calls by first loading the
7722address of the function into a register and then performing a subroutine
7723call on this register. This switch is needed if the target function
7724will lie outside of the 24 bit addressing range of the offset based
7725version of subroutine call instruction.
7726
7727This feature is not enabled by default. Specifying
7728@option{-mno-long-calls} will restore the default behavior. Note these
7729switches have no effect on how the compiler generates code to handle
7730function calls via function pointers.
0d4a78eb
BS
7731@end table
7732
39bc1876
NS
7733@node CRIS Options
7734@subsection CRIS Options
7735@cindex CRIS Options
74291a4b 7736
39bc1876 7737These options are defined specifically for the CRIS ports.
74291a4b 7738
39bc1876
NS
7739@table @gcctabopt
7740@item -march=@var{architecture-type}
7741@itemx -mcpu=@var{architecture-type}
7742@opindex march
7743@opindex mcpu
7744Generate code for the specified architecture. The choices for
7745@var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
8a36672b 7746respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
39bc1876
NS
7747Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7748@samp{v10}.
c219ddf7 7749
39bc1876
NS
7750@item -mtune=@var{architecture-type}
7751@opindex mtune
7752Tune to @var{architecture-type} everything applicable about the generated
7753code, except for the ABI and the set of available instructions. The
7754choices for @var{architecture-type} are the same as for
7755@option{-march=@var{architecture-type}}.
54284728 7756
39bc1876
NS
7757@item -mmax-stack-frame=@var{n}
7758@opindex mmax-stack-frame
7759Warn when the stack frame of a function exceeds @var{n} bytes.
54284728 7760
39bc1876
NS
7761@item -melinux-stacksize=@var{n}
7762@opindex melinux-stacksize
7763Only available with the @samp{cris-axis-aout} target. Arranges for
7764indications in the program to the kernel loader that the stack of the
7765program should be set to @var{n} bytes.
54284728 7766
39bc1876
NS
7767@item -metrax4
7768@itemx -metrax100
7769@opindex metrax4
7770@opindex metrax100
7771The options @option{-metrax4} and @option{-metrax100} are synonyms for
7772@option{-march=v3} and @option{-march=v8} respectively.
c0498f43 7773
39bc1876
NS
7774@item -mmul-bug-workaround
7775@itemx -mno-mul-bug-workaround
7776@opindex mmul-bug-workaround
7777@opindex mno-mul-bug-workaround
7778Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7779models where it applies. This option is active by default.
c0498f43 7780
39bc1876
NS
7781@item -mpdebug
7782@opindex mpdebug
7783Enable CRIS-specific verbose debug-related information in the assembly
7784code. This option also has the effect to turn off the @samp{#NO_APP}
7785formatted-code indicator to the assembler at the beginning of the
7786assembly file.
c0498f43 7787
39bc1876
NS
7788@item -mcc-init
7789@opindex mcc-init
7790Do not use condition-code results from previous instruction; always emit
7791compare and test instructions before use of condition codes.
74291a4b 7792
39bc1876
NS
7793@item -mno-side-effects
7794@opindex mno-side-effects
7795Do not emit instructions with side-effects in addressing modes other than
7796post-increment.
238b11b5 7797
39bc1876
NS
7798@item -mstack-align
7799@itemx -mno-stack-align
7800@itemx -mdata-align
7801@itemx -mno-data-align
7802@itemx -mconst-align
7803@itemx -mno-const-align
7804@opindex mstack-align
7805@opindex mno-stack-align
7806@opindex mdata-align
7807@opindex mno-data-align
7808@opindex mconst-align
7809@opindex mno-const-align
7810These options (no-options) arranges (eliminate arrangements) for the
7811stack-frame, individual data and constants to be aligned for the maximum
7812single data access size for the chosen CPU model. The default is to
7813arrange for 32-bit alignment. ABI details such as structure layout are
7814not affected by these options.
238b11b5 7815
39bc1876
NS
7816@item -m32-bit
7817@itemx -m16-bit
7818@itemx -m8-bit
7819@opindex m32-bit
7820@opindex m16-bit
7821@opindex m8-bit
7822Similar to the stack- data- and const-align options above, these options
7823arrange for stack-frame, writable data and constants to all be 32-bit,
782416-bit or 8-bit aligned. The default is 32-bit alignment.
238b11b5 7825
39bc1876
NS
7826@item -mno-prologue-epilogue
7827@itemx -mprologue-epilogue
7828@opindex mno-prologue-epilogue
7829@opindex mprologue-epilogue
7830With @option{-mno-prologue-epilogue}, the normal function prologue and
7831epilogue that sets up the stack-frame are omitted and no return
7832instructions or return sequences are generated in the code. Use this
7833option only together with visual inspection of the compiled code: no
7834warnings or errors are generated when call-saved registers must be saved,
7835or storage for local variable needs to be allocated.
238b11b5 7836
39bc1876
NS
7837@item -mno-gotplt
7838@itemx -mgotplt
7839@opindex mno-gotplt
7840@opindex mgotplt
7841With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7842instruction sequences that load addresses for functions from the PLT part
7843of the GOT rather than (traditional on other architectures) calls to the
8a36672b 7844PLT@. The default is @option{-mgotplt}.
238b11b5 7845
39bc1876
NS
7846@item -maout
7847@opindex maout
7848Legacy no-op option only recognized with the cris-axis-aout target.
c0498f43 7849
39bc1876
NS
7850@item -melf
7851@opindex melf
7852Legacy no-op option only recognized with the cris-axis-elf and
7853cris-axis-linux-gnu targets.
74291a4b 7854
39bc1876
NS
7855@item -melinux
7856@opindex melinux
7857Only recognized with the cris-axis-aout target, where it selects a
7858GNU/linux-like multilib, include files and instruction set for
7859@option{-march=v8}.
ded17aad 7860
39bc1876
NS
7861@item -mlinux
7862@opindex mlinux
7863Legacy no-op option only recognized with the cris-axis-linux-gnu target.
ded17aad 7864
39bc1876
NS
7865@item -sim
7866@opindex sim
7867This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7868to link with input-output functions from a simulator library. Code,
7869initialized data and zero-initialized data are allocated consecutively.
74291a4b 7870
39bc1876
NS
7871@item -sim2
7872@opindex sim2
7873Like @option{-sim}, but pass linker options to locate initialized data at
78740x40000000 and zero-initialized data at 0x80000000.
74291a4b
MM
7875@end table
7876
53054e77
PW
7877@node CRX Options
7878@subsection CRX Options
7879@cindex CRX Options
7880
7881These options are defined specifically for the CRX ports.
7882
7883@table @gcctabopt
7884
7885@item -mmac
7886@opindex mmac
7887Enable the use of multiply-accumulate instructions. Disabled by default.
7888
7889@item -mpush-args
7890@opindex mpush-args
7891Push instructions will be used to pass outgoing arguments when functions
7892are called. Enabled by default.
7893@end table
7894
39bc1876
NS
7895@node Darwin Options
7896@subsection Darwin Options
7897@cindex Darwin options
74291a4b 7898
39bc1876 7899These options are defined for all architectures running the Darwin operating
965a7e90
GK
7900system.
7901
7902FSF GCC on Darwin does not create ``fat'' object files; it will create
7903an object file for the single architecture that it was built to
7904target. Apple's GCC on Darwin does create ``fat'' files if multiple
46bfe5e3
GK
7905@option{-arch} options are used; it does so by running the compiler or
7906linker multiple times and joining the results together with
7907@file{lipo}.
965a7e90 7908
46bfe5e3
GK
7909The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7910@samp{i686}) is determined by the flags that specify the ISA
7911that GCC is targetting, like @option{-mcpu} or @option{-march}. The
965a7e90 7912@option{-force_cpusubtype_ALL} option can be used to override this.
74291a4b 7913
38b974a6 7914The Darwin tools vary in their behavior when presented with an ISA
46bfe5e3
GK
7915mismatch. The assembler, @file{as}, will only permit instructions to
7916be used that are valid for the subtype of the file it is generating,
7917so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7918The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7919and print an error if asked to create a shared library with a less
7920restrictive subtype than its input files (for instance, trying to put
7921a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
7922for executables, @file{ld}, will quietly give the executable the most
7923restrictive subtype of any of its input files.
7924
2642624b 7925@table @gcctabopt
39bc1876
NS
7926@item -F@var{dir}
7927@opindex F
7928Add the framework directory @var{dir} to the head of the list of
7929directories to be searched for header files. These directories are
7930interleaved with those specified by @option{-I} options and are
7931scanned in a left-to-right order.
5848830f 7932
39bc1876
NS
7933A framework directory is a directory with frameworks in it. A
7934framework is a directory with a @samp{"Headers"} and/or
7935@samp{"PrivateHeaders"} directory contained directly in it that ends
7936in @samp{".framework"}. The name of a framework is the name of this
7937directory excluding the @samp{".framework"}. Headers associated with
7938the framework are found in one of those two directories, with
7939@samp{"Headers"} being searched first. A subframework is a framework
7940directory that is in a framework's @samp{"Frameworks"} directory.
7941Includes of subframework headers can only appear in a header of a
7942framework that contains the subframework, or in a sibling subframework
7943header. Two subframeworks are siblings if they occur in the same
7944framework. A subframework should not have the same name as a
7945framework, a warning will be issued if this is violated. Currently a
7946subframework cannot have subframeworks, in the future, the mechanism
7947may be extended to support this. The standard frameworks can be found
3e558e80
MS
7948in @samp{"/System/Library/Frameworks"} and
7949@samp{"/Library/Frameworks"}. An example include looks like
39bc1876
NS
7950@code{#include <Framework/header.h>}, where @samp{Framework} denotes
7951the name of the framework and header.h is found in the
7952@samp{"PrivateHeaders"} or @samp{"Headers"} directory.
157a620e 7953
7aded944
DP
7954@item -gused
7955@opindex -gused
8a36672b 7956Emit debugging information for symbols that are used. For STABS
7aded944 7957debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8a36672b 7958This is by default ON@.
7aded944
DP
7959
7960@item -gfull
7961@opindex -gfull
7962Emit debugging information for all symbols and types.
7963
ed5b9f96
GK
7964@item -mmacosx-version-min=@var{version}
7965The earliest version of MacOS X that this executable will run on
7966is @var{version}. Typical values of @var{version} include @code{10.1},
7967@code{10.2}, and @code{10.3.9}.
7968
7969The default for this option is to make choices that seem to be most
7970useful.
7971
8f4220dc
MA
7972@item -mone-byte-bool
7973@opindex -mone-byte-bool
7974Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
f0eb93a8 7975By default @samp{sizeof(bool)} is @samp{4} when compiling for
8f4220dc
MA
7976Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7977option has no effect on x86.
7978
7979@strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7980to generate code that is not binary compatible with code generated
7981without that switch. Using this switch may require recompiling all
f0eb93a8 7982other modules in a program, including system libraries. Use this
8f4220dc
MA
7983switch to conform to a non-default data model.
7984
699c914a
MS
7985@item -mfix-and-continue
7986@itemx -ffix-and-continue
7987@itemx -findirect-data
7988@opindex mfix-and-continue
7989@opindex ffix-and-continue
7990@opindex findirect-data
7991Generate code suitable for fast turn around development. Needed to
7992enable gdb to dynamically load @code{.o} files into already running
7993programs. @option{-findirect-data} and @option{-ffix-and-continue}
7994are provided for backwards compatibility.
7995
39bc1876
NS
7996@item -all_load
7997@opindex all_load
7998Loads all members of static archive libraries.
7999See man ld(1) for more information.
74291a4b 8000
39bc1876
NS
8001@item -arch_errors_fatal
8002@opindex arch_errors_fatal
8003Cause the errors having to do with files that have the wrong architecture
8004to be fatal.
157a620e 8005
39bc1876
NS
8006@item -bind_at_load
8007@opindex bind_at_load
8008Causes the output file to be marked such that the dynamic linker will
8009bind all undefined references when the file is loaded or launched.
157a620e 8010
39bc1876
NS
8011@item -bundle
8012@opindex bundle
8013Produce a Mach-o bundle format file.
8014See man ld(1) for more information.
157a620e 8015
39bc1876
NS
8016@item -bundle_loader @var{executable}
8017@opindex bundle_loader
965a7e90 8018This option specifies the @var{executable} that will be loading the build
8a36672b 8019output file being linked. See man ld(1) for more information.
157a620e 8020
965a7e90
GK
8021@item -dynamiclib
8022@opindex -dynamiclib
8023When passed this option, GCC will produce a dynamic library instead of
8024an executable when linking, using the Darwin @file{libtool} command.
157a620e 8025
965a7e90
GK
8026@item -force_cpusubtype_ALL
8027@opindex -force_cpusubtype_ALL
8028This causes GCC's output file to have the @var{ALL} subtype, instead of
8029one controlled by the @option{-mcpu} or @option{-march} option.
8030
8031@item -allowable_client @var{client_name}
39bc1876
NS
8032@itemx -client_name
8033@itemx -compatibility_version
8034@itemx -current_version
5079843a 8035@itemx -dead_strip
39bc1876
NS
8036@itemx -dependency-file
8037@itemx -dylib_file
8038@itemx -dylinker_install_name
8039@itemx -dynamic
39bc1876
NS
8040@itemx -exported_symbols_list
8041@itemx -filelist
8042@itemx -flat_namespace
39bc1876
NS
8043@itemx -force_flat_namespace
8044@itemx -headerpad_max_install_names
8045@itemx -image_base
8046@itemx -init
8047@itemx -install_name
8048@itemx -keep_private_externs
8049@itemx -multi_module
8050@itemx -multiply_defined
8051@itemx -multiply_defined_unused
8052@itemx -noall_load
89aa5a20 8053@itemx -no_dead_strip_inits_and_terms
39bc1876
NS
8054@itemx -nofixprebinding
8055@itemx -nomultidefs
8056@itemx -noprebind
8057@itemx -noseglinkedit
8058@itemx -pagezero_size
8059@itemx -prebind
8060@itemx -prebind_all_twolevel_modules
8061@itemx -private_bundle
8062@itemx -read_only_relocs
8063@itemx -sectalign
8064@itemx -sectobjectsymbols
8065@itemx -whyload
8066@itemx -seg1addr
8067@itemx -sectcreate
8068@itemx -sectobjectsymbols
8069@itemx -sectorder
5826770c
DP
8070@itemx -segaddr
8071@itemx -segs_read_only_addr
8072@itemx -segs_read_write_addr
39bc1876
NS
8073@itemx -seg_addr_table
8074@itemx -seg_addr_table_filename
8075@itemx -seglinkedit
8076@itemx -segprot
8077@itemx -segs_read_only_addr
8078@itemx -segs_read_write_addr
8079@itemx -single_module
8080@itemx -static
8081@itemx -sub_library
8082@itemx -sub_umbrella
8083@itemx -twolevel_namespace
8084@itemx -umbrella
8085@itemx -undefined
8086@itemx -unexported_symbols_list
8087@itemx -weak_reference_mismatches
8088@itemx -whatsloaded
74291a4b 8089
39bc1876 8090@opindex allowable_client
39bc1876
NS
8091@opindex client_name
8092@opindex compatibility_version
8093@opindex current_version
5079843a 8094@opindex dead_strip
39bc1876
NS
8095@opindex dependency-file
8096@opindex dylib_file
8097@opindex dylinker_install_name
8098@opindex dynamic
39bc1876
NS
8099@opindex exported_symbols_list
8100@opindex filelist
8101@opindex flat_namespace
39bc1876
NS
8102@opindex force_flat_namespace
8103@opindex headerpad_max_install_names
8104@opindex image_base
8105@opindex init
8106@opindex install_name
8107@opindex keep_private_externs
8108@opindex multi_module
8109@opindex multiply_defined
8110@opindex multiply_defined_unused
8111@opindex noall_load
5079843a 8112@opindex no_dead_strip_inits_and_terms
39bc1876
NS
8113@opindex nofixprebinding
8114@opindex nomultidefs
8115@opindex noprebind
8116@opindex noseglinkedit
8117@opindex pagezero_size
8118@opindex prebind
8119@opindex prebind_all_twolevel_modules
8120@opindex private_bundle
8121@opindex read_only_relocs
8122@opindex sectalign
8123@opindex sectobjectsymbols
8124@opindex whyload
8125@opindex seg1addr
8126@opindex sectcreate
8127@opindex sectobjectsymbols
8128@opindex sectorder
5826770c
DP
8129@opindex segaddr
8130@opindex segs_read_only_addr
8131@opindex segs_read_write_addr
39bc1876
NS
8132@opindex seg_addr_table
8133@opindex seg_addr_table_filename
8134@opindex seglinkedit
8135@opindex segprot
8136@opindex segs_read_only_addr
8137@opindex segs_read_write_addr
8138@opindex single_module
8139@opindex static
8140@opindex sub_library
8141@opindex sub_umbrella
8142@opindex twolevel_namespace
8143@opindex umbrella
8144@opindex undefined
8145@opindex unexported_symbols_list
8146@opindex weak_reference_mismatches
8147@opindex whatsloaded
8148
965a7e90 8149These options are passed to the Darwin linker. The Darwin linker man page
39bc1876
NS
8150describes them in detail.
8151@end table
8152
8153@node DEC Alpha Options
8154@subsection DEC Alpha Options
8155
8156These @samp{-m} options are defined for the DEC Alpha implementations:
8157
8158@table @gcctabopt
8159@item -mno-soft-float
8160@itemx -msoft-float
8161@opindex mno-soft-float
cd3bb277 8162@opindex msoft-float
39bc1876
NS
8163Use (do not use) the hardware floating-point instructions for
8164floating-point operations. When @option{-msoft-float} is specified,
8165functions in @file{libgcc.a} will be used to perform floating-point
8166operations. Unless they are replaced by routines that emulate the
8167floating-point operations, or compiled in such a way as to call such
8168emulations routines, these routines will issue floating-point
8169operations. If you are compiling for an Alpha without floating-point
8170operations, you must ensure that the library is built so as not to call
8171them.
74291a4b 8172
39bc1876
NS
8173Note that Alpha implementations without floating-point operations are
8174required to have floating-point registers.
74291a4b 8175
39bc1876
NS
8176@item -mfp-reg
8177@itemx -mno-fp-regs
8178@opindex mfp-reg
8179@opindex mno-fp-regs
8180Generate code that uses (does not use) the floating-point register set.
8181@option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
8182register set is not used, floating point operands are passed in integer
8183registers as if they were integers and floating-point results are passed
8184in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
8185so any function with a floating-point argument or return value called by code
8186compiled with @option{-mno-fp-regs} must also be compiled with that
8187option.
9b66ebb1 8188
39bc1876
NS
8189A typical use of this option is building a kernel that does not use,
8190and hence need not save and restore, any floating-point registers.
9b66ebb1 8191
39bc1876
NS
8192@item -mieee
8193@opindex mieee
8194The Alpha architecture implements floating-point hardware optimized for
8195maximum performance. It is mostly compliant with the IEEE floating
8196point standard. However, for full compliance, software assistance is
8197required. This option generates code fully IEEE compliant code
8198@emph{except} that the @var{inexact-flag} is not maintained (see below).
8199If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8200defined during compilation. The resulting code is less efficient but is
8201able to correctly support denormalized numbers and exceptional IEEE
8202values such as not-a-number and plus/minus infinity. Other Alpha
8203compilers call this option @option{-ieee_with_no_inexact}.
74291a4b 8204
39bc1876
NS
8205@item -mieee-with-inexact
8206@opindex mieee-with-inexact
8207This is like @option{-mieee} except the generated code also maintains
8208the IEEE @var{inexact-flag}. Turning on this option causes the
8209generated code to implement fully-compliant IEEE math. In addition to
8210@code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8211macro. On some Alpha implementations the resulting code may execute
8212significantly slower than the code generated by default. Since there is
8213very little code that depends on the @var{inexact-flag}, you should
8214normally not specify this option. Other Alpha compilers call this
8215option @option{-ieee_with_inexact}.
74291a4b 8216
39bc1876
NS
8217@item -mfp-trap-mode=@var{trap-mode}
8218@opindex mfp-trap-mode
8219This option controls what floating-point related traps are enabled.
8220Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8221The trap mode can be set to one of four values:
74291a4b 8222
39bc1876
NS
8223@table @samp
8224@item n
8225This is the default (normal) setting. The only traps that are enabled
8226are the ones that cannot be disabled in software (e.g., division by zero
8227trap).
62b10bbc 8228
39bc1876
NS
8229@item u
8230In addition to the traps enabled by @samp{n}, underflow traps are enabled
8231as well.
157a620e 8232
39bc1876
NS
8233@item su
8234Like @samp{su}, but the instructions are marked to be safe for software
8235completion (see Alpha architecture manual for details).
157a620e 8236
39bc1876
NS
8237@item sui
8238Like @samp{su}, but inexact traps are enabled as well.
8239@end table
9b66ebb1 8240
39bc1876
NS
8241@item -mfp-rounding-mode=@var{rounding-mode}
8242@opindex mfp-rounding-mode
8243Selects the IEEE rounding mode. Other Alpha compilers call this option
8244@option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
8245of:
157a620e 8246
39bc1876
NS
8247@table @samp
8248@item n
8249Normal IEEE rounding mode. Floating point numbers are rounded towards
8250the nearest machine number or towards the even machine number in case
8251of a tie.
5848830f 8252
39bc1876
NS
8253@item m
8254Round towards minus infinity.
157a620e 8255
39bc1876
NS
8256@item c
8257Chopped rounding mode. Floating point numbers are rounded towards zero.
f5a1b0d2 8258
39bc1876
NS
8259@item d
8260Dynamic rounding mode. A field in the floating point control register
8261(@var{fpcr}, see Alpha architecture reference manual) controls the
8262rounding mode in effect. The C library initializes this register for
8263rounding towards plus infinity. Thus, unless your program modifies the
8264@var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8265@end table
c27ba912 8266
39bc1876
NS
8267@item -mtrap-precision=@var{trap-precision}
8268@opindex mtrap-precision
8269In the Alpha architecture, floating point traps are imprecise. This
8270means without software assistance it is impossible to recover from a
8271floating trap and program execution normally needs to be terminated.
8272GCC can generate code that can assist operating system trap handlers
8273in determining the exact location that caused a floating point trap.
8274Depending on the requirements of an application, different levels of
8275precisions can be selected:
c27ba912 8276
39bc1876
NS
8277@table @samp
8278@item p
8279Program precision. This option is the default and means a trap handler
8280can only identify which program caused a floating point exception.
c27ba912 8281
39bc1876
NS
8282@item f
8283Function precision. The trap handler can determine the function that
8284caused a floating point exception.
62b10bbc 8285
39bc1876
NS
8286@item i
8287Instruction precision. The trap handler can determine the exact
8288instruction that caused a floating point exception.
8289@end table
ed0e6530 8290
39bc1876
NS
8291Other Alpha compilers provide the equivalent options called
8292@option{-scope_safe} and @option{-resumption_safe}.
ed0e6530 8293
39bc1876
NS
8294@item -mieee-conformant
8295@opindex mieee-conformant
8296This option marks the generated code as IEEE conformant. You must not
8297use this option unless you also specify @option{-mtrap-precision=i} and either
8298@option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
8299is to emit the line @samp{.eflag 48} in the function prologue of the
8300generated assembly file. Under DEC Unix, this has the effect that
8301IEEE-conformant math library routines will be linked in.
9b6b54e2 8302
39bc1876
NS
8303@item -mbuild-constants
8304@opindex mbuild-constants
8305Normally GCC examines a 32- or 64-bit integer constant to
8306see if it can construct it from smaller constants in two or three
8307instructions. If it cannot, it will output the constant as a literal and
8308generate code to load it from the data segment at runtime.
74291a4b 8309
39bc1876
NS
8310Use this option to require GCC to construct @emph{all} integer constants
8311using code, even if it takes more instructions (the maximum is six).
157a620e 8312
39bc1876
NS
8313You would typically use this option to build a shared library dynamic
8314loader. Itself a shared library, it must relocate itself in memory
8315before it can find the variables and constants in its own data segment.
8316
8317@item -malpha-as
8318@itemx -mgas
8319@opindex malpha-as
8320@opindex mgas
8321Select whether to generate code to be assembled by the vendor-supplied
8322assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8323
8324@item -mbwx
8325@itemx -mno-bwx
8326@itemx -mcix
8327@itemx -mno-cix
8328@itemx -mfix
8329@itemx -mno-fix
8330@itemx -mmax
8331@itemx -mno-max
8332@opindex mbwx
8333@opindex mno-bwx
8334@opindex mcix
8335@opindex mno-cix
8336@opindex mfix
8337@opindex mno-fix
8338@opindex mmax
8339@opindex mno-max
8340Indicate whether GCC should generate code to use the optional BWX,
8341CIX, FIX and MAX instruction sets. The default is to use the instruction
8342sets supported by the CPU type specified via @option{-mcpu=} option or that
8343of the CPU on which GCC was built if none was specified.
157a620e 8344
39bc1876
NS
8345@item -mfloat-vax
8346@itemx -mfloat-ieee
8347@opindex mfloat-vax
8348@opindex mfloat-ieee
8349Generate code that uses (does not use) VAX F and G floating point
8350arithmetic instead of IEEE single and double precision.
157a620e 8351
39bc1876
NS
8352@item -mexplicit-relocs
8353@itemx -mno-explicit-relocs
8354@opindex mexplicit-relocs
8355@opindex mno-explicit-relocs
8356Older Alpha assemblers provided no way to generate symbol relocations
8357except via assembler macros. Use of these macros does not allow
8358optimal instruction scheduling. GNU binutils as of version 2.12
8359supports a new syntax that allows the compiler to explicitly mark
8360which relocations should apply to which instructions. This option
8361is mostly useful for debugging, as GCC detects the capabilities of
8362the assembler when it is built and sets the default accordingly.
157a620e 8363
39bc1876
NS
8364@item -msmall-data
8365@itemx -mlarge-data
8366@opindex msmall-data
8367@opindex mlarge-data
8368When @option{-mexplicit-relocs} is in effect, static data is
8369accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8370is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8371(the @code{.sdata} and @code{.sbss} sections) and are accessed via
837216-bit relocations off of the @code{$gp} register. This limits the
8373size of the small data area to 64KB, but allows the variables to be
8374directly accessed via a single instruction.
62b10bbc 8375
39bc1876 8376The default is @option{-mlarge-data}. With this option the data area
8a36672b 8377is limited to just below 2GB@. Programs that require more than 2GB of
39bc1876
NS
8378data must use @code{malloc} or @code{mmap} to allocate the data in the
8379heap instead of in the program's data segment.
62b10bbc 8380
39bc1876
NS
8381When generating code for shared libraries, @option{-fpic} implies
8382@option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
4bdc1ac7 8383
39bc1876
NS
8384@item -msmall-text
8385@itemx -mlarge-text
8386@opindex msmall-text
8387@opindex mlarge-text
8388When @option{-msmall-text} is used, the compiler assumes that the
8389code of the entire program (or shared library) fits in 4MB, and is
8390thus reachable with a branch instruction. When @option{-msmall-data}
8391is used, the compiler can assume that all local symbols share the
8392same @code{$gp} value, and thus reduce the number of instructions
8393required for a function call from 4 to 1.
157a620e 8394
39bc1876 8395The default is @option{-mlarge-text}.
d2d42a91 8396
39bc1876
NS
8397@item -mcpu=@var{cpu_type}
8398@opindex mcpu
8399Set the instruction set and instruction scheduling parameters for
8400machine type @var{cpu_type}. You can specify either the @samp{EV}
8401style name or the corresponding chip number. GCC supports scheduling
8402parameters for the EV4, EV5 and EV6 family of processors and will
8403choose the default values for the instruction set from the processor
8404you specify. If you do not specify a processor type, GCC will default
8405to the processor on which the compiler was built.
6d6d0fa0 8406
39bc1876 8407Supported values for @var{cpu_type} are
6d6d0fa0 8408
39bc1876
NS
8409@table @samp
8410@item ev4
8411@itemx ev45
8412@itemx 21064
8413Schedules as an EV4 and has no instruction set extensions.
ecff22ab 8414
39bc1876
NS
8415@item ev5
8416@itemx 21164
8417Schedules as an EV5 and has no instruction set extensions.
705ac34f 8418
39bc1876
NS
8419@item ev56
8420@itemx 21164a
8421Schedules as an EV5 and supports the BWX extension.
705ac34f 8422
39bc1876
NS
8423@item pca56
8424@itemx 21164pc
8425@itemx 21164PC
8426Schedules as an EV5 and supports the BWX and MAX extensions.
c474f76b 8427
39bc1876
NS
8428@item ev6
8429@itemx 21264
8430Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
ecff22ab 8431
39bc1876
NS
8432@item ev67
8433@itemx 21264a
8434Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
6d6d0fa0
JL
8435@end table
8436
39bc1876
NS
8437@item -mtune=@var{cpu_type}
8438@opindex mtune
8439Set only the instruction scheduling parameters for machine type
8440@var{cpu_type}. The instruction set is not changed.
ecff22ab 8441
39bc1876
NS
8442@item -mmemory-latency=@var{time}
8443@opindex mmemory-latency
8444Sets the latency the scheduler should assume for typical memory
8445references as seen by the application. This number is highly
8446dependent on the memory access patterns used by the application
8447and the size of the external cache on the machine.
861bb6c1 8448
39bc1876 8449Valid options for @var{time} are
6975bd2c 8450
39bc1876
NS
8451@table @samp
8452@item @var{number}
8453A decimal number representing clock cycles.
98180123 8454
39bc1876
NS
8455@item L1
8456@itemx L2
8457@itemx L3
8458@itemx main
8459The compiler contains estimates of the number of clock cycles for
8460``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8461(also called Dcache, Scache, and Bcache), as well as to main memory.
8462Note that L3 is only valid for EV5.
de41e41c 8463
39bc1876
NS
8464@end table
8465@end table
861bb6c1 8466
39bc1876
NS
8467@node DEC Alpha/VMS Options
8468@subsection DEC Alpha/VMS Options
861bb6c1 8469
39bc1876 8470These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
861bb6c1 8471
39bc1876
NS
8472@table @gcctabopt
8473@item -mvms-return-codes
8474@opindex mvms-return-codes
8475Return VMS condition codes from main. The default is to return POSIX
8476style condition (e.g.@ error) codes.
8477@end table
861bb6c1 8478
39bc1876
NS
8479@node FRV Options
8480@subsection FRV Options
8481@cindex FRV Options
861bb6c1 8482
39bc1876
NS
8483@table @gcctabopt
8484@item -mgpr-32
8485@opindex mgpr-32
861bb6c1 8486
39bc1876 8487Only use the first 32 general purpose registers.
861bb6c1 8488
39bc1876
NS
8489@item -mgpr-64
8490@opindex mgpr-64
861bb6c1 8491
39bc1876 8492Use all 64 general purpose registers.
861bb6c1 8493
39bc1876
NS
8494@item -mfpr-32
8495@opindex mfpr-32
861bb6c1 8496
39bc1876 8497Use only the first 32 floating point registers.
ad126521 8498
39bc1876
NS
8499@item -mfpr-64
8500@opindex mfpr-64
ad126521 8501
39bc1876 8502Use all 64 floating point registers
ad126521 8503
39bc1876
NS
8504@item -mhard-float
8505@opindex mhard-float
ad126521 8506
39bc1876 8507Use hardware instructions for floating point operations.
ad126521 8508
39bc1876
NS
8509@item -msoft-float
8510@opindex msoft-float
ad126521 8511
39bc1876 8512Use library routines for floating point operations.
ad126521 8513
39bc1876
NS
8514@item -malloc-cc
8515@opindex malloc-cc
ad126521 8516
39bc1876 8517Dynamically allocate condition code registers.
ad126521 8518
39bc1876
NS
8519@item -mfixed-cc
8520@opindex mfixed-cc
861bb6c1 8521
39bc1876
NS
8522Do not try to dynamically allocate condition code registers, only
8523use @code{icc0} and @code{fcc0}.
74291a4b 8524
39bc1876
NS
8525@item -mdword
8526@opindex mdword
74291a4b 8527
39bc1876 8528Change ABI to use double word insns.
74291a4b 8529
39bc1876
NS
8530@item -mno-dword
8531@opindex mno-dword
74291a4b 8532
39bc1876 8533Do not use double word instructions.
74291a4b 8534
39bc1876
NS
8535@item -mdouble
8536@opindex mdouble
74291a4b 8537
39bc1876 8538Use floating point double instructions.
7fe90e7b 8539
39bc1876
NS
8540@item -mno-double
8541@opindex mno-double
74291a4b 8542
39bc1876 8543Do not use floating point double instructions.
74291a4b 8544
39bc1876
NS
8545@item -mmedia
8546@opindex mmedia
74291a4b 8547
39bc1876 8548Use media instructions.
9c34dbbf 8549
39bc1876
NS
8550@item -mno-media
8551@opindex mno-media
74291a4b 8552
39bc1876 8553Do not use media instructions.
74291a4b 8554
39bc1876
NS
8555@item -mmuladd
8556@opindex mmuladd
9c34dbbf 8557
39bc1876 8558Use multiply and add/subtract instructions.
66188a7e 8559
39bc1876
NS
8560@item -mno-muladd
8561@opindex mno-muladd
74291a4b 8562
39bc1876 8563Do not use multiply and add/subtract instructions.
74291a4b 8564
d711cf67
JDA
8565@item -mfdpic
8566@opindex mfdpic
8567
8568Select the FDPIC ABI, that uses function descriptors to represent
8569pointers to functions. Without any PIC/PIE-related options, it
8570implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
8571assumes GOT entries and small data are within a 12-bit range from the
8572GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8573are computed with 32 bits.
8574
8575@item -minline-plt
8576@opindex minline-plt
8577
8578Enable inlining of PLT entries in function calls to functions that are
8579not known to bind locally. It has no effect without @option{-mfdpic}.
8580It's enabled by default if optimizing for speed and compiling for
8581shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8582optimization option such as @option{-O3} or above is present in the
8583command line.
8584
e4dd71de
AH
8585@item -mTLS
8586@opindex TLS
8587
8588Assume a large TLS segment when generating thread-local code.
8589
8590@item -mtls
8591@opindex tls
8592
8593Do not assume a large TLS segment when generating thread-local code.
8594
d711cf67
JDA
8595@item -mgprel-ro
8596@opindex mgprel-ro
8597
8598Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8599that is known to be in read-only sections. It's enabled by default,
8600except for @option{-fpic} or @option{-fpie}: even though it may help
8601make the global offset table smaller, it trades 1 instruction for 4.
8602With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8603one of which may be shared by multiple symbols, and it avoids the need
8604for a GOT entry for the referenced symbol, so it's more likely to be a
8605win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
8606
8607@item -multilib-library-pic
8608@opindex multilib-library-pic
8609
8610Link with the (library, not FD) pic libraries. It's implied by
8611@option{-mlibrary-pic}, as well as by @option{-fPIC} and
8612@option{-fpic} without @option{-mfdpic}. You should never have to use
8613it explicitly.
8614
8615@item -mlinked-fp
8616@opindex mlinked-fp
8617
8618Follow the EABI requirement of always creating a frame pointer whenever
8619a stack frame is allocated. This option is enabled by default and can
8620be disabled with @option{-mno-linked-fp}.
8621
c557edf4
RS
8622@item -mlong-calls
8623@opindex mlong-calls
8624
8625Use indirect addressing to call functions outside the current
8626compilation unit. This allows the functions to be placed anywhere
8627within the 32-bit address space.
8628
8629@item -malign-labels
8630@opindex malign-labels
8631
8632Try to align labels to an 8-byte boundary by inserting nops into the
8633previous packet. This option only has an effect when VLIW packing
8634is enabled. It doesn't create new packets; it merely adds nops to
8635existing ones.
8636
39bc1876
NS
8637@item -mlibrary-pic
8638@opindex mlibrary-pic
0ac081f6 8639
39bc1876 8640Generate position-independent EABI code.
6c8875e5 8641
39bc1876
NS
8642@item -macc-4
8643@opindex macc-4
6c8875e5 8644
39bc1876 8645Use only the first four media accumulator registers.
6c8875e5 8646
39bc1876
NS
8647@item -macc-8
8648@opindex macc-8
993f19a8 8649
39bc1876 8650Use all eight media accumulator registers.
5da702b1 8651
39bc1876
NS
8652@item -mpack
8653@opindex mpack
74291a4b 8654
39bc1876 8655Pack VLIW instructions.
74291a4b 8656
39bc1876
NS
8657@item -mno-pack
8658@opindex mno-pack
74291a4b 8659
39bc1876 8660Do not pack VLIW instructions.
7fe90e7b 8661
39bc1876
NS
8662@item -mno-eflags
8663@opindex mno-eflags
74291a4b 8664
39bc1876 8665Do not mark ABI switches in e_flags.
861bb6c1 8666
39bc1876
NS
8667@item -mcond-move
8668@opindex mcond-move
6184e8a4 8669
39bc1876 8670Enable the use of conditional-move instructions (default).
74291a4b 8671
39bc1876
NS
8672This switch is mainly for debugging the compiler and will likely be removed
8673in a future version.
74291a4b 8674
39bc1876
NS
8675@item -mno-cond-move
8676@opindex mno-cond-move
74291a4b 8677
39bc1876 8678Disable the use of conditional-move instructions.
861bb6c1 8679
39bc1876
NS
8680This switch is mainly for debugging the compiler and will likely be removed
8681in a future version.
861bb6c1 8682
39bc1876
NS
8683@item -mscc
8684@opindex mscc
74291a4b 8685
39bc1876 8686Enable the use of conditional set instructions (default).
74291a4b 8687
39bc1876
NS
8688This switch is mainly for debugging the compiler and will likely be removed
8689in a future version.
74291a4b 8690
39bc1876
NS
8691@item -mno-scc
8692@opindex mno-scc
74291a4b 8693
39bc1876 8694Disable the use of conditional set instructions.
74291a4b 8695
39bc1876
NS
8696This switch is mainly for debugging the compiler and will likely be removed
8697in a future version.
74291a4b 8698
39bc1876
NS
8699@item -mcond-exec
8700@opindex mcond-exec
74291a4b 8701
39bc1876 8702Enable the use of conditional execution (default).
74291a4b 8703
39bc1876
NS
8704This switch is mainly for debugging the compiler and will likely be removed
8705in a future version.
ab82a49f 8706
39bc1876
NS
8707@item -mno-cond-exec
8708@opindex mno-cond-exec
79ae11c4 8709
39bc1876 8710Disable the use of conditional execution.
daf2f129 8711
39bc1876
NS
8712This switch is mainly for debugging the compiler and will likely be removed
8713in a future version.
cbe26ab8 8714
39bc1876
NS
8715@item -mvliw-branch
8716@opindex mvliw-branch
8717
8718Run a pass to pack branches into VLIW instructions (default).
8719
8720This switch is mainly for debugging the compiler and will likely be removed
8721in a future version.
8722
8723@item -mno-vliw-branch
8724@opindex mno-vliw-branch
8725
8726Do not run a pass to pack branches into VLIW instructions.
8727
8728This switch is mainly for debugging the compiler and will likely be removed
8729in a future version.
74291a4b 8730
39bc1876
NS
8731@item -mmulti-cond-exec
8732@opindex mmulti-cond-exec
74291a4b 8733
39bc1876
NS
8734Enable optimization of @code{&&} and @code{||} in conditional execution
8735(default).
74291a4b 8736
39bc1876
NS
8737This switch is mainly for debugging the compiler and will likely be removed
8738in a future version.
74291a4b 8739
39bc1876
NS
8740@item -mno-multi-cond-exec
8741@opindex mno-multi-cond-exec
74291a4b 8742
39bc1876 8743Disable optimization of @code{&&} and @code{||} in conditional execution.
48180d68 8744
39bc1876
NS
8745This switch is mainly for debugging the compiler and will likely be removed
8746in a future version.
edf1b3f3 8747
39bc1876
NS
8748@item -mnested-cond-exec
8749@opindex mnested-cond-exec
9904592e 8750
39bc1876 8751Enable nested conditional execution optimizations (default).
9904592e 8752
39bc1876
NS
8753This switch is mainly for debugging the compiler and will likely be removed
8754in a future version.
0ac081f6 8755
39bc1876
NS
8756@item -mno-nested-cond-exec
8757@opindex mno-nested-cond-exec
76a773f3 8758
39bc1876 8759Disable nested conditional execution optimizations.
74291a4b 8760
39bc1876
NS
8761This switch is mainly for debugging the compiler and will likely be removed
8762in a future version.
74291a4b 8763
38c28a25
AH
8764@item -moptimize-membar
8765@opindex moptimize-membar
8766
8767This switch removes redundant @code{membar} instructions from the
8768compiler generated code. It is enabled by default.
8769
8770@item -mno-optimize-membar
8771@opindex mno-optimize-membar
8772
8773This switch disables the automatic removal of redundant @code{membar}
8774instructions from the generated code.
8775
39bc1876
NS
8776@item -mtomcat-stats
8777@opindex mtomcat-stats
e9a25f70 8778
39bc1876 8779Cause gas to print out tomcat statistics.
e9a25f70 8780
39bc1876
NS
8781@item -mcpu=@var{cpu}
8782@opindex mcpu
74291a4b 8783
39bc1876 8784Select the processor type for which to generate code. Possible values are
c557edf4
RS
8785@samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8786@samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
bff46771 8787
39bc1876 8788@end table
8d8269fa 8789
464aea98
JM
8790@node GNU/Linux Options
8791@subsection GNU/Linux Options
8792
8793These @samp{-m} options are defined for GNU/Linux targets:
8794
8795@table @gcctabopt
8796@item -mglibc
8797@opindex mglibc
8798Use the GNU C library instead of uClibc. This is the default except
8799on @samp{*-*-linux-*uclibc*} targets.
8800
8801@item -muclibc
8802@opindex muclibc
8803Use uClibc instead of the GNU C library. This is the default on
7bd85ce0 8804@samp{*-*-linux-*uclibc*} targets.
464aea98
JM
8805@end table
8806
39bc1876
NS
8807@node H8/300 Options
8808@subsection H8/300 Options
74291a4b 8809
39bc1876 8810These @samp{-m} options are defined for the H8/300 implementations:
74291a4b 8811
39bc1876
NS
8812@table @gcctabopt
8813@item -mrelax
8814@opindex mrelax
8815Shorten some address references at link time, when possible; uses the
8816linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8817ld, Using ld}, for a fuller description.
74291a4b 8818
39bc1876
NS
8819@item -mh
8820@opindex mh
8821Generate code for the H8/300H@.
74291a4b 8822
39bc1876
NS
8823@item -ms
8824@opindex ms
8825Generate code for the H8S@.
74291a4b 8826
39bc1876
NS
8827@item -mn
8828@opindex mn
8829Generate code for the H8S and H8/300H in the normal mode. This switch
4ec7afd7 8830must be used either with @option{-mh} or @option{-ms}.
74291a4b 8831
39bc1876
NS
8832@item -ms2600
8833@opindex ms2600
8834Generate code for the H8S/2600. This switch must be used with @option{-ms}.
74291a4b 8835
39bc1876
NS
8836@item -mint32
8837@opindex mint32
8838Make @code{int} data 32 bits by default.
74291a4b 8839
39bc1876
NS
8840@item -malign-300
8841@opindex malign-300
8842On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8843The default for the H8/300H and H8S is to align longs and floats on 4
8844byte boundaries.
8845@option{-malign-300} causes them to be aligned on 2 byte boundaries.
8846This option has no effect on the H8/300.
8847@end table
f5a1b0d2 8848
39bc1876
NS
8849@node HPPA Options
8850@subsection HPPA Options
8851@cindex HPPA Options
a5c76ee6 8852
39bc1876 8853These @samp{-m} options are defined for the HPPA family of computers:
a5c76ee6 8854
39bc1876
NS
8855@table @gcctabopt
8856@item -march=@var{architecture-type}
8857@opindex march
8858Generate code for the specified architecture. The choices for
8859@var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
88601.1, and @samp{2.0} for PA 2.0 processors. Refer to
8861@file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8862architecture option for your machine. Code compiled for lower numbered
8863architectures will run on higher numbered architectures, but not the
8864other way around.
8865
39bc1876
NS
8866@item -mpa-risc-1-0
8867@itemx -mpa-risc-1-1
8868@itemx -mpa-risc-2-0
8869@opindex mpa-risc-1-0
8870@opindex mpa-risc-1-1
8871@opindex mpa-risc-2-0
8872Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
5a26b329 8873
39bc1876
NS
8874@item -mbig-switch
8875@opindex mbig-switch
8876Generate code suitable for big switch tables. Use this option only if
8877the assembler/linker complain about out of range branches within a switch
8878table.
efdba735 8879
39bc1876
NS
8880@item -mjump-in-delay
8881@opindex mjump-in-delay
8882Fill delay slots of function calls with unconditional jump instructions
8883by modifying the return pointer for the function call to be the target
8884of the conditional jump.
a5c76ee6 8885
39bc1876
NS
8886@item -mdisable-fpregs
8887@opindex mdisable-fpregs
8888Prevent floating point registers from being used in any manner. This is
8889necessary for compiling kernels which perform lazy context switching of
8890floating point registers. If you use this option and attempt to perform
8891floating point operations, the compiler will abort.
0a379b7a 8892
39bc1876
NS
8893@item -mdisable-indexing
8894@opindex mdisable-indexing
8895Prevent the compiler from using indexing address modes. This avoids some
8896rather obscure problems when compiling MIG generated code under MACH@.
f5a1b0d2 8897
39bc1876
NS
8898@item -mno-space-regs
8899@opindex mno-space-regs
8900Generate code that assumes the target has no space registers. This allows
8901GCC to generate faster indirect calls and use unscaled index address modes.
d2d42a91 8902
39bc1876 8903Such code is suitable for level 0 PA systems and kernels.
d2d42a91 8904
39bc1876
NS
8905@item -mfast-indirect-calls
8906@opindex mfast-indirect-calls
8907Generate code that assumes calls never cross space boundaries. This
8908allows GCC to emit code which performs faster indirect calls.
f08a3544 8909
39bc1876
NS
8910This option will not work in the presence of shared libraries or nested
8911functions.
f08a3544 8912
a2017852
JDA
8913@item -mfixed-range=@var{register-range}
8914@opindex mfixed-range
8915Generate code treating the given register range as fixed registers.
8916A fixed register is one that the register allocator can not use. This is
8917useful when compiling kernel code. A register range is specified as
8918two registers separated by a dash. Multiple register ranges can be
8919specified separated by a comma.
8920
39bc1876
NS
8921@item -mlong-load-store
8922@opindex mlong-load-store
8923Generate 3-instruction load and store sequences as sometimes required by
8924the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8925the HP compilers.
61c85ff1 8926
39bc1876
NS
8927@item -mportable-runtime
8928@opindex mportable-runtime
8929Use the portable calling conventions proposed by HP for ELF systems.
61c85ff1 8930
39bc1876
NS
8931@item -mgas
8932@opindex mgas
8933Enable the use of assembler directives only GAS understands.
61c85ff1 8934
39bc1876
NS
8935@item -mschedule=@var{cpu-type}
8936@opindex mschedule
8937Schedule code according to the constraints for the machine type
8938@var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8939@samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8940to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8941proper scheduling option for your machine. The default scheduling is
8942@samp{8000}.
61c85ff1 8943
39bc1876
NS
8944@item -mlinker-opt
8945@opindex mlinker-opt
8946Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8947debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8948linkers in which they give bogus error messages when linking some programs.
61c85ff1 8949
39bc1876
NS
8950@item -msoft-float
8951@opindex msoft-float
8952Generate output containing library calls for floating point.
8953@strong{Warning:} the requisite libraries are not available for all HPPA
8954targets. Normally the facilities of the machine's usual C compiler are
8955used, but this cannot be done directly in cross-compilation. You must make
8956your own arrangements to provide suitable library functions for
8957cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8958does provide software floating point support.
31775d31 8959
39bc1876
NS
8960@option{-msoft-float} changes the calling convention in the output file;
8961therefore, it is only useful if you compile @emph{all} of a program with
8962this option. In particular, you need to compile @file{libgcc.a}, the
8963library that comes with GCC, with @option{-msoft-float} in order for
8964this to work.
61c85ff1 8965
39bc1876
NS
8966@item -msio
8967@opindex msio
8a36672b 8968Generate the predefine, @code{_SIO}, for server IO@. The default is
39bc1876 8969@option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8a36672b
JM
8970@code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
8971options are available under HP-UX and HI-UX@.
39bc1876
NS
8972
8973@item -mgnu-ld
8974@opindex gnu-ld
8975Use GNU ld specific options. This passes @option{-shared} to ld when
8976building a shared library. It is the default when GCC is configured,
8977explicitly or implicitly, with the GNU linker. This option does not
8978have any affect on which ld is called, it only changes what parameters
8979are passed to that ld. The ld that is called is determined by the
8980@option{--with-ld} configure option, GCC's program search path, and
8981finally by the user's @env{PATH}. The linker used by GCC can be printed
a73035ae
SE
8982using @samp{which `gcc -print-prog-name=ld`}. This option is only available
8983on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
48aec0bc 8984
39bc1876
NS
8985@item -mhp-ld
8986@opindex hp-ld
8987Use HP ld specific options. This passes @option{-b} to ld when building
8988a shared library and passes @option{+Accept TypeMismatch} to ld on all
8989links. It is the default when GCC is configured, explicitly or
8990implicitly, with the HP linker. This option does not have any affect on
8991which ld is called, it only changes what parameters are passed to that
8992ld. The ld that is called is determined by the @option{--with-ld}
8993configure option, GCC's program search path, and finally by the user's
8994@env{PATH}. The linker used by GCC can be printed using @samp{which
a73035ae
SE
8995`gcc -print-prog-name=ld`}. This option is only available on the 64 bit
8996HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
48aec0bc 8997
39bc1876
NS
8998@item -mlong-calls
8999@opindex mno-long-calls
9000Generate code that uses long call sequences. This ensures that a call
9001is always able to reach linker generated stubs. The default is to generate
9002long calls only when the distance from the call site to the beginning
9003of the function or translation unit, as the case may be, exceeds a
9004predefined limit set by the branch type being used. The limits for
9005normal calls are 7,600,000 and 240,000 bytes, respectively for the
9006PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
9007240,000 bytes.
a27fb29b 9008
39bc1876
NS
9009Distances are measured from the beginning of functions when using the
9010@option{-ffunction-sections} option, or when using the @option{-mgas}
9011and @option{-mno-portable-runtime} options together under HP-UX with
9012the SOM linker.
7dac2f89 9013
39bc1876
NS
9014It is normally not desirable to use this option as it will degrade
9015performance. However, it may be useful in large applications,
9016particularly when partial linking is used to build the application.
74291a4b 9017
39bc1876
NS
9018The types of long calls used depends on the capabilities of the
9019assembler and linker, and the type of code being generated. The
9020impact on systems that support long absolute calls, and long pic
9021symbol-difference or pc-relative calls should be relatively small.
9022However, an indirect call is used on 32-bit ELF systems in pic code
9023and it is quite long.
74291a4b 9024
d711cf67
JDA
9025@item -munix=@var{unix-std}
9026@opindex march
9027Generate compiler predefines and select a startfile for the specified
9028UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
9029and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
9030is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
903111.11 and later. The default values are @samp{93} for HP-UX 10.00,
9032@samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9033and later.
9034
9035@option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9036@option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9037and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9038@option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9039@code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9040@code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9041
9042It is @emph{important} to note that this option changes the interfaces
9043for various library routines. It also affects the operational behavior
9044of the C library. Thus, @emph{extreme} care is needed in using this
9045option.
9046
9047Library code that is intended to operate with more than one UNIX
9048standard must test, set and restore the variable @var{__xpg4_extended_mask}
9049as appropriate. Most GNU software doesn't provide this capability.
9050
39bc1876
NS
9051@item -nolibdld
9052@opindex nolibdld
9053Suppress the generation of link options to search libdld.sl when the
9054@option{-static} option is specified on HP-UX 10 and later.
9055
9056@item -static
9057@opindex static
9058The HP-UX implementation of setlocale in libc has a dependency on
9059libdld.sl. There isn't an archive version of libdld.sl. Thus,
9060when the @option{-static} option is specified, special link options
9061are needed to resolve this dependency.
9062
9063On HP-UX 10 and later, the GCC driver adds the necessary options to
9064link with libdld.sl when the @option{-static} option is specified.
9065This causes the resulting binary to be dynamic. On the 64-bit port,
9066the linkers generate dynamic binaries by default in any case. The
9067@option{-nolibdld} option can be used to prevent the GCC driver from
9068adding these link options.
9069
9070@item -threads
9071@opindex threads
9072Add support for multithreading with the @dfn{dce thread} library
8a36672b 9073under HP-UX@. This option sets flags for both the preprocessor and
39bc1876
NS
9074linker.
9075@end table
9076
9077@node i386 and x86-64 Options
9078@subsection Intel 386 and AMD x86-64 Options
9079@cindex i386 Options
9080@cindex x86-64 Options
9081@cindex Intel 386 Options
9082@cindex AMD x86-64 Options
9083
9084These @samp{-m} options are defined for the i386 and x86-64 family of
9085computers:
9086
9087@table @gcctabopt
9088@item -mtune=@var{cpu-type}
9089@opindex mtune
9090Tune to @var{cpu-type} everything applicable about the generated code, except
9091for the ABI and the set of available instructions. The choices for
9092@var{cpu-type} are:
9093@table @emph
786872fd
JH
9094@item generic
9095Produce code optimized for the most common IA32/AMD64/EM64T processors.
9096If you know the CPU on which your code will run, then you should use
9097the corresponding @option{-mtune} option instead of
9098@option{-mtune=generic}. But, if you do not know exactly what CPU users
9099of your application will have, then you should use this option.
9100
9101As new processors are deployed in the marketplace, the behavior of this
9102option will change. Therefore, if you upgrade to a newer version of
9103GCC, the code generated option will change to reflect the processors
9104that were most common when that version of GCC was released.
9105
9106There is no @option{-march=generic} option because @option{-march}
9107indicates the instruction set the compiler can use, and there is no
9108generic instruction set applicable to all processors. In contrast,
9109@option{-mtune} indicates the processor (or, in this case, collection of
9110processors) for which the code is optimized.
39bc1876 9111@item i386
8a36672b 9112Original Intel's i386 CPU@.
39bc1876 9113@item i486
8a36672b 9114Intel's i486 CPU@. (No scheduling is implemented for this chip.)
39bc1876
NS
9115@item i586, pentium
9116Intel Pentium CPU with no MMX support.
9117@item pentium-mmx
9118Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
786872fd 9119@item pentiumpro
8a36672b 9120Intel PentiumPro CPU@.
786872fd
JH
9121@item i686
9122Same as @code{generic}, but when used as @code{march} option, PentiumPro
9123instruction set will be used, so the code will run on all i686 familly chips.
39bc1876
NS
9124@item pentium2
9125Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9126@item pentium3, pentium3m
9127Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9128support.
9129@item pentium-m
9130Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9131support. Used by Centrino notebooks.
9132@item pentium4, pentium4m
9133Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9134@item prescott
9135Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9136set support.
9137@item nocona
9138Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9139SSE2 and SSE3 instruction set support.
9140@item k6
9141AMD K6 CPU with MMX instruction set support.
9142@item k6-2, k6-3
9143Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9144@item athlon, athlon-tbird
9145AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9146support.
9147@item athlon-4, athlon-xp, athlon-mp
9148Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9149instruction set support.
9150@item k8, opteron, athlon64, athlon-fx
9151AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
9152MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9153@item winchip-c6
9154IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9155set support.
9156@item winchip2
9157IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9158instruction set support.
9159@item c3
8a36672b 9160Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
39bc1876
NS
9161implemented for this chip.)
9162@item c3-2
9163Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
9164implemented for this chip.)
9165@end table
9166
9167While picking a specific @var{cpu-type} will schedule things appropriately
9168for that particular chip, the compiler will not generate any code that
9169does not run on the i386 without the @option{-march=@var{cpu-type}} option
9170being used.
9171
9172@item -march=@var{cpu-type}
9173@opindex march
9174Generate instructions for the machine type @var{cpu-type}. The choices
9175for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
9176specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
74291a4b 9177
39bc1876
NS
9178@item -mcpu=@var{cpu-type}
9179@opindex mcpu
9180A deprecated synonym for @option{-mtune}.
3398f47f 9181
39bc1876
NS
9182@item -m386
9183@itemx -m486
9184@itemx -mpentium
9185@itemx -mpentiumpro
9186@opindex m386
9187@opindex m486
9188@opindex mpentium
9189@opindex mpentiumpro
9190These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9191@option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9192These synonyms are deprecated.
74291a4b 9193
39bc1876
NS
9194@item -mfpmath=@var{unit}
9195@opindex march
9196Generate floating point arithmetics for selected unit @var{unit}. The choices
9197for @var{unit} are:
2d2a50c3 9198
39bc1876
NS
9199@table @samp
9200@item 387
9201Use the standard 387 floating point coprocessor present majority of chips and
9202emulated otherwise. Code compiled with this option will run almost everywhere.
9203The temporary results are computed in 80bit precision instead of precision
9204specified by the type resulting in slightly different results compared to most
8a36672b 9205of other chips. See @option{-ffloat-store} for more detailed description.
74291a4b 9206
39bc1876 9207This is the default choice for i386 compiler.
74291a4b 9208
39bc1876
NS
9209@item sse
9210Use scalar floating point instructions present in the SSE instruction set.
9211This instruction set is supported by Pentium3 and newer chips, in the AMD line
9212by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
9213instruction set supports only single precision arithmetics, thus the double and
9214extended precision arithmetics is still done using 387. Later version, present
9215only in Pentium4 and the future AMD x86-64 chips supports double precision
9216arithmetics too.
a27fb29b 9217
c2b43d7a
UB
9218For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9219or @option{-msse2} switches to enable SSE extensions and make this option
9220effective. For the x86-64 compiler, these extensions are enabled by default.
3398f47f 9221
39bc1876
NS
9222The resulting code should be considerably faster in the majority of cases and avoid
9223the numerical instability problems of 387 code, but may break some existing
9224code that expects temporaries to be 80bit.
cd3f11a6 9225
39bc1876 9226This is the default choice for the x86-64 compiler.
74291a4b 9227
39bc1876
NS
9228@item sse,387
9229Attempt to utilize both instruction sets at once. This effectively double the
9230amount of available registers and on chips with separate execution units for
9231387 and SSE the execution resources too. Use this option with care, as it is
9232still experimental, because the GCC register allocator does not model separate
9233functional units well resulting in instable performance.
9234@end table
ee692410 9235
39bc1876
NS
9236@item -masm=@var{dialect}
9237@opindex masm=@var{dialect}
1f4c2c57
MS
9238Output asm instructions using selected @var{dialect}. Supported
9239choices are @samp{intel} or @samp{att} (the default one). Darwin does
13b3c362 9240not support @samp{intel}.
ee692410 9241
39bc1876
NS
9242@item -mieee-fp
9243@itemx -mno-ieee-fp
9244@opindex mieee-fp
9245@opindex mno-ieee-fp
9246Control whether or not the compiler uses IEEE floating point
9247comparisons. These handle correctly the case where the result of a
9248comparison is unordered.
ee692410 9249
39bc1876
NS
9250@item -msoft-float
9251@opindex msoft-float
9252Generate output containing library calls for floating point.
9253@strong{Warning:} the requisite libraries are not part of GCC@.
9254Normally the facilities of the machine's usual C compiler are used, but
9255this can't be done directly in cross-compilation. You must make your
9256own arrangements to provide suitable library functions for
9257cross-compilation.
ee692410 9258
39bc1876
NS
9259On machines where a function returns floating point results in the 80387
9260register stack, some floating point opcodes may be emitted even if
9261@option{-msoft-float} is used.
ee692410 9262
39bc1876
NS
9263@item -mno-fp-ret-in-387
9264@opindex mno-fp-ret-in-387
9265Do not use the FPU registers for return values of functions.
ee692410 9266
39bc1876
NS
9267The usual calling convention has functions return values of types
9268@code{float} and @code{double} in an FPU register, even if there
9269is no FPU@. The idea is that the operating system should emulate
9270an FPU@.
5a4b3afd 9271
39bc1876
NS
9272The option @option{-mno-fp-ret-in-387} causes such values to be returned
9273in ordinary CPU registers instead.
5a4b3afd 9274
39bc1876
NS
9275@item -mno-fancy-math-387
9276@opindex mno-fancy-math-387
9277Some 387 emulators do not support the @code{sin}, @code{cos} and
9278@code{sqrt} instructions for the 387. Specify this option to avoid
9279generating those instructions. This option is the default on FreeBSD,
9280OpenBSD and NetBSD@. This option is overridden when @option{-march}
9281indicates that the target cpu will always have an FPU and so the
9282instruction will not need emulation. As of revision 2.6.1, these
9283instructions are not generated unless you also use the
9284@option{-funsafe-math-optimizations} switch.
5a4b3afd 9285
39bc1876
NS
9286@item -malign-double
9287@itemx -mno-align-double
9288@opindex malign-double
9289@opindex mno-align-double
9290Control whether GCC aligns @code{double}, @code{long double}, and
9291@code{long long} variables on a two word boundary or a one word
9292boundary. Aligning @code{double} variables on a two word boundary will
9293produce code that runs somewhat faster on a @samp{Pentium} at the
9294expense of more memory.
5a4b3afd 9295
39bc1876
NS
9296@strong{Warning:} if you use the @option{-malign-double} switch,
9297structures containing the above types will be aligned differently than
9298the published application binary interface specifications for the 386
9299and will not be binary compatible with structures in code compiled
9300without that switch.
5a4b3afd 9301
39bc1876
NS
9302@item -m96bit-long-double
9303@itemx -m128bit-long-double
9304@opindex m96bit-long-double
9305@opindex m128bit-long-double
8a36672b 9306These switches control the size of @code{long double} type. The i386
39bc1876
NS
9307application binary interface specifies the size to be 96 bits,
9308so @option{-m96bit-long-double} is the default in 32 bit mode.
5a4b3afd 9309
39bc1876
NS
9310Modern architectures (Pentium and newer) would prefer @code{long double}
9311to be aligned to an 8 or 16 byte boundary. In arrays or structures
9312conforming to the ABI, this would not be possible. So specifying a
9313@option{-m128bit-long-double} will align @code{long double}
9314to a 16 byte boundary by padding the @code{long double} with an additional
931532 bit zero.
5a4b3afd 9316
39bc1876
NS
9317In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9318its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
5a4b3afd 9319
39bc1876
NS
9320Notice that neither of these options enable any extra precision over the x87
9321standard of 80 bits for a @code{long double}.
5a4b3afd 9322
39bc1876
NS
9323@strong{Warning:} if you override the default value for your target ABI, the
9324structures and arrays containing @code{long double} variables will change
9325their size as well as function calling convention for function taking
9326@code{long double} will be modified. Hence they will not be binary
9327compatible with arrays or structures in code compiled without that switch.
5a4b3afd 9328
7dcbf659
JH
9329@item -mmlarge-data-threshold=@var{number}
9330@opindex mlarge-data-threshold=@var{number}
9331When @option{-mcmodel=medium} is specified, the data greater than
9332@var{threshold} are placed in large data section. This value must be the
a4d05547 9333same across all object linked into the binary and defaults to 65535.
5a4b3afd 9334
39bc1876
NS
9335@item -msvr3-shlib
9336@itemx -mno-svr3-shlib
9337@opindex msvr3-shlib
9338@opindex mno-svr3-shlib
9339Control whether GCC places uninitialized local variables into the
9340@code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
9341into @code{bss}. These options are meaningful only on System V Release 3.
5a4b3afd 9342
39bc1876
NS
9343@item -mrtd
9344@opindex mrtd
9345Use a different function-calling convention, in which functions that
9346take a fixed number of arguments return with the @code{ret} @var{num}
9347instruction, which pops their arguments while returning. This saves one
9348instruction in the caller since there is no need to pop the arguments
9349there.
5a4b3afd 9350
39bc1876
NS
9351You can specify that an individual function is called with this calling
9352sequence with the function attribute @samp{stdcall}. You can also
9353override the @option{-mrtd} option by using the function attribute
9354@samp{cdecl}. @xref{Function Attributes}.
74291a4b 9355
39bc1876
NS
9356@strong{Warning:} this calling convention is incompatible with the one
9357normally used on Unix, so you cannot use it if you need to call
9358libraries compiled with the Unix compiler.
74291a4b 9359
39bc1876
NS
9360Also, you must provide function prototypes for all functions that
9361take variable numbers of arguments (including @code{printf});
9362otherwise incorrect code will be generated for calls to those
9363functions.
02f52e19 9364
39bc1876
NS
9365In addition, seriously incorrect code will result if you call a
9366function with too many arguments. (Normally, extra arguments are
9367harmlessly ignored.)
1cf959cb 9368
39bc1876
NS
9369@item -mregparm=@var{num}
9370@opindex mregparm
9371Control how many registers are used to pass integer arguments. By
9372default, no registers are used to pass arguments, and at most 3
9373registers can be used. You can control this behavior for a specific
9374function by using the function attribute @samp{regparm}.
9375@xref{Function Attributes}.
1cf959cb 9376
39bc1876
NS
9377@strong{Warning:} if you use this switch, and
9378@var{num} is nonzero, then you must build all modules with the same
9379value, including any libraries. This includes the system libraries and
9380startup modules.
5a4b3afd 9381
1f97667f
RG
9382@item -msseregparm
9383@opindex msseregparm
9384Use SSE register passing conventions for float and double arguments
9385and return values. You can control this behavior for a specific
9386function by using the function attribute @samp{sseregparm}.
9387@xref{Function Attributes}.
9388
9389@strong{Warning:} if you use this switch then you must build all
9390modules with the same value, including any libraries. This includes
9391the system libraries and startup modules.
9392
39bc1876
NS
9393@item -mpreferred-stack-boundary=@var{num}
9394@opindex mpreferred-stack-boundary
9395Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9396byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
9397the default is 4 (16 bytes or 128 bits), except when optimizing for code
9398size (@option{-Os}), in which case the default is the minimum correct
9399alignment (4 bytes for x86, and 8 bytes for x86-64).
5a4b3afd 9400
39bc1876
NS
9401On Pentium and PentiumPro, @code{double} and @code{long double} values
9402should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9403suffer significant run time performance penalties. On Pentium III, the
9404Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9405penalties if it is not 16 byte aligned.
5a4b3afd 9406
39bc1876
NS
9407To ensure proper alignment of this values on the stack, the stack boundary
9408must be as aligned as that required by any value stored on the stack.
9409Further, every function must be generated such that it keeps the stack
9410aligned. Thus calling a function compiled with a higher preferred
9411stack boundary from a function compiled with a lower preferred stack
9412boundary will most likely misalign the stack. It is recommended that
9413libraries that use callbacks always use the default setting.
5a4b3afd 9414
39bc1876
NS
9415This extra alignment does consume extra stack space, and generally
9416increases code size. Code that is sensitive to stack space usage, such
9417as embedded systems and operating system kernels, may want to reduce the
9418preferred alignment to @option{-mpreferred-stack-boundary=2}.
5a4b3afd 9419
39bc1876
NS
9420@item -mmmx
9421@itemx -mno-mmx
9422@item -msse
9423@itemx -mno-sse
9424@item -msse2
9425@itemx -mno-sse2
9426@item -msse3
9427@itemx -mno-sse3
9428@item -m3dnow
9429@itemx -mno-3dnow
9430@opindex mmmx
9431@opindex mno-mmx
9432@opindex msse
9433@opindex mno-sse
9434@opindex m3dnow
9435@opindex mno-3dnow
75576871
BB
9436These switches enable or disable the use of instructions in the MMX,
9437SSE, SSE2 or 3DNow! extended instruction sets. These extensions are
9438also available as built-in functions: see @ref{X86 Built-in Functions},
9439for details of the functions enabled and disabled by these switches.
74291a4b 9440
39bc1876 9441To have SSE/SSE2 instructions generated automatically from floating-point
75576871
BB
9442code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9443
9444These options will enable GCC to use these extended instructions in
9445generated code, even without @option{-mfpmath=sse}. Applications which
9446perform runtime CPU detection must compile separate files for each
9447supported architecture, using the appropriate flags. In particular,
9448the file containing the CPU detection code should be compiled without
9449these options.
74291a4b 9450
ee963181
RG
9451@item -msselibm
9452@opindex msselibm
9453Use special versions of certain libm routines that come with an SSE
9454ABI and an SSE implementation. Useful together with @option{-mfpmath=sse}
9455to avoid moving values between SSE registers and the x87 FP stack.
9456
39bc1876
NS
9457@item -mpush-args
9458@itemx -mno-push-args
9459@opindex mpush-args
9460@opindex mno-push-args
9461Use PUSH operations to store outgoing parameters. This method is shorter
9462and usually equally fast as method using SUB/MOV operations and is enabled
9463by default. In some cases disabling it may improve performance because of
9464improved scheduling and reduced dependencies.
74291a4b 9465
39bc1876
NS
9466@item -maccumulate-outgoing-args
9467@opindex maccumulate-outgoing-args
9468If enabled, the maximum amount of space required for outgoing arguments will be
9469computed in the function prologue. This is faster on most modern CPUs
9470because of reduced dependencies, improved scheduling and reduced stack usage
9471when preferred stack boundary is not equal to 2. The drawback is a notable
9472increase in code size. This switch implies @option{-mno-push-args}.
63357d93 9473
39bc1876
NS
9474@item -mthreads
9475@opindex mthreads
9476Support thread-safe exception handling on @samp{Mingw32}. Code that relies
9477on thread-safe exception handling must compile and link all code with the
9478@option{-mthreads} option. When compiling, @option{-mthreads} defines
9479@option{-D_MT}; when linking, it links in a special thread helper library
9480@option{-lmingwthrd} which cleans up per thread exception handling data.
5ef1a99d 9481
39bc1876
NS
9482@item -mno-align-stringops
9483@opindex mno-align-stringops
9484Do not align destination of inlined string operations. This switch reduces
9485code size and improves performance in case the destination is already aligned,
9486but GCC doesn't know about it.
46490403 9487
39bc1876
NS
9488@item -minline-all-stringops
9489@opindex minline-all-stringops
9490By default GCC inlines string operations only when destination is known to be
9491aligned at least to 4 byte boundary. This enables more inlining, increase code
9492size, but may improve performance of code that depends on fast memcpy, strlen
9493and memset for short lengths.
c235ddf2 9494
39bc1876
NS
9495@item -momit-leaf-frame-pointer
9496@opindex momit-leaf-frame-pointer
9497Don't keep the frame pointer in a register for leaf functions. This
9498avoids the instructions to save, set up and restore frame pointers and
9499makes an extra register available in leaf functions. The option
9500@option{-fomit-frame-pointer} removes the frame pointer for all functions
9501which might make debugging harder.
c235ddf2 9502
39bc1876
NS
9503@item -mtls-direct-seg-refs
9504@itemx -mno-tls-direct-seg-refs
9505@opindex mtls-direct-seg-refs
9506Controls whether TLS variables may be accessed with offsets from the
9507TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9508or whether the thread base pointer must be added. Whether or not this
9509is legal depends on the operating system, and whether it maps the
9510segment to cover the entire TLS area.
beadc644 9511
39bc1876
NS
9512For systems that use GNU libc, the default is on.
9513@end table
af34e51e 9514
39bc1876
NS
9515These @samp{-m} switches are supported in addition to the above
9516on AMD x86-64 processors in 64-bit environments.
50d32cf6 9517
39bc1876
NS
9518@table @gcctabopt
9519@item -m32
9520@itemx -m64
9521@opindex m32
9522@opindex m64
9523Generate code for a 32-bit or 64-bit environment.
9524The 32-bit environment sets int, long and pointer to 32 bits and
9525generates code that runs on any i386 system.
9526The 64-bit environment sets int to 32 bits and long and pointer
9527to 64 bits and generates code for AMD's x86-64 architecture.
50d32cf6 9528
39bc1876
NS
9529@item -mno-red-zone
9530@opindex no-red-zone
9531Do not use a so called red zone for x86-64 code. The red zone is mandated
9532by the x86-64 ABI, it is a 128-byte area beyond the location of the
9533stack pointer that will not be modified by signal or interrupt handlers
9534and therefore can be used for temporary data without adjusting the stack
9535pointer. The flag @option{-mno-red-zone} disables this red zone.
dc884a86 9536
39bc1876
NS
9537@item -mcmodel=small
9538@opindex mcmodel=small
9539Generate code for the small code model: the program and its symbols must
9540be linked in the lower 2 GB of the address space. Pointers are 64 bits.
9541Programs can be statically or dynamically linked. This is the default
9542code model.
dc884a86 9543
39bc1876
NS
9544@item -mcmodel=kernel
9545@opindex mcmodel=kernel
9546Generate code for the kernel code model. The kernel runs in the
9547negative 2 GB of the address space.
9548This model has to be used for Linux kernel code.
9549
9550@item -mcmodel=medium
9551@opindex mcmodel=medium
9552Generate code for the medium model: The program is linked in the lower 2
9553GB of the address space but symbols can be located anywhere in the
9554address space. Programs can be statically or dynamically linked, but
9555building of shared libraries are not supported with the medium model.
9556
9557@item -mcmodel=large
9558@opindex mcmodel=large
9559Generate code for the large model: This model makes no assumptions
9560about addresses and sizes of sections. Currently GCC does not implement
9561this model.
74291a4b
MM
9562@end table
9563
39bc1876
NS
9564@node IA-64 Options
9565@subsection IA-64 Options
9566@cindex IA-64 Options
74291a4b 9567
39bc1876 9568These are the @samp{-m} options defined for the Intel IA-64 architecture.
74291a4b 9569
2642624b 9570@table @gcctabopt
39bc1876
NS
9571@item -mbig-endian
9572@opindex mbig-endian
9573Generate code for a big endian target. This is the default for HP-UX@.
6f670fde 9574
39bc1876
NS
9575@item -mlittle-endian
9576@opindex mlittle-endian
9577Generate code for a little endian target. This is the default for AIX5
9578and GNU/Linux.
a9f3e1a4 9579
39bc1876
NS
9580@item -mgnu-as
9581@itemx -mno-gnu-as
9582@opindex mgnu-as
9583@opindex mno-gnu-as
9584Generate (or don't) code for the GNU assembler. This is the default.
9585@c Also, this is the default if the configure option @option{--with-gnu-as}
9586@c is used.
9d913bbf 9587
39bc1876
NS
9588@item -mgnu-ld
9589@itemx -mno-gnu-ld
9590@opindex mgnu-ld
9591@opindex mno-gnu-ld
9592Generate (or don't) code for the GNU linker. This is the default.
9593@c Also, this is the default if the configure option @option{--with-gnu-ld}
9594@c is used.
a9f3e1a4 9595
39bc1876
NS
9596@item -mno-pic
9597@opindex mno-pic
9598Generate code that does not use a global pointer register. The result
9599is not position independent code, and violates the IA-64 ABI@.
74291a4b 9600
39bc1876
NS
9601@item -mvolatile-asm-stop
9602@itemx -mno-volatile-asm-stop
9603@opindex mvolatile-asm-stop
9604@opindex mno-volatile-asm-stop
9605Generate (or don't) a stop bit immediately before and after volatile asm
9606statements.
965f5423 9607
39bc1876
NS
9608@item -mregister-names
9609@itemx -mno-register-names
9610@opindex mregister-names
9611@opindex mno-register-names
9612Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9613the stacked registers. This may make assembler output more readable.
965f5423 9614
39bc1876
NS
9615@item -mno-sdata
9616@itemx -msdata
9617@opindex mno-sdata
9618@opindex msdata
9619Disable (or enable) optimizations that use the small data section. This may
9620be useful for working around optimizer bugs.
9621
9622@item -mconstant-gp
9623@opindex mconstant-gp
9624Generate code that uses a single constant global pointer value. This is
9625useful when compiling kernel code.
9626
9627@item -mauto-pic
9628@opindex mauto-pic
9629Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9630This is useful when compiling firmware code.
9631
9632@item -minline-float-divide-min-latency
9633@opindex minline-float-divide-min-latency
9634Generate code for inline divides of floating point values
9635using the minimum latency algorithm.
965f5423 9636
39bc1876
NS
9637@item -minline-float-divide-max-throughput
9638@opindex minline-float-divide-max-throughput
9639Generate code for inline divides of floating point values
9640using the maximum throughput algorithm.
965f5423 9641
39bc1876
NS
9642@item -minline-int-divide-min-latency
9643@opindex minline-int-divide-min-latency
9644Generate code for inline divides of integer values
9645using the minimum latency algorithm.
965f5423 9646
39bc1876
NS
9647@item -minline-int-divide-max-throughput
9648@opindex minline-int-divide-max-throughput
9649Generate code for inline divides of integer values
9650using the maximum throughput algorithm.
965f5423 9651
28b43def
SE
9652@item -minline-sqrt-min-latency
9653@opindex minline-sqrt-min-latency
9654Generate code for inline square roots
9655using the minimum latency algorithm.
9656
9657@item -minline-sqrt-max-throughput
9658@opindex minline-sqrt-max-throughput
9659Generate code for inline square roots
9660using the maximum throughput algorithm.
9661
39bc1876
NS
9662@item -mno-dwarf2-asm
9663@itemx -mdwarf2-asm
9664@opindex mno-dwarf2-asm
9665@opindex mdwarf2-asm
9666Don't (or do) generate assembler code for the DWARF2 line number debugging
9667info. This may be useful when not using the GNU assembler.
965f5423 9668
28b43def
SE
9669@item -mearly-stop-bits
9670@itemx -mno-early-stop-bits
9671@opindex mearly-stop-bits
9672@opindex mno-early-stop-bits
9673Allow stop bits to be placed earlier than immediately preceding the
9674instruction that triggered the stop bit. This can improve instruction
9675scheduling, but does not always do so.
9676
39bc1876
NS
9677@item -mfixed-range=@var{register-range}
9678@opindex mfixed-range
9679Generate code treating the given register range as fixed registers.
9680A fixed register is one that the register allocator can not use. This is
9681useful when compiling kernel code. A register range is specified as
9682two registers separated by a dash. Multiple register ranges can be
9683specified separated by a comma.
04e149ab 9684
28b43def
SE
9685@item -mtls-size=@var{tls-size}
9686@opindex mtls-size
9687Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
968864.
9689
7f9dc823
JW
9690@item -mtune=@var{cpu-type}
9691@opindex mtune
28b43def
SE
9692Tune the instruction scheduling for a particular CPU, Valid values are
9693itanium, itanium1, merced, itanium2, and mckinley.
9694
9695@item -mt
9696@itemx -pthread
9697@opindex mt
9698@opindex pthread
9699Add support for multithreading using the POSIX threads library. This
9700option sets flags for both the preprocessor and linker. It does
9701not affect the thread safety of object code produced by the compiler or
9702that of libraries supplied with it. These are HP-UX specific flags.
9703
9704@item -milp32
9705@itemx -mlp64
9706@opindex milp32
9707@opindex mlp64
9708Generate code for a 32-bit or 64-bit environment.
9709The 32-bit environment sets int, long and pointer to 32 bits.
9710The 64-bit environment sets int to 32 bits and long and pointer
9711to 64 bits. These are HP-UX specific flags.
9712
39bc1876 9713@end table
74291a4b 9714
38b2d076
DD
9715@node M32C Options
9716@subsection M32C Options
9717@cindex M32C options
9718
9719@table @gcctabopt
9720@item -mcpu=@var{name}
9721@opindex mcpu=
9722Select the CPU for which code is generated. @var{name} may be one of
9723@samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9724/60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9725the M32C/80 series.
9726
9727@item -msim
9728@opindex msim
9729Specifies that the program will be run on the simulator. This causes
9730an alternate runtime library to be linked in which supports, for
9731example, file I/O. You must not use this option when generating
9732programs that will run on real hardware; you must provide your own
9733runtime library for whatever I/O functions are needed.
9734
9735@item -memregs=@var{number}
9736@opindex memregs=
9737Specifies the number of memory-based pseudo-registers GCC will use
9738during code generation. These pseudo-registers will be used like real
9739registers, so there is a tradeoff between GCC's ability to fit the
9740code into available registers, and the performance penalty of using
9741memory instead of registers. Note that all modules in a program must
9742be compiled with the same value for this option. Because of that, you
9743must not use this option with the default runtime libraries gcc
9744builds.
9745
9746@end table
9747
39bc1876
NS
9748@node M32R/D Options
9749@subsection M32R/D Options
9750@cindex M32R/D options
74291a4b 9751
39bc1876 9752These @option{-m} options are defined for Renesas M32R/D architectures:
74291a4b 9753
39bc1876
NS
9754@table @gcctabopt
9755@item -m32r2
9756@opindex m32r2
9757Generate code for the M32R/2@.
74291a4b 9758
39bc1876
NS
9759@item -m32rx
9760@opindex m32rx
9761Generate code for the M32R/X@.
74291a4b 9762
39bc1876
NS
9763@item -m32r
9764@opindex m32r
9765Generate code for the M32R@. This is the default.
74291a4b 9766
39bc1876
NS
9767@item -mmodel=small
9768@opindex mmodel=small
9769Assume all objects live in the lower 16MB of memory (so that their addresses
9770can be loaded with the @code{ld24} instruction), and assume all subroutines
9771are reachable with the @code{bl} instruction.
9772This is the default.
74291a4b 9773
39bc1876
NS
9774The addressability of a particular object can be set with the
9775@code{model} attribute.
74291a4b 9776
39bc1876
NS
9777@item -mmodel=medium
9778@opindex mmodel=medium
9779Assume objects may be anywhere in the 32-bit address space (the compiler
9780will generate @code{seth/add3} instructions to load their addresses), and
9781assume all subroutines are reachable with the @code{bl} instruction.
194734e9 9782
39bc1876
NS
9783@item -mmodel=large
9784@opindex mmodel=large
9785Assume objects may be anywhere in the 32-bit address space (the compiler
9786will generate @code{seth/add3} instructions to load their addresses), and
9787assume subroutines may not be reachable with the @code{bl} instruction
9788(the compiler will generate the much slower @code{seth/add3/jl}
9789instruction sequence).
a5f3dd66 9790
39bc1876
NS
9791@item -msdata=none
9792@opindex msdata=none
9793Disable use of the small data area. Variables will be put into
9794one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9795@code{section} attribute has been specified).
9796This is the default.
a5f3dd66 9797
39bc1876
NS
9798The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9799Objects may be explicitly put in the small data area with the
9800@code{section} attribute using one of these sections.
daf2f129 9801
39bc1876
NS
9802@item -msdata=sdata
9803@opindex msdata=sdata
9804Put small global and static data in the small data area, but do not
9805generate special code to reference them.
2b589241 9806
39bc1876
NS
9807@item -msdata=use
9808@opindex msdata=use
9809Put small global and static data in the small data area, and generate
9810special instructions to reference them.
2b589241 9811
39bc1876
NS
9812@item -G @var{num}
9813@opindex G
9814@cindex smaller data references
9815Put global and static objects less than or equal to @var{num} bytes
9816into the small data or bss sections instead of the normal data or bss
9817sections. The default value of @var{num} is 8.
9818The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9819for this option to have any effect.
74291a4b 9820
39bc1876
NS
9821All modules should be compiled with the same @option{-G @var{num}} value.
9822Compiling with different values of @var{num} may or may not work; if it
9823doesn't the linker will give an error message---incorrect code will not be
9824generated.
74291a4b 9825
39bc1876
NS
9826@item -mdebug
9827@opindex mdebug
9828Makes the M32R specific code in the compiler display some statistics
9829that might help in debugging programs.
74291a4b 9830
39bc1876
NS
9831@item -malign-loops
9832@opindex malign-loops
9833Align all loops to a 32-byte boundary.
74291a4b 9834
39bc1876
NS
9835@item -mno-align-loops
9836@opindex mno-align-loops
9837Do not enforce a 32-byte alignment for loops. This is the default.
74291a4b 9838
39bc1876
NS
9839@item -missue-rate=@var{number}
9840@opindex missue-rate=@var{number}
9841Issue @var{number} instructions per cycle. @var{number} can only be 1
9842or 2.
74291a4b 9843
39bc1876
NS
9844@item -mbranch-cost=@var{number}
9845@opindex mbranch-cost=@var{number}
9846@var{number} can only be 1 or 2. If it is 1 then branches will be
9847preferred over conditional code, if it is 2, then the opposite will
9848apply.
74291a4b 9849
39bc1876
NS
9850@item -mflush-trap=@var{number}
9851@opindex mflush-trap=@var{number}
9852Specifies the trap number to use to flush the cache. The default is
985312. Valid numbers are between 0 and 15 inclusive.
74291a4b 9854
39bc1876
NS
9855@item -mno-flush-trap
9856@opindex mno-flush-trap
9857Specifies that the cache cannot be flushed by using a trap.
74291a4b 9858
39bc1876
NS
9859@item -mflush-func=@var{name}
9860@opindex mflush-func=@var{name}
9861Specifies the name of the operating system function to call to flush
9862the cache. The default is @emph{_flush_cache}, but a function call
9863will only be used if a trap is not available.
3af4bd89 9864
39bc1876
NS
9865@item -mno-flush-func
9866@opindex mno-flush-func
9867Indicates that there is no OS function for flushing the cache.
3af4bd89 9868
39bc1876 9869@end table
3af4bd89 9870
39bc1876
NS
9871@node M680x0 Options
9872@subsection M680x0 Options
9873@cindex M680x0 options
f22a97d2 9874
39bc1876
NS
9875These are the @samp{-m} options defined for the 68000 series. The default
9876values for these options depends on which style of 68000 was selected when
9877the compiler was configured; the defaults for the most common choices are
9878given below.
1255c85c 9879
39bc1876
NS
9880@table @gcctabopt
9881@item -m68000
9882@itemx -mc68000
9883@opindex m68000
9884@opindex mc68000
9885Generate output for a 68000. This is the default
9886when the compiler is configured for 68000-based systems.
1255c85c 9887
39bc1876
NS
9888Use this option for microcontrollers with a 68000 or EC000 core,
9889including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
7eafc329 9890
39bc1876
NS
9891@item -m68020
9892@itemx -mc68020
9893@opindex m68020
9894@opindex mc68020
9895Generate output for a 68020. This is the default
9896when the compiler is configured for 68020-based systems.
f73ad30e 9897
39bc1876
NS
9898@item -m68881
9899@opindex m68881
9900Generate output containing 68881 instructions for floating point.
9901This is the default for most 68020 systems unless @option{--nfp} was
9902specified when the compiler was configured.
f73ad30e 9903
39bc1876
NS
9904@item -m68030
9905@opindex m68030
9906Generate output for a 68030. This is the default when the compiler is
9907configured for 68030-based systems.
79f05c19 9908
39bc1876
NS
9909@item -m68040
9910@opindex m68040
9911Generate output for a 68040. This is the default when the compiler is
9912configured for 68040-based systems.
79f05c19 9913
39bc1876
NS
9914This option inhibits the use of 68881/68882 instructions that have to be
9915emulated by software on the 68040. Use this option if your 68040 does not
9916have code to emulate those instructions.
762e166b 9917
39bc1876
NS
9918@item -m68060
9919@opindex m68060
9920Generate output for a 68060. This is the default when the compiler is
9921configured for 68060-based systems.
74dc3e94 9922
39bc1876
NS
9923This option inhibits the use of 68020 and 68881/68882 instructions that
9924have to be emulated by software on the 68060. Use this option if your 68060
9925does not have code to emulate those instructions.
74dc3e94 9926
39bc1876
NS
9927@item -mcpu32
9928@opindex mcpu32
9929Generate output for a CPU32. This is the default
9930when the compiler is configured for CPU32-based systems.
3af4bd89 9931
39bc1876
NS
9932Use this option for microcontrollers with a
9933CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
993468336, 68340, 68341, 68349 and 68360.
14f73b5a 9935
39bc1876
NS
9936@item -m5200
9937@opindex m5200
9938Generate output for a 520X ``coldfire'' family cpu. This is the default
9939when the compiler is configured for 520X-based systems.
14f73b5a 9940
39bc1876
NS
9941Use this option for microcontroller with a 5200 core, including
9942the MCF5202, MCF5203, MCF5204 and MCF5202.
a7701995 9943
dcc21c4c
PB
9944@item -mcfv4e
9945@opindex mcfv4e
9946Generate output for a ColdFire V4e family cpu (e.g.@: 547x/548x).
9947This includes use of hardware floating point instructions.
a7701995 9948
39bc1876
NS
9949@item -m68020-40
9950@opindex m68020-40
9951Generate output for a 68040, without using any of the new instructions.
9952This results in code which can run relatively efficiently on either a
995368020/68881 or a 68030 or a 68040. The generated code does use the
995468881 instructions that are emulated on the 68040.
a7701995 9955
39bc1876
NS
9956@item -m68020-60
9957@opindex m68020-60
9958Generate output for a 68060, without using any of the new instructions.
9959This results in code which can run relatively efficiently on either a
996068020/68881 or a 68030 or a 68040. The generated code does use the
996168881 instructions that are emulated on the 68060.
a7701995 9962
39bc1876
NS
9963@item -msoft-float
9964@opindex msoft-float
9965Generate output containing library calls for floating point.
9966@strong{Warning:} the requisite libraries are not available for all m68k
9967targets. Normally the facilities of the machine's usual C compiler are
9968used, but this can't be done directly in cross-compilation. You must
9969make your own arrangements to provide suitable library functions for
9970cross-compilation. The embedded targets @samp{m68k-*-aout} and
9971@samp{m68k-*-coff} do provide software floating point support.
14f73b5a 9972
39bc1876
NS
9973@item -mshort
9974@opindex mshort
9975Consider type @code{int} to be 16 bits wide, like @code{short int}.
9976Additionally, parameters passed on the stack are also aligned to a
997716-bit boundary even on targets whose API mandates promotion to 32-bit.
74291a4b 9978
39bc1876
NS
9979@item -mnobitfield
9980@opindex mnobitfield
9981Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
9982and @option{-m5200} options imply @w{@option{-mnobitfield}}.
74291a4b 9983
39bc1876
NS
9984@item -mbitfield
9985@opindex mbitfield
9986Do use the bit-field instructions. The @option{-m68020} option implies
9987@option{-mbitfield}. This is the default if you use a configuration
9988designed for a 68020.
9989
9990@item -mrtd
9991@opindex mrtd
9992Use a different function-calling convention, in which functions
9993that take a fixed number of arguments return with the @code{rtd}
9994instruction, which pops their arguments while returning. This
9995saves one instruction in the caller since there is no need to pop
9996the arguments there.
ea3bfbfe 9997
39bc1876
NS
9998This calling convention is incompatible with the one normally
9999used on Unix, so you cannot use it if you need to call libraries
10000compiled with the Unix compiler.
74291a4b 10001
39bc1876
NS
10002Also, you must provide function prototypes for all functions that
10003take variable numbers of arguments (including @code{printf});
10004otherwise incorrect code will be generated for calls to those
10005functions.
861bb6c1 10006
39bc1876
NS
10007In addition, seriously incorrect code will result if you call a
10008function with too many arguments. (Normally, extra arguments are
10009harmlessly ignored.)
74291a4b 10010
39bc1876
NS
10011The @code{rtd} instruction is supported by the 68010, 68020, 68030,
1001268040, 68060 and CPU32 processors, but not by the 68000 or 5200.
74291a4b 10013
39bc1876
NS
10014@item -malign-int
10015@itemx -mno-align-int
10016@opindex malign-int
10017@opindex mno-align-int
10018Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10019@code{float}, @code{double}, and @code{long double} variables on a 32-bit
10020boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10021Aligning variables on 32-bit boundaries produces code that runs somewhat
10022faster on processors with 32-bit busses at the expense of more memory.
74291a4b 10023
39bc1876
NS
10024@strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10025align structures containing the above types differently than
10026most published application binary interface specifications for the m68k.
74291a4b 10027
39bc1876
NS
10028@item -mpcrel
10029@opindex mpcrel
10030Use the pc-relative addressing mode of the 68000 directly, instead of
10031using a global offset table. At present, this option implies @option{-fpic},
10032allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
10033not presently supported with @option{-mpcrel}, though this could be supported for
1003468020 and higher processors.
74291a4b 10035
39bc1876
NS
10036@item -mno-strict-align
10037@itemx -mstrict-align
10038@opindex mno-strict-align
10039@opindex mstrict-align
10040Do not (do) assume that unaligned memory references will be handled by
10041the system.
74291a4b 10042
39bc1876
NS
10043@item -msep-data
10044Generate code that allows the data segment to be located in a different
10045area of memory from the text segment. This allows for execute in place in
4ec7afd7
KH
10046an environment without virtual memory management. This option implies
10047@option{-fPIC}.
74291a4b 10048
39bc1876
NS
10049@item -mno-sep-data
10050Generate code that assumes that the data segment follows the text segment.
10051This is the default.
74291a4b 10052
39bc1876
NS
10053@item -mid-shared-library
10054Generate code that supports shared libraries via the library ID method.
10055This allows for execute in place and shared libraries in an environment
4ec7afd7 10056without virtual memory management. This option implies @option{-fPIC}.
74291a4b 10057
39bc1876
NS
10058@item -mno-id-shared-library
10059Generate code that doesn't assume ID based shared libraries are being used.
10060This is the default.
74291a4b 10061
39bc1876
NS
10062@item -mshared-library-id=n
10063Specified the identification number of the ID based shared library being
10064compiled. Specifying a value of 0 will generate more compact code, specifying
10065other values will force the allocation of that number to the current
10066library but is no more space or time efficient than omitting this option.
74291a4b 10067
39bc1876 10068@end table
74291a4b 10069
39bc1876
NS
10070@node M68hc1x Options
10071@subsection M68hc1x Options
10072@cindex M68hc1x options
74291a4b 10073
39bc1876
NS
10074These are the @samp{-m} options defined for the 68hc11 and 68hc12
10075microcontrollers. The default values for these options depends on
10076which style of microcontroller was selected when the compiler was configured;
10077the defaults for the most common choices are given below.
c219e1da 10078
39bc1876
NS
10079@table @gcctabopt
10080@item -m6811
10081@itemx -m68hc11
10082@opindex m6811
10083@opindex m68hc11
10084Generate output for a 68HC11. This is the default
10085when the compiler is configured for 68HC11-based systems.
c5d3d49b 10086
39bc1876
NS
10087@item -m6812
10088@itemx -m68hc12
10089@opindex m6812
10090@opindex m68hc12
10091Generate output for a 68HC12. This is the default
10092when the compiler is configured for 68HC12-based systems.
c5d3d49b 10093
39bc1876
NS
10094@item -m68S12
10095@itemx -m68hcs12
10096@opindex m68S12
10097@opindex m68hcs12
10098Generate output for a 68HCS12.
c5d3d49b 10099
39bc1876
NS
10100@item -mauto-incdec
10101@opindex mauto-incdec
10102Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10103addressing modes.
34208acf 10104
39bc1876
NS
10105@item -minmax
10106@itemx -nominmax
10107@opindex minmax
10108@opindex mnominmax
10109Enable the use of 68HC12 min and max instructions.
34208acf 10110
39bc1876
NS
10111@item -mlong-calls
10112@itemx -mno-long-calls
10113@opindex mlong-calls
10114@opindex mno-long-calls
10115Treat all calls as being far away (near). If calls are assumed to be
10116far away, the compiler will use the @code{call} instruction to
10117call a function and the @code{rtc} instruction for returning.
34208acf 10118
39bc1876
NS
10119@item -mshort
10120@opindex mshort
10121Consider type @code{int} to be 16 bits wide, like @code{short int}.
34208acf 10122
39bc1876
NS
10123@item -msoft-reg-count=@var{count}
10124@opindex msoft-reg-count
10125Specify the number of pseudo-soft registers which are used for the
10126code generation. The maximum number is 32. Using more pseudo-soft
10127register may or may not result in better code depending on the program.
10128The default is 4 for 68HC11 and 2 for 68HC12.
34208acf 10129
39bc1876 10130@end table
34208acf 10131
39bc1876
NS
10132@node MCore Options
10133@subsection MCore Options
10134@cindex MCore options
34208acf 10135
39bc1876
NS
10136These are the @samp{-m} options defined for the Motorola M*Core
10137processors.
34208acf 10138
39bc1876 10139@table @gcctabopt
34208acf 10140
39bc1876
NS
10141@item -mhardlit
10142@itemx -mno-hardlit
10143@opindex mhardlit
10144@opindex mno-hardlit
10145Inline constants into the code stream if it can be done in two
10146instructions or less.
34208acf 10147
39bc1876
NS
10148@item -mdiv
10149@itemx -mno-div
10150@opindex mdiv
10151@opindex mno-div
10152Use the divide instruction. (Enabled by default).
a02aa5b0 10153
39bc1876
NS
10154@item -mrelax-immediate
10155@itemx -mno-relax-immediate
10156@opindex mrelax-immediate
10157@opindex mno-relax-immediate
10158Allow arbitrary sized immediates in bit operations.
a02aa5b0 10159
39bc1876
NS
10160@item -mwide-bitfields
10161@itemx -mno-wide-bitfields
10162@opindex mwide-bitfields
10163@opindex mno-wide-bitfields
10164Always treat bit-fields as int-sized.
a02aa5b0 10165
39bc1876
NS
10166@item -m4byte-functions
10167@itemx -mno-4byte-functions
10168@opindex m4byte-functions
10169@opindex mno-4byte-functions
10170Force all functions to be aligned to a four byte boundary.
a02aa5b0 10171
39bc1876
NS
10172@item -mcallgraph-data
10173@itemx -mno-callgraph-data
10174@opindex mcallgraph-data
10175@opindex mno-callgraph-data
10176Emit callgraph information.
f401d0f5 10177
39bc1876
NS
10178@item -mslow-bytes
10179@itemx -mno-slow-bytes
10180@opindex mslow-bytes
10181@opindex mno-slow-bytes
10182Prefer word access when reading byte quantities.
f401d0f5 10183
39bc1876
NS
10184@item -mlittle-endian
10185@itemx -mbig-endian
10186@opindex mlittle-endian
10187@opindex mbig-endian
10188Generate code for a little endian target.
f401d0f5 10189
39bc1876
NS
10190@item -m210
10191@itemx -m340
10192@opindex m210
10193@opindex m340
10194Generate code for the 210 processor.
74291a4b
MM
10195@end table
10196
39bc1876
NS
10197@node MIPS Options
10198@subsection MIPS Options
10199@cindex MIPS options
74291a4b 10200
2642624b 10201@table @gcctabopt
74291a4b 10202
39bc1876
NS
10203@item -EB
10204@opindex EB
10205Generate big-endian code.
74291a4b 10206
39bc1876
NS
10207@item -EL
10208@opindex EL
10209Generate little-endian code. This is the default for @samp{mips*el-*-*}
10210configurations.
74291a4b 10211
39bc1876
NS
10212@item -march=@var{arch}
10213@opindex march
10214Generate code that will run on @var{arch}, which can be the name of a
10215generic MIPS ISA, or the name of a particular processor.
10216The ISA names are:
10217@samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10218@samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10219The processor names are:
79dad081
DU
10220@samp{4kc}, @samp{4km}, @samp{4kp},
10221@samp{5kc}, @samp{5kf},
10222@samp{20kc},
10223@samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
39bc1876 10224@samp{m4k},
39bc1876 10225@samp{orion},
79dad081
DU
10226@samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10227@samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10228@samp{rm7000}, @samp{rm9000},
39bc1876 10229@samp{sb1},
79dad081 10230@samp{sr71000},
39bc1876
NS
10231@samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10232@samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10233The special value @samp{from-abi} selects the
10234most compatible architecture for the selected ABI (that is,
10235@samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
74291a4b 10236
39bc1876
NS
10237In processor names, a final @samp{000} can be abbreviated as @samp{k}
10238(for example, @samp{-march=r2k}). Prefixes are optional, and
10239@samp{vr} may be written @samp{r}.
74291a4b 10240
39bc1876
NS
10241GCC defines two macros based on the value of this option. The first
10242is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10243a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
10244where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10245For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10246to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
74291a4b 10247
39bc1876
NS
10248Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10249above. In other words, it will have the full prefix and will not
10250abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
10251the macro names the resolved architecture (either @samp{"mips1"} or
10252@samp{"mips3"}). It names the default architecture when no
10253@option{-march} option is given.
74291a4b 10254
39bc1876
NS
10255@item -mtune=@var{arch}
10256@opindex mtune
10257Optimize for @var{arch}. Among other things, this option controls
10258the way instructions are scheduled, and the perceived cost of arithmetic
10259operations. The list of @var{arch} values is the same as for
10260@option{-march}.
74291a4b 10261
39bc1876
NS
10262When this option is not used, GCC will optimize for the processor
10263specified by @option{-march}. By using @option{-march} and
10264@option{-mtune} together, it is possible to generate code that will
10265run on a family of processors, but optimize the code for one
10266particular member of that family.
74291a4b 10267
39bc1876
NS
10268@samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10269@samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10270@samp{-march} ones described above.
74291a4b 10271
39bc1876
NS
10272@item -mips1
10273@opindex mips1
10274Equivalent to @samp{-march=mips1}.
74291a4b 10275
39bc1876
NS
10276@item -mips2
10277@opindex mips2
10278Equivalent to @samp{-march=mips2}.
74291a4b 10279
39bc1876
NS
10280@item -mips3
10281@opindex mips3
10282Equivalent to @samp{-march=mips3}.
74291a4b 10283
39bc1876
NS
10284@item -mips4
10285@opindex mips4
10286Equivalent to @samp{-march=mips4}.
10287
10288@item -mips32
10289@opindex mips32
10290Equivalent to @samp{-march=mips32}.
74291a4b 10291
39bc1876
NS
10292@item -mips32r2
10293@opindex mips32r2
10294Equivalent to @samp{-march=mips32r2}.
74291a4b 10295
39bc1876
NS
10296@item -mips64
10297@opindex mips64
10298Equivalent to @samp{-march=mips64}.
74291a4b 10299
39bc1876
NS
10300@item -mips16
10301@itemx -mno-mips16
10302@opindex mips16
10303@opindex mno-mips16
7cc63a88 10304Generate (do not generate) MIPS16 code. If GCC is targetting a
71cb39e6 10305MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
74291a4b 10306
39bc1876
NS
10307@item -mabi=32
10308@itemx -mabi=o64
10309@itemx -mabi=n32
10310@itemx -mabi=64
10311@itemx -mabi=eabi
10312@opindex mabi=32
10313@opindex mabi=o64
10314@opindex mabi=n32
10315@opindex mabi=64
10316@opindex mabi=eabi
10317Generate code for the given ABI@.
74291a4b 10318
39bc1876
NS
10319Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
10320generates 64-bit code when you select a 64-bit architecture, but you
10321can use @option{-mgp32} to get 32-bit code instead.
74291a4b 10322
39bc1876
NS
10323For information about the O64 ABI, see
10324@w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
74291a4b 10325
39bc1876
NS
10326@item -mabicalls
10327@itemx -mno-abicalls
10328@opindex mabicalls
10329@opindex mno-abicalls
10330Generate (do not generate) SVR4-style position-independent code.
10331@option{-mabicalls} is the default for SVR4-based systems.
74291a4b 10332
39bc1876
NS
10333@item -mxgot
10334@itemx -mno-xgot
10335@opindex mxgot
10336@opindex mno-xgot
10337Lift (do not lift) the usual restrictions on the size of the global
10338offset table.
74291a4b 10339
8a36672b 10340GCC normally uses a single instruction to load values from the GOT@.
39bc1876
NS
10341While this is relatively efficient, it will only work if the GOT
10342is smaller than about 64k. Anything larger will cause the linker
10343to report an error such as:
74291a4b 10344
39bc1876
NS
10345@cindex relocation truncated to fit (MIPS)
10346@smallexample
10347relocation truncated to fit: R_MIPS_GOT16 foobar
10348@end smallexample
74291a4b 10349
39bc1876
NS
10350If this happens, you should recompile your code with @option{-mxgot}.
10351It should then work with very large GOTs, although it will also be
10352less efficient, since it will take three instructions to fetch the
10353value of a global symbol.
956d6950 10354
39bc1876
NS
10355Note that some linkers can create multiple GOTs. If you have such a
10356linker, you should only need to use @option{-mxgot} when a single object
10357file accesses more than 64k's worth of GOT entries. Very few do.
956d6950 10358
39bc1876
NS
10359These options have no effect unless GCC is generating position
10360independent code.
956d6950 10361
39bc1876
NS
10362@item -mgp32
10363@opindex mgp32
10364Assume that general-purpose registers are 32 bits wide.
58605ba0 10365
39bc1876
NS
10366@item -mgp64
10367@opindex mgp64
10368Assume that general-purpose registers are 64 bits wide.
58605ba0 10369
39bc1876
NS
10370@item -mfp32
10371@opindex mfp32
10372Assume that floating-point registers are 32 bits wide.
58605ba0 10373
39bc1876
NS
10374@item -mfp64
10375@opindex mfp64
10376Assume that floating-point registers are 64 bits wide.
58605ba0 10377
39bc1876
NS
10378@item -mhard-float
10379@opindex mhard-float
10380Use floating-point coprocessor instructions.
58605ba0 10381
39bc1876
NS
10382@item -msoft-float
10383@opindex msoft-float
10384Do not use floating-point coprocessor instructions. Implement
10385floating-point calculations using library calls instead.
3094247f 10386
39bc1876
NS
10387@item -msingle-float
10388@opindex msingle-float
10389Assume that the floating-point coprocessor only supports single-precision
10390operations.
3094247f 10391
39bc1876
NS
10392@itemx -mdouble-float
10393@opindex mdouble-float
10394Assume that the floating-point coprocessor supports double-precision
10395operations. This is the default.
956d6950 10396
118ea793
CF
10397@itemx -mdsp
10398@itemx -mno-dsp
10399@opindex mdsp
10400@opindex mno-dsp
10401Use (do not use) the MIPS DSP ASE. @xref{MIPS DSP Built-in Functions}.
10402
06a4ab70
CF
10403@itemx -mpaired-single
10404@itemx -mno-paired-single
10405@opindex mpaired-single
10406@opindex mno-paired-single
d840bfd3
CF
10407Use (do not use) paired-single floating-point instructions.
10408@xref{MIPS Paired-Single Support}. This option can only be used
10409when generating 64-bit code and requires hardware floating-point
10410support to be enabled.
06a4ab70
CF
10411
10412@itemx -mips3d
10413@itemx -mno-mips3d
10414@opindex mips3d
10415@opindex mno-mips3d
8a36672b 10416Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
d840bfd3 10417The option @option{-mips3d} implies @option{-mpaired-single}.
06a4ab70 10418
39bc1876
NS
10419@item -mlong64
10420@opindex mlong64
10421Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
10422an explanation of the default and the way that the pointer size is
10423determined.
956d6950 10424
39bc1876
NS
10425@item -mlong32
10426@opindex mlong32
10427Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
956d6950 10428
39bc1876
NS
10429The default size of @code{int}s, @code{long}s and pointers depends on
10430the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
10431uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
1043232-bit @code{long}s. Pointers are the same size as @code{long}s,
10433or the same size as integer registers, whichever is smaller.
956d6950 10434
acda0e26
RS
10435@item -msym32
10436@itemx -mno-sym32
10437@opindex msym32
10438@opindex mno-sym32
10439Assume (do not assume) that all symbols have 32-bit values, regardless
10440of the selected ABI@. This option is useful in combination with
10441@option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10442to generate shorter and faster references to symbolic addresses.
10443
39bc1876
NS
10444@item -G @var{num}
10445@opindex G
10446@cindex smaller data references (MIPS)
10447@cindex gp-relative references (MIPS)
10448Put global and static items less than or equal to @var{num} bytes into
10449the small data or bss section instead of the normal data or bss section.
10450This allows the data to be accessed using a single instruction.
10451
10452All modules should be compiled with the same @option{-G @var{num}}
10453value.
956d6950 10454
39bc1876
NS
10455@item -membedded-data
10456@itemx -mno-embedded-data
10457@opindex membedded-data
10458@opindex mno-embedded-data
10459Allocate variables to the read-only data section first if possible, then
10460next in the small data section if possible, otherwise in data. This gives
10461slightly slower code than the default, but reduces the amount of RAM required
10462when executing, and thus may be preferred for some embedded systems.
58605ba0 10463
39bc1876
NS
10464@item -muninit-const-in-rodata
10465@itemx -mno-uninit-const-in-rodata
10466@opindex muninit-const-in-rodata
10467@opindex mno-uninit-const-in-rodata
10468Put uninitialized @code{const} variables in the read-only data section.
10469This option is only meaningful in conjunction with @option{-membedded-data}.
4f69985c 10470
39bc1876
NS
10471@item -msplit-addresses
10472@itemx -mno-split-addresses
10473@opindex msplit-addresses
10474@opindex mno-split-addresses
10475Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
38b974a6 10476relocation operators. This option has been superseded by
39bc1876 10477@option{-mexplicit-relocs} but is retained for backwards compatibility.
58605ba0 10478
39bc1876
NS
10479@item -mexplicit-relocs
10480@itemx -mno-explicit-relocs
10481@opindex mexplicit-relocs
10482@opindex mno-explicit-relocs
10483Use (do not use) assembler relocation operators when dealing with symbolic
10484addresses. The alternative, selected by @option{-mno-explicit-relocs},
10485is to use assembler macros instead.
4f69985c 10486
12e4afe4
RS
10487@option{-mexplicit-relocs} is the default if GCC was configured
10488to use an assembler that supports relocation operators.
4f69985c 10489
39bc1876
NS
10490@item -mcheck-zero-division
10491@itemx -mno-check-zero-division
10492@opindex mcheck-zero-division
10493@opindex mno-check-zero-division
10494Trap (do not trap) on integer division by zero. The default is
10495@option{-mcheck-zero-division}.
4f69985c 10496
9f0df97a
DD
10497@item -mdivide-traps
10498@itemx -mdivide-breaks
10499@opindex mdivide-traps
10500@opindex mdivide-breaks
10501MIPS systems check for division by zero by generating either a
10502conditional trap or a break instruction. Using traps results in
10503smaller code, but is only supported on MIPS II and later. Also, some
10504versions of the Linux kernel have a bug that prevents trap from
8a36672b 10505generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
9f0df97a
DD
10506allow conditional traps on architectures that support them and
10507@option{-mdivide-breaks} to force the use of breaks.
10508
10509The default is usually @option{-mdivide-traps}, but this can be
10510overridden at configure time using @option{--with-divide=breaks}.
10511Divide-by-zero checks can be completely disabled using
10512@option{-mno-check-zero-division}.
10513
39bc1876
NS
10514@item -mmemcpy
10515@itemx -mno-memcpy
10516@opindex mmemcpy
10517@opindex mno-memcpy
10518Force (do not force) the use of @code{memcpy()} for non-trivial block
10519moves. The default is @option{-mno-memcpy}, which allows GCC to inline
10520most constant-sized copies.
74291a4b 10521
39bc1876
NS
10522@item -mlong-calls
10523@itemx -mno-long-calls
10524@opindex mlong-calls
10525@opindex mno-long-calls
10526Disable (do not disable) use of the @code{jal} instruction. Calling
10527functions using @code{jal} is more efficient but requires the caller
10528and callee to be in the same 256 megabyte segment.
d7c23cdc 10529
39bc1876
NS
10530This option has no effect on abicalls code. The default is
10531@option{-mno-long-calls}.
d7c23cdc 10532
39bc1876
NS
10533@item -mmad
10534@itemx -mno-mad
10535@opindex mmad
10536@opindex mno-mad
10537Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8a36672b 10538instructions, as provided by the R4650 ISA@.
d7c23cdc 10539
39bc1876
NS
10540@item -mfused-madd
10541@itemx -mno-fused-madd
10542@opindex mfused-madd
10543@opindex mno-fused-madd
10544Enable (disable) use of the floating point multiply-accumulate
10545instructions, when they are available. The default is
10546@option{-mfused-madd}.
74291a4b 10547
39bc1876
NS
10548When multiply-accumulate instructions are used, the intermediate
10549product is calculated to infinite precision and is not subject to
10550the FCSR Flush to Zero bit. This may be undesirable in some
10551circumstances.
74291a4b 10552
39bc1876
NS
10553@item -nocpp
10554@opindex nocpp
10555Tell the MIPS assembler to not run its preprocessor over user
10556assembler files (with a @samp{.s} suffix) when assembling them.
74291a4b 10557
39bc1876
NS
10558@item -mfix-r4000
10559@itemx -mno-fix-r4000
10560@opindex mfix-r4000
10561@opindex mno-fix-r4000
10562Work around certain R4000 CPU errata:
10563@itemize @minus
10564@item
10565A double-word or a variable shift may give an incorrect result if executed
10566immediately after starting an integer division.
10567@item
10568A double-word or a variable shift may give an incorrect result if executed
10569while an integer multiplication is in progress.
10570@item
10571An integer division may give an incorrect result if started in a delay slot
10572of a taken branch or a jump.
10573@end itemize
74291a4b 10574
39bc1876
NS
10575@item -mfix-r4400
10576@itemx -mno-fix-r4400
10577@opindex mfix-r4400
10578@opindex mno-fix-r4400
10579Work around certain R4400 CPU errata:
10580@itemize @minus
10581@item
10582A double-word or a variable shift may give an incorrect result if executed
10583immediately after starting an integer division.
10584@end itemize
dcb9d1f0 10585
39bc1876
NS
10586@item -mfix-vr4120
10587@itemx -mno-fix-vr4120
10588@opindex mfix-vr4120
10589Work around certain VR4120 errata:
10590@itemize @minus
10591@item
10592@code{dmultu} does not always produce the correct result.
10593@item
10594@code{div} and @code{ddiv} do not always produce the correct result if one
10595of the operands is negative.
10596@end itemize
10597The workarounds for the division errata rely on special functions in
10598@file{libgcc.a}. At present, these functions are only provided by
10599the @code{mips64vr*-elf} configurations.
39ba95b5 10600
39bc1876
NS
10601Other VR4120 errata require a nop to be inserted between certain pairs of
10602instructions. These errata are handled by the assembler, not by GCC itself.
17f0f8fa 10603
0ac40e7a
RS
10604@item -mfix-vr4130
10605@opindex mfix-vr4130
10606Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
10607workarounds are implemented by the assembler rather than by GCC,
10608although GCC will avoid using @code{mflo} and @code{mfhi} if the
10609VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10610instructions are available instead.
10611
39bc1876
NS
10612@item -mfix-sb1
10613@itemx -mno-fix-sb1
10614@opindex mfix-sb1
10615Work around certain SB-1 CPU core errata.
10616(This flag currently works around the SB-1 revision 2
10617``F1'' and ``F2'' floating point errata.)
74291a4b 10618
39bc1876
NS
10619@item -mflush-func=@var{func}
10620@itemx -mno-flush-func
10621@opindex mflush-func
10622Specifies the function to call to flush the I and D caches, or to not
10623call any such function. If called, the function must take the same
10624arguments as the common @code{_flush_func()}, that is, the address of the
10625memory range for which the cache is being flushed, the size of the
10626memory range, and the number 3 (to flush both caches). The default
10627depends on the target GCC was configured for, but commonly is either
10628@samp{_flush_func} or @samp{__cpu_flush}.
74291a4b 10629
39bc1876
NS
10630@item -mbranch-likely
10631@itemx -mno-branch-likely
10632@opindex mbranch-likely
10633@opindex mno-branch-likely
10634Enable or disable use of Branch Likely instructions, regardless of the
10635default for the selected architecture. By default, Branch Likely
10636instructions may be generated if they are supported by the selected
10637architecture. An exception is for the MIPS32 and MIPS64 architectures
10638and processors which implement those architectures; for those, Branch
10639Likely instructions will not be generated by default because the MIPS32
10640and MIPS64 architectures specifically deprecate their use.
74291a4b 10641
39bc1876
NS
10642@item -mfp-exceptions
10643@itemx -mno-fp-exceptions
10644@opindex mfp-exceptions
10645Specifies whether FP exceptions are enabled. This affects how we schedule
10646FP instructions for some processors. The default is that FP exceptions are
10647enabled.
74291a4b 10648
39bc1876
NS
10649For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
1065064-bit code, then we can use both FP pipes. Otherwise, we can only use one
10651FP pipe.
74291a4b 10652
39bc1876
NS
10653@item -mvr4130-align
10654@itemx -mno-vr4130-align
10655@opindex mvr4130-align
10656The VR4130 pipeline is two-way superscalar, but can only issue two
10657instructions together if the first one is 8-byte aligned. When this
10658option is enabled, GCC will align pairs of instructions that it
10659thinks should execute in parallel.
74291a4b 10660
39bc1876
NS
10661This option only has an effect when optimizing for the VR4130.
10662It normally makes code faster, but at the expense of making it bigger.
10663It is enabled by default at optimization level @option{-O3}.
10664@end table
3a8699c7 10665
39bc1876
NS
10666@node MMIX Options
10667@subsection MMIX Options
10668@cindex MMIX Options
74291a4b 10669
39bc1876 10670These options are defined for the MMIX:
74291a4b 10671
39bc1876
NS
10672@table @gcctabopt
10673@item -mlibfuncs
10674@itemx -mno-libfuncs
10675@opindex mlibfuncs
10676@opindex mno-libfuncs
10677Specify that intrinsic library functions are being compiled, passing all
10678values in registers, no matter the size.
3cadd778 10679
39bc1876
NS
10680@item -mepsilon
10681@itemx -mno-epsilon
10682@opindex mepsilon
10683@opindex mno-epsilon
10684Generate floating-point comparison instructions that compare with respect
10685to the @code{rE} epsilon register.
3cadd778 10686
39bc1876
NS
10687@item -mabi=mmixware
10688@itemx -mabi=gnu
10689@opindex mabi-mmixware
10690@opindex mabi=gnu
10691Generate code that passes function parameters and return values that (in
10692the called function) are seen as registers @code{$0} and up, as opposed to
10693the GNU ABI which uses global registers @code{$231} and up.
3cadd778 10694
39bc1876
NS
10695@item -mzero-extend
10696@itemx -mno-zero-extend
10697@opindex mzero-extend
10698@opindex mno-zero-extend
10699When reading data from memory in sizes shorter than 64 bits, use (do not
10700use) zero-extending load instructions by default, rather than
10701sign-extending ones.
3cadd778 10702
39bc1876
NS
10703@item -mknuthdiv
10704@itemx -mno-knuthdiv
10705@opindex mknuthdiv
10706@opindex mno-knuthdiv
10707Make the result of a division yielding a remainder have the same sign as
10708the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10709remainder follows the sign of the dividend. Both methods are
10710arithmetically valid, the latter being almost exclusively used.
74291a4b 10711
39bc1876
NS
10712@item -mtoplevel-symbols
10713@itemx -mno-toplevel-symbols
10714@opindex mtoplevel-symbols
10715@opindex mno-toplevel-symbols
10716Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10717code can be used with the @code{PREFIX} assembly directive.
74291a4b 10718
39bc1876
NS
10719@item -melf
10720@opindex melf
10721Generate an executable in the ELF format, rather than the default
10722@samp{mmo} format used by the @command{mmix} simulator.
3d5a0820 10723
39bc1876
NS
10724@item -mbranch-predict
10725@itemx -mno-branch-predict
10726@opindex mbranch-predict
10727@opindex mno-branch-predict
10728Use (do not use) the probable-branch instructions, when static branch
10729prediction indicates a probable branch.
3cadd778 10730
39bc1876
NS
10731@item -mbase-addresses
10732@itemx -mno-base-addresses
10733@opindex mbase-addresses
10734@opindex mno-base-addresses
10735Generate (do not generate) code that uses @emph{base addresses}. Using a
10736base address automatically generates a request (handled by the assembler
10737and the linker) for a constant to be set up in a global register. The
10738register is used for one or more base address requests within the range 0
10739to 255 from the value held in the register. The generally leads to short
10740and fast code, but the number of different data items that can be
10741addressed is limited. This means that a program that uses lots of static
10742data may require @option{-mno-base-addresses}.
3cadd778 10743
39bc1876
NS
10744@item -msingle-exit
10745@itemx -mno-single-exit
10746@opindex msingle-exit
10747@opindex mno-single-exit
10748Force (do not force) generated code to have a single exit point in each
10749function.
10750@end table
3cadd778 10751
39bc1876
NS
10752@node MN10300 Options
10753@subsection MN10300 Options
10754@cindex MN10300 options
3cadd778 10755
39bc1876 10756These @option{-m} options are defined for Matsushita MN10300 architectures:
3cadd778 10757
39bc1876
NS
10758@table @gcctabopt
10759@item -mmult-bug
10760@opindex mmult-bug
10761Generate code to avoid bugs in the multiply instructions for the MN10300
10762processors. This is the default.
c474f76b 10763
39bc1876
NS
10764@item -mno-mult-bug
10765@opindex mno-mult-bug
10766Do not generate code to avoid bugs in the multiply instructions for the
10767MN10300 processors.
3cadd778 10768
39bc1876
NS
10769@item -mam33
10770@opindex mam33
10771Generate code which uses features specific to the AM33 processor.
3cadd778 10772
39bc1876
NS
10773@item -mno-am33
10774@opindex mno-am33
10775Do not generate code which uses features specific to the AM33 processor. This
10776is the default.
1a66cd67 10777
b1eb8119
DD
10778@item -mreturn-pointer-on-d0
10779@opindex mreturn-pointer-on-d0
10780When generating a function which returns a pointer, return the pointer
10781in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
10782only in a0, and attempts to call such functions without a prototype
10783would result in errors. Note that this option is on by default; use
10784@option{-mno-return-pointer-on-d0} to disable it.
10785
39bc1876
NS
10786@item -mno-crt0
10787@opindex mno-crt0
10788Do not link in the C run-time initialization object file.
93ca1662 10789
39bc1876
NS
10790@item -mrelax
10791@opindex mrelax
10792Indicate to the linker that it should perform a relaxation optimization pass
10793to shorten branches, calls and absolute memory addresses. This option only
10794has an effect when used on the command line for the final link step.
10795
10796This option makes symbolic debugging impossible.
74291a4b
MM
10797@end table
10798
6c9ac67a
NS
10799@node MT Options
10800@subsection MT Options
10801@cindex MT options
c85ba4fb 10802
6c9ac67a 10803These @option{-m} options are defined for Morpho MT architectures:
c85ba4fb
AH
10804
10805@table @gcctabopt
10806
10807@item -march=@var{cpu-type}
10808@opindex march
10809Generate code that will run on @var{cpu-type}, which is the name of a system
10810representing a certain processor type. Possible values for
6c9ac67a
NS
10811@var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10812@samp{ms1-16-003} and @samp{ms2}.
c85ba4fb 10813
6c9ac67a 10814When this option is not used, the default is @option{-march=ms1-16-002}.
c85ba4fb
AH
10815
10816@item -mbacc
10817@opindex mbacc
10818Use byte loads and stores when generating code.
10819
10820@item -mno-bacc
10821@opindex mno-bacc
10822Do not use byte loads and stores when generating code.
10823
10824@item -msim
10825@opindex msim
10826Use simulator runtime
10827
10828@item -mno-crt0
10829@opindex mno-crt0
10830Do not link in the C run-time initialization object file
57b51d4d 10831@file{crti.o}. Other run-time initialization and termination files
c85ba4fb
AH
10832such as @file{startup.o} and @file{exit.o} are still included on the
10833linker command line.
10834
10835@end table
10836
39bc1876
NS
10837@node PDP-11 Options
10838@subsection PDP-11 Options
10839@cindex PDP-11 Options
f84271d9 10840
39bc1876 10841These options are defined for the PDP-11:
f84271d9 10842
2642624b 10843@table @gcctabopt
39bc1876
NS
10844@item -mfpu
10845@opindex mfpu
10846Use hardware FPP floating point. This is the default. (FIS floating
10847point on the PDP-11/40 is not supported.)
f84271d9 10848
39bc1876
NS
10849@item -msoft-float
10850@opindex msoft-float
10851Do not use hardware floating point.
f84271d9 10852
39bc1876
NS
10853@item -mac0
10854@opindex mac0
10855Return floating-point results in ac0 (fr0 in Unix assembler syntax).
f84271d9 10856
39bc1876
NS
10857@item -mno-ac0
10858@opindex mno-ac0
10859Return floating-point results in memory. This is the default.
10860
10861@item -m40
10862@opindex m40
10863Generate code for a PDP-11/40.
10864
10865@item -m45
10866@opindex m45
10867Generate code for a PDP-11/45. This is the default.
f84271d9 10868
39bc1876
NS
10869@item -m10
10870@opindex m10
10871Generate code for a PDP-11/10.
f84271d9 10872
39bc1876
NS
10873@item -mbcopy-builtin
10874@opindex bcopy-builtin
70128ad9 10875Use inline @code{movmemhi} patterns for copying memory. This is the
39bc1876 10876default.
f84271d9 10877
39bc1876
NS
10878@item -mbcopy
10879@opindex mbcopy
70128ad9 10880Do not use inline @code{movmemhi} patterns for copying memory.
02f52e19 10881
39bc1876
NS
10882@item -mint16
10883@itemx -mno-int32
10884@opindex mint16
10885@opindex mno-int32
10886Use 16-bit @code{int}. This is the default.
48f0be1b 10887
39bc1876
NS
10888@item -mint32
10889@itemx -mno-int16
10890@opindex mint32
10891@opindex mno-int16
10892Use 32-bit @code{int}.
b4378319 10893
39bc1876
NS
10894@item -mfloat64
10895@itemx -mno-float32
10896@opindex mfloat64
10897@opindex mno-float32
10898Use 64-bit @code{float}. This is the default.
b4378319 10899
39bc1876
NS
10900@item -mfloat32
10901@itemx -mno-float64
10902@opindex mfloat32
10903@opindex mno-float64
10904Use 32-bit @code{float}.
daf2f129 10905
39bc1876
NS
10906@item -mabshi
10907@opindex mabshi
10908Use @code{abshi2} pattern. This is the default.
232830b7 10909
39bc1876
NS
10910@item -mno-abshi
10911@opindex mno-abshi
10912Do not use @code{abshi2} pattern.
b4378319 10913
39bc1876
NS
10914@item -mbranch-expensive
10915@opindex mbranch-expensive
10916Pretend that branches are expensive. This is for experimenting with
10917code generation only.
b4378319 10918
39bc1876
NS
10919@item -mbranch-cheap
10920@opindex mbranch-cheap
10921Do not pretend that branches are expensive. This is the default.
b4378319 10922
39bc1876
NS
10923@item -msplit
10924@opindex msplit
8a36672b 10925Generate code for a system with split I&D@.
b4378319 10926
39bc1876
NS
10927@item -mno-split
10928@opindex mno-split
8a36672b 10929Generate code for a system without split I&D@. This is the default.
f84271d9 10930
39bc1876
NS
10931@item -munix-asm
10932@opindex munix-asm
10933Use Unix assembler syntax. This is the default when configured for
10934@samp{pdp11-*-bsd}.
56b2d7a7 10935
39bc1876
NS
10936@item -mdec-asm
10937@opindex mdec-asm
10938Use DEC assembler syntax. This is the default when configured for any
10939PDP-11 target other than @samp{pdp11-*-bsd}.
10940@end table
56b2d7a7 10941
39bc1876
NS
10942@node PowerPC Options
10943@subsection PowerPC Options
10944@cindex PowerPC options
56b2d7a7 10945
39bc1876 10946These are listed under @xref{RS/6000 and PowerPC Options}.
56b2d7a7 10947
39bc1876
NS
10948@node RS/6000 and PowerPC Options
10949@subsection IBM RS/6000 and PowerPC Options
10950@cindex RS/6000 and PowerPC Options
10951@cindex IBM RS/6000 and PowerPC Options
56b2d7a7 10952
39bc1876
NS
10953These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10954@table @gcctabopt
10955@item -mpower
10956@itemx -mno-power
10957@itemx -mpower2
10958@itemx -mno-power2
10959@itemx -mpowerpc
10960@itemx -mno-powerpc
10961@itemx -mpowerpc-gpopt
10962@itemx -mno-powerpc-gpopt
10963@itemx -mpowerpc-gfxopt
10964@itemx -mno-powerpc-gfxopt
10965@itemx -mpowerpc64
10966@itemx -mno-powerpc64
9719f3b7
DE
10967@itemx -mmfcrf
10968@itemx -mno-mfcrf
10969@itemx -mpopcntb
10970@itemx -mno-popcntb
10971@itemx -mfprnd
10972@itemx -mno-fprnd
39bc1876
NS
10973@opindex mpower
10974@opindex mno-power
10975@opindex mpower2
10976@opindex mno-power2
10977@opindex mpowerpc
10978@opindex mno-powerpc
10979@opindex mpowerpc-gpopt
10980@opindex mno-powerpc-gpopt
10981@opindex mpowerpc-gfxopt
10982@opindex mno-powerpc-gfxopt
10983@opindex mpowerpc64
10984@opindex mno-powerpc64
9719f3b7
DE
10985@opindex mmfcrf
10986@opindex mno-mfcrf
10987@opindex mpopcntb
10988@opindex mno-popcntb
10989@opindex mfprnd
10990@opindex mno-fprnd
39bc1876
NS
10991GCC supports two related instruction set architectures for the
10992RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
10993instructions supported by the @samp{rios} chip set used in the original
10994RS/6000 systems and the @dfn{PowerPC} instruction set is the
9719f3b7
DE
10995architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10996the IBM 4xx, 6xx, and follow-on microprocessors.
56b2d7a7 10997
39bc1876
NS
10998Neither architecture is a subset of the other. However there is a
10999large common subset of instructions supported by both. An MQ
11000register is included in processors supporting the POWER architecture.
56b2d7a7 11001
39bc1876
NS
11002You use these options to specify which instructions are available on the
11003processor you are using. The default value of these options is
11004determined when configuring GCC@. Specifying the
11005@option{-mcpu=@var{cpu_type}} overrides the specification of these
11006options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
11007rather than the options listed above.
56b2d7a7 11008
39bc1876
NS
11009The @option{-mpower} option allows GCC to generate instructions that
11010are found only in the POWER architecture and to use the MQ register.
11011Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11012to generate instructions that are present in the POWER2 architecture but
11013not the original POWER architecture.
83575957 11014
39bc1876
NS
11015The @option{-mpowerpc} option allows GCC to generate instructions that
11016are found only in the 32-bit subset of the PowerPC architecture.
11017Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11018GCC to use the optional PowerPC architecture instructions in the
11019General Purpose group, including floating-point square root. Specifying
11020@option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11021use the optional PowerPC architecture instructions in the Graphics
11022group, including floating-point select.
83575957 11023
9719f3b7
DE
11024The @option{-mmfcrf} option allows GCC to generate the move from
11025condition register field instruction implemented on the POWER4
11026processor and other processors that support the PowerPC V2.01
11027architecture.
11028The @option{-mpopcntb} option allows GCC to generate the popcount and
11029double precision FP reciprocal estimate instruction implemented on the
11030POWER5 processor and other processors that support the PowerPC V2.02
11031architecture.
11032The @option{-mfprnd} option allows GCC to generate the FP round to
11033integer instructions implemented on the POWER5+ processor and other
11034processors that support the PowerPC V2.03 architecture.
11035
39bc1876
NS
11036The @option{-mpowerpc64} option allows GCC to generate the additional
1103764-bit instructions that are found in the full PowerPC64 architecture
11038and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
11039@option{-mno-powerpc64}.
83575957 11040
39bc1876
NS
11041If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11042will use only the instructions in the common subset of both
11043architectures plus some special AIX common-mode calls, and will not use
11044the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
11045permits GCC to use any instruction from either architecture and to
11046allow use of the MQ register; specify this for the Motorola MPC601.
83575957 11047
39bc1876
NS
11048@item -mnew-mnemonics
11049@itemx -mold-mnemonics
11050@opindex mnew-mnemonics
11051@opindex mold-mnemonics
11052Select which mnemonics to use in the generated assembler code. With
11053@option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11054the PowerPC architecture. With @option{-mold-mnemonics} it uses the
11055assembler mnemonics defined for the POWER architecture. Instructions
11056defined in only one architecture have only one mnemonic; GCC uses that
11057mnemonic irrespective of which of these options is specified.
83575957 11058
39bc1876
NS
11059GCC defaults to the mnemonics appropriate for the architecture in
11060use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11061value of these option. Unless you are building a cross-compiler, you
11062should normally not specify either @option{-mnew-mnemonics} or
11063@option{-mold-mnemonics}, but should instead accept the default.
83575957 11064
39bc1876
NS
11065@item -mcpu=@var{cpu_type}
11066@opindex mcpu
11067Set architecture type, register usage, choice of mnemonics, and
11068instruction scheduling parameters for machine type @var{cpu_type}.
11069Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11070@samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11071@samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11072@samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11073@samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
9719f3b7 11074@samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
39bc1876 11075@samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
9719f3b7
DE
11076@samp{power4}, @samp{power5}, @samp{power5+},
11077@samp{common}, @samp{powerpc}, @samp{powerpc64},
98c41d98 11078@samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
83575957 11079
39bc1876
NS
11080@option{-mcpu=common} selects a completely generic processor. Code
11081generated under this option will run on any POWER or PowerPC processor.
11082GCC will use only the instructions in the common subset of both
11083architectures, and will not use the MQ register. GCC assumes a generic
11084processor model for scheduling purposes.
83575957 11085
39bc1876
NS
11086@option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11087@option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11088PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11089types, with an appropriate, generic processor model assumed for
11090scheduling purposes.
83575957 11091
39bc1876
NS
11092The other options specify a specific processor. Code generated under
11093those options will run best on that processor, and may not run at all on
11094others.
83575957 11095
39bc1876 11096The @option{-mcpu} options automatically enable or disable the
9719f3b7
DE
11097following options: @option{-maltivec}, @option{-mfprnd},
11098@option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11099@option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11100@option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
131aeb82
JM
11101@option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}.
11102The particular options
9719f3b7
DE
11103set for any particular CPU will vary between compiler versions,
11104depending on what setting seems to produce optimal code for that CPU;
11105it doesn't necessarily reflect the actual hardware's capabilities. If
11106you wish to set an individual option to a particular value, you may
11107specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11108-mno-altivec}.
5d7c2819 11109
39bc1876 11110On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
9719f3b7 11111not enabled or disabled by the @option{-mcpu} option at present because
39bc1876
NS
11112AIX does not have full support for these options. You may still
11113enable or disable them individually if you're sure it'll work in your
11114environment.
83575957 11115
39bc1876
NS
11116@item -mtune=@var{cpu_type}
11117@opindex mtune
11118Set the instruction scheduling parameters for machine type
11119@var{cpu_type}, but do not set the architecture type, register usage, or
11120choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
11121values for @var{cpu_type} are used for @option{-mtune} as for
11122@option{-mcpu}. If both are specified, the code generated will use the
11123architecture, registers, and mnemonics set by @option{-mcpu}, but the
11124scheduling parameters set by @option{-mtune}.
83575957 11125
ef765ea9
DE
11126@item -mswdiv
11127@itemx -mno-swdiv
11128@opindex mswdiv
11129@opindex mno-swdiv
11130Generate code to compute division as reciprocal estimate and iterative
11131refinement, creating opportunities for increased throughput. This
11132feature requires: optional PowerPC Graphics instruction set for single
11133precision and FRE instruction for double precision, assuming divides
11134cannot generate user-visible traps, and the domain values not include
11135Infinities, denormals or zero denominator.
11136
39bc1876
NS
11137@item -maltivec
11138@itemx -mno-altivec
11139@opindex maltivec
11140@opindex mno-altivec
7088c6e4
GK
11141Generate code that uses (does not use) AltiVec instructions, and also
11142enable the use of built-in functions that allow more direct access to
11143the AltiVec instruction set. You may also need to set
39bc1876
NS
11144@option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11145enhancements.
83575957 11146
78f5898b
AH
11147@item -mvrsave
11148@item -mno-vrsave
11149@opindex mvrsave
11150@opindex mno-vrsave
11151Generate VRSAVE instructions when generating AltiVec code.
11152
7f970b70
AM
11153@item -msecure-plt
11154@opindex msecure-plt
11155Generate code that allows ld and ld.so to build executables and shared
11156libraries with non-exec .plt and .got sections. This is a PowerPC
1115732-bit SYSV ABI option.
11158
11159@item -mbss-plt
11160@opindex mbss-plt
11161Generate code that uses a BSS .plt section that ld.so fills in, and
11162requires .plt and .got sections that are both writable and executable.
11163This is a PowerPC 32-bit SYSV ABI option.
11164
78f5898b
AH
11165@item -misel
11166@itemx -mno-isel
39bc1876 11167@opindex misel
78f5898b 11168@opindex mno-isel
39bc1876 11169This switch enables or disables the generation of ISEL instructions.
83575957 11170
78f5898b
AH
11171@item -misel=@var{yes/no}
11172This switch has been deprecated. Use @option{-misel} and
11173@option{-mno-isel} instead.
11174
11175@item -mspe
11176@itemx -mno-isel
39bc1876 11177@opindex mspe
78f5898b 11178@opindex mno-spe
39bc1876
NS
11179This switch enables or disables the generation of SPE simd
11180instructions.
83575957 11181
78f5898b
AH
11182@item -mspe=@var{yes/no}
11183This option has been deprecated. Use @option{-mspe} and
11184@option{-mno-spe} instead.
11185
4d4cbc0e 11186@item -mfloat-gprs=@var{yes/single/double/no}
39bc1876
NS
11187@itemx -mfloat-gprs
11188@opindex mfloat-gprs
11189This switch enables or disables the generation of floating point
11190operations on the general purpose registers for architectures that
4d4cbc0e
AH
11191support it.
11192
11193The argument @var{yes} or @var{single} enables the use of
11194single-precision floating point operations.
11195
11196The argument @var{double} enables the use of single and
11197double-precision floating point operations.
11198
11199The argument @var{no} disables floating point operations on the
11200general purpose registers.
11201
11202This option is currently only available on the MPC854x.
83575957 11203
49bd1d27
SS
11204@item -m32
11205@itemx -m64
11206@opindex m32
11207@opindex m64
11208Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11209targets (including GNU/Linux). The 32-bit environment sets int, long
11210and pointer to 32 bits and generates code that runs on any PowerPC
11211variant. The 64-bit environment sets int to 32 bits and long and
11212pointer to 64 bits, and generates code for PowerPC64, as for
11213@option{-mpowerpc64}.
11214
39bc1876
NS
11215@item -mfull-toc
11216@itemx -mno-fp-in-toc
11217@itemx -mno-sum-in-toc
11218@itemx -mminimal-toc
11219@opindex mfull-toc
11220@opindex mno-fp-in-toc
11221@opindex mno-sum-in-toc
11222@opindex mminimal-toc
11223Modify generation of the TOC (Table Of Contents), which is created for
11224every executable file. The @option{-mfull-toc} option is selected by
11225default. In that case, GCC will allocate at least one TOC entry for
11226each unique non-automatic variable reference in your program. GCC
11227will also place floating-point constants in the TOC@. However, only
1122816,384 entries are available in the TOC@.
83575957 11229
39bc1876
NS
11230If you receive a linker error message that saying you have overflowed
11231the available TOC space, you can reduce the amount of TOC space used
11232with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11233@option{-mno-fp-in-toc} prevents GCC from putting floating-point
11234constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11235generate code to calculate the sum of an address and a constant at
11236run-time instead of putting that sum into the TOC@. You may specify one
11237or both of these options. Each causes GCC to produce very slightly
11238slower and larger code at the expense of conserving TOC space.
83575957 11239
39bc1876
NS
11240If you still run out of space in the TOC even when you specify both of
11241these options, specify @option{-mminimal-toc} instead. This option causes
11242GCC to make only one TOC entry for every file. When you specify this
11243option, GCC will produce code that is slower and larger but which
11244uses extremely little TOC space. You may wish to use this option
11245only on files that contain less frequently executed code.
83575957 11246
39bc1876
NS
11247@item -maix64
11248@itemx -maix32
11249@opindex maix64
11250@opindex maix32
11251Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11252@code{long} type, and the infrastructure needed to support them.
11253Specifying @option{-maix64} implies @option{-mpowerpc64} and
11254@option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11255implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
83575957 11256
de17c25f
DE
11257@item -mxl-compat
11258@itemx -mno-xl-compat
11259@opindex mxl-compat
11260@opindex mno-xl-compat
8fbe3bb2
DE
11261Produce code that conforms more closely to IBM XL compiler semantics
11262when using AIX-compatible ABI. Pass floating-point arguments to
11263prototyped functions beyond the register save area (RSA) on the stack
11264in addition to argument FPRs. Do not assume that most significant
11265double in 128-bit long double value is properly rounded when comparing
11266values and converting to double. Use XL symbol names for long double
11267support routines.
de17c25f
DE
11268
11269The AIX calling convention was extended but not initially documented to
39bc1876 11270handle an obscure K&R C case of calling a function that takes the
8fbe3bb2 11271address of its arguments with fewer arguments than declared. IBM XL
39bc1876
NS
11272compilers access floating point arguments which do not fit in the
11273RSA from the stack when a subroutine is compiled without
11274optimization. Because always storing floating-point arguments on the
11275stack is inefficient and rarely needed, this option is not enabled by
8fbe3bb2 11276default and only is necessary when calling subroutines compiled by IBM
39bc1876 11277XL compilers without optimization.
83575957 11278
39bc1876
NS
11279@item -mpe
11280@opindex mpe
11281Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
11282application written to use message passing with special startup code to
11283enable the application to run. The system must have PE installed in the
11284standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11285must be overridden with the @option{-specs=} option to specify the
11286appropriate directory location. The Parallel Environment does not
11287support threads, so the @option{-mpe} option and the @option{-pthread}
11288option are incompatible.
83575957 11289
39bc1876
NS
11290@item -malign-natural
11291@itemx -malign-power
11292@opindex malign-natural
11293@opindex malign-power
d9168963 11294On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
39bc1876
NS
11295@option{-malign-natural} overrides the ABI-defined alignment of larger
11296types, such as floating-point doubles, on their natural size-based boundary.
11297The option @option{-malign-power} instructs GCC to follow the ABI-specified
8a36672b 11298alignment rules. GCC defaults to the standard alignment defined in the ABI@.
83575957 11299
d9168963
SS
11300On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11301is not supported.
11302
39bc1876
NS
11303@item -msoft-float
11304@itemx -mhard-float
11305@opindex msoft-float
11306@opindex mhard-float
11307Generate code that does not use (uses) the floating-point register set.
11308Software floating point emulation is provided if you use the
11309@option{-msoft-float} option, and pass the option to GCC when linking.
83575957 11310
39bc1876
NS
11311@item -mmultiple
11312@itemx -mno-multiple
11313@opindex mmultiple
11314@opindex mno-multiple
11315Generate code that uses (does not use) the load multiple word
11316instructions and the store multiple word instructions. These
11317instructions are generated by default on POWER systems, and not
11318generated on PowerPC systems. Do not use @option{-mmultiple} on little
11319endian PowerPC systems, since those instructions do not work when the
11320processor is in little endian mode. The exceptions are PPC740 and
11321PPC750 which permit the instructions usage in little endian mode.
83575957 11322
39bc1876
NS
11323@item -mstring
11324@itemx -mno-string
11325@opindex mstring
11326@opindex mno-string
11327Generate code that uses (does not use) the load string instructions
11328and the store string word instructions to save multiple registers and
11329do small block moves. These instructions are generated by default on
11330POWER systems, and not generated on PowerPC systems. Do not use
11331@option{-mstring} on little endian PowerPC systems, since those
11332instructions do not work when the processor is in little endian mode.
11333The exceptions are PPC740 and PPC750 which permit the instructions
11334usage in little endian mode.
052a4b28 11335
39bc1876
NS
11336@item -mupdate
11337@itemx -mno-update
11338@opindex mupdate
11339@opindex mno-update
11340Generate code that uses (does not use) the load or store instructions
11341that update the base register to the address of the calculated memory
11342location. These instructions are generated by default. If you use
11343@option{-mno-update}, there is a small window between the time that the
11344stack pointer is updated and the address of the previous frame is
11345stored, which means code that walks the stack frame across interrupts or
11346signals may get corrupted data.
052a4b28 11347
39bc1876
NS
11348@item -mfused-madd
11349@itemx -mno-fused-madd
11350@opindex mfused-madd
11351@opindex mno-fused-madd
11352Generate code that uses (does not use) the floating point multiply and
11353accumulate instructions. These instructions are generated by default if
11354hardware floating is used.
3a69a7d5 11355
131aeb82
JM
11356@item -mmulhw
11357@itemx -mno-mulhw
11358@opindex mmulhw
11359@opindex mno-mulhw
11360Generate code that uses (does not use) the half-word multiply and
11361multiply-accumulate instructions on the IBM 405 and 440 processors.
11362These instructions are generated by default when targetting those
11363processors.
11364
39bc1876
NS
11365@item -mno-bit-align
11366@itemx -mbit-align
11367@opindex mno-bit-align
11368@opindex mbit-align
11369On System V.4 and embedded PowerPC systems do not (do) force structures
11370and unions that contain bit-fields to be aligned to the base type of the
11371bit-field.
3a69a7d5 11372
39bc1876
NS
11373For example, by default a structure containing nothing but 8
11374@code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11375boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
11376the structure would be aligned to a 1 byte boundary and be one byte in
11377size.
3a69a7d5 11378
39bc1876
NS
11379@item -mno-strict-align
11380@itemx -mstrict-align
11381@opindex mno-strict-align
11382@opindex mstrict-align
11383On System V.4 and embedded PowerPC systems do not (do) assume that
11384unaligned memory references will be handled by the system.
3a69a7d5 11385
39bc1876
NS
11386@item -mrelocatable
11387@itemx -mno-relocatable
11388@opindex mrelocatable
11389@opindex mno-relocatable
11390On embedded PowerPC systems generate code that allows (does not allow)
11391the program to be relocated to a different address at runtime. If you
11392use @option{-mrelocatable} on any module, all objects linked together must
11393be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
3a69a7d5 11394
39bc1876
NS
11395@item -mrelocatable-lib
11396@itemx -mno-relocatable-lib
11397@opindex mrelocatable-lib
11398@opindex mno-relocatable-lib
11399On embedded PowerPC systems generate code that allows (does not allow)
11400the program to be relocated to a different address at runtime. Modules
11401compiled with @option{-mrelocatable-lib} can be linked with either modules
11402compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11403with modules compiled with the @option{-mrelocatable} options.
052a4b28 11404
39bc1876
NS
11405@item -mno-toc
11406@itemx -mtoc
11407@opindex mno-toc
11408@opindex mtoc
11409On System V.4 and embedded PowerPC systems do not (do) assume that
11410register 2 contains a pointer to a global area pointing to the addresses
11411used in the program.
052a4b28 11412
39bc1876
NS
11413@item -mlittle
11414@itemx -mlittle-endian
11415@opindex mlittle
11416@opindex mlittle-endian
11417On System V.4 and embedded PowerPC systems compile code for the
11418processor in little endian mode. The @option{-mlittle-endian} option is
11419the same as @option{-mlittle}.
052a4b28 11420
39bc1876
NS
11421@item -mbig
11422@itemx -mbig-endian
11423@opindex mbig
11424@opindex mbig-endian
11425On System V.4 and embedded PowerPC systems compile code for the
11426processor in big endian mode. The @option{-mbig-endian} option is
11427the same as @option{-mbig}.
052a4b28 11428
39bc1876
NS
11429@item -mdynamic-no-pic
11430@opindex mdynamic-no-pic
11431On Darwin and Mac OS X systems, compile code so that it is not
11432relocatable, but that its external references are relocatable. The
11433resulting code is suitable for applications, but not shared
11434libraries.
3a69a7d5 11435
39bc1876
NS
11436@item -mprioritize-restricted-insns=@var{priority}
11437@opindex mprioritize-restricted-insns
11438This option controls the priority that is assigned to
11439dispatch-slot restricted instructions during the second scheduling
11440pass. The argument @var{priority} takes the value @var{0/1/2} to assign
11441@var{no/highest/second-highest} priority to dispatch slot restricted
11442instructions.
3a69a7d5 11443
39bc1876
NS
11444@item -msched-costly-dep=@var{dependence_type}
11445@opindex msched-costly-dep
11446This option controls which dependences are considered costly
11447by the target during instruction scheduling. The argument
11448@var{dependence_type} takes one of the following values:
11449@var{no}: no dependence is costly,
11450@var{all}: all dependences are costly,
11451@var{true_store_to_load}: a true dependence from store to load is costly,
11452@var{store_to_load}: any dependence from store to load is costly,
11453@var{number}: any dependence which latency >= @var{number} is costly.
11338cda 11454
39bc1876
NS
11455@item -minsert-sched-nops=@var{scheme}
11456@opindex minsert-sched-nops
11457This option controls which nop insertion scheme will be used during
8a36672b 11458the second scheduling pass. The argument @var{scheme} takes one of the
39bc1876
NS
11459following values:
11460@var{no}: Don't insert nops.
11461@var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11462according to the scheduler's grouping.
11463@var{regroup_exact}: Insert nops to force costly dependent insns into
11464separate groups. Insert exactly as many nops as needed to force an insn
11465to a new group, according to the estimated processor grouping.
11466@var{number}: Insert nops to force costly dependent insns into
11467separate groups. Insert @var{number} nops to force an insn to a new group.
052a4b28 11468
39bc1876
NS
11469@item -mcall-sysv
11470@opindex mcall-sysv
11471On System V.4 and embedded PowerPC systems compile code using calling
11472conventions that adheres to the March 1995 draft of the System V
11473Application Binary Interface, PowerPC processor supplement. This is the
11474default unless you configured GCC using @samp{powerpc-*-eabiaix}.
789a3090 11475
39bc1876
NS
11476@item -mcall-sysv-eabi
11477@opindex mcall-sysv-eabi
11478Specify both @option{-mcall-sysv} and @option{-meabi} options.
789a3090 11479
39bc1876
NS
11480@item -mcall-sysv-noeabi
11481@opindex mcall-sysv-noeabi
11482Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
789a3090 11483
39bc1876
NS
11484@item -mcall-solaris
11485@opindex mcall-solaris
11486On System V.4 and embedded PowerPC systems compile code for the Solaris
11487operating system.
789a3090 11488
39bc1876
NS
11489@item -mcall-linux
11490@opindex mcall-linux
11491On System V.4 and embedded PowerPC systems compile code for the
11492Linux-based GNU system.
789a3090 11493
39bc1876
NS
11494@item -mcall-gnu
11495@opindex mcall-gnu
11496On System V.4 and embedded PowerPC systems compile code for the
11497Hurd-based GNU system.
789a3090 11498
39bc1876
NS
11499@item -mcall-netbsd
11500@opindex mcall-netbsd
11501On System V.4 and embedded PowerPC systems compile code for the
11502NetBSD operating system.
789a3090 11503
39bc1876
NS
11504@item -maix-struct-return
11505@opindex maix-struct-return
11506Return all structures in memory (as specified by the AIX ABI)@.
789a3090 11507
39bc1876
NS
11508@item -msvr4-struct-return
11509@opindex msvr4-struct-return
11510Return structures smaller than 8 bytes in registers (as specified by the
11511SVR4 ABI)@.
789a3090 11512
78f5898b
AH
11513@item -mabi=@var{abi-type}
11514@opindex mabi
11515Extend the current ABI with a particular extension, or remove such extension.
11516Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
602ea4d3
JJ
11517@var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11518
11519@item -mabi=spe
11520@opindex mabi=spe
11521Extend the current ABI with SPE ABI extensions. This does not change
11522the default ABI, instead it adds the SPE ABI extensions to the current
11523ABI@.
11524
11525@item -mabi=no-spe
11526@opindex mabi=no-spe
11527Disable Booke SPE ABI extensions for the current ABI@.
11528
11529@item -mabi=ibmlongdouble
11530@opindex mabi=ibmlongdouble
11531Change the current ABI to use IBM extended precision long double.
11532This is a PowerPC 32-bit SYSV ABI option.
11533
11534@item -mabi=ieeelongdouble
11535@opindex mabi=ieeelongdouble
11536Change the current ABI to use IEEE extended precision long double.
11537This is a PowerPC 32-bit Linux ABI option.
789a3090 11538
39bc1876
NS
11539@item -mprototype
11540@itemx -mno-prototype
11541@opindex mprototype
11542@opindex mno-prototype
11543On System V.4 and embedded PowerPC systems assume that all calls to
11544variable argument functions are properly prototyped. Otherwise, the
11545compiler must insert an instruction before every non prototyped call to
11546set or clear bit 6 of the condition code register (@var{CR}) to
11547indicate whether floating point values were passed in the floating point
11548registers in case the function takes a variable arguments. With
11549@option{-mprototype}, only calls to prototyped variable argument functions
11550will set or clear the bit.
83575957 11551
39bc1876
NS
11552@item -msim
11553@opindex msim
11554On embedded PowerPC systems, assume that the startup module is called
11555@file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11556@file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
11557configurations.
df6194d4 11558
39bc1876
NS
11559@item -mmvme
11560@opindex mmvme
11561On embedded PowerPC systems, assume that the startup module is called
11562@file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11563@file{libc.a}.
df6194d4 11564
39bc1876
NS
11565@item -mads
11566@opindex mads
11567On embedded PowerPC systems, assume that the startup module is called
11568@file{crt0.o} and the standard C libraries are @file{libads.a} and
11569@file{libc.a}.
df6194d4 11570
39bc1876
NS
11571@item -myellowknife
11572@opindex myellowknife
11573On embedded PowerPC systems, assume that the startup module is called
11574@file{crt0.o} and the standard C libraries are @file{libyk.a} and
11575@file{libc.a}.
df6194d4 11576
39bc1876
NS
11577@item -mvxworks
11578@opindex mvxworks
11579On System V.4 and embedded PowerPC systems, specify that you are
11580compiling for a VxWorks system.
df6194d4 11581
39bc1876
NS
11582@item -mwindiss
11583@opindex mwindiss
11584Specify that you are compiling for the WindISS simulation environment.
df6194d4 11585
39bc1876
NS
11586@item -memb
11587@opindex memb
11588On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11589header to indicate that @samp{eabi} extended relocations are used.
df6194d4 11590
39bc1876
NS
11591@item -meabi
11592@itemx -mno-eabi
11593@opindex meabi
11594@opindex mno-eabi
11595On System V.4 and embedded PowerPC systems do (do not) adhere to the
11596Embedded Applications Binary Interface (eabi) which is a set of
11597modifications to the System V.4 specifications. Selecting @option{-meabi}
11598means that the stack is aligned to an 8 byte boundary, a function
11599@code{__eabi} is called to from @code{main} to set up the eabi
11600environment, and the @option{-msdata} option can use both @code{r2} and
11601@code{r13} to point to two separate small data areas. Selecting
11602@option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11603do not call an initialization function from @code{main}, and the
11604@option{-msdata} option will only use @code{r13} to point to a single
11605small data area. The @option{-meabi} option is on by default if you
11606configured GCC using one of the @samp{powerpc*-*-eabi*} options.
df6194d4 11607
39bc1876
NS
11608@item -msdata=eabi
11609@opindex msdata=eabi
11610On System V.4 and embedded PowerPC systems, put small initialized
11611@code{const} global and static data in the @samp{.sdata2} section, which
11612is pointed to by register @code{r2}. Put small initialized
11613non-@code{const} global and static data in the @samp{.sdata} section,
11614which is pointed to by register @code{r13}. Put small uninitialized
11615global and static data in the @samp{.sbss} section, which is adjacent to
11616the @samp{.sdata} section. The @option{-msdata=eabi} option is
11617incompatible with the @option{-mrelocatable} option. The
11618@option{-msdata=eabi} option also sets the @option{-memb} option.
df6194d4 11619
39bc1876
NS
11620@item -msdata=sysv
11621@opindex msdata=sysv
11622On System V.4 and embedded PowerPC systems, put small global and static
11623data in the @samp{.sdata} section, which is pointed to by register
11624@code{r13}. Put small uninitialized global and static data in the
11625@samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11626The @option{-msdata=sysv} option is incompatible with the
11627@option{-mrelocatable} option.
df6194d4 11628
39bc1876 11629@item -msdata=default
df6194d4 11630@itemx -msdata
39bc1876 11631@opindex msdata=default
cd3bb277 11632@opindex msdata
39bc1876
NS
11633On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11634compile code the same as @option{-msdata=eabi}, otherwise compile code the
11635same as @option{-msdata=sysv}.
df6194d4 11636
39bc1876
NS
11637@item -msdata-data
11638@opindex msdata-data
05f25017
AM
11639On System V.4 and embedded PowerPC systems, put small global
11640data in the @samp{.sdata} section. Put small uninitialized global
11641data in the @samp{.sbss} section. Do not use register @code{r13}
39bc1876
NS
11642to address small data however. This is the default behavior unless
11643other @option{-msdata} options are used.
df6194d4 11644
39bc1876
NS
11645@item -msdata=none
11646@itemx -mno-sdata
11647@opindex msdata=none
11648@opindex mno-sdata
11649On embedded PowerPC systems, put all initialized global and static data
11650in the @samp{.data} section, and all uninitialized data in the
11651@samp{.bss} section.
df6194d4 11652
39bc1876
NS
11653@item -G @var{num}
11654@opindex G
11655@cindex smaller data references (PowerPC)
11656@cindex .sdata/.sdata2 references (PowerPC)
11657On embedded PowerPC systems, put global and static items less than or
11658equal to @var{num} bytes into the small data or bss sections instead of
11659the normal data or bss section. By default, @var{num} is 8. The
11660@option{-G @var{num}} switch is also passed to the linker.
11661All modules should be compiled with the same @option{-G @var{num}} value.
dcffbade 11662
39bc1876
NS
11663@item -mregnames
11664@itemx -mno-regnames
11665@opindex mregnames
11666@opindex mno-regnames
11667On System V.4 and embedded PowerPC systems do (do not) emit register
11668names in the assembly language output using symbolic forms.
dcffbade 11669
39bc1876
NS
11670@item -mlongcall
11671@itemx -mno-longcall
11672@opindex mlongcall
11673@opindex mno-longcall
11674Default to making all function calls indirectly, using a register, so
11675that functions which reside further than 32 megabytes (33,554,432
11676bytes) from the current location can be called. This setting can be
11677overridden by the @code{shortcall} function attribute, or by
11678@code{#pragma longcall(0)}.
dcffbade 11679
39bc1876
NS
11680Some linkers are capable of detecting out-of-range calls and generating
11681glue code on the fly. On these systems, long calls are unnecessary and
11682generate slower code. As of this writing, the AIX linker can do this,
11683as can the GNU linker for PowerPC/64. It is planned to add this feature
11684to the GNU linker for 32-bit PowerPC systems as well.
df6194d4 11685
39bc1876
NS
11686On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11687callee, L42'', plus a ``branch island'' (glue code). The two target
d78aa55c 11688addresses represent the callee and the ``branch island''. The
39bc1876
NS
11689Darwin/PPC linker will prefer the first address and generate a ``bl
11690callee'' if the PPC ``bl'' instruction will reach the callee directly;
11691otherwise, the linker will generate ``bl L42'' to call the ``branch
d78aa55c 11692island''. The ``branch island'' is appended to the body of the
39bc1876
NS
11693calling function; it computes the full 32-bit address of the callee
11694and jumps to it.
df6194d4 11695
39bc1876
NS
11696On Mach-O (Darwin) systems, this option directs the compiler emit to
11697the glue for every direct call, and the Darwin linker decides whether
11698to use or discard it.
11699
11700In the future, we may cause GCC to ignore all longcall specifications
11701when the linker is known to generate glue.
11702
11703@item -pthread
11704@opindex pthread
11705Adds support for multithreading with the @dfn{pthreads} library.
11706This option sets flags for both the preprocessor and linker.
30028c85 11707
df6194d4
JW
11708@end table
11709
91abf72d
HP
11710@node S/390 and zSeries Options
11711@subsection S/390 and zSeries Options
11712@cindex S/390 and zSeries Options
11713
11714These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11715
11716@table @gcctabopt
11717@item -mhard-float
11718@itemx -msoft-float
11719@opindex mhard-float
11720@opindex msoft-float
11721Use (do not use) the hardware floating-point instructions and registers
11722for floating-point operations. When @option{-msoft-float} is specified,
11723functions in @file{libgcc.a} will be used to perform floating-point
11724operations. When @option{-mhard-float} is specified, the compiler
11725generates IEEE floating-point instructions. This is the default.
11726
f61a2c7d
AK
11727@item -mlong-double-64
11728@itemx -mlong-double-128
11729@opindex mlong-double-64
11730@opindex mlong-double-128
11731These switches control the size of @code{long double} type. A size
11732of 64bit makes the @code{long double} type equivalent to the @code{double}
11733type. This is the default.
11734
91abf72d
HP
11735@item -mbackchain
11736@itemx -mno-backchain
11737@opindex mbackchain
11738@opindex mno-backchain
b3d31392
AK
11739Store (do not store) the address of the caller's frame as backchain pointer
11740into the callee's stack frame.
adf39f8f
AK
11741A backchain may be needed to allow debugging using tools that do not understand
11742DWARF-2 call frame information.
b3d31392
AK
11743When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11744at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11745the backchain is placed into the topmost word of the 96/160 byte register
11746save area.
11747
11748In general, code compiled with @option{-mbackchain} is call-compatible with
11749code compiled with @option{-mmo-backchain}; however, use of the backchain
11750for debugging purposes usually requires that the whole binary is built with
6b78f6be
AK
11751@option{-mbackchain}. Note that the combination of @option{-mbackchain},
11752@option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11753to build a linux kernel use @option{-msoft-float}.
b3d31392
AK
11754
11755The default is to not maintain the backchain.
11756
11757@item -mpacked-stack
11758@item -mno-packed-stack
11759@opindex mpacked-stack
11760@opindex mno-packed-stack
11761Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
11762specified, the compiler uses the all fields of the 96/160 byte register save
11763area only for their default purpose; unused fields still take up stack space.
11764When @option{-mpacked-stack} is specified, register save slots are densely
11765packed at the top of the register save area; unused space is reused for other
11766purposes, allowing for more efficient use of the available stack space.
11767However, when @option{-mbackchain} is also in effect, the topmost word of
11768the save area is always used to store the backchain, and the return address
11769register is always saved two words below the backchain.
11770
f2fd3821 11771As long as the stack frame backchain is not used, code generated with
b3d31392
AK
11772@option{-mpacked-stack} is call-compatible with code generated with
11773@option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
11774S/390 or zSeries generated code that uses the stack frame backchain at run
11775time, not just for debugging purposes. Such code is not call-compatible
11776with code compiled with @option{-mpacked-stack}. Also, note that the
6b78f6be
AK
11777combination of @option{-mbackchain},
11778@option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11779to build a linux kernel use @option{-msoft-float}.
b3d31392
AK
11780
11781The default is to not use the packed stack layout.
91abf72d
HP
11782
11783@item -msmall-exec
11784@itemx -mno-small-exec
11785@opindex msmall-exec
11786@opindex mno-small-exec
f282ffb3
JM
11787Generate (or do not generate) code using the @code{bras} instruction
11788to do subroutine calls.
91abf72d
HP
11789This only works reliably if the total executable size does not
11790exceed 64k. The default is to use the @code{basr} instruction instead,
11791which does not have this limitation.
11792
11793@item -m64
11794@itemx -m31
11795@opindex m64
11796@opindex m31
11797When @option{-m31} is specified, generate code compliant to the
95fef11f
JM
11798GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
11799code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
91abf72d 11800particular to generate 64-bit instructions. For the @samp{s390}
f282ffb3 11801targets, the default is @option{-m31}, while the @samp{s390x}
91abf72d
HP
11802targets default to @option{-m64}.
11803
1fec52be
HP
11804@item -mzarch
11805@itemx -mesa
11806@opindex mzarch
11807@opindex mesa
daf2f129
JM
11808When @option{-mzarch} is specified, generate code using the
11809instructions available on z/Architecture.
11810When @option{-mesa} is specified, generate code using the
8a36672b 11811instructions available on ESA/390. Note that @option{-mesa} is
1fec52be 11812not possible with @option{-m64}.
95fef11f 11813When generating code compliant to the GNU/Linux for S/390 ABI,
f13e0d4e 11814the default is @option{-mesa}. When generating code compliant
95fef11f 11815to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
1fec52be 11816
91abf72d
HP
11817@item -mmvcle
11818@itemx -mno-mvcle
11819@opindex mmvcle
11820@opindex mno-mvcle
f282ffb3 11821Generate (or do not generate) code using the @code{mvcle} instruction
3364c33b 11822to perform block moves. When @option{-mno-mvcle} is specified,
8daf098e
AS
11823use a @code{mvc} loop instead. This is the default unless optimizing for
11824size.
91abf72d
HP
11825
11826@item -mdebug
11827@itemx -mno-debug
11828@opindex mdebug
11829@opindex mno-debug
11830Print (or do not print) additional debug information when compiling.
11831The default is to not print debug information.
11832
f13e0d4e 11833@item -march=@var{cpu-type}
1fec52be 11834@opindex march
f13e0d4e 11835Generate code that will run on @var{cpu-type}, which is the name of a system
8a36672b 11836representing a certain processor type. Possible values for
f13e0d4e
UW
11837@var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11838When generating code using the instructions available on z/Architecture,
11839the default is @option{-march=z900}. Otherwise, the default is
11840@option{-march=g5}.
1fec52be 11841
f13e0d4e 11842@item -mtune=@var{cpu-type}
35082351 11843@opindex mtune
1fec52be 11844Tune to @var{cpu-type} everything applicable about the generated code,
f13e0d4e
UW
11845except for the ABI and the set of available instructions.
11846The list of @var{cpu-type} values is the same as for @option{-march}.
11847The default is the value used for @option{-march}.
1fec52be 11848
f26c1794
EC
11849@item -mtpf-trace
11850@itemx -mno-tpf-trace
11851@opindex mtpf-trace
11852@opindex mno-tpf-trace
11853Generate code that adds (does not add) in TPF OS specific branches to trace
11854routines in the operating system. This option is off by default, even
8a36672b 11855when compiling for the TPF OS@.
f26c1794 11856
f2d226e1
AK
11857@item -mfused-madd
11858@itemx -mno-fused-madd
11859@opindex mfused-madd
11860@opindex mno-fused-madd
11861Generate code that uses (does not use) the floating point multiply and
11862accumulate instructions. These instructions are generated by default if
11863hardware floating point is used.
d75f90f1
AK
11864
11865@item -mwarn-framesize=@var{framesize}
11866@opindex mwarn-framesize
11867Emit a warning if the current function exceeds the given frame size. Because
11868this is a compile time check it doesn't need to be a real problem when the program
f0eb93a8
JM
11869runs. It is intended to identify functions which most probably cause
11870a stack overflow. It is useful to be used in an environment with limited stack
431ae0bf 11871size e.g.@: the linux kernel.
d75f90f1
AK
11872
11873@item -mwarn-dynamicstack
11874@opindex mwarn-dynamicstack
11875Emit a warning if the function calls alloca or uses dynamically
11876sized arrays. This is generally a bad idea with a limited stack size.
11877
11878@item -mstack-guard=@var{stack-guard}
11879@item -mstack-size=@var{stack-size}
11880@opindex mstack-guard
11881@opindex mstack-size
11882These arguments always have to be used in conjunction. If they are present the s390
11883back end emits additional instructions in the function prologue which trigger a trap
f0eb93a8
JM
11884if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11885(remember that the stack on s390 grows downward). These options are intended to
11886be used to help debugging stack overflow problems. The additionally emitted code
f695eccf 11887causes only little overhead and hence can also be used in production like systems
f0eb93a8 11888without greater performance degradation. The given values have to be exact
f695eccf
AK
11889powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11890exceeding 64k.
d75f90f1
AK
11891In order to be efficient the extra code makes the assumption that the stack starts
11892at an address aligned to the value given by @var{stack-size}.
91abf72d
HP
11893@end table
11894
39bc1876
NS
11895@node SH Options
11896@subsection SH Options
bcf684c7 11897
39bc1876 11898These @samp{-m} options are defined for the SH implementations:
bcf684c7 11899
5d22c1a5 11900@table @gcctabopt
39bc1876
NS
11901@item -m1
11902@opindex m1
11903Generate code for the SH1.
9f85bca7 11904
39bc1876
NS
11905@item -m2
11906@opindex m2
11907Generate code for the SH2.
9f85bca7 11908
39bc1876
NS
11909@item -m2e
11910Generate code for the SH2e.
9f85bca7 11911
39bc1876
NS
11912@item -m3
11913@opindex m3
11914Generate code for the SH3.
9f85bca7 11915
39bc1876
NS
11916@item -m3e
11917@opindex m3e
11918Generate code for the SH3e.
9f85bca7 11919
39bc1876
NS
11920@item -m4-nofpu
11921@opindex m4-nofpu
11922Generate code for the SH4 without a floating-point unit.
9f85bca7 11923
39bc1876
NS
11924@item -m4-single-only
11925@opindex m4-single-only
11926Generate code for the SH4 with a floating-point unit that only
11927supports single-precision arithmetic.
9f85bca7 11928
39bc1876
NS
11929@item -m4-single
11930@opindex m4-single
11931Generate code for the SH4 assuming the floating-point unit is in
11932single-precision mode by default.
9f85bca7 11933
39bc1876
NS
11934@item -m4
11935@opindex m4
11936Generate code for the SH4.
9f85bca7 11937
312209c6
AO
11938@item -m4a-nofpu
11939@opindex m4a-nofpu
11940Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11941floating-point unit is not used.
11942
11943@item -m4a-single-only
11944@opindex m4a-single-only
11945Generate code for the SH4a, in such a way that no double-precision
11946floating point operations are used.
11947
11948@item -m4a-single
11949@opindex m4a-single
11950Generate code for the SH4a assuming the floating-point unit is in
11951single-precision mode by default.
11952
11953@item -m4a
11954@opindex m4a
11955Generate code for the SH4a.
11956
11957@item -m4al
11958@opindex m4al
11959Same as @option{-m4a-nofpu}, except that it implicitly passes
11960@option{-dsp} to the assembler. GCC doesn't generate any DSP
11961instructions at the moment.
11962
39bc1876
NS
11963@item -mb
11964@opindex mb
11965Compile code for the processor in big endian mode.
9f85bca7 11966
39bc1876
NS
11967@item -ml
11968@opindex ml
11969Compile code for the processor in little endian mode.
9f85bca7 11970
39bc1876
NS
11971@item -mdalign
11972@opindex mdalign
11973Align doubles at 64-bit boundaries. Note that this changes the calling
11974conventions, and thus some functions from the standard C library will
11975not work unless you recompile it first with @option{-mdalign}.
9f85bca7 11976
39bc1876
NS
11977@item -mrelax
11978@opindex mrelax
11979Shorten some address references at link time, when possible; uses the
11980linker option @option{-relax}.
9f85bca7 11981
39bc1876
NS
11982@item -mbigtable
11983@opindex mbigtable
11984Use 32-bit offsets in @code{switch} tables. The default is to use
1198516-bit offsets.
9f85bca7 11986
39bc1876
NS
11987@item -mfmovd
11988@opindex mfmovd
11989Enable the use of the instruction @code{fmovd}.
9f85bca7 11990
39bc1876
NS
11991@item -mhitachi
11992@opindex mhitachi
11993Comply with the calling conventions defined by Renesas.
9f85bca7 11994
2acc29bd
NC
11995@item -mrenesas
11996@opindex mhitachi
11997Comply with the calling conventions defined by Renesas.
11998
11999@item -mno-renesas
12000@opindex mhitachi
12001Comply with the calling conventions defined for GCC before the Renesas
12002conventions were available. This option is the default for all
12003targets of the SH toolchain except for @samp{sh-symbianelf}.
12004
39bc1876
NS
12005@item -mnomacsave
12006@opindex mnomacsave
12007Mark the @code{MAC} register as call-clobbered, even if
12008@option{-mhitachi} is given.
9f85bca7 12009
39bc1876
NS
12010@item -mieee
12011@opindex mieee
12012Increase IEEE-compliance of floating-point code.
73a4d10b
R
12013At the moment, this is equivalent to @option{-fno-finite-math-only}.
12014When generating 16 bit SH opcodes, getting IEEE-conforming results for
12015comparisons of NANs / infinities incurs extra overhead in every
12016floating point comparison, therefore the default is set to
12017@option{-ffinite-math-only}.
9f85bca7 12018
39bc1876
NS
12019@item -misize
12020@opindex misize
12021Dump instruction size and location in the assembly code.
9f85bca7 12022
39bc1876
NS
12023@item -mpadstruct
12024@opindex mpadstruct
12025This option is deprecated. It pads structures to multiple of 4 bytes,
12026which is incompatible with the SH ABI@.
9f85bca7 12027
39bc1876
NS
12028@item -mspace
12029@opindex mspace
12030Optimize for space instead of speed. Implied by @option{-Os}.
9f85bca7 12031
39bc1876
NS
12032@item -mprefergot
12033@opindex mprefergot
12034When generating position-independent code, emit function calls using
12035the Global Offset Table instead of the Procedure Linkage Table.
9f85bca7 12036
39bc1876
NS
12037@item -musermode
12038@opindex musermode
12039Generate a library function call to invalidate instruction cache
12040entries, after fixing up a trampoline. This library function call
12041doesn't assume it can write to the whole memory address space. This
12042is the default when the target is @code{sh-*-linux*}.
73a4d10b
R
12043
12044@item -multcost=@var{number}
12045@opindex multcost=@var{number}
12046Set the cost to assume for a multiply insn.
12047
12048@item -mdiv=@var{strategy}
12049@opindex mdiv=@var{strategy}
12050Set the division strategy to use for SHmedia code. @var{strategy} must be
12051one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12052inv:call2, inv:fp .
12053"fp" performs the operation in floating point. This has a very high latency,
12054but needs only a few instructions, so it might be a good choice if
30dc60c7 12055your code has enough easily exploitable ILP to allow the compiler to
73a4d10b
R
12056schedule the floating point instructions together with other instructions.
12057Division by zero causes a floating point exception.
12058"inv" uses integer operations to calculate the inverse of the divisor,
30dc60c7 12059and then multiplies the dividend with the inverse. This strategy allows
73a4d10b
R
12060cse and hoisting of the inverse calculation. Division by zero calculates
12061an unspecified result, but does not trap.
12062"inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12063have been found, or if the entire operation has been hoisted to the same
12064place, the last stages of the inverse calculation are intertwined with the
12065final multiply to reduce the overall latency, at the expense of using a few
12066more instructions, and thus offering fewer scheduling opportunities with
12067other code.
12068"call" calls a library function that usually implements the inv:minlat
12069strategy.
12070This gives high code density for m5-*media-nofpu compilations.
12071"call2" uses a different entry point of the same library function, where it
12072assumes that a pointer to a lookup table has already been set up, which
12073exposes the pointer load to cse / code hoisting optimizations.
12074"inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12075code generation, but if the code stays unoptimized, revert to the "call",
30dc60c7 12076"call2", or "fp" strategies, respectively. Note that the
73a4d10b
R
12077potentially-trapping side effect of division by zero is carried by a
12078separate instruction, so it is possible that all the integer instructions
12079are hoisted out, but the marker for the side effect stays where it is.
12080A recombination to fp operations or a call is not possible in that case.
12081"inv20u" and "inv20l" are variants of the "inv:minlat" strategy. In the case
12082that the inverse calculation was nor separated from the multiply, they speed
12083up division where the dividend fits into 20 bits (plus sign where applicable),
12084by inserting a test to skip a number of operations in this case; this test
30dc60c7 12085slows down the case of larger dividends. inv20u assumes the case of a such
73a4d10b
R
12086a small dividend to be unlikely, and inv20l assumes it to be likely.
12087
12088@item -mdivsi3_libfunc=@var{name}
12089@opindex mdivsi3_libfunc=@var{name}
12090Set the name of the library function used for 32 bit signed division to
12091@var{name}. This only affect the name used in the call and inv:call
12092division strategies, and the compiler will still expect the same
12093sets of input/output/clobbered registers as if this option was not present.
12094
12095@item -madjust-unroll
12096@opindex madjust-unroll
12097Throttle unrolling to avoid thrashing target registers.
12098This option only has an effect if the gcc code base supports the
12099TARGET_ADJUST_UNROLL_MAX target hook.
12100
12101@item -mindexed-addressing
12102@opindex mindexed-addressing
12103Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12104This is only safe if the hardware and/or OS implement 32 bit wrap-around
12105semantics for the indexed addressing mode. The architecture allows the
12106implementation of processors with 64 bit MMU, which the OS could use to
30dc60c7 12107get 32 bit addressing, but since no current hardware implementation supports
73a4d10b
R
12108this or any other way to make the indexed addressing mode safe to use in
12109the 32 bit ABI, the default is -mno-indexed-addressing.
12110
12111@item -mgettrcost=@var{number}
12112@opindex mgettrcost=@var{number}
12113Set the cost assumed for the gettr instruction to @var{number}.
12114The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12115
12116@item -mpt-fixed
12117@opindex mpt-fixed
12118Assume pt* instructions won't trap. This will generally generate better
12119scheduled code, but is unsafe on current hardware. The current architecture
12120definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12121This has the unintentional effect of making it unsafe to schedule ptabs /
12122ptrel before a branch, or hoist it out of a loop. For example,
12123__do_global_ctors, a part of libgcc that runs constructors at program
12124startup, calls functions in a list which is delimited by -1. With the
12125-mpt-fixed option, the ptabs will be done before testing against -1.
12126That means that all the constructors will be run a bit quicker, but when
30dc60c7 12127the loop comes to the end of the list, the program crashes because ptabs
73a4d10b
R
12128loads -1 into a target register. Since this option is unsafe for any
12129hardware implementing the current architecture specification, the default
12130is -mno-pt-fixed. Unless the user specifies a specific cost with
12131@option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12132this deters register allocation using target registers for storing
12133ordinary integers.
12134
12135@item -minvalid-symbols
12136@opindex minvalid-symbols
12137Assume symbols might be invalid. Ordinary function symbols generated by
12138the compiler will always be valid to load with movi/shori/ptabs or
12139movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12140to generate symbols that will cause ptabs / ptrel to trap.
12141This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12142It will then prevent cross-basic-block cse, hoisting and most scheduling
12143of symbol loads. The default is @option{-mno-invalid-symbols}.
9f85bca7
JM
12144@end table
12145
39bc1876
NS
12146@node SPARC Options
12147@subsection SPARC Options
12148@cindex SPARC options
69a0611f 12149
39bc1876 12150These @samp{-m} options are supported on the SPARC:
69a0611f
GK
12151
12152@table @gcctabopt
39bc1876
NS
12153@item -mno-app-regs
12154@itemx -mapp-regs
12155@opindex mno-app-regs
12156@opindex mapp-regs
12157Specify @option{-mapp-regs} to generate output using the global registers
121582 through 4, which the SPARC SVR4 ABI reserves for applications. This
d14f5ecb 12159is the default.
69a0611f 12160
39bc1876
NS
12161To be fully SVR4 ABI compliant at the cost of some performance loss,
12162specify @option{-mno-app-regs}. You should compile libraries and system
12163software with this option.
70899148 12164
39bc1876
NS
12165@item -mfpu
12166@itemx -mhard-float
12167@opindex mfpu
12168@opindex mhard-float
12169Generate output containing floating point instructions. This is the
12170default.
70899148 12171
39bc1876
NS
12172@item -mno-fpu
12173@itemx -msoft-float
12174@opindex mno-fpu
12175@opindex msoft-float
12176Generate output containing library calls for floating point.
12177@strong{Warning:} the requisite libraries are not available for all SPARC
12178targets. Normally the facilities of the machine's usual C compiler are
12179used, but this cannot be done directly in cross-compilation. You must make
12180your own arrangements to provide suitable library functions for
12181cross-compilation. The embedded targets @samp{sparc-*-aout} and
12182@samp{sparclite-*-*} do provide software floating point support.
70899148 12183
39bc1876
NS
12184@option{-msoft-float} changes the calling convention in the output file;
12185therefore, it is only useful if you compile @emph{all} of a program with
12186this option. In particular, you need to compile @file{libgcc.a}, the
12187library that comes with GCC, with @option{-msoft-float} in order for
12188this to work.
70899148 12189
39bc1876
NS
12190@item -mhard-quad-float
12191@opindex mhard-quad-float
12192Generate output containing quad-word (long double) floating point
12193instructions.
70899148 12194
39bc1876
NS
12195@item -msoft-quad-float
12196@opindex msoft-quad-float
12197Generate output containing library calls for quad-word (long double)
12198floating point instructions. The functions called are those specified
12199in the SPARC ABI@. This is the default.
70899148 12200
39bc1876
NS
12201As of this writing, there are no SPARC implementations that have hardware
12202support for the quad-word floating point instructions. They all invoke
12203a trap handler for one of these instructions, and then the trap handler
12204emulates the effect of the instruction. Because of the trap handler overhead,
12205this is much slower than calling the ABI library routines. Thus the
12206@option{-msoft-quad-float} option is the default.
70899148 12207
39bc1876
NS
12208@item -mno-unaligned-doubles
12209@itemx -munaligned-doubles
12210@opindex mno-unaligned-doubles
12211@opindex munaligned-doubles
12212Assume that doubles have 8 byte alignment. This is the default.
70899148 12213
39bc1876
NS
12214With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12215alignment only if they are contained in another type, or if they have an
12216absolute address. Otherwise, it assumes they have 4 byte alignment.
12217Specifying this option avoids some rare compatibility problems with code
12218generated by other compilers. It is not the default because it results
12219in a performance loss, especially for floating point code.
70899148 12220
39bc1876
NS
12221@item -mno-faster-structs
12222@itemx -mfaster-structs
12223@opindex mno-faster-structs
12224@opindex mfaster-structs
12225With @option{-mfaster-structs}, the compiler assumes that structures
12226should have 8 byte alignment. This enables the use of pairs of
12227@code{ldd} and @code{std} instructions for copies in structure
12228assignment, in place of twice as many @code{ld} and @code{st} pairs.
12229However, the use of this changed alignment directly violates the SPARC
12230ABI@. Thus, it's intended only for use on targets where the developer
12231acknowledges that their resulting code will not be directly in line with
12232the rules of the ABI@.
70899148 12233
39bc1876
NS
12234@item -mimpure-text
12235@opindex mimpure-text
12236@option{-mimpure-text}, used in addition to @option{-shared}, tells
12237the compiler to not pass @option{-z text} to the linker when linking a
12238shared object. Using this option, you can link position-dependent
12239code into a shared object.
70899148 12240
39bc1876
NS
12241@option{-mimpure-text} suppresses the ``relocations remain against
12242allocatable but non-writable sections'' linker error message.
12243However, the necessary relocations will trigger copy-on-write, and the
12244shared object is not actually shared across processes. Instead of
12245using @option{-mimpure-text}, you should compile all source code with
12246@option{-fpic} or @option{-fPIC}.
12247
12248This option is only available on SunOS and Solaris.
12249
12250@item -mcpu=@var{cpu_type}
12251@opindex mcpu
12252Set the instruction set, register set, and instruction scheduling parameters
12253for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
12254@samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12255@samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12256@samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12257@samp{ultrasparc3}.
70899148 12258
39bc1876
NS
12259Default instruction scheduling parameters are used for values that select
12260an architecture and not an implementation. These are @samp{v7}, @samp{v8},
12261@samp{sparclite}, @samp{sparclet}, @samp{v9}.
70899148 12262
39bc1876
NS
12263Here is a list of each supported architecture and their supported
12264implementations.
70899148 12265
39bc1876
NS
12266@smallexample
12267 v7: cypress
12268 v8: supersparc, hypersparc
12269 sparclite: f930, f934, sparclite86x
12270 sparclet: tsc701
12271 v9: ultrasparc, ultrasparc3
12272@end smallexample
70899148 12273
39bc1876
NS
12274By default (unless configured otherwise), GCC generates code for the V7
12275variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
12276additionally optimizes it for the Cypress CY7C602 chip, as used in the
12277SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
12278SPARCStation 1, 2, IPX etc.
70899148 12279
39bc1876
NS
12280With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12281architecture. The only difference from V7 code is that the compiler emits
12282the integer multiply and integer divide instructions which exist in SPARC-V8
12283but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
12284optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
122852000 series.
70899148 12286
39bc1876
NS
12287With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12288the SPARC architecture. This adds the integer multiply, integer divide step
12289and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12290With @option{-mcpu=f930}, the compiler additionally optimizes it for the
8a36672b 12291Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
39bc1876 12292@option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
8a36672b 12293MB86934 chip, which is the more recent SPARClite with FPU@.
70899148 12294
39bc1876
NS
12295With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12296the SPARC architecture. This adds the integer multiply, multiply/accumulate,
12297integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12298but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
12299optimizes it for the TEMIC SPARClet chip.
70899148 12300
39bc1876
NS
12301With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12302architecture. This adds 64-bit integer and floating-point move instructions,
123033 additional floating-point condition code registers and conditional move
12304instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
12305optimizes it for the Sun UltraSPARC I/II chips. With
12306@option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12307Sun UltraSPARC III chip.
70899148 12308
39bc1876
NS
12309@item -mtune=@var{cpu_type}
12310@opindex mtune
12311Set the instruction scheduling parameters for machine type
12312@var{cpu_type}, but do not set the instruction set or register set that the
12313option @option{-mcpu=@var{cpu_type}} would.
70899148 12314
39bc1876
NS
12315The same values for @option{-mcpu=@var{cpu_type}} can be used for
12316@option{-mtune=@var{cpu_type}}, but the only useful values are those
12317that select a particular cpu implementation. Those are @samp{cypress},
12318@samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12319@samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12320@samp{ultrasparc3}.
70899148 12321
39bc1876
NS
12322@item -mv8plus
12323@itemx -mno-v8plus
12324@opindex mv8plus
12325@opindex mno-v8plus
8a36672b 12326With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
39bc1876
NS
12327difference from the V8 ABI is that the global and out registers are
12328considered 64-bit wide. This is enabled by default on Solaris in 32-bit
12329mode for all SPARC-V9 processors.
70899148 12330
39bc1876
NS
12331@item -mvis
12332@itemx -mno-vis
12333@opindex mvis
12334@opindex mno-vis
12335With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12336Visual Instruction Set extensions. The default is @option{-mno-vis}.
12337@end table
70899148 12338
39bc1876
NS
12339These @samp{-m} options are supported in addition to the above
12340on SPARC-V9 processors in 64-bit environments:
70899148 12341
39bc1876
NS
12342@table @gcctabopt
12343@item -mlittle-endian
12344@opindex mlittle-endian
8a36672b 12345Generate code for a processor running in little-endian mode. It is only
d4e1591f 12346available for a few configurations and most notably not on Solaris and Linux.
70899148 12347
39bc1876
NS
12348@item -m32
12349@itemx -m64
12350@opindex m32
12351@opindex m64
12352Generate code for a 32-bit or 64-bit environment.
12353The 32-bit environment sets int, long and pointer to 32 bits.
12354The 64-bit environment sets int to 32 bits and long and pointer
12355to 64 bits.
70899148 12356
39bc1876
NS
12357@item -mcmodel=medlow
12358@opindex mcmodel=medlow
12359Generate code for the Medium/Low code model: 64-bit addresses, programs
12360must be linked in the low 32 bits of memory. Programs can be statically
12361or dynamically linked.
70899148 12362
39bc1876
NS
12363@item -mcmodel=medmid
12364@opindex mcmodel=medmid
12365Generate code for the Medium/Middle code model: 64-bit addresses, programs
12366must be linked in the low 44 bits of memory, the text and data segments must
12367be less than 2GB in size and the data segment must be located within 2GB of
12368the text segment.
70899148 12369
39bc1876
NS
12370@item -mcmodel=medany
12371@opindex mcmodel=medany
12372Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12373may be linked anywhere in memory, the text and data segments must be less
12374than 2GB in size and the data segment must be located within 2GB of the
12375text segment.
70899148 12376
39bc1876
NS
12377@item -mcmodel=embmedany
12378@opindex mcmodel=embmedany
12379Generate code for the Medium/Anywhere code model for embedded systems:
1238064-bit addresses, the text and data segments must be less than 2GB in
12381size, both starting anywhere in memory (determined at link time). The
12382global register %g4 points to the base of the data segment. Programs
12383are statically linked and PIC is not supported.
70899148 12384
39bc1876
NS
12385@item -mstack-bias
12386@itemx -mno-stack-bias
12387@opindex mstack-bias
12388@opindex mno-stack-bias
12389With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12390frame pointer if present, are offset by @minus{}2047 which must be added back
12391when making stack frame references. This is the default in 64-bit mode.
12392Otherwise, assume no such offset is present.
12393@end table
70899148 12394
6bfb2f93
EB
12395These switches are supported in addition to the above on Solaris:
12396
12397@table @gcctabopt
12398@item -threads
12399@opindex threads
12400Add support for multithreading using the Solaris threads library. This
12401option sets flags for both the preprocessor and linker. This option does
12402not affect the thread safety of object code produced by the compiler or
12403that of libraries supplied with it.
12404
12405@item -pthreads
12406@opindex pthreads
12407Add support for multithreading using the POSIX threads library. This
12408option sets flags for both the preprocessor and linker. This option does
12409not affect the thread safety of object code produced by the compiler or
12410that of libraries supplied with it.
f5e2061b
EB
12411
12412@item -pthread
12413@opindex pthread
12414This is a synonym for @option{-pthreads}.
6bfb2f93
EB
12415@end table
12416
39bc1876
NS
12417@node System V Options
12418@subsection Options for System V
70899148 12419
39bc1876
NS
12420These additional options are available on System V Release 4 for
12421compatibility with other compilers on those systems:
70899148 12422
39bc1876
NS
12423@table @gcctabopt
12424@item -G
12425@opindex G
12426Create a shared object.
12427It is recommended that @option{-symbolic} or @option{-shared} be used instead.
70899148 12428
39bc1876
NS
12429@item -Qy
12430@opindex Qy
12431Identify the versions of each tool used by the compiler, in a
12432@code{.ident} assembler directive in the output.
70899148 12433
39bc1876
NS
12434@item -Qn
12435@opindex Qn
12436Refrain from adding @code{.ident} directives to the output file (this is
12437the default).
70899148 12438
39bc1876
NS
12439@item -YP,@var{dirs}
12440@opindex YP
12441Search the directories @var{dirs}, and no others, for libraries
12442specified with @option{-l}.
70899148 12443
39bc1876
NS
12444@item -Ym,@var{dir}
12445@opindex Ym
12446Look in the directory @var{dir} to find the M4 preprocessor.
12447The assembler uses this option.
12448@c This is supposed to go with a -Yd for predefined M4 macro files, but
12449@c the generic assembler that comes with Solaris takes just -Ym.
12450@end table
70899148 12451
39bc1876
NS
12452@node TMS320C3x/C4x Options
12453@subsection TMS320C3x/C4x Options
12454@cindex TMS320C3x/C4x Options
70899148 12455
39bc1876 12456These @samp{-m} options are defined for TMS320C3x/C4x implementations:
70899148 12457
39bc1876 12458@table @gcctabopt
70899148 12459
39bc1876
NS
12460@item -mcpu=@var{cpu_type}
12461@opindex mcpu
12462Set the instruction set, register set, and instruction scheduling
12463parameters for machine type @var{cpu_type}. Supported values for
12464@var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12465@samp{c44}. The default is @samp{c40} to generate code for the
12466TMS320C40.
70899148 12467
39bc1876
NS
12468@item -mbig-memory
12469@itemx -mbig
12470@itemx -msmall-memory
12471@itemx -msmall
12472@opindex mbig-memory
12473@opindex mbig
12474@opindex msmall-memory
12475@opindex msmall
12476Generates code for the big or small memory model. The small memory
12477model assumed that all data fits into one 64K word page. At run-time
12478the data page (DP) register must be set to point to the 64K page
12479containing the .bss and .data program sections. The big memory model is
12480the default and requires reloading of the DP register for every direct
12481memory access.
70899148 12482
39bc1876
NS
12483@item -mbk
12484@itemx -mno-bk
12485@opindex mbk
12486@opindex mno-bk
12487Allow (disallow) allocation of general integer operands into the block
12488count register BK@.
70899148 12489
39bc1876
NS
12490@item -mdb
12491@itemx -mno-db
12492@opindex mdb
12493@opindex mno-db
12494Enable (disable) generation of code using decrement and branch,
12495DBcond(D), instructions. This is enabled by default for the C4x. To be
12496on the safe side, this is disabled for the C3x, since the maximum
12497iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12498@math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
12499that it can utilize the decrement and branch instruction, but will give
12500up if there is more than one memory reference in the loop. Thus a loop
12501where the loop counter is decremented can generate slightly more
12502efficient code, in cases where the RPTB instruction cannot be utilized.
70899148 12503
39bc1876
NS
12504@item -mdp-isr-reload
12505@itemx -mparanoid
12506@opindex mdp-isr-reload
12507@opindex mparanoid
12508Force the DP register to be saved on entry to an interrupt service
12509routine (ISR), reloaded to point to the data section, and restored on
12510exit from the ISR@. This should not be required unless someone has
12511violated the small memory model by modifying the DP register, say within
12512an object library.
70899148 12513
39bc1876
NS
12514@item -mmpyi
12515@itemx -mno-mpyi
12516@opindex mmpyi
12517@opindex mno-mpyi
12518For the C3x use the 24-bit MPYI instruction for integer multiplies
12519instead of a library call to guarantee 32-bit results. Note that if one
12520of the operands is a constant, then the multiplication will be performed
12521using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
12522then squaring operations are performed inline instead of a library call.
70899148 12523
39bc1876
NS
12524@item -mfast-fix
12525@itemx -mno-fast-fix
12526@opindex mfast-fix
12527@opindex mno-fast-fix
12528The C3x/C4x FIX instruction to convert a floating point value to an
12529integer value chooses the nearest integer less than or equal to the
12530floating point value rather than to the nearest integer. Thus if the
12531floating point number is negative, the result will be incorrectly
12532truncated an additional code is necessary to detect and correct this
12533case. This option can be used to disable generation of the additional
12534code required to correct the result.
70899148 12535
39bc1876
NS
12536@item -mrptb
12537@itemx -mno-rptb
12538@opindex mrptb
12539@opindex mno-rptb
12540Enable (disable) generation of repeat block sequences using the RPTB
12541instruction for zero overhead looping. The RPTB construct is only used
12542for innermost loops that do not call functions or jump across the loop
12543boundaries. There is no advantage having nested RPTB loops due to the
12544overhead required to save and restore the RC, RS, and RE registers.
12545This is enabled by default with @option{-O2}.
70899148 12546
39bc1876
NS
12547@item -mrpts=@var{count}
12548@itemx -mno-rpts
12549@opindex mrpts
12550@opindex mno-rpts
12551Enable (disable) the use of the single instruction repeat instruction
12552RPTS@. If a repeat block contains a single instruction, and the loop
12553count can be guaranteed to be less than the value @var{count}, GCC will
12554emit a RPTS instruction instead of a RPTB@. If no value is specified,
12555then a RPTS will be emitted even if the loop count cannot be determined
12556at compile time. Note that the repeated instruction following RPTS does
12557not have to be reloaded from memory each iteration, thus freeing up the
12558CPU buses for operands. However, since interrupts are blocked by this
12559instruction, it is disabled by default.
70899148 12560
39bc1876
NS
12561@item -mloop-unsigned
12562@itemx -mno-loop-unsigned
12563@opindex mloop-unsigned
12564@opindex mno-loop-unsigned
12565The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12566is @math{2^{31} + 1} since these instructions test if the iteration count is
12567negative to terminate the loop. If the iteration count is unsigned
12568there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12569exceeded. This switch allows an unsigned iteration count.
70899148 12570
39bc1876
NS
12571@item -mti
12572@opindex mti
12573Try to emit an assembler syntax that the TI assembler (asm30) is happy
12574with. This also enforces compatibility with the API employed by the TI
12575C3x C compiler. For example, long doubles are passed as structures
12576rather than in floating point registers.
70899148 12577
39bc1876
NS
12578@item -mregparm
12579@itemx -mmemparm
12580@opindex mregparm
12581@opindex mmemparm
12582Generate code that uses registers (stack) for passing arguments to functions.
12583By default, arguments are passed in registers where possible rather
12584than by pushing arguments on to the stack.
70899148 12585
39bc1876
NS
12586@item -mparallel-insns
12587@itemx -mno-parallel-insns
12588@opindex mparallel-insns
12589@opindex mno-parallel-insns
12590Allow the generation of parallel instructions. This is enabled by
12591default with @option{-O2}.
70899148 12592
39bc1876
NS
12593@item -mparallel-mpy
12594@itemx -mno-parallel-mpy
12595@opindex mparallel-mpy
12596@opindex mno-parallel-mpy
12597Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12598provided @option{-mparallel-insns} is also specified. These instructions have
12599tight register constraints which can pessimize the code generation
12600of large functions.
70899148 12601
39bc1876 12602@end table
70899148 12603
39bc1876
NS
12604@node V850 Options
12605@subsection V850 Options
12606@cindex V850 Options
70899148 12607
39bc1876 12608These @samp{-m} options are defined for V850 implementations:
70899148 12609
39bc1876
NS
12610@table @gcctabopt
12611@item -mlong-calls
12612@itemx -mno-long-calls
12613@opindex mlong-calls
12614@opindex mno-long-calls
12615Treat all calls as being far away (near). If calls are assumed to be
12616far away, the compiler will always load the functions address up into a
12617register, and call indirect through the pointer.
70899148 12618
39bc1876
NS
12619@item -mno-ep
12620@itemx -mep
12621@opindex mno-ep
12622@opindex mep
12623Do not optimize (do optimize) basic blocks that use the same index
12624pointer 4 or more times to copy pointer into the @code{ep} register, and
12625use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
12626option is on by default if you optimize.
70899148 12627
39bc1876
NS
12628@item -mno-prolog-function
12629@itemx -mprolog-function
12630@opindex mno-prolog-function
12631@opindex mprolog-function
12632Do not use (do use) external functions to save and restore registers
12633at the prologue and epilogue of a function. The external functions
12634are slower, but use less code space if more than one function saves
12635the same number of registers. The @option{-mprolog-function} option
12636is on by default if you optimize.
70899148 12637
39bc1876
NS
12638@item -mspace
12639@opindex mspace
12640Try to make the code as small as possible. At present, this just turns
12641on the @option{-mep} and @option{-mprolog-function} options.
70899148 12642
39bc1876
NS
12643@item -mtda=@var{n}
12644@opindex mtda
12645Put static or global variables whose size is @var{n} bytes or less into
12646the tiny data area that register @code{ep} points to. The tiny data
12647area can hold up to 256 bytes in total (128 bytes for byte references).
70899148 12648
39bc1876
NS
12649@item -msda=@var{n}
12650@opindex msda
12651Put static or global variables whose size is @var{n} bytes or less into
12652the small data area that register @code{gp} points to. The small data
12653area can hold up to 64 kilobytes.
70899148 12654
39bc1876
NS
12655@item -mzda=@var{n}
12656@opindex mzda
12657Put static or global variables whose size is @var{n} bytes or less into
12658the first 32 kilobytes of memory.
70899148 12659
39bc1876
NS
12660@item -mv850
12661@opindex mv850
12662Specify that the target processor is the V850.
70899148 12663
39bc1876
NS
12664@item -mbig-switch
12665@opindex mbig-switch
12666Generate code suitable for big switch tables. Use this option only if
12667the assembler/linker complain about out of range branches within a switch
12668table.
70899148 12669
39bc1876
NS
12670@item -mapp-regs
12671@opindex mapp-regs
12672This option will cause r2 and r5 to be used in the code generated by
12673the compiler. This setting is the default.
70899148 12674
39bc1876
NS
12675@item -mno-app-regs
12676@opindex mno-app-regs
12677This option will cause r2 and r5 to be treated as fixed registers.
70899148 12678
39bc1876
NS
12679@item -mv850e1
12680@opindex mv850e1
12681Specify that the target processor is the V850E1. The preprocessor
12682constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12683this option is used.
70899148 12684
39bc1876
NS
12685@item -mv850e
12686@opindex mv850e
8a36672b 12687Specify that the target processor is the V850E@. The preprocessor
39bc1876 12688constant @samp{__v850e__} will be defined if this option is used.
70899148 12689
39bc1876
NS
12690If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12691are defined then a default target processor will be chosen and the
12692relevant @samp{__v850*__} preprocessor constant will be defined.
70899148 12693
39bc1876
NS
12694The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12695defined, regardless of which processor variant is the target.
70899148 12696
39bc1876
NS
12697@item -mdisable-callt
12698@opindex mdisable-callt
12699This option will suppress generation of the CALLT instruction for the
12700v850e and v850e1 flavors of the v850 architecture. The default is
12701@option{-mno-disable-callt} which allows the CALLT instruction to be used.
70899148 12702
39bc1876 12703@end table
70899148 12704
39bc1876
NS
12705@node VAX Options
12706@subsection VAX Options
12707@cindex VAX options
70899148 12708
39bc1876 12709These @samp{-m} options are defined for the VAX:
70899148 12710
39bc1876
NS
12711@table @gcctabopt
12712@item -munix
12713@opindex munix
12714Do not output certain jump instructions (@code{aobleq} and so on)
12715that the Unix assembler for the VAX cannot handle across long
12716ranges.
70899148 12717
39bc1876
NS
12718@item -mgnu
12719@opindex mgnu
12720Do output those jump instructions, on the assumption that you
12721will assemble with the GNU assembler.
70899148 12722
39bc1876
NS
12723@item -mg
12724@opindex mg
12725Output code for g-format floating point numbers instead of d-format.
12726@end table
70899148 12727
39bc1876
NS
12728@node x86-64 Options
12729@subsection x86-64 Options
12730@cindex x86-64 options
70899148 12731
39bc1876 12732These are listed under @xref{i386 and x86-64 Options}.
70899148 12733
39bc1876
NS
12734@node Xstormy16 Options
12735@subsection Xstormy16 Options
12736@cindex Xstormy16 Options
70899148 12737
39bc1876 12738These options are defined for Xstormy16:
70899148 12739
39bc1876
NS
12740@table @gcctabopt
12741@item -msim
12742@opindex msim
12743Choose startup files and linker script suitable for the simulator.
70899148
BS
12744@end table
12745
03984308
BW
12746@node Xtensa Options
12747@subsection Xtensa Options
12748@cindex Xtensa Options
12749
6cedbe44 12750These options are supported for Xtensa targets:
03984308
BW
12751
12752@table @gcctabopt
f42f5a1b
BW
12753@item -mconst16
12754@itemx -mno-const16
12755@opindex mconst16
12756@opindex mno-const16
6c2e8d1c
BW
12757Enable or disable use of @code{CONST16} instructions for loading
12758constant values. The @code{CONST16} instruction is currently not a
12759standard option from Tensilica. When enabled, @code{CONST16}
12760instructions are always used in place of the standard @code{L32R}
12761instructions. The use of @code{CONST16} is enabled by default only if
12762the @code{L32R} instruction is not available.
12763
03984308
BW
12764@item -mfused-madd
12765@itemx -mno-fused-madd
12766@opindex mfused-madd
12767@opindex mno-fused-madd
12768Enable or disable use of fused multiply/add and multiply/subtract
12769instructions in the floating-point option. This has no effect if the
12770floating-point option is not also enabled. Disabling fused multiply/add
12771and multiply/subtract instructions forces the compiler to use separate
12772instructions for the multiply and add/subtract operations. This may be
12773desirable in some cases where strict IEEE 754-compliant results are
12774required: the fused multiply add/subtract instructions do not round the
12775intermediate result, thereby producing results with @emph{more} bits of
12776precision than specified by the IEEE standard. Disabling fused multiply
12777add/subtract instructions also ensures that the program output is not
12778sensitive to the compiler's ability to combine multiply and add/subtract
12779operations.
12780
03984308
BW
12781@item -mtext-section-literals
12782@itemx -mno-text-section-literals
12783@opindex mtext-section-literals
12784@opindex mno-text-section-literals
12785Control the treatment of literal pools. The default is
12786@option{-mno-text-section-literals}, which places literals in a separate
12787section in the output file. This allows the literal pool to be placed
12788in a data RAM/ROM, and it also allows the linker to combine literal
12789pools from separate object files to remove redundant literals and
12790improve code size. With @option{-mtext-section-literals}, the literals
12791are interspersed in the text section in order to keep them as close as
12792possible to their references. This may be necessary for large assembly
12793files.
12794
12795@item -mtarget-align
12796@itemx -mno-target-align
12797@opindex mtarget-align
12798@opindex mno-target-align
12799When this option is enabled, GCC instructs the assembler to
12800automatically align instructions to reduce branch penalties at the
12801expense of some code density. The assembler attempts to widen density
12802instructions to align branch targets and the instructions following call
12803instructions. If there are not enough preceding safe density
12804instructions to align a target, no widening will be performed. The
12805default is @option{-mtarget-align}. These options do not affect the
12806treatment of auto-aligned instructions like @code{LOOP}, which the
12807assembler will always align, either by widening density instructions or
12808by inserting no-op instructions.
12809
12810@item -mlongcalls
12811@itemx -mno-longcalls
12812@opindex mlongcalls
12813@opindex mno-longcalls
12814When this option is enabled, GCC instructs the assembler to translate
12815direct calls to indirect calls unless it can determine that the target
12816of a direct call is in the range allowed by the call instruction. This
12817translation typically occurs for calls to functions in other source
12818files. Specifically, the assembler translates a direct @code{CALL}
12819instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12820The default is @option{-mno-longcalls}. This option should be used in
12821programs where the call target can potentially be out of range. This
12822option is implemented in the assembler, not the compiler, so the
12823assembly code generated by GCC will still show direct call
12824instructions---look at the disassembled object code to see the actual
12825instructions. Note that the assembler will use an indirect call for
12826every cross-file call, not just those that really will be out of range.
12827@end table
12828
39bc1876
NS
12829@node zSeries Options
12830@subsection zSeries Options
12831@cindex zSeries options
12832
12833These are listed under @xref{S/390 and zSeries Options}.
12834
74291a4b
MM
12835@node Code Gen Options
12836@section Options for Code Generation Conventions
12837@cindex code generation conventions
12838@cindex options, code generation
12839@cindex run-time options
12840
12841These machine-independent options control the interface conventions
12842used in code generation.
12843
12844Most of them have both positive and negative forms; the negative form
630d3d5a 12845of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
74291a4b
MM
12846one of the forms is listed---the one which is not the default. You
12847can figure out the other form by either removing @samp{no-} or adding
12848it.
12849
2642624b 12850@table @gcctabopt
d4463dfc
JQ
12851@item -fbounds-check
12852@opindex fbounds-check
12853For front-ends that support it, generate additional code to check that
12854indices used to access arrays are within the declared range. This is
12855currently only supported by the Java and Fortran 77 front-ends, where
12856this option defaults to true and false respectively.
12857
12858@item -ftrapv
12859@opindex ftrapv
12860This option generates traps for signed overflow on addition, subtraction,
12861multiplication operations.
12862
4fa26a60
RS
12863@item -fwrapv
12864@opindex fwrapv
12865This option instructs the compiler to assume that signed arithmetic
12866overflow of addition, subtraction and multiplication wraps around
c0cbdbd9 12867using twos-complement representation. This flag enables some optimizations
aa58883c 12868and disables others. This option is enabled by default for the Java
4fa26a60
RS
12869front-end, as required by the Java language specification.
12870
956d6950 12871@item -fexceptions
cd3bb277 12872@opindex fexceptions
767094dd 12873Enable exception handling. Generates extra code needed to propagate
f0523f02 12874exceptions. For some targets, this implies GCC will generate frame
c5c76735
JL
12875unwind information for all functions, which can produce significant data
12876size overhead, although it does not affect execution. If you do not
f0523f02 12877specify this option, GCC will enable it by default for languages like
90ecce3e 12878C++ which normally require exception handling, and disable it for
c5c76735
JL
12879languages like C that do not normally require it. However, you may need
12880to enable this option when compiling C code that needs to interoperate
12881properly with exception handlers written in C++. You may also wish to
12882disable this option if you are compiling older C++ programs that don't
12883use exception handling.
956d6950 12884
6cfc0341
RH
12885@item -fnon-call-exceptions
12886@opindex fnon-call-exceptions
12887Generate code that allows trapping instructions to throw exceptions.
12888Note that this requires platform-specific runtime support that does
12889not exist everywhere. Moreover, it only allows @emph{trapping}
e979f9e8 12890instructions to throw exceptions, i.e.@: memory references or floating
6cfc0341
RH
12891point instructions. It does not allow exceptions to be thrown from
12892arbitrary signal handlers such as @code{SIGALRM}.
12893
14a774a9 12894@item -funwind-tables
cd3bb277 12895@opindex funwind-tables
bedc7537 12896Similar to @option{-fexceptions}, except that it will just generate any needed
14a774a9
RK
12897static data, but will not affect the generated code in any other way.
12898You will normally not enable this option; instead, a language processor
12899that needs this handling would enable it on your behalf.
12900
b932f770 12901@item -fasynchronous-unwind-tables
2a9dc917 12902@opindex fasynchronous-unwind-tables
b932f770
JH
12903Generate unwind table in dwarf2 format, if supported by target machine. The
12904table is exact at each instruction boundary, so it can be used for stack
12905unwinding from asynchronous events (such as debugger or garbage collector).
12906
74291a4b 12907@item -fpcc-struct-return
cd3bb277 12908@opindex fpcc-struct-return
74291a4b
MM
12909Return ``short'' @code{struct} and @code{union} values in memory like
12910longer ones, rather than in registers. This convention is less
12911efficient, but it has the advantage of allowing intercallability between
a9c60612
JJ
12912GCC-compiled files and files compiled with other compilers, particularly
12913the Portable C Compiler (pcc).
74291a4b
MM
12914
12915The precise convention for returning structures in memory depends
12916on the target configuration macros.
12917
12918Short structures and unions are those whose size and alignment match
12919that of some integer type.
12920
a9c60612
JJ
12921@strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12922switch is not binary compatible with code compiled with the
12923@option{-freg-struct-return} switch.
12924Use it to conform to a non-default application binary interface.
12925
74291a4b 12926@item -freg-struct-return
cd3bb277 12927@opindex freg-struct-return
9c34dbbf
ZW
12928Return @code{struct} and @code{union} values in registers when possible.
12929This is more efficient for small structures than
12930@option{-fpcc-struct-return}.
74291a4b 12931
9c34dbbf 12932If you specify neither @option{-fpcc-struct-return} nor
630d3d5a 12933@option{-freg-struct-return}, GCC defaults to whichever convention is
0c2d1a2a 12934standard for the target. If there is no standard convention, GCC
9c34dbbf
ZW
12935defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12936the principal compiler. In those cases, we can choose the standard, and
12937we chose the more efficient register return alternative.
74291a4b 12938
a9c60612
JJ
12939@strong{Warning:} code compiled with the @option{-freg-struct-return}
12940switch is not binary compatible with code compiled with the
12941@option{-fpcc-struct-return} switch.
12942Use it to conform to a non-default application binary interface.
12943
74291a4b 12944@item -fshort-enums
cd3bb277 12945@opindex fshort-enums
74291a4b
MM
12946Allocate to an @code{enum} type only as many bytes as it needs for the
12947declared range of possible values. Specifically, the @code{enum} type
12948will be equivalent to the smallest integer type which has enough room.
12949
a9c60612
JJ
12950@strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12951code that is not binary compatible with code generated without that switch.
12952Use it to conform to a non-default application binary interface.
12953
74291a4b 12954@item -fshort-double
cd3bb277 12955@opindex fshort-double
74291a4b
MM
12956Use the same size for @code{double} as for @code{float}.
12957
a9c60612
JJ
12958@strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12959code that is not binary compatible with code generated without that switch.
12960Use it to conform to a non-default application binary interface.
12961
12962@item -fshort-wchar
12963@opindex fshort-wchar
12964Override the underlying type for @samp{wchar_t} to be @samp{short
12965unsigned int} instead of the default for the target. This option is
12966useful for building programs to run under WINE@.
12967
12968@strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12969code that is not binary compatible with code generated without that switch.
12970Use it to conform to a non-default application binary interface.
12971
74291a4b 12972@item -fshared-data
cd3bb277 12973@opindex fshared-data
74291a4b
MM
12974Requests that the data and non-@code{const} variables of this
12975compilation be shared data rather than private data. The distinction
12976makes sense only on certain operating systems, where shared data is
12977shared between processes running the same program, while private data
12978exists in one copy per process.
12979
12980@item -fno-common
cd3bb277 12981@opindex fno-common
90ecce3e 12982In C, allocate even uninitialized global variables in the data section of the
74291a4b
MM
12983object file, rather than generating them as common blocks. This has the
12984effect that if the same variable is declared (without @code{extern}) in
12985two different compilations, you will get an error when you link them.
12986The only reason this might be useful is if you wish to verify that the
12987program will work on other systems which always work this way.
12988
12989@item -fno-ident
cd3bb277 12990@opindex fno-ident
74291a4b
MM
12991Ignore the @samp{#ident} directive.
12992
74291a4b 12993@item -finhibit-size-directive
cd3bb277 12994@opindex finhibit-size-directive
74291a4b
MM
12995Don't output a @code{.size} assembler directive, or anything else that
12996would cause trouble if the function is split in the middle, and the
12997two halves are placed at locations far apart in memory. This option is
12998used when compiling @file{crtstuff.c}; you should not need to use it
12999for anything else.
13000
13001@item -fverbose-asm
cd3bb277 13002@opindex fverbose-asm
74291a4b
MM
13003Put extra commentary information in the generated assembly code to
13004make it more readable. This option is generally only of use to those
13005who actually need to read the generated assembly code (perhaps while
13006debugging the compiler itself).
13007
630d3d5a 13008@option{-fno-verbose-asm}, the default, causes the
74291a4b
MM
13009extra information to be omitted and is useful when comparing two assembler
13010files.
13011
74291a4b 13012@item -fpic
cd3bb277 13013@opindex fpic
74291a4b
MM
13014@cindex global offset table
13015@cindex PIC
13016Generate position-independent code (PIC) suitable for use in a shared
13017library, if supported for the target machine. Such code accesses all
161d7b59 13018constant addresses through a global offset table (GOT)@. The dynamic
861bb6c1 13019loader resolves the GOT entries when the program starts (the dynamic
0c2d1a2a 13020loader is not part of GCC; it is part of the operating system). If
861bb6c1
JL
13021the GOT size for the linked executable exceeds a machine-specific
13022maximum size, you get an error message from the linker indicating that
630d3d5a 13023@option{-fpic} does not work; in that case, recompile with @option{-fPIC}
b6e69d94 13024instead. (These maximums are 8k on the SPARC and 32k
861bb6c1 13025on the m68k and RS/6000. The 386 has no such limit.)
74291a4b
MM
13026
13027Position-independent code requires special support, and therefore works
0c2d1a2a 13028only on certain machines. For the 386, GCC supports PIC for System V
74291a4b
MM
13029but not for the Sun 386i. Code generated for the IBM RS/6000 is always
13030position-independent.
13031
3d119f8f
KG
13032When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13033are defined to 1.
13034
74291a4b 13035@item -fPIC
cd3bb277 13036@opindex fPIC
74291a4b
MM
13037If supported for the target machine, emit position-independent code,
13038suitable for dynamic linking and avoiding any limit on the size of the
068d4f38
BE
13039global offset table. This option makes a difference on the m68k,
13040PowerPC and SPARC@.
74291a4b
MM
13041
13042Position-independent code requires special support, and therefore works
13043only on certain machines.
13044
3d119f8f
KG
13045When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13046are defined to 2.
13047
24a4dd31
JJ
13048@item -fpie
13049@itemx -fPIE
13050@opindex fpie
13051@opindex fPIE
13052These options are similar to @option{-fpic} and @option{-fPIC}, but
13053generated position independent code can be only linked into executables.
13054Usually these options are used when @option{-pie} GCC option will be
13055used during linking.
13056
82c0180d
JM
13057@item -fno-jump-tables
13058@opindex fno-jump-tables
13059Do not use jump tables for switch statements even where it would be
13060more efficient than other code generation strategies. This option is
13061of use in conjunction with @option{-fpic} or @option{-fPIC} for
13062building code which forms part of a dynamic linker and cannot
13063reference the address of a jump table. On some targets, jump tables
13064do not require a GOT and this option is not needed.
13065
74291a4b 13066@item -ffixed-@var{reg}
cd3bb277 13067@opindex ffixed
74291a4b
MM
13068Treat the register named @var{reg} as a fixed register; generated code
13069should never refer to it (except perhaps as a stack pointer, frame
13070pointer or in some other fixed role).
13071
13072@var{reg} must be the name of a register. The register names accepted
13073are machine-specific and are defined in the @code{REGISTER_NAMES}
13074macro in the machine description macro file.
13075
13076This flag does not have a negative form, because it specifies a
13077three-way choice.
13078
13079@item -fcall-used-@var{reg}
cd3bb277 13080@opindex fcall-used
956d6950 13081Treat the register named @var{reg} as an allocable register that is
74291a4b
MM
13082clobbered by function calls. It may be allocated for temporaries or
13083variables that do not live across a call. Functions compiled this way
13084will not save and restore the register @var{reg}.
13085
cb2fdc84
GRK
13086It is an error to used this flag with the frame pointer or stack pointer.
13087Use of this flag for other registers that have fixed pervasive roles in
13088the machine's execution model will produce disastrous results.
74291a4b
MM
13089
13090This flag does not have a negative form, because it specifies a
13091three-way choice.
13092
13093@item -fcall-saved-@var{reg}
cd3bb277 13094@opindex fcall-saved
956d6950 13095Treat the register named @var{reg} as an allocable register saved by
74291a4b
MM
13096functions. It may be allocated even for temporaries or variables that
13097live across a call. Functions compiled this way will save and restore
13098the register @var{reg} if they use it.
13099
cb2fdc84
GRK
13100It is an error to used this flag with the frame pointer or stack pointer.
13101Use of this flag for other registers that have fixed pervasive roles in
13102the machine's execution model will produce disastrous results.
74291a4b
MM
13103
13104A different sort of disaster will result from the use of this flag for
13105a register in which function values may be returned.
13106
13107This flag does not have a negative form, because it specifies a
13108three-way choice.
13109
467cecf3 13110@item -fpack-struct[=@var{n}]
cd3bb277 13111@opindex fpack-struct
467cecf3 13112Without a value specified, pack all structure members together without
8a36672b 13113holes. When a value is specified (which must be a small power of two), pack
467cecf3
JB
13114structure members according to this value, representing the maximum
13115alignment (that is, objects with default alignment requirements larger than
13116this will be output potentially unaligned at the next fitting location.
a9c60612
JJ
13117
13118@strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13119code that is not binary compatible with code generated without that switch.
3364c33b 13120Additionally, it makes the code suboptimal.
a9c60612 13121Use it to conform to a non-default application binary interface.
74291a4b 13122
07417085 13123@item -finstrument-functions
cd3bb277 13124@opindex finstrument-functions
07417085
KR
13125Generate instrumentation calls for entry and exit to functions. Just
13126after function entry and just before function exit, the following
13127profiling functions will be called with the address of the current
13128function and its call site. (On some platforms,
13129@code{__builtin_return_address} does not work beyond the current
13130function, so the call site information may not be available to the
13131profiling functions otherwise.)
13132
3ab51846 13133@smallexample
310668e8
JM
13134void __cyg_profile_func_enter (void *this_fn,
13135 void *call_site);
13136void __cyg_profile_func_exit (void *this_fn,
13137 void *call_site);
3ab51846 13138@end smallexample
07417085
KR
13139
13140The first argument is the address of the start of the current function,
13141which may be looked up exactly in the symbol table.
13142
13143This instrumentation is also done for functions expanded inline in other
13144functions. The profiling calls will indicate where, conceptually, the
13145inline function is entered and exited. This means that addressable
13146versions of such functions must be available. If all your uses of a
13147function are expanded inline, this may mean an additional expansion of
13148code size. If you use @samp{extern inline} in your C code, an
13149addressable version of such functions must be provided. (This is
13150normally the case anyways, but if you get lucky and the optimizer always
13151expands the functions inline, you might have gotten away without
13152providing static copies.)
13153
13154A function may be given the attribute @code{no_instrument_function}, in
13155which case this instrumentation will not be done. This can be used, for
13156example, for the profiling functions listed above, high-priority
13157interrupt routines, and any functions from which the profiling functions
13158cannot safely be called (perhaps signal handlers, if the profiling
13159routines generate output or allocate memory).
13160
861bb6c1 13161@item -fstack-check
cd3bb277 13162@opindex fstack-check
861bb6c1
JL
13163Generate code to verify that you do not go beyond the boundary of the
13164stack. You should specify this flag if you are running in an
13165environment with multiple threads, but only rarely need to specify it in
13166a single-threaded environment since stack overflow is automatically
13167detected on nearly all systems if there is only one stack.
13168
a157febd
GK
13169Note that this switch does not actually cause checking to be done; the
13170operating system must do that. The switch causes generation of code
13171to ensure that the operating system sees the stack being extended.
13172
13173@item -fstack-limit-register=@var{reg}
13174@itemx -fstack-limit-symbol=@var{sym}
13175@itemx -fno-stack-limit
cd3bb277
JM
13176@opindex fstack-limit-register
13177@opindex fstack-limit-symbol
13178@opindex fno-stack-limit
a157febd
GK
13179Generate code to ensure that the stack does not grow beyond a certain value,
13180either the value of a register or the address of a symbol. If the stack
13181would grow beyond the value, a signal is raised. For most targets,
13182the signal is raised before the stack overruns the boundary, so
13183it is possible to catch the signal without taking special precautions.
13184
9c34dbbf
ZW
13185For instance, if the stack starts at absolute address @samp{0x80000000}
13186and grows downwards, you can use the flags
13187@option{-fstack-limit-symbol=__stack_limit} and
13188@option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13189of 128KB@. Note that this may only work with the GNU linker.
a157febd 13190
e5eb27e5
JL
13191@cindex aliasing of parameters
13192@cindex parameters, aliased
13193@item -fargument-alias
04afd9d6
JL
13194@itemx -fargument-noalias
13195@itemx -fargument-noalias-global
cd3bb277
JM
13196@opindex fargument-alias
13197@opindex fargument-noalias
13198@opindex fargument-noalias-global
e5eb27e5
JL
13199Specify the possible relationships among parameters and between
13200parameters and global data.
13201
630d3d5a 13202@option{-fargument-alias} specifies that arguments (parameters) may
9c34dbbf 13203alias each other and may alias global storage.@*
630d3d5a 13204@option{-fargument-noalias} specifies that arguments do not alias
9c34dbbf 13205each other, but may alias global storage.@*
630d3d5a 13206@option{-fargument-noalias-global} specifies that arguments do not
e5eb27e5
JL
13207alias each other and do not alias global storage.
13208
13209Each language will automatically use whatever option is required by
13210the language standard. You should not need to use these options yourself.
19283265
RH
13211
13212@item -fleading-underscore
cd3bb277 13213@opindex fleading-underscore
695ac33f 13214This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19283265
RH
13215change the way C symbols are represented in the object file. One use
13216is to help link with legacy assembly code.
13217
a9c60612
JJ
13218@strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13219generate code that is not binary compatible with code generated without that
13220switch. Use it to conform to a non-default application binary interface.
13221Not all targets provide complete support for this switch.
3d78f2e9
RH
13222
13223@item -ftls-model=@var{model}
13224Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13225The @var{model} argument should be one of @code{global-dynamic},
13226@code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13227
13228The default without @option{-fpic} is @code{initial-exec}; with
13229@option{-fpic} the default is @code{global-dynamic}.
d7afec4b
ND
13230
13231@item -fvisibility=@var{default|internal|hidden|protected}
13232@opindex fvisibility
78466c0e 13233Set the default ELF image symbol visibility to the specified option---all
27ef2cdd 13234symbols will be marked with this unless overridden within the code.
d7afec4b 13235Using this feature can very substantially improve linking and
27ef2cdd 13236load times of shared object libraries, produce more optimized
d7afec4b
ND
13237code, provide near-perfect API export and prevent symbol clashes.
13238It is @strong{strongly} recommended that you use this in any shared objects
13239you distribute.
f0eb93a8 13240
d7afec4b
ND
13241Despite the nomenclature, @code{default} always means public ie;
13242available to be linked against from outside the shared object.
13243@code{protected} and @code{internal} are pretty useless in real-world
13244usage so the only other commonly used option will be @code{hidden}.
78466c0e
JM
13245The default if @option{-fvisibility} isn't specified is
13246@code{default}, i.e., make every
13247symbol public---this causes the same behavior as previous versions of
8a36672b 13248GCC@.
f0eb93a8 13249
d7afec4b
ND
13250A good explanation of the benefits offered by ensuring ELF
13251symbols have the correct visibility is given by ``How To Write
13252Shared Libraries'' by Ulrich Drepper (which can be found at
78466c0e 13253@w{@uref{http://people.redhat.com/~drepper/}})---however a superior
d7afec4b
ND
13254solution made possible by this option to marking things hidden when
13255the default is public is to make the default hidden and mark things
8a36672b 13256public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
d7afec4b
ND
13257and @code{__attribute__ ((visibility("default")))} instead of
13258@code{__declspec(dllexport)} you get almost identical semantics with
8a36672b 13259identical syntax. This is a great boon to those working with
d7afec4b
ND
13260cross-platform projects.
13261
13262For those adding visibility support to existing code, you may find
8a36672b 13263@samp{#pragma GCC visibility} of use. This works by you enclosing
d7afec4b
ND
13264the declarations you wish to set visibility for with (for example)
13265@samp{#pragma GCC visibility push(hidden)} and
be1b1c9b
L
13266@samp{#pragma GCC visibility pop}.
13267Bear in mind that symbol visibility should be viewed @strong{as
d7afec4b
ND
13268part of the API interface contract} and thus all new code should
13269always specify visibility when it is not the default ie; declarations
13270only for use within the local DSO should @strong{always} be marked explicitly
78466c0e 13271as hidden as so to avoid PLT indirection overheads---making this
d7afec4b
ND
13272abundantly clear also aids readability and self-documentation of the code.
13273Note that due to ISO C++ specification requirements, operator new and
13274operator delete must always be of default visibility.
13275
ce84fa41
DP
13276An overview of these techniques, their benefits and how to use them
13277is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13278
74291a4b
MM
13279@end table
13280
ee457005
JM
13281@c man end
13282
74291a4b 13283@node Environment Variables
0c2d1a2a 13284@section Environment Variables Affecting GCC
74291a4b
MM
13285@cindex environment variables
13286
ee457005 13287@c man begin ENVIRONMENT
0c2d1a2a
JB
13288This section describes several environment variables that affect how GCC
13289operates. Some of them work by specifying directories or prefixes to use
767094dd 13290when searching for various kinds of files. Some are used to specify other
46103ab4 13291aspects of the compilation environment.
74291a4b 13292
74291a4b 13293Note that you can also specify places to search using options such as
630d3d5a 13294@option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
74291a4b 13295take precedence over places specified using environment variables, which
161d7b59 13296in turn take precedence over those specified by the configuration of GCC@.
b11cc610
JM
13297@xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13298GNU Compiler Collection (GCC) Internals}.
74291a4b 13299
bedc7537 13300@table @env
ab87f8c8
JL
13301@item LANG
13302@itemx LC_CTYPE
13303@c @itemx LC_COLLATE
13304@itemx LC_MESSAGES
13305@c @itemx LC_MONETARY
13306@c @itemx LC_NUMERIC
13307@c @itemx LC_TIME
13308@itemx LC_ALL
13309@findex LANG
13310@findex LC_CTYPE
13311@c @findex LC_COLLATE
13312@findex LC_MESSAGES
13313@c @findex LC_MONETARY
13314@c @findex LC_NUMERIC
13315@c @findex LC_TIME
13316@findex LC_ALL
13317@cindex locale
0c2d1a2a
JB
13318These environment variables control the way that GCC uses
13319localization information that allow GCC to work with different
13320national conventions. GCC inspects the locale categories
bedc7537 13321@env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
ab87f8c8 13322so. These locale categories can be set to any value supported by your
0e6d31fb
JM
13323installation. A typical value is @samp{en_GB.UTF-8} for English in the United
13324Kingdom encoded in UTF-8.
ab87f8c8 13325
bedc7537 13326The @env{LC_CTYPE} environment variable specifies character
0c2d1a2a 13327classification. GCC uses it to determine the character boundaries in
ab87f8c8
JL
13328a string; this is needed for some multibyte encodings that contain quote
13329and escape characters that would otherwise be interpreted as a string
13330end or escape.
13331
bedc7537 13332The @env{LC_MESSAGES} environment variable specifies the language to
ab87f8c8
JL
13333use in diagnostic messages.
13334
bedc7537
NC
13335If the @env{LC_ALL} environment variable is set, it overrides the value
13336of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13337and @env{LC_MESSAGES} default to the value of the @env{LANG}
0c2d1a2a 13338environment variable. If none of these variables are set, GCC
ab87f8c8
JL
13339defaults to traditional C English behavior.
13340
74291a4b
MM
13341@item TMPDIR
13342@findex TMPDIR
bedc7537 13343If @env{TMPDIR} is set, it specifies the directory to use for temporary
0c2d1a2a 13344files. GCC uses temporary files to hold the output of one stage of
74291a4b
MM
13345compilation which is to be used as input to the next stage: for example,
13346the output of the preprocessor, which is the input to the compiler
13347proper.
13348
13349@item GCC_EXEC_PREFIX
13350@findex GCC_EXEC_PREFIX
bedc7537 13351If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
74291a4b
MM
13352names of the subprograms executed by the compiler. No slash is added
13353when this prefix is combined with the name of a subprogram, but you can
13354specify a prefix that ends with a slash if you wish.
13355
f0523f02 13356If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
0deb20df
TT
13357an appropriate prefix to use based on the pathname it was invoked with.
13358
0c2d1a2a 13359If GCC cannot find the subprogram using the specified prefix, it
74291a4b
MM
13360tries looking in the usual places for the subprogram.
13361
bedc7537 13362The default value of @env{GCC_EXEC_PREFIX} is
8e5f33ff 13363@file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
74291a4b
MM
13364of @code{prefix} when you ran the @file{configure} script.
13365
630d3d5a 13366Other prefixes specified with @option{-B} take precedence over this prefix.
74291a4b
MM
13367
13368This prefix is also used for finding files such as @file{crt0.o} that are
13369used for linking.
13370
13371In addition, the prefix is used in an unusual way in finding the
13372directories to search for header files. For each of the standard
8e5f33ff 13373directories whose name normally begins with @samp{/usr/local/lib/gcc}
bedc7537 13374(more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
74291a4b 13375replacing that beginning with the specified prefix to produce an
630d3d5a 13376alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
74291a4b
MM
13377@file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13378These alternate directories are searched first; the standard directories
13379come next.
13380
13381@item COMPILER_PATH
13382@findex COMPILER_PATH
bedc7537
NC
13383The value of @env{COMPILER_PATH} is a colon-separated list of
13384directories, much like @env{PATH}. GCC tries the directories thus
74291a4b 13385specified when searching for subprograms, if it can't find the
bedc7537 13386subprograms using @env{GCC_EXEC_PREFIX}.
74291a4b
MM
13387
13388@item LIBRARY_PATH
13389@findex LIBRARY_PATH
bedc7537
NC
13390The value of @env{LIBRARY_PATH} is a colon-separated list of
13391directories, much like @env{PATH}. When configured as a native compiler,
0c2d1a2a 13392GCC tries the directories thus specified when searching for special
bedc7537 13393linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
0c2d1a2a 13394using GCC also uses these directories when searching for ordinary
630d3d5a
JM
13395libraries for the @option{-l} option (but directories specified with
13396@option{-L} come first).
74291a4b 13397
56f48ce9
DB
13398@item LANG
13399@findex LANG
13400@cindex locale definition
767094dd 13401This variable is used to pass locale information to the compiler. One way in
56f48ce9
DB
13402which this information is used is to determine the character set to be used
13403when character literals, string literals and comments are parsed in C and C++.
13404When the compiler is configured to allow multibyte characters,
bedc7537 13405the following values for @env{LANG} are recognized:
56f48ce9 13406
2642624b 13407@table @samp
56f48ce9
DB
13408@item C-JIS
13409Recognize JIS characters.
13410@item C-SJIS
13411Recognize SJIS characters.
13412@item C-EUCJP
13413Recognize EUCJP characters.
13414@end table
13415
bedc7537 13416If @env{LANG} is not defined, or if it has some other value, then the
56f48ce9
DB
13417compiler will use mblen and mbtowc as defined by the default locale to
13418recognize and translate multibyte characters.
74291a4b
MM
13419@end table
13420
40adaa27
NB
13421@noindent
13422Some additional environments variables affect the behavior of the
13423preprocessor.
13424
13425@include cppenv.texi
13426
9d86bffc
JM
13427@c man end
13428
17211ab5
GK
13429@node Precompiled Headers
13430@section Using Precompiled Headers
13431@cindex precompiled headers
13432@cindex speed of compilation
13433
13434Often large projects have many header files that are included in every
13435source file. The time the compiler takes to process these header files
13436over and over again can account for nearly all of the time required to
13437build the project. To make builds faster, GCC allows users to
13438`precompile' a header file; then, if builds can use the precompiled
13439header file they will be much faster.
13440
13441To create a precompiled header file, simply compile it as you would any
13442other file, if necessary using the @option{-x} option to make the driver
13443treat it as a C or C++ header file. You will probably want to use a
13444tool like @command{make} to keep the precompiled header up-to-date when
13445the headers it contains change.
13446
13447A precompiled header file will be searched for when @code{#include} is
13448seen in the compilation. As it searches for the included file
24726b96 13449(@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17211ab5
GK
13450compiler looks for a precompiled header in each directory just before it
13451looks for the include file in that directory. The name searched for is
d8fad4ea 13452the name specified in the @code{#include} with @samp{.gch} appended. If
17211ab5
GK
13453the precompiled header file can't be used, it is ignored.
13454
13455For instance, if you have @code{#include "all.h"}, and you have
d8fad4ea 13456@file{all.h.gch} in the same directory as @file{all.h}, then the
17211ab5
GK
13457precompiled header file will be used if possible, and the original
13458header will be used otherwise.
13459
13460Alternatively, you might decide to put the precompiled header file in a
13461directory and use @option{-I} to ensure that directory is searched
13462before (or instead of) the directory containing the original header.
13463Then, if you want to check that the precompiled header file is always
13464used, you can put a file of the same name as the original header in this
13465directory containing an @code{#error} command.
13466
13467This also works with @option{-include}. So yet another way to use
13468precompiled headers, good for projects not designed with precompiled
13469header files in mind, is to simply take most of the header files used by
13470a project, include them from another header file, precompile that header
13471file, and @option{-include} the precompiled header. If the header files
13472have guards against multiple inclusion, they will be skipped because
13473they've already been included (in the precompiled header).
13474
13475If you need to precompile the same header file for different
13476languages, targets, or compiler options, you can instead make a
d8fad4ea 13477@emph{directory} named like @file{all.h.gch}, and put each precompiled
54e109ed
GK
13478header in the directory, perhaps using @option{-o}. It doesn't matter
13479what you call the files in the directory, every precompiled header in
13480the directory will be considered. The first precompiled header
13481encountered in the directory that is valid for this compilation will
13482be used; they're searched in no particular order.
17211ab5
GK
13483
13484There are many other possibilities, limited only by your imagination,
13485good sense, and the constraints of your build system.
13486
13487A precompiled header file can be used only when these conditions apply:
13488
13489@itemize
13490@item
13491Only one precompiled header can be used in a particular compilation.
54e109ed 13492
17211ab5
GK
13493@item
13494A precompiled header can't be used once the first C token is seen. You
13495can have preprocessor directives before a precompiled header; you can
13496even include a precompiled header from inside another header, so long as
13497there are no C tokens before the @code{#include}.
54e109ed 13498
17211ab5
GK
13499@item
13500The precompiled header file must be produced for the same language as
13501the current compilation. You can't use a C precompiled header for a C++
13502compilation.
54e109ed 13503
17211ab5 13504@item
3fd30b88
GK
13505The precompiled header file must have been produced by the same compiler
13506binary as the current compilation is using.
54e109ed 13507
17211ab5 13508@item
54e109ed
GK
13509Any macros defined before the precompiled header is included must
13510either be defined in the same way as when the precompiled header was
13511generated, or must not affect the precompiled header, which usually
0bdcd332 13512means that they don't appear in the precompiled header at all.
54e109ed
GK
13513
13514The @option{-D} option is one way to define a macro before a
13515precompiled header is included; using a @code{#define} can also do it.
13516There are also some options that define macros implicitly, like
13517@option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13518defined this way.
13519
13520@item If debugging information is output when using the precompiled
13521header, using @option{-g} or similar, the same kind of debugging information
13522must have been output when building the precompiled header. However,
13523a precompiled header built using @option{-g} can be used in a compilation
13524when no debugging information is being output.
13525
13526@item The same @option{-m} options must generally be used when building
13527and using the precompiled header. @xref{Submodel Options},
13528for any cases where this rule is relaxed.
13529
13530@item Each of the following options must be the same when building and using
13531the precompiled header:
13532
13533@gccoptlist{-fexceptions -funit-at-a-time}
13534
17211ab5 13535@item
54e109ed
GK
13536Some other command-line options starting with @option{-f},
13537@option{-p}, or @option{-O} must be defined in the same way as when
13538the precompiled header was generated. At present, it's not clear
13539which options are safe to change and which are not; the safest choice
13540is to use exactly the same options when generating and using the
13541precompiled header. The following are known to be safe:
13542
17ccdd2c 13543@gccoptlist{-fmessage-length= -fpreprocessed
3fd30b88 13544-fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
17ccdd2c 13545-fsched-verbose=<number> -fschedule-insns -fvisibility=
3fd30b88 13546-pedantic-errors}
54e109ed 13547
17211ab5
GK
13548@end itemize
13549
54e109ed
GK
13550For all of these except the last, the compiler will automatically
13551ignore the precompiled header if the conditions aren't met. If you
13552find an option combination that doesn't work and doesn't cause the
13553precompiled header to be ignored, please consider filing a bug report,
13554see @ref{Bugs}.
17211ab5 13555
c0d578e6 13556If you do use differing options when generating and using the
83c99486
KH
13557precompiled header, the actual behavior will be a mixture of the
13558behavior for the options. For instance, if you use @option{-g} to
c0d578e6
GK
13559generate the precompiled header but not when using it, you may or may
13560not get debugging information for routines in the precompiled header.
13561
74291a4b
MM
13562@node Running Protoize
13563@section Running Protoize
13564
161d7b59 13565The program @code{protoize} is an optional part of GCC@. You can use
c1030c7c 13566it to add prototypes to a program, thus converting the program to ISO
74291a4b
MM
13567C in one respect. The companion program @code{unprotoize} does the
13568reverse: it removes argument types from any prototypes that are found.
13569
13570When you run these programs, you must specify a set of source files as
13571command line arguments. The conversion programs start out by compiling
13572these files to see what functions they define. The information gathered
13573about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13574
13575After scanning comes actual conversion. The specified files are all
13576eligible to be converted; any files they include (whether sources or
13577just headers) are eligible as well.
13578
13579But not all the eligible files are converted. By default,
13580@code{protoize} and @code{unprotoize} convert only source and header
13581files in the current directory. You can specify additional directories
630d3d5a 13582whose files should be converted with the @option{-d @var{directory}}
74291a4b 13583option. You can also specify particular files to exclude with the
630d3d5a 13584@option{-x @var{file}} option. A file is converted if it is eligible, its
74291a4b
MM
13585directory name matches one of the specified directory names, and its
13586name within the directory has not been excluded.
13587
13588Basic conversion with @code{protoize} consists of rewriting most
13589function definitions and function declarations to specify the types of
13590the arguments. The only ones not rewritten are those for varargs
13591functions.
13592
13593@code{protoize} optionally inserts prototype declarations at the
13594beginning of the source file, to make them available for any calls that
13595precede the function's definition. Or it can insert prototype
13596declarations with block scope in the blocks where undeclared functions
13597are called.
13598
13599Basic conversion with @code{unprotoize} consists of rewriting most
13600function declarations to remove any argument types, and rewriting
c1030c7c 13601function definitions to the old-style pre-ISO form.
74291a4b
MM
13602
13603Both conversion programs print a warning for any function declaration or
13604definition that they can't convert. You can suppress these warnings
630d3d5a 13605with @option{-q}.
74291a4b
MM
13606
13607The output from @code{protoize} or @code{unprotoize} replaces the
13608original source file. The original file is renamed to a name ending
02f52e19 13609with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
a7db8bbb
MK
13610without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
13611for DOS) file already exists, then the source file is simply discarded.
74291a4b 13612
0c2d1a2a 13613@code{protoize} and @code{unprotoize} both depend on GCC itself to
74291a4b 13614scan the program and collect information about the functions it uses.
0c2d1a2a 13615So neither of these programs will work until GCC is installed.
74291a4b
MM
13616
13617Here is a table of the options you can use with @code{protoize} and
13618@code{unprotoize}. Each option works with both programs unless
13619otherwise stated.
13620
13621@table @code
13622@item -B @var{directory}
13623Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13624usual directory (normally @file{/usr/local/lib}). This file contains
13625prototype information about standard system functions. This option
13626applies only to @code{protoize}.
13627
13628@item -c @var{compilation-options}
05739753 13629Use @var{compilation-options} as the options when running @command{gcc} to
630d3d5a 13630produce the @samp{.X} files. The special option @option{-aux-info} is
05739753 13631always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
74291a4b
MM
13632
13633Note that the compilation options must be given as a single argument to
13634@code{protoize} or @code{unprotoize}. If you want to specify several
05739753 13635@command{gcc} options, you must quote the entire set of compilation options
74291a4b
MM
13636to make them a single word in the shell.
13637
05739753 13638There are certain @command{gcc} arguments that you cannot use, because they
630d3d5a
JM
13639would produce the wrong kind of output. These include @option{-g},
13640@option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
74291a4b
MM
13641the @var{compilation-options}, they are ignored.
13642
13643@item -C
a7db8bbb 13644Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
02f52e19 13645systems) instead of @samp{.c}. This is convenient if you are converting
ee77eda5 13646a C program to C++. This option applies only to @code{protoize}.
74291a4b
MM
13647
13648@item -g
13649Add explicit global declarations. This means inserting explicit
13650declarations at the beginning of each source file for each function
13651that is called in the file and was not declared. These declarations
13652precede the first function definition that contains a call to an
13653undeclared function. This option applies only to @code{protoize}.
13654
13655@item -i @var{string}
13656Indent old-style parameter declarations with the string @var{string}.
13657This option applies only to @code{protoize}.
13658
13659@code{unprotoize} converts prototyped function definitions to old-style
13660function definitions, where the arguments are declared between the
13661argument list and the initial @samp{@{}. By default, @code{unprotoize}
13662uses five spaces as the indentation. If you want to indent with just
630d3d5a 13663one space instead, use @option{-i " "}.
74291a4b
MM
13664
13665@item -k
13666Keep the @samp{.X} files. Normally, they are deleted after conversion
13667is finished.
13668
13669@item -l
630d3d5a 13670Add explicit local declarations. @code{protoize} with @option{-l} inserts
74291a4b
MM
13671a prototype declaration for each function in each block which calls the
13672function without any declaration. This option applies only to
13673@code{protoize}.
13674
13675@item -n
13676Make no real changes. This mode just prints information about the conversions
630d3d5a 13677that would have been done without @option{-n}.
74291a4b
MM
13678
13679@item -N
13680Make no @samp{.save} files. The original files are simply deleted.
13681Use this option with caution.
13682
13683@item -p @var{program}
13684Use the program @var{program} as the compiler. Normally, the name
13685@file{gcc} is used.
13686
13687@item -q
13688Work quietly. Most warnings are suppressed.
13689
13690@item -v
05739753 13691Print the version number, just like @option{-v} for @command{gcc}.
74291a4b
MM
13692@end table
13693
13694If you need special compiler options to compile one of your program's
13695source files, then you should generate that file's @samp{.X} file
05739753 13696specially, by running @command{gcc} on that source file with the
630d3d5a 13697appropriate options and the option @option{-aux-info}. Then run
74291a4b
MM
13698@code{protoize} on the entire set of files. @code{protoize} will use
13699the existing @samp{.X} file because it is newer than the source file.
13700For example:
13701
3ab51846 13702@smallexample
b1018de6 13703gcc -Dfoo=bar file1.c -aux-info file1.X
74291a4b 13704protoize *.c
3ab51846 13705@end smallexample
74291a4b
MM
13706
13707@noindent
13708You need to include the special files along with the rest in the
13709@code{protoize} command, even though their @samp{.X} files already
13710exist, because otherwise they won't get converted.
13711
13712@xref{Protoize Caveats}, for more information on how to use
13713@code{protoize} successfully.