]> gcc.gnu.org Git - gcc.git/blame - gcc/doc/invoke.texi
cpplib.h (struct cpp_options): New member, warn_endif_labels.
[gcc.git] / gcc / doc / invoke.texi
CommitLineData
d0a5eb32 1@c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4dd57c18 2@c 2000, 2001, 2002 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
JM
6@ignore
7@c man begin COPYRIGHT
8Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
4dd57c18 91998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
9d86bffc 10
77bd67cb
JM
11Permission is granted to copy, distribute and/or modify this document
12under the terms of the GNU Free Documentation License, Version 1.1 or
13any later version published by the Free Software Foundation; with the
14Invariant Sections being ``GNU General Public License'' and ``Funding
15Free Software'', the Front-Cover texts being (a) (see below), and with
16the Back-Cover Texts being (b) (see below). A copy of the license is
17included in the gfdl(7) man page.
9d86bffc 18
77bd67cb 19(a) The FSF's Front-Cover Text is:
9d86bffc 20
77bd67cb
JM
21 A GNU Manual
22
23(b) The FSF's Back-Cover Text is:
24
25 You have freedom to copy and modify this GNU Manual, like GNU
26 software. Copies published by the Free Software Foundation raise
27 funds for GNU development.
9d86bffc
JM
28@c man end
29@c Set file name and title for the man page.
30@setfilename gcc
31@settitle GNU project C and C++ compiler
32@c man begin SYNOPSIS
630d3d5a
JM
33gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39 [@option{-o} @var{outfile}] @var{infile}@dots{}
9d86bffc
JM
40
41Only the most useful options are listed here; see below for the
42remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
43@c man end
44@c man begin SEEALSO
77bd67cb 45gpl(7), gfdl(7), fsf-funding(7),
9d86bffc
JM
46cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48@file{ld}, @file{binutils} and @file{gdb}.
49@c man end
2642624b
JM
50@c man begin BUGS
51For instructions on reporting bugs, see
bedc7537 52@w{@uref{http://gcc.gnu.org/bugs.html}}. Use of the @command{gccbug}
2642624b
JM
53script to report bugs is recommended.
54@c man end
55@c man begin AUTHOR
24dbb440
GP
56See the Info entry for @command{gcc}, or
57@w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58for contributors to GCC@.
2642624b 59@c man end
9d86bffc
JM
60@end ignore
61
74291a4b 62@node Invoking GCC
0c2d1a2a
JB
63@chapter GCC Command Options
64@cindex GCC command options
74291a4b 65@cindex command options
0c2d1a2a 66@cindex options, GCC command
74291a4b 67
9d86bffc
JM
68@c man begin DESCRIPTION
69
0c2d1a2a 70When you invoke GCC, it normally does preprocessing, compilation,
74291a4b 71assembly and linking. The ``overall options'' allow you to stop this
630d3d5a 72process at an intermediate stage. For example, the @option{-c} option
74291a4b
MM
73says not to run the linker. Then the output consists of object files
74output by the assembler.
75
76Other options are passed on to one stage of processing. Some options
77control the preprocessor and others the compiler itself. Yet other
78options control the assembler and linker; most of these are not
79documented here, since you rarely need to use any of them.
80
81@cindex C compilation options
0c2d1a2a 82Most of the command line options that you can use with GCC are useful
74291a4b
MM
83for C programs; when an option is only useful with another language
84(usually C++), the explanation says so explicitly. If the description
85for a particular option does not mention a source language, you can use
86that option with all supported languages.
87
88@cindex C++ compilation options
89@xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90options for compiling C++ programs.
91
92@cindex grouping options
93@cindex options, grouping
bedc7537 94The @command{gcc} program accepts options and file names as operands. Many
b192711e 95options have multi-letter names; therefore multiple single-letter options
630d3d5a 96may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
74291a4b
MM
97-r}}.
98
99@cindex order of options
100@cindex options, order
101You can mix options and other arguments. For the most part, the order
102you use doesn't matter. Order does matter when you use several options
630d3d5a 103of the same kind; for example, if you specify @option{-L} more than once,
74291a4b
MM
104the directories are searched in the order specified.
105
106Many options have long names starting with @samp{-f} or with
630d3d5a
JM
107@samp{-W}---for example, @option{-fforce-mem},
108@option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
74291a4b 109these have both positive and negative forms; the negative form of
630d3d5a 110@option{-ffoo} would be @option{-fno-foo}. This manual documents
74291a4b
MM
111only one of these two forms, whichever one is not the default.
112
9d86bffc
JM
113@c man end
114
cd3bb277
JM
115@xref{Option Index}, for an index to GCC's options.
116
74291a4b
MM
117@menu
118* Option Summary:: Brief list of all options, without explanations.
119* Overall Options:: Controlling the kind of output:
120 an executable, object files, assembler files,
121 or preprocessed source.
122* Invoking G++:: Compiling C++ programs.
123* C Dialect Options:: Controlling the variant of C language compiled.
124* C++ Dialect Options:: Variations on C++.
60de6385 125* Objective-C Dialect Options:: Variations on Objective-C.
764dbbf2 126* Language Independent Options:: Controlling how diagnostics should be
02f52e19 127 formatted.
74291a4b
MM
128* Warning Options:: How picky should the compiler be?
129* Debugging Options:: Symbol tables, measurements, and debugging dumps.
130* Optimize Options:: How much optimization?
131* Preprocessor Options:: Controlling header files and macro definitions.
132 Also, getting dependency information for Make.
133* Assembler Options:: Passing options to the assembler.
134* Link Options:: Specifying libraries and so on.
135* Directory Options:: Where to find header files and libraries.
136 Where to find the compiler executable files.
a743d340 137* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 138* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
139* Submodel Options:: Specifying minor hardware or convention variations,
140 such as 68010 vs 68020.
141* Code Gen Options:: Specifying conventions for function calls, data layout
142 and register usage.
0c2d1a2a 143* Environment Variables:: Env vars that affect GCC.
74291a4b
MM
144* Running Protoize:: Automatically adding or removing function prototypes.
145@end menu
146
4bc1997b
JM
147@c man begin OPTIONS
148
74291a4b
MM
149@node Option Summary
150@section Option Summary
151
152Here is a summary of all the options, grouped by type. Explanations are
153in the following sections.
154
155@table @emph
156@item Overall Options
157@xref{Overall Options,,Options Controlling the Kind of Output}.
4bc1997b
JM
158@gccoptlist{
159-c -S -E -o @var{file} -pipe -pass-exit-codes -x @var{language} @gol
e8b3c8ac 160-v -### --target-help --help}
74291a4b
MM
161
162@item C Language Options
163@xref{C Dialect Options,,Options Controlling C Dialect}.
4bc1997b 164@gccoptlist{
b1018de6 165-ansi -std=@var{standard} -aux-info @var{filename} @gol
7d14c755 166-fno-asm -fno-builtin -fno-builtin-@var{function} @gol
4bc1997b
JM
167-fhosted -ffreestanding @gol
168-trigraphs -traditional -traditional-cpp @gol
169-fallow-single-precision -fcond-mismatch @gol
170-fsigned-bitfields -fsigned-char @gol
171-funsigned-bitfields -funsigned-char @gol
172-fwritable-strings -fshort-wchar}
74291a4b
MM
173
174@item C++ Language Options
175@xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
4bc1997b
JM
176@gccoptlist{
177-fno-access-control -fcheck-new -fconserve-space @gol
aa0cc562
JM
178-fno-const-strings -fdollars-in-identifiers @gol
179-fno-elide-constructors @gol
4bc1997b
JM
180-fno-enforce-eh-specs -fexternal-templates @gol
181-falt-external-templates @gol
1dbb6023 182-ffor-scope -fno-for-scope -fno-gnu-keywords @gol
90ecce3e 183-fno-implicit-templates @gol
4bc1997b
JM
184-fno-implicit-inline-templates @gol
185-fno-implement-inlines -fms-extensions @gol
aa0cc562 186-fno-nonansi-builtins -fno-operator-names @gol
4bc1997b 187-fno-optional-diags -fpermissive @gol
aa0cc562 188-frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
90ecce3e 189-fuse-cxa-atexit -fvtable-gc -fno-weak -nostdinc++ @gol
4bc1997b
JM
190-fno-default-inline -Wctor-dtor-privacy @gol
191-Wnon-virtual-dtor -Wreorder @gol
192-Weffc++ -Wno-deprecated @gol
193-Wno-non-template-friend -Wold-style-cast @gol
194-Woverloaded-virtual -Wno-pmf-conversions @gol
195-Wsign-promo -Wsynth}
74291a4b 196
60de6385
SS
197@item Objective-C Language Options
198@xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
199@gccoptlist{
630d3d5a 200-fconstant-string-class=@var{class-name} @gol
310668e8 201-fgnu-runtime -fnext-runtime -gen-decls @gol
60de6385
SS
202-Wno-protocol -Wselector}
203
764dbbf2
GDR
204@item Language Independent Options
205@xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
4bc1997b
JM
206@gccoptlist{
207-fmessage-length=@var{n} @gol
208-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
764dbbf2 209
74291a4b
MM
210@item Warning Options
211@xref{Warning Options,,Options to Request or Suppress Warnings}.
4bc1997b
JM
212@gccoptlist{
213-fsyntax-only -pedantic -pedantic-errors @gol
214-w -W -Wall -Waggregate-return @gol
215-Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
e23bd218 216-Wconversion -Wno-deprecated-declarations @gol
75227a33 217-Wdisabled-optimization -Wno-div-by-zero -Werror @gol
4bc1997b 218-Wfloat-equal -Wformat -Wformat=2 @gol
feb48bde
JM
219-Wformat-nonliteral -Wformat-security @gol
220-Wimplicit -Wimplicit-int @gol
4bc1997b
JM
221-Wimplicit-function-declaration @gol
222-Werror-implicit-function-declaration @gol
909de5da 223-Wimport -Winline -Wno-endif-labels @gol
4bc1997b 224-Wlarger-than-@var{len} -Wlong-long @gol
1f0c3120 225-Wmain -Wmissing-braces -Wmissing-declarations @gol
4bc1997b 226-Wmissing-format-attribute -Wmissing-noreturn @gol
75227a33 227-Wno-multichar -Wno-format-extra-args -Wno-format-y2k @gol
4bc1997b 228-Wno-import -Wpacked -Wpadded @gol
310668e8 229-Wparentheses -Wpointer-arith -Wredundant-decls @gol
4bc1997b
JM
230-Wreturn-type -Wsequence-point -Wshadow @gol
231-Wsign-compare -Wswitch -Wsystem-headers @gol
232-Wtrigraphs -Wundef -Wuninitialized @gol
233-Wunknown-pragmas -Wunreachable-code @gol
234-Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
235-Wunused-value -Wunused-variable -Wwrite-strings}
74291a4b 236
fe50c0eb 237@item C-only Warning Options
4bc1997b 238@gccoptlist{
310668e8
JM
239-Wbad-function-cast -Wmissing-prototypes -Wnested-externs @gol
240-Wstrict-prototypes -Wtraditional}
fe50c0eb 241
74291a4b
MM
242@item Debugging Options
243@xref{Debugging Options,,Options for Debugging Your Program or GCC}.
4bc1997b 244@gccoptlist{
8456b95a 245-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
f70a54cb 246-fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
aee96fe9 247-fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
22367161
NS
248-fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
249-fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
ba31d94e 250-fmem-report @gol
1f0c3120 251-fprofile-arcs -ftest-coverage -ftime-report @gol
4bc1997b 252-g -g@var{level} -gcoff -gdwarf -gdwarf-1 -gdwarf-1+ -gdwarf-2 @gol
5f98259a 253-ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
4bc1997b 254-p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
b1018de6 255-print-multi-directory -print-multi-lib @gol
4bc1997b
JM
256-print-prog-name=@var{program} -print-search-dirs -Q @gol
257-save-temps -time}
74291a4b
MM
258
259@item Optimization Options
260@xref{Optimize Options,,Options that Control Optimization}.
4bc1997b
JM
261@gccoptlist{
262-falign-functions=@var{n} -falign-jumps=@var{n} @gol
263-falign-labels=@var{n} -falign-loops=@var{n} @gol
8582c27b 264-fbranch-probabilities -fcaller-saves -fcprop-registers @gol
62d285ff 265-fcse-follow-jumps -fcse-skip-blocks -fdata-sections @gol
4bc1997b
JM
266-fdelayed-branch -fdelete-null-pointer-checks @gol
267-fexpensive-optimizations -ffast-math -ffloat-store @gol
feb48bde 268-fforce-addr -fforce-mem -ffunction-sections @gol
96327cdc 269-fgcse -fgcse-lm -fgcse-sm -floop-optimize -fcrossjumping @gol
4bc1997b 270-finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
201556f0
JJ
271-fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
272-fmove-all-movables -fno-default-inline -fno-defer-pop @gol
feb48bde 273-fno-function-cse -fno-guess-branch-probability @gol
6cfc0341 274-fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
de6c5979 275-funsafe-math-optimizations -fno-trapping-math @gol
27b41650 276-fno-zero-initialized-in-bss @gol
4bc1997b 277-fomit-frame-pointer -foptimize-register-move @gol
5d22c1a5
JM
278-foptimize-sibling-calls -fprefetch-loop-arrays @gol
279-freduce-all-givs -fregmove -frename-registers @gol
4bc1997b
JM
280-frerun-cse-after-loop -frerun-loop-opt @gol
281-fschedule-insns -fschedule-insns2 @gol
0b47e4c1 282-fsingle-precision-constant -fssa -fssa-ccp -fssa-dce @gol
4bc1997b 283-fstrength-reduce -fstrict-aliasing -fthread-jumps -ftrapv @gol
86be733d 284-funroll-all-loops -funroll-loops @gol
3af64fd6 285--param @var{name}=@var{value}
4bc1997b 286-O -O0 -O1 -O2 -O3 -Os}
74291a4b
MM
287
288@item Preprocessor Options
289@xref{Preprocessor Options,,Options Controlling the Preprocessor}.
4bc1997b
JM
290@gccoptlist{
291-$ -A@var{question}=@var{answer} -A-@var{question}@r{[}=@var{answer}@r{]} @gol
292-C -dD -dI -dM -dN @gol
293-D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
294-idirafter @var{dir} @gol
295-include @var{file} -imacros @var{file} @gol
296-iprefix @var{file} -iwithprefix @var{dir} @gol
bdd42dd9 297-iwithprefixbefore @var{dir} -isystem @var{dir} @gol
4bc1997b 298-M -MM -MF -MG -MP -MQ -MT -nostdinc -P -remap @gol
aee96fe9 299-trigraphs -undef -U@var{macro} -Wp,@var{option}}
74291a4b
MM
300
301@item Assembler Option
302@xref{Assembler Options,,Passing Options to the Assembler}.
4bc1997b 303@gccoptlist{
aee96fe9 304-Wa,@var{option}}
74291a4b
MM
305
306@item Linker Options
307@xref{Link Options,,Options for Linking}.
4bc1997b
JM
308@gccoptlist{
309@var{object-file-name} -l@var{library} @gol
310-nostartfiles -nodefaultlibs -nostdlib @gol
311-s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
aee96fe9 312-Wl,@var{option} -Xlinker @var{option} @gol
4bc1997b 313-u @var{symbol}}
74291a4b
MM
314
315@item Directory Options
316@xref{Directory Options,,Options for Directory Search}.
4bc1997b
JM
317@gccoptlist{
318-B@var{prefix} -I@var{dir} -I- -L@var{dir} -specs=@var{file}}
74291a4b
MM
319
320@item Target Options
321@c I wrote this xref this way to avoid overfull hbox. -- rms
322@xref{Target Options}.
4bc1997b
JM
323@gccoptlist{
324-b @var{machine} -V @var{version}}
74291a4b
MM
325
326@item Machine Dependent Options
327@xref{Submodel Options,,Hardware Models and Configurations}.
5d22c1a5 328
74291a4b 329@emph{M680x0 Options}
4bc1997b
JM
330@gccoptlist{
331-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
feb48bde 332-m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
310668e8
JM
333-mfpa -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
334-malign-int -mstrict-align}
74291a4b 335
2856c3e3 336@emph{M68hc1x Options}
4bc1997b
JM
337@gccoptlist{
338-m6811 -m6812 -m68hc11 -m68hc12 @gol
339-mauto-incdec -mshort -msoft-reg-count=@var{count}}
2856c3e3 340
74291a4b 341@emph{VAX Options}
4bc1997b
JM
342@gccoptlist{
343-mg -mgnu -munix}
74291a4b
MM
344
345@emph{SPARC Options}
4bc1997b 346@gccoptlist{
630d3d5a
JM
347-mcpu=@var{cpu-type} @gol
348-mtune=@var{cpu-type} @gol
349-mcmodel=@var{code-model} @gol
4bc1997b
JM
350-m32 -m64 @gol
351-mapp-regs -mbroken-saverestore -mcypress @gol
feb48bde 352-mepilogue -mfaster-structs -mflat @gol
4bc1997b
JM
353-mfpu -mhard-float -mhard-quad-float @gol
354-mimpure-text -mlive-g0 -mno-app-regs @gol
310668e8
JM
355-mno-epilogue -mno-faster-structs -mno-flat -mno-fpu @gol
356-mno-impure-text -mno-stack-bias -mno-unaligned-doubles @gol
4bc1997b
JM
357-msoft-float -msoft-quad-float -msparclite -mstack-bias @gol
358-msupersparc -munaligned-doubles -mv8}
74291a4b
MM
359
360@emph{Convex Options}
4bc1997b
JM
361@gccoptlist{
362-mc1 -mc2 -mc32 -mc34 -mc38 @gol
363-margcount -mnoargcount @gol
364-mlong32 -mlong64 @gol
365-mvolatile-cache -mvolatile-nocache}
74291a4b
MM
366
367@emph{AMD29K Options}
4bc1997b
JM
368@gccoptlist{
369-m29000 -m29050 -mbw -mnbw -mdw -mndw @gol
370-mlarge -mnormal -msmall @gol
371-mkernel-registers -mno-reuse-arg-regs @gol
372-mno-stack-check -mno-storem-bug @gol
373-mreuse-arg-regs -msoft-float -mstack-check @gol
374-mstorem-bug -muser-registers}
74291a4b
MM
375
376@emph{ARM Options}
4bc1997b 377@gccoptlist{
310668e8
JM
378-mapcs-frame -mno-apcs-frame @gol
379-mapcs-26 -mapcs-32 @gol
380-mapcs-stack-check -mno-apcs-stack-check @gol
381-mapcs-float -mno-apcs-float @gol
382-mapcs-reentrant -mno-apcs-reentrant @gol
383-msched-prolog -mno-sched-prolog @gol
384-mlittle-endian -mbig-endian -mwords-little-endian @gol
385-malignment-traps -mno-alignment-traps @gol
386-msoft-float -mhard-float -mfpe @gol
387-mthumb-interwork -mno-thumb-interwork @gol
388-mcpu=@var{name} -march=@var{name} -mfpe=@var{name} @gol
247f8561 389-mstructure-size-boundary=@var{n} @gol
310668e8 390-mbsd -mxopen -mno-symrename @gol
4bc1997b 391-mabort-on-noreturn @gol
310668e8
JM
392-mlong-calls -mno-long-calls @gol
393-msingle-pic-base -mno-single-pic-base @gol
247f8561
PB
394-mpic-register=@var{reg} @gol
395-mnop-fun-dllimport @gol
396-mpoke-function-name @gol
310668e8
JM
397-mthumb -marm @gol
398-mtpcs-frame -mtpcs-leaf-frame @gol
399-mcaller-super-interworking -mcallee-super-interworking }
74291a4b 400
ecff22ab 401@emph{MN10200 Options}
4bc1997b
JM
402@gccoptlist{
403-mrelax}
ecff22ab 404
6d6d0fa0 405@emph{MN10300 Options}
4bc1997b 406@gccoptlist{
c474f76b
AO
407-mmult-bug -mno-mult-bug @gol
408-mam33 -mno-am33 @gol
409-mno-crt0 -mrelax}
6d6d0fa0 410
861bb6c1 411@emph{M32R/D Options}
4bc1997b 412@gccoptlist{
98180123 413-m32rx -m32r -mcode-model=@var{model-type} -msdata=@var{sdata-type} @gol
4bc1997b 414-G @var{num}}
861bb6c1 415
74291a4b 416@emph{M88K Options}
4bc1997b
JM
417@gccoptlist{
418-m88000 -m88100 -m88110 -mbig-pic @gol
419-mcheck-zero-division -mhandle-large-shift @gol
420-midentify-revision -mno-check-zero-division @gol
421-mno-ocs-debug-info -mno-ocs-frame-position @gol
422-mno-optimize-arg-area -mno-serialize-volatile @gol
423-mno-underscores -mocs-debug-info @gol
424-mocs-frame-position -moptimize-arg-area @gol
425-mserialize-volatile -mshort-data-@var{num} -msvr3 @gol
426-msvr4 -mtrap-large-shift -muse-div-instruction @gol
427-mversion-03.00 -mwarn-passed-structs}
74291a4b
MM
428
429@emph{RS/6000 and PowerPC Options}
4bc1997b 430@gccoptlist{
630d3d5a
JM
431-mcpu=@var{cpu-type} @gol
432-mtune=@var{cpu-type} @gol
4bc1997b
JM
433-mpower -mno-power -mpower2 -mno-power2 @gol
434-mpowerpc -mpowerpc64 -mno-powerpc @gol
0ac081f6 435-maltivec -mno-altivec @gol
4bc1997b
JM
436-mpowerpc-gpopt -mno-powerpc-gpopt @gol
437-mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
438-mnew-mnemonics -mold-mnemonics @gol
c50503ac 439-mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
0a379b7a 440-m64 -m32 -mxl-call -mno-xl-call -mpe @gol
4bc1997b
JM
441-msoft-float -mhard-float -mmultiple -mno-multiple @gol
442-mstring -mno-string -mupdate -mno-update @gol
443-mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
444-mstrict-align -mno-strict-align -mrelocatable @gol
445-mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
446-mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
9c34dbbf 447-mcall-aix -mcall-sysv -mcall-netbsd @gol
9904592e 448-maix-struct-return -msvr4-struct-return
76a773f3 449-mabi=altivec -mabi=no-altivec @gol
9c34dbbf 450-mprototype -mno-prototype @gol
4bc1997b 451-msim -mmvme -mads -myellowknife -memb -msdata @gol
0a379b7a 452-msdata=@var{opt} -mvxworks -G @var{num} -pthread}
74291a4b
MM
453
454@emph{RT Options}
4bc1997b
JM
455@gccoptlist{
456-mcall-lib-mul -mfp-arg-in-fpregs -mfp-arg-in-gregs @gol
457-mfull-fp-blocks -mhc-struct-return -min-line-mul @gol
458-mminimum-fp-blocks -mnohc-struct-return}
74291a4b
MM
459
460@emph{MIPS Options}
4bc1997b 461@gccoptlist{
7dac2f89
EC
462-mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
463-mcpu=@var{cpu-type} -membedded-data -muninit-const-in-rodata @gol
13fac94a
GK
464-membedded-pic -mfp32 -mfp64 -mfused-madd -mno-fused-madd @gol
465-mgas -mgp32 -mgp64 @gol
4bc1997b 466-mgpopt -mhalf-pic -mhard-float -mint64 -mips1 @gol
feb48bde 467-mips2 -mips3 -mips4 -mlong64 -mlong32 -mlong-calls -mmemcpy @gol
4bc1997b 468-mmips-as -mmips-tfile -mno-abicalls @gol
feb48bde
JM
469-mno-embedded-data -mno-uninit-const-in-rodata @gol
470-mno-embedded-pic -mno-gpopt -mno-long-calls @gol
4bc1997b
JM
471-mno-memcpy -mno-mips-tfile -mno-rnames -mno-stats @gol
472-mrnames -msoft-float @gol
473-m4650 -msingle-float -mmad @gol
474-mstats -EL -EB -G @var{num} -nocpp @gol
feb48bde 475-mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
d490e8ad 476-mfix7000 -mno-crt0 -mflush-func=@var{func} -mno-flush-func}
74291a4b 477
14f73b5a 478@emph{i386 and x86-64 Options}
4bc1997b 479@gccoptlist{
965f5423 480-mcpu=@var{cpu-type} -march=@var{cpu-type} -mfpmath=@var{unit} @gol
c93e80a5 481-masm=@var{dialect} -mno-fancy-math-387 @gol
4bc1997b
JM
482-mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
483-mno-wide-multiply -mrtd -malign-double @gol
3e18fdf6 484-mpreferred-stack-boundary=@var{num} @gol
965f5423 485-mmmx -msse -msse2 -msse-math -m3dnow @gol
feb48bde
JM
486-mthreads -mno-align-stringops -minline-all-stringops @gol
487-mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
14f73b5a
JH
488-m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
489-mno-red-zone@gol
490-m32 -m64}
74291a4b
MM
491
492@emph{HPPA Options}
4bc1997b 493@gccoptlist{
630d3d5a 494-march=@var{architecture-type} @gol
feb48bde
JM
495-mbig-switch -mdisable-fpregs -mdisable-indexing @gol
496-mfast-indirect-calls -mgas -mjump-in-delay @gol
4bc1997b
JM
497-mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
498-mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
feb48bde 499-mno-jump-in-delay -mno-long-load-store @gol
4bc1997b 500-mno-portable-runtime -mno-soft-float @gol
feb48bde
JM
501-mno-space-regs -msoft-float -mpa-risc-1-0 @gol
502-mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
630d3d5a 503-mschedule=@var{cpu-type} -mspace-regs}
74291a4b
MM
504
505@emph{Intel 960 Options}
4bc1997b 506@gccoptlist{
630d3d5a 507-m@var{cpu-type} -masm-compat -mclean-linkage @gol
4bc1997b
JM
508-mcode-align -mcomplex-addr -mleaf-procedures @gol
509-mic-compat -mic2.0-compat -mic3.0-compat @gol
510-mintel-asm -mno-clean-linkage -mno-code-align @gol
511-mno-complex-addr -mno-leaf-procedures @gol
512-mno-old-align -mno-strict-align -mno-tail-call @gol
513-mnumerics -mold-align -msoft-float -mstrict-align @gol
514-mtail-call}
74291a4b
MM
515
516@emph{DEC Alpha Options}
4bc1997b 517@gccoptlist{
58605ba0 518-mno-fp-regs -msoft-float -malpha-as -mgas @gol
4bc1997b
JM
519-mieee -mieee-with-inexact -mieee-conformant @gol
520-mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
521-mtrap-precision=@var{mode} -mbuild-constants @gol
58605ba0
RH
522-mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
523-mbwx -mmax -mfix -mcix @gol
524-mfloat-vax -mfloat-ieee @gol
525-mexplicit-relocs -msmall-data -mlarge-data @gol
4bc1997b 526-mmemory-latency=@var{time}}
74291a4b 527
d7c23cdc
DR
528@emph{DEC Alpha/VMS Options}
529@gccoptlist{
530-mvms-return-codes}
531
74291a4b 532@emph{Clipper Options}
4bc1997b
JM
533@gccoptlist{
534-mc300 -mc400}
74291a4b
MM
535
536@emph{H8/300 Options}
4bc1997b 537@gccoptlist{
310668e8 538-mrelax -mh -ms -mint32 -malign-300}
74291a4b
MM
539
540@emph{SH Options}
4bc1997b
JM
541@gccoptlist{
542-m1 -m2 -m3 -m3e @gol
543-m4-nofpu -m4-single-only -m4-single -m4 @gol
fa5322fa
AO
544-m5-64media -m5-64media-nofpu @gol
545-m5-32media -m5-32media-nofpu @gol
546-m5-compact -m5-compact-nofpu @gol
4bc1997b
JM
547-mb -ml -mdalign -mrelax @gol
548-mbigtable -mfmovd -mhitachi -mnomacsave @gol
c474f76b
AO
549-mieee -misize -mpadstruct -mspace @gol
550-mprefergot -musermode}
74291a4b
MM
551
552@emph{System V Options}
4bc1997b 553@gccoptlist{
aee96fe9 554-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
74291a4b 555
56b2d7a7 556@emph{ARC Options}
4bc1997b
JM
557@gccoptlist{
558-EB -EL @gol
630d3d5a
JM
559-mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
560-mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
56b2d7a7 561
282a61e6 562@emph{TMS320C3x/C4x Options}
4bc1997b 563@gccoptlist{
310668e8
JM
564-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
565-mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
566-mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
567-mparallel-insns -mparallel-mpy -mpreserve-float}
282a61e6 568
f84271d9 569@emph{V850 Options}
4bc1997b 570@gccoptlist{
310668e8
JM
571-mlong-calls -mno-long-calls -mep -mno-ep @gol
572-mprolog-function -mno-prolog-function -mspace @gol
573-mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
574-mv850 -mbig-switch}
83575957
ID
575
576@emph{NS32K Options}
4bc1997b 577@gccoptlist{
310668e8 578-m32032 -m32332 -m32532 -m32081 -m32381 @gol
feb48bde 579-mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
310668e8
JM
580-mregparam -mnoregparam -msb -mnosb @gol
581-mbitfield -mnobitfield -mhimem -mnohimem}
789a3090 582
052a4b28 583@emph{AVR Options}
4bc1997b 584@gccoptlist{
310668e8
JM
585-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
586-mcall-prologues -mno-tablejump -mtiny-stack}
052a4b28 587
789a3090 588@emph{MCore Options}
4bc1997b 589@gccoptlist{
feb48bde 590-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
310668e8
JM
591-mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
592-m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
593-mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
594-mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
f84271d9 595
bcf684c7
HPN
596@emph{MMIX Options}
597@gccoptlist{
598-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
599-mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
a824924d
HPN
600-melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
601-mno-base-addresses}
bcf684c7 602
df6194d4
JW
603@emph{IA-64 Options}
604@gccoptlist{
310668e8
JM
605-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
606-mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
607-mconstant-gp -mauto-pic -minline-divide-min-latency @gol
608-minline-divide-max-throughput -mno-dwarf2-asm @gol
630d3d5a 609-mfixed-range=@var{register-range}}
df6194d4 610
5d22c1a5
JM
611@emph{D30V Options}
612@gccoptlist{
613-mextmem -mextmemory -monchip -mno-asm-optimize -masm-optimize @gol
614-mbranch-cost=@var{n} -mcond-exec=@var{n}}
615
91abf72d
HP
616@emph{S/390 and zSeries Options}
617@gccoptlist{
618-mhard-float -msoft-float -mbackchain -mno-backchain @gol
619-msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
620-m64 -m31 -mdebug -mno-debug}
621
0b85d816
HPN
622@emph{CRIS Options}
623@gccoptlist{
624-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
625-mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
626-metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
627-mstack-align -mdata-align -mconst-align @gol
628-m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
629-melf -maout -melinux -mlinux -sim -sim2}
630
9f85bca7
JM
631@emph{PDP-11 Options}
632@gccoptlist{
633-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
634-mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
635-mint16 -mno-int32 -mfloat32 -mno-float64 @gol
636-mfloat64 -mno-float32 -mabshi -mno-abshi @gol
637-mbranch-expensive -mbranch-cheap @gol
638-msplit -mno-split -munix-asm -mdec-asm}
639
69a0611f
GK
640@emph{Xstormy16 Options}
641@gccoptlist{
642-msim}
643
03984308
BW
644@emph{Xtensa Options}
645@gccoptlist{
646-mbig-endian -mlittle-endian @gol
647-mdensity -mno-density @gol
648-mmac16 -mno-mac16 @gol
649-mmul16 -mno-mul16 @gol
650-mmul32 -mno-mul32 @gol
651-mnsa -mno-nsa @gol
652-mminmax -mno-minmax @gol
653-msext -mno-sext @gol
654-mbooleans -mno-booleans @gol
655-mhard-float -msoft-float @gol
656-mfused-madd -mno-fused-madd @gol
657-mserialize-volatile -mno-serialize-volatile @gol
658-mtext-section-literals -mno-text-section-literals @gol
659-mtarget-align -mno-target-align @gol
660-mlongcalls -mno-longcalls}
661
74291a4b
MM
662@item Code Generation Options
663@xref{Code Gen Options,,Options for Code Generation Conventions}.
4bc1997b
JM
664@gccoptlist{
665-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
6cfc0341 666-ffixed-@var{reg} -fexceptions @gol
5d22c1a5
JM
667-fnon-call-exceptions -funwind-tables @gol
668-fasynchronous-unwind-tables @gol
4bc1997b 669-finhibit-size-directive -finstrument-functions @gol
4bc1997b
JM
670-fno-common -fno-ident -fno-gnu-linker @gol
671-fpcc-struct-return -fpic -fPIC @gol
672-freg-struct-return -fshared-data -fshort-enums @gol
310668e8
JM
673-fshort-double -fvolatile @gol
674-fvolatile-global -fvolatile-static @gol
4bc1997b
JM
675-fverbose-asm -fpack-struct -fstack-check @gol
676-fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
677-fargument-alias -fargument-noalias @gol
310668e8 678-fargument-noalias-global -fleading-underscore}
74291a4b
MM
679@end table
680
681@menu
682* Overall Options:: Controlling the kind of output:
683 an executable, object files, assembler files,
684 or preprocessed source.
685* C Dialect Options:: Controlling the variant of C language compiled.
686* C++ Dialect Options:: Variations on C++.
60de6385 687* Objective-C Dialect Options:: Variations on Objective-C.
764dbbf2 688* Language Independent Options:: Controlling how diagnostics should be
02f52e19 689 formatted.
74291a4b
MM
690* Warning Options:: How picky should the compiler be?
691* Debugging Options:: Symbol tables, measurements, and debugging dumps.
692* Optimize Options:: How much optimization?
693* Preprocessor Options:: Controlling header files and macro definitions.
694 Also, getting dependency information for Make.
695* Assembler Options:: Passing options to the assembler.
696* Link Options:: Specifying libraries and so on.
697* Directory Options:: Where to find header files and libraries.
698 Where to find the compiler executable files.
a743d340 699* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 700* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
701@end menu
702
703@node Overall Options
704@section Options Controlling the Kind of Output
705
706Compilation can involve up to four stages: preprocessing, compilation
707proper, assembly and linking, always in that order. The first three
708stages apply to an individual source file, and end by producing an
709object file; linking combines all the object files (those newly
710compiled, and those specified as input) into an executable file.
711
712@cindex file name suffix
713For any given input file, the file name suffix determines what kind of
714compilation is done:
715
2642624b 716@table @gcctabopt
74291a4b
MM
717@item @var{file}.c
718C source code which must be preprocessed.
719
720@item @var{file}.i
721C source code which should not be preprocessed.
722
723@item @var{file}.ii
724C++ source code which should not be preprocessed.
725
726@item @var{file}.m
727Objective-C source code. Note that you must link with the library
728@file{libobjc.a} to make an Objective-C program work.
729
b9265ec1
JM
730@item @var{file}.mi
731Objective-C source code which should not be preprocessed.
732
74291a4b
MM
733@item @var{file}.h
734C header file (not to be compiled or linked).
735
736@item @var{file}.cc
b9265ec1 737@itemx @var{file}.cp
74291a4b
MM
738@itemx @var{file}.cxx
739@itemx @var{file}.cpp
b9265ec1 740@itemx @var{file}.c++
74291a4b
MM
741@itemx @var{file}.C
742C++ source code which must be preprocessed. Note that in @samp{.cxx},
743the last two letters must both be literally @samp{x}. Likewise,
161d7b59 744@samp{.C} refers to a literal capital C@.
74291a4b 745
b9265ec1
JM
746@item @var{file}.f
747@itemx @var{file}.for
748@itemx @var{file}.FOR
749Fortran source code which should not be preprocessed.
750
751@item @var{file}.F
752@itemx @var{file}.fpp
753@itemx @var{file}.FPP
754Fortran source code which must be preprocessed (with the traditional
755preprocessor).
756
757@item @var{file}.r
758Fortran source code which must be preprocessed with a RATFOR
161d7b59 759preprocessor (not included with GCC)@.
b9265ec1
JM
760
761@xref{Overall Options,,Options Controlling the Kind of Output, g77,
762Using and Porting GNU Fortran}, for more details of the handling of
763Fortran input files.
764
765@c FIXME: Descriptions of Java file types.
766@c @var{file}.java
767@c @var{file}.class
768@c @var{file}.zip
769@c @var{file}.jar
770
e23381df
GB
771@item @var{file}.ads
772Ada source code file which contains a library unit declaration (a
773declaration of a package, subprogram, or generic, or a generic
774instantiation), or a library unit renaming declaration (a package,
775generic, or subprogram renaming declaration). Such files are also
776called @dfn{specs}.
777
778@itemx @var{file}.adb
779Ada source code file containing a library unit body (a subprogram or
780package body). Such files are also called @dfn{bodies}.
781
b9265ec1 782@c GCC also knows about some suffixes for languages not yet included:
b9265ec1
JM
783@c Pascal:
784@c @var{file}.p
785@c @var{file}.pas
786
787@item @var{file}.ch
788@itemx @var{file}.chi
789CHILL source code (preprocessed with the traditional preprocessor).
790
74291a4b
MM
791@item @var{file}.s
792Assembler code.
793
794@item @var{file}.S
795Assembler code which must be preprocessed.
796
797@item @var{other}
798An object file to be fed straight into linking.
799Any file name with no recognized suffix is treated this way.
800@end table
801
cd3bb277 802@opindex x
630d3d5a 803You can specify the input language explicitly with the @option{-x} option:
74291a4b 804
2642624b 805@table @gcctabopt
74291a4b
MM
806@item -x @var{language}
807Specify explicitly the @var{language} for the following input files
808(rather than letting the compiler choose a default based on the file
809name suffix). This option applies to all following input files until
630d3d5a 810the next @option{-x} option. Possible values for @var{language} are:
74291a4b 811@example
b9265ec1
JM
812c c-header cpp-output
813c++ c++-cpp-output
814objective-c objc-cpp-output
74291a4b 815assembler assembler-with-cpp
e23381df
GB
816ada
817chill
b9265ec1 818f77 f77-cpp-input ratfor
e23381df 819java
74291a4b
MM
820@end example
821
822@item -x none
823Turn off any specification of a language, so that subsequent files are
630d3d5a 824handled according to their file name suffixes (as they are if @option{-x}
74291a4b 825has not been used at all).
14a774a9
RK
826
827@item -pass-exit-codes
cd3bb277 828@opindex pass-exit-codes
bedc7537 829Normally the @command{gcc} program will exit with the code of 1 if any
14a774a9 830phase of the compiler returns a non-success return code. If you specify
630d3d5a 831@option{-pass-exit-codes}, the @command{gcc} program will instead return with
14a774a9
RK
832numerically highest error produced by any phase that returned an error
833indication.
74291a4b
MM
834@end table
835
836If you only want some of the stages of compilation, you can use
630d3d5a
JM
837@option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
838one of the options @option{-c}, @option{-S}, or @option{-E} to say where
bedc7537
NC
839@command{gcc} is to stop. Note that some combinations (for example,
840@samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
74291a4b 841
2642624b 842@table @gcctabopt
74291a4b 843@item -c
cd3bb277 844@opindex c
74291a4b
MM
845Compile or assemble the source files, but do not link. The linking
846stage simply is not done. The ultimate output is in the form of an
847object file for each source file.
848
849By default, the object file name for a source file is made by replacing
850the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
851
852Unrecognized input files, not requiring compilation or assembly, are
853ignored.
854
855@item -S
cd3bb277 856@opindex S
74291a4b
MM
857Stop after the stage of compilation proper; do not assemble. The output
858is in the form of an assembler code file for each non-assembler input
859file specified.
860
861By default, the assembler file name for a source file is made by
862replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
863
864Input files that don't require compilation are ignored.
865
866@item -E
cd3bb277 867@opindex E
74291a4b
MM
868Stop after the preprocessing stage; do not run the compiler proper. The
869output is in the form of preprocessed source code, which is sent to the
870standard output.
871
872Input files which don't require preprocessing are ignored.
873
874@cindex output file option
875@item -o @var{file}
cd3bb277 876@opindex o
74291a4b
MM
877Place output in file @var{file}. This applies regardless to whatever
878sort of output is being produced, whether it be an executable file,
879an object file, an assembler file or preprocessed C code.
880
881Since only one output file can be specified, it does not make sense to
630d3d5a 882use @option{-o} when compiling more than one input file, unless you are
74291a4b
MM
883producing an executable file as output.
884
630d3d5a 885If @option{-o} is not specified, the default is to put an executable file
74291a4b
MM
886in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
887@file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
bd819a4a 888all preprocessed C source on standard output.
74291a4b
MM
889
890@item -v
cd3bb277 891@opindex v
74291a4b
MM
892Print (on standard error output) the commands executed to run the stages
893of compilation. Also print the version number of the compiler driver
894program and of the preprocessor and the compiler proper.
895
e8b3c8ac
IR
896@item -###
897@opindex ###
898Like @option{-v} except the commands are not executed and all command
899arguments are quoted. This is useful for shell scripts to capture the
900driver-generated command lines.
901
74291a4b 902@item -pipe
cd3bb277 903@opindex pipe
74291a4b
MM
904Use pipes rather than temporary files for communication between the
905various stages of compilation. This fails to work on some systems where
906the assembler is unable to read from a pipe; but the GNU assembler has
907no trouble.
844642e6
NC
908
909@item --help
cd3bb277 910@opindex help
844642e6 911Print (on the standard output) a description of the command line options
bedc7537
NC
912understood by @command{gcc}. If the @option{-v} option is also specified
913then @option{--help} will also be passed on to the various processes
914invoked by @command{gcc}, so that they can display the command line options
915they accept. If the @option{-W} option is also specified then command
844642e6
NC
916line options which have no documentation associated with them will also
917be displayed.
10501d8f
CC
918
919@item --target-help
cd3bb277 920@opindex target-help
10501d8f
CC
921Print (on the standard output) a description of target specific command
922line options for each tool.
74291a4b
MM
923@end table
924
925@node Invoking G++
926@section Compiling C++ Programs
927
928@cindex suffixes for C++ source
929@cindex C++ source file suffixes
930C++ source files conventionally use one of the suffixes @samp{.C},
bba975d4 931@samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
0c2d1a2a 932preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
bba975d4
JM
933files with these names and compiles them as C++ programs even if you
934call the compiler the same way as for compiling C programs (usually with
bedc7537 935the name @command{gcc}).
74291a4b
MM
936
937@findex g++
938@findex c++
939However, C++ programs often require class libraries as well as a
940compiler that understands the C++ language---and under some
941circumstances, you might want to compile programs from standard input,
942or otherwise without a suffix that flags them as C++ programs.
bedc7537 943@command{g++} is a program that calls GCC with the default language
e5e809f4 944set to C++, and automatically specifies linking against the C++
bedc7537
NC
945library. On many systems, @command{g++} is also
946installed with the name @command{c++}.
74291a4b 947
bedc7537 948@cindex invoking @command{g++}
74291a4b
MM
949When you compile C++ programs, you may specify many of the same
950command-line options that you use for compiling programs in any
951language; or command-line options meaningful for C and related
952languages; or options that are meaningful only for C++ programs.
953@xref{C Dialect Options,,Options Controlling C Dialect}, for
161d7b59 954explanations of options for languages related to C@.
74291a4b
MM
955@xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
956explanations of options that are meaningful only for C++ programs.
957
958@node C Dialect Options
959@section Options Controlling C Dialect
960@cindex dialect options
961@cindex language dialect options
962@cindex options, dialect
963
964The following options control the dialect of C (or languages derived
2147b154 965from C, such as C++ and Objective-C) that the compiler accepts:
74291a4b 966
2642624b 967@table @gcctabopt
74291a4b 968@cindex ANSI support
c1030c7c 969@cindex ISO support
74291a4b 970@item -ansi
cd3bb277 971@opindex ansi
c1030c7c 972In C mode, support all ISO C89 programs. In C++ mode,
775afb25 973remove GNU extensions that conflict with ISO C++.
74291a4b 974
c1030c7c 975This turns off certain features of GCC that are incompatible with ISO
aee96fe9 976C89 (when compiling C code), or of standard C++ (when compiling C++ code),
0c2d1a2a 977such as the @code{asm} and @code{typeof} keywords, and
74291a4b
MM
978predefined macros such as @code{unix} and @code{vax} that identify the
979type of system you are using. It also enables the undesirable and
02f52e19 980rarely used ISO trigraph feature. For the C compiler,
0c2d1a2a 981it disables recognition of C++ style @samp{//} comments as well as
775afb25 982the @code{inline} keyword.
74291a4b
MM
983
984The alternate keywords @code{__asm__}, @code{__extension__},
985@code{__inline__} and @code{__typeof__} continue to work despite
630d3d5a 986@option{-ansi}. You would not want to use them in an ISO C program, of
74291a4b 987course, but it is useful to put them in header files that might be included
630d3d5a 988in compilations done with @option{-ansi}. Alternate predefined macros
74291a4b 989such as @code{__unix__} and @code{__vax__} are also available, with or
630d3d5a 990without @option{-ansi}.
74291a4b 991
630d3d5a
JM
992The @option{-ansi} option does not cause non-ISO programs to be
993rejected gratuitously. For that, @option{-pedantic} is required in
994addition to @option{-ansi}. @xref{Warning Options}.
74291a4b 995
630d3d5a 996The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
74291a4b
MM
997option is used. Some header files may notice this macro and refrain
998from declaring certain functions or defining certain macros that the
c1030c7c 999ISO standard doesn't call for; this is to avoid interfering with any
74291a4b
MM
1000programs that might use these names for other things.
1001
c771326b
JM
1002Functions which would normally be built in but do not have semantics
1003defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
630d3d5a 1004functions with @option{-ansi} is used. @xref{Other Builtins,,Other
f0523f02 1005built-in functions provided by GCC}, for details of the functions
01702459 1006affected.
74291a4b 1007
49419c8f 1008@item -std=
cd3bb277 1009@opindex std
aee96fe9
JM
1010Determine the language standard. This option is currently only
1011supported when compiling C@. A value for this option must be provided;
02f52e19 1012possible values are
3932261a 1013
ee457005 1014@table @samp
aee96fe9
JM
1015@item c89
1016@itemx iso9899:1990
1017ISO C89 (same as @option{-ansi}).
3043b30e
ML
1018
1019@item iso9899:199409
aee96fe9 1020ISO C89 as modified in amendment 1.
3043b30e 1021
49419c8f 1022@item c99
aee96fe9
JM
1023@itemx c9x
1024@itemx iso9899:1999
1025@itemx iso9899:199x
1026ISO C99. Note that this standard is not yet fully supported; see
1027@w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1028names @samp{c9x} and @samp{iso9899:199x} are deprecated.
3043b30e
ML
1029
1030@item gnu89
aee96fe9 1031Default, ISO C89 plus GNU extensions (including some C99 features).
3043b30e 1032
49419c8f 1033@item gnu99
7dac2f89 1034@item gnu9x
d15a05b3
EC
1035ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1036this will become the default. The name @samp{gnu9x} is deprecated.
49419c8f 1037
ee457005 1038@end table
3043b30e
ML
1039
1040Even when this option is not specified, you can still use some of the
1041features of newer standards in so far as they do not conflict with
1042previous C standards. For example, you may use @code{__restrict__} even
bedc7537 1043when @option{-std=c99} is not specified.
3932261a 1044
5490d604
JM
1045The @option{-std} options specifying some version of ISO C have the same
1046effects as @option{-ansi}, except that features that were not in ISO C89
1047but are in the specified version (for example, @samp{//} comments and
1048the @code{inline} keyword in ISO C99) are not disabled.
1049
c1030c7c
JM
1050@xref{Standards,,Language Standards Supported by GCC}, for details of
1051these standard versions.
1052
b1018de6
AO
1053@item -aux-info @var{filename}
1054@opindex aux-info
1055Output to the given filename prototyped declarations for all functions
1056declared and/or defined in a translation unit, including those in header
161d7b59 1057files. This option is silently ignored in any language other than C@.
b1018de6
AO
1058
1059Besides declarations, the file indicates, in comments, the origin of
1060each declaration (source file and line), whether the declaration was
1061implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1062@samp{O} for old, respectively, in the first character after the line
1063number and the colon), and whether it came from a declaration or a
1064definition (@samp{C} or @samp{F}, respectively, in the following
1065character). In the case of function definitions, a K&R-style list of
1066arguments followed by their declarations is also provided, inside
1067comments, after the declaration.
1068
74291a4b 1069@item -fno-asm
cd3bb277 1070@opindex fno-asm
74291a4b
MM
1071Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1072keyword, so that code can use these words as identifiers. You can use
1073the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
630d3d5a 1074instead. @option{-ansi} implies @option{-fno-asm}.
74291a4b
MM
1075
1076In C++, this switch only affects the @code{typeof} keyword, since
1077@code{asm} and @code{inline} are standard keywords. You may want to
630d3d5a 1078use the @option{-fno-gnu-keywords} flag instead, which has the same
5490d604
JM
1079effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1080switch only affects the @code{asm} and @code{typeof} keywords, since
1081@code{inline} is a standard keyword in ISO C99.
74291a4b
MM
1082
1083@item -fno-builtin
7d14c755 1084@itemx -fno-builtin-@var{function} @r{(C and Objective-C only)}
cd3bb277 1085@opindex fno-builtin
c771326b
JM
1086@cindex built-in functions
1087Don't recognize built-in functions that do not begin with
01702459 1088@samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
f0523f02 1089functions provided by GCC}, for details of the functions affected,
c771326b 1090including those which are not built-in functions when @option{-ansi} or
5490d604
JM
1091@option{-std} options for strict ISO C conformance are used because they
1092do not have an ISO standard meaning.
74291a4b 1093
c771326b 1094GCC normally generates special code to handle certain built-in functions
74291a4b
MM
1095more efficiently; for instance, calls to @code{alloca} may become single
1096instructions that adjust the stack directly, and calls to @code{memcpy}
1097may become inline copy loops. The resulting code is often both smaller
1098and faster, but since the function calls no longer appear as such, you
1099cannot set a breakpoint on those calls, nor can you change the behavior
1100of the functions by linking with a different library.
1101
630d3d5a 1102In C++, @option{-fno-builtin} is always in effect. The @option{-fbuiltin}
0b1161fc 1103option has no effect. Therefore, in C++, the only way to get the
c771326b 1104optimization benefits of built-in functions is to call the function
0b1161fc 1105using the @samp{__builtin_} prefix. The GNU C++ Standard Library uses
c771326b 1106built-in functions to implement many functions (like
0b1161fc
MM
1107@code{std::strchr}), so that you automatically get efficient code.
1108
7d14c755
JM
1109With the @option{-fno-builtin-@var{function}} option, not available
1110when compiling C++, only the built-in function @var{function} is
1111disabled. @var{function} must not begin with @samp{__builtin_}. If a
1112function is named this is not built-in in this version of GCC, this
1113option is ignored. There is no corresponding
1114@option{-fbuiltin-@var{function}} option; if you wish to enable
1115built-in functions selectively when using @option{-fno-builtin} or
1116@option{-ffreestanding}, you may define macros such as:
1117
1118@smallexample
1119#define abs(n) __builtin_abs ((n))
1120#define strcpy(d, s) __builtin_strcpy ((d), (s))
1121@end smallexample
1122
861bb6c1 1123@item -fhosted
cd3bb277 1124@opindex fhosted
861bb6c1
JL
1125@cindex hosted environment
1126
1127Assert that compilation takes place in a hosted environment. This implies
630d3d5a 1128@option{-fbuiltin}. A hosted environment is one in which the
861bb6c1
JL
1129entire standard library is available, and in which @code{main} has a return
1130type of @code{int}. Examples are nearly everything except a kernel.
630d3d5a 1131This is equivalent to @option{-fno-freestanding}.
861bb6c1
JL
1132
1133@item -ffreestanding
cd3bb277 1134@opindex ffreestanding
861bb6c1
JL
1135@cindex hosted environment
1136
1137Assert that compilation takes place in a freestanding environment. This
630d3d5a 1138implies @option{-fno-builtin}. A freestanding environment
861bb6c1
JL
1139is one in which the standard library may not exist, and program startup may
1140not necessarily be at @code{main}. The most obvious example is an OS kernel.
630d3d5a 1141This is equivalent to @option{-fno-hosted}.
861bb6c1 1142
c1030c7c
JM
1143@xref{Standards,,Language Standards Supported by GCC}, for details of
1144freestanding and hosted environments.
1145
74291a4b 1146@item -trigraphs
cd3bb277 1147@opindex trigraphs
3bce8a01
NB
1148Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1149options for strict ISO C conformance) implies @option{-trigraphs}.
74291a4b
MM
1150
1151@cindex traditional C language
1152@cindex C language, traditional
1153@item -traditional
f458d1d5 1154@itemx -traditional-cpp
cd3bb277 1155@opindex traditional-cpp
f458d1d5
ZW
1156@opindex traditional
1157Formerly, these options caused GCC to attempt to emulate a pre-standard
1158C compiler. They are now only supported with the @option{-E} switch.
1159The preprocessor continues to support a pre-standard mode. See the GNU
1160CPP manual for details.
74291a4b
MM
1161
1162@item -fcond-mismatch
cd3bb277 1163@opindex fcond-mismatch
74291a4b 1164Allow conditional expressions with mismatched types in the second and
a7537031
JM
1165third arguments. The value of such an expression is void. This option
1166is not supported for C++.
74291a4b
MM
1167
1168@item -funsigned-char
cd3bb277 1169@opindex funsigned-char
74291a4b
MM
1170Let the type @code{char} be unsigned, like @code{unsigned char}.
1171
1172Each kind of machine has a default for what @code{char} should
1173be. It is either like @code{unsigned char} by default or like
1174@code{signed char} by default.
1175
1176Ideally, a portable program should always use @code{signed char} or
1177@code{unsigned char} when it depends on the signedness of an object.
1178But many programs have been written to use plain @code{char} and
1179expect it to be signed, or expect it to be unsigned, depending on the
1180machines they were written for. This option, and its inverse, let you
1181make such a program work with the opposite default.
1182
1183The type @code{char} is always a distinct type from each of
1184@code{signed char} or @code{unsigned char}, even though its behavior
1185is always just like one of those two.
1186
1187@item -fsigned-char
cd3bb277 1188@opindex fsigned-char
74291a4b
MM
1189Let the type @code{char} be signed, like @code{signed char}.
1190
630d3d5a
JM
1191Note that this is equivalent to @option{-fno-unsigned-char}, which is
1192the negative form of @option{-funsigned-char}. Likewise, the option
1193@option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
74291a4b 1194
74291a4b
MM
1195@item -fsigned-bitfields
1196@itemx -funsigned-bitfields
1197@itemx -fno-signed-bitfields
1198@itemx -fno-unsigned-bitfields
cd3bb277
JM
1199@opindex fsigned-bitfields
1200@opindex funsigned-bitfields
1201@opindex fno-signed-bitfields
1202@opindex fno-unsigned-bitfields
c771326b 1203These options control whether a bit-field is signed or unsigned, when the
74291a4b 1204declaration does not use either @code{signed} or @code{unsigned}. By
c771326b 1205default, such a bit-field is signed, because this is consistent: the
74291a4b
MM
1206basic integer types such as @code{int} are signed types.
1207
74291a4b 1208@item -fwritable-strings
cd3bb277 1209@opindex fwritable-strings
74291a4b
MM
1210Store string constants in the writable data segment and don't uniquize
1211them. This is for compatibility with old programs which assume they can
f458d1d5 1212write into string constants.
74291a4b
MM
1213
1214Writing into string constants is a very bad idea; ``constants'' should
1215be constant.
1216
3e37bef5 1217@item -fshort-wchar
cd3bb277 1218@opindex fshort-wchar
3e37bef5
JM
1219Override the underlying type for @samp{wchar_t} to be @samp{short
1220unsigned int} instead of the default for the target. This option is
161d7b59 1221useful for building programs to run under WINE@.
74291a4b
MM
1222@end table
1223
1224@node C++ Dialect Options
1225@section Options Controlling C++ Dialect
1226
1227@cindex compiler options, C++
1228@cindex C++ options, command line
1229@cindex options, C++
1230This section describes the command-line options that are only meaningful
1231for C++ programs; but you can also use most of the GNU compiler options
1232regardless of what language your program is in. For example, you
1233might compile a file @code{firstClass.C} like this:
1234
1235@example
1dc5fc4b 1236g++ -g -frepo -O -c firstClass.C
74291a4b
MM
1237@end example
1238
1239@noindent
630d3d5a 1240In this example, only @option{-frepo} is an option meant
74291a4b 1241only for C++ programs; you can use the other options with any
161d7b59 1242language supported by GCC@.
74291a4b
MM
1243
1244Here is a list of options that are @emph{only} for compiling C++ programs:
1245
2642624b 1246@table @gcctabopt
74291a4b 1247@item -fno-access-control
cd3bb277 1248@opindex fno-access-control
74291a4b
MM
1249Turn off all access checking. This switch is mainly useful for working
1250around bugs in the access control code.
1251
74291a4b 1252@item -fcheck-new
cd3bb277 1253@opindex fcheck-new
74291a4b
MM
1254Check that the pointer returned by @code{operator new} is non-null
1255before attempting to modify the storage allocated. The current Working
1256Paper requires that @code{operator new} never return a null pointer, so
1257this check is normally unnecessary.
1258
1dc5fc4b
JM
1259An alternative to using this option is to specify that your
1260@code{operator new} does not throw any exceptions; if you declare it
aee96fe9 1261@samp{throw()}, G++ will check the return value. See also @samp{new
1dc5fc4b
JM
1262(nothrow)}.
1263
74291a4b 1264@item -fconserve-space
cd3bb277 1265@opindex fconserve-space
74291a4b
MM
1266Put uninitialized or runtime-initialized global variables into the
1267common segment, as C does. This saves space in the executable at the
1268cost of not diagnosing duplicate definitions. If you compile with this
1269flag and your program mysteriously crashes after @code{main()} has
1270completed, you may have an object that is being destroyed twice because
1271two definitions were merged.
1272
1dc5fc4b
JM
1273This option is no longer useful on most targets, now that support has
1274been added for putting variables into BSS without making them common.
1275
02f52e19 1276@item -fno-const-strings
cd3bb277 1277@opindex fno-const-strings
fcca588c
MM
1278Give string constants type @code{char *} instead of type @code{const
1279char *}. By default, G++ uses type @code{const char *} as required by
630d3d5a 1280the standard. Even if you use @option{-fno-const-strings}, you cannot
fcca588c 1281actually modify the value of a string constant, unless you also use
630d3d5a 1282@option{-fwritable-strings}.
fcca588c
MM
1283
1284This option might be removed in a future release of G++. For maximum
1285portability, you should structure your code so that it works with
1286string constants that have type @code{const char *}.
1287
74291a4b 1288@item -fdollars-in-identifiers
cd3bb277 1289@opindex fdollars-in-identifiers
74291a4b 1290Accept @samp{$} in identifiers. You can also explicitly prohibit use of
630d3d5a 1291@samp{$} with the option @option{-fno-dollars-in-identifiers}. (GNU C allows
eb795509 1292@samp{$} by default on most target systems, but there are a few exceptions.)
74291a4b 1293Traditional C allowed the character @samp{$} to form part of
c1030c7c 1294identifiers. However, ISO C and C++ forbid @samp{$} in identifiers.
74291a4b 1295
1dc5fc4b 1296@item -fno-elide-constructors
cd3bb277 1297@opindex fno-elide-constructors
1dc5fc4b
JM
1298The C++ standard allows an implementation to omit creating a temporary
1299which is only used to initialize another object of the same type.
aee96fe9 1300Specifying this option disables that optimization, and forces G++ to
1dc5fc4b 1301call the copy constructor in all cases.
74291a4b 1302
dd1ba632 1303@item -fno-enforce-eh-specs
cd3bb277 1304@opindex fno-enforce-eh-specs
dd1ba632
JM
1305Don't check for violation of exception specifications at runtime. This
1306option violates the C++ standard, but may be useful for reducing code
1307size in production builds, much like defining @samp{NDEBUG}. The compiler
1308will still optimize based on the exception specifications.
1309
74291a4b 1310@item -fexternal-templates
cd3bb277 1311@opindex fexternal-templates
9c34dbbf
ZW
1312
1313Cause @samp{#pragma interface} and @samp{implementation} to apply to
1314template instantiation; template instances are emitted or not according
74291a4b
MM
1315to the location of the template definition. @xref{Template
1316Instantiation}, for more information.
1317
37f6b6bf
MM
1318This option is deprecated.
1319
74291a4b 1320@item -falt-external-templates
cd3bb277 1321@opindex falt-external-templates
9c34dbbf
ZW
1322Similar to @option{-fexternal-templates}, but template instances are
1323emitted or not according to the place where they are first instantiated.
74291a4b
MM
1324@xref{Template Instantiation}, for more information.
1325
37f6b6bf
MM
1326This option is deprecated.
1327
74291a4b 1328@item -ffor-scope
8c81598d 1329@itemx -fno-for-scope
cd3bb277
JM
1330@opindex ffor-scope
1331@opindex fno-for-scope
695ac33f 1332If @option{-ffor-scope} is specified, the scope of variables declared in
74291a4b 1333a @i{for-init-statement} is limited to the @samp{for} loop itself,
34527c47 1334as specified by the C++ standard.
695ac33f 1335If @option{-fno-for-scope} is specified, the scope of variables declared in
74291a4b 1336a @i{for-init-statement} extends to the end of the enclosing scope,
aee96fe9 1337as was the case in old versions of G++, and other (traditional)
74291a4b
MM
1338implementations of C++.
1339
1340The default if neither flag is given to follow the standard,
1341but to allow and give a warning for old-style code that would
1342otherwise be invalid, or have different behavior.
1343
1344@item -fno-gnu-keywords
cd3bb277 1345@opindex fno-gnu-keywords
9762e8a4 1346Do not recognize @code{typeof} as a keyword, so that code can use this
767094dd 1347word as an identifier. You can use the keyword @code{__typeof__} instead.
630d3d5a 1348@option{-ansi} implies @option{-fno-gnu-keywords}.
74291a4b 1349
1dc5fc4b 1350@item -fno-implicit-templates
cd3bb277 1351@opindex fno-implicit-templates
bba975d4 1352Never emit code for non-inline templates which are instantiated
e979f9e8 1353implicitly (i.e.@: by use); only emit code for explicit instantiations.
bba975d4
JM
1354@xref{Template Instantiation}, for more information.
1355
1356@item -fno-implicit-inline-templates
cd3bb277 1357@opindex fno-implicit-inline-templates
bba975d4
JM
1358Don't emit code for implicit instantiations of inline templates, either.
1359The default is to handle inlines differently so that compiles with and
1360without optimization will need the same set of explicit instantiations.
1dc5fc4b 1361
74291a4b 1362@item -fno-implement-inlines
cd3bb277 1363@opindex fno-implement-inlines
74291a4b
MM
1364To save space, do not emit out-of-line copies of inline functions
1365controlled by @samp{#pragma implementation}. This will cause linker
1366errors if these functions are not inlined everywhere they are called.
1367
631cf95d 1368@item -fms-extensions
cd3bb277 1369@opindex fms-extensions
32fb1fb2
PE
1370Disable pedantic warnings about constructs used in MFC, such as implicit
1371int and getting a pointer to member function via non-standard syntax.
631cf95d 1372
fcca588c 1373@item -fno-nonansi-builtins
cd3bb277 1374@opindex fno-nonansi-builtins
c771326b 1375Disable built-in declarations of functions that are not mandated by
161d7b59 1376ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
fcca588c
MM
1377@code{index}, @code{bzero}, @code{conjf}, and other related functions.
1378
775afb25 1379@item -fno-operator-names
cd3bb277 1380@opindex fno-operator-names
775afb25 1381Do not treat the operator name keywords @code{and}, @code{bitand},
74291a4b 1382@code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
775afb25 1383synonyms as keywords.
74291a4b 1384
4f8b4fd9 1385@item -fno-optional-diags
cd3bb277 1386@opindex fno-optional-diags
4f8b4fd9 1387Disable diagnostics that the standard says a compiler does not need to
aee96fe9 1388issue. Currently, the only such diagnostic issued by G++ is the one for
bba975d4 1389a name having multiple meanings within a class.
4f8b4fd9 1390
8c7707b0 1391@item -fpermissive
cd3bb277 1392@opindex fpermissive
8c7707b0 1393Downgrade messages about nonconformant code from errors to warnings. By
aee96fe9 1394default, G++ effectively sets @option{-pedantic-errors} without
630d3d5a 1395@option{-pedantic}; this option reverses that. This behavior and this
161d7b59 1396option are superseded by @option{-pedantic}, which works as it does for GNU C@.
8c7707b0 1397
8c81598d 1398@item -frepo
cd3bb277 1399@opindex frepo
9c34dbbf
ZW
1400Enable automatic template instantiation at link time. This option also
1401implies @option{-fno-implicit-templates}. @xref{Template
1402Instantiation}, for more information.
8c81598d 1403
8c7707b0 1404@item -fno-rtti
cd3bb277 1405@opindex fno-rtti
a7fbfcf9
JM
1406Disable generation of information about every class with virtual
1407functions for use by the C++ runtime type identification features
1408(@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1409of the language, you can save some space by using this flag. Note that
1410exception handling uses the same information, but it will generate it as
1411needed.
8c7707b0 1412
fcca588c 1413@item -fstats
cd3bb277 1414@opindex fstats
fcca588c
MM
1415Emit statistics about front-end processing at the end of the compilation.
1416This information is generally only useful to the G++ development team.
1417
1dc5fc4b 1418@item -ftemplate-depth-@var{n}
cd3bb277 1419@opindex ftemplate-depth
1dc5fc4b
JM
1420Set the maximum instantiation depth for template classes to @var{n}.
1421A limit on the template instantiation depth is needed to detect
767094dd 1422endless recursions during template class instantiation. ANSI/ISO C++
1dc5fc4b
JM
1423conforming programs must not rely on a maximum depth greater than 17.
1424
fc693822 1425@item -fuse-cxa-atexit
cd3bb277 1426@opindex fuse-cxa-atexit
fc693822
MM
1427Register destructors for objects with static storage duration with the
1428@code{__cxa_atexit} function rather than the @code{atexit} function.
1429This option is required for fully standards-compliant handling of static
1430destructors, but will only work if your C library supports
1431@code{__cxa_atexit}.
1432
90ecce3e 1433@item -fvtable-gc
cd3bb277 1434@opindex fvtable-gc
90ecce3e
JM
1435Emit special relocations for vtables and virtual function references
1436so that the linker can identify unused virtual functions and zero out
1437vtable slots that refer to them. This is most useful with
630d3d5a 1438@option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
90ecce3e 1439also discard the functions themselves.
f5a1b0d2 1440
90ecce3e 1441This optimization requires GNU as and GNU ld. Not all systems support
630d3d5a 1442this option. @option{-Wl,--gc-sections} is ignored without @option{-static}.
861bb6c1 1443
02f52e19 1444@item -fno-weak
cd3bb277 1445@opindex fno-weak
90ecce3e 1446Do not use weak symbol support, even if it is provided by the linker.
fcca588c
MM
1447By default, G++ will use weak symbols if they are available. This
1448option exists only for testing, and should not be used by end-users;
1449it will result in inferior code and has no benefits. This option may
1450be removed in a future release of G++.
1451
74291a4b 1452@item -nostdinc++
cd3bb277 1453@opindex nostdinc++
74291a4b
MM
1454Do not search for header files in the standard directories specific to
1455C++, but do still search the other standard directories. (This option
e5e809f4 1456is used when building the C++ library.)
74291a4b
MM
1457@end table
1458
1459In addition, these optimization, warning, and code generation options
1460have meanings only for C++ programs:
1461
2642624b 1462@table @gcctabopt
74291a4b 1463@item -fno-default-inline
cd3bb277 1464@opindex fno-default-inline
74291a4b 1465Do not assume @samp{inline} for functions defined inside a class scope.
1dc5fc4b
JM
1466@xref{Optimize Options,,Options That Control Optimization}. Note that these
1467functions will have linkage like inline functions; they just won't be
1468inlined by default.
74291a4b 1469
aee96fe9 1470@item -Wctor-dtor-privacy @r{(C++ only)}
cd3bb277 1471@opindex Wctor-dtor-privacy
bba975d4
JM
1472Warn when a class seems unusable, because all the constructors or
1473destructors in a class are private and the class has no friends or
1474public static member functions.
1475
aee96fe9 1476@item -Wnon-virtual-dtor @r{(C++ only)}
cd3bb277 1477@opindex Wnon-virtual-dtor
bba975d4
JM
1478Warn when a class declares a non-virtual destructor that should probably
1479be virtual, because it looks like the class will be used polymorphically.
1480
aee96fe9 1481@item -Wreorder @r{(C++ only)}
cd3bb277 1482@opindex Wreorder
bba975d4
JM
1483@cindex reordering, warning
1484@cindex warning for reordering of member initializers
1485Warn when the order of member initializers given in the code does not
1486match the order in which they must be executed. For instance:
1487
1488@smallexample
1489struct A @{
1490 int i;
1491 int j;
1492 A(): j (0), i (1) @{ @}
1493@};
1494@end smallexample
1495
1496Here the compiler will warn that the member initializers for @samp{i}
1497and @samp{j} will be rearranged to match the declaration order of the
1498members.
1499@end table
1500
630d3d5a 1501The following @option{-W@dots{}} options are not affected by @option{-Wall}.
bba975d4 1502
2642624b 1503@table @gcctabopt
aee96fe9 1504@item -Weffc++ @r{(C++ only)}
cd3bb277 1505@opindex Weffc++
77f6c1eb
RS
1506Warn about violations of the following style guidelines from Scott Meyers'
1507@cite{Effective C++} book:
1508
1509@itemize @bullet
1510@item
1511Item 11: Define a copy constructor and an assignment operator for classes
1512with dynamically allocated memory.
1513
1514@item
1515Item 12: Prefer initialization to assignment in constructors.
1516
1517@item
1518Item 14: Make destructors virtual in base classes.
1519
1520@item
1521Item 15: Have @code{operator=} return a reference to @code{*this}.
1522
1523@item
1524Item 23: Don't try to return a reference when you must return an object.
1525
1526@end itemize
1527
1528and about violations of the following style guidelines from Scott Meyers'
1529@cite{More Effective C++} book:
1530
1531@itemize @bullet
1532@item
1533Item 6: Distinguish between prefix and postfix forms of increment and
1534decrement operators.
1535
1536@item
1537Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1538
1539@end itemize
1540
1541If you use this option, you should be aware that the standard library
1542headers do not obey all of these guidelines; you can use @samp{grep -v}
1543to filter out those warnings.
bba975d4 1544
aee96fe9 1545@item -Wno-deprecated @r{(C++ only)}
cd3bb277 1546@opindex Wno-deprecated
767094dd 1547Do not warn about usage of deprecated features. @xref{Deprecated Features}.
2de45c06 1548
aee96fe9 1549@item -Wno-non-template-friend @r{(C++ only)}
cd3bb277 1550@opindex Wno-non-template-friend
bba975d4 1551Disable warnings when non-templatized friend functions are declared
767094dd 1552within a template. With the advent of explicit template specification
aee96fe9 1553support in G++, if the name of the friend is an unqualified-id (i.e.,
bba975d4 1554@samp{friend foo(int)}), the C++ language specification demands that the
767094dd 1555friend declare or define an ordinary, nontemplate function. (Section
aee96fe9 155614.5.3). Before G++ implemented explicit specification, unqualified-ids
bba975d4 1557could be interpreted as a particular specialization of a templatized
767094dd 1558function. Because this non-conforming behavior is no longer the default
aee96fe9 1559behavior for G++, @option{-Wnon-template-friend} allows the compiler to
bba975d4 1560check existing code for potential trouble spots, and is on by default.
2228d450 1561This new compiler behavior can be turned off with
630d3d5a 1562@option{-Wno-non-template-friend} which keeps the conformant compiler code
2228d450 1563but disables the helpful warning.
bba975d4 1564
aee96fe9 1565@item -Wold-style-cast @r{(C++ only)}
cd3bb277 1566@opindex Wold-style-cast
323728aa
NS
1567Warn if an old-style (C-style) cast to a non-void type is used within
1568a C++ program. The new-style casts (@samp{static_cast},
1569@samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1570unintended effects, and much easier to grep for.
bba975d4 1571
aee96fe9 1572@item -Woverloaded-virtual @r{(C++ only)}
cd3bb277 1573@opindex Woverloaded-virtual
bba975d4
JM
1574@cindex overloaded virtual fn, warning
1575@cindex warning for overloaded virtual fn
3747f3dc
MM
1576Warn when a function declaration hides virtual functions from a
1577base class. For example, in:
1578
1579@smallexample
1580struct A @{
1581 virtual void f();
1582@};
1583
1584struct B: public A @{
1585 void f(int);
1586@};
1587@end smallexample
1588
1589the @code{A} class version of @code{f} is hidden in @code{B}, and code
1590like this:
1591
1592@smallexample
1593B* b;
1594b->f();
1595@end smallexample
1596
1597will fail to compile.
bba975d4 1598
aee96fe9 1599@item -Wno-pmf-conversions @r{(C++ only)}
cd3bb277 1600@opindex Wno-pmf-conversions
bba975d4
JM
1601Disable the diagnostic for converting a bound pointer to member function
1602to a plain pointer.
1603
aee96fe9 1604@item -Wsign-promo @r{(C++ only)}
cd3bb277 1605@opindex Wsign-promo
bba975d4
JM
1606Warn when overload resolution chooses a promotion from unsigned or
1607enumeral type to a signed type over a conversion to an unsigned type of
aee96fe9 1608the same size. Previous versions of G++ would try to preserve
bba975d4
JM
1609unsignedness, but the standard mandates the current behavior.
1610
aee96fe9 1611@item -Wsynth @r{(C++ only)}
cd3bb277 1612@opindex Wsynth
bba975d4
JM
1613@cindex warning for synthesized methods
1614@cindex synthesized methods, warning
aee96fe9 1615Warn when G++'s synthesis behavior does not match that of cfront. For
bba975d4
JM
1616instance:
1617
1618@smallexample
1619struct A @{
1620 operator int ();
1621 A& operator = (int);
1622@};
1623
1624main ()
1625@{
1626 A a,b;
1627 a = b;
1628@}
1629@end smallexample
74291a4b 1630
aee96fe9 1631In this example, G++ will synthesize a default @samp{A& operator =
bba975d4 1632(const A&);}, while cfront will use the user-defined @samp{operator =}.
74291a4b
MM
1633@end table
1634
60de6385
SS
1635@node Objective-C Dialect Options
1636@section Options Controlling Objective-C Dialect
1637
1638@cindex compiler options, Objective-C
1639@cindex Objective-C options, command line
1640@cindex options, Objective-C
1641This section describes the command-line options that are only meaningful
1642for Objective-C programs; but you can also use most of the GNU compiler
1643options regardless of what language your program is in. For example,
1644you might compile a file @code{some_class.m} like this:
1645
1646@example
1647gcc -g -fgnu-runtime -O -c some_class.m
1648@end example
1649
1650@noindent
630d3d5a 1651In this example, only @option{-fgnu-runtime} is an option meant only for
60de6385 1652Objective-C programs; you can use the other options with any language
161d7b59 1653supported by GCC@.
60de6385
SS
1654
1655Here is a list of options that are @emph{only} for compiling Objective-C
1656programs:
1657
1658@table @gcctabopt
630d3d5a 1659@item -fconstant-string-class=@var{class-name}
cd3bb277 1660@opindex fconstant-string-class
630d3d5a 1661Use @var{class-name} as the name of the class to instantiate for each
695ac33f 1662literal string specified with the syntax @code{@@"@dots{}"}. The default
60de6385
SS
1663class name is @code{NXConstantString}.
1664
1665@item -fgnu-runtime
cd3bb277 1666@opindex fgnu-runtime
60de6385
SS
1667Generate object code compatible with the standard GNU Objective-C
1668runtime. This is the default for most types of systems.
1669
1670@item -fnext-runtime
cd3bb277 1671@opindex fnext-runtime
60de6385 1672Generate output compatible with the NeXT runtime. This is the default
161d7b59 1673for NeXT-based systems, including Darwin and Mac OS X@.
60de6385
SS
1674
1675@item -gen-decls
cd3bb277 1676@opindex gen-decls
60de6385
SS
1677Dump interface declarations for all classes seen in the source file to a
1678file named @file{@var{sourcename}.decl}.
1679
1680@item -Wno-protocol
cd3bb277 1681@opindex Wno-protocol
60de6385
SS
1682Do not warn if methods required by a protocol are not implemented
1683in the class adopting it.
1684
1685@item -Wselector
cd3bb277 1686@opindex Wselector
60de6385
SS
1687Warn if a selector has multiple methods of different types defined.
1688
1689@c not documented because only avail via -Wp
1690@c @item -print-objc-runtime-info
1691
1692@end table
1693
764dbbf2
GDR
1694@node Language Independent Options
1695@section Options to Control Diagnostic Messages Formatting
1696@cindex options to control diagnostics formatting
1697@cindex diagnostic messages
1698@cindex message formatting
1699
b192711e 1700Traditionally, diagnostic messages have been formatted irrespective of
e979f9e8 1701the output device's aspect (e.g.@: its width, @dots{}). The options described
764dbbf2 1702below can be used to control the diagnostic messages formatting
e979f9e8 1703algorithm, e.g.@: how many characters per line, how often source location
6c0a4eab 1704information should be reported. Right now, only the C++ front end can
764dbbf2 1705honor these options. However it is expected, in the near future, that
6c0a4eab 1706the remaining front ends would be able to digest them correctly.
764dbbf2 1707
2642624b 1708@table @gcctabopt
764dbbf2 1709@item -fmessage-length=@var{n}
cd3bb277 1710@opindex fmessage-length
764dbbf2 1711Try to format error messages so that they fit on lines of about @var{n}
aee96fe9 1712characters. The default is 72 characters for @command{g++} and 0 for the rest of
161d7b59 1713the front ends supported by GCC@. If @var{n} is zero, then no
02f52e19 1714line-wrapping will be done; each error message will appear on a single
764dbbf2
GDR
1715line.
1716
cd3bb277 1717@opindex fdiagnostics-show-location
764dbbf2 1718@item -fdiagnostics-show-location=once
b192711e 1719Only meaningful in line-wrapping mode. Instructs the diagnostic messages
764dbbf2
GDR
1720reporter to emit @emph{once} source location information; that is, in
1721case the message is too long to fit on a single physical line and has to
1722be wrapped, the source location won't be emitted (as prefix) again,
1723over and over, in subsequent continuation lines. This is the default
c21cd8b1 1724behavior.
764dbbf2
GDR
1725
1726@item -fdiagnostics-show-location=every-line
1727Only meaningful in line-wrapping mode. Instructs the diagnostic
1728messages reporter to emit the same source location information (as
4fe9b91c 1729prefix) for physical lines that result from the process of breaking
b192711e 1730a message which is too long to fit on a single line.
764dbbf2
GDR
1731
1732@end table
1733
74291a4b
MM
1734@node Warning Options
1735@section Options to Request or Suppress Warnings
1736@cindex options to control warnings
1737@cindex warning messages
1738@cindex messages, warning
1739@cindex suppressing warnings
1740
1741Warnings are diagnostic messages that report constructions which
1742are not inherently erroneous but which are risky or suggest there
1743may have been an error.
1744
1745You can request many specific warnings with options beginning @samp{-W},
630d3d5a 1746for example @option{-Wimplicit} to request warnings on implicit
74291a4b
MM
1747declarations. Each of these specific warning options also has a
1748negative form beginning @samp{-Wno-} to turn off warnings;
630d3d5a 1749for example, @option{-Wno-implicit}. This manual lists only one of the
74291a4b
MM
1750two forms, whichever is not the default.
1751
0c2d1a2a 1752These options control the amount and kinds of warnings produced by GCC:
74291a4b 1753
2642624b 1754@table @gcctabopt
74291a4b
MM
1755@cindex syntax checking
1756@item -fsyntax-only
cd3bb277 1757@opindex fsyntax-only
74291a4b
MM
1758Check the code for syntax errors, but don't do anything beyond that.
1759
1760@item -pedantic
cd3bb277 1761@opindex pedantic
074e95e3
JM
1762Issue all the warnings demanded by strict ISO C and ISO C++;
1763reject all programs that use forbidden extensions, and some other
1764programs that do not follow ISO C and ISO C++. For ISO C, follows the
630d3d5a 1765version of the ISO C standard specified by any @option{-std} option used.
74291a4b 1766
074e95e3 1767Valid ISO C and ISO C++ programs should compile properly with or without
5490d604 1768this option (though a rare few will require @option{-ansi} or a
161d7b59 1769@option{-std} option specifying the required version of ISO C)@. However,
b1d16193
JL
1770without this option, certain GNU extensions and traditional C and C++
1771features are supported as well. With this option, they are rejected.
74291a4b 1772
630d3d5a 1773@option{-pedantic} does not cause warning messages for use of the
74291a4b
MM
1774alternate keywords whose names begin and end with @samp{__}. Pedantic
1775warnings are also disabled in the expression that follows
1776@code{__extension__}. However, only system header files should use
1777these escape routes; application programs should avoid them.
1778@xref{Alternate Keywords}.
1779
630d3d5a 1780Some users try to use @option{-pedantic} to check programs for strict ISO
74291a4b 1781C conformance. They soon find that it does not do quite what they want:
c1030c7c 1782it finds some non-ISO practices, but not all---only those for which
074e95e3
JM
1783ISO C @emph{requires} a diagnostic, and some others for which
1784diagnostics have been added.
74291a4b 1785
074e95e3 1786A feature to report any failure to conform to ISO C might be useful in
74291a4b 1787some instances, but would require considerable additional work and would
630d3d5a 1788be quite different from @option{-pedantic}. We don't have plans to
892d0a6d 1789support such a feature in the near future.
74291a4b 1790
91ea548a
JM
1791Where the standard specified with @option{-std} represents a GNU
1792extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1793corresponding @dfn{base standard}, the version of ISO C on which the GNU
1794extended dialect is based. Warnings from @option{-pedantic} are given
1795where they are required by the base standard. (It would not make sense
1796for such warnings to be given only for features not in the specified GNU
1797C dialect, since by definition the GNU dialects of C include all
1798features the compiler supports with the given option, and there would be
1799nothing to warn about.)
1800
74291a4b 1801@item -pedantic-errors
cd3bb277 1802@opindex pedantic-errors
630d3d5a 1803Like @option{-pedantic}, except that errors are produced rather than
74291a4b
MM
1804warnings.
1805
1806@item -w
cd3bb277 1807@opindex w
74291a4b
MM
1808Inhibit all warning messages.
1809
1810@item -Wno-import
cd3bb277 1811@opindex Wno-import
74291a4b
MM
1812Inhibit warning messages about the use of @samp{#import}.
1813
1814@item -Wchar-subscripts
cd3bb277 1815@opindex Wchar-subscripts
74291a4b
MM
1816Warn if an array subscript has type @code{char}. This is a common cause
1817of error, as programmers often forget that this type is signed on some
1818machines.
1819
1820@item -Wcomment
cd3bb277 1821@opindex Wcomment
74291a4b
MM
1822Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1823comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1824
1825@item -Wformat
cd3bb277 1826@opindex Wformat
74291a4b
MM
1827Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1828the arguments supplied have types appropriate to the format string
26f6672d
JM
1829specified, and that the conversions specified in the format string make
1830sense. This includes standard functions, and others specified by format
1831attributes (@pxref{Function Attributes}), in the @code{printf},
1832@code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1833not in the C standard) families.
74291a4b 1834
8308e0b7
JM
1835The formats are checked against the format features supported by GNU
1836libc version 2.2. These include all ISO C89 and C99 features, as well
1837as features from the Single Unix Specification and some BSD and GNU
1838extensions. Other library implementations may not support all these
1839features; GCC does not support warning about features that go beyond a
630d3d5a
JM
1840particular library's limitations. However, if @option{-pedantic} is used
1841with @option{-Wformat}, warnings will be given about format features not
26f6672d
JM
1842in the selected standard version (but not for @code{strfmon} formats,
1843since those are not in any version of the C standard). @xref{C Dialect
1844Options,,Options Controlling C Dialect}.
8308e0b7 1845
630d3d5a
JM
1846@option{-Wformat} is included in @option{-Wall}. For more control over some
1847aspects of format checking, the options @option{-Wno-format-y2k},
1848@option{-Wno-format-extra-args}, @option{-Wformat-nonliteral},
1849@option{-Wformat-security} and @option{-Wformat=2} are available, but are
1850not included in @option{-Wall}.
4d808927
JM
1851
1852@item -Wno-format-y2k
cd3bb277 1853@opindex Wno-format-y2k
630d3d5a 1854If @option{-Wformat} is specified, do not warn about @code{strftime}
4d808927
JM
1855formats which may yield only a two-digit year.
1856
1857@item -Wno-format-extra-args
cd3bb277 1858@opindex Wno-format-extra-args
630d3d5a 1859If @option{-Wformat} is specified, do not warn about excess arguments to a
4d808927
JM
1860@code{printf} or @code{scanf} format function. The C standard specifies
1861that such arguments are ignored.
1862
7e5fb12f
JM
1863Where the unused arguments lie between used arguments that are
1864specified with @samp{$} operand number specifications, normally
1865warnings are still given, since the implementation could not know what
1866type to pass to @code{va_arg} to skip the unused arguments. However,
1867in the case of @code{scanf} formats, this option will suppress the
1868warning if the unused arguments are all pointers, since the Single
1869Unix Specification says that such unused arguments are allowed.
1870
4d808927 1871@item -Wformat-nonliteral
cd3bb277 1872@opindex Wformat-nonliteral
630d3d5a 1873If @option{-Wformat} is specified, also warn if the format string is not a
4d808927
JM
1874string literal and so cannot be checked, unless the format function
1875takes its format arguments as a @code{va_list}.
1876
c907e684 1877@item -Wformat-security
cd3bb277 1878@opindex Wformat-security
630d3d5a 1879If @option{-Wformat} is specified, also warn about uses of format
c907e684
JM
1880functions that represent possible security problems. At present, this
1881warns about calls to @code{printf} and @code{scanf} functions where the
1882format string is not a string literal and there are no format arguments,
1883as in @code{printf (foo);}. This may be a security hole if the format
1884string came from untrusted input and contains @samp{%n}. (This is
630d3d5a
JM
1885currently a subset of what @option{-Wformat-nonliteral} warns about, but
1886in future warnings may be added to @option{-Wformat-security} that are not
1887included in @option{-Wformat-nonliteral}.)
c907e684 1888
4d808927 1889@item -Wformat=2
cd3bb277 1890@opindex Wformat=2
630d3d5a
JM
1891Enable @option{-Wformat} plus format checks not included in
1892@option{-Wformat}. Currently equivalent to @samp{-Wformat
c907e684 1893-Wformat-nonliteral -Wformat-security}.
4d808927 1894
e9a25f70 1895@item -Wimplicit-int
cd3bb277 1896@opindex Wimplicit-int
e9a25f70
JL
1897Warn when a declaration does not specify a type.
1898
f5963e61
JL
1899@item -Wimplicit-function-declaration
1900@itemx -Werror-implicit-function-declaration
cd3bb277
JM
1901@opindex Wimplicit-function-declaration
1902@opindex Werror-implicit-function-declaration
f5963e61
JL
1903Give a warning (or error) whenever a function is used before being
1904declared.
e9a25f70 1905
74291a4b 1906@item -Wimplicit
cd3bb277 1907@opindex Wimplicit
630d3d5a 1908Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
861bb6c1
JL
1909
1910@item -Wmain
cd3bb277 1911@opindex Wmain
861bb6c1
JL
1912Warn if the type of @samp{main} is suspicious. @samp{main} should be a
1913function with external linkage, returning int, taking either zero
1914arguments, two, or three arguments of appropriate types.
4a870dba 1915
1f0c3120 1916@item -Wmissing-braces
cd3bb277 1917@opindex Wmissing-braces
1f0c3120
JM
1918Warn if an aggregate or union initializer is not fully bracketed. In
1919the following example, the initializer for @samp{a} is not fully
1920bracketed, but that for @samp{b} is fully bracketed.
1921
1922@smallexample
1923int a[2][2] = @{ 0, 1, 2, 3 @};
1924int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1925@end smallexample
1926
74291a4b 1927@item -Wparentheses
cd3bb277 1928@opindex Wparentheses
74291a4b
MM
1929Warn if parentheses are omitted in certain contexts, such
1930as when there is an assignment in a context where a truth value
1931is expected, or when operators are nested whose precedence people
1932often get confused about.
1933
e9a25f70
JL
1934Also warn about constructions where there may be confusion to which
1935@code{if} statement an @code{else} branch belongs. Here is an example of
1936such a case:
1937
1938@smallexample
aee96fe9 1939@group
e9a25f70
JL
1940@{
1941 if (a)
1942 if (b)
1943 foo ();
1944 else
1945 bar ();
1946@}
aee96fe9 1947@end group
e9a25f70
JL
1948@end smallexample
1949
1950In C, every @code{else} branch belongs to the innermost possible @code{if}
1951statement, which in this example is @code{if (b)}. This is often not
1952what the programmer expected, as illustrated in the above example by
1953indentation the programmer chose. When there is the potential for this
f0523f02 1954confusion, GCC will issue a warning when this flag is specified.
e9a25f70
JL
1955To eliminate the warning, add explicit braces around the innermost
1956@code{if} statement so there is no way the @code{else} could belong to
1957the enclosing @code{if}. The resulting code would look like this:
1958
1959@smallexample
aee96fe9 1960@group
e9a25f70
JL
1961@{
1962 if (a)
1963 @{
1964 if (b)
1965 foo ();
1966 else
1967 bar ();
1968 @}
1969@}
aee96fe9 1970@end group
e9a25f70
JL
1971@end smallexample
1972
bb58bec5 1973@item -Wsequence-point
cd3bb277 1974@opindex Wsequence-point
bb58bec5
JM
1975Warn about code that may have undefined semantics because of violations
1976of sequence point rules in the C standard.
1977
1978The C standard defines the order in which expressions in a C program are
1979evaluated in terms of @dfn{sequence points}, which represent a partial
1980ordering between the execution of parts of the program: those executed
1981before the sequence point, and those executed after it. These occur
1982after the evaluation of a full expression (one which is not part of a
1983larger expression), after the evaluation of the first operand of a
1984@code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1985function is called (but after the evaluation of its arguments and the
1986expression denoting the called function), and in certain other places.
1987Other than as expressed by the sequence point rules, the order of
1988evaluation of subexpressions of an expression is not specified. All
1989these rules describe only a partial order rather than a total order,
1990since, for example, if two functions are called within one expression
1991with no sequence point between them, the order in which the functions
1992are called is not specified. However, the standards committee have
1993ruled that function calls do not overlap.
1994
1995It is not specified when between sequence points modifications to the
1996values of objects take effect. Programs whose behavior depends on this
1997have undefined behavior; the C standard specifies that ``Between the
1998previous and next sequence point an object shall have its stored value
1999modified at most once by the evaluation of an expression. Furthermore,
2000the prior value shall be read only to determine the value to be
2001stored.''. If a program breaks these rules, the results on any
2002particular implementation are entirely unpredictable.
2003
2004Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2005= b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2006diagnosed by this option, and it may give an occasional false positive
2007result, but in general it has been found fairly effective at detecting
2008this sort of problem in programs.
2009
2010The present implementation of this option only works for C programs. A
2011future implementation may also work for C++ programs.
2012
9c34dbbf
ZW
2013The C standard is worded confusingly, therefore there is some debate
2014over the precise meaning of the sequence point rules in subtle cases.
2015Links to discussions of the problem, including proposed formal
2016definitions, may be found on our readings page, at
c5122d75 2017@w{@uref{http://gcc.gnu.org/readings.html}}.
bb58bec5 2018
74291a4b 2019@item -Wreturn-type
cd3bb277 2020@opindex Wreturn-type
32c4c36c
ML
2021Warn whenever a function is defined with a return-type that defaults to
2022@code{int}. Also warn about any @code{return} statement with no
02f52e19 2023return-value in a function whose return-type is not @code{void}.
32c4c36c
ML
2024
2025For C++, a function without return type always produces a diagnostic
767094dd 2026message, even when @option{-Wno-return-type} is specified. The only
32c4c36c 2027exceptions are @samp{main} and functions defined in system headers.
74291a4b
MM
2028
2029@item -Wswitch
cd3bb277 2030@opindex Wswitch
74291a4b
MM
2031Warn whenever a @code{switch} statement has an index of enumeral type
2032and lacks a @code{case} for one or more of the named codes of that
2033enumeration. (The presence of a @code{default} label prevents this
2034warning.) @code{case} labels outside the enumeration range also
2035provoke warnings when this option is used.
2036
2037@item -Wtrigraphs
cd3bb277 2038@opindex Wtrigraphs
f2ecb02d
JM
2039Warn if any trigraphs are encountered that might change the meaning of
2040the program (trigraphs within comments are not warned about).
74291a4b 2041
078721e1 2042@item -Wunused-function
cd3bb277 2043@opindex Wunused-function
078721e1
AC
2044Warn whenever a static function is declared but not defined or a
2045non\-inline static function is unused.
74291a4b 2046
078721e1 2047@item -Wunused-label
cd3bb277 2048@opindex Wunused-label
078721e1
AC
2049Warn whenever a label is declared but not used.
2050
2051To suppress this warning use the @samp{unused} attribute
2052(@pxref{Variable Attributes}).
2053
2054@item -Wunused-parameter
cd3bb277 2055@opindex Wunused-parameter
078721e1
AC
2056Warn whenever a function parameter is unused aside from its declaration.
2057
2058To suppress this warning use the @samp{unused} attribute
2059(@pxref{Variable Attributes}).
956d6950 2060
078721e1 2061@item -Wunused-variable
cd3bb277 2062@opindex Wunused-variable
078721e1
AC
2063Warn whenever a local variable or non-constant static variable is unused
2064aside from its declaration
2065
2066To suppress this warning use the @samp{unused} attribute
74291a4b
MM
2067(@pxref{Variable Attributes}).
2068
078721e1 2069@item -Wunused-value
cd3bb277 2070@opindex Wunused-value
078721e1
AC
2071Warn whenever a statement computes a result that is explicitly not used.
2072
2073To suppress this warning cast the expression to @samp{void}.
2074
2075@item -Wunused
cd3bb277 2076@opindex Wunused
630d3d5a 2077All all the above @option{-Wunused} options combined.
078721e1
AC
2078
2079In order to get a warning about an unused function parameter, you must
b192711e 2080either specify @samp{-W -Wunused} or separately specify
630d3d5a 2081@option{-Wunused-parameter}.
078721e1 2082
74291a4b 2083@item -Wuninitialized
cd3bb277 2084@opindex Wuninitialized
c5c76735
JL
2085Warn if an automatic variable is used without first being initialized or
2086if a variable may be clobbered by a @code{setjmp} call.
74291a4b
MM
2087
2088These warnings are possible only in optimizing compilation,
2089because they require data flow information that is computed only
630d3d5a 2090when optimizing. If you don't specify @option{-O}, you simply won't
74291a4b
MM
2091get these warnings.
2092
2093These warnings occur only for variables that are candidates for
2094register allocation. Therefore, they do not occur for a variable that
2095is declared @code{volatile}, or whose address is taken, or whose size
2096is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
2097structures, unions or arrays, even when they are in registers.
2098
2099Note that there may be no warning about a variable that is used only
2100to compute a value that itself is never used, because such
2101computations may be deleted by data flow analysis before the warnings
2102are printed.
2103
0c2d1a2a 2104These warnings are made optional because GCC is not smart
74291a4b
MM
2105enough to see all the reasons why the code might be correct
2106despite appearing to have an error. Here is one example of how
2107this can happen:
2108
2109@smallexample
aee96fe9 2110@group
74291a4b
MM
2111@{
2112 int x;
2113 switch (y)
2114 @{
2115 case 1: x = 1;
2116 break;
2117 case 2: x = 4;
2118 break;
2119 case 3: x = 5;
2120 @}
2121 foo (x);
2122@}
aee96fe9 2123@end group
74291a4b
MM
2124@end smallexample
2125
2126@noindent
2127If the value of @code{y} is always 1, 2 or 3, then @code{x} is
0c2d1a2a 2128always initialized, but GCC doesn't know this. Here is
74291a4b
MM
2129another common case:
2130
2131@smallexample
2132@{
2133 int save_y;
2134 if (change_y) save_y = y, y = new_y;
2135 @dots{}
2136 if (change_y) y = save_y;
2137@}
2138@end smallexample
2139
2140@noindent
2141This has no bug because @code{save_y} is used only if it is set.
2142
20300b05 2143@cindex @code{longjmp} warnings
b192711e 2144This option also warns when a non-volatile automatic variable might be
c5c76735
JL
2145changed by a call to @code{longjmp}. These warnings as well are possible
2146only in optimizing compilation.
20300b05
GK
2147
2148The compiler sees only the calls to @code{setjmp}. It cannot know
2149where @code{longjmp} will be called; in fact, a signal handler could
2150call it at any point in the code. As a result, you may get a warning
2151even when there is in fact no problem because @code{longjmp} cannot
2152in fact be called at the place which would cause a problem.
2153
74291a4b
MM
2154Some spurious warnings can be avoided if you declare all the functions
2155you use that never return as @code{noreturn}. @xref{Function
2156Attributes}.
2157
aee96fe9 2158@item -Wreorder @r{(C++ only)}
cd3bb277 2159@opindex Wreorder
c5c76735
JL
2160@cindex reordering, warning
2161@cindex warning for reordering of member initializers
2162Warn when the order of member initializers given in the code does not
2163match the order in which they must be executed. For instance:
2164
d300e551 2165@item -Wunknown-pragmas
cd3bb277 2166@opindex Wunknown-pragmas
d300e551
NC
2167@cindex warning for unknown pragmas
2168@cindex unknown pragmas, warning
2169@cindex pragmas, warning of unknown
2170Warn when a #pragma directive is encountered which is not understood by
161d7b59 2171GCC@. If this command line option is used, warnings will even be issued
d300e551 2172for unknown pragmas in system header files. This is not the case if
630d3d5a 2173the warnings were only enabled by the @option{-Wall} command line option.
d300e551 2174
74291a4b 2175@item -Wall
cd3bb277 2176@opindex Wall
74291a4b
MM
2177All of the above @samp{-W} options combined. This enables all the
2178warnings about constructions that some users consider questionable, and
2179that are easy to avoid (or modify to prevent the warning), even in
2180conjunction with macros.
2181@end table
2182
630d3d5a 2183The following @option{-W@dots{}} options are not implied by @option{-Wall}.
74291a4b
MM
2184Some of them warn about constructions that users generally do not
2185consider questionable, but which occasionally you might wish to check
2186for; others warn about constructions that are necessary or hard to avoid
2187in some cases, and there is no simple way to modify the code to suppress
2188the warning.
2189
2642624b 2190@table @gcctabopt
74291a4b 2191@item -W
cd3bb277 2192@opindex W
74291a4b
MM
2193Print extra warning messages for these events:
2194
2195@itemize @bullet
74291a4b
MM
2196@item
2197A function can return either with or without a value. (Falling
2198off the end of the function body is considered returning without
2199a value.) For example, this function would evoke such a
2200warning:
2201
2202@smallexample
2203@group
2204foo (a)
2205@{
2206 if (a > 0)
2207 return a;
2208@}
2209@end group
2210@end smallexample
2211
2212@item
2213An expression-statement or the left-hand side of a comma expression
2214contains no side effects.
2215To suppress the warning, cast the unused expression to void.
2216For example, an expression such as @samp{x[i,j]} will cause a warning,
2217but @samp{x[(void)i,j]} will not.
2218
2219@item
2220An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2221
2222@item
2223A comparison like @samp{x<=y<=z} appears; this is equivalent to
2224@samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2225that of ordinary mathematical notation.
2226
2227@item
2228Storage-class specifiers like @code{static} are not the first things in
2229a declaration. According to the C Standard, this usage is obsolescent.
2230
e0c9fbb7
JM
2231@item
2232The return type of a function has a type qualifier such as @code{const}.
2233Such a type qualifier has no effect, since the value returned by a
2234function is not an lvalue. (But don't warn about the GNU extension of
2235@code{volatile void} return types. That extension will be warned about
630d3d5a 2236if @option{-pedantic} is specified.)
e0c9fbb7 2237
74291a4b 2238@item
630d3d5a 2239If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
74291a4b
MM
2240arguments.
2241
e9a25f70
JL
2242@item
2243A comparison between signed and unsigned values could produce an
2244incorrect result when the signed value is converted to unsigned.
630d3d5a 2245(But don't warn if @option{-Wno-sign-compare} is also specified.)
e9a25f70 2246
74291a4b
MM
2247@item
2248An aggregate has a partly bracketed initializer.
2249For example, the following code would evoke such a warning,
2250because braces are missing around the initializer for @code{x.h}:
2251
2252@smallexample
2253struct s @{ int f, g; @};
2254struct t @{ struct s h; int i; @};
2255struct t x = @{ 1, 2, 3 @};
2256@end smallexample
dbde0d5d
BH
2257
2258@item
2259An aggregate has an initializer which does not initialize all members.
2260For example, the following code would cause such a warning, because
2261@code{x.h} would be implicitly initialized to zero:
2262
2263@smallexample
2264struct s @{ int f, g, h; @};
2265struct s x = @{ 3, 4 @};
2266@end smallexample
74291a4b
MM
2267@end itemize
2268
75227a33
GK
2269@item -Wno-div-by-zero
2270@opindex Wno-div-by-zero
2271@opindex Wdiv-by-zero
2272Do not warn about compile-time integer division by zero. Floating point
2273division by zero is not warned about, as it can be a legitimate way of
2274obtaining infinities and NaNs.
2275
2276@item -Wsystem-headers
2277@opindex Wsystem-headers
2278@cindex warnings from system headers
2279@cindex system headers, warnings from
2280Print warning messages for constructs found in system header files.
2281Warnings from system headers are normally suppressed, on the assumption
2282that they usually do not indicate real problems and would only make the
2283compiler output harder to read. Using this command line option tells
2284GCC to emit warnings from system headers as if they occurred in user
2285code. However, note that using @option{-Wall} in conjunction with this
2286option will @emph{not} warn about unknown pragmas in system
2287headers---for that, @option{-Wunknown-pragmas} must also be used.
2288
f793a95e 2289@item -Wfloat-equal
cd3bb277 2290@opindex Wfloat-equal
f793a95e
JL
2291Warn if floating point values are used in equality comparisons.
2292
488d3985
GK
2293The idea behind this is that sometimes it is convenient (for the
2294programmer) to consider floating-point values as approximations to
2295infinitely precise real numbers. If you are doing this, then you need
2296to compute (by analysing the code, or in some other way) the maximum or
2297likely maximum error that the computation introduces, and allow for it
2298when performing comparisons (and when producing output, but that's a
2299different problem). In particular, instead of testing for equality, you
2300would check to see whether the two values have ranges that overlap; and
2301this is done with the relational operators, so equality comparisons are
2302probably mistaken.
2303
aee96fe9 2304@item -Wtraditional @r{(C only)}
cd3bb277 2305@opindex Wtraditional
74291a4b 2306Warn about certain constructs that behave differently in traditional and
161d7b59 2307ISO C@. Also warn about ISO C constructs that have no traditional C
c8abc684 2308equivalent, and/or problematic constructs which should be avoided.
74291a4b
MM
2309
2310@itemize @bullet
2311@item
da312b55
NB
2312Macro parameters that appear within string literals in the macro body.
2313In traditional C macro replacement takes place within string literals,
161d7b59 2314but does not in ISO C@.
da312b55
NB
2315
2316@item
2317In traditional C, some preprocessor directives did not exist.
2318Traditional preprocessors would only consider a line to be a directive
2319if the @samp{#} appeared in column 1 on the line. Therefore
630d3d5a 2320@option{-Wtraditional} warns about directives that traditional C
da312b55
NB
2321understands but would ignore because the @samp{#} does not appear as the
2322first character on the line. It also suggests you hide directives like
2323@samp{#pragma} not understood by traditional C by indenting them. Some
c21cd8b1 2324traditional implementations would not recognize @samp{#elif}, so it
da312b55
NB
2325suggests avoiding it altogether.
2326
2327@item
2328A function-like macro that appears without arguments.
2329
2330@item
2331The unary plus operator.
2332
2333@item
c771326b
JM
2334The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2335constant suffixes. (Traditional C does support the @samp{L} suffix on integer
da312b55 2336constants.) Note, these suffixes appear in macros defined in the system
e979f9e8 2337headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
c8abc684
KG
2338Use of these macros in user code might normally lead to spurious
2339warnings, however gcc's integrated preprocessor has enough context to
2340avoid warning in these cases.
74291a4b
MM
2341
2342@item
2343A function declared external in one block and then used after the end of
2344the block.
2345
2346@item
2347A @code{switch} statement has an operand of type @code{long}.
db838bb8
KG
2348
2349@item
2350A non-@code{static} function declaration follows a @code{static} one.
2351This construct is not accepted by some traditional C compilers.
48776cde
KG
2352
2353@item
c1030c7c 2354The ISO type of an integer constant has a different width or
48776cde 2355signedness from its traditional type. This warning is only issued if
e979f9e8 2356the base of the constant is ten. I.e.@: hexadecimal or octal values, which
48776cde 2357typically represent bit patterns, are not warned about.
bb66adca
KG
2358
2359@item
c1030c7c 2360Usage of ISO string concatenation is detected.
7f094a94 2361
895ea614
KG
2362@item
2363Initialization of automatic aggregates.
2364
2365@item
2366Identifier conflicts with labels. Traditional C lacks a separate
2367namespace for labels.
253b6b82
KG
2368
2369@item
2370Initialization of unions. If the initializer is zero, the warning is
2371omitted. This is done under the assumption that the zero initializer in
e979f9e8 2372user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
253b6b82
KG
2373initializer warnings and relies on default initialization to zero in the
2374traditional C case.
03829ad2
KG
2375
2376@item
3ed56f8a
KG
2377Conversions by prototypes between fixed/floating point values and vice
2378versa. The absence of these prototypes when compiling with traditional
2379C would cause serious problems. This is a subset of the possible
630d3d5a 2380conversion warnings, for the full set use @option{-Wconversion}.
74291a4b
MM
2381@end itemize
2382
861bb6c1 2383@item -Wundef
cd3bb277 2384@opindex Wundef
861bb6c1
JL
2385Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2386
909de5da
PE
2387@item -Wendif-labels
2388@opindex Wendif-labels
2389Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2390
74291a4b 2391@item -Wshadow
cd3bb277 2392@opindex Wshadow
d773df5a
DB
2393Warn whenever a local variable shadows another local variable, parameter or
2394global variable or whenever a built-in function is shadowed.
74291a4b 2395
74291a4b 2396@item -Wlarger-than-@var{len}
cd3bb277 2397@opindex Wlarger-than
74291a4b
MM
2398Warn whenever an object of larger than @var{len} bytes is defined.
2399
2400@item -Wpointer-arith
cd3bb277 2401@opindex Wpointer-arith
74291a4b
MM
2402Warn about anything that depends on the ``size of'' a function type or
2403of @code{void}. GNU C assigns these types a size of 1, for
2404convenience in calculations with @code{void *} pointers and pointers
2405to functions.
2406
aee96fe9 2407@item -Wbad-function-cast @r{(C only)}
cd3bb277 2408@opindex Wbad-function-cast
74291a4b
MM
2409Warn whenever a function call is cast to a non-matching type.
2410For example, warn if @code{int malloc()} is cast to @code{anything *}.
2411
2412@item -Wcast-qual
cd3bb277 2413@opindex Wcast-qual
74291a4b
MM
2414Warn whenever a pointer is cast so as to remove a type qualifier from
2415the target type. For example, warn if a @code{const char *} is cast
2416to an ordinary @code{char *}.
2417
2418@item -Wcast-align
cd3bb277 2419@opindex Wcast-align
74291a4b
MM
2420Warn whenever a pointer is cast such that the required alignment of the
2421target is increased. For example, warn if a @code{char *} is cast to
2422an @code{int *} on machines where integers can only be accessed at
2423two- or four-byte boundaries.
2424
2425@item -Wwrite-strings
cd3bb277 2426@opindex Wwrite-strings
aee96fe9
JM
2427When compiling C, give string constants the type @code{const
2428char[@var{length}]} so that
74291a4b 2429copying the address of one into a non-@code{const} @code{char *}
aee96fe9
JM
2430pointer will get a warning; when compiling C++, warn about the
2431deprecated conversion from string constants to @code{char *}.
2432These warnings will help you find at
74291a4b
MM
2433compile time code that can try to write into a string constant, but
2434only if you have been very careful about using @code{const} in
2435declarations and prototypes. Otherwise, it will just be a nuisance;
630d3d5a 2436this is why we did not make @option{-Wall} request these warnings.
74291a4b
MM
2437
2438@item -Wconversion
cd3bb277 2439@opindex Wconversion
74291a4b
MM
2440Warn if a prototype causes a type conversion that is different from what
2441would happen to the same argument in the absence of a prototype. This
2442includes conversions of fixed point to floating and vice versa, and
2443conversions changing the width or signedness of a fixed point argument
2444except when the same as the default promotion.
2445
2446Also, warn if a negative integer constant expression is implicitly
2447converted to an unsigned type. For example, warn about the assignment
2448@code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2449casts like @code{(unsigned) -1}.
2450
e9a25f70 2451@item -Wsign-compare
cd3bb277 2452@opindex Wsign-compare
e9a25f70
JL
2453@cindex warning for comparison of signed and unsigned values
2454@cindex comparison of signed and unsigned values, warning
2455@cindex signed and unsigned values, comparison warning
2456Warn when a comparison between signed and unsigned values could produce
2457an incorrect result when the signed value is converted to unsigned.
630d3d5a
JM
2458This warning is also enabled by @option{-W}; to get the other warnings
2459of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
e9a25f70 2460
74291a4b 2461@item -Waggregate-return
cd3bb277 2462@opindex Waggregate-return
74291a4b
MM
2463Warn if any functions that return structures or unions are defined or
2464called. (In languages where you can return an array, this also elicits
2465a warning.)
2466
aee96fe9 2467@item -Wstrict-prototypes @r{(C only)}
cd3bb277 2468@opindex Wstrict-prototypes
74291a4b
MM
2469Warn if a function is declared or defined without specifying the
2470argument types. (An old-style function definition is permitted without
2471a warning if preceded by a declaration which specifies the argument
2472types.)
2473
aee96fe9 2474@item -Wmissing-prototypes @r{(C only)}
cd3bb277 2475@opindex Wmissing-prototypes
74291a4b
MM
2476Warn if a global function is defined without a previous prototype
2477declaration. This warning is issued even if the definition itself
2478provides a prototype. The aim is to detect global functions that fail
2479to be declared in header files.
2480
2481@item -Wmissing-declarations
cd3bb277 2482@opindex Wmissing-declarations
74291a4b
MM
2483Warn if a global function is defined without a previous declaration.
2484Do so even if the definition itself provides a prototype.
2485Use this option to detect global functions that are not declared in
2486header files.
2487
0ca3fb0a 2488@item -Wmissing-noreturn
cd3bb277 2489@opindex Wmissing-noreturn
0ca3fb0a
KG
2490Warn about functions which might be candidates for attribute @code{noreturn}.
2491Note these are only possible candidates, not absolute ones. Care should
2492be taken to manually verify functions actually do not ever return before
2493adding the @code{noreturn} attribute, otherwise subtle code generation
21c7361e
AJ
2494bugs could be introduced. You will not get a warning for @code{main} in
2495hosted C environments.
0ca3fb0a 2496
74ff4629 2497@item -Wmissing-format-attribute
cd3bb277
JM
2498@opindex Wmissing-format-attribute
2499@opindex Wformat
630d3d5a 2500If @option{-Wformat} is enabled, also warn about functions which might be
74ff4629
JM
2501candidates for @code{format} attributes. Note these are only possible
2502candidates, not absolute ones. GCC will guess that @code{format}
2503attributes might be appropriate for any function that calls a function
2504like @code{vprintf} or @code{vscanf}, but this might not always be the
2505case, and some functions for which @code{format} attributes are
2506appropriate may not be detected. This option has no effect unless
630d3d5a 2507@option{-Wformat} is enabled (possibly by @option{-Wall}).
74ff4629 2508
75227a33
GK
2509@item -Wno-multichar
2510@opindex Wno-multichar
2511@opindex Wmultichar
2512Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2513Usually they indicate a typo in the user's code, as they have
2514implementation-defined values, and should not be used in portable code.
2515
e23bd218
IR
2516@item -Wno-deprecated-declarations
2517@opindex Wno-deprecated-declarations
2518Do not warn about uses of functions, variables, and types marked as
f282ffb3 2519deprecated by using the @code{deprecated} attribute.
e23bd218
IR
2520(@pxref{Function Attributes}, @pxref{Variable Attributes},
2521@pxref{Type Attributes}.)
2522
3c12fcc2 2523@item -Wpacked
cd3bb277 2524@opindex Wpacked
3c12fcc2 2525Warn if a structure is given the packed attribute, but the packed
02f52e19 2526attribute has no effect on the layout or size of the structure.
3c12fcc2
GM
2527Such structures may be mis-aligned for little benefit. For
2528instance, in this code, the variable @code{f.x} in @code{struct bar}
2529will be misaligned even though @code{struct bar} does not itself
2530have the packed attribute:
2531
2532@smallexample
2533@group
2534struct foo @{
2535 int x;
2536 char a, b, c, d;
2537@} __attribute__((packed));
2538struct bar @{
2539 char z;
2540 struct foo f;
2541@};
2542@end group
2543@end smallexample
2544
2545@item -Wpadded
cd3bb277 2546@opindex Wpadded
3c12fcc2
GM
2547Warn if padding is included in a structure, either to align an element
2548of the structure or to align the whole structure. Sometimes when this
2549happens it is possible to rearrange the fields of the structure to
2550reduce the padding and so make the structure smaller.
2551
74291a4b 2552@item -Wredundant-decls
cd3bb277 2553@opindex Wredundant-decls
74291a4b
MM
2554Warn if anything is declared more than once in the same scope, even in
2555cases where multiple declaration is valid and changes nothing.
2556
aee96fe9 2557@item -Wnested-externs @r{(C only)}
cd3bb277 2558@opindex Wnested-externs
252215a7 2559Warn if an @code{extern} declaration is encountered within a function.
74291a4b 2560
312f6255 2561@item -Wunreachable-code
cd3bb277 2562@opindex Wunreachable-code
312f6255
GK
2563Warn if the compiler detects that code will never be executed.
2564
2565This option is intended to warn when the compiler detects that at
2566least a whole line of source code will never be executed, because
2567some condition is never satisfied or because it is after a
2568procedure that never returns.
2569
2570It is possible for this option to produce a warning even though there
2571are circumstances under which part of the affected line can be executed,
2572so care should be taken when removing apparently-unreachable code.
2573
2574For instance, when a function is inlined, a warning may mean that the
02f52e19 2575line is unreachable in only one inlined copy of the function.
312f6255 2576
630d3d5a 2577This option is not made part of @option{-Wall} because in a debugging
312f6255
GK
2578version of a program there is often substantial code which checks
2579correct functioning of the program and is, hopefully, unreachable
2580because the program does work. Another common use of unreachable
c21cd8b1 2581code is to provide behavior which is selectable at compile-time.
312f6255 2582
74291a4b 2583@item -Winline
cd3bb277 2584@opindex Winline
c5c76735 2585Warn if a function can not be inlined and it was declared as inline.
74291a4b 2586
795add94 2587@item -Wlong-long
cd3bb277
JM
2588@opindex Wlong-long
2589@opindex Wno-long-long
795add94 2590Warn if @samp{long long} type is used. This is default. To inhibit
630d3d5a
JM
2591the warning messages, use @option{-Wno-long-long}. Flags
2592@option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2593only when @option{-pedantic} flag is used.
795add94 2594
18424ae1 2595@item -Wdisabled-optimization
cd3bb277 2596@opindex Wdisabled-optimization
18424ae1
BL
2597Warn if a requested optimization pass is disabled. This warning does
2598not generally indicate that there is anything wrong with your code; it
2599merely indicates that GCC's optimizers were unable to handle the code
2600effectively. Often, the problem is that your code is too big or too
2601complex; GCC will refuse to optimize programs when the optimization
2602itself is likely to take inordinate amounts of time.
2603
74291a4b 2604@item -Werror
cd3bb277 2605@opindex Werror
74291a4b
MM
2606Make all warnings into errors.
2607@end table
2608
2609@node Debugging Options
0c2d1a2a 2610@section Options for Debugging Your Program or GCC
74291a4b
MM
2611@cindex options, debugging
2612@cindex debugging information options
2613
0c2d1a2a 2614GCC has various special options that are used for debugging
74291a4b
MM
2615either your program or GCC:
2616
2642624b 2617@table @gcctabopt
74291a4b 2618@item -g
cd3bb277 2619@opindex g
74291a4b 2620Produce debugging information in the operating system's native format
161d7b59 2621(stabs, COFF, XCOFF, or DWARF)@. GDB can work with this debugging
74291a4b
MM
2622information.
2623
630d3d5a 2624On most systems that use stabs format, @option{-g} enables use of extra
74291a4b
MM
2625debugging information that only GDB can use; this extra information
2626makes debugging work better in GDB but will probably make other debuggers
2627crash or
2628refuse to read the program. If you want to control for certain whether
630d3d5a 2629to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5f98259a
RK
2630@option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2631or @option{-gvms} (see below).
74291a4b 2632
630d3d5a
JM
2633Unlike most other C compilers, GCC allows you to use @option{-g} with
2634@option{-O}. The shortcuts taken by optimized code may occasionally
74291a4b
MM
2635produce surprising results: some variables you declared may not exist
2636at all; flow of control may briefly move where you did not expect it;
2637some statements may not be executed because they compute constant
2638results or their values were already at hand; some statements may
2639execute in different places because they were moved out of loops.
2640
2641Nevertheless it proves possible to debug optimized output. This makes
2642it reasonable to use the optimizer for programs that might have bugs.
2643
0c2d1a2a 2644The following options are useful when GCC is generated with the
74291a4b
MM
2645capability for more than one debugging format.
2646
2647@item -ggdb
cd3bb277 2648@opindex ggdb
161d7b59 2649Produce debugging information for use by GDB@. This means to use the
861bb6c1
JL
2650most expressive format available (DWARF 2, stabs, or the native format
2651if neither of those are supported), including GDB extensions if at all
2652possible.
74291a4b
MM
2653
2654@item -gstabs
cd3bb277 2655@opindex gstabs
74291a4b
MM
2656Produce debugging information in stabs format (if that is supported),
2657without GDB extensions. This is the format used by DBX on most BSD
2658systems. On MIPS, Alpha and System V Release 4 systems this option
161d7b59 2659produces stabs debugging output which is not understood by DBX or SDB@.
74291a4b
MM
2660On System V Release 4 systems this option requires the GNU assembler.
2661
2662@item -gstabs+
cd3bb277 2663@opindex gstabs+
74291a4b 2664Produce debugging information in stabs format (if that is supported),
161d7b59 2665using GNU extensions understood only by the GNU debugger (GDB)@. The
74291a4b
MM
2666use of these extensions is likely to make other debuggers crash or
2667refuse to read the program.
2668
2669@item -gcoff
cd3bb277 2670@opindex gcoff
74291a4b
MM
2671Produce debugging information in COFF format (if that is supported).
2672This is the format used by SDB on most System V systems prior to
2673System V Release 4.
2674
2675@item -gxcoff
cd3bb277 2676@opindex gxcoff
74291a4b
MM
2677Produce debugging information in XCOFF format (if that is supported).
2678This is the format used by the DBX debugger on IBM RS/6000 systems.
2679
2680@item -gxcoff+
cd3bb277 2681@opindex gxcoff+
74291a4b 2682Produce debugging information in XCOFF format (if that is supported),
161d7b59 2683using GNU extensions understood only by the GNU debugger (GDB)@. The
74291a4b
MM
2684use of these extensions is likely to make other debuggers crash or
2685refuse to read the program, and may cause assemblers other than the GNU
2686assembler (GAS) to fail with an error.
2687
2688@item -gdwarf
cd3bb277 2689@opindex gdwarf
861bb6c1
JL
2690Produce debugging information in DWARF version 1 format (if that is
2691supported). This is the format used by SDB on most System V Release 4
2692systems.
74291a4b
MM
2693
2694@item -gdwarf+
cd3bb277 2695@opindex gdwarf+
861bb6c1
JL
2696Produce debugging information in DWARF version 1 format (if that is
2697supported), using GNU extensions understood only by the GNU debugger
161d7b59 2698(GDB)@. The use of these extensions is likely to make other debuggers
861bb6c1
JL
2699crash or refuse to read the program.
2700
2701@item -gdwarf-2
cd3bb277 2702@opindex gdwarf-2
861bb6c1
JL
2703Produce debugging information in DWARF version 2 format (if that is
2704supported). This is the format used by DBX on IRIX 6.
74291a4b 2705
5f98259a
RK
2706@item -gvms
2707@opindex gvms
2708Produce debugging information in VMS debug format (if that is
2709supported). This is the format used by DEBUG on VMS systems.
2710
74291a4b
MM
2711@item -g@var{level}
2712@itemx -ggdb@var{level}
2713@itemx -gstabs@var{level}
2714@itemx -gcoff@var{level}
2715@itemx -gxcoff@var{level}
2716@itemx -gdwarf@var{level}
861bb6c1 2717@itemx -gdwarf-2@var{level}
5f98259a 2718@itemx -gvms@var{level}
74291a4b
MM
2719Request debugging information and also use @var{level} to specify how
2720much information. The default level is 2.
2721
2722Level 1 produces minimal information, enough for making backtraces in
2723parts of the program that you don't plan to debug. This includes
2724descriptions of functions and external variables, but no information
2725about local variables and no line numbers.
2726
2727Level 3 includes extra information, such as all the macro definitions
2728present in the program. Some debuggers support macro expansion when
630d3d5a 2729you use @option{-g3}.
74291a4b
MM
2730
2731@cindex @code{prof}
2732@item -p
cd3bb277 2733@opindex p
74291a4b
MM
2734Generate extra code to write profile information suitable for the
2735analysis program @code{prof}. You must use this option when compiling
2736the source files you want data about, and you must also use it when
2737linking.
2738
2739@cindex @code{gprof}
2740@item -pg
cd3bb277 2741@opindex pg
74291a4b
MM
2742Generate extra code to write profile information suitable for the
2743analysis program @code{gprof}. You must use this option when compiling
2744the source files you want data about, and you must also use it when
2745linking.
2746
2747@cindex @code{tcov}
2748@item -a
cd3bb277 2749@opindex a
74291a4b
MM
2750Generate extra code to write profile information for basic blocks, which will
2751record the number of times each basic block is executed, the basic block start
630d3d5a 2752address, and the function name containing the basic block. If @option{-g} is
74291a4b
MM
2753used, the line number and filename of the start of the basic block will also be
2754recorded. If not overridden by the machine description, the default action is
2755to append to the text file @file{bb.out}.
2756
2757This data could be analyzed by a program like @code{tcov}. Note,
2758however, that the format of the data is not what @code{tcov} expects.
2759Eventually GNU @code{gprof} should be extended to process this data.
2760
898f531b 2761@item -Q
cd3bb277 2762@opindex Q
898f531b
JL
2763Makes the compiler print out each function name as it is compiled, and
2764print some statistics about each pass when it finishes.
2765
1f0c3120 2766@item -ftime-report
cd3bb277 2767@opindex ftime-report
1f0c3120
JM
2768Makes the compiler print some statistics about the time consumed by each
2769pass when it finishes.
2770
2771@item -fmem-report
cd3bb277 2772@opindex fmem-report
1f0c3120
JM
2773Makes the compiler print some statistics about permanent memory
2774allocation when it finishes.
2775
861bb6c1 2776@item -fprofile-arcs
cd3bb277 2777@opindex fprofile-arcs
3de87bf2
JJ
2778Instrument @dfn{arcs} during compilation to generate coverage data
2779or for profile-directed block ordering. During execution the program
2780records how many times each branch is executed and how many times it is
2781taken. When the compiled program exits it saves this data to a file
2782called @file{@var{sourcename}.da} for each source file.
2783
2784For profile-directed block ordering, compile the program with
2785@option{-fprofile-arcs} plus optimization and code generation options,
2786generate the arc profile information by running the program on a
2787selected workload, and then compile the program again with the same
2788optimization and code generation options plus
630d3d5a 2789@option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3de87bf2
JJ
2790Control Optimization}).
2791
2792The other use of @option{-fprofile-arcs} is for use with @code{gcov},
2793when it is used with the @option{-ftest-coverage} option. GCC
2794supports two methods of determining code coverage: the options that
2795support @code{gcov}, and options @option{-a} and @option{-ax}, which
2796write information to text files. The options that support @code{gcov}
2797do not need to instrument every arc in the program, so a program compiled
2798with them runs faster than a program compiled with @option{-a}, which
2799adds instrumentation code to every basic block in the program. The
2800tradeoff: since @code{gcov} does not have execution counts for all
2801branches, it must start with the execution counts for the instrumented
2802branches, and then iterate over the program flow graph until the entire
2803graph has been solved. Hence, @code{gcov} runs a little more slowly than
2804a program which uses information from @option{-a} and @option{-ax}.
2805
2806With @option{-fprofile-arcs}, for each function of your program GCC
2807creates a program flow graph, then finds a spanning tree for the graph.
2808Only arcs that are not on the spanning tree have to be instrumented: the
2809compiler adds code to count the number of times that these arcs are
2810executed. When an arc is the only exit or only entrance to a block, the
2811instrumentation code can be added to the block; otherwise, a new basic
2812block must be created to hold the instrumentation code.
2813
2814This option makes it possible to estimate branch probabilities and to
2815calculate basic block execution counts. In general, basic block
2816execution counts as provided by @option{-a} do not give enough
2817information to estimate all branch probabilities.
861bb6c1
JL
2818
2819@need 2000
2820@item -ftest-coverage
cd3bb277 2821@opindex ftest-coverage
861bb6c1 2822Create data files for the @code{gcov} code-coverage utility
0c2d1a2a 2823(@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
861bb6c1
JL
2824The data file names begin with the name of your source file:
2825
2642624b 2826@table @gcctabopt
861bb6c1
JL
2827@item @var{sourcename}.bb
2828A mapping from basic blocks to line numbers, which @code{gcov} uses to
2829associate basic block execution counts with line numbers.
2830
2831@item @var{sourcename}.bbg
2832A list of all arcs in the program flow graph. This allows @code{gcov}
2833to reconstruct the program flow graph, so that it can compute all basic
2834block and arc execution counts from the information in the
3de87bf2 2835@code{@var{sourcename}.da} file.
861bb6c1
JL
2836@end table
2837
3de87bf2
JJ
2838Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
2839option adds instrumentation to the program, which then writes
2840execution counts to another data file:
2841
2842@table @gcctabopt
2843@item @var{sourcename}.da
2844Runtime arc execution counts, used in conjunction with the arc
2845information in the file @code{@var{sourcename}.bbg}.
2846@end table
2847
2848Coverage data will map better to the source files if
2849@option{-ftest-coverage} is used without optimization.
2850
74291a4b 2851@item -d@var{letters}
cd3bb277 2852@opindex d
74291a4b
MM
2853Says to make debugging dumps during compilation at times specified by
2854@var{letters}. This is used for debugging the compiler. The file names
375e2d5c 2855for most of the dumps are made by appending a pass number and a word to
02f52e19 2856the source file name (e.g. @file{foo.c.00.rtl} or @file{foo.c.01.sibling}).
375e2d5c 2857Here are the possible letters for use in @var{letters}, and their meanings:
74291a4b
MM
2858
2859@table @samp
375e2d5c 2860@item A
cd3bb277 2861@opindex dA
375e2d5c 2862Annotate the assembler output with miscellaneous debugging information.
956d6950 2863@item b
cd3bb277 2864@opindex db
38c1593d 2865Dump after computing branch probabilities, to @file{@var{file}.15.bp}.
48d9ade5 2866@item B
cd3bb277 2867@opindex dB
38c1593d 2868Dump after block reordering, to @file{@var{file}.30.bbro}.
032713aa 2869@item c
cd3bb277 2870@opindex dc
38c1593d 2871Dump after instruction combination, to the file @file{@var{file}.17.combine}.
470fc13d 2872@item C
cd3bb277 2873@opindex dC
38c1593d 2874Dump after the first if conversion, to the file @file{@var{file}.18.ce}.
032713aa 2875@item d
cd3bb277 2876@opindex dd
38c1593d 2877Dump after delayed branch scheduling, to @file{@var{file}.32.dbr}.
032713aa 2878@item D
cd3bb277 2879@opindex dD
f5963e61
JL
2880Dump all macro definitions, at the end of preprocessing, in addition to
2881normal output.
48d9ade5 2882@item e
cd3bb277 2883@opindex de
0826f1d8 2884Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
0b47e4c1 2885@file{@var{file}.07.ussa}.
470fc13d 2886@item E
cd3bb277 2887@opindex dE
38c1593d 2888Dump after the second if conversion, to @file{@var{file}.27.ce2}.
74291a4b 2889@item f
cd3bb277 2890@opindex df
38c1593d 2891Dump after life analysis, to @file{@var{file}.16.life}.
48d9ade5 2892@item F
cd3bb277 2893@opindex dF
38c1593d 2894Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
74291a4b 2895@item g
cd3bb277 2896@opindex dg
38c1593d 2897Dump after global register allocation, to @file{@var{file}.22.greg}.
0826f1d8
JL
2898@item h
2899@opindex dh
2900Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
1e4e4df2
KH
2901@item k
2902@opindex dk
38c1593d 2903Dump after reg-to-stack conversion, to @file{@var{file}.29.stack}.
0826f1d8 2904@item o
cd3bb277 2905@opindex do
38c1593d 2906Dump after post-reload optimizations, to @file{@var{file}.23.postreload}.
02f52e19 2907@item G
cd3bb277 2908@opindex dG
38c1593d 2909Dump after GCSE, to @file{@var{file}.11.gcse}.
48d9ade5 2910@item i
cd3bb277 2911@opindex di
48d9ade5 2912Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
032713aa 2913@item j
cd3bb277 2914@opindex dj
0826f1d8 2915Dump after the first jump optimization, to @file{@var{file}.03.jump}.
74291a4b 2916@item k
cd3bb277 2917@opindex dk
38c1593d 2918Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
032713aa 2919@item l
cd3bb277 2920@opindex dl
38c1593d 2921Dump after local register allocation, to @file{@var{file}.21.lreg}.
032713aa 2922@item L
cd3bb277 2923@opindex dL
38c1593d 2924Dump after loop optimization, to @file{@var{file}.12.loop}.
032713aa 2925@item M
cd3bb277 2926@opindex dM
032713aa 2927Dump after performing the machine dependent reorganisation pass, to
38c1593d 2928@file{@var{file}.31.mach}.
48d9ade5 2929@item n
cd3bb277 2930@opindex dn
38c1593d 2931Dump after register renumbering, to @file{@var{file}.26.rnreg}.
032713aa 2932@item N
cd3bb277 2933@opindex dN
38c1593d 2934Dump after the register move pass, to @file{@var{file}.19.regmove}.
032713aa 2935@item r
cd3bb277 2936@opindex dr
375e2d5c 2937Dump after RTL generation, to @file{@var{file}.00.rtl}.
032713aa 2938@item R
cd3bb277 2939@opindex dR
38c1593d 2940Dump after the second scheduling pass, to @file{@var{file}.28.sched2}.
032713aa 2941@item s
cd3bb277 2942@opindex ds
032713aa 2943Dump after CSE (including the jump optimization that sometimes follows
38c1593d 2944CSE), to @file{@var{file}.09.cse}.
032713aa 2945@item S
cd3bb277 2946@opindex dS
38c1593d 2947Dump after the first scheduling pass, to @file{@var{file}.20.sched}.
032713aa 2948@item t
cd3bb277 2949@opindex dt
032713aa 2950Dump after the second CSE pass (including the jump optimization that
38c1593d
JH
2951sometimes follows CSE), to @file{@var{file}.13.cse2}.
2952@item u
2953@opindex du
2954Dump after null pointer ellimination pass ti @file{@var{file}.08.null}.
48d9ade5 2955@item w
cd3bb277 2956@opindex dw
38c1593d 2957Dump after the second flow pass, to @file{@var{file}.24.flow2}.
470fc13d 2958@item X
cd3bb277 2959@opindex dX
9c34dbbf 2960Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
48d9ade5 2961@item z
cd3bb277 2962@opindex dz
38c1593d 2963Dump after the peephole pass, to @file{@var{file}.25.peephole2}.
74291a4b 2964@item a
cd3bb277 2965@opindex da
74291a4b
MM
2966Produce all the dumps listed above.
2967@item m
cd3bb277 2968@opindex dm
74291a4b
MM
2969Print statistics on memory usage, at the end of the run, to
2970standard error.
2971@item p
cd3bb277 2972@opindex dp
74291a4b 2973Annotate the assembler output with a comment indicating which
f20b5577
MM
2974pattern and alternative was used. The length of each instruction is
2975also printed.
2856c3e3 2976@item P
cd3bb277 2977@opindex dP
2856c3e3 2978Dump the RTL in the assembler output as a comment before each instruction.
630d3d5a 2979Also turns on @option{-dp} annotation.
375e2d5c 2980@item v
cd3bb277 2981@opindex dv
375e2d5c
RH
2982For each of the other indicated dump files (except for
2983@file{@var{file}.00.rtl}), dump a representation of the control flow graph
b192711e 2984suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
62a1403d 2985@item x
cd3bb277 2986@opindex dx
62a1403d
AS
2987Just generate RTL for a function instead of compiling it. Usually used
2988with @samp{r}.
032713aa 2989@item y
cd3bb277 2990@opindex dy
032713aa 2991Dump debugging information during parsing, to standard error.
74291a4b
MM
2992@end table
2993
b707b450 2994@item -fdump-unnumbered
cd3bb277 2995@opindex fdump-unnumbered
695ac33f 2996When doing debugging dumps (see @option{-d} option above), suppress instruction
b707b450 2997numbers and line number note output. This makes it more feasible to
b192711e 2998use diff on debugging dumps for compiler invocations with different
695ac33f 2999options, in particular with and without @option{-g}.
b707b450 3000
f70a54cb
CR
3001@item -fdump-translation-unit @r{(C and C++ only)}
3002@itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3003@opindex fdump-translation-unit
3004Dump a representation of the tree structure for the entire translation
3005unit to a file. The file name is made by appending @file{.tu} to the
3006source file name. If the @samp{-@var{options}} form is used, @var{options}
3007controls the details of the dump as described for the
3008@option{-fdump-tree} options.
3009
aee96fe9 3010@item -fdump-class-hierarchy @r{(C++ only)}
22367161 3011@itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
cd3bb277 3012@opindex fdump-class-hierarchy
e76b4820 3013Dump a representation of each class's hierarchy and virtual function
767094dd 3014table layout to a file. The file name is made by appending @file{.class}
22367161
NS
3015to the source file name. If the @samp{-@var{options}} form is used,
3016@var{options} controls the details of the dump as described for the
3017@option{-fdump-tree} options.
3018
3019@item -fdump-tree-@var{switch} @r{(C++ only)}
3020@itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3021@opindex fdump-tree
3022Control the dumping at various stages of processing the intermediate
3023language tree to a file. The file name is generated by appending a switch
3024specific suffix to the source file name. If the @samp{-@var{options}}
3025form is used, @var{options} is a list of @samp{-} separated options that
3026control the details of the dump. Not all options are applicable to all
3027dumps, those which are not meaningful will be ignored. The following
3028options are available
f71f87f9 3029
e76b4820 3030@table @samp
22367161 3031@item address
767094dd 3032Print the address of each node. Usually this is not meaningful as it
22367161
NS
3033changes according to the environment and source file. Its primary use
3034is for tying up a dump file with a debug environment.
3035@item slim
3036Inhibit dumping of members of a scope or body of a function merely
3037because that scope has been reached. Only dump such items when they
3038are directly reachable by some other path.
3039@item all
3040Turn on all options.
e76b4820
NS
3041@end table
3042
3043The following tree dumps are possible:
3044@table @samp
3045@item original
3046Dump before any tree based optimization, to @file{@var{file}.original}.
3047@item optimized
3048Dump after all tree based optimization, to @file{@var{file}.optimized}.
6be77748 3049@item inlined
9c34dbbf 3050Dump after function inlining, to @file{@var{file}.inlined}.
e76b4820 3051@end table
9965d119 3052
74291a4b 3053@item -save-temps
cd3bb277 3054@opindex save-temps
74291a4b
MM
3055Store the usual ``temporary'' intermediate files permanently; place them
3056in the current directory and name them based on the source file. Thus,
3057compiling @file{foo.c} with @samp{-c -save-temps} would produce files
f2ecb02d
JM
3058@file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
3059preprocessed @file{foo.i} output file even though the compiler now
3060normally uses an integrated preprocessor.
74291a4b 3061
03c41c05 3062@item -time
cd3bb277 3063@opindex time
03c41c05 3064Report the CPU time taken by each subprocess in the compilation
f2ecb02d
JM
3065sequence. For C source files, this is the compiler proper and assembler
3066(plus the linker if linking is done). The output looks like this:
03c41c05
ZW
3067
3068@smallexample
03c41c05
ZW
3069# cc1 0.12 0.01
3070# as 0.00 0.01
3071@end smallexample
3072
3073The first number on each line is the ``user time,'' that is time spent
3074executing the program itself. The second number is ``system time,''
3075time spent executing operating system routines on behalf of the program.
3076Both numbers are in seconds.
3077
74291a4b 3078@item -print-file-name=@var{library}
cd3bb277 3079@opindex print-file-name
74291a4b
MM
3080Print the full absolute name of the library file @var{library} that
3081would be used when linking---and don't do anything else. With this
0c2d1a2a 3082option, GCC does not compile or link anything; it just prints the
74291a4b
MM
3083file name.
3084
b1018de6
AO
3085@item -print-multi-directory
3086@opindex print-multi-directory
3087Print the directory name corresponding to the multilib selected by any
3088other switches present in the command line. This directory is supposed
3089to exist in @env{GCC_EXEC_PREFIX}.
3090
3091@item -print-multi-lib
3092@opindex print-multi-lib
3093Print the mapping from multilib directory names to compiler switches
3094that enable them. The directory name is separated from the switches by
3095@samp{;}, and each switch starts with an @samp{@@} instead of the
3096@samp{-}, without spaces between multiple switches. This is supposed to
3097ease shell-processing.
3098
74291a4b 3099@item -print-prog-name=@var{program}
cd3bb277 3100@opindex print-prog-name
630d3d5a 3101Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
74291a4b
MM
3102
3103@item -print-libgcc-file-name
cd3bb277 3104@opindex print-libgcc-file-name
630d3d5a 3105Same as @option{-print-file-name=libgcc.a}.
74291a4b 3106
630d3d5a 3107This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
74291a4b
MM
3108but you do want to link with @file{libgcc.a}. You can do
3109
3110@example
3111gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3112@end example
3113
3114@item -print-search-dirs
cd3bb277 3115@opindex print-search-dirs
74291a4b
MM
3116Print the name of the configured installation directory and a list of
3117program and library directories gcc will search---and don't do anything else.
3118
3119This is useful when gcc prints the error message
3c0b7970
JM
3120@samp{installation problem, cannot exec cpp0: No such file or directory}.
3121To resolve this you either need to put @file{cpp0} and the other compiler
74291a4b 3122components where gcc expects to find them, or you can set the environment
bedc7537 3123variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
74291a4b
MM
3124Don't forget the trailing '/'.
3125@xref{Environment Variables}.
1f0c3120
JM
3126
3127@item -dumpmachine
cd3bb277 3128@opindex dumpmachine
1f0c3120
JM
3129Print the compiler's target machine (for example,
3130@samp{i686-pc-linux-gnu})---and don't do anything else.
3131
3132@item -dumpversion
cd3bb277 3133@opindex dumpversion
1f0c3120
JM
3134Print the compiler version (for example, @samp{3.0})---and don't do
3135anything else.
3136
3137@item -dumpspecs
cd3bb277 3138@opindex dumpspecs
1f0c3120
JM
3139Print the compiler's built-in specs---and don't do anything else. (This
3140is used when GCC itself is being built.) @xref{Spec Files}.
74291a4b
MM
3141@end table
3142
3143@node Optimize Options
3144@section Options That Control Optimization
3145@cindex optimize options
3146@cindex options, optimization
3147
3148These options control various sorts of optimizations:
3149
2642624b 3150@table @gcctabopt
74291a4b
MM
3151@item -O
3152@itemx -O1
cd3bb277
JM
3153@opindex O
3154@opindex O1
74291a4b
MM
3155Optimize. Optimizing compilation takes somewhat more time, and a lot
3156more memory for a large function.
3157
630d3d5a 3158Without @option{-O}, the compiler's goal is to reduce the cost of
74291a4b
MM
3159compilation and to make debugging produce the expected results.
3160Statements are independent: if you stop the program with a breakpoint
3161between statements, you can then assign a new value to any variable or
3162change the program counter to any other statement in the function and
3163get exactly the results you would expect from the source code.
3164
630d3d5a 3165With @option{-O}, the compiler tries to reduce code size and execution
9c34dbbf
ZW
3166time, without performing any optimizations that take a great deal of
3167compilation time.
74291a4b
MM
3168
3169@item -O2
cd3bb277 3170@opindex O2
0c2d1a2a 3171Optimize even more. GCC performs nearly all supported optimizations
74291a4b 3172that do not involve a space-speed tradeoff. The compiler does not
630d3d5a
JM
3173perform loop unrolling or function inlining when you specify @option{-O2}.
3174As compared to @option{-O}, this option increases both compilation time
74291a4b
MM
3175and the performance of the generated code.
3176
852b81bb
MM
3177@option{-O2} turns on all optional optimizations except for loop
3178unrolling, function inlining, and register renaming. It also turns on
3179the @option{-fforce-mem} and @option{-fstrict-aliasing} option on all
3180machines and frame pointer elimination on machines where doing so does
3181not interfere with debugging.
74291a4b 3182
081ca317
BL
3183Please note the warning under @option{-fgcse} about
3184invoking @option{-O2} on programs that use computed gotos.
3185
74291a4b 3186@item -O3
cd3bb277 3187@opindex O3
630d3d5a
JM
3188Optimize yet more. @option{-O3} turns on all optimizations specified by
3189@option{-O2} and also turns on the @option{-finline-functions} and
3190@option{-frename-registers} options.
74291a4b
MM
3191
3192@item -O0
cd3bb277 3193@opindex O0
74291a4b
MM
3194Do not optimize.
3195
c6aded7c 3196@item -Os
cd3bb277 3197@opindex Os
630d3d5a 3198Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
c6aded7c
AG
3199do not typically increase code size. It also performs further
3200optimizations designed to reduce code size.
3201
630d3d5a 3202If you use multiple @option{-O} options, with or without level numbers,
74291a4b
MM
3203the last such option is the one that is effective.
3204@end table
3205
630d3d5a 3206Options of the form @option{-f@var{flag}} specify machine-independent
74291a4b 3207flags. Most flags have both positive and negative forms; the negative
630d3d5a 3208form of @option{-ffoo} would be @option{-fno-foo}. In the table below,
74291a4b
MM
3209only one of the forms is listed---the one which is not the default.
3210You can figure out the other form by either removing @samp{no-} or
3211adding it.
3212
2642624b 3213@table @gcctabopt
74291a4b 3214@item -ffloat-store
cd3bb277 3215@opindex ffloat-store
74291a4b
MM
3216Do not store floating point variables in registers, and inhibit other
3217options that might change whether a floating point value is taken from a
3218register or memory.
3219
3220@cindex floating point precision
3221This option prevents undesirable excess precision on machines such as
3222the 68000 where the floating registers (of the 68881) keep more
3223precision than a @code{double} is supposed to have. Similarly for the
3224x86 architecture. For most programs, the excess precision does only
3225good, but a few programs rely on the precise definition of IEEE floating
630d3d5a 3226point. Use @option{-ffloat-store} for such programs, after modifying
6fd74494 3227them to store all pertinent intermediate computations into variables.
74291a4b
MM
3228
3229@item -fno-default-inline
cd3bb277 3230@opindex fno-default-inline
74291a4b
MM
3231Do not make member functions inline by default merely because they are
3232defined inside the class scope (C++ only). Otherwise, when you specify
630d3d5a 3233@w{@option{-O}}, member functions defined inside class scope are compiled
74291a4b
MM
3234inline by default; i.e., you don't need to add @samp{inline} in front of
3235the member function name.
3236
3237@item -fno-defer-pop
cd3bb277 3238@opindex fno-defer-pop
74291a4b
MM
3239Always pop the arguments to each function call as soon as that function
3240returns. For machines which must pop arguments after a function call,
3241the compiler normally lets arguments accumulate on the stack for several
3242function calls and pops them all at once.
3243
3244@item -fforce-mem
cd3bb277 3245@opindex fforce-mem
74291a4b
MM
3246Force memory operands to be copied into registers before doing
3247arithmetic on them. This produces better code by making all memory
3248references potential common subexpressions. When they are not common
3249subexpressions, instruction combination should eliminate the separate
630d3d5a 3250register-load. The @option{-O2} option turns on this option.
74291a4b
MM
3251
3252@item -fforce-addr
cd3bb277 3253@opindex fforce-addr
74291a4b
MM
3254Force memory address constants to be copied into registers before
3255doing arithmetic on them. This may produce better code just as
630d3d5a 3256@option{-fforce-mem} may.
74291a4b
MM
3257
3258@item -fomit-frame-pointer
cd3bb277 3259@opindex fomit-frame-pointer
74291a4b
MM
3260Don't keep the frame pointer in a register for functions that
3261don't need one. This avoids the instructions to save, set up and
3262restore frame pointers; it also makes an extra register available
3263in many functions. @strong{It also makes debugging impossible on
3264some machines.}
3265
8aeea6e6 3266On some machines, such as the VAX, this flag has no effect, because
74291a4b
MM
3267the standard calling sequence automatically handles the frame pointer
3268and nothing is saved by pretending it doesn't exist. The
3269machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3270whether a target machine supports this flag. @xref{Registers,,Register
b11cc610 3271Usage, gccint, GNU Compiler Collection (GCC) Internals}.
74291a4b 3272
1aaef9c1 3273@item -foptimize-sibling-calls
cd3bb277 3274@opindex foptimize-sibling-calls
1aaef9c1
JH
3275Optimize sibling and tail recursive calls.
3276
91ce572a 3277@item -ftrapv
cd3bb277 3278@opindex ftrapv
91ce572a
CC
3279This option generates traps for signed overflow on addition, subtraction,
3280multiplication operations.
3281
74291a4b 3282@item -fno-inline
cd3bb277 3283@opindex fno-inline
74291a4b
MM
3284Don't pay attention to the @code{inline} keyword. Normally this option
3285is used to keep the compiler from expanding any functions inline.
3286Note that if you are not optimizing, no functions can be expanded inline.
3287
3288@item -finline-functions
cd3bb277 3289@opindex finline-functions
74291a4b
MM
3290Integrate all simple functions into their callers. The compiler
3291heuristically decides which functions are simple enough to be worth
3292integrating in this way.
3293
3294If all calls to a given function are integrated, and the function is
3295declared @code{static}, then the function is normally not output as
3296assembler code in its own right.
3297
efa3896a 3298@item -finline-limit=@var{n}
cd3bb277 3299@opindex finline-limit
f9e814f1
TP
3300By default, gcc limits the size of functions that can be inlined. This flag
3301allows the control of this limit for functions that are explicitly marked as
02f52e19
AJ
3302inline (ie marked with the inline keyword or defined within the class
3303definition in c++). @var{n} is the size of functions that can be inlined in
f9e814f1 3304number of pseudo instructions (not counting parameter handling). The default
93ee12c4
GP
3305value of @var{n} is 600.
3306Increasing this value can result in more inlined code at
f9e814f1 3307the cost of compilation time and memory consumption. Decreasing usually makes
02f52e19
AJ
3308the compilation faster and less code will be inlined (which presumably
3309means slower programs). This option is particularly useful for programs that
aee96fe9 3310use inlining heavily such as those based on recursive templates with C++.
f9e814f1
TP
3311
3312@emph{Note:} pseudo instruction represents, in this particular context, an
3313abstract measurement of function's size. In no way, it represents a count
3314of assembly instructions and as such its exact meaning might change from one
3315release to an another.
3316
74291a4b 3317@item -fkeep-inline-functions
cd3bb277 3318@opindex fkeep-inline-functions
74291a4b
MM
3319Even if all calls to a given function are integrated, and the function
3320is declared @code{static}, nevertheless output a separate run-time
3321callable version of the function. This switch does not affect
3322@code{extern inline} functions.
3323
3324@item -fkeep-static-consts
cd3bb277 3325@opindex fkeep-static-consts
74291a4b
MM
3326Emit variables declared @code{static const} when optimization isn't turned
3327on, even if the variables aren't referenced.
3328
0c2d1a2a 3329GCC enables this option by default. If you want to force the compiler to
74291a4b 3330check if the variable was referenced, regardless of whether or not
630d3d5a 3331optimization is turned on, use the @option{-fno-keep-static-consts} option.
74291a4b 3332
201556f0
JJ
3333@item -fmerge-constants
3334Attempt to merge identical constants (string constants and floating point
3335constants) accross compilation units.
3336
3337This option is default for optimized compilation if assembler and linker
c21cd8b1 3338support it. Use @option{-fno-merge-constants} to inhibit this behavior.
201556f0
JJ
3339
3340@item -fmerge-all-constants
3341Attempt to merge identical constants and identical variables.
3342
3343This option implies @option{-fmerge-constants}. In addition to
3344@option{-fmerge-constants} this considers e.g. even constant initialized
3345arrays or initialized constant variables with integral or floating point
3346types. Languages like C or C++ require each non-automatic variable to
3347have distinct location, so using this option will result in non-conforming
c21cd8b1 3348behavior.
201556f0 3349
74291a4b 3350@item -fno-function-cse
cd3bb277 3351@opindex fno-function-cse
74291a4b
MM
3352Do not put function addresses in registers; make each instruction that
3353calls a constant function contain the function's address explicitly.
3354
3355This option results in less efficient code, but some strange hacks
3356that alter the assembler output may be confused by the optimizations
3357performed when this option is not used.
3358
3359@item -ffast-math
cd3bb277 3360@opindex ffast-math
9c34dbbf
ZW
3361Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, and @*
3362@option{-fno-trapping-math}.
de6c5979 3363
630d3d5a 3364This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
74291a4b 3365
630d3d5a 3366This option should never be turned on by any @option{-O} option since
74291a4b 3367it can result in incorrect output for programs which depend on
c1030c7c 3368an exact implementation of IEEE or ISO rules/specifications for
74291a4b 3369math functions.
9605da8a
BL
3370
3371@item -fno-math-errno
cd3bb277 3372@opindex fno-math-errno
9605da8a
BL
3373Do not set ERRNO after calling math functions that are executed
3374with a single instruction, e.g., sqrt. A program that relies on
3375IEEE exceptions for math error handling may want to use this flag
3376for speed while maintaining IEEE arithmetic compatibility.
3377
630d3d5a 3378This option should never be turned on by any @option{-O} option since
de6c5979
BL
3379it can result in incorrect output for programs which depend on
3380an exact implementation of IEEE or ISO rules/specifications for
3381math functions.
3382
9c34dbbf 3383The default is @option{-fmath-errno}.
de6c5979
BL
3384
3385@item -funsafe-math-optimizations
cd3bb277 3386@opindex funsafe-math-optimizations
de6c5979
BL
3387Allow optimizations for floating-point arithmetic that (a) assume
3388that arguments and results are valid and (b) may violate IEEE or
237b14f7
RH
3389ANSI standards. When used at link-time, it may include libraries
3390or startup files that change the default FPU control word or other
3391similar optimizations.
de6c5979 3392
630d3d5a 3393This option should never be turned on by any @option{-O} option since
de6c5979
BL
3394it can result in incorrect output for programs which depend on
3395an exact implementation of IEEE or ISO rules/specifications for
3396math functions.
3397
9c34dbbf 3398The default is @option{-fno-unsafe-math-optimizations}.
de6c5979
BL
3399
3400@item -fno-trapping-math
cd3bb277 3401@opindex fno-trapping-math
de6c5979
BL
3402Compile code assuming that floating-point operations cannot generate
3403user-visible traps. Setting this option may allow faster code
3404if one relies on ``non-stop'' IEEE arithmetic, for example.
3405
630d3d5a 3406This option should never be turned on by any @option{-O} option since
de6c5979
BL
3407it can result in incorrect output for programs which depend on
3408an exact implementation of IEEE or ISO rules/specifications for
3409math functions.
3410
9c34dbbf 3411The default is @option{-ftrapping-math}.
27b41650
KG
3412
3413@item -fno-zero-initialized-in-bss
3414@opindex fno-zero-initialized-in-bss
3415If the target supports a BSS section, GCC by default puts variables that
3416are initialized to zero into BSS@. This can save space in the resulting
3417code.
3418
3419This option turns off this behavior because some programs explicitly
3420rely on variables going to the data section. E.g., so that the
3421resulting executable can find the beginning of that section and/or make
3422assumptions based on that.
3423
3424The default is @option{-fzero-initialized-in-bss}.
74291a4b
MM
3425@end table
3426
630d3d5a
JM
3427The following options control specific optimizations. The @option{-O2}
3428option turns on all of these optimizations except @option{-funroll-loops}
3429and @option{-funroll-all-loops}. On most machines, the @option{-O} option
3430turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
74291a4b
MM
3431but specific machines may handle it differently.
3432
3433You can use the following flags in the rare cases when ``fine-tuning''
3434of optimizations to be performed is desired.
3435
9c34dbbf
ZW
3436Not all of the optimizations performed by GCC have @option{-f} options
3437to control them.
3438
ad919812 3439@table @gcctabopt
74291a4b 3440@item -fstrength-reduce
cd3bb277 3441@opindex fstrength-reduce
74291a4b
MM
3442Perform the optimizations of loop strength reduction and
3443elimination of iteration variables.
3444
3445@item -fthread-jumps
cd3bb277 3446@opindex fthread-jumps
74291a4b
MM
3447Perform optimizations where we check to see if a jump branches to a
3448location where another comparison subsumed by the first is found. If
3449so, the first branch is redirected to either the destination of the
3450second branch or a point immediately following it, depending on whether
3451the condition is known to be true or false.
3452
3453@item -fcse-follow-jumps
cd3bb277 3454@opindex fcse-follow-jumps
74291a4b
MM
3455In common subexpression elimination, scan through jump instructions
3456when the target of the jump is not reached by any other path. For
3457example, when CSE encounters an @code{if} statement with an
3458@code{else} clause, CSE will follow the jump when the condition
3459tested is false.
3460
3461@item -fcse-skip-blocks
cd3bb277 3462@opindex fcse-skip-blocks
630d3d5a 3463This is similar to @option{-fcse-follow-jumps}, but causes CSE to
74291a4b
MM
3464follow jumps which conditionally skip over blocks. When CSE
3465encounters a simple @code{if} statement with no else clause,
630d3d5a 3466@option{-fcse-skip-blocks} causes CSE to follow the jump around the
74291a4b
MM
3467body of the @code{if}.
3468
3469@item -frerun-cse-after-loop
cd3bb277 3470@opindex frerun-cse-after-loop
74291a4b
MM
3471Re-run common subexpression elimination after loop optimizations has been
3472performed.
3473
6d6d0fa0 3474@item -frerun-loop-opt
cd3bb277 3475@opindex frerun-loop-opt
6d6d0fa0
JL
3476Run the loop optimizer twice.
3477
7506f491 3478@item -fgcse
cd3bb277 3479@opindex fgcse
7506f491
DE
3480Perform a global common subexpression elimination pass.
3481This pass also performs global constant and copy propagation.
3482
081ca317
BL
3483@emph{Note:} When compiling a program using computed gotos, a GCC
3484extension, you may get better runtime performance if you disable
3485the global common subexpression elmination pass by adding
3486@option{-fno-gcse} to the command line.
3487
a13d4ebf 3488@item -fgcse-lm
cd3bb277 3489@opindex fgcse-lm
695ac33f 3490When @option{-fgcse-lm} is enabled, global common subexpression elimination will
767094dd 3491attempt to move loads which are only killed by stores into themselves. This
a13d4ebf 3492allows a loop containing a load/store sequence to be changed to a load outside
02f52e19 3493the loop, and a copy/store within the loop.
a13d4ebf
AM
3494
3495@item -fgcse-sm
cd3bb277 3496@opindex fgcse-sm
695ac33f 3497When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
767094dd 3498subexpression elimination. This pass will attempt to move stores out of loops.
695ac33f 3499When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
a13d4ebf
AM
3500can be changed to a load before the loop and a store after the loop.
3501
96327cdc
JH
3502@item -floop-optimize
3503@opindex floop-optimize
3504Perform loop optimizations: move constant expressions out of loops, simplify
3505exit test conditions and optionally do strength-reduction and loop unrolling as
3506well.
3507
3508@item -fcrossjumping
3509@opindex crossjumping
3510Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3511resulting code may or may not perform better than without cross-jumping.
3512
b6d24183 3513@item -fdelete-null-pointer-checks
cd3bb277 3514@opindex fdelete-null-pointer-checks
9c34dbbf
ZW
3515Use global dataflow analysis to identify and eliminate useless checks
3516for null pointers. The compiler assumes that dereferencing a null
3517pointer would have halted the program. If a pointer is checked after
3518it has already been dereferenced, it cannot be null.
3519
3520In some environments, this assumption is not true, and programs can
3521safely dereference null pointers. Use
3522@option{-fno-delete-null-pointer-checks} to disable this optimization
3523for programs which depend on that behavior.
b6d24183 3524
74291a4b 3525@item -fexpensive-optimizations
cd3bb277 3526@opindex fexpensive-optimizations
74291a4b
MM
3527Perform a number of minor optimizations that are relatively expensive.
3528
639726ba 3529@item -foptimize-register-move
59d40964 3530@itemx -fregmove
cd3bb277
JM
3531@opindex foptimize-register-move
3532@opindex fregmove
9ec36da5
JL
3533Attempt to reassign register numbers in move instructions and as
3534operands of other simple instructions in order to maximize the amount of
56159047 3535register tying. This is especially helpful on machines with two-operand
630d3d5a 3536instructions. GCC enables this optimization by default with @option{-O2}
9ec36da5
JL
3537or higher.
3538
bedc7537 3539Note @option{-fregmove} and @option{-foptimize-register-move} are the same
9ec36da5
JL
3540optimization.
3541
74291a4b 3542@item -fdelayed-branch
cd3bb277 3543@opindex fdelayed-branch
74291a4b
MM
3544If supported for the target machine, attempt to reorder instructions
3545to exploit instruction slots available after delayed branch
3546instructions.
3547
3548@item -fschedule-insns
cd3bb277 3549@opindex fschedule-insns
74291a4b
MM
3550If supported for the target machine, attempt to reorder instructions to
3551eliminate execution stalls due to required data being unavailable. This
3552helps machines that have slow floating point or memory load instructions
3553by allowing other instructions to be issued until the result of the load
3554or floating point instruction is required.
3555
3556@item -fschedule-insns2
cd3bb277 3557@opindex fschedule-insns2
630d3d5a 3558Similar to @option{-fschedule-insns}, but requests an additional pass of
74291a4b
MM
3559instruction scheduling after register allocation has been done. This is
3560especially useful on machines with a relatively small number of
3561registers and where memory load instructions take more than one cycle.
3562
3563@item -ffunction-sections
59d40964 3564@itemx -fdata-sections
cd3bb277
JM
3565@opindex ffunction-sections
3566@opindex fdata-sections
7d0756fb
CM
3567Place each function or data item into its own section in the output
3568file if the target supports arbitrary sections. The name of the
3569function or the name of the data item determines the section's name
3570in the output file.
74291a4b 3571
7d0756fb 3572Use these options on systems where the linker can perform optimizations
74291a4b
MM
3573to improve locality of reference in the instruction space. HPPA
3574processors running HP-UX and Sparc processors running Solaris 2 have
3575linkers with such optimizations. Other systems using the ELF object format
3576as well as AIX may have these optimizations in the future.
3577
7d0756fb
CM
3578Only use these options when there are significant benefits from doing
3579so. When you specify these options, the assembler and linker will
74291a4b
MM
3580create larger object and executable files and will also be slower.
3581You will not be able to use @code{gprof} on all systems if you
3582specify this option and you may have problems with debugging if
630d3d5a 3583you specify both this option and @option{-g}.
74291a4b
MM
3584
3585@item -fcaller-saves
cd3bb277 3586@opindex fcaller-saves
74291a4b
MM
3587Enable values to be allocated in registers that will be clobbered by
3588function calls, by emitting extra instructions to save and restore the
3589registers around such calls. Such allocation is done only when it
3590seems to result in better code than would otherwise be produced.
3591
81610a0d
HPN
3592This option is always enabled by default on certain machines, usually
3593those which have no call-preserved registers to use instead.
3594
3595For all machines, optimization level 2 and higher enables this flag by
3596default.
74291a4b
MM
3597
3598@item -funroll-loops
cd3bb277 3599@opindex funroll-loops
9c34dbbf
ZW
3600Unroll loops whose number of iterations can be determined at compile
3601time or upon entry to the loop. @option{-funroll-loops} implies both
3602@option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
3603option makes code larger, and may or may not make it run faster.
74291a4b
MM
3604
3605@item -funroll-all-loops
cd3bb277 3606@opindex funroll-all-loops
9c34dbbf
ZW
3607Unroll all loops, even if their number of iterations is uncertain when
3608the loop is entered. This usually makes programs run more slowly.
3609@option{-funroll-all-loops} implies the same options as
3610@option{-funroll-loops},
3611
0dd0e980
JH
3612@item -fprefetch-loop-arrays
3613@opindex fprefetch-loop-arrays
3614If supported by the target machine, generate instructions to prefetch
3615memory to improve the performance of loops that access large arrays.
74291a4b 3616
e5eb27e5 3617@item -fmove-all-movables
cd3bb277 3618@opindex fmove-all-movables
e5eb27e5
JL
3619Forces all invariant computations in loops to be moved
3620outside the loop.
3621
3622@item -freduce-all-givs
cd3bb277 3623@opindex freduce-all-givs
e5eb27e5
JL
3624Forces all general-induction variables in loops to be
3625strength-reduced.
3626
3627@emph{Note:} When compiling programs written in Fortran,
630d3d5a 3628@option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
e5eb27e5
JL
3629by default when you use the optimizer.
3630
3631These options may generate better or worse code; results are highly
3632dependent on the structure of loops within the source code.
3633
3634These two options are intended to be removed someday, once
3635they have helped determine the efficacy of various
3636approaches to improving loop optimizations.
3637
2642624b 3638Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
e5eb27e5
JL
3639know how use of these options affects
3640the performance of your production code.
3641We're very interested in code that runs @emph{slower}
3642when these options are @emph{enabled}.
3643
74291a4b 3644@item -fno-peephole
6cfc0341 3645@itemx -fno-peephole2
cd3bb277 3646@opindex fno-peephole
6cfc0341
RH
3647@opindex fno-peephole2
3648Disable any machine-specific peephole optimizations. The difference
630d3d5a 3649between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6cfc0341
RH
3650are implemented in the compiler; some targets use one, some use the
3651other, a few use both.
861bb6c1
JL
3652
3653@item -fbranch-probabilities
cd3bb277 3654@opindex fbranch-probabilities
630d3d5a 3655After running a program compiled with @option{-fprofile-arcs}
861bb6c1 3656(@pxref{Debugging Options,, Options for Debugging Your Program or
bedc7537 3657@command{gcc}}), you can compile it a second time using
630d3d5a 3658@option{-fbranch-probabilities}, to improve optimizations based on
3de87bf2
JJ
3659the number of times each branch was taken. When the program
3660compiled with @option{-fprofile-arcs} exits it saves arc execution
3661counts to a file called @file{@var{sourcename}.da} for each source
3662file The information in this data file is very dependent on the
3663structure of the generated code, so you must use the same source code
3664and the same optimization options for both compilations.
861bb6c1 3665
630d3d5a 3666With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
861bb6c1
JL
3667note on the first instruction of each basic block, and a
3668@samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3669These can be used to improve optimization. Currently, they are only
3670used in one place: in @file{reorg.c}, instead of guessing which path a
3671branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3672exactly determine which path is taken more often.
8c660648 3673
454d0cc7 3674@item -fno-guess-branch-probability
cd3bb277 3675@opindex fno-guess-branch-probability
9c34dbbf
ZW
3676Do not guess branch probabilities using a randomized model.
3677
3678Sometimes gcc will opt to use a randomized model to guess branch
3679probabilities, when none are available from either profiling feedback
3680(@option{-fprofile-arcs}) or @samp{__builtin_expect}. This means that
3681different runs of the compiler on the same program may produce different
3682object code.
3683
3684In a hard real-time system, people don't want different runs of the
3685compiler to produce code that has different behavior; minimizing
3686non-determinism is of paramount import. This switch allows users to
3687reduce non-determinism, possibly at the expense of inferior
3688optimization.
454d0cc7 3689
41472af8 3690@item -fstrict-aliasing
cd3bb277 3691@opindex fstrict-aliasing
41472af8
MM
3692Allows the compiler to assume the strictest aliasing rules applicable to
3693the language being compiled. For C (and C++), this activates
3694optimizations based on the type of expressions. In particular, an
3695object of one type is assumed never to reside at the same address as an
3696object of a different type, unless the types are almost the same. For
3697example, an @code{unsigned int} can alias an @code{int}, but not a
3698@code{void*} or a @code{double}. A character type may alias any other
02f52e19 3699type.
41472af8
MM
3700
3701Pay special attention to code like this:
3702@example
02f52e19 3703union a_union @{
41472af8
MM
3704 int i;
3705 double d;
3706@};
3707
3708int f() @{
3709 a_union t;
3710 t.d = 3.0;
3711 return t.i;
3712@}
3713@end example
3714The practice of reading from a different union member than the one most
3715recently written to (called ``type-punning'') is common. Even with
630d3d5a 3716@option{-fstrict-aliasing}, type-punning is allowed, provided the memory
41472af8
MM
3717is accessed through the union type. So, the code above will work as
3718expected. However, this code might not:
3719@example
02f52e19 3720int f() @{
41472af8
MM
3721 a_union t;
3722 int* ip;
3723 t.d = 3.0;
3724 ip = &t.i;
3725 return *ip;
3726@}
3727@end example
3728
41472af8
MM
3729Every language that wishes to perform language-specific alias analysis
3730should define a function that computes, given an @code{tree}
3731node, an alias set for the node. Nodes in different alias sets are not
3732allowed to alias. For an example, see the C front-end function
3733@code{c_get_alias_set}.
41472af8 3734
852b81bb
MM
3735For all machines, optimization level 2 and higher enables this flag by
3736default.
3737
efa3896a
GK
3738@item -falign-functions
3739@itemx -falign-functions=@var{n}
cd3bb277 3740@opindex falign-functions
efa3896a
GK
3741Align the start of functions to the next power-of-two greater than
3742@var{n}, skipping up to @var{n} bytes. For instance,
630d3d5a
JM
3743@option{-falign-functions=32} aligns functions to the next 32-byte
3744boundary, but @option{-falign-functions=24} would align to the next
efa3896a
GK
374532-byte boundary only if this can be done by skipping 23 bytes or less.
3746
630d3d5a 3747@option{-fno-align-functions} and @option{-falign-functions=1} are
efa3896a
GK
3748equivalent and mean that functions will not be aligned.
3749
3750Some assemblers only support this flag when @var{n} is a power of two;
3751in that case, it is rounded up.
3752
3753If @var{n} is not specified, use a machine-dependent default.
3754
3755@item -falign-labels
3756@itemx -falign-labels=@var{n}
cd3bb277 3757@opindex falign-labels
efa3896a 3758Align all branch targets to a power-of-two boundary, skipping up to
630d3d5a 3759@var{n} bytes like @option{-falign-functions}. This option can easily
efa3896a
GK
3760make code slower, because it must insert dummy operations for when the
3761branch target is reached in the usual flow of the code.
3762
630d3d5a 3763If @option{-falign-loops} or @option{-falign-jumps} are applicable and
efa3896a
GK
3764are greater than this value, then their values are used instead.
3765
3766If @var{n} is not specified, use a machine-dependent default which is
3767very likely to be @samp{1}, meaning no alignment.
3768
3769@item -falign-loops
3770@itemx -falign-loops=@var{n}
cd3bb277 3771@opindex falign-loops
efa3896a 3772Align loops to a power-of-two boundary, skipping up to @var{n} bytes
630d3d5a 3773like @option{-falign-functions}. The hope is that the loop will be
efa3896a
GK
3774executed many times, which will make up for any execution of the dummy
3775operations.
3776
3777If @var{n} is not specified, use a machine-dependent default.
3778
3779@item -falign-jumps
3780@itemx -falign-jumps=@var{n}
cd3bb277 3781@opindex falign-jumps
efa3896a
GK
3782Align branch targets to a power-of-two boundary, for branch targets
3783where the targets can only be reached by jumping, skipping up to @var{n}
630d3d5a 3784bytes like @option{-falign-functions}. In this case, no dummy operations
efa3896a
GK
3785need be executed.
3786
3787If @var{n} is not specified, use a machine-dependent default.
3788
4bae0b47 3789@item -fssa
cd3bb277 3790@opindex fssa
4bae0b47
AS
3791Perform optimizations in static single assignment form. Each function's
3792flow graph is translated into SSA form, optimizations are performed, and
90ecce3e 3793the flow graph is translated back from SSA form. Users should not
b53978a3
JO
3794specify this option, since it is not yet ready for production use.
3795
0b47e4c1
JL
3796@item -fssa-ccp
3797@opindex fssa-ccp
3798Perform Sparse Conditional Constant Propagation in SSA form. Requires
3799@option{-fssa}. Like @option{-fssa}, this is an experimental feature.
3800
62d285ff
JL
3801@item -fssa-dce
3802@opindex fssa-dce
3803Perform aggressive dead-code elimination in SSA form. Requires @option{-fssa}.
3804Like @option{-fssa}, this is an experimental feature.
4bae0b47 3805
46d3a873 3806@item -fsingle-precision-constant
cd3bb277 3807@opindex fsingle-precision-constant
46d3a873
CC
3808Treat floating point constant as single precision constant instead of
3809implicitly converting it to double precision constant.
3810
2b2a8f1f 3811@item -frename-registers
cd3bb277 3812@opindex frename-registers
c771326b 3813Attempt to avoid false dependencies in scheduled code by making use
2b2a8f1f
RH
3814of registers left over after register allocation. This optimization
3815will most benefit processors with lots of registers. It can, however,
3816make debugging impossible, since variables will no longer stay in
3817a ``home register''.
3af64fd6 3818
8582c27b
RH
3819@item -fno-cprop-registers
3820@opindex fno-cprop-registers
3821After register allocation and post-register allocation instruction splitting,
3822we perform a copy-propagation pass to try to reduce scheduling dependencies
3823and occasionally eliminate the copy.
3824
3af64fd6 3825@item --param @var{name}=@var{value}
cd3bb277 3826@opindex param
3af64fd6
MM
3827In some places, GCC uses various constants to control the amount of
3828optimization that is done. For example, GCC will not inline functions
3829that contain more that a certain number of instructions. You can
3830control some of these constants on the command-line using the
630d3d5a 3831@option{--param} option.
3af64fd6 3832
4fe9b91c 3833In each case, the @var{value} is an integer. The allowable choices for
3af64fd6
MM
3834@var{name} are given in the following table:
3835
3836@table @gcctabopt
1c4c47db
JO
3837@item max-delay-slot-insn-search
3838The maximum number of instructions to consider when looking for an
3839instruction to fill a delay slot. If more than this arbitrary number of
3840instructions is searched, the time savings from filling the delay slot
3841will be minimal so stop searching. Increasing values mean more
3842aggressive optimization, making the compile time increase with probably
3843small improvement in executable run time.
3844
3845@item max-delay-slot-live-search
3846When trying to fill delay slots, the maximum number of instructions to
3847consider when searching for a block with valid live register
3848information. Increasing this arbitrarily chosen value means more
3849aggressive optimization, increasing the compile time. This parameter
3850should be removed when the delay slot code is rewritten to maintain the
3851control-flow graph.
33d3b05b
MM
3852
3853@item max-gcse-memory
3854The approximate maximum amount of memory that will be allocated in
3855order to perform the global common subexpression elimination
3856optimization. If more memory than specified is required, the
3857optimization will not be done.
3af64fd6 3858
740f35a0 3859@item max-gcse-passes
7dac2f89 3860The maximum number of passes of GCSE to run.
740f35a0 3861
4a121cc3 3862@item max-pending-list-length
0c688a7d 3863The maximum number of pending dependencies scheduling will allow
4a121cc3
AM
3864before flushing the current state and starting over. Large functions
3865with few branches or calls can create excessively large lists which
3866needlessly consume memory and resources.
3867
1c4c47db
JO
3868@item max-inline-insns
3869If an function contains more than this many instructions, it
3870will not be inlined. This option is precisely equivalent to
630d3d5a 3871@option{-finline-limit}.
1c4c47db 3872
03e9dbc9
MM
3873@item max-unrolled-insns
3874The maximum number of instructions that a loop should have if that loop
3875is unrolled, and if the loop is unrolled, it determines how many times
3876the loop code is unrolled.
3877
1c4c47db 3878@end table
74291a4b
MM
3879@end table
3880
3881@node Preprocessor Options
3882@section Options Controlling the Preprocessor
3883@cindex preprocessor options
3884@cindex options, preprocessor
3885
3886These options control the C preprocessor, which is run on each C source
3887file before actual compilation.
3888
630d3d5a
JM
3889If you use the @option{-E} option, nothing is done except preprocessing.
3890Some of these options make sense only together with @option{-E} because
74291a4b
MM
3891they cause the preprocessor output to be unsuitable for actual
3892compilation.
3893
cd3bb277 3894@opindex Wp
40adaa27
NB
3895You can use @option{-Wp,@var{option}} to bypass the compiler driver
3896and pass @var{option} directly through to the preprocessor. If
3897@var{option} contains commas, it is split into multiple options at the
3898commas. However, many options are modified, translated or interpreted
3899by the compiler driver before being passed to the preprocessor, and
3900@option{-Wp} forcibly bypasses this phase. The preprocessor's direct
3901interface is undocumented and subject to change, so whenever possible
3902you should avoid using @option{-Wp} and let the driver handle the
3903options instead.
3904
3905@include cppopts.texi
74291a4b
MM
3906
3907@node Assembler Options
3908@section Passing Options to the Assembler
3909
3910@c prevent bad page break with this line
3911You can pass options to the assembler.
3912
2642624b 3913@table @gcctabopt
aee96fe9 3914@item -Wa,@var{option}
cd3bb277 3915@opindex Wa
74291a4b
MM
3916Pass @var{option} as an option to the assembler. If @var{option}
3917contains commas, it is split into multiple options at the commas.
3918@end table
3919
3920@node Link Options
3921@section Options for Linking
3922@cindex link options
3923@cindex options, linking
3924
3925These options come into play when the compiler links object files into
3926an executable output file. They are meaningless if the compiler is
3927not doing a link step.
3928
2642624b 3929@table @gcctabopt
74291a4b
MM
3930@cindex file names
3931@item @var{object-file-name}
3932A file name that does not end in a special recognized suffix is
3933considered to name an object file or library. (Object files are
3934distinguished from libraries by the linker according to the file
3935contents.) If linking is done, these object files are used as input
3936to the linker.
3937
3938@item -c
3939@itemx -S
3940@itemx -E
cd3bb277
JM
3941@opindex c
3942@opindex S
3943@opindex E
74291a4b
MM
3944If any of these options is used, then the linker is not run, and
3945object file names should not be used as arguments. @xref{Overall
3946Options}.
3947
3948@cindex Libraries
3949@item -l@var{library}
4275c4c4 3950@itemx -l @var{library}
cd3bb277 3951@opindex l
4275c4c4
JS
3952Search the library named @var{library} when linking. (The second
3953alternative with the library as a separate argument is only for
3954POSIX compliance and is not recommended.)
74291a4b
MM
3955
3956It makes a difference where in the command you write this option; the
4275c4c4 3957linker searches and processes libraries and object files in the order they
74291a4b
MM
3958are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3959after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
3960to functions in @samp{z}, those functions may not be loaded.
3961
3962The linker searches a standard list of directories for the library,
3963which is actually a file named @file{lib@var{library}.a}. The linker
3964then uses this file as if it had been specified precisely by name.
3965
3966The directories searched include several standard system directories
630d3d5a 3967plus any that you specify with @option{-L}.
74291a4b
MM
3968
3969Normally the files found this way are library files---archive files
3970whose members are object files. The linker handles an archive file by
3971scanning through it for members which define symbols that have so far
3972been referenced but not defined. But if the file that is found is an
3973ordinary object file, it is linked in the usual fashion. The only
630d3d5a
JM
3974difference between using an @option{-l} option and specifying a file name
3975is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
74291a4b
MM
3976and searches several directories.
3977
3978@item -lobjc
cd3bb277 3979@opindex lobjc
630d3d5a 3980You need this special case of the @option{-l} option in order to
2147b154 3981link an Objective-C program.
74291a4b
MM
3982
3983@item -nostartfiles
cd3bb277 3984@opindex nostartfiles
74291a4b 3985Do not use the standard system startup files when linking.
bedc7537
NC
3986The standard system libraries are used normally, unless @option{-nostdlib}
3987or @option{-nodefaultlibs} is used.
74291a4b
MM
3988
3989@item -nodefaultlibs
cd3bb277 3990@opindex nodefaultlibs
74291a4b
MM
3991Do not use the standard system libraries when linking.
3992Only the libraries you specify will be passed to the linker.
bedc7537 3993The standard startup files are used normally, unless @option{-nostartfiles}
4754172c 3994is used. The compiler may generate calls to memcmp, memset, and memcpy
c1030c7c 3995for System V (and ISO C) environments or to bcopy and bzero for
4754172c
CM
3996BSD environments. These entries are usually resolved by entries in
3997libc. These entry points should be supplied through some other
3998mechanism when this option is specified.
74291a4b
MM
3999
4000@item -nostdlib
cd3bb277 4001@opindex nostdlib
74291a4b
MM
4002Do not use the standard system startup files or libraries when linking.
4003No startup files and only the libraries you specify will be passed to
767094dd 4004the linker. The compiler may generate calls to memcmp, memset, and memcpy
c1030c7c 4005for System V (and ISO C) environments or to bcopy and bzero for
4754172c
CM
4006BSD environments. These entries are usually resolved by entries in
4007libc. These entry points should be supplied through some other
4008mechanism when this option is specified.
74291a4b 4009
630d3d5a
JM
4010@cindex @option{-lgcc}, use with @option{-nostdlib}
4011@cindex @option{-nostdlib} and unresolved references
4012@cindex unresolved references and @option{-nostdlib}
4013@cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4014@cindex @option{-nodefaultlibs} and unresolved references
4015@cindex unresolved references and @option{-nodefaultlibs}
4016One of the standard libraries bypassed by @option{-nostdlib} and
4017@option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
0c2d1a2a 4018that GCC uses to overcome shortcomings of particular machines, or special
74291a4b 4019needs for some languages.
b11cc610
JM
4020(@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4021Collection (GCC) Internals},
74291a4b 4022for more discussion of @file{libgcc.a}.)
74291a4b 4023In most cases, you need @file{libgcc.a} even when you want to avoid
630d3d5a
JM
4024other standard libraries. In other words, when you specify @option{-nostdlib}
4025or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
0c2d1a2a 4026This ensures that you have no unresolved references to internal GCC
74291a4b 4027library subroutines. (For example, @samp{__main}, used to ensure C++
b11cc610
JM
4028constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4029GNU Compiler Collection (GCC) Internals}.)
74291a4b
MM
4030
4031@item -s
cd3bb277 4032@opindex s
74291a4b
MM
4033Remove all symbol table and relocation information from the executable.
4034
4035@item -static
cd3bb277 4036@opindex static
74291a4b
MM
4037On systems that support dynamic linking, this prevents linking with the shared
4038libraries. On other systems, this option has no effect.
4039
4040@item -shared
cd3bb277 4041@opindex shared
74291a4b 4042Produce a shared object which can then be linked with other objects to
1d3b0e2c 4043form an executable. Not all systems support this option. For predictable
02f52e19 4044results, you must also specify the same set of options that were used to
630d3d5a 4045generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
2642624b 4046when you specify this option.@footnote{On some systems, @samp{gcc -shared}
767094dd 4047needs to build supplementary stub code for constructors to work. On
2642624b 4048multi-libbed systems, @samp{gcc -shared} must select the correct support
1d3b0e2c 4049libraries to link against. Failing to supply the correct flags may lead
767094dd 4050to subtle defects. Supplying them in cases where they are not necessary
1d3b0e2c 4051is innocuous.}
74291a4b 4052
9db0819e
RH
4053@item -shared-libgcc
4054@itemx -static-libgcc
cd3bb277
JM
4055@opindex shared-libgcc
4056@opindex static-libgcc
9db0819e
RH
4057On systems that provide @file{libgcc} as a shared library, these options
4058force the use of either the shared or static version respectively.
4059If no shared version of @file{libgcc} was built when the compiler was
4060configured, these options have no effect.
4061
4062There are several situations in which an application should use the
4063shared @file{libgcc} instead of the static version. The most common
4064of these is when the application wishes to throw and catch exceptions
4065across different shared libraries. In that case, each of the libraries
4066as well as the application itself should use the shared @file{libgcc}.
4067
5c181756
AO
4068Therefore, the G++ and GCJ drivers automatically add
4069@option{-shared-libgcc} whenever you build a shared library or a main
4070executable, because C++ and Java programs typically use exceptions, so
4071this is the right thing to do.
4072
4073If, instead, you use the GCC driver to create shared libraries, you may
4074find that they will not always be linked with the shared @file{libgcc}.
4075If GCC finds, at its configuration time, that you have a GNU linker that
4076does not support option @option{--eh-frame-hdr}, it will link the shared
4077version of @file{libgcc} into shared libraries by default. Otherwise,
4078it will take advantage of the linker and optimize away the linking with
4079the shared version of @file{libgcc}, linking with the static version of
4080libgcc by default. This allows exceptions to propagate through such
4081shared libraries, without incurring relocation costs at library load
4082time.
4083
4084However, if a library or main executable is supposed to throw or catch
4085exceptions, you must link it using the G++ or GCJ driver, as appropriate
4086for the languages used in the program, or using the option
4087@option{-shared-libgcc}, such that it is linked with the shared
049f6ec9 4088@file{libgcc}.
9db0819e 4089
74291a4b 4090@item -symbolic
cd3bb277 4091@opindex symbolic
74291a4b
MM
4092Bind references to global symbols when building a shared object. Warn
4093about any unresolved references (unless overridden by the link editor
4094option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
4095this option.
4096
4097@item -Xlinker @var{option}
cd3bb277 4098@opindex Xlinker
74291a4b 4099Pass @var{option} as an option to the linker. You can use this to
0c2d1a2a 4100supply system-specific linker options which GCC does not know how to
74291a4b
MM
4101recognize.
4102
4103If you want to pass an option that takes an argument, you must use
630d3d5a
JM
4104@option{-Xlinker} twice, once for the option and once for the argument.
4105For example, to pass @option{-assert definitions}, you must write
74291a4b 4106@samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
630d3d5a 4107@option{-Xlinker "-assert definitions"}, because this passes the entire
74291a4b
MM
4108string as a single argument, which is not what the linker expects.
4109
aee96fe9 4110@item -Wl,@var{option}
cd3bb277 4111@opindex Wl
74291a4b
MM
4112Pass @var{option} as an option to the linker. If @var{option} contains
4113commas, it is split into multiple options at the commas.
4114
4115@item -u @var{symbol}
cd3bb277 4116@opindex u
74291a4b 4117Pretend the symbol @var{symbol} is undefined, to force linking of
630d3d5a 4118library modules to define it. You can use @option{-u} multiple times with
74291a4b
MM
4119different symbols to force loading of additional library modules.
4120@end table
4121
4122@node Directory Options
4123@section Options for Directory Search
4124@cindex directory options
4125@cindex options, directory search
4126@cindex search path
4127
4128These options specify directories to search for header files, for
4129libraries and for parts of the compiler:
4130
2642624b 4131@table @gcctabopt
74291a4b 4132@item -I@var{dir}
cd3bb277 4133@opindex I
861bb6c1
JL
4134Add the directory @var{dir} to the head of the list of directories to be
4135searched for header files. This can be used to override a system header
4136file, substituting your own version, since these directories are
d0a5eb32
RK
4137searched before the system header file directories. However, you should
4138not use this option to add directories that contain vendor-supplied
767094dd 4139system header files (use @option{-isystem} for that). If you use more than
630d3d5a 4140one @option{-I} option, the directories are scanned in left-to-right
74291a4b
MM
4141order; the standard system directories come after.
4142
dbead49c
NS
4143If a standard system include directory, or a directory specified with
4144@option{-isystem}, is also specified with @option{-I}, it will be
4145searched only in the position requested by @option{-I}. Also, it will
4146not be considered a system include directory. If that directory really
4147does contain system headers, there is a good chance that they will
4148break. For instance, if GCC's installation procedure edited the headers
4149in @file{/usr/include} to fix bugs, @samp{-I/usr/include} will cause the
4150original, buggy headers to be found instead of the corrected ones. GCC
4151will issue a warning when a system include directory is hidden in this
4152way.
4153
74291a4b 4154@item -I-
cd3bb277 4155@opindex I-
630d3d5a 4156Any directories you specify with @option{-I} options before the @option{-I-}
74291a4b
MM
4157option are searched only for the case of @samp{#include "@var{file}"};
4158they are not searched for @samp{#include <@var{file}>}.
4159
630d3d5a
JM
4160If additional directories are specified with @option{-I} options after
4161the @option{-I-}, these directories are searched for all @samp{#include}
4162directives. (Ordinarily @emph{all} @option{-I} directories are used
74291a4b
MM
4163this way.)
4164
630d3d5a 4165In addition, the @option{-I-} option inhibits the use of the current
74291a4b
MM
4166directory (where the current input file came from) as the first search
4167directory for @samp{#include "@var{file}"}. There is no way to
630d3d5a 4168override this effect of @option{-I-}. With @option{-I.} you can specify
74291a4b
MM
4169searching the directory which was current when the compiler was
4170invoked. That is not exactly the same as what the preprocessor does
4171by default, but it is often satisfactory.
4172
630d3d5a
JM
4173@option{-I-} does not inhibit the use of the standard system directories
4174for header files. Thus, @option{-I-} and @option{-nostdinc} are
74291a4b
MM
4175independent.
4176
4177@item -L@var{dir}
cd3bb277 4178@opindex L
74291a4b 4179Add directory @var{dir} to the list of directories to be searched
630d3d5a 4180for @option{-l}.
74291a4b
MM
4181
4182@item -B@var{prefix}
cd3bb277 4183@opindex B
74291a4b
MM
4184This option specifies where to find the executables, libraries,
4185include files, and data files of the compiler itself.
4186
4187The compiler driver program runs one or more of the subprograms
4188@file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
4189@var{prefix} as a prefix for each program it tries to run, both with and
4190without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4191
4192For each subprogram to be run, the compiler driver first tries the
630d3d5a 4193@option{-B} prefix, if any. If that name is not found, or if @option{-B}
74291a4b
MM
4194was not specified, the driver tries two standard prefixes, which are
4195@file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}. If neither of
4196those results in a file name that is found, the unmodified program
4197name is searched for using the directories specified in your
bedc7537 4198@env{PATH} environment variable.
74291a4b 4199
07804c3b
NC
4200The compiler will check to see if the path provided by the @option{-B}
4201refers to a directory, and if necessary it will add a directory
4202separator character at the end of the path.
4203
630d3d5a 4204@option{-B} prefixes that effectively specify directory names also apply
74291a4b 4205to libraries in the linker, because the compiler translates these
630d3d5a 4206options into @option{-L} options for the linker. They also apply to
74291a4b 4207includes files in the preprocessor, because the compiler translates these
630d3d5a 4208options into @option{-isystem} options for the preprocessor. In this case,
74291a4b
MM
4209the compiler appends @samp{include} to the prefix.
4210
4211The run-time support file @file{libgcc.a} can also be searched for using
630d3d5a 4212the @option{-B} prefix, if needed. If it is not found there, the two
74291a4b
MM
4213standard prefixes above are tried, and that is all. The file is left
4214out of the link if it is not found by those means.
4215
630d3d5a 4216Another way to specify a prefix much like the @option{-B} prefix is to use
bedc7537 4217the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
74291a4b 4218Variables}.
861bb6c1 4219
07804c3b 4220As a special kludge, if the path provided by @option{-B} is
bf4eebe0
NC
4221@file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
42229, then it will be replaced by @file{[dir/]include}. This is to help
7dac2f89 4223with boot-strapping the compiler.
07804c3b 4224
861bb6c1 4225@item -specs=@var{file}
cd3bb277 4226@opindex specs
861bb6c1
JL
4227Process @var{file} after the compiler reads in the standard @file{specs}
4228file, in order to override the defaults that the @file{gcc} driver
4229program uses when determining what switches to pass to @file{cc1},
4230@file{cc1plus}, @file{as}, @file{ld}, etc. More than one
630d3d5a 4231@option{-specs=@var{file}} can be specified on the command line, and they
861bb6c1 4232are processed in order, from left to right.
74291a4b
MM
4233@end table
4234
ee457005
JM
4235@c man end
4236
a743d340
NC
4237@node Spec Files
4238@section Specifying subprocesses and the switches to pass to them
4239@cindex Spec Files
bedc7537 4240@command{gcc} is a driver program. It performs its job by invoking a
a743d340
NC
4241sequence of other programs to do the work of compiling, assembling and
4242linking. GCC interprets its command-line parameters and uses these to
4243deduce which programs it should invoke, and which command-line options
c21cd8b1 4244it ought to place on their command lines. This behavior is controlled
a743d340
NC
4245by @dfn{spec strings}. In most cases there is one spec string for each
4246program that GCC can invoke, but a few programs have multiple spec
c21cd8b1 4247strings to control their behavior. The spec strings built into GCC can
630d3d5a 4248be overridden by using the @option{-specs=} command-line switch to specify
a743d340
NC
4249a spec file.
4250
4251@dfn{Spec files} are plaintext files that are used to construct spec
4252strings. They consist of a sequence of directives separated by blank
4253lines. The type of directive is determined by the first non-whitespace
4254character on the line and it can be one of the following:
4255
4256@table @code
4257@item %@var{command}
4258Issues a @var{command} to the spec file processor. The commands that can
02f52e19 4259appear here are:
a743d340
NC
4260
4261@table @code
4262@item %include <@var{file}>
4263@cindex %include
4264Search for @var{file} and insert its text at the current point in the
4265specs file.
4266
4267@item %include_noerr <@var{file}>
4268@cindex %include_noerr
4269Just like @samp{%include}, but do not generate an error message if the include
4270file cannot be found.
4271
4272@item %rename @var{old_name} @var{new_name}
4273@cindex %rename
4274Rename the spec string @var{old_name} to @var{new_name}.
4275
4276@end table
4277
4278@item *[@var{spec_name}]:
4279This tells the compiler to create, override or delete the named spec
4280string. All lines after this directive up to the next directive or
4281blank line are considered to be the text for the spec string. If this
4282results in an empty string then the spec will be deleted. (Or, if the
4283spec did not exist, then nothing will happened.) Otherwise, if the spec
4284does not currently exist a new spec will be created. If the spec does
4285exist then its contents will be overridden by the text of this
4286directive, unless the first character of that text is the @samp{+}
4287character, in which case the text will be appended to the spec.
4288
4289@item [@var{suffix}]:
4290Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
4291and up to the next directive or blank line are considered to make up the
02f52e19 4292spec string for the indicated suffix. When the compiler encounters an
a743d340
NC
4293input file with the named suffix, it will processes the spec string in
4294order to work out how to compile that file. For example:
4295
4296@smallexample
4297.ZZ:
4298z-compile -input %i
4299@end smallexample
4300
4301This says that any input file whose name ends in @samp{.ZZ} should be
4302passed to the program @samp{z-compile}, which should be invoked with the
630d3d5a 4303command-line switch @option{-input} and with the result of performing the
a743d340
NC
4304@samp{%i} substitution. (See below.)
4305
4306As an alternative to providing a spec string, the text that follows a
4307suffix directive can be one of the following:
4308
4309@table @code
4310@item @@@var{language}
4311This says that the suffix is an alias for a known @var{language}. This is
bedc7537 4312similar to using the @option{-x} command-line switch to GCC to specify a
a743d340
NC
4313language explicitly. For example:
4314
4315@smallexample
4316.ZZ:
4317@@c++
4318@end smallexample
4319
4320Says that .ZZ files are, in fact, C++ source files.
4321
4322@item #@var{name}
4323This causes an error messages saying:
4324
4325@smallexample
4326@var{name} compiler not installed on this system.
4327@end smallexample
4328@end table
4329
4330GCC already has an extensive list of suffixes built into it.
4331This directive will add an entry to the end of the list of suffixes, but
4332since the list is searched from the end backwards, it is effectively
4333possible to override earlier entries using this technique.
4334
4335@end table
4336
4337GCC has the following spec strings built into it. Spec files can
4338override these strings or create their own. Note that individual
02f52e19 4339targets can also add their own spec strings to this list.
a743d340
NC
4340
4341@smallexample
4342asm Options to pass to the assembler
4343asm_final Options to pass to the assembler post-processor
4344cpp Options to pass to the C preprocessor
4345cc1 Options to pass to the C compiler
4346cc1plus Options to pass to the C++ compiler
4347endfile Object files to include at the end of the link
4348link Options to pass to the linker
4349lib Libraries to include on the command line to the linker
4350libgcc Decides which GCC support library to pass to the linker
4351linker Sets the name of the linker
4352predefines Defines to be passed to the C preprocessor
310668e8
JM
4353signed_char Defines to pass to CPP to say whether @code{char} is signed
4354 by default
a743d340
NC
4355startfile Object files to include at the start of the link
4356@end smallexample
4357
4358Here is a small example of a spec file:
4359
4360@smallexample
4361%rename lib old_lib
4362
4363*lib:
4364--start-group -lgcc -lc -leval1 --end-group %(old_lib)
4365@end smallexample
4366
4367This example renames the spec called @samp{lib} to @samp{old_lib} and
4368then overrides the previous definition of @samp{lib} with a new one.
4369The new definition adds in some extra command-line options before
4370including the text of the old definition.
4371
4372@dfn{Spec strings} are a list of command-line options to be passed to their
4373corresponding program. In addition, the spec strings can contain
4374@samp{%}-prefixed sequences to substitute variable text or to
4375conditionally insert text into the command line. Using these constructs
4376it is possible to generate quite complex command lines.
4377
4378Here is a table of all defined @samp{%}-sequences for spec
4379strings. Note that spaces are not generated automatically around the
4380results of expanding these sequences. Therefore you can concatenate them
02f52e19 4381together or combine them with constant text in a single argument.
a743d340
NC
4382
4383@table @code
4384@item %%
4385Substitute one @samp{%} into the program name or argument.
4386
4387@item %i
4388Substitute the name of the input file being processed.
4389
4390@item %b
4391Substitute the basename of the input file being processed.
4392This is the substring up to (and not including) the last period
4393and not including the directory.
4394
371e300b
NC
4395@item %B
4396This is the same as @samp{%b}, but include the file suffix (text after
4397the last period).
4398
a743d340
NC
4399@item %d
4400Marks the argument containing or following the @samp{%d} as a
4401temporary file name, so that that file will be deleted if GCC exits
4402successfully. Unlike @samp{%g}, this contributes no text to the
02f52e19 4403argument.
a743d340
NC
4404
4405@item %g@var{suffix}
4406Substitute a file name that has suffix @var{suffix} and is chosen
4407once per compilation, and mark the argument in the same way as
4408@samp{%d}. To reduce exposure to denial-of-service attacks, the file
02f52e19 4409name is now chosen in a way that is hard to predict even when previously
695ac33f 4410chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
a743d340
NC
4411might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
4412the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4413treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
4414was simply substituted with a file name chosen once per compilation,
4415without regard to any appended suffix (which was therefore treated
4416just like ordinary text), making such attacks more likely to succeed.
4417
4418@item %u@var{suffix}
4419Like @samp{%g}, but generates a new temporary file name even if
4420@samp{%u@var{suffix}} was already seen.
4421
4422@item %U@var{suffix}
4423Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4424new one if there is no such last file name. In the absence of any
4425@samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
695ac33f 4426the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
a743d340
NC
4427would involve the generation of two distinct file names, one
4428for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
4429simply substituted with a file name chosen for the previous @samp{%u},
4430without regard to any appended suffix.
4431
371e300b 4432@item %j@var{SUFFIX}
aee96fe9 4433Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
371e300b
NC
4434writable, and if save-temps is off; otherwise, substitute the name
4435of a temporary file, just like @samp{%u}. This temporary file is not
4436meant for communication between processes, but rather as a junk
4437disposal mechanism.
4438
4439@item %.@var{SUFFIX}
4440Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
767094dd 4441when it is subsequently output with @samp{%*}. @var{SUFFIX} is
371e300b
NC
4442terminated by the next space or %.
4443
a743d340
NC
4444@item %w
4445Marks the argument containing or following the @samp{%w} as the
4446designated output file of this compilation. This puts the argument
4447into the sequence of arguments that @samp{%o} will substitute later.
4448
4449@item %o
4450Substitutes the names of all the output files, with spaces
4451automatically placed around them. You should write spaces
4452around the @samp{%o} as well or the results are undefined.
4453@samp{%o} is for use in the specs for running the linker.
4454Input files whose names have no recognized suffix are not compiled
4455at all, but they are included among the output files, so they will
4456be linked.
4457
4458@item %O
4459Substitutes the suffix for object files. Note that this is
4460handled specially when it immediately follows @samp{%g, %u, or %U},
4461because of the need for those to form complete file names. The
4462handling is such that @samp{%O} is treated exactly as if it had already
4463been substituted, except that @samp{%g, %u, and %U} do not currently
4464support additional @var{suffix} characters following @samp{%O} as they would
4465following, for example, @samp{.o}.
4466
4467@item %p
4468Substitutes the standard macro predefinitions for the
4469current target machine. Use this when running @code{cpp}.
4470
4471@item %P
4472Like @samp{%p}, but puts @samp{__} before and after the name of each
4473predefined macro, except for macros that start with @samp{__} or with
c1030c7c 4474@samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
161d7b59 4475C@.
a743d340
NC
4476
4477@item %I
aee96fe9 4478Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
a743d340
NC
4479
4480@item %s
4481Current argument is the name of a library or startup file of some sort.
4482Search for that file in a standard list of directories and substitute
02f52e19 4483the full name found.
a743d340
NC
4484
4485@item %e@var{str}
4486Print @var{str} as an error message. @var{str} is terminated by a newline.
4487Use this when inconsistent options are detected.
4488
4489@item %|
4490Output @samp{-} if the input for the current command is coming from a pipe.
4491
4492@item %(@var{name})
4493Substitute the contents of spec string @var{name} at this point.
4494
4495@item %[@var{name}]
630d3d5a 4496Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
a743d340
NC
4497
4498@item %x@{@var{option}@}
4499Accumulate an option for @samp{%X}.
4500
4501@item %X
630d3d5a 4502Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
a743d340
NC
4503spec string.
4504
4505@item %Y
630d3d5a 4506Output the accumulated assembler options specified by @option{-Wa}.
a743d340
NC
4507
4508@item %Z
630d3d5a 4509Output the accumulated preprocessor options specified by @option{-Wp}.
a743d340
NC
4510
4511@item %v1
161d7b59 4512Substitute the major version number of GCC@.
a743d340
NC
4513(For version 2.9.5, this is 2.)
4514
4515@item %v2
161d7b59 4516Substitute the minor version number of GCC@.
a743d340
NC
4517(For version 2.9.5, this is 9.)
4518
371e300b 4519@item %v3
161d7b59 4520Substitute the patch level number of GCC@.
371e300b
NC
4521(For version 2.9.5, this is 5.)
4522
a743d340
NC
4523@item %a
4524Process the @code{asm} spec. This is used to compute the
4525switches to be passed to the assembler.
4526
4527@item %A
4528Process the @code{asm_final} spec. This is a spec string for
4529passing switches to an assembler post-processor, if such a program is
4530needed.
4531
4532@item %l
4533Process the @code{link} spec. This is the spec for computing the
4534command line passed to the linker. Typically it will make use of the
4535@samp{%L %G %S %D and %E} sequences.
4536
4537@item %D
630d3d5a 4538Dump out a @option{-L} option for each directory that GCC believes might
a743d340 4539contain startup files. If the target supports multilibs then the
02f52e19 4540current multilib directory will be prepended to each of these paths.
a743d340 4541
371e300b 4542@item %M
c771326b 4543Output the multilib directory with directory separators replaced with
695ac33f
JM
4544@samp{_}. If multilib directories are not set, or the multilib directory is
4545@file{.} then this option emits nothing.
371e300b 4546
a743d340
NC
4547@item %L
4548Process the @code{lib} spec. This is a spec string for deciding which
02f52e19 4549libraries should be included on the command line to the linker.
a743d340
NC
4550
4551@item %G
4552Process the @code{libgcc} spec. This is a spec string for deciding
02f52e19 4553which GCC support library should be included on the command line to the linker.
a743d340
NC
4554
4555@item %S
4556Process the @code{startfile} spec. This is a spec for deciding which
4557object files should be the first ones passed to the linker. Typically
02f52e19 4558this might be a file named @file{crt0.o}.
a743d340
NC
4559
4560@item %E
4561Process the @code{endfile} spec. This is a spec string that specifies
02f52e19 4562the last object files that will be passed to the linker.
a743d340
NC
4563
4564@item %C
4565Process the @code{cpp} spec. This is used to construct the arguments
4566to be passed to the C preprocessor.
4567
4568@item %c
4569Process the @code{signed_char} spec. This is intended to be used
02f52e19 4570to tell cpp whether a char is signed. It typically has the definition:
a743d340
NC
4571@smallexample
4572%@{funsigned-char:-D__CHAR_UNSIGNED__@}
4573@end smallexample
4574
4575@item %1
4576Process the @code{cc1} spec. This is used to construct the options to be
4577passed to the actual C compiler (@samp{cc1}).
4578
4579@item %2
4580Process the @code{cc1plus} spec. This is used to construct the options to be
4581passed to the actual C++ compiler (@samp{cc1plus}).
4582
4583@item %*
4584Substitute the variable part of a matched option. See below.
4585Note that each comma in the substituted string is replaced by
4586a single space.
4587
4588@item %@{@code{S}@}
161d7b59 4589Substitutes the @code{-S} switch, if that switch was given to GCC@.
a743d340
NC
4590If that switch was not specified, this substitutes nothing. Note that
4591the leading dash is omitted when specifying this option, and it is
4592automatically inserted if the substitution is performed. Thus the spec
630d3d5a
JM
4593string @samp{%@{foo@}} would match the command-line option @option{-foo}
4594and would output the command line option @option{-foo}.
a743d340
NC
4595
4596@item %W@{@code{S}@}
4597Like %@{@code{S}@} but mark last argument supplied within as a file to be
02f52e19 4598deleted on failure.
a743d340
NC
4599
4600@item %@{@code{S}*@}
4601Substitutes all the switches specified to GCC whose names start
4602with @code{-S}, but which also take an argument. This is used for
695ac33f 4603switches like @option{-o}, @option{-D}, @option{-I}, etc.
630d3d5a 4604GCC considers @option{-o foo} as being
a743d340 4605one switch whose names starts with @samp{o}. %@{o*@} would substitute this
02f52e19 4606text, including the space. Thus two arguments would be generated.
a743d340
NC
4607
4608@item %@{^@code{S}*@}
4609Like %@{@code{S}*@}, but don't put a blank between a switch and its
4610argument. Thus %@{^o*@} would only generate one argument, not two.
4611
371e300b
NC
4612@item %@{@code{S}*&@code{T}*@}
4613Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4614(the order of @code{S} and @code{T} in the spec is not significant).
4615There can be any number of ampersand-separated variables; for each the
4616wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
4617
d630442f 4618@item %@{<@code{S}@}
695ac33f 4619Remove all occurrences of @code{-S} from the command line. Note---this
d630442f 4620command is position dependent. @samp{%} commands in the spec string
50c57e7b 4621before this option will see @code{-S}, @samp{%} commands in the spec
d630442f
NC
4622string after this option will not.
4623
a743d340
NC
4624@item %@{@code{S}*:@code{X}@}
4625Substitutes @code{X} if one or more switches whose names start with
161d7b59 4626@code{-S} are specified to GCC@. Note that the tail part of the
e979f9e8 4627@code{-S} option (i.e.@: the part matched by the @samp{*}) will be substituted
02f52e19 4628for each occurrence of @samp{%*} within @code{X}.
a743d340
NC
4629
4630@item %@{@code{S}:@code{X}@}
161d7b59 4631Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC@.
a743d340
NC
4632
4633@item %@{!@code{S}:@code{X}@}
161d7b59 4634Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC@.
a743d340
NC
4635
4636@item %@{|@code{S}:@code{X}@}
4637Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4638
4639@item %@{|!@code{S}:@code{X}@}
4640Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4641
4642@item %@{.@code{S}:@code{X}@}
4643Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4644
4645@item %@{!.@code{S}:@code{X}@}
4646Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4647
4648@item %@{@code{S}|@code{P}:@code{X}@}
161d7b59 4649Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@. This may be
a743d340
NC
4650combined with @samp{!} and @samp{.} sequences as well, although they
4651have a stronger binding than the @samp{|}. For example a spec string
4652like this:
4653
4654@smallexample
4655%@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4656@end smallexample
4657
4658will output the following command-line options from the following input
4659command-line options:
4660
4661@smallexample
4662fred.c -foo -baz
4663jim.d -bar -boggle
4664-d fred.c -foo -baz -boggle
4665-d jim.d -bar -baz -boggle
4666@end smallexample
4667
4668@end table
4669
4670The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4671%@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4672or spaces, or even newlines. They are processed as usual, as described
02f52e19 4673above.
a743d340 4674
695ac33f
JM
4675The @option{-O}, @option{-f}, @option{-m}, and @option{-W}
4676switches are handled specifically in these
630d3d5a
JM
4677constructs. If another value of @option{-O} or the negated form of a @option{-f}, @option{-m}, or
4678@option{-W} switch is found later in the command line, the earlier switch
a743d340
NC
4679value is ignored, except with @{@code{S}*@} where @code{S} is just one
4680letter, which passes all matching options.
4681
4682The character @samp{|} at the beginning of the predicate text is used to indicate
630d3d5a 4683that a command should be piped to the following command, but only if @option{-pipe}
a743d340
NC
4684is specified.
4685
4686It is built into GCC which switches take arguments and which do not.
4687(You might think it would be useful to generalize this to allow each
4688compiler's spec to say which switches take arguments. But this cannot
4689be done in a consistent fashion. GCC cannot even decide which input
4690files have been specified without knowing which switches take arguments,
4691and it must know which input files to compile in order to tell which
02f52e19 4692compilers to run).
a743d340 4693
630d3d5a 4694GCC also knows implicitly that arguments starting in @option{-l} are to be
a743d340
NC
4695treated as compiler output files, and passed to the linker in their
4696proper position among the other output files.
4697
ee457005
JM
4698@c man begin OPTIONS
4699
74291a4b
MM
4700@node Target Options
4701@section Specifying Target Machine and Compiler Version
4702@cindex target options
4703@cindex cross compiling
4704@cindex specifying machine version
4705@cindex specifying compiler version and target machine
4706@cindex compiler version, specifying
4707@cindex target machine, specifying
4708
0c2d1a2a 4709By default, GCC compiles code for the same type of machine that you
74291a4b
MM
4710are using. However, it can also be installed as a cross-compiler, to
4711compile for some other type of machine. In fact, several different
0c2d1a2a 4712configurations of GCC, for different target machines, can be
74291a4b 4713installed side by side. Then you specify which one to use with the
630d3d5a 4714@option{-b} option.
74291a4b 4715
0c2d1a2a 4716In addition, older and newer versions of GCC can be installed side
74291a4b
MM
4717by side. One of them (probably the newest) will be the default, but
4718you may sometimes wish to use another.
4719
2642624b 4720@table @gcctabopt
74291a4b 4721@item -b @var{machine}
cd3bb277 4722@opindex b
74291a4b 4723The argument @var{machine} specifies the target machine for compilation.
0c2d1a2a 4724This is useful when you have installed GCC as a cross-compiler.
74291a4b
MM
4725
4726The value to use for @var{machine} is the same as was specified as the
0c2d1a2a 4727machine type when configuring GCC as a cross-compiler. For
74291a4b
MM
4728example, if a cross-compiler was configured with @samp{configure
4729i386v}, meaning to compile for an 80386 running System V, then you
630d3d5a 4730would specify @option{-b i386v} to run that cross compiler.
74291a4b 4731
630d3d5a 4732When you do not specify @option{-b}, it normally means to compile for
74291a4b
MM
4733the same type of machine that you are using.
4734
4735@item -V @var{version}
cd3bb277 4736@opindex V
0c2d1a2a 4737The argument @var{version} specifies which version of GCC to run.
74291a4b 4738This is useful when multiple versions are installed. For example,
0c2d1a2a 4739@var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
74291a4b 4740
630d3d5a 4741The default version, when you do not specify @option{-V}, is the last
0c2d1a2a 4742version of GCC that you installed.
74291a4b
MM
4743@end table
4744
630d3d5a 4745The @option{-b} and @option{-V} options actually work by controlling part of
74291a4b 4746the file name used for the executable files and libraries used for
0c2d1a2a 4747compilation. A given version of GCC, for a given target machine, is
bd819a4a 4748normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.
74291a4b 4749
630d3d5a 4750Thus, sites can customize the effect of @option{-b} or @option{-V} either by
74291a4b
MM
4751changing the names of these directories or adding alternate names (or
4752symbolic links). If in directory @file{/usr/local/lib/gcc-lib/} the
630d3d5a
JM
4753file @file{80386} is a link to the file @file{i386v}, then @option{-b
475480386} becomes an alias for @option{-b i386v}.
74291a4b 4755
630d3d5a 4756In one respect, the @option{-b} or @option{-V} do not completely change
bedc7537 4757to a different compiler: the top-level driver program @command{gcc}
74291a4b
MM
4758that you originally invoked continues to run and invoke the other
4759executables (preprocessor, compiler per se, assembler and linker)
4760that do the real work. However, since no real work is done in the
4761driver program, it usually does not matter that the driver program
8c7b74b9
JM
4762in use is not the one for the specified target. It is common for the
4763interface to the other executables to change incompatibly between
4764compiler versions, so unless the version specified is very close to that
630d3d5a
JM
4765of the driver (for example, @option{-V 3.0} with a driver program from GCC
4766version 3.0.1), use of @option{-V} may not work; for example, using
4767@option{-V 2.95.2} will not work with a driver program from GCC 3.0.
74291a4b
MM
4768
4769The only way that the driver program depends on the target machine is
4770in the parsing and handling of special machine-specific options.
4771However, this is controlled by a file which is found, along with the
4772other executables, in the directory for the specified version and
4773target machine. As a result, a single installed driver program adapts
8c7b74b9
JM
4774to any specified target machine, and sufficiently similar compiler
4775versions.
74291a4b
MM
4776
4777The driver program executable does control one significant thing,
4778however: the default version and target machine. Therefore, you can
4779install different instances of the driver program, compiled for
4780different targets or versions, under different names.
4781
bedc7537
NC
4782For example, if the driver for version 2.0 is installed as @command{ogcc}
4783and that for version 2.1 is installed as @command{gcc}, then the command
4784@command{gcc} will use version 2.1 by default, while @command{ogcc} will use
74291a4b 47852.0 by default. However, you can choose either version with either
630d3d5a 4786command with the @option{-V} option.
74291a4b
MM
4787
4788@node Submodel Options
4789@section Hardware Models and Configurations
4790@cindex submodel options
4791@cindex specifying hardware config
4792@cindex hardware models and configurations, specifying
4793@cindex machine dependent options
4794
630d3d5a 4795Earlier we discussed the standard option @option{-b} which chooses among
74291a4b 4796different installed compilers for completely different target
8aeea6e6 4797machines, such as VAX vs.@: 68000 vs.@: 80386.
74291a4b
MM
4798
4799In addition, each of these target machine types can have its own
4800special options, starting with @samp{-m}, to choose among various
4801hardware models or configurations---for example, 68010 vs 68020,
4802floating coprocessor or none. A single installed version of the
4803compiler can compile for any model or configuration, according to the
4804options specified.
4805
4806Some configurations of the compiler also support additional special
4807options, usually for compatibility with other compilers on the same
4808platform.
4809
74291a4b
MM
4810These options are defined by the macro @code{TARGET_SWITCHES} in the
4811machine description. The default for the options is also defined by
4812that macro, which enables you to change the defaults.
74291a4b
MM
4813
4814@menu
4815* M680x0 Options::
2856c3e3 4816* M68hc1x Options::
74291a4b
MM
4817* VAX Options::
4818* SPARC Options::
4819* Convex Options::
4820* AMD29K Options::
4821* ARM Options::
ecff22ab 4822* MN10200 Options::
6d6d0fa0 4823* MN10300 Options::
861bb6c1 4824* M32R/D Options::
74291a4b
MM
4825* M88K Options::
4826* RS/6000 and PowerPC Options::
4827* RT Options::
4828* MIPS Options::
14f73b5a 4829* i386 and x86-64 Options::
74291a4b
MM
4830* HPPA Options::
4831* Intel 960 Options::
4832* DEC Alpha Options::
d7c23cdc 4833* DEC Alpha/VMS Options::
74291a4b
MM
4834* Clipper Options::
4835* H8/300 Options::
4836* SH Options::
4837* System V Options::
282a61e6 4838* TMS320C3x/C4x Options::
f84271d9 4839* V850 Options::
56b2d7a7 4840* ARC Options::
83575957 4841* NS32K Options::
052a4b28
DC
4842* AVR Options::
4843* MCore Options::
df6194d4 4844* IA-64 Options::
e8ad90e5 4845* D30V Options::
91abf72d 4846* S/390 and zSeries Options::
0b85d816 4847* CRIS Options::
bcf684c7 4848* MMIX Options::
9f85bca7 4849* PDP-11 Options::
69a0611f 4850* Xstormy16 Options::
03984308 4851* Xtensa Options::
74291a4b
MM
4852@end menu
4853
4854@node M680x0 Options
4855@subsection M680x0 Options
4856@cindex M680x0 options
4857
4858These are the @samp{-m} options defined for the 68000 series. The default
4859values for these options depends on which style of 68000 was selected when
4860the compiler was configured; the defaults for the most common choices are
4861given below.
4862
2642624b 4863@table @gcctabopt
74291a4b
MM
4864@item -m68000
4865@itemx -mc68000
cd3bb277
JM
4866@opindex m68000
4867@opindex mc68000
74291a4b
MM
4868Generate output for a 68000. This is the default
4869when the compiler is configured for 68000-based systems.
4870
74cf1c6d
RK
4871Use this option for microcontrollers with a 68000 or EC000 core,
4872including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4873
74291a4b
MM
4874@item -m68020
4875@itemx -mc68020
cd3bb277
JM
4876@opindex m68020
4877@opindex mc68020
74291a4b
MM
4878Generate output for a 68020. This is the default
4879when the compiler is configured for 68020-based systems.
4880
4881@item -m68881
cd3bb277 4882@opindex m68881
74291a4b 4883Generate output containing 68881 instructions for floating point.
630d3d5a 4884This is the default for most 68020 systems unless @option{--nfp} was
74291a4b
MM
4885specified when the compiler was configured.
4886
4887@item -m68030
cd3bb277 4888@opindex m68030
74291a4b
MM
4889Generate output for a 68030. This is the default when the compiler is
4890configured for 68030-based systems.
4891
4892@item -m68040
cd3bb277 4893@opindex m68040
74291a4b
MM
4894Generate output for a 68040. This is the default when the compiler is
4895configured for 68040-based systems.
4896
4897This option inhibits the use of 68881/68882 instructions that have to be
74cf1c6d
RK
4898emulated by software on the 68040. Use this option if your 68040 does not
4899have code to emulate those instructions.
74291a4b
MM
4900
4901@item -m68060
cd3bb277 4902@opindex m68060
74291a4b
MM
4903Generate output for a 68060. This is the default when the compiler is
4904configured for 68060-based systems.
4905
4906This option inhibits the use of 68020 and 68881/68882 instructions that
74cf1c6d
RK
4907have to be emulated by software on the 68060. Use this option if your 68060
4908does not have code to emulate those instructions.
4909
4910@item -mcpu32
cd3bb277 4911@opindex mcpu32
767094dd 4912Generate output for a CPU32. This is the default
74cf1c6d
RK
4913when the compiler is configured for CPU32-based systems.
4914
4915Use this option for microcontrollers with a
4916CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
491768336, 68340, 68341, 68349 and 68360.
74291a4b
MM
4918
4919@item -m5200
cd3bb277 4920@opindex m5200
695ac33f 4921Generate output for a 520X ``coldfire'' family cpu. This is the default
74291a4b
MM
4922when the compiler is configured for 520X-based systems.
4923
02f52e19 4924Use this option for microcontroller with a 5200 core, including
74cf1c6d
RK
4925the MCF5202, MCF5203, MCF5204 and MCF5202.
4926
74291a4b
MM
4927
4928@item -m68020-40
cd3bb277 4929@opindex m68020-40
74291a4b
MM
4930Generate output for a 68040, without using any of the new instructions.
4931This results in code which can run relatively efficiently on either a
493268020/68881 or a 68030 or a 68040. The generated code does use the
493368881 instructions that are emulated on the 68040.
4934
861bb6c1 4935@item -m68020-60
cd3bb277 4936@opindex m68020-60
861bb6c1
JL
4937Generate output for a 68060, without using any of the new instructions.
4938This results in code which can run relatively efficiently on either a
493968020/68881 or a 68030 or a 68040. The generated code does use the
494068881 instructions that are emulated on the 68060.
4941
74291a4b 4942@item -mfpa
cd3bb277 4943@opindex mfpa
74291a4b
MM
4944Generate output containing Sun FPA instructions for floating point.
4945
4946@item -msoft-float
cd3bb277 4947@opindex msoft-float
74291a4b
MM
4948Generate output containing library calls for floating point.
4949@strong{Warning:} the requisite libraries are not available for all m68k
4950targets. Normally the facilities of the machine's usual C compiler are
4951used, but this can't be done directly in cross-compilation. You must
4952make your own arrangements to provide suitable library functions for
4953cross-compilation. The embedded targets @samp{m68k-*-aout} and
4954@samp{m68k-*-coff} do provide software floating point support.
4955
4956@item -mshort
cd3bb277 4957@opindex mshort
74291a4b
MM
4958Consider type @code{int} to be 16 bits wide, like @code{short int}.
4959
4960@item -mnobitfield
cd3bb277 4961@opindex mnobitfield
630d3d5a
JM
4962Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
4963and @option{-m5200} options imply @w{@option{-mnobitfield}}.
74291a4b
MM
4964
4965@item -mbitfield
cd3bb277 4966@opindex mbitfield
630d3d5a
JM
4967Do use the bit-field instructions. The @option{-m68020} option implies
4968@option{-mbitfield}. This is the default if you use a configuration
74291a4b
MM
4969designed for a 68020.
4970
4971@item -mrtd
cd3bb277 4972@opindex mrtd
74291a4b
MM
4973Use a different function-calling convention, in which functions
4974that take a fixed number of arguments return with the @code{rtd}
4975instruction, which pops their arguments while returning. This
4976saves one instruction in the caller since there is no need to pop
4977the arguments there.
4978
4979This calling convention is incompatible with the one normally
4980used on Unix, so you cannot use it if you need to call libraries
4981compiled with the Unix compiler.
4982
4983Also, you must provide function prototypes for all functions that
4984take variable numbers of arguments (including @code{printf});
4985otherwise incorrect code will be generated for calls to those
4986functions.
4987
4988In addition, seriously incorrect code will result if you call a
4989function with too many arguments. (Normally, extra arguments are
4990harmlessly ignored.)
4991
4992The @code{rtd} instruction is supported by the 68010, 68020, 68030,
74cf1c6d 499368040, 68060 and CPU32 processors, but not by the 68000 or 5200.
861bb6c1
JL
4994
4995@item -malign-int
4996@itemx -mno-align-int
cd3bb277
JM
4997@opindex malign-int
4998@opindex mno-align-int
02f52e19 4999Control whether GCC aligns @code{int}, @code{long}, @code{long long},
861bb6c1 5000@code{float}, @code{double}, and @code{long double} variables on a 32-bit
630d3d5a 5001boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
861bb6c1
JL
5002Aligning variables on 32-bit boundaries produces code that runs somewhat
5003faster on processors with 32-bit busses at the expense of more memory.
5004
630d3d5a 5005@strong{Warning:} if you use the @option{-malign-int} switch, GCC will
861bb6c1
JL
5006align structures containing the above types differently than
5007most published application binary interface specifications for the m68k.
5008
fb868474 5009@item -mpcrel
cd3bb277 5010@opindex mpcrel
fb868474 5011Use the pc-relative addressing mode of the 68000 directly, instead of
695ac33f
JM
5012using a global offset table. At present, this option implies @option{-fpic},
5013allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
5014not presently supported with @option{-mpcrel}, though this could be supported for
fb868474
DL
501568020 and higher processors.
5016
b71733d5
GM
5017@item -mno-strict-align
5018@itemx -mstrict-align
cd3bb277
JM
5019@opindex mno-strict-align
5020@opindex mstrict-align
b71733d5
GM
5021Do not (do) assume that unaligned memory references will be handled by
5022the system.
5023
74291a4b
MM
5024@end table
5025
2856c3e3
SC
5026@node M68hc1x Options
5027@subsection M68hc1x Options
5028@cindex M68hc1x options
5029
5030These are the @samp{-m} options defined for the 68hc11 and 68hc12
02f52e19 5031microcontrollers. The default values for these options depends on
2856c3e3
SC
5032which style of microcontroller was selected when the compiler was configured;
5033the defaults for the most common choices are given below.
5034
2642624b 5035@table @gcctabopt
2856c3e3
SC
5036@item -m6811
5037@itemx -m68hc11
cd3bb277
JM
5038@opindex m6811
5039@opindex m68hc11
2856c3e3
SC
5040Generate output for a 68HC11. This is the default
5041when the compiler is configured for 68HC11-based systems.
5042
5043@item -m6812
5044@itemx -m68hc12
cd3bb277
JM
5045@opindex m6812
5046@opindex m68hc12
2856c3e3
SC
5047Generate output for a 68HC12. This is the default
5048when the compiler is configured for 68HC12-based systems.
5049
5050@item -mauto-incdec
cd3bb277 5051@opindex mauto-incdec
2856c3e3
SC
5052Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5053addressing modes.
5054
5055@item -mshort
cd3bb277 5056@opindex mshort
2856c3e3
SC
5057Consider type @code{int} to be 16 bits wide, like @code{short int}.
5058
5059@item -msoft-reg-count=@var{count}
cd3bb277 5060@opindex msoft-reg-count
2856c3e3
SC
5061Specify the number of pseudo-soft registers which are used for the
5062code generation. The maximum number is 32. Using more pseudo-soft
5063register may or may not result in better code depending on the program.
5064The default is 4 for 68HC11 and 2 for 68HC12.
5065
5066@end table
5067
74291a4b
MM
5068@node VAX Options
5069@subsection VAX Options
5070@cindex VAX options
5071
8aeea6e6 5072These @samp{-m} options are defined for the VAX:
74291a4b 5073
2642624b 5074@table @gcctabopt
74291a4b 5075@item -munix
cd3bb277 5076@opindex munix
74291a4b 5077Do not output certain jump instructions (@code{aobleq} and so on)
8aeea6e6 5078that the Unix assembler for the VAX cannot handle across long
74291a4b
MM
5079ranges.
5080
5081@item -mgnu
cd3bb277 5082@opindex mgnu
74291a4b
MM
5083Do output those jump instructions, on the assumption that you
5084will assemble with the GNU assembler.
5085
5086@item -mg
cd3bb277 5087@opindex mg
74291a4b
MM
5088Output code for g-format floating point numbers instead of d-format.
5089@end table
5090
5091@node SPARC Options
5092@subsection SPARC Options
5093@cindex SPARC options
5094
5095These @samp{-m} switches are supported on the SPARC:
5096
2642624b 5097@table @gcctabopt
74291a4b
MM
5098@item -mno-app-regs
5099@itemx -mapp-regs
cd3bb277
JM
5100@opindex mno-app-regs
5101@opindex mapp-regs
630d3d5a 5102Specify @option{-mapp-regs} to generate output using the global registers
74291a4b
MM
51032 through 4, which the SPARC SVR4 ABI reserves for applications. This
5104is the default.
5105
5106To be fully SVR4 ABI compliant at the cost of some performance loss,
630d3d5a 5107specify @option{-mno-app-regs}. You should compile libraries and system
74291a4b
MM
5108software with this option.
5109
5110@item -mfpu
5111@itemx -mhard-float
cd3bb277
JM
5112@opindex mfpu
5113@opindex mhard-float
74291a4b
MM
5114Generate output containing floating point instructions. This is the
5115default.
5116
5117@item -mno-fpu
5118@itemx -msoft-float
cd3bb277
JM
5119@opindex mno-fpu
5120@opindex msoft-float
74291a4b
MM
5121Generate output containing library calls for floating point.
5122@strong{Warning:} the requisite libraries are not available for all SPARC
5123targets. Normally the facilities of the machine's usual C compiler are
5124used, but this cannot be done directly in cross-compilation. You must make
5125your own arrangements to provide suitable library functions for
5126cross-compilation. The embedded targets @samp{sparc-*-aout} and
5127@samp{sparclite-*-*} do provide software floating point support.
5128
630d3d5a 5129@option{-msoft-float} changes the calling convention in the output file;
74291a4b
MM
5130therefore, it is only useful if you compile @emph{all} of a program with
5131this option. In particular, you need to compile @file{libgcc.a}, the
630d3d5a 5132library that comes with GCC, with @option{-msoft-float} in order for
74291a4b
MM
5133this to work.
5134
5135@item -mhard-quad-float
cd3bb277 5136@opindex mhard-quad-float
74291a4b
MM
5137Generate output containing quad-word (long double) floating point
5138instructions.
5139
5140@item -msoft-quad-float
cd3bb277 5141@opindex msoft-quad-float
74291a4b
MM
5142Generate output containing library calls for quad-word (long double)
5143floating point instructions. The functions called are those specified
161d7b59 5144in the SPARC ABI@. This is the default.
74291a4b
MM
5145
5146As of this writing, there are no sparc implementations that have hardware
5147support for the quad-word floating point instructions. They all invoke
5148a trap handler for one of these instructions, and then the trap handler
5149emulates the effect of the instruction. Because of the trap handler overhead,
5150this is much slower than calling the ABI library routines. Thus the
630d3d5a 5151@option{-msoft-quad-float} option is the default.
74291a4b
MM
5152
5153@item -mno-epilogue
5154@itemx -mepilogue
cd3bb277
JM
5155@opindex mno-epilogue
5156@opindex mepilogue
630d3d5a 5157With @option{-mepilogue} (the default), the compiler always emits code for
74291a4b
MM
5158function exit at the end of each function. Any function exit in
5159the middle of the function (such as a return statement in C) will
5160generate a jump to the exit code at the end of the function.
5161
630d3d5a 5162With @option{-mno-epilogue}, the compiler tries to emit exit code inline
74291a4b
MM
5163at every function exit.
5164
5165@item -mno-flat
5166@itemx -mflat
cd3bb277
JM
5167@opindex mno-flat
5168@opindex mflat
630d3d5a 5169With @option{-mflat}, the compiler does not generate save/restore instructions
695ac33f 5170and will use a ``flat'' or single register window calling convention.
74291a4b
MM
5171This model uses %i7 as the frame pointer and is compatible with the normal
5172register window model. Code from either may be intermixed.
aee96fe9 5173The local registers and the input registers (0--5) are still treated as
695ac33f 5174``call saved'' registers and will be saved on the stack as necessary.
74291a4b 5175
630d3d5a 5176With @option{-mno-flat} (the default), the compiler emits save/restore
74291a4b
MM
5177instructions (except for leaf functions) and is the normal mode of operation.
5178
5179@item -mno-unaligned-doubles
5180@itemx -munaligned-doubles
cd3bb277
JM
5181@opindex mno-unaligned-doubles
5182@opindex munaligned-doubles
74291a4b
MM
5183Assume that doubles have 8 byte alignment. This is the default.
5184
630d3d5a 5185With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
74291a4b
MM
5186alignment only if they are contained in another type, or if they have an
5187absolute address. Otherwise, it assumes they have 4 byte alignment.
5188Specifying this option avoids some rare compatibility problems with code
5189generated by other compilers. It is not the default because it results
5190in a performance loss, especially for floating point code.
5191
c219ddf7
BK
5192@item -mno-faster-structs
5193@itemx -mfaster-structs
cd3bb277
JM
5194@opindex mno-faster-structs
5195@opindex mfaster-structs
630d3d5a 5196With @option{-mfaster-structs}, the compiler assumes that structures
c219ddf7
BK
5197should have 8 byte alignment. This enables the use of pairs of
5198@code{ldd} and @code{std} instructions for copies in structure
5199assignment, in place of twice as many @code{ld} and @code{st} pairs.
5200However, the use of this changed alignment directly violates the Sparc
161d7b59 5201ABI@. Thus, it's intended only for use on targets where the developer
c219ddf7 5202acknowledges that their resulting code will not be directly in line with
161d7b59 5203the rules of the ABI@.
c219ddf7 5204
74291a4b
MM
5205@item -mv8
5206@itemx -msparclite
cd3bb277
JM
5207@opindex mv8
5208@opindex msparclite
74291a4b
MM
5209These two options select variations on the SPARC architecture.
5210
5211By default (unless specifically configured for the Fujitsu SPARClite),
5212GCC generates code for the v7 variant of the SPARC architecture.
5213
630d3d5a 5214@option{-mv8} will give you SPARC v8 code. The only difference from v7
74291a4b
MM
5215code is that the compiler emits the integer multiply and integer
5216divide instructions which exist in SPARC v8 but not in SPARC v7.
5217
630d3d5a 5218@option{-msparclite} will give you SPARClite code. This adds the integer
74291a4b
MM
5219multiply, integer divide step and scan (@code{ffs}) instructions which
5220exist in SPARClite but not in SPARC v7.
5221
0c2d1a2a 5222These options are deprecated and will be deleted in a future GCC release.
630d3d5a 5223They have been replaced with @option{-mcpu=xxx}.
74291a4b
MM
5224
5225@item -mcypress
5226@itemx -msupersparc
cd3bb277
JM
5227@opindex mcypress
5228@opindex msupersparc
c21cd8b1 5229These two options select the processor for which the code is optimized.
74291a4b 5230
630d3d5a 5231With @option{-mcypress} (the default), the compiler optimizes code for the
74291a4b
MM
5232Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
5233This is also appropriate for the older SparcStation 1, 2, IPX etc.
5234
630d3d5a 5235With @option{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
767094dd 5236used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
74291a4b
MM
5237of the full SPARC v8 instruction set.
5238
0c2d1a2a 5239These options are deprecated and will be deleted in a future GCC release.
630d3d5a 5240They have been replaced with @option{-mcpu=xxx}.
74291a4b
MM
5241
5242@item -mcpu=@var{cpu_type}
cd3bb277 5243@opindex mcpu
c0498f43
DE
5244Set the instruction set, register set, and instruction scheduling parameters
5245for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
5246@samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
ad6843d7
RH
5247@samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5248@samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
c0498f43
DE
5249
5250Default instruction scheduling parameters are used for values that select
5251an architecture and not an implementation. These are @samp{v7}, @samp{v8},
5252@samp{sparclite}, @samp{sparclet}, @samp{v9}.
5253
5254Here is a list of each supported architecture and their supported
5255implementations.
5256
5257@smallexample
5258 v7: cypress
ad6843d7
RH
5259 v8: supersparc, hypersparc
5260 sparclite: f930, f934, sparclite86x
c0498f43
DE
5261 sparclet: tsc701
5262 v9: ultrasparc
5263@end smallexample
74291a4b
MM
5264
5265@item -mtune=@var{cpu_type}
cd3bb277 5266@opindex mtune
74291a4b 5267Set the instruction scheduling parameters for machine type
c0498f43 5268@var{cpu_type}, but do not set the instruction set or register set that the
630d3d5a 5269option @option{-mcpu=@var{cpu_type}} would.
c0498f43 5270
9c34dbbf
ZW
5271The same values for @option{-mcpu=@var{cpu_type}} can be used for
5272@option{-mtune=@var{cpu_type}}, but the only useful values are those
5273that select a particular cpu implementation. Those are @samp{cypress},
5274@samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5275@samp{sparclite86x}, @samp{tsc701}, and @samp{ultrasparc}.
74291a4b
MM
5276
5277@end table
5278
5279These @samp{-m} switches are supported in addition to the above
5280on the SPARCLET processor.
5281
2642624b 5282@table @gcctabopt
74291a4b 5283@item -mlittle-endian
cd3bb277 5284@opindex mlittle-endian
74291a4b
MM
5285Generate code for a processor running in little-endian mode.
5286
5287@item -mlive-g0
cd3bb277 5288@opindex mlive-g0
74291a4b
MM
5289Treat register @code{%g0} as a normal register.
5290GCC will continue to clobber it as necessary but will not assume
5291it always reads as 0.
5292
5293@item -mbroken-saverestore
cd3bb277 5294@opindex mbroken-saverestore
74291a4b
MM
5295Generate code that does not use non-trivial forms of the @code{save} and
5296@code{restore} instructions. Early versions of the SPARCLET processor do
5297not correctly handle @code{save} and @code{restore} instructions used with
5298arguments. They correctly handle them used without arguments. A @code{save}
5299instruction used without arguments increments the current window pointer
5300but does not allocate a new stack frame. It is assumed that the window
5301overflow trap handler will properly handle this case as will interrupt
5302handlers.
5303@end table
5304
5305These @samp{-m} switches are supported in addition to the above
02f52e19 5306on SPARC V9 processors in 64-bit environments.
74291a4b 5307
2642624b 5308@table @gcctabopt
74291a4b 5309@item -mlittle-endian
cd3bb277 5310@opindex mlittle-endian
74291a4b
MM
5311Generate code for a processor running in little-endian mode.
5312
ded17aad
DE
5313@item -m32
5314@itemx -m64
cd3bb277
JM
5315@opindex m32
5316@opindex m64
02f52e19
AJ
5317Generate code for a 32-bit or 64-bit environment.
5318The 32-bit environment sets int, long and pointer to 32 bits.
5319The 64-bit environment sets int to 32 bits and long and pointer
ded17aad
DE
5320to 64 bits.
5321
5322@item -mcmodel=medlow
cd3bb277 5323@opindex mcmodel=medlow
ded17aad
DE
5324Generate code for the Medium/Low code model: the program must be linked
5325in the low 32 bits of the address space. Pointers are 64 bits.
5326Programs can be statically or dynamically linked.
5327
5328@item -mcmodel=medmid
cd3bb277 5329@opindex mcmodel=medmid
ded17aad
DE
5330Generate code for the Medium/Middle code model: the program must be linked
5331in the low 44 bits of the address space, the text segment must be less than
53322G bytes, and data segment must be within 2G of the text segment.
5333Pointers are 64 bits.
5334
5335@item -mcmodel=medany
cd3bb277 5336@opindex mcmodel=medany
ded17aad
DE
5337Generate code for the Medium/Anywhere code model: the program may be linked
5338anywhere in the address space, the text segment must be less than
53392G bytes, and data segment must be within 2G of the text segment.
5340Pointers are 64 bits.
5341
5342@item -mcmodel=embmedany
cd3bb277 5343@opindex mcmodel=embmedany
ded17aad 5344Generate code for the Medium/Anywhere code model for embedded systems:
02f52e19 5345assume a 32-bit text and a 32-bit data segment, both starting anywhere
ded17aad 5346(determined at link time). Register %g4 points to the base of the
02f52e19 5347data segment. Pointers are still 64 bits.
ded17aad 5348Programs are statically linked, PIC is not supported.
74291a4b
MM
5349
5350@item -mstack-bias
5351@itemx -mno-stack-bias
cd3bb277
JM
5352@opindex mstack-bias
5353@opindex mno-stack-bias
630d3d5a
JM
5354With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5355frame pointer if present, are offset by @minus{}2047 which must be added back
74291a4b
MM
5356when making stack frame references.
5357Otherwise, assume no such offset is present.
5358@end table
5359
5360@node Convex Options
5361@subsection Convex Options
5362@cindex Convex options
5363
5364These @samp{-m} options are defined for Convex:
5365
2642624b 5366@table @gcctabopt
74291a4b 5367@item -mc1
cd3bb277 5368@opindex mc1
74291a4b
MM
5369Generate output for C1. The code will run on any Convex machine.
5370The preprocessor symbol @code{__convex__c1__} is defined.
5371
5372@item -mc2
cd3bb277 5373@opindex mc2
74291a4b
MM
5374Generate output for C2. Uses instructions not available on C1.
5375Scheduling and other optimizations are chosen for max performance on C2.
5376The preprocessor symbol @code{__convex_c2__} is defined.
5377
5378@item -mc32
cd3bb277 5379@opindex mc32
74291a4b
MM
5380Generate output for C32xx. Uses instructions not available on C1.
5381Scheduling and other optimizations are chosen for max performance on C32.
5382The preprocessor symbol @code{__convex_c32__} is defined.
5383
5384@item -mc34
cd3bb277 5385@opindex mc34
74291a4b
MM
5386Generate output for C34xx. Uses instructions not available on C1.
5387Scheduling and other optimizations are chosen for max performance on C34.
5388The preprocessor symbol @code{__convex_c34__} is defined.
5389
5390@item -mc38
cd3bb277 5391@opindex mc38
74291a4b
MM
5392Generate output for C38xx. Uses instructions not available on C1.
5393Scheduling and other optimizations are chosen for max performance on C38.
5394The preprocessor symbol @code{__convex_c38__} is defined.
5395
5396@item -margcount
cd3bb277 5397@opindex margcount
74291a4b
MM
5398Generate code which puts an argument count in the word preceding each
5399argument list. This is compatible with regular CC, and a few programs
5400may need the argument count word. GDB and other source-level debuggers
5401do not need it; this info is in the symbol table.
5402
5403@item -mnoargcount
cd3bb277 5404@opindex mnoargcount
74291a4b
MM
5405Omit the argument count word. This is the default.
5406
5407@item -mvolatile-cache
cd3bb277 5408@opindex mvolatile-cache
74291a4b
MM
5409Allow volatile references to be cached. This is the default.
5410
5411@item -mvolatile-nocache
cd3bb277 5412@opindex mvolatile-nocache
74291a4b
MM
5413Volatile references bypass the data cache, going all the way to memory.
5414This is only needed for multi-processor code that does not use standard
5415synchronization instructions. Making non-volatile references to volatile
5416locations will not necessarily work.
5417
5418@item -mlong32
cd3bb277 5419@opindex mlong32
74291a4b
MM
5420Type long is 32 bits, the same as type int. This is the default.
5421
5422@item -mlong64
cd3bb277 5423@opindex mlong64
74291a4b
MM
5424Type long is 64 bits, the same as type long long. This option is useless,
5425because no library support exists for it.
5426@end table
5427
5428@node AMD29K Options
5429@subsection AMD29K Options
5430@cindex AMD29K options
5431
5432These @samp{-m} options are defined for the AMD Am29000:
5433
2642624b 5434@table @gcctabopt
74291a4b 5435@item -mdw
cd3bb277 5436@opindex mdw
74291a4b
MM
5437@cindex DW bit (29k)
5438Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5439halfword operations are directly supported by the hardware. This is the
5440default.
5441
5442@item -mndw
cd3bb277 5443@opindex mndw
74291a4b
MM
5444Generate code that assumes the @code{DW} bit is not set.
5445
5446@item -mbw
cd3bb277 5447@opindex mbw
74291a4b
MM
5448@cindex byte writes (29k)
5449Generate code that assumes the system supports byte and halfword write
5450operations. This is the default.
5451
5452@item -mnbw
cd3bb277 5453@opindex mnbw
74291a4b 5454Generate code that assumes the systems does not support byte and
630d3d5a 5455halfword write operations. @option{-mnbw} implies @option{-mndw}.
74291a4b
MM
5456
5457@item -msmall
cd3bb277 5458@opindex msmall
74291a4b
MM
5459@cindex memory model (29k)
5460Use a small memory model that assumes that all function addresses are
5461either within a single 256 KB segment or at an absolute address of less
5462than 256k. This allows the @code{call} instruction to be used instead
5463of a @code{const}, @code{consth}, @code{calli} sequence.
5464
5465@item -mnormal
cd3bb277 5466@opindex mnormal
74291a4b
MM
5467Use the normal memory model: Generate @code{call} instructions only when
5468calling functions in the same file and @code{calli} instructions
5469otherwise. This works if each file occupies less than 256 KB but allows
161d7b59 5470the entire executable to be larger than 256 KB@. This is the default.
74291a4b
MM
5471
5472@item -mlarge
cd3bb277 5473@opindex mlarge
74291a4b
MM
5474Always use @code{calli} instructions. Specify this option if you expect
5475a single file to compile into more than 256 KB of code.
5476
5477@item -m29050
cd3bb277 5478@opindex m29050
74291a4b
MM
5479@cindex processor selection (29k)
5480Generate code for the Am29050.
5481
5482@item -m29000
cd3bb277 5483@opindex m29000
74291a4b
MM
5484Generate code for the Am29000. This is the default.
5485
5486@item -mkernel-registers
cd3bb277 5487@opindex mkernel-registers
74291a4b
MM
5488@cindex kernel and user registers (29k)
5489Generate references to registers @code{gr64-gr95} instead of to
5490registers @code{gr96-gr127}. This option can be used when compiling
5491kernel code that wants a set of global registers disjoint from that used
5492by user-mode code.
5493
5494Note that when this option is used, register names in @samp{-f} flags
5495must use the normal, user-mode, names.
5496
5497@item -muser-registers
cd3bb277 5498@opindex muser-registers
74291a4b
MM
5499Use the normal set of global registers, @code{gr96-gr127}. This is the
5500default.
5501
5502@item -mstack-check
5503@itemx -mno-stack-check
cd3bb277
JM
5504@opindex mstack-check
5505@opindex mno-stack-check
74291a4b
MM
5506@cindex stack checks (29k)
5507Insert (or do not insert) a call to @code{__msp_check} after each stack
5508adjustment. This is often used for kernel code.
5509
5510@item -mstorem-bug
5511@itemx -mno-storem-bug
cd3bb277
JM
5512@opindex mstorem-bug
5513@opindex mno-storem-bug
74291a4b 5514@cindex storem bug (29k)
630d3d5a 5515@option{-mstorem-bug} handles 29k processors which cannot handle the
74291a4b
MM
5516separation of a mtsrim insn and a storem instruction (most 29000 chips
5517to date, but not the 29050).
5518
5519@item -mno-reuse-arg-regs
5520@itemx -mreuse-arg-regs
cd3bb277
JM
5521@opindex mno-reuse-arg-regs
5522@opindex mreuse-arg-regs
630d3d5a 5523@option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
74291a4b
MM
5524registers for copying out arguments. This helps detect calling a function
5525with fewer arguments than it was declared with.
5526
861bb6c1
JL
5527@item -mno-impure-text
5528@itemx -mimpure-text
cd3bb277
JM
5529@opindex mno-impure-text
5530@opindex mimpure-text
630d3d5a
JM
5531@option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5532not pass @option{-assert pure-text} to the linker when linking a shared object.
861bb6c1 5533
74291a4b 5534@item -msoft-float
cd3bb277 5535@opindex msoft-float
74291a4b 5536Generate output containing library calls for floating point.
161d7b59 5537@strong{Warning:} the requisite libraries are not part of GCC@.
74291a4b
MM
5538Normally the facilities of the machine's usual C compiler are used, but
5539this can't be done directly in cross-compilation. You must make your
5540own arrangements to provide suitable library functions for
5541cross-compilation.
4e8d7ddc
JW
5542
5543@item -mno-multm
cd3bb277 5544@opindex mno-multm
4e8d7ddc
JW
5545Do not generate multm or multmu instructions. This is useful for some embedded
5546systems which do not have trap handlers for these instructions.
74291a4b
MM
5547@end table
5548
5549@node ARM Options
5550@subsection ARM Options
5551@cindex ARM options
5552
5553These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5554architectures:
5555
2642624b 5556@table @gcctabopt
74291a4b 5557@item -mapcs-frame
cd3bb277 5558@opindex mapcs-frame
74291a4b
MM
5559Generate a stack frame that is compliant with the ARM Procedure Call
5560Standard for all functions, even if this is not strictly necessary for
630d3d5a 5561correct execution of the code. Specifying @option{-fomit-frame-pointer}
157a620e 5562with this option will cause the stack frames not to be generated for
630d3d5a 5563leaf functions. The default is @option{-mno-apcs-frame}.
157a620e
NC
5564
5565@item -mapcs
cd3bb277 5566@opindex mapcs
630d3d5a 5567This is a synonym for @option{-mapcs-frame}.
74291a4b
MM
5568
5569@item -mapcs-26
cd3bb277 5570@opindex mapcs-26
74291a4b
MM
5571Generate code for a processor running with a 26-bit program counter,
5572and conforming to the function calling standards for the APCS 26-bit
630d3d5a 5573option. This option replaces the @option{-m2} and @option{-m3} options
74291a4b
MM
5574of previous releases of the compiler.
5575
5576@item -mapcs-32
cd3bb277 5577@opindex mapcs-32
74291a4b
MM
5578Generate code for a processor running with a 32-bit program counter,
5579and conforming to the function calling standards for the APCS 32-bit
630d3d5a 5580option. This option replaces the @option{-m6} option of previous releases
74291a4b
MM
5581of the compiler.
5582
247f8561
PB
5583@ignore
5584@c not currently implemented
157a620e 5585@item -mapcs-stack-check
cd3bb277 5586@opindex mapcs-stack-check
157a620e
NC
5587Generate code to check the amount of stack space available upon entry to
5588every function (that actually uses some stack space). If there is
5589insufficient space available then either the function
5590@samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5591called, depending upon the amount of stack space required. The run time
5592system is required to provide these functions. The default is
630d3d5a 5593@option{-mno-apcs-stack-check}, since this produces smaller code.
157a620e 5594
247f8561 5595@c not currently implemented
157a620e 5596@item -mapcs-float
cd3bb277 5597@opindex mapcs-float
157a620e 5598Pass floating point arguments using the float point registers. This is
161d7b59 5599one of the variants of the APCS@. This option is recommended if the
157a620e
NC
5600target hardware has a floating point unit or if a lot of floating point
5601arithmetic is going to be performed by the code. The default is
630d3d5a
JM
5602@option{-mno-apcs-float}, since integer only code is slightly increased in
5603size if @option{-mapcs-float} is used.
157a620e 5604
247f8561 5605@c not currently implemented
157a620e 5606@item -mapcs-reentrant
cd3bb277 5607@opindex mapcs-reentrant
247f8561 5608Generate reentrant, position independent code. The default is
630d3d5a 5609@option{-mno-apcs-reentrant}.
247f8561 5610@end ignore
157a620e
NC
5611
5612@item -mthumb-interwork
cd3bb277 5613@opindex mthumb-interwork
247f8561 5614Generate code which supports calling between the ARM and Thumb
157a620e
NC
5615instruction sets. Without this option the two instruction sets cannot
5616be reliably used inside one program. The default is
630d3d5a
JM
5617@option{-mno-thumb-interwork}, since slightly larger code is generated
5618when @option{-mthumb-interwork} is specified.
157a620e
NC
5619
5620@item -mno-sched-prolog
cd3bb277 5621@opindex mno-sched-prolog
157a620e
NC
5622Prevent the reordering of instructions in the function prolog, or the
5623merging of those instruction with the instructions in the function's
ed0e6530
PB
5624body. This means that all functions will start with a recognizable set
5625of instructions (or in fact one of a choice from a small set of
157a620e
NC
5626different function prologues), and this information can be used to
5627locate the start if functions inside an executable piece of code. The
630d3d5a 5628default is @option{-msched-prolog}.
157a620e 5629
74291a4b 5630@item -mhard-float
cd3bb277 5631@opindex mhard-float
74291a4b
MM
5632Generate output containing floating point instructions. This is the
5633default.
5634
5635@item -msoft-float
cd3bb277 5636@opindex msoft-float
74291a4b
MM
5637Generate output containing library calls for floating point.
5638@strong{Warning:} the requisite libraries are not available for all ARM
5639targets. Normally the facilities of the machine's usual C compiler are
5640used, but this cannot be done directly in cross-compilation. You must make
5641your own arrangements to provide suitable library functions for
5642cross-compilation.
5643
630d3d5a 5644@option{-msoft-float} changes the calling convention in the output file;
74291a4b
MM
5645therefore, it is only useful if you compile @emph{all} of a program with
5646this option. In particular, you need to compile @file{libgcc.a}, the
630d3d5a 5647library that comes with GCC, with @option{-msoft-float} in order for
74291a4b
MM
5648this to work.
5649
5650@item -mlittle-endian
cd3bb277 5651@opindex mlittle-endian
74291a4b
MM
5652Generate code for a processor running in little-endian mode. This is
5653the default for all standard configurations.
5654
5655@item -mbig-endian
cd3bb277 5656@opindex mbig-endian
74291a4b
MM
5657Generate code for a processor running in big-endian mode; the default is
5658to compile code for a little-endian processor.
5659
5660@item -mwords-little-endian
cd3bb277 5661@opindex mwords-little-endian
74291a4b
MM
5662This option only applies when generating code for big-endian processors.
5663Generate code for a little-endian word order but a big-endian byte
5664order. That is, a byte order of the form @samp{32107654}. Note: this
5665option should only be used if you require compatibility with code for
5666big-endian ARM processors generated by versions of the compiler prior to
56672.8.
5668
5f1e6755 5669@item -malignment-traps
cd3bb277 5670@opindex malignment-traps
5f1e6755
NC
5671Generate code that will not trap if the MMU has alignment traps enabled.
5672On ARM architectures prior to ARMv4, there were no instructions to
5673access half-word objects stored in memory. However, when reading from
5674memory a feature of the ARM architecture allows a word load to be used,
5675even if the address is unaligned, and the processor core will rotate the
5676data as it is being loaded. This option tells the compiler that such
5677misaligned accesses will cause a MMU trap and that it should instead
5678synthesise the access as a series of byte accesses. The compiler can
5679still use word accesses to load half-word data if it knows that the
5680address is aligned to a word boundary.
5681
5682This option is ignored when compiling for ARM architecture 4 or later,
5683since these processors have instructions to directly access half-word
02f52e19
AJ
5684objects in memory.
5685
5f1e6755 5686@item -mno-alignment-traps
cd3bb277 5687@opindex mno-alignment-traps
5f1e6755
NC
5688Generate code that assumes that the MMU will not trap unaligned
5689accesses. This produces better code when the target instruction set
e979f9e8 5690does not have half-word memory operations (i.e.@: implementations prior to
02f52e19 5691ARMv4).
5f1e6755
NC
5692
5693Note that you cannot use this option to access unaligned word objects,
5694since the processor will only fetch one 32-bit aligned object from
02f52e19 5695memory.
5f1e6755 5696
695ac33f 5697The default setting for most targets is @option{-mno-alignment-traps}, since
5f1e6755 5698this produces better code when there are no half-word memory
02f52e19 5699instructions available.
5f1e6755 5700
74291a4b 5701@item -mshort-load-bytes
247f8561 5702@itemx -mno-short-load-words
cd3bb277
JM
5703@opindex mshort-load-bytes
5704@opindex mno-short-load-words
630d3d5a 5705These are deprecated aliases for @option{-malignment-traps}.
74291a4b
MM
5706
5707@item -mno-short-load-bytes
247f8561 5708@itemx -mshort-load-words
cd3bb277
JM
5709@opindex mno-short-load-bytes
5710@opindex mshort-load-words
630d3d5a 5711This are deprecated aliases for @option{-mno-alignment-traps}.
157a620e 5712
74291a4b 5713@item -mbsd
cd3bb277 5714@opindex mbsd
161d7b59 5715This option only applies to RISC iX@. Emulate the native BSD-mode
630d3d5a 5716compiler. This is the default if @option{-ansi} is not specified.
74291a4b
MM
5717
5718@item -mxopen
cd3bb277 5719@opindex mxopen
161d7b59 5720This option only applies to RISC iX@. Emulate the native X/Open-mode
74291a4b
MM
5721compiler.
5722
5723@item -mno-symrename
cd3bb277 5724@opindex mno-symrename
161d7b59 5725This option only applies to RISC iX@. Do not run the assembler
74291a4b
MM
5726post-processor, @samp{symrename}, after code has been assembled.
5727Normally it is necessary to modify some of the standard symbols in
5728preparation for linking with the RISC iX C library; this option
5729suppresses this pass. The post-processor is never run when the
5730compiler is built for cross-compilation.
157a620e 5731
cd3bb277
JM
5732@item -mcpu=@var{name}
5733@opindex mcpu
157a620e 5734This specifies the name of the target ARM processor. GCC uses this name
247f8561 5735to determine what kind of instructions it can emit when generating
aee96fe9
JM
5736assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
5737@samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
5738@samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
5739@samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
5740@samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
5741@samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
5742@samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
5743@samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
5744@samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
5745@samp{arm1020t}, @samp{xscale}.
62b10bbc 5746
cd3bb277
JM
5747@itemx -mtune=@var{name}
5748@opindex mtune
630d3d5a 5749This option is very similar to the @option{-mcpu=} option, except that
62b10bbc
NC
5750instead of specifying the actual target processor type, and hence
5751restricting which instructions can be used, it specifies that GCC should
5752tune the performance of the code as if the target were of the type
5753specified in this option, but still choosing the instructions that it
630d3d5a 5754will generate based on the cpu specified by a @option{-mcpu=} option.
247f8561 5755For some ARM implementations better performance can be obtained by using
62b10bbc 5756this option.
157a620e 5757
cd3bb277
JM
5758@item -march=@var{name}
5759@opindex march
157a620e 5760This specifies the name of the target ARM architecture. GCC uses this
247f8561 5761name to determine what kind of instructions it can emit when generating
157a620e 5762assembly code. This option can be used in conjunction with or instead
aee96fe9
JM
5763of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
5764@samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
5765@samp{armv5}, @samp{armv5t}, @samp{armv5te}.
157a620e 5766
cd3bb277
JM
5767@item -mfpe=@var{number}
5768@itemx -mfp=@var{number}
5769@opindex mfpe
5770@opindex mfp
b192711e 5771This specifies the version of the floating point emulation available on
630d3d5a 5772the target. Permissible values are 2 and 3. @option{-mfp=} is a synonym
161d7b59 5773for @option{-mfpe=}, for compatibility with older versions of GCC@.
157a620e 5774
cd3bb277
JM
5775@item -mstructure-size-boundary=@var{n}
5776@opindex mstructure-size-boundary
157a620e 5777The size of all structures and unions will be rounded up to a multiple
ed0e6530 5778of the number of bits set by this option. Permissible values are 8 and
157a620e
NC
577932. The default value varies for different toolchains. For the COFF
5780targeted toolchain the default value is 8. Specifying the larger number
ed0e6530 5781can produce faster, more efficient code, but can also increase the size
157a620e
NC
5782of the program. The two values are potentially incompatible. Code
5783compiled with one value cannot necessarily expect to work with code or
5784libraries compiled with the other value, if they exchange information
247f8561 5785using structures or unions.
157a620e 5786
f5a1b0d2 5787@item -mabort-on-noreturn
cd3bb277 5788@opindex mabort-on-noreturn
247f8561
PB
5789Generate a call to the function @code{abort} at the end of a
5790@code{noreturn} function. It will be executed if the function tries to
5791return.
f5a1b0d2 5792
c27ba912
DM
5793@item -mlong-calls
5794@itemx -mno-long-calls
cd3bb277
JM
5795@opindex mlong-calls
5796@opindex mno-long-calls
c27ba912
DM
5797Tells the compiler to perform function calls by first loading the
5798address of the function into a register and then performing a subroutine
5799call on this register. This switch is needed if the target function
5800will lie outside of the 64 megabyte addressing range of the offset based
02f52e19 5801version of subroutine call instruction.
c27ba912
DM
5802
5803Even if this switch is enabled, not all function calls will be turned
5804into long calls. The heuristic is that static functions, functions
5805which have the @samp{short-call} attribute, functions that are inside
5806the scope of a @samp{#pragma no_long_calls} directive and functions whose
5807definitions have already been compiled within the current compilation
5808unit, will not be turned into long calls. The exception to this rule is
b192711e 5809that weak function definitions, functions with the @samp{long-call}
c27ba912
DM
5810attribute or the @samp{section} attribute, and functions that are within
5811the scope of a @samp{#pragma long_calls} directive, will always be
5812turned into long calls.
5813
5814This feature is not enabled by default. Specifying
c21cd8b1 5815@option{-mno-long-calls} will restore the default behavior, as will
c27ba912
DM
5816placing the function calls within the scope of a @samp{#pragma
5817long_calls_off} directive. Note these switches have no effect on how
5818the compiler generates code to handle function calls via function
02f52e19 5819pointers.
c27ba912 5820
62b10bbc 5821@item -mnop-fun-dllimport
cd3bb277 5822@opindex mnop-fun-dllimport
aee96fe9 5823Disable support for the @code{dllimport} attribute.
62b10bbc 5824
ed0e6530 5825@item -msingle-pic-base
cd3bb277 5826@opindex msingle-pic-base
ed0e6530
PB
5827Treat the register used for PIC addressing as read-only, rather than
5828loading it in the prologue for each function. The run-time system is
c21cd8b1 5829responsible for initializing this register with an appropriate value
ed0e6530
PB
5830before execution begins.
5831
cd3bb277
JM
5832@item -mpic-register=@var{reg}
5833@opindex mpic-register
ed0e6530
PB
5834Specify the register to be used for PIC addressing. The default is R10
5835unless stack-checking is enabled, when R9 is used.
5836
247f8561 5837@item -mpoke-function-name
cd3bb277 5838@opindex mpoke-function-name
247f8561
PB
5839Write the name of each function into the text section, directly
5840preceding the function prologue. The generated code is similar to this:
74291a4b 5841
247f8561
PB
5842@smallexample
5843 t0
5844 .ascii "arm_poke_function_name", 0
5845 .align
5846 t1
5847 .word 0xff000000 + (t1 - t0)
5848 arm_poke_function_name
5849 mov ip, sp
5850 stmfd sp!, @{fp, ip, lr, pc@}
5851 sub fp, ip, #4
5852@end smallexample
157a620e 5853
247f8561
PB
5854When performing a stack backtrace, code can inspect the value of
5855@code{pc} stored at @code{fp + 0}. If the trace function then looks at
5856location @code{pc - 12} and the top 8 bits are set, then we know that
5857there is a function name embedded immediately preceding this location
5858and has length @code{((pc[-3]) & 0xff000000)}.
157a620e 5859
247f8561 5860@item -mthumb
cd3bb277 5861@opindex mthumb
247f8561
PB
5862Generate code for the 16-bit Thumb instruction set. The default is to
5863use the 32-bit ARM instruction set.
157a620e
NC
5864
5865@item -mtpcs-frame
cd3bb277 5866@opindex mtpcs-frame
157a620e
NC
5867Generate a stack frame that is compliant with the Thumb Procedure Call
5868Standard for all non-leaf functions. (A leaf function is one that does
630d3d5a 5869not call any other functions.) The default is @option{-mno-tpcs-frame}.
157a620e
NC
5870
5871@item -mtpcs-leaf-frame
cd3bb277 5872@opindex mtpcs-leaf-frame
157a620e
NC
5873Generate a stack frame that is compliant with the Thumb Procedure Call
5874Standard for all leaf functions. (A leaf function is one that does
630d3d5a 5875not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
62b10bbc
NC
5876
5877@item -mcallee-super-interworking
cd3bb277 5878@opindex mcallee-super-interworking
62b10bbc
NC
5879Gives all externally visible functions in the file being compiled an ARM
5880instruction set header which switches to Thumb mode before executing the
5881rest of the function. This allows these functions to be called from
5882non-interworking code.
5883
5884@item -mcaller-super-interworking
cd3bb277 5885@opindex mcaller-super-interworking
62b10bbc
NC
5886Allows calls via function pointers (including virtual functions) to
5887execute correctly regardless of whether the target code has been
5888compiled for interworking or not. There is a small overhead in the cost
4bdc1ac7
PB
5889of executing a function pointer if this option is enabled.
5890
157a620e
NC
5891@end table
5892
ecff22ab
JL
5893@node MN10200 Options
5894@subsection MN10200 Options
5895@cindex MN10200 options
630d3d5a 5896These @option{-m} options are defined for Matsushita MN10200 architectures:
2642624b 5897@table @gcctabopt
ecff22ab
JL
5898
5899@item -mrelax
cd3bb277 5900@opindex mrelax
ecff22ab
JL
5901Indicate to the linker that it should perform a relaxation optimization pass
5902to shorten branches, calls and absolute memory addresses. This option only
5903has an effect when used on the command line for the final link step.
5904
02f52e19 5905This option makes symbolic debugging impossible.
ecff22ab 5906@end table
157a620e 5907
6d6d0fa0
JL
5908@node MN10300 Options
5909@subsection MN10300 Options
5910@cindex MN10300 options
630d3d5a 5911These @option{-m} options are defined for Matsushita MN10300 architectures:
6d6d0fa0 5912
2642624b 5913@table @gcctabopt
6d6d0fa0 5914@item -mmult-bug
cd3bb277 5915@opindex mmult-bug
6d6d0fa0
JL
5916Generate code to avoid bugs in the multiply instructions for the MN10300
5917processors. This is the default.
5918
5919@item -mno-mult-bug
cd3bb277 5920@opindex mno-mult-bug
6d6d0fa0
JL
5921Do not generate code to avoid bugs in the multiply instructions for the
5922MN10300 processors.
ecff22ab 5923
705ac34f 5924@item -mam33
cd3bb277 5925@opindex mam33
705ac34f
JL
5926Generate code which uses features specific to the AM33 processor.
5927
5928@item -mno-am33
cd3bb277 5929@opindex mno-am33
705ac34f
JL
5930Do not generate code which uses features specific to the AM33 processor. This
5931is the default.
5932
c474f76b
AO
5933@item -mno-crt0
5934@opindex mno-crt0
5935Do not link in the C run-time initialization object file.
5936
ecff22ab 5937@item -mrelax
cd3bb277 5938@opindex mrelax
ecff22ab
JL
5939Indicate to the linker that it should perform a relaxation optimization pass
5940to shorten branches, calls and absolute memory addresses. This option only
5941has an effect when used on the command line for the final link step.
5942
02f52e19 5943This option makes symbolic debugging impossible.
6d6d0fa0
JL
5944@end table
5945
ecff22ab 5946
861bb6c1
JL
5947@node M32R/D Options
5948@subsection M32R/D Options
5949@cindex M32R/D options
5950
630d3d5a 5951These @option{-m} options are defined for Mitsubishi M32R/D architectures:
861bb6c1 5952
2642624b 5953@table @gcctabopt
98180123
NC
5954@item -m32rx
5955@opindex m32rx
0bf93a51 5956Generate code for the M32R/X@.
98180123
NC
5957
5958@item -m32r
5959@opindex m32r
0bf93a51 5960Generate code for the M32R@. This is the default.
de41e41c 5961
861bb6c1 5962@item -mcode-model=small
cd3bb277 5963@opindex mcode-model=small
861bb6c1
JL
5964Assume all objects live in the lower 16MB of memory (so that their addresses
5965can be loaded with the @code{ld24} instruction), and assume all subroutines
5966are reachable with the @code{bl} instruction.
5967This is the default.
5968
5969The addressability of a particular object can be set with the
5970@code{model} attribute.
5971
5972@item -mcode-model=medium
cd3bb277 5973@opindex mcode-model=medium
02f52e19 5974Assume objects may be anywhere in the 32-bit address space (the compiler
861bb6c1
JL
5975will generate @code{seth/add3} instructions to load their addresses), and
5976assume all subroutines are reachable with the @code{bl} instruction.
5977
5978@item -mcode-model=large
cd3bb277 5979@opindex mcode-model=large
02f52e19 5980Assume objects may be anywhere in the 32-bit address space (the compiler
861bb6c1
JL
5981will generate @code{seth/add3} instructions to load their addresses), and
5982assume subroutines may not be reachable with the @code{bl} instruction
5983(the compiler will generate the much slower @code{seth/add3/jl}
5984instruction sequence).
5985
5986@item -msdata=none
cd3bb277 5987@opindex msdata=none
861bb6c1
JL
5988Disable use of the small data area. Variables will be put into
5989one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5990@code{section} attribute has been specified).
5991This is the default.
5992
5993The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5994Objects may be explicitly put in the small data area with the
5995@code{section} attribute using one of these sections.
5996
5997@item -msdata=sdata
cd3bb277 5998@opindex msdata=sdata
861bb6c1
JL
5999Put small global and static data in the small data area, but do not
6000generate special code to reference them.
6001
6002@item -msdata=use
cd3bb277 6003@opindex msdata=use
861bb6c1
JL
6004Put small global and static data in the small data area, and generate
6005special instructions to reference them.
6006
6007@item -G @var{num}
cd3bb277 6008@opindex G
861bb6c1
JL
6009@cindex smaller data references
6010Put global and static objects less than or equal to @var{num} bytes
6011into the small data or bss sections instead of the normal data or bss
6012sections. The default value of @var{num} is 8.
630d3d5a 6013The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
861bb6c1
JL
6014for this option to have any effect.
6015
630d3d5a 6016All modules should be compiled with the same @option{-G @var{num}} value.
861bb6c1 6017Compiling with different values of @var{num} may or may not work; if it
695ac33f 6018doesn't the linker will give an error message---incorrect code will not be
861bb6c1
JL
6019generated.
6020
6021@end table
6022
74291a4b
MM
6023@node M88K Options
6024@subsection M88K Options
6025@cindex M88k options
6026
6027These @samp{-m} options are defined for Motorola 88k architectures:
6028
2642624b 6029@table @gcctabopt
74291a4b 6030@item -m88000
cd3bb277 6031@opindex m88000
74291a4b
MM
6032Generate code that works well on both the m88100 and the
6033m88110.
6034
6035@item -m88100
cd3bb277 6036@opindex m88100
74291a4b
MM
6037Generate code that works best for the m88100, but that also
6038runs on the m88110.
6039
6040@item -m88110
cd3bb277 6041@opindex m88110
74291a4b
MM
6042Generate code that works best for the m88110, and may not run
6043on the m88100.
6044
6045@item -mbig-pic
cd3bb277 6046@opindex mbig-pic
74291a4b 6047Obsolete option to be removed from the next revision.
630d3d5a 6048Use @option{-fPIC}.
74291a4b
MM
6049
6050@item -midentify-revision
cd3bb277 6051@opindex midentify-revision
74291a4b
MM
6052@cindex identifying source, compiler (88k)
6053Include an @code{ident} directive in the assembler output recording the
6054source file name, compiler name and version, timestamp, and compilation
6055flags used.
6056
6057@item -mno-underscores
cd3bb277 6058@opindex mno-underscores
74291a4b
MM
6059@cindex underscores, avoiding (88k)
6060In assembler output, emit symbol names without adding an underscore
6061character at the beginning of each name. The default is to use an
6062underscore as prefix on each name.
6063
6064@item -mocs-debug-info
6065@itemx -mno-ocs-debug-info
cd3bb277
JM
6066@opindex mocs-debug-info
6067@opindex mno-ocs-debug-info
74291a4b
MM
6068@cindex OCS (88k)
6069@cindex debugging, 88k OCS
6070Include (or omit) additional debugging information (about registers used
6071in each stack frame) as specified in the 88open Object Compatibility
161d7b59 6072Standard, ``OCS''@. This extra information allows debugging of code that
74291a4b
MM
6073has had the frame pointer eliminated. The default for DG/UX, SVr4, and
6074Delta 88 SVr3.2 is to include this information; other 88k configurations
6075omit this information by default.
6076
6077@item -mocs-frame-position
cd3bb277 6078@opindex mocs-frame-position
74291a4b
MM
6079@cindex register positions in frame (88k)
6080When emitting COFF debugging information for automatic variables and
6081parameters stored on the stack, use the offset from the canonical frame
6082address, which is the stack pointer (register 31) on entry to the
6083function. The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
630d3d5a
JM
6084@option{-mocs-frame-position}; other 88k configurations have the default
6085@option{-mno-ocs-frame-position}.
74291a4b
MM
6086
6087@item -mno-ocs-frame-position
cd3bb277 6088@opindex mno-ocs-frame-position
74291a4b
MM
6089@cindex register positions in frame (88k)
6090When emitting COFF debugging information for automatic variables and
6091parameters stored on the stack, use the offset from the frame pointer
6092register (register 30). When this option is in effect, the frame
6093pointer is not eliminated when debugging information is selected by the
6094-g switch.
6095
6096@item -moptimize-arg-area
cd3bb277 6097@opindex moptimize-arg-area
74291a4b 6098@cindex arguments in frame (88k)
9c34dbbf
ZW
6099Save space by reorganizing the stack frame. This option generates code
6100that does not agree with the 88open specifications, but uses less
6101memory.
6102
6103@itemx -mno-optimize-arg-area
6104@opindex mno-optimize-arg-area
6105Do not reorganize the stack frame to save space. This is the default.
6106The generated conforms to the specification, but uses more memory.
74291a4b
MM
6107
6108@item -mshort-data-@var{num}
cd3bb277 6109@opindex mshort-data
74291a4b
MM
6110@cindex smaller data references (88k)
6111@cindex r0-relative references (88k)
6112Generate smaller data references by making them relative to @code{r0},
6113which allows loading a value using a single instruction (rather than the
6114usual two). You control which data references are affected by
6115specifying @var{num} with this option. For example, if you specify
630d3d5a 6116@option{-mshort-data-512}, then the data references affected are those
74291a4b 6117involving displacements of less than 512 bytes.
630d3d5a 6118@option{-mshort-data-@var{num}} is not effective for @var{num} greater
74291a4b
MM
6119than 64k.
6120
6121@item -mserialize-volatile
cd3bb277 6122@opindex mserialize-volatile
74291a4b 6123@itemx -mno-serialize-volatile
cd3bb277 6124@opindex mno-serialize-volatile
74291a4b
MM
6125@cindex sequential consistency on 88k
6126Do, or don't, generate code to guarantee sequential consistency
6127of volatile memory references. By default, consistency is
6128guaranteed.
6129
6130The order of memory references made by the MC88110 processor does
6131not always match the order of the instructions requesting those
6132references. In particular, a load instruction may execute before
6133a preceding store instruction. Such reordering violates
6134sequential consistency of volatile memory references, when there
6135are multiple processors. When consistency must be guaranteed,
f0523f02 6136GCC generates special instructions, as needed, to force
74291a4b
MM
6137execution in the proper order.
6138
6139The MC88100 processor does not reorder memory references and so
f0523f02
JM
6140always provides sequential consistency. However, by default, GCC
6141generates the special instructions to guarantee consistency
630d3d5a 6142even when you use @option{-m88100}, so that the code may be run on an
74291a4b 6143MC88110 processor. If you intend to run your code only on the
630d3d5a 6144MC88100 processor, you may use @option{-mno-serialize-volatile}.
74291a4b
MM
6145
6146The extra code generated to guarantee consistency may affect the
6147performance of your application. If you know that you can safely
630d3d5a 6148forgo this guarantee, you may use @option{-mno-serialize-volatile}.
74291a4b
MM
6149
6150@item -msvr4
6151@itemx -msvr3
cd3bb277
JM
6152@opindex msvr4
6153@opindex msvr3
74291a4b
MM
6154@cindex assembler syntax, 88k
6155@cindex SVr4
630d3d5a 6156Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
74291a4b
MM
6157related to System V release 4 (SVr4). This controls the following:
6158
6159@enumerate
6160@item
6161Which variant of the assembler syntax to emit.
6162@item
630d3d5a 6163@option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
74291a4b
MM
6164that is used on System V release 4.
6165@item
630d3d5a 6166@option{-msvr4} makes GCC issue additional declaration directives used in
74291a4b
MM
6167SVr4.
6168@end enumerate
6169
630d3d5a 6170@option{-msvr4} is the default for the m88k-motorola-sysv4 and
767094dd 6171m88k-dg-dgux m88k configurations. @option{-msvr3} is the default for all
74291a4b
MM
6172other m88k configurations.
6173
6174@item -mversion-03.00
cd3bb277 6175@opindex mversion-03.00
74291a4b
MM
6176This option is obsolete, and is ignored.
6177@c ??? which asm syntax better for GAS? option there too?
6178
6179@item -mno-check-zero-division
6180@itemx -mcheck-zero-division
cd3bb277
JM
6181@opindex mno-check-zero-division
6182@opindex mcheck-zero-division
74291a4b
MM
6183@cindex zero division on 88k
6184Do, or don't, generate code to guarantee that integer division by
6185zero will be detected. By default, detection is guaranteed.
6186
6187Some models of the MC88100 processor fail to trap upon integer
6188division by zero under certain conditions. By default, when
f0523f02 6189compiling code that might be run on such a processor, GCC
74291a4b
MM
6190generates code that explicitly checks for zero-valued divisors
6191and traps with exception number 503 when one is detected. Use of
9c34dbbf 6192@option{-mno-check-zero-division} suppresses such checking for code
74291a4b
MM
6193generated to run on an MC88100 processor.
6194
9c34dbbf
ZW
6195GCC assumes that the MC88110 processor correctly detects all instances
6196of integer division by zero. When @option{-m88110} is specified, no
6197explicit checks for zero-valued divisors are generated, and both
6198@option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6199ignored.
74291a4b
MM
6200
6201@item -muse-div-instruction
cd3bb277 6202@opindex muse-div-instruction
74291a4b
MM
6203@cindex divide instruction, 88k
6204Use the div instruction for signed integer division on the
6205MC88100 processor. By default, the div instruction is not used.
6206
6207On the MC88100 processor the signed integer division instruction
6208div) traps to the operating system on a negative operand. The
6209operating system transparently completes the operation, but at a
6210large cost in execution time. By default, when compiling code
f0523f02 6211that might be run on an MC88100 processor, GCC emulates signed
74291a4b
MM
6212integer division using the unsigned integer division instruction
6213divu), thereby avoiding the large penalty of a trap to the
6214operating system. Such emulation has its own, smaller, execution
6215cost in both time and space. To the extent that your code's
6216important signed integer division operations are performed on two
6217nonnegative operands, it may be desirable to use the div
6218instruction directly.
6219
6220On the MC88110 processor the div instruction (also known as the
6221divs instruction) processes negative operands without trapping to
630d3d5a
JM
6222the operating system. When @option{-m88110} is specified,
6223@option{-muse-div-instruction} is ignored, and the div instruction is used
74291a4b
MM
6224for signed integer division.
6225
630d3d5a 6226Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined. In
74291a4b 6227particular, the behavior of such a division with and without
630d3d5a 6228@option{-muse-div-instruction} may differ.
74291a4b
MM
6229
6230@item -mtrap-large-shift
6231@itemx -mhandle-large-shift
cd3bb277
JM
6232@opindex mtrap-large-shift
6233@opindex mhandle-large-shift
74291a4b
MM
6234@cindex bit shift overflow (88k)
6235@cindex large bit shifts (88k)
6236Include code to detect bit-shifts of more than 31 bits; respectively,
0c2d1a2a 6237trap such shifts or emit code to handle them properly. By default GCC
74291a4b
MM
6238makes no special provision for large bit shifts.
6239
6240@item -mwarn-passed-structs
cd3bb277 6241@opindex mwarn-passed-structs
74291a4b
MM
6242@cindex structure passing (88k)
6243Warn when a function passes a struct as an argument or result.
6244Structure-passing conventions have changed during the evolution of the C
6245language, and are often the source of portability problems. By default,
0c2d1a2a 6246GCC issues no such warning.
74291a4b
MM
6247@end table
6248
9c34dbbf
ZW
6249@c break page here to avoid unsightly interparagraph stretch.
6250@c -zw, 2001-8-17
6251@page
6252
74291a4b
MM
6253@node RS/6000 and PowerPC Options
6254@subsection IBM RS/6000 and PowerPC Options
6255@cindex RS/6000 and PowerPC Options
6256@cindex IBM RS/6000 and PowerPC Options
6257
6258These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
2642624b 6259@table @gcctabopt
74291a4b
MM
6260@item -mpower
6261@itemx -mno-power
6262@itemx -mpower2
6263@itemx -mno-power2
6264@itemx -mpowerpc
6265@itemx -mno-powerpc
6266@itemx -mpowerpc-gpopt
6267@itemx -mno-powerpc-gpopt
6268@itemx -mpowerpc-gfxopt
6269@itemx -mno-powerpc-gfxopt
7fe90e7b
DE
6270@itemx -mpowerpc64
6271@itemx -mno-powerpc64
cd3bb277
JM
6272@opindex mpower
6273@opindex mno-power
6274@opindex mpower2
6275@opindex mno-power2
6276@opindex mpowerpc
6277@opindex mno-powerpc
6278@opindex mpowerpc-gpopt
6279@opindex mno-powerpc-gpopt
6280@opindex mpowerpc-gfxopt
6281@opindex mno-powerpc-gfxopt
6282@opindex mpowerpc64
6283@opindex mno-powerpc64
0c2d1a2a 6284GCC supports two related instruction set architectures for the
161d7b59 6285RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
74291a4b
MM
6286instructions supported by the @samp{rios} chip set used in the original
6287RS/6000 systems and the @dfn{PowerPC} instruction set is the
6288architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
861bb6c1 6289the IBM 4xx microprocessors.
74291a4b
MM
6290
6291Neither architecture is a subset of the other. However there is a
6292large common subset of instructions supported by both. An MQ
6293register is included in processors supporting the POWER architecture.
6294
6295You use these options to specify which instructions are available on the
6296processor you are using. The default value of these options is
161d7b59 6297determined when configuring GCC@. Specifying the
630d3d5a
JM
6298@option{-mcpu=@var{cpu_type}} overrides the specification of these
6299options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
74291a4b
MM
6300rather than the options listed above.
6301
630d3d5a 6302The @option{-mpower} option allows GCC to generate instructions that
74291a4b 6303are found only in the POWER architecture and to use the MQ register.
630d3d5a 6304Specifying @option{-mpower2} implies @option{-power} and also allows GCC
74291a4b
MM
6305to generate instructions that are present in the POWER2 architecture but
6306not the original POWER architecture.
6307
630d3d5a 6308The @option{-mpowerpc} option allows GCC to generate instructions that
74291a4b 6309are found only in the 32-bit subset of the PowerPC architecture.
630d3d5a 6310Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
0c2d1a2a 6311GCC to use the optional PowerPC architecture instructions in the
74291a4b 6312General Purpose group, including floating-point square root. Specifying
630d3d5a 6313@option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
74291a4b
MM
6314use the optional PowerPC architecture instructions in the Graphics
6315group, including floating-point select.
6316
630d3d5a 6317The @option{-mpowerpc64} option allows GCC to generate the additional
7fe90e7b 631864-bit instructions that are found in the full PowerPC64 architecture
0c2d1a2a 6319and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
630d3d5a 6320@option{-mno-powerpc64}.
7fe90e7b 6321
630d3d5a 6322If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
74291a4b
MM
6323will use only the instructions in the common subset of both
6324architectures plus some special AIX common-mode calls, and will not use
630d3d5a 6325the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
0c2d1a2a 6326permits GCC to use any instruction from either architecture and to
74291a4b
MM
6327allow use of the MQ register; specify this for the Motorola MPC601.
6328
6329@item -mnew-mnemonics
6330@itemx -mold-mnemonics
cd3bb277
JM
6331@opindex mnew-mnemonics
6332@opindex mold-mnemonics
9c34dbbf
ZW
6333Select which mnemonics to use in the generated assembler code. With
6334@option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6335the PowerPC architecture. With @option{-mold-mnemonics} it uses the
6336assembler mnemonics defined for the POWER architecture. Instructions
6337defined in only one architecture have only one mnemonic; GCC uses that
6338mnemonic irrespective of which of these options is specified.
74291a4b 6339
0c2d1a2a 6340GCC defaults to the mnemonics appropriate for the architecture in
630d3d5a 6341use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7fe90e7b 6342value of these option. Unless you are building a cross-compiler, you
630d3d5a
JM
6343should normally not specify either @option{-mnew-mnemonics} or
6344@option{-mold-mnemonics}, but should instead accept the default.
74291a4b
MM
6345
6346@item -mcpu=@var{cpu_type}
cd3bb277 6347@opindex mcpu
74291a4b
MM
6348Set architecture type, register usage, choice of mnemonics, and
6349instruction scheduling parameters for machine type @var{cpu_type}.
5f59ecb7
DE
6350Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6351@samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6352@samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
ed947a96
DJ
6353@samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6354@samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6355@samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
9c34dbbf
ZW
6356
6357@option{-mcpu=common} selects a completely generic processor. Code
6358generated under this option will run on any POWER or PowerPC processor.
6359GCC will use only the instructions in the common subset of both
6360architectures, and will not use the MQ register. GCC assumes a generic
74291a4b
MM
6361processor model for scheduling purposes.
6362
9c34dbbf
ZW
6363@option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6364@option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6365PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6366types, with an appropriate, generic processor model assumed for
6367scheduling purposes.
74291a4b 6368
9c34dbbf
ZW
6369The other options specify a specific processor. Code generated under
6370those options will run best on that processor, and may not run at all on
6371others.
6372
6373The @option{-mcpu} options automatically enable or disable other
6374@option{-m} options as follows:
6375
6376@table @samp
6377@item common
6378@option{-mno-power}, @option{-mno-powerc}
6379
6380@item power
6381@itemx power2
6382@itemx rios1
6383@itemx rios2
6384@itemx rsc
6385@option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6386
6387@item powerpc
6388@itemx rs64a
6389@itemx 602
6390@itemx 603
6391@itemx 603e
6392@itemx 604
6393@itemx 620
6394@itemx 630
6395@itemx 740
ed947a96
DJ
6396@itemx 7400
6397@itemx 7450
9c34dbbf
ZW
6398@itemx 750
6399@itemx 505
6400@option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6401
6402@item 601
6403@option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6404
6405@item 403
6406@itemx 821
6407@itemx 860
6408@option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6409@end table
74291a4b
MM
6410
6411@item -mtune=@var{cpu_type}
cd3bb277 6412@opindex mtune
74291a4b 6413Set the instruction scheduling parameters for machine type
9c34dbbf
ZW
6414@var{cpu_type}, but do not set the architecture type, register usage, or
6415choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
6416values for @var{cpu_type} are used for @option{-mtune} as for
6417@option{-mcpu}. If both are specified, the code generated will use the
6418architecture, registers, and mnemonics set by @option{-mcpu}, but the
6419scheduling parameters set by @option{-mtune}.
74291a4b 6420
0ac081f6
AH
6421@item -maltivec
6422@itemx -mno-altivec
6423@opindex maltivec
6424@opindex mno-altivec
6425These switches enable or disable the use of built-in functions that
6426allow access to the AltiVec instruction set. You may also need to set
6427@option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6428enhancements.
6429
74291a4b
MM
6430@item -mfull-toc
6431@itemx -mno-fp-in-toc
6432@itemx -mno-sum-in-toc
6433@itemx -mminimal-toc
cd3bb277
JM
6434@opindex mfull-toc
6435@opindex mno-fp-in-toc
6436@opindex mno-sum-in-toc
6437@opindex mminimal-toc
74291a4b 6438Modify generation of the TOC (Table Of Contents), which is created for
630d3d5a 6439every executable file. The @option{-mfull-toc} option is selected by
0c2d1a2a
JB
6440default. In that case, GCC will allocate at least one TOC entry for
6441each unique non-automatic variable reference in your program. GCC
161d7b59
JM
6442will also place floating-point constants in the TOC@. However, only
644316,384 entries are available in the TOC@.
74291a4b
MM
6444
6445If you receive a linker error message that saying you have overflowed
6446the available TOC space, you can reduce the amount of TOC space used
630d3d5a
JM
6447with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6448@option{-mno-fp-in-toc} prevents GCC from putting floating-point
6449constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
74291a4b 6450generate code to calculate the sum of an address and a constant at
161d7b59 6451run-time instead of putting that sum into the TOC@. You may specify one
0c2d1a2a 6452or both of these options. Each causes GCC to produce very slightly
74291a4b
MM
6453slower and larger code at the expense of conserving TOC space.
6454
6455If you still run out of space in the TOC even when you specify both of
630d3d5a 6456these options, specify @option{-mminimal-toc} instead. This option causes
0c2d1a2a
JB
6457GCC to make only one TOC entry for every file. When you specify this
6458option, GCC will produce code that is slower and larger but which
74291a4b 6459uses extremely little TOC space. You may wish to use this option
bd819a4a 6460only on files that contain less frequently executed code.
74291a4b 6461
fa06229f
GK
6462@item -maix64
6463@itemx -maix32
cd3bb277
JM
6464@opindex maix64
6465@opindex maix32
fa06229f 6466Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7fe90e7b 6467@code{long} type, and the infrastructure needed to support them.
630d3d5a
JM
6468Specifying @option{-maix64} implies @option{-mpowerpc64} and
6469@option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6470implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
7fe90e7b 6471
74291a4b
MM
6472@item -mxl-call
6473@itemx -mno-xl-call
cd3bb277
JM
6474@opindex mxl-call
6475@opindex mno-xl-call
74291a4b
MM
6476On AIX, pass floating-point arguments to prototyped functions beyond the
6477register save area (RSA) on the stack in addition to argument FPRs. The
6478AIX calling convention was extended but not initially documented to
6479handle an obscure K&R C case of calling a function that takes the
6480address of its arguments with fewer arguments than declared. AIX XL
7fe90e7b
DE
6481compilers access floating point arguments which do not fit in the
6482RSA from the stack when a subroutine is compiled without
74291a4b
MM
6483optimization. Because always storing floating-point arguments on the
6484stack is inefficient and rarely needed, this option is not enabled by
6485default and only is necessary when calling subroutines compiled by AIX
6486XL compilers without optimization.
6487
861bb6c1 6488@item -mpe
cd3bb277 6489@opindex mpe
161d7b59 6490Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
861bb6c1
JL
6491application written to use message passing with special startup code to
6492enable the application to run. The system must have PE installed in the
6493standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
630d3d5a 6494must be overridden with the @option{-specs=} option to specify the
861bb6c1 6495appropriate directory location. The Parallel Environment does not
0a379b7a 6496support threads, so the @option{-mpe} option and the @option{-pthread}
861bb6c1
JL
6497option are incompatible.
6498
74291a4b
MM
6499@item -msoft-float
6500@itemx -mhard-float
cd3bb277
JM
6501@opindex msoft-float
6502@opindex mhard-float
74291a4b
MM
6503Generate code that does not use (uses) the floating-point register set.
6504Software floating point emulation is provided if you use the
630d3d5a 6505@option{-msoft-float} option, and pass the option to GCC when linking.
74291a4b
MM
6506
6507@item -mmultiple
6508@itemx -mno-multiple
cd3bb277
JM
6509@opindex mmultiple
6510@opindex mno-multiple
74291a4b
MM
6511Generate code that uses (does not use) the load multiple word
6512instructions and the store multiple word instructions. These
6513instructions are generated by default on POWER systems, and not
630d3d5a 6514generated on PowerPC systems. Do not use @option{-mmultiple} on little
74291a4b 6515endian PowerPC systems, since those instructions do not work when the
bef84347
VM
6516processor is in little endian mode. The exceptions are PPC740 and
6517PPC750 which permit the instructions usage in little endian mode.
74291a4b
MM
6518
6519@item -mstring
6520@itemx -mno-string
cd3bb277
JM
6521@opindex mstring
6522@opindex mno-string
bef84347
VM
6523Generate code that uses (does not use) the load string instructions
6524and the store string word instructions to save multiple registers and
6525do small block moves. These instructions are generated by default on
6526POWER systems, and not generated on PowerPC systems. Do not use
630d3d5a 6527@option{-mstring} on little endian PowerPC systems, since those
bef84347
VM
6528instructions do not work when the processor is in little endian mode.
6529The exceptions are PPC740 and PPC750 which permit the instructions
6530usage in little endian mode.
74291a4b 6531
861bb6c1
JL
6532@item -mupdate
6533@itemx -mno-update
cd3bb277
JM
6534@opindex mupdate
6535@opindex mno-update
861bb6c1
JL
6536Generate code that uses (does not use) the load or store instructions
6537that update the base register to the address of the calculated memory
6538location. These instructions are generated by default. If you use
630d3d5a 6539@option{-mno-update}, there is a small window between the time that the
861bb6c1
JL
6540stack pointer is updated and the address of the previous frame is
6541stored, which means code that walks the stack frame across interrupts or
6542signals may get corrupted data.
6543
6544@item -mfused-madd
6545@itemx -mno-fused-madd
cd3bb277
JM
6546@opindex mfused-madd
6547@opindex mno-fused-madd
861bb6c1
JL
6548Generate code that uses (does not use) the floating point multiply and
6549accumulate instructions. These instructions are generated by default if
6550hardware floating is used.
6551
74291a4b
MM
6552@item -mno-bit-align
6553@itemx -mbit-align
cd3bb277
JM
6554@opindex mno-bit-align
6555@opindex mbit-align
74291a4b 6556On System V.4 and embedded PowerPC systems do not (do) force structures
c771326b
JM
6557and unions that contain bit-fields to be aligned to the base type of the
6558bit-field.
74291a4b
MM
6559
6560For example, by default a structure containing nothing but 8
c771326b 6561@code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
630d3d5a 6562boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
74291a4b
MM
6563the structure would be aligned to a 1 byte boundary and be one byte in
6564size.
6565
6566@item -mno-strict-align
6567@itemx -mstrict-align
cd3bb277
JM
6568@opindex mno-strict-align
6569@opindex mstrict-align
74291a4b
MM
6570On System V.4 and embedded PowerPC systems do not (do) assume that
6571unaligned memory references will be handled by the system.
6572
6573@item -mrelocatable
6574@itemx -mno-relocatable
cd3bb277
JM
6575@opindex mrelocatable
6576@opindex mno-relocatable
74291a4b
MM
6577On embedded PowerPC systems generate code that allows (does not allow)
6578the program to be relocated to a different address at runtime. If you
630d3d5a
JM
6579use @option{-mrelocatable} on any module, all objects linked together must
6580be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
74291a4b
MM
6581
6582@item -mrelocatable-lib
6583@itemx -mno-relocatable-lib
cd3bb277
JM
6584@opindex mrelocatable-lib
6585@opindex mno-relocatable-lib
74291a4b
MM
6586On embedded PowerPC systems generate code that allows (does not allow)
6587the program to be relocated to a different address at runtime. Modules
630d3d5a
JM
6588compiled with @option{-mrelocatable-lib} can be linked with either modules
6589compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
6590with modules compiled with the @option{-mrelocatable} options.
74291a4b
MM
6591
6592@item -mno-toc
6593@itemx -mtoc
cd3bb277
JM
6594@opindex mno-toc
6595@opindex mtoc
74291a4b
MM
6596On System V.4 and embedded PowerPC systems do not (do) assume that
6597register 2 contains a pointer to a global area pointing to the addresses
6598used in the program.
6599
74291a4b
MM
6600@item -mlittle
6601@itemx -mlittle-endian
cd3bb277
JM
6602@opindex mlittle
6603@opindex mlittle-endian
74291a4b 6604On System V.4 and embedded PowerPC systems compile code for the
630d3d5a
JM
6605processor in little endian mode. The @option{-mlittle-endian} option is
6606the same as @option{-mlittle}.
74291a4b
MM
6607
6608@item -mbig
6609@itemx -mbig-endian
cd3bb277
JM
6610@opindex mbig
6611@opindex mbig-endian
74291a4b 6612On System V.4 and embedded PowerPC systems compile code for the
630d3d5a
JM
6613processor in big endian mode. The @option{-mbig-endian} option is
6614the same as @option{-mbig}.
74291a4b
MM
6615
6616@item -mcall-sysv
cd3bb277 6617@opindex mcall-sysv
74291a4b
MM
6618On System V.4 and embedded PowerPC systems compile code using calling
6619conventions that adheres to the March 1995 draft of the System V
6620Application Binary Interface, PowerPC processor supplement. This is the
6621default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6622
6623@item -mcall-sysv-eabi
cd3bb277 6624@opindex mcall-sysv-eabi
630d3d5a 6625Specify both @option{-mcall-sysv} and @option{-meabi} options.
74291a4b
MM
6626
6627@item -mcall-sysv-noeabi
cd3bb277 6628@opindex mcall-sysv-noeabi
630d3d5a 6629Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
74291a4b
MM
6630
6631@item -mcall-aix
cd3bb277 6632@opindex mcall-aix
74291a4b 6633On System V.4 and embedded PowerPC systems compile code using calling
161d7b59 6634conventions that are similar to those used on AIX@. This is the
74291a4b
MM
6635default if you configured GCC using @samp{powerpc-*-eabiaix}.
6636
6637@item -mcall-solaris
cd3bb277 6638@opindex mcall-solaris
74291a4b
MM
6639On System V.4 and embedded PowerPC systems compile code for the Solaris
6640operating system.
6641
6642@item -mcall-linux
cd3bb277 6643@opindex mcall-linux
861bb6c1
JL
6644On System V.4 and embedded PowerPC systems compile code for the
6645Linux-based GNU system.
74291a4b 6646
48180d68
RM
6647@item -mcall-gnu
6648@opindex mcall-gnu
6649On System V.4 and embedded PowerPC systems compile code for the
6650Hurd-based GNU system.
6651
edf1b3f3
AC
6652@item -mcall-netbsd
6653@opindex mcall-netbsd
6654On System V.4 and embedded PowerPC systems compile code for the
6655NetBSD operating system.
6656
9904592e
ZW
6657@item -maix-struct-return
6658@opindex maix-struct-return
6659Return all structures in memory (as specified by the AIX ABI)@.
6660
6661@item -msvr4-struct-return
6662@opindex msvr4-struct-return
6663Return structures smaller than 8 bytes in registers (as specified by the
6664SVR4 ABI)@.
6665
0ac081f6
AH
6666@item -mabi=altivec
6667@opindex mabi=altivec
6668Extend the current ABI with AltiVec ABI extensions. This does not
6669change the default ABI, instead it adds the AltiVec ABI extensions to
6670the current ABI@.
6671
76a773f3
AH
6672@item -mabi=no-altivec
6673@opindex mabi=no-altivec
6674Disable AltiVec ABI extensions for the current ABI.
6675
74291a4b 6676@item -mprototype
e9a25f70 6677@itemx -mno-prototype
cd3bb277
JM
6678@opindex mprototype
6679@opindex mno-prototype
74291a4b
MM
6680On System V.4 and embedded PowerPC systems assume that all calls to
6681variable argument functions are properly prototyped. Otherwise, the
6682compiler must insert an instruction before every non prototyped call to
6683set or clear bit 6 of the condition code register (@var{CR}) to
6684indicate whether floating point values were passed in the floating point
6685registers in case the function takes a variable arguments. With
630d3d5a 6686@option{-mprototype}, only calls to prototyped variable argument functions
74291a4b
MM
6687will set or clear the bit.
6688
6689@item -msim
cd3bb277 6690@opindex msim
74291a4b
MM
6691On embedded PowerPC systems, assume that the startup module is called
6692@file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6693@file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
6694configurations.
6695
6696@item -mmvme
cd3bb277 6697@opindex mmvme
74291a4b 6698On embedded PowerPC systems, assume that the startup module is called
e9a25f70
JL
6699@file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6700@file{libc.a}.
6701
6702@item -mads
cd3bb277 6703@opindex mads
e9a25f70
JL
6704On embedded PowerPC systems, assume that the startup module is called
6705@file{crt0.o} and the standard C libraries are @file{libads.a} and
6706@file{libc.a}.
6707
6708@item -myellowknife
cd3bb277 6709@opindex myellowknife
e9a25f70
JL
6710On embedded PowerPC systems, assume that the startup module is called
6711@file{crt0.o} and the standard C libraries are @file{libyk.a} and
74291a4b
MM
6712@file{libc.a}.
6713
bff46771 6714@item -mvxworks
cd3bb277 6715@opindex mvxworks
bff46771
GK
6716On System V.4 and embedded PowerPC systems, specify that you are
6717compiling for a VxWorks system.
6718
74291a4b 6719@item -memb
cd3bb277 6720@opindex memb
74291a4b
MM
6721On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6722header to indicate that @samp{eabi} extended relocations are used.
6723
6724@item -meabi
6725@itemx -mno-eabi
cd3bb277
JM
6726@opindex meabi
6727@opindex mno-eabi
74291a4b
MM
6728On System V.4 and embedded PowerPC systems do (do not) adhere to the
6729Embedded Applications Binary Interface (eabi) which is a set of
bedc7537 6730modifications to the System V.4 specifications. Selecting @option{-meabi}
74291a4b
MM
6731means that the stack is aligned to an 8 byte boundary, a function
6732@code{__eabi} is called to from @code{main} to set up the eabi
630d3d5a 6733environment, and the @option{-msdata} option can use both @code{r2} and
74291a4b 6734@code{r13} to point to two separate small data areas. Selecting
bedc7537 6735@option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
74291a4b 6736do not call an initialization function from @code{main}, and the
630d3d5a
JM
6737@option{-msdata} option will only use @code{r13} to point to a single
6738small data area. The @option{-meabi} option is on by default if you
74291a4b
MM
6739configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6740
6741@item -msdata=eabi
cd3bb277 6742@opindex msdata=eabi
74291a4b
MM
6743On System V.4 and embedded PowerPC systems, put small initialized
6744@code{const} global and static data in the @samp{.sdata2} section, which
6745is pointed to by register @code{r2}. Put small initialized
6746non-@code{const} global and static data in the @samp{.sdata} section,
6747which is pointed to by register @code{r13}. Put small uninitialized
6748global and static data in the @samp{.sbss} section, which is adjacent to
630d3d5a
JM
6749the @samp{.sdata} section. The @option{-msdata=eabi} option is
6750incompatible with the @option{-mrelocatable} option. The
6751@option{-msdata=eabi} option also sets the @option{-memb} option.
74291a4b
MM
6752
6753@item -msdata=sysv
cd3bb277 6754@opindex msdata=sysv
74291a4b
MM
6755On System V.4 and embedded PowerPC systems, put small global and static
6756data in the @samp{.sdata} section, which is pointed to by register
6757@code{r13}. Put small uninitialized global and static data in the
6758@samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
630d3d5a
JM
6759The @option{-msdata=sysv} option is incompatible with the
6760@option{-mrelocatable} option.
74291a4b
MM
6761
6762@item -msdata=default
6763@itemx -msdata
cd3bb277
JM
6764@opindex msdata=default
6765@opindex msdata
630d3d5a
JM
6766On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
6767compile code the same as @option{-msdata=eabi}, otherwise compile code the
6768same as @option{-msdata=sysv}.
74291a4b
MM
6769
6770@item -msdata-data
cd3bb277 6771@opindex msdata-data
74291a4b
MM
6772On System V.4 and embedded PowerPC systems, put small global and static
6773data in the @samp{.sdata} section. Put small uninitialized global and
6774static data in the @samp{.sbss} section. Do not use register @code{r13}
6775to address small data however. This is the default behavior unless
630d3d5a 6776other @option{-msdata} options are used.
74291a4b
MM
6777
6778@item -msdata=none
6779@itemx -mno-sdata
cd3bb277
JM
6780@opindex msdata=none
6781@opindex mno-sdata
74291a4b
MM
6782On embedded PowerPC systems, put all initialized global and static data
6783in the @samp{.data} section, and all uninitialized data in the
6784@samp{.bss} section.
6785
6786@item -G @var{num}
cd3bb277 6787@opindex G
74291a4b
MM
6788@cindex smaller data references (PowerPC)
6789@cindex .sdata/.sdata2 references (PowerPC)
956d6950 6790On embedded PowerPC systems, put global and static items less than or
74291a4b
MM
6791equal to @var{num} bytes into the small data or bss sections instead of
6792the normal data or bss section. By default, @var{num} is 8. The
630d3d5a
JM
6793@option{-G @var{num}} switch is also passed to the linker.
6794All modules should be compiled with the same @option{-G @var{num}} value.
74291a4b
MM
6795
6796@item -mregnames
6797@itemx -mno-regnames
cd3bb277
JM
6798@opindex mregnames
6799@opindex mno-regnames
74291a4b
MM
6800On System V.4 and embedded PowerPC systems do (do not) emit register
6801names in the assembly language output using symbolic forms.
f5a1b0d2 6802
0a379b7a
CR
6803@item -pthread
6804@opindex pthread
6805Adds support for multithreading with the @dfn{pthreads} library.
6806This option sets flags for both the preprocessor and linker.
6807
74291a4b 6808@end table
f5a1b0d2 6809
74291a4b
MM
6810@node RT Options
6811@subsection IBM RT Options
6812@cindex RT options
6813@cindex IBM RT options
6814
6815These @samp{-m} options are defined for the IBM RT PC:
6816
2642624b 6817@table @gcctabopt
74291a4b 6818@item -min-line-mul
cd3bb277 6819@opindex min-line-mul
74291a4b
MM
6820Use an in-line code sequence for integer multiplies. This is the
6821default.
6822
6823@item -mcall-lib-mul
cd3bb277 6824@opindex mcall-lib-mul
74291a4b
MM
6825Call @code{lmul$$} for integer multiples.
6826
6827@item -mfull-fp-blocks
cd3bb277 6828@opindex mfull-fp-blocks
74291a4b 6829Generate full-size floating point data blocks, including the minimum
161d7b59 6830amount of scratch space recommended by IBM@. This is the default.
74291a4b
MM
6831
6832@item -mminimum-fp-blocks
cd3bb277 6833@opindex mminimum-fp-blocks
74291a4b
MM
6834Do not include extra scratch space in floating point data blocks. This
6835results in smaller code, but slower execution, since scratch space must
6836be allocated dynamically.
6837
6838@cindex @file{varargs.h} and RT PC
6839@cindex @file{stdarg.h} and RT PC
6840@item -mfp-arg-in-fpregs
cd3bb277 6841@opindex mfp-arg-in-fpregs
74291a4b
MM
6842Use a calling sequence incompatible with the IBM calling convention in
6843which floating point arguments are passed in floating point registers.
c771326b 6844Note that @code{varargs.h} and @code{stdarg.h} will not work with
74291a4b
MM
6845floating point operands if this option is specified.
6846
6847@item -mfp-arg-in-gregs
cd3bb277 6848@opindex mfp-arg-in-gregs
74291a4b
MM
6849Use the normal calling convention for floating point arguments. This is
6850the default.
6851
6852@item -mhc-struct-return
cd3bb277 6853@opindex mhc-struct-return
74291a4b
MM
6854Return structures of more than one word in memory, rather than in a
6855register. This provides compatibility with the MetaWare HighC (hc)
630d3d5a 6856compiler. Use the option @option{-fpcc-struct-return} for compatibility
74291a4b
MM
6857with the Portable C Compiler (pcc).
6858
6859@item -mnohc-struct-return
cd3bb277 6860@opindex mnohc-struct-return
74291a4b
MM
6861Return some structures of more than one word in registers, when
6862convenient. This is the default. For compatibility with the
630d3d5a
JM
6863IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
6864option @option{-mhc-struct-return}.
74291a4b
MM
6865@end table
6866
6867@node MIPS Options
6868@subsection MIPS Options
6869@cindex MIPS options
6870
6871These @samp{-m} options are defined for the MIPS family of computers:
6872
2642624b 6873@table @gcctabopt
7dac2f89
EC
6874
6875@item -march=@var{cpu-type}
6876@opindex march
6877Assume the defaults for the machine type @var{cpu-type} when generating
6878instructions. The choices for @var{cpu-type} are @samp{r2000}, @samp{r3000},
6879@samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6880@samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6881and @samp{orion}. Additionally, the @samp{r2000}, @samp{r3000},
6882@samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6883@samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.
6884
6885@item -mtune=@var{cpu-type}
6886@opindex mtune
630d3d5a
JM
6887Assume the defaults for the machine type @var{cpu-type} when scheduling
6888instructions. The choices for @var{cpu-type} are @samp{r2000}, @samp{r3000},
8b9243df
JJ
6889@samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6890@samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6891and @samp{orion}. Additionally, the @samp{r2000}, @samp{r3000},
6892@samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6893@samp{r2k} (or @samp{r2K}), @samp{r3k}, etc. While picking a specific
630d3d5a 6894@var{cpu-type} will schedule things appropriately for that particular
8b9243df 6895chip, the compiler will not generate any code that does not meet level 1
630d3d5a
JM
6896of the MIPS ISA (instruction set architecture) without a @option{-mipsX}
6897or @option{-mabi} switch being used.
74291a4b 6898
7dac2f89
EC
6899@item -mcpu=@var{cpu-type}
6900@opindex mcpu
6901This is identical to specifying both @option{-march} and @option{-mtune}.
6902
74291a4b 6903@item -mips1
cd3bb277 6904@opindex mips1
161d7b59 6905Issue instructions from level 1 of the MIPS ISA@. This is the default.
630d3d5a 6906@samp{r3000} is the default @var{cpu-type} at this ISA level.
74291a4b
MM
6907
6908@item -mips2
cd3bb277 6909@opindex mips2
74291a4b 6910Issue instructions from level 2 of the MIPS ISA (branch likely, square
630d3d5a 6911root instructions). @samp{r6000} is the default @var{cpu-type} at this
74291a4b
MM
6912ISA level.
6913
6914@item -mips3
cd3bb277 6915@opindex mips3
02f52e19 6916Issue instructions from level 3 of the MIPS ISA (64-bit instructions).
630d3d5a 6917@samp{r4000} is the default @var{cpu-type} at this ISA level.
74291a4b 6918
3398f47f 6919@item -mips4
cd3bb277 6920@opindex mips4
8b9243df
JJ
6921Issue instructions from level 4 of the MIPS ISA (conditional move,
6922prefetch, enhanced FPU instructions). @samp{r8000} is the default
630d3d5a 6923@var{cpu-type} at this ISA level.
3398f47f 6924
74291a4b 6925@item -mfp32
cd3bb277 6926@opindex mfp32
74291a4b
MM
6927Assume that 32 32-bit floating point registers are available. This is
6928the default.
6929
6930@item -mfp64
cd3bb277 6931@opindex mfp64
74291a4b 6932Assume that 32 64-bit floating point registers are available. This is
630d3d5a 6933the default when the @option{-mips3} option is used.
74291a4b 6934
13fac94a
GK
6935@item -mfused-madd
6936@itemx -mno-fused-madd
6937@opindex mfused-madd
6938@opindex mno-fused-madd
6939Generate code that uses (does not use) the floating point multiply and
6940accumulate instructions, when they are available. These instructions
6941are generated by default if they are available, but this may be
6942undesirable if the extra precision causes problems or on certain chips
6943in the mode where denormals are rounded to zero where denormals
6944generated by multiply and accumulate instructions cause exceptions
6945anyway.
6946
74291a4b 6947@item -mgp32
cd3bb277 6948@opindex mgp32
74291a4b
MM
6949Assume that 32 32-bit general purpose registers are available. This is
6950the default.
6951
6952@item -mgp64
cd3bb277 6953@opindex mgp64
74291a4b 6954Assume that 32 64-bit general purpose registers are available. This is
630d3d5a 6955the default when the @option{-mips3} option is used.
74291a4b
MM
6956
6957@item -mint64
cd3bb277 6958@opindex mint64
630d3d5a 6959Force int and long types to be 64 bits wide. See @option{-mlong32} for an
3ce1ba83 6960explanation of the default, and the width of pointers.
74291a4b
MM
6961
6962@item -mlong64
cd3bb277 6963@opindex mlong64
630d3d5a 6964Force long types to be 64 bits wide. See @option{-mlong32} for an
3ce1ba83 6965explanation of the default, and the width of pointers.
fb1bf66d 6966
3ce1ba83 6967@item -mlong32
cd3bb277 6968@opindex mlong32
3ce1ba83
GRK
6969Force long, int, and pointer types to be 32 bits wide.
6970
630d3d5a 6971If none of @option{-mlong32}, @option{-mlong64}, or @option{-mint64} are set,
b192711e 6972the size of ints, longs, and pointers depends on the ABI and ISA chosen.
630d3d5a
JM
6973For @option{-mabi=32}, and @option{-mabi=n32}, ints and longs are 32 bits
6974wide. For @option{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6975For @option{-mabi=eabi} and either @option{-mips1} or @option{-mips2}, ints
6976and longs are 32 bits wide. For @option{-mabi=eabi} and higher ISAs, ints
3ce1ba83
GRK
6977are 32 bits, and longs are 64 bits wide. The width of pointer types is
6978the smaller of the width of longs or the width of general purpose
161d7b59 6979registers (which in turn depends on the ISA)@.
74291a4b 6980
62a1403d 6981@item -mabi=32
8b9243df 6982@itemx -mabi=o64
3398f47f
MM
6983@itemx -mabi=n32
6984@itemx -mabi=64
6985@itemx -mabi=eabi
cd3bb277
JM
6986@opindex mabi=32
6987@opindex mabi=o64
6988@opindex mabi=n32
6989@opindex mabi=64
6990@opindex mabi=eabi
161d7b59 6991Generate code for the indicated ABI@. The default instruction level is
630d3d5a
JM
6992@option{-mips1} for @samp{32}, @option{-mips3} for @samp{n32}, and
6993@option{-mips4} otherwise. Conversely, with @option{-mips1} or
6994@option{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
8b9243df 6995is @samp{64}.
3398f47f 6996
74291a4b 6997@item -mmips-as
cd3bb277 6998@opindex mmips-as
74291a4b
MM
6999Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7000add normal debug information. This is the default for all
7001platforms except for the OSF/1 reference platform, using the OSF/rose
630d3d5a 7002object format. If the either of the @option{-gstabs} or @option{-gstabs+}
74291a4b 7003switches are used, the @file{mips-tfile} program will encapsulate the
161d7b59 7004stabs within MIPS ECOFF@.
74291a4b
MM
7005
7006@item -mgas
cd3bb277 7007@opindex mgas
74291a4b 7008Generate code for the GNU assembler. This is the default on the OSF/1
861bb6c1 7009reference platform, using the OSF/rose object format. Also, this is
630d3d5a 7010the default if the configure option @option{--with-gnu-as} is used.
861bb6c1
JL
7011
7012@item -msplit-addresses
7013@itemx -mno-split-addresses
cd3bb277
JM
7014@opindex msplit-addresses
7015@opindex mno-split-addresses
861bb6c1 7016Generate code to load the high and low parts of address constants separately.
aee96fe9 7017This allows GCC to optimize away redundant loads of the high order
861bb6c1
JL
7018bits of addresses. This optimization requires GNU as and GNU ld.
7019This optimization is enabled by default for some embedded targets where
7020GNU as and GNU ld are standard.
74291a4b
MM
7021
7022@item -mrnames
7023@itemx -mno-rnames
cd3bb277
JM
7024@opindex mrnames
7025@opindex mno-rnames
630d3d5a 7026The @option{-mrnames} switch says to output code using the MIPS software
74291a4b
MM
7027names for the registers, instead of the hardware names (ie, @var{a0}
7028instead of @var{$4}). The only known assembler that supports this option
7029is the Algorithmics assembler.
7030
7031@item -mgpopt
7032@itemx -mno-gpopt
cd3bb277
JM
7033@opindex mgpopt
7034@opindex mno-gpopt
630d3d5a 7035The @option{-mgpopt} switch says to write all of the data declarations
74291a4b
MM
7036before the instructions in the text section, this allows the MIPS
7037assembler to generate one word memory references instead of using two
7038words for short global or static data items. This is on by default if
7039optimization is selected.
7040
7041@item -mstats
7042@itemx -mno-stats
cd3bb277
JM
7043@opindex mstats
7044@opindex mno-stats
630d3d5a 7045For each non-inline function processed, the @option{-mstats} switch
74291a4b
MM
7046causes the compiler to emit one line to the standard error file to
7047print statistics about the program (number of registers saved, stack
7048size, etc.).
7049
7050@item -mmemcpy
7051@itemx -mno-memcpy
cd3bb277
JM
7052@opindex mmemcpy
7053@opindex mno-memcpy
630d3d5a 7054The @option{-mmemcpy} switch makes all block moves call the appropriate
74291a4b
MM
7055string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7056generating inline code.
7057
7058@item -mmips-tfile
7059@itemx -mno-mips-tfile
cd3bb277
JM
7060@opindex mmips-tfile
7061@opindex mno-mips-tfile
630d3d5a 7062The @option{-mno-mips-tfile} switch causes the compiler not
74291a4b
MM
7063postprocess the object file with the @file{mips-tfile} program,
7064after the MIPS assembler has generated it to add debug support. If
7065@file{mips-tfile} is not run, then no local variables will be
7066available to the debugger. In addition, @file{stage2} and
7067@file{stage3} objects will have the temporary file names passed to the
7068assembler embedded in the object file, which means the objects will
630d3d5a 7069not compare the same. The @option{-mno-mips-tfile} switch should only
74291a4b
MM
7070be used when there are bugs in the @file{mips-tfile} program that
7071prevents compilation.
7072
7073@item -msoft-float
cd3bb277 7074@opindex msoft-float
74291a4b 7075Generate output containing library calls for floating point.
161d7b59 7076@strong{Warning:} the requisite libraries are not part of GCC@.
74291a4b
MM
7077Normally the facilities of the machine's usual C compiler are used, but
7078this can't be done directly in cross-compilation. You must make your
7079own arrangements to provide suitable library functions for
7080cross-compilation.
7081
7082@item -mhard-float
cd3bb277 7083@opindex mhard-float
74291a4b
MM
7084Generate output containing floating point instructions. This is the
7085default if you use the unmodified sources.
7086
7087@item -mabicalls
7088@itemx -mno-abicalls
cd3bb277
JM
7089@opindex mabicalls
7090@opindex mno-abicalls
74291a4b
MM
7091Emit (or do not emit) the pseudo operations @samp{.abicalls},
7092@samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7093position independent code.
7094
7095@item -mlong-calls
7096@itemx -mno-long-calls
cd3bb277
JM
7097@opindex mlong-calls
7098@opindex mno-long-calls
74291a4b
MM
7099Do all calls with the @samp{JALR} instruction, which requires
7100loading up a function's address into a register before the call.
7101You need to use this switch, if you call outside of the current
7102512 megabyte segment to functions that are not through pointers.
7103
7104@item -mhalf-pic
7105@itemx -mno-half-pic
cd3bb277
JM
7106@opindex mhalf-pic
7107@opindex mno-half-pic
74291a4b
MM
7108Put pointers to extern references into the data section and load them
7109up, rather than put the references in the text section.
7110
7111@item -membedded-pic
7112@itemx -mno-embedded-pic
cd3bb277
JM
7113@opindex membedded-pic
7114@opindex mno-embedded-pic
69fa83cf
JW
7115Generate PIC code suitable for some embedded systems. All calls are
7116made using PC relative address, and all data is addressed using the $gp
7117register. No more than 65536 bytes of global data may be used. This
7118requires GNU as and GNU ld which do most of the work. This currently
161d7b59 7119only works on targets which use ECOFF; it does not work with ELF@.
74291a4b
MM
7120
7121@item -membedded-data
7122@itemx -mno-embedded-data
cd3bb277
JM
7123@opindex membedded-data
7124@opindex mno-embedded-data
74291a4b
MM
7125Allocate variables to the read-only data section first if possible, then
7126next in the small data section if possible, otherwise in data. This gives
7127slightly slower code than the default, but reduces the amount of RAM required
7128when executing, and thus may be preferred for some embedded systems.
7129
919509ce
DN
7130@item -muninit-const-in-rodata
7131@itemx -mno-uninit-const-in-rodata
cd3bb277
JM
7132@opindex muninit-const-in-rodata
7133@opindex mno-uninit-const-in-rodata
695ac33f 7134When used together with @option{-membedded-data}, it will always store uninitialized
919509ce 7135const variables in the read-only data section.
02f52e19 7136
74291a4b
MM
7137@item -msingle-float
7138@itemx -mdouble-float
cd3bb277
JM
7139@opindex msingle-float
7140@opindex mdouble-float
630d3d5a 7141The @option{-msingle-float} switch tells gcc to assume that the floating
74291a4b 7142point coprocessor only supports single precision operations, as on the
630d3d5a 7143@samp{r4650} chip. The @option{-mdouble-float} switch permits gcc to use
74291a4b
MM
7144double precision operations. This is the default.
7145
7146@item -mmad
7147@itemx -mno-mad
cd3bb277
JM
7148@opindex mmad
7149@opindex mno-mad
74291a4b
MM
7150Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7151as on the @samp{r4650} chip.
7152
7153@item -m4650
cd3bb277 7154@opindex m4650
630d3d5a
JM
7155Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7156@option{-mcpu=r4650}.
74291a4b 7157
8b9243df
JJ
7158@item -mips16
7159@itemx -mno-mips16
cd3bb277
JM
7160@opindex mips16
7161@opindex mno-mips16
8b9243df
JJ
7162Enable 16-bit instructions.
7163
7164@item -mentry
cd3bb277 7165@opindex mentry
8b9243df 7166Use the entry and exit pseudo ops. This option can only be used with
630d3d5a 7167@option{-mips16}.
8b9243df 7168
74291a4b 7169@item -EL
cd3bb277 7170@opindex EL
74291a4b
MM
7171Compile code for the processor in little endian mode.
7172The requisite libraries are assumed to exist.
7173
7174@item -EB
cd3bb277 7175@opindex EB
74291a4b
MM
7176Compile code for the processor in big endian mode.
7177The requisite libraries are assumed to exist.
7178
7179@item -G @var{num}
cd3bb277 7180@opindex G
74291a4b
MM
7181@cindex smaller data references (MIPS)
7182@cindex gp-relative references (MIPS)
7183Put global and static items less than or equal to @var{num} bytes into
7184the small data or bss sections instead of the normal data or bss
7185section. This allows the assembler to emit one word memory reference
7186instructions based on the global pointer (@var{gp} or @var{$28}),
7187instead of the normal two words used. By default, @var{num} is 8 when
7188the MIPS assembler is used, and 0 when the GNU assembler is used. The
630d3d5a
JM
7189@option{-G @var{num}} switch is also passed to the assembler and linker.
7190All modules should be compiled with the same @option{-G @var{num}}
74291a4b
MM
7191value.
7192
7193@item -nocpp
cd3bb277 7194@opindex nocpp
9ec36da5 7195Tell the MIPS assembler to not run its preprocessor over user
74291a4b 7196assembler files (with a @samp{.s} suffix) when assembling them.
63357d93 7197
1e387156 7198@item -mfix7000
cd3bb277 7199@opindex mfix7000
1e387156
CM
7200Pass an option to gas which will cause nops to be inserted if
7201the read of the destination register of an mfhi or mflo instruction
7202occurs in the following two instructions.
7203
63357d93 7204@item -no-crt0
cd3bb277 7205@opindex no-crt0
63357d93 7206Do not include the default crt0.
d490e8ad
DD
7207
7208@item -mflush-func=@var{func}
7209@itemx -mno-flush-func
7210@opindex mflush-func
7211Specifies the function to call to flush the I and D caches, or to not
7212call any such function. If called, the function must take the same
7213arguments as the common @code{_flush_func()}, that is, the address of the
7214memory range for which the cache is being flushed, the size of the
7215memory range, and the number 3 (to flush both caches). The default
7216depends on the target gcc was configured for, but commonly is either
7217@samp{_flush_func} or @samp{__cpu_flush}.
74291a4b
MM
7218@end table
7219
74291a4b
MM
7220These options are defined by the macro
7221@code{TARGET_SWITCHES} in the machine description. The default for the
7222options is also defined by that macro, which enables you to change the
7223defaults.
74291a4b 7224
14f73b5a
JH
7225@node i386 and x86-64 Options
7226@subsection Intel 386 and AMD x86-64 Options
74291a4b 7227@cindex i386 Options
14f73b5a 7228@cindex x86-64 Options
74291a4b 7229@cindex Intel 386 Options
14f73b5a 7230@cindex AMD x86-64 Options
74291a4b 7231
14f73b5a
JH
7232These @samp{-m} options are defined for the i386 and x86-64 family of
7233computers:
74291a4b 7234
2642624b 7235@table @gcctabopt
630d3d5a 7236@item -mcpu=@var{cpu-type}
cd3bb277 7237@opindex mcpu
0dd0e980
JH
7238Tune to @var{cpu-type} everything applicable about the generated code, except
7239for the ABI and the set of available instructions. The choices for
7240@var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7241@samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7242@samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7243@samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp}
7244and @samp{athlon-mp}.
6f670fde 7245
630d3d5a 7246While picking a specific @var{cpu-type} will schedule things appropriately
6f670fde 7247for that particular chip, the compiler will not generate any code that
630d3d5a 7248does not run on the i386 without the @option{-march=@var{cpu-type}} option
7001ee2d 7249being used. @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6ca3ad1b 7250is equivalent to @samp{pentiumpro}. @samp{k6} and @samp{athlon} are the
b4e89e2d 7251AMD chips as opposed to the Intel ones.
a9f3e1a4 7252
630d3d5a 7253@item -march=@var{cpu-type}
cd3bb277 7254@opindex march
630d3d5a
JM
7255Generate instructions for the machine type @var{cpu-type}. The choices
7256for @var{cpu-type} are the same as for @option{-mcpu}. Moreover,
7257specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
a9f3e1a4
JL
7258
7259@item -m386
7260@itemx -m486
7261@itemx -mpentium
7262@itemx -mpentiumpro
cd3bb277
JM
7263@opindex m386
7264@opindex m486
7265@opindex mpentium
7266@opindex mpentiumpro
9c34dbbf
ZW
7267These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7268@option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7269These synonyms are deprecated.
74291a4b 7270
965f5423
JH
7271@item -mfpmath=@var{unit}
7272@opindex march
7273generate floating point arithmetics for selected unit @var{unit}. the choices
7274for @var{unit} are:
7275
7276@table @samp
7277@item 387
7278Use the standard 387 floating point coprocessor present majority of chips and
7279emulated otherwise. Code compiled with this option will run almost everywhere.
7280The temporary results are computed in 80bit precesion instead of precision
7281specified by the type resulting in slightly different results compared to most
7282of other chips. See @option{-ffloat-store} for more detailed description.
7283
7284This is the default choice for i386 compiler.
7285
7286@item sse
7287Use scalar floating point instructions present in the SSE instruction set.
7288This instruction set is supported by Pentium3 and newer chips, in the AMD line
7289by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
7290instruction set supports only single precision arithmetics, thus the double and
7291extended precision arithmetics is still done using 387. Later version, present
7292only in Pentium4 and the future AMD x86-64 chips supports double precision
7293arithmetics too.
7294
7295For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7296@option{-msse2} switches to enable SSE extensions and make this option
7297effective. For x86-64 compiler, these extensions are enabled by default.
7298
7299The resulting code should be considerably faster in majority of cases and avoid
7300the numerical instability problems of 387 code, but may break some existing
7301code that expects temporaries to be 80bit.
7302
7303This is the default choice for x86-64 compiler.
7304
7305@item sse,387
7306Attempt to utilize both instruction sets at once. This effectivly double the
7307amount of available registers and on chips with separate execution units for
7308387 and SSE the execution resources too. Use this option with care, as it is
7309still experimental, because gcc register allocator does not model separate
7310functional units well resulting in instable performance.
7311@end table
7312
c93e80a5
JH
7313@item -masm=@var{dialect}
7314@opindex masm=@var{dialect}
7315Output asm instructions using selected @var{dialect}. Supported choices are
7316@samp{intel} or @samp{att} (the default one).
04e149ab 7317
74291a4b
MM
7318@item -mieee-fp
7319@itemx -mno-ieee-fp
cd3bb277
JM
7320@opindex mieee-fp
7321@opindex mno-ieee-fp
74291a4b
MM
7322Control whether or not the compiler uses IEEE floating point
7323comparisons. These handle correctly the case where the result of a
7324comparison is unordered.
7325
7326@item -msoft-float
cd3bb277 7327@opindex msoft-float
74291a4b 7328Generate output containing library calls for floating point.
161d7b59 7329@strong{Warning:} the requisite libraries are not part of GCC@.
74291a4b
MM
7330Normally the facilities of the machine's usual C compiler are used, but
7331this can't be done directly in cross-compilation. You must make your
7332own arrangements to provide suitable library functions for
7333cross-compilation.
7334
7335On machines where a function returns floating point results in the 80387
7336register stack, some floating point opcodes may be emitted even if
630d3d5a 7337@option{-msoft-float} is used.
74291a4b
MM
7338
7339@item -mno-fp-ret-in-387
cd3bb277 7340@opindex mno-fp-ret-in-387
74291a4b
MM
7341Do not use the FPU registers for return values of functions.
7342
7343The usual calling convention has functions return values of types
7344@code{float} and @code{double} in an FPU register, even if there
161d7b59
JM
7345is no FPU@. The idea is that the operating system should emulate
7346an FPU@.
74291a4b 7347
630d3d5a 7348The option @option{-mno-fp-ret-in-387} causes such values to be returned
74291a4b
MM
7349in ordinary CPU registers instead.
7350
7351@item -mno-fancy-math-387
cd3bb277 7352@opindex mno-fancy-math-387
74291a4b
MM
7353Some 387 emulators do not support the @code{sin}, @code{cos} and
7354@code{sqrt} instructions for the 387. Specify this option to avoid
161d7b59 7355generating those instructions. This option is the default on FreeBSD@.
74291a4b 7356As of revision 2.6.1, these instructions are not generated unless you
630d3d5a 7357also use the @option{-funsafe-math-optimizations} switch.
74291a4b
MM
7358
7359@item -malign-double
7360@itemx -mno-align-double
cd3bb277
JM
7361@opindex malign-double
7362@opindex mno-align-double
0c2d1a2a 7363Control whether GCC aligns @code{double}, @code{long double}, and
74291a4b
MM
7364@code{long long} variables on a two word boundary or a one word
7365boundary. Aligning @code{double} variables on a two word boundary will
7366produce code that runs somewhat faster on a @samp{Pentium} at the
7367expense of more memory.
7368
2b589241 7369@item -m128bit-long-double
cd3bb277 7370@opindex m128bit-long-double
2b589241
JH
7371Control the size of @code{long double} type. i386 application binary interface
7372specify the size to be 12 bytes, while modern architectures (Pentium and newer)
c771326b 7373prefer @code{long double} aligned to 8 or 16 byte boundary. This is
2b589241
JH
7374impossible to reach with 12 byte long doubles in the array accesses.
7375
630d3d5a 7376@strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
2b589241
JH
7377structures and arrays containing @code{long double} will change their size as
7378well as function calling convention for function taking @code{long double}
02f52e19 7379will be modified.
2b589241
JH
7380
7381@item -m96bit-long-double
cd3bb277 7382@opindex m96bit-long-double
0a75e5c3 7383Set the size of @code{long double} to 96 bits as required by the i386
2b589241 7384application binary interface. This is the default.
74291a4b
MM
7385
7386@item -msvr3-shlib
7387@itemx -mno-svr3-shlib
cd3bb277
JM
7388@opindex msvr3-shlib
7389@opindex mno-svr3-shlib
9c34dbbf
ZW
7390Control whether GCC places uninitialized local variables into the
7391@code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
7392into @code{bss}. These options are meaningful only on System V Release 3.
74291a4b 7393
74291a4b 7394@item -mrtd
cd3bb277 7395@opindex mrtd
74291a4b
MM
7396Use a different function-calling convention, in which functions that
7397take a fixed number of arguments return with the @code{ret} @var{num}
7398instruction, which pops their arguments while returning. This saves one
7399instruction in the caller since there is no need to pop the arguments
7400there.
7401
7402You can specify that an individual function is called with this calling
7403sequence with the function attribute @samp{stdcall}. You can also
630d3d5a 7404override the @option{-mrtd} option by using the function attribute
0b433de6 7405@samp{cdecl}. @xref{Function Attributes}.
74291a4b
MM
7406
7407@strong{Warning:} this calling convention is incompatible with the one
7408normally used on Unix, so you cannot use it if you need to call
7409libraries compiled with the Unix compiler.
7410
7411Also, you must provide function prototypes for all functions that
7412take variable numbers of arguments (including @code{printf});
7413otherwise incorrect code will be generated for calls to those
7414functions.
7415
7416In addition, seriously incorrect code will result if you call a
7417function with too many arguments. (Normally, extra arguments are
7418harmlessly ignored.)
7419
74291a4b 7420@item -mregparm=@var{num}
cd3bb277 7421@opindex mregparm
74291a4b
MM
7422Control how many registers are used to pass integer arguments. By
7423default, no registers are used to pass arguments, and at most 3
7424registers can be used. You can control this behavior for a specific
0b433de6
JL
7425function by using the function attribute @samp{regparm}.
7426@xref{Function Attributes}.
74291a4b
MM
7427
7428@strong{Warning:} if you use this switch, and
7429@var{num} is nonzero, then you must build all modules with the same
7430value, including any libraries. This includes the system libraries and
7431startup modules.
7432
3af4bd89 7433@item -mpreferred-stack-boundary=@var{num}
cd3bb277 7434@opindex mpreferred-stack-boundary
3af4bd89 7435Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
630d3d5a 7436byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
fbb83b43
AO
7437the default is 4 (16 bytes or 128 bits), except when optimizing for code
7438size (@option{-Os}), in which case the default is the minimum correct
7439alignment (4 bytes for x86, and 8 bytes for x86-64).
3af4bd89 7440
fbb83b43
AO
7441On Pentium and PentiumPro, @code{double} and @code{long double} values
7442should be aligned to an 8 byte boundary (see @option{-malign-double}) or
7443suffer significant run time performance penalties. On Pentium III, the
b192711e 7444Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
3af4bd89
JH
7445penalties if it is not 16 byte aligned.
7446
7447To ensure proper alignment of this values on the stack, the stack boundary
02f52e19 7448must be as aligned as that required by any value stored on the stack.
3af4bd89
JH
7449Further, every function must be generated such that it keeps the stack
7450aligned. Thus calling a function compiled with a higher preferred
7451stack boundary from a function compiled with a lower preferred stack
7452boundary will most likely misalign the stack. It is recommended that
7453libraries that use callbacks always use the default setting.
7454
fbb83b43
AO
7455This extra alignment does consume extra stack space, and generally
7456increases code size. Code that is sensitive to stack space usage, such
7457as embedded systems and operating system kernels, may want to reduce the
7458preferred alignment to @option{-mpreferred-stack-boundary=2}.
f22a97d2 7459
1255c85c
BS
7460@item -mmmx
7461@itemx -mno-mmx
7462@item -msse
7463@itemx -mno-sse
965f5423
JH
7464@item -msse2
7465@itemx -mno-sse2
1255c85c
BS
7466@item -m3dnow
7467@itemx -mno-3dnow
7468@opindex mmmx
7469@opindex mno-mmx
7470@opindex msse
7471@opindex mno-sse
7472@opindex m3dnow
7473@opindex mno-3dnow
7474These switches enable or disable the use of built-in functions that allow
7475direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
7476
0975678f
JM
7477@xref{X86 Built-in Functions}, for details of the functions enabled
7478and disabled by these switches.
1255c85c 7479
f73ad30e 7480@item -mpush-args
a7939b1d 7481@itemx -mno-push-args
cd3bb277 7482@opindex mpush-args
a7939b1d 7483@opindex mno-push-args
767094dd 7484Use PUSH operations to store outgoing parameters. This method is shorter
f73ad30e 7485and usually equally fast as method using SUB/MOV operations and is enabled
767094dd 7486by default. In some cases disabling it may improve performance because of
f73ad30e
JH
7487improved scheduling and reduced dependencies.
7488
7489@item -maccumulate-outgoing-args
cd3bb277 7490@opindex maccumulate-outgoing-args
f73ad30e 7491If enabled, the maximum amount of space required for outgoing arguments will be
a7939b1d 7492computed in the function prologue. This is faster on most modern CPUs
b192711e 7493because of reduced dependencies, improved scheduling and reduced stack usage
f73ad30e 7494when preferred stack boundary is not equal to 2. The drawback is a notable
767094dd 7495increase in code size. This switch implies @option{-mno-push-args}.
f73ad30e 7496
f22a97d2 7497@item -mthreads
cd3bb277 7498@opindex mthreads
767094dd 7499Support thread-safe exception handling on @samp{Mingw32}. Code that relies
02f52e19 7500on thread-safe exception handling must compile and link all code with the
767094dd 7501@option{-mthreads} option. When compiling, @option{-mthreads} defines
630d3d5a
JM
7502@option{-D_MT}; when linking, it links in a special thread helper library
7503@option{-lmingwthrd} which cleans up per thread exception handling data.
79f05c19
JH
7504
7505@item -mno-align-stringops
cd3bb277 7506@opindex mno-align-stringops
767094dd 7507Do not align destination of inlined string operations. This switch reduces
79f05c19
JH
7508code size and improves performance in case the destination is already aligned,
7509but gcc don't know about it.
7510
7511@item -minline-all-stringops
cd3bb277 7512@opindex minline-all-stringops
79f05c19 7513By default GCC inlines string operations only when destination is known to be
767094dd 7514aligned at least to 4 byte boundary. This enables more inlining, increase code
79f05c19
JH
7515size, but may improve performance of code that depends on fast memcpy, strlen
7516and memset for short lengths.
762e166b
AJ
7517
7518@item -momit-leaf-frame-pointer
cd3bb277 7519@opindex momit-leaf-frame-pointer
762e166b
AJ
7520Don't keep the frame pointer in a register for leaf functions. This
7521avoids the instructions to save, set up and restore frame pointers and
7522makes an extra register available in leaf functions. The option
630d3d5a 7523@option{-fomit-frame-pointer} removes the frame pointer for all functions
762e166b 7524which might make debugging harder.
3af4bd89
JH
7525@end table
7526
14f73b5a
JH
7527These @samp{-m} switches are supported in addition to the above
7528on AMD x86-64 processors in 64-bit environments.
7529
7530@table @gcctabopt
7531@item -m32
7532@itemx -m64
7533@opindex m32
7534@opindex m64
7535Generate code for a 32-bit or 64-bit environment.
7536The 32-bit environment sets int, long and pointer to 32 bits and
7537generates code that runs on any i386 system.
7538The 64-bit environment sets int to 32 bits and long and pointer
7539to 64 bits and generates code for AMD's x86-64 architecture.
7540
7541@item -mno-red-zone
7542@opindex no-red-zone
7543Do not use a so called red zone for x86-64 code. The red zone is mandated
7544by the x86-64 ABI, it is a 128-byte area beyond the location of the
7545stack pointer that will not be modified by signal or interrupt handlers
7546and therefore can be used for temporary data without adjusting the stack
7547pointer. The flag @option{-mno-red-zone} disables this red zone.
7548@end table
7549
74291a4b
MM
7550@node HPPA Options
7551@subsection HPPA Options
7552@cindex HPPA Options
7553
7554These @samp{-m} options are defined for the HPPA family of computers:
7555
2642624b 7556@table @gcctabopt
630d3d5a 7557@item -march=@var{architecture-type}
cd3bb277 7558@opindex march
ea3bfbfe 7559Generate code for the specified architecture. The choices for
630d3d5a 7560@var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
ea3bfbfe
JQ
75611.1, and @samp{2.0} for PA 2.0 processors. Refer to
7562@file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7563architecture option for your machine. Code compiled for lower numbered
7564architectures will run on higher numbered architectures, but not the
7565other way around.
7566
7567PA 2.0 support currently requires gas snapshot 19990413 or later. The
7568next release of binutils (current is 2.9.1) will probably contain PA 2.0
02f52e19 7569support.
74291a4b 7570
ea3bfbfe 7571@item -mpa-risc-1-0
62a1403d
AS
7572@itemx -mpa-risc-1-1
7573@itemx -mpa-risc-2-0
cd3bb277
JM
7574@opindex mpa-risc-1-0
7575@opindex mpa-risc-1-1
7576@opindex mpa-risc-2-0
695ac33f 7577Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
74291a4b 7578
861bb6c1 7579@item -mbig-switch
cd3bb277 7580@opindex mbig-switch
861bb6c1
JL
7581Generate code suitable for big switch tables. Use this option only if
7582the assembler/linker complain about out of range branches within a switch
7583table.
7584
74291a4b 7585@item -mjump-in-delay
cd3bb277 7586@opindex mjump-in-delay
74291a4b
MM
7587Fill delay slots of function calls with unconditional jump instructions
7588by modifying the return pointer for the function call to be the target
7589of the conditional jump.
7590
7591@item -mdisable-fpregs
cd3bb277 7592@opindex mdisable-fpregs
74291a4b
MM
7593Prevent floating point registers from being used in any manner. This is
7594necessary for compiling kernels which perform lazy context switching of
7595floating point registers. If you use this option and attempt to perform
7596floating point operations, the compiler will abort.
7597
7598@item -mdisable-indexing
cd3bb277 7599@opindex mdisable-indexing
74291a4b 7600Prevent the compiler from using indexing address modes. This avoids some
161d7b59 7601rather obscure problems when compiling MIG generated code under MACH@.
74291a4b
MM
7602
7603@item -mno-space-regs
cd3bb277 7604@opindex mno-space-regs
74291a4b
MM
7605Generate code that assumes the target has no space registers. This allows
7606GCC to generate faster indirect calls and use unscaled index address modes.
7607
7608Such code is suitable for level 0 PA systems and kernels.
7609
7610@item -mfast-indirect-calls
cd3bb277 7611@opindex mfast-indirect-calls
74291a4b
MM
7612Generate code that assumes calls never cross space boundaries. This
7613allows GCC to emit code which performs faster indirect calls.
7614
b192711e 7615This option will not work in the presence of shared libraries or nested
74291a4b
MM
7616functions.
7617
74291a4b 7618@item -mlong-load-store
cd3bb277 7619@opindex mlong-load-store
74291a4b
MM
7620Generate 3-instruction load and store sequences as sometimes required by
7621the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
7622the HP compilers.
7623
7624@item -mportable-runtime
cd3bb277 7625@opindex mportable-runtime
74291a4b
MM
7626Use the portable calling conventions proposed by HP for ELF systems.
7627
7628@item -mgas
cd3bb277 7629@opindex mgas
74291a4b
MM
7630Enable the use of assembler directives only GAS understands.
7631
630d3d5a 7632@item -mschedule=@var{cpu-type}
cd3bb277 7633@opindex mschedule
74291a4b 7634Schedule code according to the constraints for the machine type
630d3d5a 7635@var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
02f52e19 7636@samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}. Refer to
732135bf
JL
7637@file{/usr/lib/sched.models} on an HP-UX system to determine the
7638proper scheduling option for your machine.
74291a4b
MM
7639
7640@item -mlinker-opt
cd3bb277 7641@opindex mlinker-opt
74291a4b
MM
7642Enable the optimization pass in the HPUX linker. Note this makes symbolic
7643debugging impossible. It also triggers a bug in the HPUX 8 and HPUX 9 linkers
7644in which they give bogus error messages when linking some programs.
7645
7646@item -msoft-float
cd3bb277 7647@opindex msoft-float
74291a4b
MM
7648Generate output containing library calls for floating point.
7649@strong{Warning:} the requisite libraries are not available for all HPPA
7650targets. Normally the facilities of the machine's usual C compiler are
7651used, but this cannot be done directly in cross-compilation. You must make
7652your own arrangements to provide suitable library functions for
7653cross-compilation. The embedded target @samp{hppa1.1-*-pro}
7654does provide software floating point support.
7655
630d3d5a 7656@option{-msoft-float} changes the calling convention in the output file;
74291a4b
MM
7657therefore, it is only useful if you compile @emph{all} of a program with
7658this option. In particular, you need to compile @file{libgcc.a}, the
630d3d5a 7659library that comes with GCC, with @option{-msoft-float} in order for
74291a4b
MM
7660this to work.
7661@end table
7662
7663@node Intel 960 Options
7664@subsection Intel 960 Options
7665
7666These @samp{-m} options are defined for the Intel 960 implementations:
7667
2642624b 7668@table @gcctabopt
cd3bb277
JM
7669@item -m@var{cpu-type}
7670@opindex mka
7671@opindex mkb
7672@opindex mmc
7673@opindex mca
7674@opindex mcf
7675@opindex msa
7676@opindex msb
7677Assume the defaults for the machine type @var{cpu-type} for some of
74291a4b 7678the other options, including instruction scheduling, floating point
cd3bb277 7679support, and addressing modes. The choices for @var{cpu-type} are
74291a4b
MM
7680@samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
7681@samp{sa}, and @samp{sb}.
7682The default is
7683@samp{kb}.
7684
7685@item -mnumerics
7686@itemx -msoft-float
cd3bb277
JM
7687@opindex mnumerics
7688@opindex msoft-float
630d3d5a
JM
7689The @option{-mnumerics} option indicates that the processor does support
7690floating-point instructions. The @option{-msoft-float} option indicates
74291a4b
MM
7691that floating-point support should not be assumed.
7692
7693@item -mleaf-procedures
7694@itemx -mno-leaf-procedures
cd3bb277
JM
7695@opindex mleaf-procedures
7696@opindex mno-leaf-procedures
74291a4b
MM
7697Do (or do not) attempt to alter leaf procedures to be callable with the
7698@code{bal} instruction as well as @code{call}. This will result in more
7699efficient code for explicit calls when the @code{bal} instruction can be
7700substituted by the assembler or linker, but less efficient code in other
7701cases, such as calls via function pointers, or using a linker that doesn't
7702support this optimization.
7703
7704@item -mtail-call
7705@itemx -mno-tail-call
cd3bb277
JM
7706@opindex mtail-call
7707@opindex mno-tail-call
74291a4b
MM
7708Do (or do not) make additional attempts (beyond those of the
7709machine-independent portions of the compiler) to optimize tail-recursive
7710calls into branches. You may not want to do this because the detection of
7711cases where this is not valid is not totally complete. The default is
630d3d5a 7712@option{-mno-tail-call}.
74291a4b
MM
7713
7714@item -mcomplex-addr
7715@itemx -mno-complex-addr
cd3bb277
JM
7716@opindex mcomplex-addr
7717@opindex mno-complex-addr
74291a4b
MM
7718Assume (or do not assume) that the use of a complex addressing mode is a
7719win on this implementation of the i960. Complex addressing modes may not
7720be worthwhile on the K-series, but they definitely are on the C-series.
630d3d5a 7721The default is currently @option{-mcomplex-addr} for all processors except
161d7b59 7722the CB and CC@.
74291a4b
MM
7723
7724@item -mcode-align
7725@itemx -mno-code-align
cd3bb277
JM
7726@opindex mcode-align
7727@opindex mno-code-align
74291a4b
MM
7728Align code to 8-byte boundaries for faster fetching (or don't bother).
7729Currently turned on by default for C-series implementations only.
7730
7731@ignore
7732@item -mclean-linkage
7733@itemx -mno-clean-linkage
cd3bb277
JM
7734@opindex mclean-linkage
7735@opindex mno-clean-linkage
74291a4b
MM
7736These options are not fully implemented.
7737@end ignore
7738
7739@item -mic-compat
7740@itemx -mic2.0-compat
7741@itemx -mic3.0-compat
cd3bb277
JM
7742@opindex mic-compat
7743@opindex mic2.0-compat
7744@opindex mic3.0-compat
74291a4b
MM
7745Enable compatibility with iC960 v2.0 or v3.0.
7746
7747@item -masm-compat
7748@itemx -mintel-asm
cd3bb277
JM
7749@opindex masm-compat
7750@opindex mintel-asm
74291a4b
MM
7751Enable compatibility with the iC960 assembler.
7752
7753@item -mstrict-align
7754@itemx -mno-strict-align
cd3bb277
JM
7755@opindex mstrict-align
7756@opindex mno-strict-align
74291a4b
MM
7757Do not permit (do permit) unaligned accesses.
7758
7759@item -mold-align
cd3bb277 7760@opindex mold-align
74291a4b 7761Enable structure-alignment compatibility with Intel's gcc release version
630d3d5a 77621.3 (based on gcc 1.37). This option implies @option{-mstrict-align}.
eaa4b44c
VM
7763
7764@item -mlong-double-64
cd3bb277 7765@opindex mlong-double-64
eaa4b44c
VM
7766Implement type @samp{long double} as 64-bit floating point numbers.
7767Without the option @samp{long double} is implemented by 80-bit
7768floating point numbers. The only reason we have it because there is
7769no 128-bit @samp{long double} support in @samp{fp-bit.c} yet. So it
7770is only useful for people using soft-float targets. Otherwise, we
7771should recommend against use of it.
7772
74291a4b
MM
7773@end table
7774
7775@node DEC Alpha Options
7776@subsection DEC Alpha Options
7777
7778These @samp{-m} options are defined for the DEC Alpha implementations:
7779
2642624b 7780@table @gcctabopt
74291a4b
MM
7781@item -mno-soft-float
7782@itemx -msoft-float
cd3bb277
JM
7783@opindex mno-soft-float
7784@opindex msoft-float
74291a4b 7785Use (do not use) the hardware floating-point instructions for
bedc7537 7786floating-point operations. When @option{-msoft-float} is specified,
7857f134 7787functions in @file{libgcc.a} will be used to perform floating-point
74291a4b
MM
7788operations. Unless they are replaced by routines that emulate the
7789floating-point operations, or compiled in such a way as to call such
7790emulations routines, these routines will issue floating-point
7791operations. If you are compiling for an Alpha without floating-point
7792operations, you must ensure that the library is built so as not to call
7793them.
7794
7795Note that Alpha implementations without floating-point operations are
7796required to have floating-point registers.
7797
7798@item -mfp-reg
7799@itemx -mno-fp-regs
cd3bb277
JM
7800@opindex mfp-reg
7801@opindex mno-fp-regs
74291a4b 7802Generate code that uses (does not use) the floating-point register set.
bedc7537 7803@option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
74291a4b
MM
7804register set is not used, floating point operands are passed in integer
7805registers as if they were integers and floating-point results are passed
58605ba0
RH
7806in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
7807so any function with a floating-point argument or return value called by code
bedc7537 7808compiled with @option{-mno-fp-regs} must also be compiled with that
74291a4b
MM
7809option.
7810
7811A typical use of this option is building a kernel that does not use,
7812and hence need not save and restore, any floating-point registers.
7813
7814@item -mieee
cd3bb277 7815@opindex mieee
74291a4b
MM
7816The Alpha architecture implements floating-point hardware optimized for
7817maximum performance. It is mostly compliant with the IEEE floating
7818point standard. However, for full compliance, software assistance is
7819required. This option generates code fully IEEE compliant code
630d3d5a 7820@emph{except} that the @var{inexact-flag} is not maintained (see below).
9c34dbbf
ZW
7821If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7822defined during compilation. The resulting code is less efficient but is
7823able to correctly support denormalized numbers and exceptional IEEE
7824values such as not-a-number and plus/minus infinity. Other Alpha
7825compilers call this option @option{-ieee_with_no_inexact}.
74291a4b
MM
7826
7827@item -mieee-with-inexact
cd3bb277 7828@opindex mieee-with-inexact
9c34dbbf
ZW
7829This is like @option{-mieee} except the generated code also maintains
7830the IEEE @var{inexact-flag}. Turning on this option causes the
7831generated code to implement fully-compliant IEEE math. In addition to
7832@code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7833macro. On some Alpha implementations the resulting code may execute
7834significantly slower than the code generated by default. Since there is
7835very little code that depends on the @var{inexact-flag}, you should
74291a4b 7836normally not specify this option. Other Alpha compilers call this
630d3d5a 7837option @option{-ieee_with_inexact}.
74291a4b 7838
630d3d5a 7839@item -mfp-trap-mode=@var{trap-mode}
cd3bb277 7840@opindex mfp-trap-mode
74291a4b 7841This option controls what floating-point related traps are enabled.
630d3d5a 7842Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
74291a4b
MM
7843The trap mode can be set to one of four values:
7844
7845@table @samp
7846@item n
7847This is the default (normal) setting. The only traps that are enabled
7848are the ones that cannot be disabled in software (e.g., division by zero
7849trap).
7850
7851@item u
7852In addition to the traps enabled by @samp{n}, underflow traps are enabled
7853as well.
7854
7855@item su
7856Like @samp{su}, but the instructions are marked to be safe for software
7857completion (see Alpha architecture manual for details).
7858
7859@item sui
7860Like @samp{su}, but inexact traps are enabled as well.
7861@end table
7862
630d3d5a 7863@item -mfp-rounding-mode=@var{rounding-mode}
cd3bb277 7864@opindex mfp-rounding-mode
74291a4b 7865Selects the IEEE rounding mode. Other Alpha compilers call this option
630d3d5a 7866@option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
74291a4b
MM
7867of:
7868
7869@table @samp
7870@item n
7871Normal IEEE rounding mode. Floating point numbers are rounded towards
7872the nearest machine number or towards the even machine number in case
7873of a tie.
7874
7875@item m
7876Round towards minus infinity.
7877
7878@item c
7879Chopped rounding mode. Floating point numbers are rounded towards zero.
7880
7881@item d
7882Dynamic rounding mode. A field in the floating point control register
7883(@var{fpcr}, see Alpha architecture reference manual) controls the
7884rounding mode in effect. The C library initializes this register for
7885rounding towards plus infinity. Thus, unless your program modifies the
ec4b2ecb
CB
7886@var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7887@end table
74291a4b 7888
630d3d5a 7889@item -mtrap-precision=@var{trap-precision}
cd3bb277 7890@opindex mtrap-precision
74291a4b
MM
7891In the Alpha architecture, floating point traps are imprecise. This
7892means without software assistance it is impossible to recover from a
7893floating trap and program execution normally needs to be terminated.
0c2d1a2a 7894GCC can generate code that can assist operating system trap handlers
74291a4b
MM
7895in determining the exact location that caused a floating point trap.
7896Depending on the requirements of an application, different levels of
7897precisions can be selected:
7898
7899@table @samp
7900@item p
7901Program precision. This option is the default and means a trap handler
7902can only identify which program caused a floating point exception.
7903
7904@item f
7905Function precision. The trap handler can determine the function that
7906caused a floating point exception.
7907
7908@item i
7909Instruction precision. The trap handler can determine the exact
7910instruction that caused a floating point exception.
7911@end table
7912
7913Other Alpha compilers provide the equivalent options called
630d3d5a 7914@option{-scope_safe} and @option{-resumption_safe}.
74291a4b
MM
7915
7916@item -mieee-conformant
cd3bb277 7917@opindex mieee-conformant
74291a4b 7918This option marks the generated code as IEEE conformant. You must not
630d3d5a
JM
7919use this option unless you also specify @option{-mtrap-precision=i} and either
7920@option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
74291a4b
MM
7921is to emit the line @samp{.eflag 48} in the function prologue of the
7922generated assembly file. Under DEC Unix, this has the effect that
7923IEEE-conformant math library routines will be linked in.
7924
7925@item -mbuild-constants
cd3bb277 7926@opindex mbuild-constants
0c2d1a2a 7927Normally GCC examines a 32- or 64-bit integer constant to
74291a4b
MM
7928see if it can construct it from smaller constants in two or three
7929instructions. If it cannot, it will output the constant as a literal and
956d6950 7930generate code to load it from the data segment at runtime.
74291a4b 7931
0c2d1a2a 7932Use this option to require GCC to construct @emph{all} integer constants
74291a4b
MM
7933using code, even if it takes more instructions (the maximum is six).
7934
7935You would typically use this option to build a shared library dynamic
7936loader. Itself a shared library, it must relocate itself in memory
7937before it can find the variables and constants in its own data segment.
956d6950
JL
7938
7939@item -malpha-as
7940@itemx -mgas
cd3bb277
JM
7941@opindex malpha-as
7942@opindex mgas
956d6950 7943Select whether to generate code to be assembled by the vendor-supplied
630d3d5a 7944assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
956d6950
JL
7945
7946@item -mbwx
7947@itemx -mno-bwx
7948@itemx -mcix
7949@itemx -mno-cix
58605ba0
RH
7950@itemx -mfix
7951@itemx -mno-fix
956d6950
JL
7952@itemx -mmax
7953@itemx -mno-max
cd3bb277
JM
7954@opindex mbwx
7955@opindex mno-bwx
7956@opindex mcix
7957@opindex mno-cix
58605ba0
RH
7958@opindex mfix
7959@opindex mno-fix
cd3bb277
JM
7960@opindex mmax
7961@opindex mno-max
0c2d1a2a 7962Indicate whether GCC should generate code to use the optional BWX,
58605ba0
RH
7963CIX, FIX and MAX instruction sets. The default is to use the instruction
7964sets supported by the CPU type specified via @option{-mcpu=} option or that
0c2d1a2a 7965of the CPU on which GCC was built if none was specified.
956d6950 7966
58605ba0
RH
7967@item -mfloat-vax
7968@itemx -mfloat-ieee
7969@opindex mfloat-vax
7970@opindex mfloat-ieee
7971Generate code that uses (does not use) VAX F and G floating point
7972arithmetic instead of IEEE single and double precision.
7973
7974@item -mexplicit-relocs
7975@itemx -mno-explicit-relocs
7976@opindex mexplicit-relocs
7977@opindex mno-explicit-relocs
7978Older Alpha assemblers provided no way to generate symbol relocations
f282ffb3 7979except via assembler macros. Use of these macros does not allow
58605ba0
RH
7980optimial instruction scheduling. GNU binutils as of version 2.12
7981supports a new syntax that allows the compiler to explicitly mark
7982which relocations should apply to which instructions. This option
7983is mostly useful for debugging, as GCC detects the capabilities of
7984the assembler when it is built and sets the default accordingly.
7985
7986@item -msmall-data
7987@itemx -mlarge-data
7988@opindex msmall-data
7989@opindex mlarge-data
f282ffb3 7990When @option{-mexplicit-relocs} is in effect, static data is
58605ba0
RH
7991accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
7992is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7993(the @code{.sdata} and @code{.sbss} sections) and are accessed via
799416-bit relocations off of the @code{$gp} register. This limits the
7995size of the small data area to 64KB, but allows the variables to be
7996directly accessed via a single instruction.
7997
7998The default is @option{-mlarge-data}. With this option the data area
7999is limited to just below 2GB. Programs that require more than 2GB of
8000data must use @code{malloc} or @code{mmap} to allocate the data in the
8001heap instead of in the program's data segment.
8002
8003When generating code for shared libraries, @option{-fpic} implies
8004@option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8005
956d6950 8006@item -mcpu=@var{cpu_type}
cd3bb277 8007@opindex mcpu
58605ba0
RH
8008Set the instruction set and instruction scheduling parameters for
8009machine type @var{cpu_type}. You can specify either the @samp{EV}
8010style name or the corresponding chip number. GCC supports scheduling
8011parameters for the EV4, EV5 and EV6 family of processors and will
8012choose the default values for the instruction set from the processor
8013you specify. If you do not specify a processor type, GCC will default
8014to the processor on which the compiler was built.
956d6950
JL
8015
8016Supported values for @var{cpu_type} are
8017
8018@table @samp
8019@item ev4
58605ba0 8020@item ev45
956d6950
JL
8021@itemx 21064
8022Schedules as an EV4 and has no instruction set extensions.
8023
8024@item ev5
8025@itemx 21164
8026Schedules as an EV5 and has no instruction set extensions.
8027
8028@item ev56
8029@itemx 21164a
8030Schedules as an EV5 and supports the BWX extension.
8031
8032@item pca56
4f69985c 8033@itemx 21164pc
956d6950
JL
8034@itemx 21164PC
8035Schedules as an EV5 and supports the BWX and MAX extensions.
8036
8037@item ev6
8038@itemx 21264
58605ba0
RH
8039Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8040
8041@item ev67
8042@item 21264a
8043Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
4f69985c
RH
8044@end table
8045
58605ba0
RH
8046@item -mtune=@var{cpu_type}
8047@opindex mtune
8048Set only the instruction scheduling parameters for machine type
8049@var{cpu_type}. The instruction set is not changed.
8050
4f69985c 8051@item -mmemory-latency=@var{time}
cd3bb277 8052@opindex mmemory-latency
4f69985c
RH
8053Sets the latency the scheduler should assume for typical memory
8054references as seen by the application. This number is highly
b192711e 8055dependent on the memory access patterns used by the application
4f69985c
RH
8056and the size of the external cache on the machine.
8057
8058Valid options for @var{time} are
8059
8060@table @samp
8061@item @var{number}
8062A decimal number representing clock cycles.
8063
8064@item L1
8065@itemx L2
8066@itemx L3
8067@itemx main
8068The compiler contains estimates of the number of clock cycles for
8069``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8070(also called Dcache, Scache, and Bcache), as well as to main memory.
8071Note that L3 is only valid for EV5.
8072
956d6950 8073@end table
74291a4b
MM
8074@end table
8075
d7c23cdc
DR
8076@node DEC Alpha/VMS Options
8077@subsection DEC Alpha/VMS Options
8078
8079These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8080
8081@table @gcctabopt
8082@item -mvms-return-codes
8083@opindex mvms-return-codes
bf6cfc5e
RK
8084Return VMS condition codes from main. The default is to return POSIX
8085style condition (e.g.@ error) codes.
d7c23cdc
DR
8086@end table
8087
74291a4b
MM
8088@node Clipper Options
8089@subsection Clipper Options
8090
8091These @samp{-m} options are defined for the Clipper implementations:
8092
2642624b 8093@table @gcctabopt
74291a4b 8094@item -mc300
cd3bb277 8095@opindex mc300
767094dd 8096Produce code for a C300 Clipper processor. This is the default.
74291a4b 8097
62a1403d 8098@item -mc400
cd3bb277 8099@opindex mc400
9c34dbbf
ZW
8100Produce code for a C400 Clipper processor, i.e.@: use floating point
8101registers f8--f15.
74291a4b
MM
8102@end table
8103
8104@node H8/300 Options
8105@subsection H8/300 Options
8106
8107These @samp{-m} options are defined for the H8/300 implementations:
8108
2642624b 8109@table @gcctabopt
74291a4b 8110@item -mrelax
cd3bb277 8111@opindex mrelax
74291a4b 8112Shorten some address references at link time, when possible; uses the
630d3d5a 8113linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
74291a4b
MM
8114ld.info, Using ld}, for a fuller description.
8115
8116@item -mh
cd3bb277 8117@opindex mh
161d7b59 8118Generate code for the H8/300H@.
74291a4b 8119
dcb9d1f0 8120@item -ms
cd3bb277 8121@opindex ms
161d7b59 8122Generate code for the H8/S@.
dcb9d1f0 8123
17f0f8fa 8124@item -ms2600
cd3bb277 8125@opindex ms2600
695ac33f 8126Generate code for the H8/S2600. This switch must be used with @option{-ms}.
17f0f8fa 8127
74291a4b 8128@item -mint32
cd3bb277 8129@opindex mint32
74291a4b
MM
8130Make @code{int} data 32 bits by default.
8131
8132@item -malign-300
cd3bb277 8133@opindex malign-300
2c54abce
KH
8134On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
8135The default for the H8/300H and H8/S is to align longs and floats on 4
8136byte boundaries.
630d3d5a 8137@option{-malign-300} causes them to be aligned on 2 byte boundaries.
2c54abce 8138This option has no effect on the H8/300.
74291a4b
MM
8139@end table
8140
8141@node SH Options
8142@subsection SH Options
8143
8144These @samp{-m} options are defined for the SH implementations:
8145
2642624b 8146@table @gcctabopt
74291a4b 8147@item -m1
cd3bb277 8148@opindex m1
74291a4b
MM
8149Generate code for the SH1.
8150
8151@item -m2
cd3bb277 8152@opindex m2
74291a4b
MM
8153Generate code for the SH2.
8154
8155@item -m3
cd3bb277 8156@opindex m3
74291a4b
MM
8157Generate code for the SH3.
8158
8159@item -m3e
cd3bb277 8160@opindex m3e
74291a4b
MM
8161Generate code for the SH3e.
8162
3cadd778 8163@item -m4-nofpu
cd3bb277 8164@opindex m4-nofpu
3cadd778
AO
8165Generate code for the SH4 without a floating-point unit.
8166
8167@item -m4-single-only
cd3bb277 8168@opindex m4-single-only
3cadd778 8169Generate code for the SH4 with a floating-point unit that only
c771326b 8170supports single-precision arithmetic.
3cadd778
AO
8171
8172@item -m4-single
cd3bb277 8173@opindex m4-single
3cadd778
AO
8174Generate code for the SH4 assuming the floating-point unit is in
8175single-precision mode by default.
8176
8177@item -m4
cd3bb277 8178@opindex m4
3cadd778
AO
8179Generate code for the SH4.
8180
74291a4b 8181@item -mb
cd3bb277 8182@opindex mb
74291a4b
MM
8183Compile code for the processor in big endian mode.
8184
8185@item -ml
cd3bb277 8186@opindex ml
74291a4b
MM
8187Compile code for the processor in little endian mode.
8188
3d5a0820 8189@item -mdalign
cd3bb277 8190@opindex mdalign
02f52e19 8191Align doubles at 64-bit boundaries. Note that this changes the calling
3d5a0820 8192conventions, and thus some functions from the standard C library will
695ac33f 8193not work unless you recompile it first with @option{-mdalign}.
3d5a0820 8194
74291a4b 8195@item -mrelax
cd3bb277 8196@opindex mrelax
74291a4b 8197Shorten some address references at link time, when possible; uses the
630d3d5a 8198linker option @option{-relax}.
3cadd778
AO
8199
8200@item -mbigtable
cd3bb277 8201@opindex mbigtable
3cadd778
AO
8202Use 32-bit offsets in @code{switch} tables. The default is to use
820316-bit offsets.
8204
8205@item -mfmovd
cd3bb277 8206@opindex mfmovd
3cadd778
AO
8207Enable the use of the instruction @code{fmovd}.
8208
8209@item -mhitachi
cd3bb277 8210@opindex mhitachi
3cadd778
AO
8211Comply with the calling conventions defined by Hitachi.
8212
8213@item -mnomacsave
cd3bb277 8214@opindex mnomacsave
3cadd778 8215Mark the @code{MAC} register as call-clobbered, even if
bedc7537 8216@option{-mhitachi} is given.
3cadd778 8217
c474f76b
AO
8218@item -mieee
8219@opindex mieee
8220Increase IEEE-compliance of floating-point code.
8221
3cadd778 8222@item -misize
cd3bb277 8223@opindex misize
3cadd778
AO
8224Dump instruction size and location in the assembly code.
8225
8226@item -mpadstruct
cd3bb277 8227@opindex mpadstruct
3cadd778 8228This option is deprecated. It pads structures to multiple of 4 bytes,
161d7b59 8229which is incompatible with the SH ABI@.
3cadd778
AO
8230
8231@item -mspace
cd3bb277 8232@opindex mspace
bedc7537 8233Optimize for space instead of speed. Implied by @option{-Os}.
1a66cd67
AO
8234
8235@item -mprefergot
cd3bb277 8236@opindex mprefergot
1a66cd67
AO
8237When generating position-independent code, emit function calls using
8238the Global Offset Table instead of the Procedure Linkage Table.
93ca1662
NY
8239
8240@item -musermode
cd3bb277 8241@opindex musermode
93ca1662
NY
8242Generate a library function call to invalidate instruction cache
8243entries, after fixing up a trampoline. This library function call
8244doesn't assume it can write to the whole memory address space. This
8245is the default when the target is @code{sh-*-linux*}.
74291a4b
MM
8246@end table
8247
8248@node System V Options
8249@subsection Options for System V
8250
8251These additional options are available on System V Release 4 for
8252compatibility with other compilers on those systems:
8253
2642624b 8254@table @gcctabopt
74291a4b 8255@item -G
cd3bb277 8256@opindex G
74291a4b 8257Create a shared object.
630d3d5a 8258It is recommended that @option{-symbolic} or @option{-shared} be used instead.
74291a4b
MM
8259
8260@item -Qy
cd3bb277 8261@opindex Qy
74291a4b
MM
8262Identify the versions of each tool used by the compiler, in a
8263@code{.ident} assembler directive in the output.
8264
8265@item -Qn
cd3bb277 8266@opindex Qn
74291a4b
MM
8267Refrain from adding @code{.ident} directives to the output file (this is
8268the default).
8269
aee96fe9 8270@item -YP,@var{dirs}
cd3bb277 8271@opindex YP
74291a4b 8272Search the directories @var{dirs}, and no others, for libraries
630d3d5a 8273specified with @option{-l}.
74291a4b 8274
aee96fe9 8275@item -Ym,@var{dir}
cd3bb277 8276@opindex Ym
bedc7537 8277Look in the directory @var{dir} to find the M4 preprocessor.
74291a4b
MM
8278The assembler uses this option.
8279@c This is supposed to go with a -Yd for predefined M4 macro files, but
8280@c the generic assembler that comes with Solaris takes just -Ym.
8281@end table
8282
282a61e6
MH
8283@node TMS320C3x/C4x Options
8284@subsection TMS320C3x/C4x Options
8285@cindex TMS320C3x/C4x Options
8286
8287These @samp{-m} options are defined for TMS320C3x/C4x implementations:
8288
2642624b 8289@table @gcctabopt
282a61e6
MH
8290
8291@item -mcpu=@var{cpu_type}
cd3bb277 8292@opindex mcpu
282a61e6
MH
8293Set the instruction set, register set, and instruction scheduling
8294parameters for machine type @var{cpu_type}. Supported values for
8295@var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
8296@samp{c44}. The default is @samp{c40} to generate code for the
8297TMS320C40.
8298
8299@item -mbig-memory
8300@item -mbig
8301@itemx -msmall-memory
8302@itemx -msmall
cd3bb277
JM
8303@opindex mbig-memory
8304@opindex mbig
8305@opindex msmall-memory
8306@opindex msmall
282a61e6
MH
8307Generates code for the big or small memory model. The small memory
8308model assumed that all data fits into one 64K word page. At run-time
8309the data page (DP) register must be set to point to the 64K page
8310containing the .bss and .data program sections. The big memory model is
8311the default and requires reloading of the DP register for every direct
8312memory access.
8313
8314@item -mbk
8315@itemx -mno-bk
cd3bb277
JM
8316@opindex mbk
8317@opindex mno-bk
282a61e6 8318Allow (disallow) allocation of general integer operands into the block
161d7b59 8319count register BK@.
282a61e6
MH
8320
8321@item -mdb
8322@itemx -mno-db
cd3bb277
JM
8323@opindex mdb
8324@opindex mno-db
282a61e6
MH
8325Enable (disable) generation of code using decrement and branch,
8326DBcond(D), instructions. This is enabled by default for the C4x. To be
8327on the safe side, this is disabled for the C3x, since the maximum
cff42170
JM
8328iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
8329@math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
282a61e6
MH
8330that it can utilise the decrement and branch instruction, but will give
8331up if there is more than one memory reference in the loop. Thus a loop
8332where the loop counter is decremented can generate slightly more
8333efficient code, in cases where the RPTB instruction cannot be utilised.
8334
8335@item -mdp-isr-reload
8336@itemx -mparanoid
cd3bb277
JM
8337@opindex mdp-isr-reload
8338@opindex mparanoid
282a61e6
MH
8339Force the DP register to be saved on entry to an interrupt service
8340routine (ISR), reloaded to point to the data section, and restored on
161d7b59 8341exit from the ISR@. This should not be required unless someone has
282a61e6
MH
8342violated the small memory model by modifying the DP register, say within
8343an object library.
8344
8345@item -mmpyi
8346@itemx -mno-mpyi
cd3bb277
JM
8347@opindex mmpyi
8348@opindex mno-mpyi
282a61e6
MH
8349For the C3x use the 24-bit MPYI instruction for integer multiplies
8350instead of a library call to guarantee 32-bit results. Note that if one
8351of the operands is a constant, then the multiplication will be performed
695ac33f 8352using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
282a61e6
MH
8353then squaring operations are performed inline instead of a library call.
8354
8355@item -mfast-fix
8356@itemx -mno-fast-fix
cd3bb277
JM
8357@opindex mfast-fix
8358@opindex mno-fast-fix
282a61e6
MH
8359The C3x/C4x FIX instruction to convert a floating point value to an
8360integer value chooses the nearest integer less than or equal to the
8361floating point value rather than to the nearest integer. Thus if the
8362floating point number is negative, the result will be incorrectly
8363truncated an additional code is necessary to detect and correct this
8364case. This option can be used to disable generation of the additional
8365code required to correct the result.
8366
8367@item -mrptb
8368@itemx -mno-rptb
cd3bb277
JM
8369@opindex mrptb
8370@opindex mno-rptb
282a61e6
MH
8371Enable (disable) generation of repeat block sequences using the RPTB
8372instruction for zero overhead looping. The RPTB construct is only used
8373for innermost loops that do not call functions or jump across the loop
8374boundaries. There is no advantage having nested RPTB loops due to the
8375overhead required to save and restore the RC, RS, and RE registers.
695ac33f 8376This is enabled by default with @option{-O2}.
282a61e6
MH
8377
8378@item -mrpts=@var{count}
8379@itemx -mno-rpts
cd3bb277
JM
8380@opindex mrpts
8381@opindex mno-rpts
282a61e6 8382Enable (disable) the use of the single instruction repeat instruction
161d7b59 8383RPTS@. If a repeat block contains a single instruction, and the loop
282a61e6 8384count can be guaranteed to be less than the value @var{count}, GCC will
161d7b59 8385emit a RPTS instruction instead of a RPTB@. If no value is specified,
282a61e6
MH
8386then a RPTS will be emitted even if the loop count cannot be determined
8387at compile time. Note that the repeated instruction following RPTS does
8388not have to be reloaded from memory each iteration, thus freeing up the
b192711e 8389CPU buses for operands. However, since interrupts are blocked by this
282a61e6
MH
8390instruction, it is disabled by default.
8391
8392@item -mloop-unsigned
8393@itemx -mno-loop-unsigned
cd3bb277
JM
8394@opindex mloop-unsigned
8395@opindex mno-loop-unsigned
282a61e6 8396The maximum iteration count when using RPTS and RPTB (and DB on the C40)
cff42170 8397is @math{2^{31} + 1} since these instructions test if the iteration count is
282a61e6 8398negative to terminate the loop. If the iteration count is unsigned
cff42170 8399there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
282a61e6
MH
8400exceeded. This switch allows an unsigned iteration count.
8401
8402@item -mti
cd3bb277 8403@opindex mti
282a61e6
MH
8404Try to emit an assembler syntax that the TI assembler (asm30) is happy
8405with. This also enforces compatibility with the API employed by the TI
8406C3x C compiler. For example, long doubles are passed as structures
8407rather than in floating point registers.
8408
8409@item -mregparm
8410@itemx -mmemparm
cd3bb277
JM
8411@opindex mregparm
8412@opindex mmemparm
282a61e6
MH
8413Generate code that uses registers (stack) for passing arguments to functions.
8414By default, arguments are passed in registers where possible rather
8415than by pushing arguments on to the stack.
8416
8417@item -mparallel-insns
8418@itemx -mno-parallel-insns
cd3bb277
JM
8419@opindex mparallel-insns
8420@opindex mno-parallel-insns
282a61e6 8421Allow the generation of parallel instructions. This is enabled by
695ac33f 8422default with @option{-O2}.
282a61e6
MH
8423
8424@item -mparallel-mpy
8425@itemx -mno-parallel-mpy
cd3bb277
JM
8426@opindex mparallel-mpy
8427@opindex mno-parallel-mpy
282a61e6 8428Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
695ac33f 8429provided @option{-mparallel-insns} is also specified. These instructions have
282a61e6
MH
8430tight register constraints which can pessimize the code generation
8431of large functions.
8432
8433@end table
8434
f84271d9
JL
8435@node V850 Options
8436@subsection V850 Options
8437@cindex V850 Options
8438
8439These @samp{-m} options are defined for V850 implementations:
8440
2642624b 8441@table @gcctabopt
f84271d9
JL
8442@item -mlong-calls
8443@itemx -mno-long-calls
cd3bb277
JM
8444@opindex mlong-calls
8445@opindex mno-long-calls
f84271d9
JL
8446Treat all calls as being far away (near). If calls are assumed to be
8447far away, the compiler will always load the functions address up into a
8448register, and call indirect through the pointer.
8449
8450@item -mno-ep
bd762873 8451@itemx -mep
cd3bb277
JM
8452@opindex mno-ep
8453@opindex mep
f84271d9
JL
8454Do not optimize (do optimize) basic blocks that use the same index
8455pointer 4 or more times to copy pointer into the @code{ep} register, and
630d3d5a 8456use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
f84271d9
JL
8457option is on by default if you optimize.
8458
8459@item -mno-prolog-function
8460@itemx -mprolog-function
cd3bb277
JM
8461@opindex mno-prolog-function
8462@opindex mprolog-function
f84271d9
JL
8463Do not use (do use) external functions to save and restore registers at
8464the prolog and epilog of a function. The external functions are slower,
8465but use less code space if more than one function saves the same number
630d3d5a 8466of registers. The @option{-mprolog-function} option is on by default if
f84271d9
JL
8467you optimize.
8468
8469@item -mspace
cd3bb277 8470@opindex mspace
f84271d9 8471Try to make the code as small as possible. At present, this just turns
630d3d5a 8472on the @option{-mep} and @option{-mprolog-function} options.
f84271d9
JL
8473
8474@item -mtda=@var{n}
cd3bb277 8475@opindex mtda
f84271d9
JL
8476Put static or global variables whose size is @var{n} bytes or less into
8477the tiny data area that register @code{ep} points to. The tiny data
8478area can hold up to 256 bytes in total (128 bytes for byte references).
8479
8480@item -msda=@var{n}
cd3bb277 8481@opindex msda
f84271d9
JL
8482Put static or global variables whose size is @var{n} bytes or less into
8483the small data area that register @code{gp} points to. The small data
8484area can hold up to 64 kilobytes.
8485
8486@item -mzda=@var{n}
cd3bb277 8487@opindex mzda
f84271d9
JL
8488Put static or global variables whose size is @var{n} bytes or less into
8489the first 32 kilobytes of memory.
02f52e19 8490
48f0be1b 8491@item -mv850
cd3bb277 8492@opindex mv850
48f0be1b
SC
8493Specify that the target processor is the V850.
8494
e9a25f70 8495@item -mbig-switch
cd3bb277 8496@opindex mbig-switch
e9a25f70
JL
8497Generate code suitable for big switch tables. Use this option only if
8498the assembler/linker complain about out of range branches within a switch
8499table.
f84271d9
JL
8500@end table
8501
56b2d7a7
JL
8502@node ARC Options
8503@subsection ARC Options
8504@cindex ARC Options
8505
8506These options are defined for ARC implementations:
8507
2642624b 8508@table @gcctabopt
56b2d7a7 8509@item -EL
cd3bb277 8510@opindex EL
56b2d7a7
JL
8511Compile code for little endian mode. This is the default.
8512
8513@item -EB
cd3bb277 8514@opindex EB
56b2d7a7
JL
8515Compile code for big endian mode.
8516
8517@item -mmangle-cpu
cd3bb277 8518@opindex mmangle-cpu
56b2d7a7
JL
8519Prepend the name of the cpu to all public symbol names.
8520In multiple-processor systems, there are many ARC variants with different
8521instruction and register set characteristics. This flag prevents code
8522compiled for one cpu to be linked with code compiled for another.
695ac33f 8523No facility exists for handling variants that are ``almost identical''.
56b2d7a7
JL
8524This is an all or nothing option.
8525
8526@item -mcpu=@var{cpu}
cd3bb277 8527@opindex mcpu
56b2d7a7
JL
8528Compile code for ARC variant @var{cpu}.
8529Which variants are supported depend on the configuration.
630d3d5a 8530All variants support @option{-mcpu=base}, this is the default.
56b2d7a7 8531
630d3d5a
JM
8532@item -mtext=@var{text-section}
8533@itemx -mdata=@var{data-section}
8534@itemx -mrodata=@var{readonly-data-section}
cd3bb277
JM
8535@opindex mtext
8536@opindex mdata
8537@opindex mrodata
630d3d5a
JM
8538Put functions, data, and readonly data in @var{text-section},
8539@var{data-section}, and @var{readonly-data-section} respectively
56b2d7a7 8540by default. This can be overridden with the @code{section} attribute.
0b433de6 8541@xref{Variable Attributes}.
56b2d7a7
JL
8542
8543@end table
8544
83575957
ID
8545@node NS32K Options
8546@subsection NS32K Options
8547@cindex NS32K options
8548
8549These are the @samp{-m} options defined for the 32000 series. The default
8550values for these options depends on which style of 32000 was selected when
8551the compiler was configured; the defaults for the most common choices are
8552given below.
8553
2642624b 8554@table @gcctabopt
83575957
ID
8555@item -m32032
8556@itemx -m32032
cd3bb277
JM
8557@opindex m32032
8558@opindex m32032
83575957
ID
8559Generate output for a 32032. This is the default
8560when the compiler is configured for 32032 and 32016 based systems.
8561
8562@item -m32332
8563@itemx -m32332
cd3bb277
JM
8564@opindex m32332
8565@opindex m32332
83575957
ID
8566Generate output for a 32332. This is the default
8567when the compiler is configured for 32332-based systems.
8568
8569@item -m32532
8570@itemx -m32532
cd3bb277
JM
8571@opindex m32532
8572@opindex m32532
83575957
ID
8573Generate output for a 32532. This is the default
8574when the compiler is configured for 32532-based systems.
8575
8576@item -m32081
cd3bb277 8577@opindex m32081
83575957
ID
8578Generate output containing 32081 instructions for floating point.
8579This is the default for all systems.
8580
8581@item -m32381
cd3bb277 8582@opindex m32381
83575957 8583Generate output containing 32381 instructions for floating point. This
767094dd
JM
8584also implies @option{-m32081}. The 32381 is only compatible with the 32332
8585and 32532 cpus. This is the default for the pc532-netbsd configuration.
83575957
ID
8586
8587@item -mmulti-add
cd3bb277 8588@opindex mmulti-add
83575957 8589Try and generate multiply-add floating point instructions @code{polyF}
767094dd 8590and @code{dotF}. This option is only available if the @option{-m32381}
14976c58 8591option is in effect. Using these instructions requires changes to
83575957
ID
8592register allocation which generally has a negative impact on
8593performance. This option should only be enabled when compiling code
8594particularly likely to make heavy use of multiply-add instructions.
8595
8596@item -mnomulti-add
cd3bb277 8597@opindex mnomulti-add
83575957 8598Do not try and generate multiply-add floating point instructions
767094dd 8599@code{polyF} and @code{dotF}. This is the default on all platforms.
83575957
ID
8600
8601@item -msoft-float
cd3bb277 8602@opindex msoft-float
83575957
ID
8603Generate output containing library calls for floating point.
8604@strong{Warning:} the requisite libraries may not be available.
8605
8606@item -mnobitfield
cd3bb277 8607@opindex mnobitfield
767094dd
JM
8608Do not use the bit-field instructions. On some machines it is faster to
8609use shifting and masking operations. This is the default for the pc532.
83575957
ID
8610
8611@item -mbitfield
cd3bb277 8612@opindex mbitfield
767094dd 8613Do use the bit-field instructions. This is the default for all platforms
83575957
ID
8614except the pc532.
8615
8616@item -mrtd
cd3bb277 8617@opindex mrtd
83575957
ID
8618Use a different function-calling convention, in which functions
8619that take a fixed number of arguments return pop their
8620arguments on return with the @code{ret} instruction.
8621
8622This calling convention is incompatible with the one normally
8623used on Unix, so you cannot use it if you need to call libraries
8624compiled with the Unix compiler.
8625
8626Also, you must provide function prototypes for all functions that
8627take variable numbers of arguments (including @code{printf});
8628otherwise incorrect code will be generated for calls to those
8629functions.
8630
8631In addition, seriously incorrect code will result if you call a
8632function with too many arguments. (Normally, extra arguments are
8633harmlessly ignored.)
8634
8635This option takes its name from the 680x0 @code{rtd} instruction.
8636
8637
8638@item -mregparam
cd3bb277 8639@opindex mregparam
83575957
ID
8640Use a different function-calling convention where the first two arguments
8641are passed in registers.
8642
8643This calling convention is incompatible with the one normally
8644used on Unix, so you cannot use it if you need to call libraries
8645compiled with the Unix compiler.
8646
8647@item -mnoregparam
cd3bb277 8648@opindex mnoregparam
767094dd 8649Do not pass any arguments in registers. This is the default for all
83575957
ID
8650targets.
8651
8652@item -msb
cd3bb277 8653@opindex msb
83575957 8654It is OK to use the sb as an index register which is always loaded with
767094dd 8655zero. This is the default for the pc532-netbsd target.
83575957
ID
8656
8657@item -mnosb
cd3bb277 8658@opindex mnosb
83575957 8659The sb register is not available for use or has not been initialized to
767094dd
JM
8660zero by the run time system. This is the default for all targets except
8661the pc532-netbsd. It is also implied whenever @option{-mhimem} or
630d3d5a 8662@option{-fpic} is set.
83575957
ID
8663
8664@item -mhimem
cd3bb277 8665@opindex mhimem
161d7b59 8666Many ns32000 series addressing modes use displacements of up to 512MB@.
83575957 8667If an address is above 512MB then displacements from zero can not be used.
161d7b59 8668This option causes code to be generated which can be loaded above 512MB@.
83575957
ID
8669This may be useful for operating systems or ROM code.
8670
8671@item -mnohimem
cd3bb277 8672@opindex mnohimem
83575957
ID
8673Assume code will be loaded in the first 512MB of virtual address space.
8674This is the default for all platforms.
8675
8676
8677@end table
8678
052a4b28
DC
8679@node AVR Options
8680@subsection AVR Options
8681@cindex AVR Options
8682
8683These options are defined for AVR implementations:
8684
2642624b 8685@table @gcctabopt
052a4b28 8686@item -mmcu=@var{mcu}
cd3bb277 8687@opindex mmcu
3a69a7d5
MM
8688Specify ATMEL AVR instruction set or MCU type.
8689
8690Instruction set avr1 is for the minimal AVR core, not supported by the C
8691compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8692attiny11, attiny12, attiny15, attiny28).
8693
8694Instruction set avr2 (default) is for the classic AVR core with up to
86958K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8696at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8697at90c8534, at90s8535).
8698
8699Instruction set avr3 is for the classic AVR core with up to 128K program
c7f3e0b0 8700memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
3a69a7d5
MM
8701
8702Instruction set avr4 is for the enhanced AVR core with up to 8K program
c7f3e0b0 8703memory space (MCU types: atmega8, atmega83, atmega85).
3a69a7d5
MM
8704
8705Instruction set avr5 is for the enhanced AVR core with up to 128K program
c7f3e0b0
MM
8706memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8707atmega64, atmega128, at43usb355, at94k).
052a4b28
DC
8708
8709@item -msize
cd3bb277 8710@opindex msize
3a69a7d5 8711Output instruction sizes to the asm file.
052a4b28
DC
8712
8713@item -minit-stack=@var{N}
cd3bb277 8714@opindex minit-stack
3a69a7d5 8715Specify the initial stack address, which may be a symbol or numeric value,
aee96fe9 8716@samp{__stack} is the default.
052a4b28
DC
8717
8718@item -mno-interrupts
cd3bb277 8719@opindex mno-interrupts
052a4b28
DC
8720Generated code is not compatible with hardware interrupts.
8721Code size will be smaller.
8722
8723@item -mcall-prologues
cd3bb277 8724@opindex mcall-prologues
052a4b28 8725Functions prologues/epilogues expanded as call to appropriate
767094dd 8726subroutines. Code size will be smaller.
3a69a7d5
MM
8727
8728@item -mno-tablejump
cd3bb277 8729@opindex mno-tablejump
3a69a7d5
MM
8730Do not generate tablejump insns which sometimes increase code size.
8731
8732@item -mtiny-stack
cd3bb277 8733@opindex mtiny-stack
3a69a7d5 8734Change only the low 8 bits of the stack pointer.
052a4b28
DC
8735@end table
8736
789a3090
NC
8737@node MCore Options
8738@subsection MCore Options
8739@cindex MCore options
8740
8741These are the @samp{-m} options defined for the Motorola M*Core
02f52e19 8742processors.
789a3090 8743
2642624b 8744@table @gcctabopt
789a3090
NC
8745
8746@item -mhardlit
8747@itemx -mhardlit
8748@itemx -mno-hardlit
cd3bb277
JM
8749@opindex mhardlit
8750@opindex mhardlit
8751@opindex mno-hardlit
789a3090
NC
8752Inline constants into the code stream if it can be done in two
8753instructions or less.
8754
8755@item -mdiv
8756@itemx -mdiv
8757@itemx -mno-div
cd3bb277
JM
8758@opindex mdiv
8759@opindex mdiv
8760@opindex mno-div
789a3090
NC
8761Use the divide instruction. (Enabled by default).
8762
8763@item -mrelax-immediate
8764@itemx -mrelax-immediate
8765@itemx -mno-relax-immediate
cd3bb277
JM
8766@opindex mrelax-immediate
8767@opindex mrelax-immediate
8768@opindex mno-relax-immediate
b192711e 8769Allow arbitrary sized immediates in bit operations.
789a3090
NC
8770
8771@item -mwide-bitfields
8772@itemx -mwide-bitfields
8773@itemx -mno-wide-bitfields
cd3bb277
JM
8774@opindex mwide-bitfields
8775@opindex mwide-bitfields
8776@opindex mno-wide-bitfields
c771326b 8777Always treat bit-fields as int-sized.
789a3090
NC
8778
8779@item -m4byte-functions
8780@itemx -m4byte-functions
8781@itemx -mno-4byte-functions
cd3bb277
JM
8782@opindex m4byte-functions
8783@opindex m4byte-functions
8784@opindex mno-4byte-functions
b192711e 8785Force all functions to be aligned to a four byte boundary.
789a3090
NC
8786
8787@item -mcallgraph-data
8788@itemx -mcallgraph-data
8789@itemx -mno-callgraph-data
cd3bb277
JM
8790@opindex mcallgraph-data
8791@opindex mcallgraph-data
8792@opindex mno-callgraph-data
789a3090
NC
8793Emit callgraph information.
8794
8795@item -mslow-bytes
8796@itemx -mslow-bytes
8797@itemx -mno-slow-bytes
cd3bb277
JM
8798@opindex mslow-bytes
8799@opindex mslow-bytes
8800@opindex mno-slow-bytes
789a3090
NC
8801Prefer word access when reading byte quantities.
8802
8803@item -mlittle-endian
8804@itemx -mlittle-endian
8805@itemx -mbig-endian
cd3bb277
JM
8806@opindex mlittle-endian
8807@opindex mlittle-endian
8808@opindex mbig-endian
b192711e 8809Generate code for a little endian target.
789a3090
NC
8810
8811@item -m210
8812@itemx -m210
8813@itemx -m340
cd3bb277
JM
8814@opindex m210
8815@opindex m210
8816@opindex m340
789a3090 8817Generate code for the 210 processor.
789a3090 8818@end table
83575957 8819
df6194d4
JW
8820@node IA-64 Options
8821@subsection IA-64 Options
8822@cindex IA-64 Options
8823
8824These are the @samp{-m} options defined for the Intel IA-64 architecture.
8825
8826@table @gcctabopt
8827@item -mbig-endian
cd3bb277 8828@opindex mbig-endian
161d7b59 8829Generate code for a big endian target. This is the default for HPUX@.
df6194d4
JW
8830
8831@item -mlittle-endian
cd3bb277 8832@opindex mlittle-endian
df6194d4
JW
8833Generate code for a little endian target. This is the default for AIX5
8834and Linux.
8835
8836@item -mgnu-as
8837@itemx -mno-gnu-as
cd3bb277
JM
8838@opindex mgnu-as
8839@opindex mno-gnu-as
15d3a111 8840Generate (or don't) code for the GNU assembler. This is the default.
630d3d5a 8841@c Also, this is the default if the configure option @option{--with-gnu-as}
15d3a111 8842@c is used.
df6194d4
JW
8843
8844@item -mgnu-ld
8845@itemx -mno-gnu-ld
cd3bb277
JM
8846@opindex mgnu-ld
8847@opindex mno-gnu-ld
15d3a111 8848Generate (or don't) code for the GNU linker. This is the default.
630d3d5a 8849@c Also, this is the default if the configure option @option{--with-gnu-ld}
15d3a111 8850@c is used.
df6194d4
JW
8851
8852@item -mno-pic
cd3bb277 8853@opindex mno-pic
15d3a111 8854Generate code that does not use a global pointer register. The result
161d7b59 8855is not position independent code, and violates the IA-64 ABI@.
df6194d4
JW
8856
8857@item -mvolatile-asm-stop
8858@itemx -mno-volatile-asm-stop
cd3bb277
JM
8859@opindex mvolatile-asm-stop
8860@opindex mno-volatile-asm-stop
15d3a111
JW
8861Generate (or don't) a stop bit immediately before and after volatile asm
8862statements.
df6194d4
JW
8863
8864@item -mb-step
cd3bb277 8865@opindex mb-step
df6194d4
JW
8866Generate code that works around Itanium B step errata.
8867
8868@item -mregister-names
8869@itemx -mno-register-names
cd3bb277
JM
8870@opindex mregister-names
8871@opindex mno-register-names
15d3a111
JW
8872Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8873the stacked registers. This may make assembler output more readable.
df6194d4
JW
8874
8875@item -mno-sdata
8876@itemx -msdata
cd3bb277
JM
8877@opindex mno-sdata
8878@opindex msdata
15d3a111
JW
8879Disable (or enable) optimizations that use the small data section. This may
8880be useful for working around optimizer bugs.
df6194d4
JW
8881
8882@item -mconstant-gp
cd3bb277 8883@opindex mconstant-gp
df6194d4
JW
8884Generate code that uses a single constant global pointer value. This is
8885useful when compiling kernel code.
8886
8887@item -mauto-pic
cd3bb277 8888@opindex mauto-pic
630d3d5a 8889Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
df6194d4
JW
8890This is useful when compiling firmware code.
8891
8892@item -minline-divide-min-latency
cd3bb277 8893@opindex minline-divide-min-latency
df6194d4
JW
8894Generate code for inline divides using the minimum latency algorithm.
8895
8896@item -minline-divide-max-throughput
cd3bb277 8897@opindex minline-divide-max-throughput
df6194d4
JW
8898Generate code for inline divides using the maximum throughput algorithm.
8899
8900@item -mno-dwarf2-asm
8901@itemx -mdwarf2-asm
cd3bb277
JM
8902@opindex mno-dwarf2-asm
8903@opindex mdwarf2-asm
15d3a111
JW
8904Don't (or do) generate assembler code for the DWARF2 line number debugging
8905info. This may be useful when not using the GNU assembler.
df6194d4 8906
630d3d5a 8907@item -mfixed-range=@var{register-range}
cd3bb277 8908@opindex mfixed-range
df6194d4
JW
8909Generate code treating the given register range as fixed registers.
8910A fixed register is one that the register allocator can not use. This is
8911useful when compiling kernel code. A register range is specified as
8912two registers separated by a dash. Multiple register ranges can be
8913specified separated by a comma.
8914@end table
8915
e8ad90e5
MM
8916@node D30V Options
8917@subsection D30V Options
8918@cindex D30V Options
8919
8920These @samp{-m} options are defined for D30V implementations:
8921
2642624b 8922@table @gcctabopt
e8ad90e5 8923@item -mextmem
cd3bb277 8924@opindex mextmem
e8ad90e5
MM
8925Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
8926@samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
8927memory, which starts at location @code{0x80000000}.
8928
8929@item -mextmemory
cd3bb277 8930@opindex mextmemory
630d3d5a 8931Same as the @option{-mextmem} switch.
e8ad90e5
MM
8932
8933@item -monchip
cd3bb277 8934@opindex monchip
e8ad90e5
MM
8935Link the @samp{.text} section into onchip text memory, which starts at
8936location @code{0x0}. Also link @samp{.data}, @samp{.bss},
8937@samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
8938into onchip data memory, which starts at location @code{0x20000000}.
8939
8940@item -mno-asm-optimize
8941@itemx -masm-optimize
cd3bb277
JM
8942@opindex mno-asm-optimize
8943@opindex masm-optimize
630d3d5a
JM
8944Disable (enable) passing @option{-O} to the assembler when optimizing.
8945The assembler uses the @option{-O} option to automatically parallelize
e8ad90e5
MM
8946adjacent short instructions where possible.
8947
8948@item -mbranch-cost=@var{n}
cd3bb277 8949@opindex mbranch-cost
e8ad90e5
MM
8950Increase the internal costs of branches to @var{n}. Higher costs means
8951that the compiler will issue more instructions to avoid doing a branch.
8952The default is 2.
8953
8954@item -mcond-exec=@var{n}
cd3bb277 8955@opindex mcond-exec
e8ad90e5
MM
8956Specify the maximum number of conditionally executed instructions that
8957replace a branch. The default is 4.
8958@end table
56b2d7a7 8959
91abf72d
HP
8960@node S/390 and zSeries Options
8961@subsection S/390 and zSeries Options
8962@cindex S/390 and zSeries Options
8963
8964These are the @samp{-m} options defined for the S/390 and zSeries architecture.
8965
8966@table @gcctabopt
8967@item -mhard-float
8968@itemx -msoft-float
8969@opindex mhard-float
8970@opindex msoft-float
8971Use (do not use) the hardware floating-point instructions and registers
8972for floating-point operations. When @option{-msoft-float} is specified,
8973functions in @file{libgcc.a} will be used to perform floating-point
8974operations. When @option{-mhard-float} is specified, the compiler
8975generates IEEE floating-point instructions. This is the default.
8976
8977@item -mbackchain
8978@itemx -mno-backchain
8979@opindex mbackchain
8980@opindex mno-backchain
f282ffb3 8981Generate (or do not generate) code which maintains an explicit
91abf72d
HP
8982backchain within the stack frame that points to the caller's frame.
8983This is currently needed to allow debugging. The default is to
8984generate the backchain.
8985
8986@item -msmall-exec
8987@itemx -mno-small-exec
8988@opindex msmall-exec
8989@opindex mno-small-exec
f282ffb3
JM
8990Generate (or do not generate) code using the @code{bras} instruction
8991to do subroutine calls.
91abf72d
HP
8992This only works reliably if the total executable size does not
8993exceed 64k. The default is to use the @code{basr} instruction instead,
8994which does not have this limitation.
8995
8996@item -m64
8997@itemx -m31
8998@opindex m64
8999@opindex m31
9000When @option{-m31} is specified, generate code compliant to the
9001Linux for S/390 ABI@. When @option{-m64} is specified, generate
9002code compliant to the Linux for zSeries ABI@. This allows GCC in
9003particular to generate 64-bit instructions. For the @samp{s390}
f282ffb3 9004targets, the default is @option{-m31}, while the @samp{s390x}
91abf72d
HP
9005targets default to @option{-m64}.
9006
9007@item -mmvcle
9008@itemx -mno-mvcle
9009@opindex mmvcle
9010@opindex mno-mvcle
f282ffb3 9011Generate (or do not generate) code using the @code{mvcle} instruction
91abf72d
HP
9012to perform block moves. When @option{-mno-mvcle} is specifed,
9013use a @code{mvc} loop instead. This is the default.
9014
9015@item -mdebug
9016@itemx -mno-debug
9017@opindex mdebug
9018@opindex mno-debug
9019Print (or do not print) additional debug information when compiling.
9020The default is to not print debug information.
9021
9022@end table
9023
0b85d816
HPN
9024@node CRIS Options
9025@subsection CRIS Options
9026@cindex CRIS Options
9027
9028These options are defined specifically for the CRIS ports.
9029
9030@table @gcctabopt
9031@item -march=@var{architecture-type}
9032@itemx -mcpu=@var{architecture-type}
9033@opindex march
9034@opindex mcpu
9035Generate code for the specified architecture. The choices for
9036@var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9037respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9038Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9039@samp{v10}.
9040
9041@item -mtune=@var{architecture-type}
9042@opindex mtune
9043Tune to @var{architecture-type} everything applicable about the generated
9044code, except for the ABI and the set of available instructions. The
9045choices for @var{architecture-type} are the same as for
9046@option{-march=@var{architecture-type}}.
9047
9048@item -mmax-stack-frame=@var{n}
9049@opindex mmax-stack-frame
9050Warn when the stack frame of a function exceeds @var{n} bytes.
9051
9052@item -melinux-stacksize=@var{n}
9053@opindex melinux-stacksize
9054Only available with the @samp{cris-axis-aout} target. Arranges for
9055indications in the program to the kernel loader that the stack of the
9056program should be set to @var{n} bytes.
9057
9058@item -metrax4
9059@itemx -metrax100
9060@opindex metrax4
9061@opindex metrax100
9062The options @option{-metrax4} and @option{-metrax100} are synonyms for
9063@option{-march=v3} and @option{-march=v8} respectively.
9064
9065@item -mpdebug
9066@opindex mpdebug
9067Enable CRIS-specific verbose debug-related information in the assembly
9068code. This option also has the effect to turn off the @samp{#NO_APP}
9069formatted-code indicator to the assembler at the beginning of the
9070assembly file.
9071
9072@item -mcc-init
9073@opindex mcc-init
9074Do not use condition-code results from previous instruction; always emit
9075compare and test instructions before use of condition codes.
9076
9077@item -mno-side-effects
9078@opindex mno-side-effects
9079Do not emit instructions with side-effects in addressing modes other than
9080post-increment.
9081
9082@item -mstack-align
9083@itemx -mno-stack-align
9084@itemx -mdata-align
9085@itemx -mno-data-align
9086@itemx -mconst-align
9087@itemx -mno-const-align
9088@opindex mstack-align
9089@opindex mno-stack-align
9090@opindex mdata-align
9091@opindex mno-data-align
9092@opindex mconst-align
9093@opindex mno-const-align
9094These options (no-options) arranges (eliminate arrangements) for the
9095stack-frame, individual data and constants to be aligned for the maximum
9096single data access size for the chosen CPU model. The default is to
9097arrange for 32-bit alignment. ABI details such as structure layout are
9098not affected by these options.
9099
9100@item -m32-bit
9101@itemx -m16-bit
9102@itemx -m8-bit
9103@opindex m32-bit
9104@opindex m16-bit
9105@opindex m8-bit
9106Similar to the stack- data- and const-align options above, these options
9107arrange for stack-frame, writable data and constants to all be 32-bit,
910816-bit or 8-bit aligned. The default is 32-bit alignment.
9109
9110@item -mno-prologue-epilogue
9111@itemx -mprologue-epilogue
9112@opindex mno-prologue-epilogue
9113@opindex mprologue-epilogue
9114With @option{-mno-prologue-epilogue}, the normal function prologue and
9115epilogue that sets up the stack-frame are omitted and no return
9116instructions or return sequences are generated in the code. Use this
9117option only together with visual inspection of the compiled code: no
9118warnings or errors are generated when call-saved registers must be saved,
9119or storage for local variable needs to be allocated.
9120
9121@item -mno-gotplt
9122@itemx -mgotplt
9123@opindex mno-gotplt
9124@opindex mgotplt
9125With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9126instruction sequences that load addresses for functions from the PLT part
9127of the GOT rather than (traditional on other architectures) calls to the
9128PLT. The default is @option{-mgotplt}.
9129
9130@item -maout
9131@opindex maout
9132Legacy no-op option only recognized with the cris-axis-aout target.
9133
9134@item -melf
9135@opindex melf
9136Legacy no-op option only recognized with the cris-axis-elf and
9137cris-axis-linux-gnu targets.
9138
9139@item -melinux
9140@opindex melinux
9141Only recognized with the cris-axis-aout target, where it selects a
9142GNU/linux-like multilib, include files and instruction set for
9143@option{-march=v8}.
9144
9145@item -mlinux
9146@opindex mlinux
9147Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9148
9149@item -sim
9150@opindex sim
9151This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9152to link with input-output functions from a simulator library. Code,
9153initialized data and zero-initialized data are allocated consecutively.
9154
9155@item -sim2
9156@opindex sim2
9157Like @option{-sim}, but pass linker options to locate initialized data at
91580x40000000 and zero-initialized data at 0x80000000.
9159@end table
9160
bcf684c7
HPN
9161@node MMIX Options
9162@subsection MMIX Options
9163@cindex MMIX Options
9164
9165These options are defined for the MMIX:
9166
5d22c1a5 9167@table @gcctabopt
bcf684c7
HPN
9168@item -mlibfuncs
9169@itemx -mno-libfuncs
5d22c1a5
JM
9170@opindex mlibfuncs
9171@opindex mno-libfuncs
bcf684c7
HPN
9172Specify that intrinsic library functions are being compiled, passing all
9173values in registers, no matter the size.
9174
9175@item -mepsilon
9176@itemx -mno-epsilon
5d22c1a5
JM
9177@opindex mepsilon
9178@opindex mno-epsilon
bcf684c7
HPN
9179Generate floating-point comparison instructions that compare with respect
9180to the @code{rE} epsilon register.
9181
9182@item -mabi=mmixware
9183@itemx -mabi=gnu
5d22c1a5
JM
9184@opindex mabi-mmixware
9185@opindex mabi=gnu
bcf684c7
HPN
9186Generate code that passes function parameters and return values that (in
9187the called function) are seen as registers @code{$0} and up, as opposed to
9188the GNU ABI which uses global registers @code{$231} and up.
9189
9190@item -mzero-extend
3e0f61ac 9191@itemx -mno-zero-extend
5d22c1a5
JM
9192@opindex mzero-extend
9193@opindex mno-zero-extend
bcf684c7
HPN
9194When reading data from memory in sizes shorter than 64 bits, use (do not
9195use) zero-extending load instructions by default, rather than
9196sign-extending ones.
9197
9198@item -mknuthdiv
9199@itemx -mno-knuthdiv
5d22c1a5
JM
9200@opindex mknuthdiv
9201@opindex mno-knuthdiv
bcf684c7
HPN
9202Make the result of a division yielding a remainder have the same sign as
9203the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
7fba3293
HPN
9204remainder follows the sign of the dividend. Both methods are
9205arithmetically valid, the latter being almost exclusively used.
bcf684c7
HPN
9206
9207@item -mtoplevel-symbols
9208@itemx -mno-toplevel-symbols
5d22c1a5
JM
9209@opindex mtoplevel-symbols
9210@opindex mno-toplevel-symbols
7fba3293 9211Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
bcf684c7
HPN
9212code can be used with the @code{PREFIX} assembly directive.
9213
9214@item -melf
5d22c1a5 9215@opindex melf
7fba3293 9216Generate an executable in the ELF format, rather than the default
bcf684c7 9217@samp{mmo} format used by the @command{mmix} simulator.
3e0f61ac
HPN
9218
9219@item -mbranch-predict
9220@itemx -mno-branch-predict
5d22c1a5
JM
9221@opindex mbranch-predict
9222@opindex mno-branch-predict
3e0f61ac
HPN
9223Use (do not use) the probable-branch instructions, when static branch
9224prediction indicates a probable branch.
a824924d
HPN
9225
9226@item -mbase-addresses
9227@itemx -mno-base-addresses
9228@opindex mbase-addresses
9229@opindex mno-base-addresses
9230Generate (do not generate) code that uses @emph{base addresses}. Using a
9231base address automatically generates a request (handled by the assembler
9232and the linker) for a constant to be set up in a global register. The
9233register is used for one or more base address requests within the range 0
9234to 255 from the value held in the register. The generally leads to short
9235and fast code, but the number of different data items that can be
9236addressed is limited. This means that a program that uses lots of static
9237data may require @option{-mno-base-addresses}.
bcf684c7
HPN
9238@end table
9239
9f85bca7
JM
9240@node PDP-11 Options
9241@subsection PDP-11 Options
9242@cindex PDP-11 Options
9243
9244These options are defined for the PDP-11:
9245
9246@table @gcctabopt
9247@item -mfpu
9248@opindex mfpu
9249Use hardware FPP floating point. This is the default. (FIS floating
9250point on the PDP-11/40 is not supported.)
9251
9252@item -msoft-float
9253@opindex msoft-float
9254Do not use hardware floating point.
9255
9256@item -mac0
9257@opindex mac0
9258Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9259
9260@item -mno-ac0
9261@opindex mno-ac0
9262Return floating-point results in memory. This is the default.
9263
9264@item -m40
9265@opindex m40
9266Generate code for a PDP-11/40.
9267
9268@item -m45
9269@opindex m45
9270Generate code for a PDP-11/45. This is the default.
9271
9272@item -m10
9273@opindex m10
9274Generate code for a PDP-11/10.
9275
9276@item -mbcopy-builtin
9277@opindex bcopy-builtin
9278Use inline @code{movstrhi} patterns for copying memory. This is the
9279default.
9280
9281@item -mbcopy
9282@opindex mbcopy
9283Do not use inline @code{movstrhi} patterns for copying memory.
9284
9285@item -mint16
9286@itemx -mno-int32
9287@opindex mint16
9288@opindex mno-int32
9289Use 16-bit @code{int}. This is the default.
9290
9291@item -mint32
9292@itemx -mno-int16
9293@opindex mint32
9294@opindex mno-int16
9295Use 32-bit @code{int}.
9296
9297@item -mfloat64
9298@itemx -mno-float32
9299@opindex mfloat64
9300@opindex mno-float32
9301Use 64-bit @code{float}. This is the default.
9302
9303@item -mfloat32
9304@item -mno-float64
9305@opindex mfloat32
9306@opindex mno-float64
9307Use 32-bit @code{float}.
9308
9309@item -mabshi
9310@opindex mabshi
9311Use @code{abshi2} pattern. This is the default.
9312
9313@item -mno-abshi
9314@opindex mno-abshi
9315Do not use @code{abshi2} pattern.
9316
9317@item -mbranch-expensive
9318@opindex mbranch-expensive
9319Pretend that branches are expensive. This is for experimenting with
9320code generation only.
9321
9322@item -mbranch-cheap
9323@opindex mbranch-cheap
9324Do not pretend that branches are expensive. This is the default.
9325
9326@item -msplit
9327@opindex msplit
9328Generate code for a system with split I&D.
9329
9330@item -mno-split
9331@opindex mno-split
9332Generate code for a system without split I&D. This is the default.
9333
9334@item -munix-asm
9335@opindex munix-asm
9336Use Unix assembler syntax. This is the default when configured for
9337@samp{pdp11-*-bsd}.
9338
9339@item -mdec-asm
9340@opindex mdec-asm
9341Use DEC assembler syntax. This is the default when configured for any
9342PDP-11 target other than @samp{pdp11-*-bsd}.
9343@end table
9344
69a0611f
GK
9345@node Xstormy16 Options
9346@subsection Xstormy16 Options
9347@cindex Xstormy16 Options
9348
9349These options are defined for Xstormy16:
9350
9351@table @gcctabopt
9352@item -msim
9353@opindex msim
9354Choose startup files and linker script suitable for the simulator.
9355@end table
9356
03984308
BW
9357@node Xtensa Options
9358@subsection Xtensa Options
9359@cindex Xtensa Options
9360
9361The Xtensa architecture is designed to support many different
9362configurations. The compiler's default options can be set to match a
9363particular Xtensa configuration by copying a configuration file into the
9364GCC sources when building GCC@. The options below may be used to
9365override the default options.
9366
9367@table @gcctabopt
9368@item -mbig-endian
9369@itemx -mlittle-endian
9370@opindex mbig-endian
9371@opindex mlittle-endian
9372Specify big-endian or little-endian byte ordering for the target Xtensa
9373processor.
9374
9375@item -mdensity
9376@itemx -mno-density
9377@opindex mdensity
9378@opindex mno-density
9379Enable or disable use of the optional Xtensa code density instructions.
9380
9381@item -mmac16
9382@itemx -mno-mac16
9383@opindex mmac16
9384@opindex mno-mac16
9385Enable or disable use of the Xtensa MAC16 option. When enabled, GCC
9386will generate MAC16 instructions from standard C code, with the
9387limitation that it will use neither the MR register file nor any
9388instruction that operates on the MR registers. When this option is
9389disabled, GCC will translate 16-bit multiply/accumulate operations to a
9390combination of core instructions and library calls, depending on whether
9391any other multiplier options are enabled.
9392
9393@item -mmul16
9394@itemx -mno-mul16
9395@opindex mmul16
9396@opindex mno-mul16
9397Enable or disable use of the 16-bit integer multiplier option. When
9398enabled, the compiler will generate 16-bit multiply instructions for
9399multiplications of 16 bits or smaller in standard C code. When this
9400option is disabled, the compiler will either use 32-bit multiply or
9401MAC16 instructions if they are available or generate library calls to
9402perform the multiply operations using shifts and adds.
9403
9404@item -mmul32
9405@itemx -mno-mul32
9406@opindex mmul32
9407@opindex mno-mul32
9408Enable or disable use of the 32-bit integer multiplier option. When
9409enabled, the compiler will generate 32-bit multiply instructions for
9410multiplications of 32 bits or smaller in standard C code. When this
9411option is disabled, the compiler will generate library calls to perform
9412the multiply operations using either shifts and adds or 16-bit multiply
9413instructions if they are available.
9414
9415@item -mnsa
9416@itemx -mno-nsa
9417@opindex mnsa
9418@opindex mno-nsa
9419Enable or disable use of the optional normalization shift amount
9420(@code{NSA}) instructions to implement the built-in @code{ffs} function.
9421
9422@item -mminmax
9423@itemx -mno-minmax
9424@opindex mminmax
9425@opindex mno-minmax
9426Enable or disable use of the optional minimum and maximum value
9427instructions.
9428
9429@item -msext
9430@itemx -mno-sext
9431@opindex msext
9432@opindex mno-sext
9433Enable or disable use of the optional sign extend (@code{SEXT})
9434instruction.
9435
9436@item -mbooleans
9437@itemx -mno-booleans
9438@opindex mbooleans
9439@opindex mno-booleans
9440Enable or disable support for the boolean register file used by Xtensa
9441coprocessors. This is not typically useful by itself but may be
9442required for other options that make use of the boolean registers (e.g.,
9443the floating-point option).
9444
9445@item -mhard-float
9446@itemx -msoft-float
9447@opindex mhard-float
9448@opindex msoft-float
9449Enable or disable use of the floating-point option. When enabled, GCC
9450generates floating-point instructions for 32-bit @code{float}
9451operations. When this option is disabled, GCC generates library calls
9452to emulate 32-bit floating-point operations using integer instructions.
9453Regardless of this option, 64-bit @code{double} operations are always
9454emulated with calls to library functions.
9455
9456@item -mfused-madd
9457@itemx -mno-fused-madd
9458@opindex mfused-madd
9459@opindex mno-fused-madd
9460Enable or disable use of fused multiply/add and multiply/subtract
9461instructions in the floating-point option. This has no effect if the
9462floating-point option is not also enabled. Disabling fused multiply/add
9463and multiply/subtract instructions forces the compiler to use separate
9464instructions for the multiply and add/subtract operations. This may be
9465desirable in some cases where strict IEEE 754-compliant results are
9466required: the fused multiply add/subtract instructions do not round the
9467intermediate result, thereby producing results with @emph{more} bits of
9468precision than specified by the IEEE standard. Disabling fused multiply
9469add/subtract instructions also ensures that the program output is not
9470sensitive to the compiler's ability to combine multiply and add/subtract
9471operations.
9472
9473@item -mserialize-volatile
9474@itemx -mno-serialize-volatile
9475@opindex mserialize-volatile
9476@opindex mno-serialize-volatile
9477When this option is enabled, GCC inserts @code{MEMW} instructions before
9478@code{volatile} memory references to guarantee sequential consistency.
9479The default is @option{-mserialize-volatile}. Use
9480@option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
9481
9482@item -mtext-section-literals
9483@itemx -mno-text-section-literals
9484@opindex mtext-section-literals
9485@opindex mno-text-section-literals
9486Control the treatment of literal pools. The default is
9487@option{-mno-text-section-literals}, which places literals in a separate
9488section in the output file. This allows the literal pool to be placed
9489in a data RAM/ROM, and it also allows the linker to combine literal
9490pools from separate object files to remove redundant literals and
9491improve code size. With @option{-mtext-section-literals}, the literals
9492are interspersed in the text section in order to keep them as close as
9493possible to their references. This may be necessary for large assembly
9494files.
9495
9496@item -mtarget-align
9497@itemx -mno-target-align
9498@opindex mtarget-align
9499@opindex mno-target-align
9500When this option is enabled, GCC instructs the assembler to
9501automatically align instructions to reduce branch penalties at the
9502expense of some code density. The assembler attempts to widen density
9503instructions to align branch targets and the instructions following call
9504instructions. If there are not enough preceding safe density
9505instructions to align a target, no widening will be performed. The
9506default is @option{-mtarget-align}. These options do not affect the
9507treatment of auto-aligned instructions like @code{LOOP}, which the
9508assembler will always align, either by widening density instructions or
9509by inserting no-op instructions.
9510
9511@item -mlongcalls
9512@itemx -mno-longcalls
9513@opindex mlongcalls
9514@opindex mno-longcalls
9515When this option is enabled, GCC instructs the assembler to translate
9516direct calls to indirect calls unless it can determine that the target
9517of a direct call is in the range allowed by the call instruction. This
9518translation typically occurs for calls to functions in other source
9519files. Specifically, the assembler translates a direct @code{CALL}
9520instruction into an @code{L32R} followed by a @code{CALLX} instruction.
9521The default is @option{-mno-longcalls}. This option should be used in
9522programs where the call target can potentially be out of range. This
9523option is implemented in the assembler, not the compiler, so the
9524assembly code generated by GCC will still show direct call
9525instructions---look at the disassembled object code to see the actual
9526instructions. Note that the assembler will use an indirect call for
9527every cross-file call, not just those that really will be out of range.
9528@end table
9529
74291a4b
MM
9530@node Code Gen Options
9531@section Options for Code Generation Conventions
9532@cindex code generation conventions
9533@cindex options, code generation
9534@cindex run-time options
9535
9536These machine-independent options control the interface conventions
9537used in code generation.
9538
9539Most of them have both positive and negative forms; the negative form
630d3d5a 9540of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
74291a4b
MM
9541one of the forms is listed---the one which is not the default. You
9542can figure out the other form by either removing @samp{no-} or adding
9543it.
9544
2642624b 9545@table @gcctabopt
956d6950 9546@item -fexceptions
cd3bb277 9547@opindex fexceptions
767094dd 9548Enable exception handling. Generates extra code needed to propagate
f0523f02 9549exceptions. For some targets, this implies GCC will generate frame
c5c76735
JL
9550unwind information for all functions, which can produce significant data
9551size overhead, although it does not affect execution. If you do not
f0523f02 9552specify this option, GCC will enable it by default for languages like
90ecce3e 9553C++ which normally require exception handling, and disable it for
c5c76735
JL
9554languages like C that do not normally require it. However, you may need
9555to enable this option when compiling C code that needs to interoperate
9556properly with exception handlers written in C++. You may also wish to
9557disable this option if you are compiling older C++ programs that don't
9558use exception handling.
956d6950 9559
6cfc0341
RH
9560@item -fnon-call-exceptions
9561@opindex fnon-call-exceptions
9562Generate code that allows trapping instructions to throw exceptions.
9563Note that this requires platform-specific runtime support that does
9564not exist everywhere. Moreover, it only allows @emph{trapping}
e979f9e8 9565instructions to throw exceptions, i.e.@: memory references or floating
6cfc0341
RH
9566point instructions. It does not allow exceptions to be thrown from
9567arbitrary signal handlers such as @code{SIGALRM}.
9568
14a774a9 9569@item -funwind-tables
cd3bb277 9570@opindex funwind-tables
bedc7537 9571Similar to @option{-fexceptions}, except that it will just generate any needed
14a774a9
RK
9572static data, but will not affect the generated code in any other way.
9573You will normally not enable this option; instead, a language processor
9574that needs this handling would enable it on your behalf.
9575
b932f770
JH
9576@item -fasynchronous-unwind-tables
9577@opindex funwind-tables
9578Generate unwind table in dwarf2 format, if supported by target machine. The
9579table is exact at each instruction boundary, so it can be used for stack
9580unwinding from asynchronous events (such as debugger or garbage collector).
9581
74291a4b 9582@item -fpcc-struct-return
cd3bb277 9583@opindex fpcc-struct-return
74291a4b
MM
9584Return ``short'' @code{struct} and @code{union} values in memory like
9585longer ones, rather than in registers. This convention is less
9586efficient, but it has the advantage of allowing intercallability between
0c2d1a2a 9587GCC-compiled files and files compiled with other compilers.
74291a4b
MM
9588
9589The precise convention for returning structures in memory depends
9590on the target configuration macros.
9591
9592Short structures and unions are those whose size and alignment match
9593that of some integer type.
9594
9595@item -freg-struct-return
cd3bb277 9596@opindex freg-struct-return
9c34dbbf
ZW
9597Return @code{struct} and @code{union} values in registers when possible.
9598This is more efficient for small structures than
9599@option{-fpcc-struct-return}.
74291a4b 9600
9c34dbbf 9601If you specify neither @option{-fpcc-struct-return} nor
630d3d5a 9602@option{-freg-struct-return}, GCC defaults to whichever convention is
0c2d1a2a 9603standard for the target. If there is no standard convention, GCC
9c34dbbf
ZW
9604defaults to @option{-fpcc-struct-return}, except on targets where GCC is
9605the principal compiler. In those cases, we can choose the standard, and
9606we chose the more efficient register return alternative.
74291a4b
MM
9607
9608@item -fshort-enums
cd3bb277 9609@opindex fshort-enums
74291a4b
MM
9610Allocate to an @code{enum} type only as many bytes as it needs for the
9611declared range of possible values. Specifically, the @code{enum} type
9612will be equivalent to the smallest integer type which has enough room.
9613
9614@item -fshort-double
cd3bb277 9615@opindex fshort-double
74291a4b
MM
9616Use the same size for @code{double} as for @code{float}.
9617
9618@item -fshared-data
cd3bb277 9619@opindex fshared-data
74291a4b
MM
9620Requests that the data and non-@code{const} variables of this
9621compilation be shared data rather than private data. The distinction
9622makes sense only on certain operating systems, where shared data is
9623shared between processes running the same program, while private data
9624exists in one copy per process.
9625
9626@item -fno-common
cd3bb277 9627@opindex fno-common
90ecce3e 9628In C, allocate even uninitialized global variables in the data section of the
74291a4b
MM
9629object file, rather than generating them as common blocks. This has the
9630effect that if the same variable is declared (without @code{extern}) in
9631two different compilations, you will get an error when you link them.
9632The only reason this might be useful is if you wish to verify that the
9633program will work on other systems which always work this way.
9634
9635@item -fno-ident
cd3bb277 9636@opindex fno-ident
74291a4b
MM
9637Ignore the @samp{#ident} directive.
9638
9639@item -fno-gnu-linker
cd3bb277 9640@opindex fno-gnu-linker
74291a4b
MM
9641Do not output global initializations (such as C++ constructors and
9642destructors) in the form used by the GNU linker (on systems where the GNU
9643linker is the standard method of handling them). Use this option when
9644you want to use a non-GNU linker, which also requires using the
bedc7537
NC
9645@command{collect2} program to make sure the system linker includes
9646constructors and destructors. (@command{collect2} is included in the GCC
9647distribution.) For systems which @emph{must} use @command{collect2}, the
9648compiler driver @command{gcc} is configured to do this automatically.
74291a4b
MM
9649
9650@item -finhibit-size-directive
cd3bb277 9651@opindex finhibit-size-directive
74291a4b
MM
9652Don't output a @code{.size} assembler directive, or anything else that
9653would cause trouble if the function is split in the middle, and the
9654two halves are placed at locations far apart in memory. This option is
9655used when compiling @file{crtstuff.c}; you should not need to use it
9656for anything else.
9657
9658@item -fverbose-asm
cd3bb277 9659@opindex fverbose-asm
74291a4b
MM
9660Put extra commentary information in the generated assembly code to
9661make it more readable. This option is generally only of use to those
9662who actually need to read the generated assembly code (perhaps while
9663debugging the compiler itself).
9664
630d3d5a 9665@option{-fno-verbose-asm}, the default, causes the
74291a4b
MM
9666extra information to be omitted and is useful when comparing two assembler
9667files.
9668
9669@item -fvolatile
cd3bb277 9670@opindex fvolatile
74291a4b
MM
9671Consider all memory references through pointers to be volatile.
9672
9673@item -fvolatile-global
cd3bb277 9674@opindex fvolatile-global
74291a4b 9675Consider all memory references to extern and global data items to
0c2d1a2a 9676be volatile. GCC does not consider static data items to be volatile
ab87f8c8
JL
9677because of this switch.
9678
9679@item -fvolatile-static
cd3bb277 9680@opindex fvolatile-static
ab87f8c8 9681Consider all memory references to static data to be volatile.
74291a4b
MM
9682
9683@item -fpic
cd3bb277 9684@opindex fpic
74291a4b
MM
9685@cindex global offset table
9686@cindex PIC
9687Generate position-independent code (PIC) suitable for use in a shared
9688library, if supported for the target machine. Such code accesses all
161d7b59 9689constant addresses through a global offset table (GOT)@. The dynamic
861bb6c1 9690loader resolves the GOT entries when the program starts (the dynamic
0c2d1a2a 9691loader is not part of GCC; it is part of the operating system). If
861bb6c1
JL
9692the GOT size for the linked executable exceeds a machine-specific
9693maximum size, you get an error message from the linker indicating that
630d3d5a 9694@option{-fpic} does not work; in that case, recompile with @option{-fPIC}
861bb6c1
JL
9695instead. (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
9696on the m68k and RS/6000. The 386 has no such limit.)
74291a4b
MM
9697
9698Position-independent code requires special support, and therefore works
0c2d1a2a 9699only on certain machines. For the 386, GCC supports PIC for System V
74291a4b
MM
9700but not for the Sun 386i. Code generated for the IBM RS/6000 is always
9701position-independent.
9702
74291a4b 9703@item -fPIC
cd3bb277 9704@opindex fPIC
74291a4b
MM
9705If supported for the target machine, emit position-independent code,
9706suitable for dynamic linking and avoiding any limit on the size of the
9707global offset table. This option makes a difference on the m68k, m88k,
9708and the Sparc.
9709
9710Position-independent code requires special support, and therefore works
9711only on certain machines.
9712
9713@item -ffixed-@var{reg}
cd3bb277 9714@opindex ffixed
74291a4b
MM
9715Treat the register named @var{reg} as a fixed register; generated code
9716should never refer to it (except perhaps as a stack pointer, frame
9717pointer or in some other fixed role).
9718
9719@var{reg} must be the name of a register. The register names accepted
9720are machine-specific and are defined in the @code{REGISTER_NAMES}
9721macro in the machine description macro file.
9722
9723This flag does not have a negative form, because it specifies a
9724three-way choice.
9725
9726@item -fcall-used-@var{reg}
cd3bb277 9727@opindex fcall-used
956d6950 9728Treat the register named @var{reg} as an allocable register that is
74291a4b
MM
9729clobbered by function calls. It may be allocated for temporaries or
9730variables that do not live across a call. Functions compiled this way
9731will not save and restore the register @var{reg}.
9732
cb2fdc84
GRK
9733It is an error to used this flag with the frame pointer or stack pointer.
9734Use of this flag for other registers that have fixed pervasive roles in
9735the machine's execution model will produce disastrous results.
74291a4b
MM
9736
9737This flag does not have a negative form, because it specifies a
9738three-way choice.
9739
9740@item -fcall-saved-@var{reg}
cd3bb277 9741@opindex fcall-saved
956d6950 9742Treat the register named @var{reg} as an allocable register saved by
74291a4b
MM
9743functions. It may be allocated even for temporaries or variables that
9744live across a call. Functions compiled this way will save and restore
9745the register @var{reg} if they use it.
9746
cb2fdc84
GRK
9747It is an error to used this flag with the frame pointer or stack pointer.
9748Use of this flag for other registers that have fixed pervasive roles in
9749the machine's execution model will produce disastrous results.
74291a4b
MM
9750
9751A different sort of disaster will result from the use of this flag for
9752a register in which function values may be returned.
9753
9754This flag does not have a negative form, because it specifies a
9755three-way choice.
9756
9757@item -fpack-struct
cd3bb277 9758@opindex fpack-struct
74291a4b
MM
9759Pack all structure members together without holes. Usually you would
9760not want to use this option, since it makes the code suboptimal, and
9761the offsets of structure members won't agree with system libraries.
9762
07417085 9763@item -finstrument-functions
cd3bb277 9764@opindex finstrument-functions
07417085
KR
9765Generate instrumentation calls for entry and exit to functions. Just
9766after function entry and just before function exit, the following
9767profiling functions will be called with the address of the current
9768function and its call site. (On some platforms,
9769@code{__builtin_return_address} does not work beyond the current
9770function, so the call site information may not be available to the
9771profiling functions otherwise.)
9772
9773@example
310668e8
JM
9774void __cyg_profile_func_enter (void *this_fn,
9775 void *call_site);
9776void __cyg_profile_func_exit (void *this_fn,
9777 void *call_site);
07417085
KR
9778@end example
9779
9780The first argument is the address of the start of the current function,
9781which may be looked up exactly in the symbol table.
9782
9783This instrumentation is also done for functions expanded inline in other
9784functions. The profiling calls will indicate where, conceptually, the
9785inline function is entered and exited. This means that addressable
9786versions of such functions must be available. If all your uses of a
9787function are expanded inline, this may mean an additional expansion of
9788code size. If you use @samp{extern inline} in your C code, an
9789addressable version of such functions must be provided. (This is
9790normally the case anyways, but if you get lucky and the optimizer always
9791expands the functions inline, you might have gotten away without
9792providing static copies.)
9793
9794A function may be given the attribute @code{no_instrument_function}, in
9795which case this instrumentation will not be done. This can be used, for
9796example, for the profiling functions listed above, high-priority
9797interrupt routines, and any functions from which the profiling functions
9798cannot safely be called (perhaps signal handlers, if the profiling
9799routines generate output or allocate memory).
9800
861bb6c1 9801@item -fstack-check
cd3bb277 9802@opindex fstack-check
861bb6c1
JL
9803Generate code to verify that you do not go beyond the boundary of the
9804stack. You should specify this flag if you are running in an
9805environment with multiple threads, but only rarely need to specify it in
9806a single-threaded environment since stack overflow is automatically
9807detected on nearly all systems if there is only one stack.
9808
a157febd
GK
9809Note that this switch does not actually cause checking to be done; the
9810operating system must do that. The switch causes generation of code
9811to ensure that the operating system sees the stack being extended.
9812
9813@item -fstack-limit-register=@var{reg}
9814@itemx -fstack-limit-symbol=@var{sym}
9815@itemx -fno-stack-limit
cd3bb277
JM
9816@opindex fstack-limit-register
9817@opindex fstack-limit-symbol
9818@opindex fno-stack-limit
a157febd
GK
9819Generate code to ensure that the stack does not grow beyond a certain value,
9820either the value of a register or the address of a symbol. If the stack
9821would grow beyond the value, a signal is raised. For most targets,
9822the signal is raised before the stack overruns the boundary, so
9823it is possible to catch the signal without taking special precautions.
9824
9c34dbbf
ZW
9825For instance, if the stack starts at absolute address @samp{0x80000000}
9826and grows downwards, you can use the flags
9827@option{-fstack-limit-symbol=__stack_limit} and
9828@option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
9829of 128KB@. Note that this may only work with the GNU linker.
a157febd 9830
e5eb27e5
JL
9831@cindex aliasing of parameters
9832@cindex parameters, aliased
9833@item -fargument-alias
04afd9d6
JL
9834@itemx -fargument-noalias
9835@itemx -fargument-noalias-global
cd3bb277
JM
9836@opindex fargument-alias
9837@opindex fargument-noalias
9838@opindex fargument-noalias-global
e5eb27e5
JL
9839Specify the possible relationships among parameters and between
9840parameters and global data.
9841
630d3d5a 9842@option{-fargument-alias} specifies that arguments (parameters) may
9c34dbbf 9843alias each other and may alias global storage.@*
630d3d5a 9844@option{-fargument-noalias} specifies that arguments do not alias
9c34dbbf 9845each other, but may alias global storage.@*
630d3d5a 9846@option{-fargument-noalias-global} specifies that arguments do not
e5eb27e5
JL
9847alias each other and do not alias global storage.
9848
9849Each language will automatically use whatever option is required by
9850the language standard. You should not need to use these options yourself.
19283265
RH
9851
9852@item -fleading-underscore
cd3bb277 9853@opindex fleading-underscore
695ac33f 9854This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19283265
RH
9855change the way C symbols are represented in the object file. One use
9856is to help link with legacy assembly code.
9857
9858Be warned that you should know what you are doing when invoking this
9859option, and that not all targets provide complete support for it.
74291a4b
MM
9860@end table
9861
ee457005
JM
9862@c man end
9863
74291a4b 9864@node Environment Variables
0c2d1a2a 9865@section Environment Variables Affecting GCC
74291a4b
MM
9866@cindex environment variables
9867
ee457005
JM
9868@c man begin ENVIRONMENT
9869
0c2d1a2a
JB
9870This section describes several environment variables that affect how GCC
9871operates. Some of them work by specifying directories or prefixes to use
767094dd 9872when searching for various kinds of files. Some are used to specify other
46103ab4 9873aspects of the compilation environment.
74291a4b 9874
74291a4b 9875Note that you can also specify places to search using options such as
630d3d5a 9876@option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
74291a4b 9877take precedence over places specified using environment variables, which
161d7b59 9878in turn take precedence over those specified by the configuration of GCC@.
b11cc610
JM
9879@xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
9880GNU Compiler Collection (GCC) Internals}.
74291a4b 9881
bedc7537 9882@table @env
ab87f8c8
JL
9883@item LANG
9884@itemx LC_CTYPE
9885@c @itemx LC_COLLATE
9886@itemx LC_MESSAGES
9887@c @itemx LC_MONETARY
9888@c @itemx LC_NUMERIC
9889@c @itemx LC_TIME
9890@itemx LC_ALL
9891@findex LANG
9892@findex LC_CTYPE
9893@c @findex LC_COLLATE
9894@findex LC_MESSAGES
9895@c @findex LC_MONETARY
9896@c @findex LC_NUMERIC
9897@c @findex LC_TIME
9898@findex LC_ALL
9899@cindex locale
0c2d1a2a
JB
9900These environment variables control the way that GCC uses
9901localization information that allow GCC to work with different
9902national conventions. GCC inspects the locale categories
bedc7537 9903@env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
ab87f8c8
JL
9904so. These locale categories can be set to any value supported by your
9905installation. A typical value is @samp{en_UK} for English in the United
9906Kingdom.
9907
bedc7537 9908The @env{LC_CTYPE} environment variable specifies character
0c2d1a2a 9909classification. GCC uses it to determine the character boundaries in
ab87f8c8
JL
9910a string; this is needed for some multibyte encodings that contain quote
9911and escape characters that would otherwise be interpreted as a string
9912end or escape.
9913
bedc7537 9914The @env{LC_MESSAGES} environment variable specifies the language to
ab87f8c8
JL
9915use in diagnostic messages.
9916
bedc7537
NC
9917If the @env{LC_ALL} environment variable is set, it overrides the value
9918of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
9919and @env{LC_MESSAGES} default to the value of the @env{LANG}
0c2d1a2a 9920environment variable. If none of these variables are set, GCC
ab87f8c8
JL
9921defaults to traditional C English behavior.
9922
74291a4b
MM
9923@item TMPDIR
9924@findex TMPDIR
bedc7537 9925If @env{TMPDIR} is set, it specifies the directory to use for temporary
0c2d1a2a 9926files. GCC uses temporary files to hold the output of one stage of
74291a4b
MM
9927compilation which is to be used as input to the next stage: for example,
9928the output of the preprocessor, which is the input to the compiler
9929proper.
9930
9931@item GCC_EXEC_PREFIX
9932@findex GCC_EXEC_PREFIX
bedc7537 9933If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
74291a4b
MM
9934names of the subprograms executed by the compiler. No slash is added
9935when this prefix is combined with the name of a subprogram, but you can
9936specify a prefix that ends with a slash if you wish.
9937
f0523f02 9938If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
0deb20df
TT
9939an appropriate prefix to use based on the pathname it was invoked with.
9940
0c2d1a2a 9941If GCC cannot find the subprogram using the specified prefix, it
74291a4b
MM
9942tries looking in the usual places for the subprogram.
9943
bedc7537 9944The default value of @env{GCC_EXEC_PREFIX} is
74291a4b
MM
9945@file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
9946of @code{prefix} when you ran the @file{configure} script.
9947
630d3d5a 9948Other prefixes specified with @option{-B} take precedence over this prefix.
74291a4b
MM
9949
9950This prefix is also used for finding files such as @file{crt0.o} that are
9951used for linking.
9952
9953In addition, the prefix is used in an unusual way in finding the
9954directories to search for header files. For each of the standard
9955directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
bedc7537 9956(more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
74291a4b 9957replacing that beginning with the specified prefix to produce an
630d3d5a 9958alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
74291a4b
MM
9959@file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
9960These alternate directories are searched first; the standard directories
9961come next.
9962
9963@item COMPILER_PATH
9964@findex COMPILER_PATH
bedc7537
NC
9965The value of @env{COMPILER_PATH} is a colon-separated list of
9966directories, much like @env{PATH}. GCC tries the directories thus
74291a4b 9967specified when searching for subprograms, if it can't find the
bedc7537 9968subprograms using @env{GCC_EXEC_PREFIX}.
74291a4b
MM
9969
9970@item LIBRARY_PATH
9971@findex LIBRARY_PATH
bedc7537
NC
9972The value of @env{LIBRARY_PATH} is a colon-separated list of
9973directories, much like @env{PATH}. When configured as a native compiler,
0c2d1a2a 9974GCC tries the directories thus specified when searching for special
bedc7537 9975linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
0c2d1a2a 9976using GCC also uses these directories when searching for ordinary
630d3d5a
JM
9977libraries for the @option{-l} option (but directories specified with
9978@option{-L} come first).
74291a4b 9979
56f48ce9
DB
9980@item LANG
9981@findex LANG
9982@cindex locale definition
767094dd 9983This variable is used to pass locale information to the compiler. One way in
56f48ce9
DB
9984which this information is used is to determine the character set to be used
9985when character literals, string literals and comments are parsed in C and C++.
9986When the compiler is configured to allow multibyte characters,
bedc7537 9987the following values for @env{LANG} are recognized:
56f48ce9 9988
2642624b 9989@table @samp
56f48ce9
DB
9990@item C-JIS
9991Recognize JIS characters.
9992@item C-SJIS
9993Recognize SJIS characters.
9994@item C-EUCJP
9995Recognize EUCJP characters.
9996@end table
9997
bedc7537 9998If @env{LANG} is not defined, or if it has some other value, then the
56f48ce9
DB
9999compiler will use mblen and mbtowc as defined by the default locale to
10000recognize and translate multibyte characters.
74291a4b
MM
10001@end table
10002
40adaa27
NB
10003@noindent
10004Some additional environments variables affect the behavior of the
10005preprocessor.
10006
10007@include cppenv.texi
10008
9d86bffc
JM
10009@c man end
10010
74291a4b
MM
10011@node Running Protoize
10012@section Running Protoize
10013
161d7b59 10014The program @code{protoize} is an optional part of GCC@. You can use
c1030c7c 10015it to add prototypes to a program, thus converting the program to ISO
74291a4b
MM
10016C in one respect. The companion program @code{unprotoize} does the
10017reverse: it removes argument types from any prototypes that are found.
10018
10019When you run these programs, you must specify a set of source files as
10020command line arguments. The conversion programs start out by compiling
10021these files to see what functions they define. The information gathered
10022about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
10023
10024After scanning comes actual conversion. The specified files are all
10025eligible to be converted; any files they include (whether sources or
10026just headers) are eligible as well.
10027
10028But not all the eligible files are converted. By default,
10029@code{protoize} and @code{unprotoize} convert only source and header
10030files in the current directory. You can specify additional directories
630d3d5a 10031whose files should be converted with the @option{-d @var{directory}}
74291a4b 10032option. You can also specify particular files to exclude with the
630d3d5a 10033@option{-x @var{file}} option. A file is converted if it is eligible, its
74291a4b
MM
10034directory name matches one of the specified directory names, and its
10035name within the directory has not been excluded.
10036
10037Basic conversion with @code{protoize} consists of rewriting most
10038function definitions and function declarations to specify the types of
10039the arguments. The only ones not rewritten are those for varargs
10040functions.
10041
10042@code{protoize} optionally inserts prototype declarations at the
10043beginning of the source file, to make them available for any calls that
10044precede the function's definition. Or it can insert prototype
10045declarations with block scope in the blocks where undeclared functions
10046are called.
10047
10048Basic conversion with @code{unprotoize} consists of rewriting most
10049function declarations to remove any argument types, and rewriting
c1030c7c 10050function definitions to the old-style pre-ISO form.
74291a4b
MM
10051
10052Both conversion programs print a warning for any function declaration or
10053definition that they can't convert. You can suppress these warnings
630d3d5a 10054with @option{-q}.
74291a4b
MM
10055
10056The output from @code{protoize} or @code{unprotoize} replaces the
10057original source file. The original file is renamed to a name ending
02f52e19 10058with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
a7db8bbb
MK
10059without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
10060for DOS) file already exists, then the source file is simply discarded.
74291a4b 10061
0c2d1a2a 10062@code{protoize} and @code{unprotoize} both depend on GCC itself to
74291a4b 10063scan the program and collect information about the functions it uses.
0c2d1a2a 10064So neither of these programs will work until GCC is installed.
74291a4b
MM
10065
10066Here is a table of the options you can use with @code{protoize} and
10067@code{unprotoize}. Each option works with both programs unless
10068otherwise stated.
10069
10070@table @code
10071@item -B @var{directory}
10072Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
10073usual directory (normally @file{/usr/local/lib}). This file contains
10074prototype information about standard system functions. This option
10075applies only to @code{protoize}.
10076
10077@item -c @var{compilation-options}
10078Use @var{compilation-options} as the options when running @code{gcc} to
630d3d5a 10079produce the @samp{.X} files. The special option @option{-aux-info} is
74291a4b
MM
10080always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
10081
10082Note that the compilation options must be given as a single argument to
10083@code{protoize} or @code{unprotoize}. If you want to specify several
10084@code{gcc} options, you must quote the entire set of compilation options
10085to make them a single word in the shell.
10086
10087There are certain @code{gcc} arguments that you cannot use, because they
630d3d5a
JM
10088would produce the wrong kind of output. These include @option{-g},
10089@option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
74291a4b
MM
10090the @var{compilation-options}, they are ignored.
10091
10092@item -C
a7db8bbb 10093Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
02f52e19 10094systems) instead of @samp{.c}. This is convenient if you are converting
ee77eda5 10095a C program to C++. This option applies only to @code{protoize}.
74291a4b
MM
10096
10097@item -g
10098Add explicit global declarations. This means inserting explicit
10099declarations at the beginning of each source file for each function
10100that is called in the file and was not declared. These declarations
10101precede the first function definition that contains a call to an
10102undeclared function. This option applies only to @code{protoize}.
10103
10104@item -i @var{string}
10105Indent old-style parameter declarations with the string @var{string}.
10106This option applies only to @code{protoize}.
10107
10108@code{unprotoize} converts prototyped function definitions to old-style
10109function definitions, where the arguments are declared between the
10110argument list and the initial @samp{@{}. By default, @code{unprotoize}
10111uses five spaces as the indentation. If you want to indent with just
630d3d5a 10112one space instead, use @option{-i " "}.
74291a4b
MM
10113
10114@item -k
10115Keep the @samp{.X} files. Normally, they are deleted after conversion
10116is finished.
10117
10118@item -l
630d3d5a 10119Add explicit local declarations. @code{protoize} with @option{-l} inserts
74291a4b
MM
10120a prototype declaration for each function in each block which calls the
10121function without any declaration. This option applies only to
10122@code{protoize}.
10123
10124@item -n
10125Make no real changes. This mode just prints information about the conversions
630d3d5a 10126that would have been done without @option{-n}.
74291a4b
MM
10127
10128@item -N
10129Make no @samp{.save} files. The original files are simply deleted.
10130Use this option with caution.
10131
10132@item -p @var{program}
10133Use the program @var{program} as the compiler. Normally, the name
10134@file{gcc} is used.
10135
10136@item -q
10137Work quietly. Most warnings are suppressed.
10138
10139@item -v
630d3d5a 10140Print the version number, just like @option{-v} for @code{gcc}.
74291a4b
MM
10141@end table
10142
10143If you need special compiler options to compile one of your program's
10144source files, then you should generate that file's @samp{.X} file
10145specially, by running @code{gcc} on that source file with the
630d3d5a 10146appropriate options and the option @option{-aux-info}. Then run
74291a4b
MM
10147@code{protoize} on the entire set of files. @code{protoize} will use
10148the existing @samp{.X} file because it is newer than the source file.
10149For example:
10150
10151@example
b1018de6 10152gcc -Dfoo=bar file1.c -aux-info file1.X
74291a4b
MM
10153protoize *.c
10154@end example
10155
10156@noindent
10157You need to include the special files along with the rest in the
10158@code{protoize} command, even though their @samp{.X} files already
10159exist, because otherwise they won't get converted.
10160
10161@xref{Protoize Caveats}, for more information on how to use
10162@code{protoize} successfully.
This page took 2.827549 seconds and 5 git commands to generate.