]> gcc.gnu.org Git - gcc.git/blame - gcc/invoke.texi
Fix method search wrt scope of inner classes to match JLS2.
[gcc.git] / gcc / invoke.texi
CommitLineData
d0a5eb32
RK
1@c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2@c 2000, 2001 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,
21c7361e 91998, 1999, 2000, 2001 Free Software Foundation, Inc.
9d86bffc
JM
10
11Permission is granted to make and distribute verbatim copies of this
12manual provided the copyright notice and this permission notice are
13preserved on all copies.
14
15Permission is granted to copy and distribute modified versions of this
16manual under the conditions for verbatim copying, provided also that the
17entire resulting derived work is distributed under the terms of a
18permission notice identical to this one.
19
20Permission is granted to copy and distribute translations of this manual
21into another language, under the above conditions for modified versions,
22except that this permission notice may be included in translations
23approved by the Free Software Foundation instead of in the original
24English.
25@c man end
26@c Set file name and title for the man page.
27@setfilename gcc
28@settitle GNU project C and C++ compiler
29@c man begin SYNOPSIS
30gcc [@samp{-c}|@samp{-S}|@samp{-E}] [@samp{-std=}@var{standard}]
31 [@samp{-g}] [@samp{-pg}] [@samp{-O}@var{level}]
32 [@samp{-W}@var{warn}...] [@samp{-pedantic}]
33 [@samp{-I}@var{dir}...] [@samp{-L}@var{dir}...]
34 [@samp{-D}@var{macro}[=@var{defn}]...] [@samp{-U}@var{macro}]
35 [@samp{-f}@var{option}...] [@samp{-m}@var{machine-option}...]
36 [@samp{-o} @var{outfile}] @var{infile}...
37
38Only the most useful options are listed here; see below for the
39remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
40@c man end
41@c man begin SEEALSO
42cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
43and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
44@file{ld}, @file{binutils} and @file{gdb}.
45@c man end
2642624b
JM
46@c man begin BUGS
47For instructions on reporting bugs, see
bedc7537 48@w{@uref{http://gcc.gnu.org/bugs.html}}. Use of the @command{gccbug}
2642624b
JM
49script to report bugs is recommended.
50@c man end
51@c man begin AUTHOR
52See the Info entry for @file{gcc}, or
53@w{@uref{http://gcc.gnu.org/thanks.html}}, for contributors to GCC.
54@c man end
9d86bffc
JM
55@end ignore
56
74291a4b 57@node Invoking GCC
0c2d1a2a
JB
58@chapter GCC Command Options
59@cindex GCC command options
74291a4b 60@cindex command options
0c2d1a2a 61@cindex options, GCC command
74291a4b 62
9d86bffc
JM
63@c man begin DESCRIPTION
64
0c2d1a2a 65When you invoke GCC, it normally does preprocessing, compilation,
74291a4b
MM
66assembly and linking. The ``overall options'' allow you to stop this
67process at an intermediate stage. For example, the @samp{-c} option
68says not to run the linker. Then the output consists of object files
69output by the assembler.
70
71Other options are passed on to one stage of processing. Some options
72control the preprocessor and others the compiler itself. Yet other
73options control the assembler and linker; most of these are not
74documented here, since you rarely need to use any of them.
75
76@cindex C compilation options
0c2d1a2a 77Most of the command line options that you can use with GCC are useful
74291a4b
MM
78for C programs; when an option is only useful with another language
79(usually C++), the explanation says so explicitly. If the description
80for a particular option does not mention a source language, you can use
81that option with all supported languages.
82
83@cindex C++ compilation options
84@xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
85options for compiling C++ programs.
86
87@cindex grouping options
88@cindex options, grouping
bedc7537 89The @command{gcc} program accepts options and file names as operands. Many
b192711e 90options have multi-letter names; therefore multiple single-letter options
74291a4b
MM
91may @emph{not} be grouped: @samp{-dr} is very different from @w{@samp{-d
92-r}}.
93
94@cindex order of options
95@cindex options, order
96You can mix options and other arguments. For the most part, the order
97you use doesn't matter. Order does matter when you use several options
98of the same kind; for example, if you specify @samp{-L} more than once,
99the directories are searched in the order specified.
100
101Many options have long names starting with @samp{-f} or with
102@samp{-W}---for example, @samp{-fforce-mem},
103@samp{-fstrength-reduce}, @samp{-Wformat} and so on. Most of
104these have both positive and negative forms; the negative form of
105@samp{-ffoo} would be @samp{-fno-foo}. This manual documents
106only one of these two forms, whichever one is not the default.
107
9d86bffc
JM
108@c man end
109
74291a4b
MM
110@menu
111* Option Summary:: Brief list of all options, without explanations.
112* Overall Options:: Controlling the kind of output:
113 an executable, object files, assembler files,
114 or preprocessed source.
115* Invoking G++:: Compiling C++ programs.
116* C Dialect Options:: Controlling the variant of C language compiled.
117* C++ Dialect Options:: Variations on C++.
764dbbf2
GDR
118* Language Independent Options:: Controlling how diagnostics should be
119 formatted.
74291a4b
MM
120* Warning Options:: How picky should the compiler be?
121* Debugging Options:: Symbol tables, measurements, and debugging dumps.
122* Optimize Options:: How much optimization?
123* Preprocessor Options:: Controlling header files and macro definitions.
124 Also, getting dependency information for Make.
125* Assembler Options:: Passing options to the assembler.
126* Link Options:: Specifying libraries and so on.
127* Directory Options:: Where to find header files and libraries.
128 Where to find the compiler executable files.
a743d340 129* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 130* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
131* Submodel Options:: Specifying minor hardware or convention variations,
132 such as 68010 vs 68020.
133* Code Gen Options:: Specifying conventions for function calls, data layout
134 and register usage.
0c2d1a2a 135* Environment Variables:: Env vars that affect GCC.
74291a4b
MM
136* Running Protoize:: Automatically adding or removing function prototypes.
137@end menu
138
4bc1997b
JM
139@c man begin OPTIONS
140
74291a4b
MM
141@node Option Summary
142@section Option Summary
143
144Here is a summary of all the options, grouped by type. Explanations are
145in the following sections.
146
147@table @emph
148@item Overall Options
149@xref{Overall Options,,Options Controlling the Kind of Output}.
4bc1997b
JM
150@gccoptlist{
151-c -S -E -o @var{file} -pipe -pass-exit-codes -x @var{language} @gol
152-v --target-help --help}
74291a4b
MM
153
154@item C Language Options
155@xref{C Dialect Options,,Options Controlling C Dialect}.
4bc1997b
JM
156@gccoptlist{
157-ansi -std=@var{standard} -fno-asm -fno-builtin @gol
158-fhosted -ffreestanding @gol
159-trigraphs -traditional -traditional-cpp @gol
160-fallow-single-precision -fcond-mismatch @gol
161-fsigned-bitfields -fsigned-char @gol
162-funsigned-bitfields -funsigned-char @gol
163-fwritable-strings -fshort-wchar}
74291a4b
MM
164
165@item C++ Language Options
166@xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
4bc1997b
JM
167@gccoptlist{
168-fno-access-control -fcheck-new -fconserve-space @gol
169-fdollars-in-identifiers -fno-elide-constructors @gol
170-fno-enforce-eh-specs -fexternal-templates @gol
171-falt-external-templates @gol
172-ffor-scope -fno-for-scope -fno-gnu-keywords -fhonor-std @gol
173-fhuge-objects -fno-implicit-templates @gol
174-fno-implicit-inline-templates @gol
175-fno-implement-inlines -fms-extensions @gol
8fa33dfa 176-fno-operator-names @gol
4bc1997b 177-fno-optional-diags -fpermissive @gol
8fa33dfa 178-frepo -fno-rtti -ftemplate-depth-@var{n} @gol
4bc1997b
JM
179-fuse-cxa-atexit -fvtable-thunks -nostdinc++ @gol
180-fno-default-inline -Wctor-dtor-privacy @gol
181-Wnon-virtual-dtor -Wreorder @gol
182-Weffc++ -Wno-deprecated @gol
183-Wno-non-template-friend -Wold-style-cast @gol
184-Woverloaded-virtual -Wno-pmf-conversions @gol
185-Wsign-promo -Wsynth}
74291a4b 186
764dbbf2
GDR
187@item Language Independent Options
188@xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
4bc1997b
JM
189@gccoptlist{
190-fmessage-length=@var{n} @gol
191-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
764dbbf2 192
74291a4b
MM
193@item Warning Options
194@xref{Warning Options,,Options to Request or Suppress Warnings}.
4bc1997b
JM
195@gccoptlist{
196-fsyntax-only -pedantic -pedantic-errors @gol
197-w -W -Wall -Waggregate-return @gol
198-Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
199-Wconversion -Wdisabled-optimization -Werror @gol
200-Wfloat-equal -Wformat -Wformat=2 @gol
201-Wformat-nonliteral -Wformat-security @gol
202-Wid-clash-@var{len} -Wimplicit -Wimplicit-int @gol
203-Wimplicit-function-declaration @gol
204-Werror-implicit-function-declaration @gol
205-Wimport -Winline @gol
206-Wlarger-than-@var{len} -Wlong-long @gol
1f0c3120 207-Wmain -Wmissing-braces -Wmissing-declarations @gol
4bc1997b
JM
208-Wmissing-format-attribute -Wmissing-noreturn @gol
209-Wmultichar -Wno-format-extra-args -Wno-format-y2k @gol
210-Wno-import -Wpacked -Wpadded @gol
211-Wparentheses -Wpointer-arith -Wredundant-decls @gol
212-Wreturn-type -Wsequence-point -Wshadow @gol
213-Wsign-compare -Wswitch -Wsystem-headers @gol
214-Wtrigraphs -Wundef -Wuninitialized @gol
215-Wunknown-pragmas -Wunreachable-code @gol
216-Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
217-Wunused-value -Wunused-variable -Wwrite-strings}
74291a4b 218
fe50c0eb 219@item C-only Warning Options
4bc1997b
JM
220@gccoptlist{
221-Wbad-function-cast -Wmissing-prototypes -Wnested-externs @gol
222-Wstrict-prototypes -Wtraditional}
fe50c0eb 223
74291a4b
MM
224@item Debugging Options
225@xref{Debugging Options,,Options for Debugging Your Program or GCC}.
4bc1997b 226@gccoptlist{
1f0c3120
JM
227-a -ax -d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
228-fdump-unnumbered -fdump-translation-unit=@var{file} @gol
229-fdump-class-layout=@var{file} -fmem-report -fpretend-float @gol
230-fprofile-arcs -ftest-coverage -ftime-report @gol
4bc1997b
JM
231-g -g@var{level} -gcoff -gdwarf -gdwarf-1 -gdwarf-1+ -gdwarf-2 @gol
232-ggdb -gstabs -gstabs+ -gxcoff -gxcoff+ @gol
233-p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
234-print-prog-name=@var{program} -print-search-dirs -Q @gol
235-save-temps -time}
74291a4b
MM
236
237@item Optimization Options
238@xref{Optimize Options,,Options that Control Optimization}.
4bc1997b
JM
239@gccoptlist{
240-falign-functions=@var{n} -falign-jumps=@var{n} @gol
241-falign-labels=@var{n} -falign-loops=@var{n} @gol
242-fbranch-probabilities -fcaller-saves @gol
243-fcse-follow-jumps -fcse-skip-blocks -fdata-sections -fdce @gol
244-fdelayed-branch -fdelete-null-pointer-checks @gol
245-fexpensive-optimizations -ffast-math -ffloat-store @gol
a13d4ebf 246-fforce-addr -fforce-mem -ffunction-sections -fgcse -fgcse-lm -fgcse-sm @gol
4bc1997b
JM
247-finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
248-fkeep-static-consts -fmove-all-movables @gol
249-fno-default-inline -fno-defer-pop @gol
de6c5979 250-fno-function-cse -fno-guess-branch-probability @gol
454d0cc7 251-fno-inline -fno-math-errno -fno-peephole @gol
de6c5979 252-funsafe-math-optimizations -fno-trapping-math @gol
4bc1997b
JM
253-fomit-frame-pointer -foptimize-register-move @gol
254-foptimize-sibling-calls -freduce-all-givs @gol
255-fregmove -frename-registers @gol
256-frerun-cse-after-loop -frerun-loop-opt @gol
257-fschedule-insns -fschedule-insns2 @gol
258-fsingle-precision-constant -fssa @gol
259-fstrength-reduce -fstrict-aliasing -fthread-jumps -ftrapv @gol
260-funroll-all-loops -funroll-loops @gol
3af64fd6 261--param @var{name}=@var{value}
4bc1997b 262-O -O0 -O1 -O2 -O3 -Os}
74291a4b
MM
263
264@item Preprocessor Options
265@xref{Preprocessor Options,,Options Controlling the Preprocessor}.
4bc1997b
JM
266@gccoptlist{
267-$ -A@var{question}=@var{answer} -A-@var{question}@r{[}=@var{answer}@r{]} @gol
268-C -dD -dI -dM -dN @gol
269-D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
270-idirafter @var{dir} @gol
271-include @var{file} -imacros @var{file} @gol
272-iprefix @var{file} -iwithprefix @var{dir} @gol
273-iwithprefixbefore @var{dir} -isystem @var{dir} -isystem-c++ @var{dir} @gol
274-M -MM -MF -MG -MP -MQ -MT -nostdinc -P -remap @gol
371e300b 275-trigraphs -undef -U@var{macro} -Wp\,@var{option}}
74291a4b
MM
276
277@item Assembler Option
278@xref{Assembler Options,,Passing Options to the Assembler}.
4bc1997b 279@gccoptlist{
371e300b 280-Wa\,@var{option}}
74291a4b
MM
281
282@item Linker Options
283@xref{Link Options,,Options for Linking}.
4bc1997b
JM
284@gccoptlist{
285@var{object-file-name} -l@var{library} @gol
286-nostartfiles -nodefaultlibs -nostdlib @gol
287-s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
371e300b 288-Wl\,@var{option} -Xlinker @var{option} @gol
4bc1997b 289-u @var{symbol}}
74291a4b
MM
290
291@item Directory Options
292@xref{Directory Options,,Options for Directory Search}.
4bc1997b
JM
293@gccoptlist{
294-B@var{prefix} -I@var{dir} -I- -L@var{dir} -specs=@var{file}}
74291a4b
MM
295
296@item Target Options
297@c I wrote this xref this way to avoid overfull hbox. -- rms
298@xref{Target Options}.
4bc1997b
JM
299@gccoptlist{
300-b @var{machine} -V @var{version}}
74291a4b
MM
301
302@item Machine Dependent Options
303@xref{Submodel Options,,Hardware Models and Configurations}.
74291a4b 304@emph{M680x0 Options}
4bc1997b
JM
305@gccoptlist{
306-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
307-m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
308-mfpa -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
309-malign-int -mstrict-align}
74291a4b 310
2856c3e3 311@emph{M68hc1x Options}
4bc1997b
JM
312@gccoptlist{
313-m6811 -m6812 -m68hc11 -m68hc12 @gol
314-mauto-incdec -mshort -msoft-reg-count=@var{count}}
2856c3e3 315
74291a4b 316@emph{VAX Options}
4bc1997b
JM
317@gccoptlist{
318-mg -mgnu -munix}
74291a4b
MM
319
320@emph{SPARC Options}
4bc1997b
JM
321@gccoptlist{
322-mcpu=@var{cpu type} @gol
323-mtune=@var{cpu type} @gol
324-mcmodel=@var{code model} @gol
325-m32 -m64 @gol
326-mapp-regs -mbroken-saverestore -mcypress @gol
327-mepilogue -mfaster-structs -mflat @gol
328-mfpu -mhard-float -mhard-quad-float @gol
329-mimpure-text -mlive-g0 -mno-app-regs @gol
330-mno-epilogue -mno-faster-structs -mno-flat -mno-fpu @gol
331-mno-impure-text -mno-stack-bias -mno-unaligned-doubles @gol
332-msoft-float -msoft-quad-float -msparclite -mstack-bias @gol
333-msupersparc -munaligned-doubles -mv8}
74291a4b
MM
334
335@emph{Convex Options}
4bc1997b
JM
336@gccoptlist{
337-mc1 -mc2 -mc32 -mc34 -mc38 @gol
338-margcount -mnoargcount @gol
339-mlong32 -mlong64 @gol
340-mvolatile-cache -mvolatile-nocache}
74291a4b
MM
341
342@emph{AMD29K Options}
4bc1997b
JM
343@gccoptlist{
344-m29000 -m29050 -mbw -mnbw -mdw -mndw @gol
345-mlarge -mnormal -msmall @gol
346-mkernel-registers -mno-reuse-arg-regs @gol
347-mno-stack-check -mno-storem-bug @gol
348-mreuse-arg-regs -msoft-float -mstack-check @gol
349-mstorem-bug -muser-registers}
74291a4b
MM
350
351@emph{ARM Options}
4bc1997b
JM
352@gccoptlist{
353-mapcs-frame -mno-apcs-frame @gol
354-mapcs-26 -mapcs-32 @gol
355-mapcs-stack-check -mno-apcs-stack-check @gol
356-mapcs-float -mno-apcs-float @gol
357-mapcs-reentrant -mno-apcs-reentrant @gol
358-msched-prolog -mno-sched-prolog @gol
359-mlittle-endian -mbig-endian -mwords-little-endian @gol
360-malignment-traps -mno-alignment-traps @gol
361-msoft-float -mhard-float -mfpe @gol
362-mthumb-interwork -mno-thumb-interwork @gol
363-mcpu= -march= -mfpe= @gol
364-mstructure-size-boundary= @gol
365-mbsd -mxopen -mno-symrename @gol
366-mabort-on-noreturn @gol
367-mlong-calls -mno-long-calls @gol
368-mnop-fun-dllimport -mno-nop-fun-dllimport @gol
369-msingle-pic-base -mno-single-pic-base @gol
370-mpic-register=}
157a620e
NC
371
372@emph{Thumb Options}
4bc1997b
JM
373@gccoptlist{
374-mtpcs-frame -mno-tpcs-frame @gol
375-mtpcs-leaf-frame -mno-tpcs-leaf-frame @gol
376-mlittle-endian -mbig-endian @gol
377-mthumb-interwork -mno-thumb-interwork @gol
378-mstructure-size-boundary= @gol
379-mnop-fun-dllimport -mno-nop-fun-dllimport @gol
380-mcallee-super-interworking -mno-callee-super-interworking @gol
381-mcaller-super-interworking -mno-caller-super-interworking @gol
382-msingle-pic-base -mno-single-pic-base @gol
383-mpic-register=}
74291a4b 384
ecff22ab 385@emph{MN10200 Options}
4bc1997b
JM
386@gccoptlist{
387-mrelax}
ecff22ab 388
6d6d0fa0 389@emph{MN10300 Options}
4bc1997b
JM
390@gccoptlist{
391-mmult-bug @gol
392-mno-mult-bug @gol
393-mam33 @gol
394-mno-am33 @gol
395-mrelax}
6d6d0fa0 396
861bb6c1 397@emph{M32R/D Options}
4bc1997b
JM
398@gccoptlist{
399-mcode-model=@var{model type} -msdata=@var{sdata type} @gol
400-G @var{num}}
861bb6c1 401
74291a4b 402@emph{M88K Options}
4bc1997b
JM
403@gccoptlist{
404-m88000 -m88100 -m88110 -mbig-pic @gol
405-mcheck-zero-division -mhandle-large-shift @gol
406-midentify-revision -mno-check-zero-division @gol
407-mno-ocs-debug-info -mno-ocs-frame-position @gol
408-mno-optimize-arg-area -mno-serialize-volatile @gol
409-mno-underscores -mocs-debug-info @gol
410-mocs-frame-position -moptimize-arg-area @gol
411-mserialize-volatile -mshort-data-@var{num} -msvr3 @gol
412-msvr4 -mtrap-large-shift -muse-div-instruction @gol
413-mversion-03.00 -mwarn-passed-structs}
74291a4b
MM
414
415@emph{RS/6000 and PowerPC Options}
4bc1997b
JM
416@gccoptlist{
417-mcpu=@var{cpu type} @gol
418-mtune=@var{cpu type} @gol
419-mpower -mno-power -mpower2 -mno-power2 @gol
420-mpowerpc -mpowerpc64 -mno-powerpc @gol
421-mpowerpc-gpopt -mno-powerpc-gpopt @gol
422-mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
423-mnew-mnemonics -mold-mnemonics @gol
424-mfull-toc -mminimal-toc -mno-fop-in-toc -mno-sum-in-toc @gol
425-m64 -m32 -mxl-call -mno-xl-call -mthreads -mpe @gol
426-msoft-float -mhard-float -mmultiple -mno-multiple @gol
427-mstring -mno-string -mupdate -mno-update @gol
428-mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
429-mstrict-align -mno-strict-align -mrelocatable @gol
430-mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
431-mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
432-mcall-aix -mcall-sysv -mprototype -mno-prototype @gol
433-msim -mmvme -mads -myellowknife -memb -msdata @gol
434-msdata=@var{opt} -mvxworks -G @var{num}}
74291a4b
MM
435
436@emph{RT Options}
4bc1997b
JM
437@gccoptlist{
438-mcall-lib-mul -mfp-arg-in-fpregs -mfp-arg-in-gregs @gol
439-mfull-fp-blocks -mhc-struct-return -min-line-mul @gol
440-mminimum-fp-blocks -mnohc-struct-return}
74291a4b
MM
441
442@emph{MIPS Options}
4bc1997b 443@gccoptlist{
84a0e7b8 444-mabicalls -mcpu=@var{cpu type}
4bc1997b
JM
445-membedded-data -muninit-const-in-rodata @gol
446-membedded-pic -mfp32 -mfp64 -mgas -mgp32 -mgp64 @gol
447-mgpopt -mhalf-pic -mhard-float -mint64 -mips1 @gol
448-mips2 -mips3 -mips4 -mlong64 -mlong32 -mlong-calls -mmemcpy @gol
449-mmips-as -mmips-tfile -mno-abicalls @gol
450-mno-embedded-data -mno-uninit-const-in-rodata -mno-embedded-pic @gol
451-mno-gpopt -mno-long-calls @gol
452-mno-memcpy -mno-mips-tfile -mno-rnames -mno-stats @gol
453-mrnames -msoft-float @gol
454-m4650 -msingle-float -mmad @gol
455-mstats -EL -EB -G @var{num} -nocpp @gol
456-mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
457-mfix7000 -mno-crt0}
74291a4b
MM
458
459@emph{i386 Options}
4bc1997b
JM
460@gccoptlist{
461-mcpu=@var{cpu type} -march=@var{cpu type} @gol
462-mintel-syntax -mieee-fp -mno-fancy-math-387 @gol
463-mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
464-mno-wide-multiply -mrtd -malign-double @gol
4bc1997b
JM
465-malign-jumps=@var{num} -malign-loops=@var{num} @gol
466-malign-functions=@var{num} -mpreferred-stack-boundary=@var{num} @gol
467-mthreads -mno-align-stringops -minline-all-stringops @gol
468-mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
2ccc6d5b 469-m96bit-long-double -mregparm=@var{num}}
74291a4b
MM
470
471@emph{HPPA Options}
4bc1997b
JM
472@gccoptlist{
473-march=@var{architecture type} @gol
474-mbig-switch -mdisable-fpregs -mdisable-indexing @gol
475-mfast-indirect-calls -mgas -mjump-in-delay @gol
476-mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
477-mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
478-mno-jump-in-delay -mno-long-load-store @gol
479-mno-portable-runtime -mno-soft-float @gol
480-mno-space-regs -msoft-float -mpa-risc-1-0 @gol
481-mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
482-mschedule=@var{cpu type} -mspace-regs}
74291a4b
MM
483
484@emph{Intel 960 Options}
4bc1997b
JM
485@gccoptlist{
486-m@var{cpu type} -masm-compat -mclean-linkage @gol
487-mcode-align -mcomplex-addr -mleaf-procedures @gol
488-mic-compat -mic2.0-compat -mic3.0-compat @gol
489-mintel-asm -mno-clean-linkage -mno-code-align @gol
490-mno-complex-addr -mno-leaf-procedures @gol
491-mno-old-align -mno-strict-align -mno-tail-call @gol
492-mnumerics -mold-align -msoft-float -mstrict-align @gol
493-mtail-call}
74291a4b
MM
494
495@emph{DEC Alpha Options}
4bc1997b
JM
496@gccoptlist{
497-mfp-regs -mno-fp-regs -mno-soft-float -msoft-float @gol
498-malpha-as -mgas @gol
499-mieee -mieee-with-inexact -mieee-conformant @gol
500-mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
501-mtrap-precision=@var{mode} -mbuild-constants @gol
502-mcpu=@var{cpu type} @gol
503-mbwx -mno-bwx -mcix -mno-cix -mmax -mno-max @gol
504-mmemory-latency=@var{time}}
74291a4b
MM
505
506@emph{Clipper Options}
4bc1997b
JM
507@gccoptlist{
508-mc300 -mc400}
74291a4b
MM
509
510@emph{H8/300 Options}
4bc1997b
JM
511@gccoptlist{
512-mrelax -mh -ms -mint32 -malign-300}
74291a4b
MM
513
514@emph{SH Options}
4bc1997b
JM
515@gccoptlist{
516-m1 -m2 -m3 -m3e @gol
517-m4-nofpu -m4-single-only -m4-single -m4 @gol
518-mb -ml -mdalign -mrelax @gol
519-mbigtable -mfmovd -mhitachi -mnomacsave @gol
520-misize -mpadstruct -mspace @gol
1a66cd67 521-mprefergot
4bc1997b 522-musermode}
74291a4b
MM
523
524@emph{System V Options}
4bc1997b 525@gccoptlist{
371e300b 526-Qy -Qn -YP\,@var{paths} -Ym\,@var{dir}}
74291a4b 527
56b2d7a7 528@emph{ARC Options}
4bc1997b
JM
529@gccoptlist{
530-EB -EL @gol
531-mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text section} @gol
532-mdata=@var{data section} -mrodata=@var{readonly data section}}
56b2d7a7 533
282a61e6 534@emph{TMS320C3x/C4x Options}
4bc1997b
JM
535@gccoptlist{
536-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
537-mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
538-mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
539-mparallel-insns -mparallel-mpy -mpreserve-float}
282a61e6 540
f84271d9 541@emph{V850 Options}
4bc1997b
JM
542@gccoptlist{
543-mlong-calls -mno-long-calls -mep -mno-ep @gol
544-mprolog-function -mno-prolog-function -mspace @gol
545-mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
546-mv850 -mbig-switch}
83575957
ID
547
548@emph{NS32K Options}
4bc1997b
JM
549@gccoptlist{
550-m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add @gol
551-msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb @gol
552-mbitfield -mnobitfield -mhimem -mnohimem}
789a3090 553
052a4b28 554@emph{AVR Options}
4bc1997b
JM
555@gccoptlist{
556-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
557-mcall-prologues -mno-tablejump -mtiny-stack}
052a4b28 558
789a3090 559@emph{MCore Options}
4bc1997b 560@gccoptlist{
371e300b 561-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
4bc1997b
JM
562-mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
563-m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
564-mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
565-mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
f84271d9 566
df6194d4
JW
567@emph{IA-64 Options}
568@gccoptlist{
569-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
570-mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
571-mconstant-gp -mauto-pic -minline-divide-min-latency @gol
572-minline-divide-max-throughput -mno-dwarf2-asm @gol
573-mfixed-range=@var{register range}}
574
74291a4b
MM
575@item Code Generation Options
576@xref{Code Gen Options,,Options for Code Generation Conventions}.
4bc1997b
JM
577@gccoptlist{
578-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
579-fexceptions -funwind-tables -ffixed-@var{reg} @gol
580-finhibit-size-directive -finstrument-functions @gol
581-fcheck-memory-usage -fprefix-function-name @gol
582-fno-common -fno-ident -fno-gnu-linker @gol
583-fpcc-struct-return -fpic -fPIC @gol
584-freg-struct-return -fshared-data -fshort-enums @gol
585-fshort-double -fvolatile -fvolatile-global -fvolatile-static @gol
586-fverbose-asm -fpack-struct -fstack-check @gol
587-fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
588-fargument-alias -fargument-noalias @gol
589-fargument-noalias-global @gol
590-fleading-underscore}
74291a4b
MM
591@end table
592
593@menu
594* Overall Options:: Controlling the kind of output:
595 an executable, object files, assembler files,
596 or preprocessed source.
597* C Dialect Options:: Controlling the variant of C language compiled.
598* C++ Dialect Options:: Variations on C++.
764dbbf2
GDR
599* Language Independent Options:: Controlling how diagnostics should be
600 formatted.
74291a4b
MM
601* Warning Options:: How picky should the compiler be?
602* Debugging Options:: Symbol tables, measurements, and debugging dumps.
603* Optimize Options:: How much optimization?
604* Preprocessor Options:: Controlling header files and macro definitions.
605 Also, getting dependency information for Make.
606* Assembler Options:: Passing options to the assembler.
607* Link Options:: Specifying libraries and so on.
608* Directory Options:: Where to find header files and libraries.
609 Where to find the compiler executable files.
a743d340 610* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 611* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
612@end menu
613
614@node Overall Options
615@section Options Controlling the Kind of Output
616
617Compilation can involve up to four stages: preprocessing, compilation
618proper, assembly and linking, always in that order. The first three
619stages apply to an individual source file, and end by producing an
620object file; linking combines all the object files (those newly
621compiled, and those specified as input) into an executable file.
622
623@cindex file name suffix
624For any given input file, the file name suffix determines what kind of
625compilation is done:
626
2642624b 627@table @gcctabopt
74291a4b
MM
628@item @var{file}.c
629C source code which must be preprocessed.
630
631@item @var{file}.i
632C source code which should not be preprocessed.
633
634@item @var{file}.ii
635C++ source code which should not be preprocessed.
636
637@item @var{file}.m
638Objective-C source code. Note that you must link with the library
639@file{libobjc.a} to make an Objective-C program work.
640
b9265ec1
JM
641@item @var{file}.mi
642Objective-C source code which should not be preprocessed.
643
74291a4b
MM
644@item @var{file}.h
645C header file (not to be compiled or linked).
646
647@item @var{file}.cc
b9265ec1 648@itemx @var{file}.cp
74291a4b
MM
649@itemx @var{file}.cxx
650@itemx @var{file}.cpp
b9265ec1 651@itemx @var{file}.c++
74291a4b
MM
652@itemx @var{file}.C
653C++ source code which must be preprocessed. Note that in @samp{.cxx},
654the last two letters must both be literally @samp{x}. Likewise,
655@samp{.C} refers to a literal capital C.
656
b9265ec1
JM
657@item @var{file}.f
658@itemx @var{file}.for
659@itemx @var{file}.FOR
660Fortran source code which should not be preprocessed.
661
662@item @var{file}.F
663@itemx @var{file}.fpp
664@itemx @var{file}.FPP
665Fortran source code which must be preprocessed (with the traditional
666preprocessor).
667
668@item @var{file}.r
669Fortran source code which must be preprocessed with a RATFOR
670preprocessor (not included with GCC).
671
672@xref{Overall Options,,Options Controlling the Kind of Output, g77,
673Using and Porting GNU Fortran}, for more details of the handling of
674Fortran input files.
675
676@c FIXME: Descriptions of Java file types.
677@c @var{file}.java
678@c @var{file}.class
679@c @var{file}.zip
680@c @var{file}.jar
681
682@c GCC also knows about some suffixes for languages not yet included:
683@c Ada:
684@c @var{file}.ads
685@c @var{file}.adb
686@c @var{file}.ada
687@c Pascal:
688@c @var{file}.p
689@c @var{file}.pas
690
691@item @var{file}.ch
692@itemx @var{file}.chi
693CHILL source code (preprocessed with the traditional preprocessor).
694
74291a4b
MM
695@item @var{file}.s
696Assembler code.
697
698@item @var{file}.S
699Assembler code which must be preprocessed.
700
701@item @var{other}
702An object file to be fed straight into linking.
703Any file name with no recognized suffix is treated this way.
704@end table
705
706You can specify the input language explicitly with the @samp{-x} option:
707
2642624b 708@table @gcctabopt
74291a4b
MM
709@item -x @var{language}
710Specify explicitly the @var{language} for the following input files
711(rather than letting the compiler choose a default based on the file
712name suffix). This option applies to all following input files until
713the next @samp{-x} option. Possible values for @var{language} are:
714@example
b9265ec1
JM
715c c-header cpp-output
716c++ c++-cpp-output
717objective-c objc-cpp-output
74291a4b 718assembler assembler-with-cpp
b9265ec1
JM
719f77 f77-cpp-input ratfor
720java chill
74291a4b 721@end example
b9265ec1 722@c Also f77-version, for internal use only.
74291a4b
MM
723
724@item -x none
725Turn off any specification of a language, so that subsequent files are
726handled according to their file name suffixes (as they are if @samp{-x}
727has not been used at all).
14a774a9
RK
728
729@item -pass-exit-codes
bedc7537 730Normally the @command{gcc} program will exit with the code of 1 if any
14a774a9 731phase of the compiler returns a non-success return code. If you specify
bedc7537 732@samp{-pass-exit-codes}, the @command{gcc} program will instead return with
14a774a9
RK
733numerically highest error produced by any phase that returned an error
734indication.
74291a4b
MM
735@end table
736
737If you only want some of the stages of compilation, you can use
bedc7537 738@samp{-x} (or filename suffixes) to tell @command{gcc} where to start, and
74291a4b 739one of the options @samp{-c}, @samp{-S}, or @samp{-E} to say where
bedc7537
NC
740@command{gcc} is to stop. Note that some combinations (for example,
741@samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
74291a4b 742
2642624b 743@table @gcctabopt
74291a4b
MM
744@item -c
745Compile or assemble the source files, but do not link. The linking
746stage simply is not done. The ultimate output is in the form of an
747object file for each source file.
748
749By default, the object file name for a source file is made by replacing
750the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
751
752Unrecognized input files, not requiring compilation or assembly, are
753ignored.
754
755@item -S
756Stop after the stage of compilation proper; do not assemble. The output
757is in the form of an assembler code file for each non-assembler input
758file specified.
759
760By default, the assembler file name for a source file is made by
761replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
762
763Input files that don't require compilation are ignored.
764
765@item -E
766Stop after the preprocessing stage; do not run the compiler proper. The
767output is in the form of preprocessed source code, which is sent to the
768standard output.
769
770Input files which don't require preprocessing are ignored.
771
772@cindex output file option
773@item -o @var{file}
774Place output in file @var{file}. This applies regardless to whatever
775sort of output is being produced, whether it be an executable file,
776an object file, an assembler file or preprocessed C code.
777
778Since only one output file can be specified, it does not make sense to
779use @samp{-o} when compiling more than one input file, unless you are
780producing an executable file as output.
781
782If @samp{-o} is not specified, the default is to put an executable file
783in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
784@file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
785all preprocessed C source on standard output.@refill
786
787@item -v
788Print (on standard error output) the commands executed to run the stages
789of compilation. Also print the version number of the compiler driver
790program and of the preprocessor and the compiler proper.
791
792@item -pipe
793Use pipes rather than temporary files for communication between the
794various stages of compilation. This fails to work on some systems where
795the assembler is unable to read from a pipe; but the GNU assembler has
796no trouble.
844642e6
NC
797
798@item --help
799Print (on the standard output) a description of the command line options
bedc7537
NC
800understood by @command{gcc}. If the @option{-v} option is also specified
801then @option{--help} will also be passed on to the various processes
802invoked by @command{gcc}, so that they can display the command line options
803they accept. If the @option{-W} option is also specified then command
844642e6
NC
804line options which have no documentation associated with them will also
805be displayed.
10501d8f
CC
806
807@item --target-help
808Print (on the standard output) a description of target specific command
809line options for each tool.
74291a4b
MM
810@end table
811
812@node Invoking G++
813@section Compiling C++ Programs
814
815@cindex suffixes for C++ source
816@cindex C++ source file suffixes
817C++ source files conventionally use one of the suffixes @samp{.C},
bba975d4 818@samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
0c2d1a2a 819preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
bba975d4
JM
820files with these names and compiles them as C++ programs even if you
821call the compiler the same way as for compiling C programs (usually with
bedc7537 822the name @command{gcc}).
74291a4b
MM
823
824@findex g++
825@findex c++
826However, C++ programs often require class libraries as well as a
827compiler that understands the C++ language---and under some
828circumstances, you might want to compile programs from standard input,
829or otherwise without a suffix that flags them as C++ programs.
bedc7537 830@command{g++} is a program that calls GCC with the default language
e5e809f4 831set to C++, and automatically specifies linking against the C++
bedc7537
NC
832library. On many systems, @command{g++} is also
833installed with the name @command{c++}.
74291a4b 834
bedc7537 835@cindex invoking @command{g++}
74291a4b
MM
836When you compile C++ programs, you may specify many of the same
837command-line options that you use for compiling programs in any
838language; or command-line options meaningful for C and related
839languages; or options that are meaningful only for C++ programs.
840@xref{C Dialect Options,,Options Controlling C Dialect}, for
841explanations of options for languages related to C.
842@xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
843explanations of options that are meaningful only for C++ programs.
844
845@node C Dialect Options
846@section Options Controlling C Dialect
847@cindex dialect options
848@cindex language dialect options
849@cindex options, dialect
850
851The following options control the dialect of C (or languages derived
852from C, such as C++ and Objective C) that the compiler accepts:
853
2642624b 854@table @gcctabopt
74291a4b 855@cindex ANSI support
c1030c7c 856@cindex ISO support
74291a4b 857@item -ansi
c1030c7c 858In C mode, support all ISO C89 programs. In C++ mode,
775afb25 859remove GNU extensions that conflict with ISO C++.
74291a4b 860
c1030c7c 861This turns off certain features of GCC that are incompatible with ISO
775afb25 862C (when compiling C code), or of standard C++ (when compiling C++ code),
0c2d1a2a 863such as the @code{asm} and @code{typeof} keywords, and
74291a4b
MM
864predefined macros such as @code{unix} and @code{vax} that identify the
865type of system you are using. It also enables the undesirable and
c1030c7c 866rarely used ISO trigraph feature. For the C compiler,
0c2d1a2a 867it disables recognition of C++ style @samp{//} comments as well as
775afb25 868the @code{inline} keyword.
74291a4b
MM
869
870The alternate keywords @code{__asm__}, @code{__extension__},
871@code{__inline__} and @code{__typeof__} continue to work despite
c1030c7c 872@samp{-ansi}. You would not want to use them in an ISO C program, of
74291a4b
MM
873course, but it is useful to put them in header files that might be included
874in compilations done with @samp{-ansi}. Alternate predefined macros
875such as @code{__unix__} and @code{__vax__} are also available, with or
876without @samp{-ansi}.
877
c1030c7c 878The @samp{-ansi} option does not cause non-ISO programs to be
74291a4b
MM
879rejected gratuitously. For that, @samp{-pedantic} is required in
880addition to @samp{-ansi}. @xref{Warning Options}.
881
882The macro @code{__STRICT_ANSI__} is predefined when the @samp{-ansi}
883option is used. Some header files may notice this macro and refrain
884from declaring certain functions or defining certain macros that the
c1030c7c 885ISO standard doesn't call for; this is to avoid interfering with any
74291a4b
MM
886programs that might use these names for other things.
887
01702459
JM
888Functions which would normally be builtin but do not have semantics
889defined by ISO C (such as @code{alloca} and @code{ffs}) are not builtin
890functions with @samp{-ansi} is used. @xref{Other Builtins,,Other
891built-in functions provided by GNU CC}, for details of the functions
892affected.
74291a4b 893
49419c8f 894@item -std=
3043b30e
ML
895Determine the language standard. A value for this option must be provided;
896possible values are
3932261a 897
ee457005 898@table @samp
3043b30e 899@item iso9899:1990
bedc7537 900Same as @option{-ansi}
3043b30e
ML
901
902@item iso9899:199409
903ISO C as modified in amend. 1
904
49419c8f
JM
905@item iso9899:1999
906ISO C99. Note that this standard is not yet fully supported; see
2642624b 907@w{@uref{http://gcc.gnu.org/c99status.html}} for more information.
3043b30e
ML
908
909@item c89
bedc7537 910same as @option{-std=iso9899:1990}
3043b30e 911
49419c8f 912@item c99
bedc7537 913same as @option{-std=iso9899:1999}
3043b30e
ML
914
915@item gnu89
916default, iso9899:1990 + gnu extensions
917
49419c8f
JM
918@item gnu99
919iso9899:1999 + gnu extensions
920
921@item iso9899:199x
bedc7537 922same as @option{-std=iso9899:1999}, deprecated
49419c8f
JM
923
924@item c9x
bedc7537 925same as @option{-std=iso9899:1999}, deprecated
49419c8f 926
3043b30e 927@item gnu9x
bedc7537 928same as @option{-std=gnu99}, deprecated
49419c8f 929
ee457005 930@end table
3043b30e
ML
931
932Even when this option is not specified, you can still use some of the
933features of newer standards in so far as they do not conflict with
934previous C standards. For example, you may use @code{__restrict__} even
bedc7537 935when @option{-std=c99} is not specified.
3932261a 936
5490d604
JM
937The @option{-std} options specifying some version of ISO C have the same
938effects as @option{-ansi}, except that features that were not in ISO C89
939but are in the specified version (for example, @samp{//} comments and
940the @code{inline} keyword in ISO C99) are not disabled.
941
c1030c7c
JM
942@xref{Standards,,Language Standards Supported by GCC}, for details of
943these standard versions.
944
74291a4b
MM
945@item -fno-asm
946Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
947keyword, so that code can use these words as identifiers. You can use
948the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
949instead. @samp{-ansi} implies @samp{-fno-asm}.
950
951In C++, this switch only affects the @code{typeof} keyword, since
952@code{asm} and @code{inline} are standard keywords. You may want to
5490d604
JM
953use the @samp{-fno-gnu-keywords} flag instead, which has the same
954effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
955switch only affects the @code{asm} and @code{typeof} keywords, since
956@code{inline} is a standard keyword in ISO C99.
74291a4b
MM
957
958@item -fno-builtin
959@cindex builtin functions
01702459
JM
960Don't recognize builtin functions that do not begin with
961@samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
962functions provided by GNU CC}, for details of the functions affected,
5490d604
JM
963including those which are not builtin functions when @option{-ansi} or
964@option{-std} options for strict ISO C conformance are used because they
965do not have an ISO standard meaning.
74291a4b
MM
966
967GCC normally generates special code to handle certain builtin functions
968more efficiently; for instance, calls to @code{alloca} may become single
969instructions that adjust the stack directly, and calls to @code{memcpy}
970may become inline copy loops. The resulting code is often both smaller
971and faster, but since the function calls no longer appear as such, you
972cannot set a breakpoint on those calls, nor can you change the behavior
973of the functions by linking with a different library.
974
861bb6c1
JL
975@item -fhosted
976@cindex hosted environment
977
978Assert that compilation takes place in a hosted environment. This implies
979@samp{-fbuiltin}. A hosted environment is one in which the
980entire standard library is available, and in which @code{main} has a return
981type of @code{int}. Examples are nearly everything except a kernel.
982This is equivalent to @samp{-fno-freestanding}.
983
984@item -ffreestanding
985@cindex hosted environment
986
987Assert that compilation takes place in a freestanding environment. This
988implies @samp{-fno-builtin}. A freestanding environment
989is one in which the standard library may not exist, and program startup may
990not necessarily be at @code{main}. The most obvious example is an OS kernel.
991This is equivalent to @samp{-fno-hosted}.
992
c1030c7c
JM
993@xref{Standards,,Language Standards Supported by GCC}, for details of
994freestanding and hosted environments.
995
74291a4b 996@item -trigraphs
c1030c7c 997Support ISO C trigraphs. You don't want to know about this
5490d604
JM
998brain-damage. The @option{-ansi} option (and @option{-std} options for
999strict ISO C conformance) implies @option{-trigraphs}.
74291a4b
MM
1000
1001@cindex traditional C language
1002@cindex C language, traditional
1003@item -traditional
1004Attempt to support some aspects of traditional C compilers.
1005Specifically:
1006
1007@itemize @bullet
1008@item
1009All @code{extern} declarations take effect globally even if they
1010are written inside of a function definition. This includes implicit
1011declarations of functions.
1012
1013@item
1014The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1015and @code{volatile} are not recognized. (You can still use the
1016alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1017so on.)
1018
1019@item
1020Comparisons between pointers and integers are always allowed.
1021
1022@item
1023Integer types @code{unsigned short} and @code{unsigned char} promote
1024to @code{unsigned int}.
1025
1026@item
1027Out-of-range floating point literals are not an error.
1028
1029@item
c1030c7c 1030Certain constructs which ISO regards as a single invalid preprocessing
74291a4b
MM
1031number, such as @samp{0xe-0xd}, are treated as expressions instead.
1032
1033@item
1034String ``constants'' are not necessarily constant; they are stored in
1035writable space, and identical looking constants are allocated
1036separately. (This is the same as the effect of
1037@samp{-fwritable-strings}.)
1038
1039@cindex @code{longjmp} and automatic variables
1040@item
1041All automatic variables not declared @code{register} are preserved by
c1030c7c 1042@code{longjmp}. Ordinarily, GNU C follows ISO C: automatic variables
74291a4b
MM
1043not declared @code{volatile} may be clobbered.
1044
1045@item
1046@kindex \x
1047@kindex \a
1048@cindex escape sequences, traditional
1049The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1050literal characters @samp{x} and @samp{a} respectively. Without
1051@w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1052representation of a character, and @samp{\a} produces a bell.
ad299d9b 1053@end itemize
74291a4b 1054
74291a4b
MM
1055You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1056if your program uses names that are normally GNU C builtin functions for
1057other purposes of its own.
1058
1059You cannot use @samp{-traditional} if you include any header files that
c1030c7c
JM
1060rely on ISO C features. Some vendors are starting to ship systems with
1061ISO C header files and you cannot use @samp{-traditional} on such
74291a4b
MM
1062systems to compile files that include any system headers.
1063
e5e809f4
JL
1064The @samp{-traditional} option also enables @samp{-traditional-cpp},
1065which is described next.
74291a4b
MM
1066
1067@item -traditional-cpp
1068Attempt to support some aspects of traditional C preprocessors.
1069Specifically:
1070
1071@itemize @bullet
1072@item
1073Comments convert to nothing at all, rather than to a space. This allows
1074traditional token concatenation.
1075
1076@item
1077In a preprocessing directive, the @samp{#} symbol must appear as the first
1078character of a line.
1079
1080@item
1081Macro arguments are recognized within string constants in a macro
1082definition (and their values are stringified, though without additional
1083quote marks, when they appear in such a context). The preprocessor
1084always considers a string constant to end at a newline.
1085
1086@item
1087@cindex detecting @w{@samp{-traditional}}
1088The predefined macro @code{__STDC__} is not defined when you use
1089@samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
1090which @code{__GNUC__} indicates are not affected by
1091@samp{-traditional}). If you need to write header files that work
1092differently depending on whether @samp{-traditional} is in use, by
1093testing both of these predefined macros you can distinguish four
c1030c7c 1094situations: GNU C, traditional GNU C, other ISO C compilers, and other
74291a4b
MM
1095old C compilers. The predefined macro @code{__STDC_VERSION__} is also
1096not defined when you use @samp{-traditional}. @xref{Standard
1097Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
1098for more discussion of these and other predefined macros.
1099
1100@item
1101@cindex string constants vs newline
1102@cindex newline vs string constants
1103The preprocessor considers a string constant to end at a newline (unless
1104the newline is escaped with @samp{\}). (Without @w{@samp{-traditional}},
1105string constants can contain the newline character as typed.)
1106@end itemize
1107
1108@item -fcond-mismatch
1109Allow conditional expressions with mismatched types in the second and
a7537031
JM
1110third arguments. The value of such an expression is void. This option
1111is not supported for C++.
74291a4b
MM
1112
1113@item -funsigned-char
1114Let the type @code{char} be unsigned, like @code{unsigned char}.
1115
1116Each kind of machine has a default for what @code{char} should
1117be. It is either like @code{unsigned char} by default or like
1118@code{signed char} by default.
1119
1120Ideally, a portable program should always use @code{signed char} or
1121@code{unsigned char} when it depends on the signedness of an object.
1122But many programs have been written to use plain @code{char} and
1123expect it to be signed, or expect it to be unsigned, depending on the
1124machines they were written for. This option, and its inverse, let you
1125make such a program work with the opposite default.
1126
1127The type @code{char} is always a distinct type from each of
1128@code{signed char} or @code{unsigned char}, even though its behavior
1129is always just like one of those two.
1130
1131@item -fsigned-char
1132Let the type @code{char} be signed, like @code{signed char}.
1133
1134Note that this is equivalent to @samp{-fno-unsigned-char}, which is
1135the negative form of @samp{-funsigned-char}. Likewise, the option
1136@samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
1137
1138You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1139if your program uses names that are normally GNU C builtin functions for
1140other purposes of its own.
1141
1142You cannot use @samp{-traditional} if you include any header files that
c1030c7c
JM
1143rely on ISO C features. Some vendors are starting to ship systems with
1144ISO C header files and you cannot use @samp{-traditional} on such
74291a4b
MM
1145systems to compile files that include any system headers.
1146
1147@item -fsigned-bitfields
1148@itemx -funsigned-bitfields
1149@itemx -fno-signed-bitfields
1150@itemx -fno-unsigned-bitfields
1151These options control whether a bitfield is signed or unsigned, when the
1152declaration does not use either @code{signed} or @code{unsigned}. By
1153default, such a bitfield is signed, because this is consistent: the
1154basic integer types such as @code{int} are signed types.
1155
1156However, when @samp{-traditional} is used, bitfields are all unsigned
1157no matter what.
1158
1159@item -fwritable-strings
1160Store string constants in the writable data segment and don't uniquize
1161them. This is for compatibility with old programs which assume they can
1162write into string constants. The option @samp{-traditional} also has
1163this effect.
1164
1165Writing into string constants is a very bad idea; ``constants'' should
1166be constant.
1167
1168@item -fallow-single-precision
1169Do not promote single precision math operations to double precision,
1170even when compiling with @samp{-traditional}.
1171
1172Traditional K&R C promotes all floating point operations to double
1173precision, regardless of the sizes of the operands. On the
1174architecture for which you are compiling, single precision may be faster
1175than double precision. If you must use @samp{-traditional}, but want
1176to use single precision operations when the operands are single
1177precision, use this option. This option has no effect when compiling
c1030c7c 1178with ISO or GNU C conventions (the default).
74291a4b 1179
3e37bef5
JM
1180@item -fshort-wchar
1181Override the underlying type for @samp{wchar_t} to be @samp{short
1182unsigned int} instead of the default for the target. This option is
1183useful for building programs to run under WINE.
74291a4b
MM
1184@end table
1185
1186@node C++ Dialect Options
1187@section Options Controlling C++ Dialect
1188
1189@cindex compiler options, C++
1190@cindex C++ options, command line
1191@cindex options, C++
1192This section describes the command-line options that are only meaningful
1193for C++ programs; but you can also use most of the GNU compiler options
1194regardless of what language your program is in. For example, you
1195might compile a file @code{firstClass.C} like this:
1196
1197@example
1dc5fc4b 1198g++ -g -frepo -O -c firstClass.C
74291a4b
MM
1199@end example
1200
1201@noindent
1dc5fc4b 1202In this example, only @samp{-frepo} is an option meant
74291a4b 1203only for C++ programs; you can use the other options with any
0c2d1a2a 1204language supported by GCC.
74291a4b
MM
1205
1206Here is a list of options that are @emph{only} for compiling C++ programs:
1207
2642624b 1208@table @gcctabopt
74291a4b
MM
1209@item -fno-access-control
1210Turn off all access checking. This switch is mainly useful for working
1211around bugs in the access control code.
1212
74291a4b
MM
1213@item -fcheck-new
1214Check that the pointer returned by @code{operator new} is non-null
1215before attempting to modify the storage allocated. The current Working
1216Paper requires that @code{operator new} never return a null pointer, so
1217this check is normally unnecessary.
1218
1dc5fc4b
JM
1219An alternative to using this option is to specify that your
1220@code{operator new} does not throw any exceptions; if you declare it
1221@samp{throw()}, g++ will check the return value. See also @samp{new
1222(nothrow)}.
1223
74291a4b
MM
1224@item -fconserve-space
1225Put uninitialized or runtime-initialized global variables into the
1226common segment, as C does. This saves space in the executable at the
1227cost of not diagnosing duplicate definitions. If you compile with this
1228flag and your program mysteriously crashes after @code{main()} has
1229completed, you may have an object that is being destroyed twice because
1230two definitions were merged.
1231
1dc5fc4b
JM
1232This option is no longer useful on most targets, now that support has
1233been added for putting variables into BSS without making them common.
1234
74291a4b
MM
1235@item -fdollars-in-identifiers
1236Accept @samp{$} in identifiers. You can also explicitly prohibit use of
eb795509
RK
1237@samp{$} with the option @samp{-fno-dollars-in-identifiers}. (GNU C allows
1238@samp{$} by default on most target systems, but there are a few exceptions.)
74291a4b 1239Traditional C allowed the character @samp{$} to form part of
c1030c7c 1240identifiers. However, ISO C and C++ forbid @samp{$} in identifiers.
74291a4b 1241
1dc5fc4b
JM
1242@item -fno-elide-constructors
1243The C++ standard allows an implementation to omit creating a temporary
1244which is only used to initialize another object of the same type.
1245Specifying this option disables that optimization, and forces g++ to
1246call the copy constructor in all cases.
74291a4b 1247
dd1ba632
JM
1248@item -fno-enforce-eh-specs
1249Don't check for violation of exception specifications at runtime. This
1250option violates the C++ standard, but may be useful for reducing code
1251size in production builds, much like defining @samp{NDEBUG}. The compiler
1252will still optimize based on the exception specifications.
1253
74291a4b
MM
1254@item -fexternal-templates
1255Cause template instantiations to obey @samp{#pragma interface} and
1256@samp{implementation}; template instances are emitted or not according
1257to the location of the template definition. @xref{Template
1258Instantiation}, for more information.
1259
37f6b6bf
MM
1260This option is deprecated.
1261
74291a4b
MM
1262@item -falt-external-templates
1263Similar to -fexternal-templates, but template instances are emitted or
1264not according to the place where they are first instantiated.
1265@xref{Template Instantiation}, for more information.
1266
37f6b6bf
MM
1267This option is deprecated.
1268
74291a4b 1269@item -ffor-scope
8c81598d 1270@itemx -fno-for-scope
74291a4b
MM
1271If -ffor-scope is specified, the scope of variables declared in
1272a @i{for-init-statement} is limited to the @samp{for} loop itself,
34527c47 1273as specified by the C++ standard.
74291a4b
MM
1274If -fno-for-scope is specified, the scope of variables declared in
1275a @i{for-init-statement} extends to the end of the enclosing scope,
1276as was the case in old versions of gcc, and other (traditional)
1277implementations of C++.
1278
1279The default if neither flag is given to follow the standard,
1280but to allow and give a warning for old-style code that would
1281otherwise be invalid, or have different behavior.
1282
1283@item -fno-gnu-keywords
9762e8a4
ML
1284Do not recognize @code{typeof} as a keyword, so that code can use this
1285word as an identifier. You can use the keyword @code{__typeof__} instead.
1286@samp{-ansi} implies @samp{-fno-gnu-keywords}.
74291a4b 1287
95c81fb8
ML
1288@item -fhonor-std
1289Treat the @code{namespace std} as a namespace, instead of ignoring
1290it. For compatibility with earlier versions of g++, the compiler will,
1291by default, ignore @code{namespace-declarations},
1292@code{using-declarations}, @code{using-directives}, and
1293@code{namespace-names}, if they involve @code{std}.
1294
74291a4b
MM
1295@item -fhuge-objects
1296Support virtual function calls for objects that exceed the size
1297representable by a @samp{short int}. Users should not use this flag by
1dc5fc4b 1298default; if you need to use it, the compiler will tell you so.
74291a4b
MM
1299
1300This flag is not useful when compiling with -fvtable-thunks.
1301
1dc5fc4b
JM
1302Like all options that change the ABI, all C++ code, @emph{including
1303libgcc} must be built with the same setting of this option.
1304
1305@item -fno-implicit-templates
bba975d4
JM
1306Never emit code for non-inline templates which are instantiated
1307implicitly (i.e. by use); only emit code for explicit instantiations.
1308@xref{Template Instantiation}, for more information.
1309
1310@item -fno-implicit-inline-templates
1311Don't emit code for implicit instantiations of inline templates, either.
1312The default is to handle inlines differently so that compiles with and
1313without optimization will need the same set of explicit instantiations.
1dc5fc4b 1314
74291a4b
MM
1315@item -fno-implement-inlines
1316To save space, do not emit out-of-line copies of inline functions
1317controlled by @samp{#pragma implementation}. This will cause linker
1318errors if these functions are not inlined everywhere they are called.
1319
631cf95d 1320@item -fms-extensions
32fb1fb2
PE
1321Disable pedantic warnings about constructs used in MFC, such as implicit
1322int and getting a pointer to member function via non-standard syntax.
631cf95d 1323
775afb25
ML
1324@item -fno-operator-names
1325Do not treat the operator name keywords @code{and}, @code{bitand},
74291a4b 1326@code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
775afb25 1327synonyms as keywords.
74291a4b 1328
4f8b4fd9
JM
1329@item -fno-optional-diags
1330Disable diagnostics that the standard says a compiler does not need to
bba975d4
JM
1331issue. Currently, the only such diagnostic issued by g++ is the one for
1332a name having multiple meanings within a class.
4f8b4fd9 1333
8c7707b0
JM
1334@item -fpermissive
1335Downgrade messages about nonconformant code from errors to warnings. By
1336default, g++ effectively sets @samp{-pedantic-errors} without
1337@samp{-pedantic}; this option reverses that. This behavior and this
2d9f9cf1 1338option are superseded by @samp{-pedantic}, which works as it does for GNU C.
8c7707b0 1339
8c81598d
JM
1340@item -frepo
1341Enable automatic template instantiation. This option also implies
1342@samp{-fno-implicit-templates}. @xref{Template Instantiation}, for more
1343information.
1344
8c7707b0 1345@item -fno-rtti
a7fbfcf9
JM
1346Disable generation of information about every class with virtual
1347functions for use by the C++ runtime type identification features
1348(@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1349of the language, you can save some space by using this flag. Note that
1350exception handling uses the same information, but it will generate it as
1351needed.
8c7707b0 1352
1dc5fc4b
JM
1353@item -ftemplate-depth-@var{n}
1354Set the maximum instantiation depth for template classes to @var{n}.
1355A limit on the template instantiation depth is needed to detect
1356endless recursions during template class instantiation. ANSI/ISO C++
1357conforming programs must not rely on a maximum depth greater than 17.
1358
fc693822
MM
1359@item -fuse-cxa-atexit
1360Register destructors for objects with static storage duration with the
1361@code{__cxa_atexit} function rather than the @code{atexit} function.
1362This option is required for fully standards-compliant handling of static
1363destructors, but will only work if your C library supports
1364@code{__cxa_atexit}.
1365
74291a4b
MM
1366@item -fvtable-thunks
1367Use @samp{thunks} to implement the virtual function dispatch table
1368(@samp{vtable}). The traditional (cfront-style) approach to
1369implementing vtables was to store a pointer to the function and two
1370offsets for adjusting the @samp{this} pointer at the call site. Newer
1371implementations store a single pointer to a @samp{thunk} function which
1372does any necessary adjustment and then calls the target function.
1373
f5a1b0d2
NC
1374This option also enables a heuristic for controlling emission of
1375vtables; if a class has any non-inline virtual functions, the vtable
1376will be emitted in the translation unit containing the first one of
1377those.
1378
1dc5fc4b
JM
1379Like all options that change the ABI, all C++ code, @emph{including
1380libgcc.a} must be built with the same setting of this option.
861bb6c1 1381
74291a4b
MM
1382@item -nostdinc++
1383Do not search for header files in the standard directories specific to
1384C++, but do still search the other standard directories. (This option
e5e809f4 1385is used when building the C++ library.)
74291a4b
MM
1386@end table
1387
1388In addition, these optimization, warning, and code generation options
1389have meanings only for C++ programs:
1390
2642624b 1391@table @gcctabopt
74291a4b
MM
1392@item -fno-default-inline
1393Do not assume @samp{inline} for functions defined inside a class scope.
1dc5fc4b
JM
1394@xref{Optimize Options,,Options That Control Optimization}. Note that these
1395functions will have linkage like inline functions; they just won't be
1396inlined by default.
74291a4b 1397
bba975d4
JM
1398@item -Wctor-dtor-privacy (C++ only)
1399Warn when a class seems unusable, because all the constructors or
1400destructors in a class are private and the class has no friends or
1401public static member functions.
1402
1403@item -Wnon-virtual-dtor (C++ only)
1404Warn when a class declares a non-virtual destructor that should probably
1405be virtual, because it looks like the class will be used polymorphically.
1406
1407@item -Wreorder (C++ only)
1408@cindex reordering, warning
1409@cindex warning for reordering of member initializers
1410Warn when the order of member initializers given in the code does not
1411match the order in which they must be executed. For instance:
1412
1413@smallexample
1414struct A @{
1415 int i;
1416 int j;
1417 A(): j (0), i (1) @{ @}
1418@};
1419@end smallexample
1420
1421Here the compiler will warn that the member initializers for @samp{i}
1422and @samp{j} will be rearranged to match the declaration order of the
1423members.
1424@end table
1425
1426The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1427
2642624b 1428@table @gcctabopt
bba975d4
JM
1429@item -Weffc++ (C++ only)
1430Warn about violations of various style guidelines from Scott Meyers'
1431@cite{Effective C++} books. If you use this option, you should be aware
1432that the standard library headers do not obey all of these guidelines;
1433you can use @samp{grep -v} to filter out those warnings.
1434
2de45c06
ML
1435@item -Wno-deprecated (C++ only)
1436Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1437
bba975d4
JM
1438@item -Wno-non-template-friend (C++ only)
1439Disable warnings when non-templatized friend functions are declared
1440within a template. With the advent of explicit template specification
1441support in g++, if the name of the friend is an unqualified-id (ie,
1442@samp{friend foo(int)}), the C++ language specification demands that the
1443friend declare or define an ordinary, nontemplate function. (Section
144414.5.3). Before g++ implemented explicit specification, unqualified-ids
1445could be interpreted as a particular specialization of a templatized
1446function. Because this non-conforming behavior is no longer the default
1447behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1448check existing code for potential trouble spots, and is on by default.
2228d450
MM
1449This new compiler behavior can be turned off with
1450@samp{-Wno-non-template-friend} which keeps the conformant compiler code
1451but disables the helpful warning.
bba975d4
JM
1452
1453@item -Wold-style-cast (C++ only)
1454Warn if an old-style (C-style) cast is used within a C++ program. The
1455new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1456@samp{const_cast}) are less vulnerable to unintended effects.
1457
1458@item -Woverloaded-virtual (C++ only)
1459@cindex overloaded virtual fn, warning
1460@cindex warning for overloaded virtual fn
3747f3dc
MM
1461Warn when a function declaration hides virtual functions from a
1462base class. For example, in:
1463
1464@smallexample
1465struct A @{
1466 virtual void f();
1467@};
1468
1469struct B: public A @{
1470 void f(int);
1471@};
1472@end smallexample
1473
1474the @code{A} class version of @code{f} is hidden in @code{B}, and code
1475like this:
1476
1477@smallexample
1478B* b;
1479b->f();
1480@end smallexample
1481
1482will fail to compile.
bba975d4
JM
1483
1484@item -Wno-pmf-conversions (C++ only)
1485Disable the diagnostic for converting a bound pointer to member function
1486to a plain pointer.
1487
1488@item -Wsign-promo (C++ only)
1489Warn when overload resolution chooses a promotion from unsigned or
1490enumeral type to a signed type over a conversion to an unsigned type of
1491the same size. Previous versions of g++ would try to preserve
1492unsignedness, but the standard mandates the current behavior.
1493
1494@item -Wsynth (C++ only)
1495@cindex warning for synthesized methods
1496@cindex synthesized methods, warning
1497Warn when g++'s synthesis behavior does not match that of cfront. For
1498instance:
1499
1500@smallexample
1501struct A @{
1502 operator int ();
1503 A& operator = (int);
1504@};
1505
1506main ()
1507@{
1508 A a,b;
1509 a = b;
1510@}
1511@end smallexample
74291a4b 1512
bba975d4
JM
1513In this example, g++ will synthesize a default @samp{A& operator =
1514(const A&);}, while cfront will use the user-defined @samp{operator =}.
74291a4b
MM
1515@end table
1516
764dbbf2
GDR
1517@node Language Independent Options
1518@section Options to Control Diagnostic Messages Formatting
1519@cindex options to control diagnostics formatting
1520@cindex diagnostic messages
1521@cindex message formatting
1522
b192711e 1523Traditionally, diagnostic messages have been formatted irrespective of
764dbbf2
GDR
1524the output device's aspect (e.g. its width, ...). The options described
1525below can be used to control the diagnostic messages formatting
1526algorithm, e.g. how many characters per line, how often source location
1527information should be reported. Right now, only the C++ front-end can
1528honor these options. However it is expected, in the near future, that
1529the remaining front-ends would be able to digest them correctly.
1530
2642624b 1531@table @gcctabopt
764dbbf2
GDR
1532@item -fmessage-length=@var{n}
1533Try to format error messages so that they fit on lines of about @var{n}
1534characters. The default is 72 characters for g++ and 0 for the rest of
1535the front-ends supported by GCC. If @var{n} is zero, then no
1536line-wrapping will be done; each error message will appear on a single
1537line.
1538
1539@item -fdiagnostics-show-location=once
b192711e 1540Only meaningful in line-wrapping mode. Instructs the diagnostic messages
764dbbf2
GDR
1541reporter to emit @emph{once} source location information; that is, in
1542case the message is too long to fit on a single physical line and has to
1543be wrapped, the source location won't be emitted (as prefix) again,
1544over and over, in subsequent continuation lines. This is the default
1545behaviour.
1546
1547@item -fdiagnostics-show-location=every-line
1548Only meaningful in line-wrapping mode. Instructs the diagnostic
1549messages reporter to emit the same source location information (as
1550prefix) for physical lines that result from the process of breaking a
b192711e 1551a message which is too long to fit on a single line.
764dbbf2
GDR
1552
1553@end table
1554
74291a4b
MM
1555@node Warning Options
1556@section Options to Request or Suppress Warnings
1557@cindex options to control warnings
1558@cindex warning messages
1559@cindex messages, warning
1560@cindex suppressing warnings
1561
1562Warnings are diagnostic messages that report constructions which
1563are not inherently erroneous but which are risky or suggest there
1564may have been an error.
1565
1566You can request many specific warnings with options beginning @samp{-W},
1567for example @samp{-Wimplicit} to request warnings on implicit
1568declarations. Each of these specific warning options also has a
1569negative form beginning @samp{-Wno-} to turn off warnings;
1570for example, @samp{-Wno-implicit}. This manual lists only one of the
1571two forms, whichever is not the default.
1572
0c2d1a2a 1573These options control the amount and kinds of warnings produced by GCC:
74291a4b 1574
2642624b 1575@table @gcctabopt
74291a4b
MM
1576@cindex syntax checking
1577@item -fsyntax-only
1578Check the code for syntax errors, but don't do anything beyond that.
1579
1580@item -pedantic
074e95e3
JM
1581Issue all the warnings demanded by strict ISO C and ISO C++;
1582reject all programs that use forbidden extensions, and some other
1583programs that do not follow ISO C and ISO C++. For ISO C, follows the
1584version of the ISO C standard specified by any @samp{-std} option used.
74291a4b 1585
074e95e3 1586Valid ISO C and ISO C++ programs should compile properly with or without
5490d604
JM
1587this option (though a rare few will require @option{-ansi} or a
1588@option{-std} option specifying the required version of ISO C). However,
b1d16193
JL
1589without this option, certain GNU extensions and traditional C and C++
1590features are supported as well. With this option, they are rejected.
74291a4b
MM
1591
1592@samp{-pedantic} does not cause warning messages for use of the
1593alternate keywords whose names begin and end with @samp{__}. Pedantic
1594warnings are also disabled in the expression that follows
1595@code{__extension__}. However, only system header files should use
1596these escape routes; application programs should avoid them.
1597@xref{Alternate Keywords}.
1598
074e95e3 1599Some users try to use @samp{-pedantic} to check programs for strict ISO
74291a4b 1600C conformance. They soon find that it does not do quite what they want:
c1030c7c 1601it finds some non-ISO practices, but not all---only those for which
074e95e3
JM
1602ISO C @emph{requires} a diagnostic, and some others for which
1603diagnostics have been added.
74291a4b 1604
074e95e3 1605A feature to report any failure to conform to ISO C might be useful in
74291a4b 1606some instances, but would require considerable additional work and would
892d0a6d
AO
1607be quite different from @samp{-pedantic}. We don't have plans to
1608support such a feature in the near future.
74291a4b
MM
1609
1610@item -pedantic-errors
1611Like @samp{-pedantic}, except that errors are produced rather than
1612warnings.
1613
1614@item -w
1615Inhibit all warning messages.
1616
1617@item -Wno-import
1618Inhibit warning messages about the use of @samp{#import}.
1619
1620@item -Wchar-subscripts
1621Warn if an array subscript has type @code{char}. This is a common cause
1622of error, as programmers often forget that this type is signed on some
1623machines.
1624
1625@item -Wcomment
1626Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1627comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1628
1629@item -Wformat
1630Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1631the arguments supplied have types appropriate to the format string
26f6672d
JM
1632specified, and that the conversions specified in the format string make
1633sense. This includes standard functions, and others specified by format
1634attributes (@pxref{Function Attributes}), in the @code{printf},
1635@code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1636not in the C standard) families.
74291a4b 1637
8308e0b7
JM
1638The formats are checked against the format features supported by GNU
1639libc version 2.2. These include all ISO C89 and C99 features, as well
1640as features from the Single Unix Specification and some BSD and GNU
1641extensions. Other library implementations may not support all these
1642features; GCC does not support warning about features that go beyond a
1643particular library's limitations. However, if @samp{-pedantic} is used
1644with @samp{-Wformat}, warnings will be given about format features not
26f6672d
JM
1645in the selected standard version (but not for @code{strfmon} formats,
1646since those are not in any version of the C standard). @xref{C Dialect
1647Options,,Options Controlling C Dialect}.
8308e0b7 1648
4d808927
JM
1649@samp{-Wformat} is included in @samp{-Wall}. For more control over some
1650aspects of format checking, the options @samp{-Wno-format-y2k},
c907e684
JM
1651@samp{-Wno-format-extra-args}, @samp{-Wformat-nonliteral},
1652@samp{-Wformat-security} and @samp{-Wformat=2} are available, but are
1653not included in @samp{-Wall}.
4d808927
JM
1654
1655@item -Wno-format-y2k
1656If @samp{-Wformat} is specified, do not warn about @code{strftime}
1657formats which may yield only a two-digit year.
1658
1659@item -Wno-format-extra-args
1660If @samp{-Wformat} is specified, do not warn about excess arguments to a
1661@code{printf} or @code{scanf} format function. The C standard specifies
1662that such arguments are ignored.
1663
1664@item -Wformat-nonliteral
1665If @samp{-Wformat} is specified, also warn if the format string is not a
1666string literal and so cannot be checked, unless the format function
1667takes its format arguments as a @code{va_list}.
1668
c907e684
JM
1669@item -Wformat-security
1670If @samp{-Wformat} is specified, also warn about uses of format
1671functions that represent possible security problems. At present, this
1672warns about calls to @code{printf} and @code{scanf} functions where the
1673format string is not a string literal and there are no format arguments,
1674as in @code{printf (foo);}. This may be a security hole if the format
1675string came from untrusted input and contains @samp{%n}. (This is
1676currently a subset of what @samp{-Wformat-nonliteral} warns about, but
1677in future warnings may be added to @samp{-Wformat-security} that are not
1678included in @samp{-Wformat-nonliteral}.)
1679
4d808927
JM
1680@item -Wformat=2
1681Enable @samp{-Wformat} plus format checks not included in
1682@samp{-Wformat}. Currently equivalent to @samp{-Wformat
c907e684 1683-Wformat-nonliteral -Wformat-security}.
4d808927 1684
e9a25f70
JL
1685@item -Wimplicit-int
1686Warn when a declaration does not specify a type.
1687
f5963e61
JL
1688@item -Wimplicit-function-declaration
1689@itemx -Werror-implicit-function-declaration
1690Give a warning (or error) whenever a function is used before being
1691declared.
e9a25f70 1692
74291a4b 1693@item -Wimplicit
e5e809f4
JL
1694Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1695@samp{declaration}.
861bb6c1
JL
1696
1697@item -Wmain
1698Warn if the type of @samp{main} is suspicious. @samp{main} should be a
1699function with external linkage, returning int, taking either zero
1700arguments, two, or three arguments of appropriate types.
4a870dba 1701
1f0c3120
JM
1702@item -Wmissing-braces
1703Warn if an aggregate or union initializer is not fully bracketed. In
1704the following example, the initializer for @samp{a} is not fully
1705bracketed, but that for @samp{b} is fully bracketed.
1706
1707@smallexample
1708int a[2][2] = @{ 0, 1, 2, 3 @};
1709int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1710@end smallexample
1711
4a870dba
JM
1712@item -Wmultichar
1713Warn if a multicharacter constant (@samp{'FOOF'}) is used. Usually they
1714indicate a typo in the user's code, as they have implementation-defined
1715values, and should not be used in portable code.
3c12fcc2 1716
74291a4b
MM
1717@item -Wparentheses
1718Warn if parentheses are omitted in certain contexts, such
1719as when there is an assignment in a context where a truth value
1720is expected, or when operators are nested whose precedence people
1721often get confused about.
1722
e9a25f70
JL
1723Also warn about constructions where there may be confusion to which
1724@code{if} statement an @code{else} branch belongs. Here is an example of
1725such a case:
1726
1727@smallexample
1728@{
1729 if (a)
1730 if (b)
1731 foo ();
1732 else
1733 bar ();
1734@}
1735@end smallexample
1736
1737In C, every @code{else} branch belongs to the innermost possible @code{if}
1738statement, which in this example is @code{if (b)}. This is often not
1739what the programmer expected, as illustrated in the above example by
1740indentation the programmer chose. When there is the potential for this
1741confusion, GNU C will issue a warning when this flag is specified.
1742To eliminate the warning, add explicit braces around the innermost
1743@code{if} statement so there is no way the @code{else} could belong to
1744the enclosing @code{if}. The resulting code would look like this:
1745
1746@smallexample
1747@{
1748 if (a)
1749 @{
1750 if (b)
1751 foo ();
1752 else
1753 bar ();
1754 @}
1755@}
1756@end smallexample
1757
bb58bec5
JM
1758@item -Wsequence-point
1759Warn about code that may have undefined semantics because of violations
1760of sequence point rules in the C standard.
1761
1762The C standard defines the order in which expressions in a C program are
1763evaluated in terms of @dfn{sequence points}, which represent a partial
1764ordering between the execution of parts of the program: those executed
1765before the sequence point, and those executed after it. These occur
1766after the evaluation of a full expression (one which is not part of a
1767larger expression), after the evaluation of the first operand of a
1768@code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1769function is called (but after the evaluation of its arguments and the
1770expression denoting the called function), and in certain other places.
1771Other than as expressed by the sequence point rules, the order of
1772evaluation of subexpressions of an expression is not specified. All
1773these rules describe only a partial order rather than a total order,
1774since, for example, if two functions are called within one expression
1775with no sequence point between them, the order in which the functions
1776are called is not specified. However, the standards committee have
1777ruled that function calls do not overlap.
1778
1779It is not specified when between sequence points modifications to the
1780values of objects take effect. Programs whose behavior depends on this
1781have undefined behavior; the C standard specifies that ``Between the
1782previous and next sequence point an object shall have its stored value
1783modified at most once by the evaluation of an expression. Furthermore,
1784the prior value shall be read only to determine the value to be
1785stored.''. If a program breaks these rules, the results on any
1786particular implementation are entirely unpredictable.
1787
1788Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1789= b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
1790diagnosed by this option, and it may give an occasional false positive
1791result, but in general it has been found fairly effective at detecting
1792this sort of problem in programs.
1793
1794The present implementation of this option only works for C programs. A
1795future implementation may also work for C++ programs.
1796
1797There is some controversy over the precise meaning of the sequence point
1798rules in subtle cases. Alternative formal definitions may be found in
1799Clive Feather's ``Annex S''
2642624b 1800@w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n925.htm}} and in
bb58bec5 1801Michael Norrish's thesis
2642624b 1802@w{@uref{http://www.cl.cam.ac.uk/users/mn200/PhD/thesis-report.ps.gz}}.
163686bd 1803Other discussions are by Raymond Mak
2642624b 1804@w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n926.htm}} and
163686bd 1805D. Hugh Redelmeier
2642624b 1806@w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n927.htm}}.
bb58bec5 1807
74291a4b 1808@item -Wreturn-type
32c4c36c
ML
1809Warn whenever a function is defined with a return-type that defaults to
1810@code{int}. Also warn about any @code{return} statement with no
1811return-value in a function whose return-type is not @code{void}.
1812
1813For C++, a function without return type always produces a diagnostic
1814message, even when @samp{-Wno-return-type} is specified. The only
1815exceptions are @samp{main} and functions defined in system headers.
74291a4b
MM
1816
1817@item -Wswitch
1818Warn whenever a @code{switch} statement has an index of enumeral type
1819and lacks a @code{case} for one or more of the named codes of that
1820enumeration. (The presence of a @code{default} label prevents this
1821warning.) @code{case} labels outside the enumeration range also
1822provoke warnings when this option is used.
1823
1824@item -Wtrigraphs
f2ecb02d
JM
1825Warn if any trigraphs are encountered that might change the meaning of
1826the program (trigraphs within comments are not warned about).
74291a4b 1827
078721e1
AC
1828@item -Wunused-function
1829Warn whenever a static function is declared but not defined or a
1830non\-inline static function is unused.
74291a4b 1831
078721e1
AC
1832@item -Wunused-label
1833Warn whenever a label is declared but not used.
1834
1835To suppress this warning use the @samp{unused} attribute
1836(@pxref{Variable Attributes}).
1837
1838@item -Wunused-parameter
1839Warn whenever a function parameter is unused aside from its declaration.
1840
1841To suppress this warning use the @samp{unused} attribute
1842(@pxref{Variable Attributes}).
956d6950 1843
078721e1
AC
1844@item -Wunused-variable
1845Warn whenever a local variable or non-constant static variable is unused
1846aside from its declaration
1847
1848To suppress this warning use the @samp{unused} attribute
74291a4b
MM
1849(@pxref{Variable Attributes}).
1850
078721e1
AC
1851@item -Wunused-value
1852Warn whenever a statement computes a result that is explicitly not used.
1853
1854To suppress this warning cast the expression to @samp{void}.
1855
1856@item -Wunused
1857All all the above @samp{-Wunused} options combined.
1858
1859In order to get a warning about an unused function parameter, you must
b192711e 1860either specify @samp{-W -Wunused} or separately specify
078721e1
AC
1861@samp{-Wunused-parameter}.
1862
74291a4b 1863@item -Wuninitialized
c5c76735
JL
1864Warn if an automatic variable is used without first being initialized or
1865if a variable may be clobbered by a @code{setjmp} call.
74291a4b
MM
1866
1867These warnings are possible only in optimizing compilation,
1868because they require data flow information that is computed only
1869when optimizing. If you don't specify @samp{-O}, you simply won't
1870get these warnings.
1871
1872These warnings occur only for variables that are candidates for
1873register allocation. Therefore, they do not occur for a variable that
1874is declared @code{volatile}, or whose address is taken, or whose size
1875is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
1876structures, unions or arrays, even when they are in registers.
1877
1878Note that there may be no warning about a variable that is used only
1879to compute a value that itself is never used, because such
1880computations may be deleted by data flow analysis before the warnings
1881are printed.
1882
0c2d1a2a 1883These warnings are made optional because GCC is not smart
74291a4b
MM
1884enough to see all the reasons why the code might be correct
1885despite appearing to have an error. Here is one example of how
1886this can happen:
1887
1888@smallexample
1889@{
1890 int x;
1891 switch (y)
1892 @{
1893 case 1: x = 1;
1894 break;
1895 case 2: x = 4;
1896 break;
1897 case 3: x = 5;
1898 @}
1899 foo (x);
1900@}
1901@end smallexample
1902
1903@noindent
1904If the value of @code{y} is always 1, 2 or 3, then @code{x} is
0c2d1a2a 1905always initialized, but GCC doesn't know this. Here is
74291a4b
MM
1906another common case:
1907
1908@smallexample
1909@{
1910 int save_y;
1911 if (change_y) save_y = y, y = new_y;
1912 @dots{}
1913 if (change_y) y = save_y;
1914@}
1915@end smallexample
1916
1917@noindent
1918This has no bug because @code{save_y} is used only if it is set.
1919
20300b05 1920@cindex @code{longjmp} warnings
b192711e 1921This option also warns when a non-volatile automatic variable might be
c5c76735
JL
1922changed by a call to @code{longjmp}. These warnings as well are possible
1923only in optimizing compilation.
20300b05
GK
1924
1925The compiler sees only the calls to @code{setjmp}. It cannot know
1926where @code{longjmp} will be called; in fact, a signal handler could
1927call it at any point in the code. As a result, you may get a warning
1928even when there is in fact no problem because @code{longjmp} cannot
1929in fact be called at the place which would cause a problem.
1930
74291a4b
MM
1931Some spurious warnings can be avoided if you declare all the functions
1932you use that never return as @code{noreturn}. @xref{Function
1933Attributes}.
1934
c5c76735
JL
1935@item -Wreorder (C++ only)
1936@cindex reordering, warning
1937@cindex warning for reordering of member initializers
1938Warn when the order of member initializers given in the code does not
1939match the order in which they must be executed. For instance:
1940
d300e551
NC
1941@item -Wunknown-pragmas
1942@cindex warning for unknown pragmas
1943@cindex unknown pragmas, warning
1944@cindex pragmas, warning of unknown
1945Warn when a #pragma directive is encountered which is not understood by
1946GCC. If this command line option is used, warnings will even be issued
1947for unknown pragmas in system header files. This is not the case if
1948the warnings were only enabled by the @samp{-Wall} command line option.
1949
74291a4b
MM
1950@item -Wall
1951All of the above @samp{-W} options combined. This enables all the
1952warnings about constructions that some users consider questionable, and
1953that are easy to avoid (or modify to prevent the warning), even in
1954conjunction with macros.
317639a8
BC
1955
1956@item -Wsystem-headers
1957@cindex warnings from system headers
1958@cindex system headers, warnings from
1959Print warning messages for constructs found in system header files.
1960Warnings from system headers are normally suppressed, on the assumption
1961that they usually do not indicate real problems and would only make the
1962compiler output harder to read. Using this command line option tells
1963GCC to emit warnings from system headers as if they occurred in user
1964code. However, note that using @samp{-Wall} in conjunction with this
1965option will @emph{not} warn about unknown pragmas in system
1966headers---for that, @samp{-Wunknown-pragmas} must also be used.
74291a4b
MM
1967@end table
1968
1969The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1970Some of them warn about constructions that users generally do not
1971consider questionable, but which occasionally you might wish to check
1972for; others warn about constructions that are necessary or hard to avoid
1973in some cases, and there is no simple way to modify the code to suppress
1974the warning.
1975
2642624b 1976@table @gcctabopt
74291a4b
MM
1977@item -W
1978Print extra warning messages for these events:
1979
1980@itemize @bullet
74291a4b
MM
1981@item
1982A function can return either with or without a value. (Falling
1983off the end of the function body is considered returning without
1984a value.) For example, this function would evoke such a
1985warning:
1986
1987@smallexample
1988@group
1989foo (a)
1990@{
1991 if (a > 0)
1992 return a;
1993@}
1994@end group
1995@end smallexample
1996
1997@item
1998An expression-statement or the left-hand side of a comma expression
1999contains no side effects.
2000To suppress the warning, cast the unused expression to void.
2001For example, an expression such as @samp{x[i,j]} will cause a warning,
2002but @samp{x[(void)i,j]} will not.
2003
2004@item
2005An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2006
2007@item
2008A comparison like @samp{x<=y<=z} appears; this is equivalent to
2009@samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2010that of ordinary mathematical notation.
2011
2012@item
2013Storage-class specifiers like @code{static} are not the first things in
2014a declaration. According to the C Standard, this usage is obsolescent.
2015
e0c9fbb7
JM
2016@item
2017The return type of a function has a type qualifier such as @code{const}.
2018Such a type qualifier has no effect, since the value returned by a
2019function is not an lvalue. (But don't warn about the GNU extension of
2020@code{volatile void} return types. That extension will be warned about
2021if @samp{-pedantic} is specified.)
2022
74291a4b
MM
2023@item
2024If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
2025arguments.
2026
e9a25f70
JL
2027@item
2028A comparison between signed and unsigned values could produce an
2029incorrect result when the signed value is converted to unsigned.
e5e809f4 2030(But don't warn if @samp{-Wno-sign-compare} is also specified.)
e9a25f70 2031
74291a4b
MM
2032@item
2033An aggregate has a partly bracketed initializer.
2034For example, the following code would evoke such a warning,
2035because braces are missing around the initializer for @code{x.h}:
2036
2037@smallexample
2038struct s @{ int f, g; @};
2039struct t @{ struct s h; int i; @};
2040struct t x = @{ 1, 2, 3 @};
2041@end smallexample
dbde0d5d
BH
2042
2043@item
2044An aggregate has an initializer which does not initialize all members.
2045For example, the following code would cause such a warning, because
2046@code{x.h} would be implicitly initialized to zero:
2047
2048@smallexample
2049struct s @{ int f, g, h; @};
2050struct s x = @{ 3, 4 @};
2051@end smallexample
74291a4b
MM
2052@end itemize
2053
f793a95e
JL
2054@item -Wfloat-equal
2055Warn if floating point values are used in equality comparisons.
2056
488d3985
GK
2057The idea behind this is that sometimes it is convenient (for the
2058programmer) to consider floating-point values as approximations to
2059infinitely precise real numbers. If you are doing this, then you need
2060to compute (by analysing the code, or in some other way) the maximum or
2061likely maximum error that the computation introduces, and allow for it
2062when performing comparisons (and when producing output, but that's a
2063different problem). In particular, instead of testing for equality, you
2064would check to see whether the two values have ranges that overlap; and
2065this is done with the relational operators, so equality comparisons are
2066probably mistaken.
2067
fe50c0eb 2068@item -Wtraditional (C only)
74291a4b 2069Warn about certain constructs that behave differently in traditional and
c8abc684
KG
2070ISO C. Also warn about ISO C constructs that have no traditional C
2071equivalent, and/or problematic constructs which should be avoided.
74291a4b
MM
2072
2073@itemize @bullet
2074@item
da312b55
NB
2075Macro parameters that appear within string literals in the macro body.
2076In traditional C macro replacement takes place within string literals,
2077but does not in ISO C.
2078
2079@item
2080In traditional C, some preprocessor directives did not exist.
2081Traditional preprocessors would only consider a line to be a directive
2082if the @samp{#} appeared in column 1 on the line. Therefore
2083@samp{-Wtraditional} warns about directives that traditional C
2084understands but would ignore because the @samp{#} does not appear as the
2085first character on the line. It also suggests you hide directives like
2086@samp{#pragma} not understood by traditional C by indenting them. Some
2087traditional implementations would not recognise @samp{#elif}, so it
2088suggests avoiding it altogether.
2089
2090@item
2091A function-like macro that appears without arguments.
2092
2093@item
2094The unary plus operator.
2095
2096@item
2097The `U' integer constant suffix, or the `F' or `L' floating point
2098constant suffixes. (Traditonal C does support the `L' suffix on integer
2099constants.) Note, these suffixes appear in macros defined in the system
2100headers of most modern systems, e.g. the _MIN/_MAX macros in limits.h.
c8abc684
KG
2101Use of these macros in user code might normally lead to spurious
2102warnings, however gcc's integrated preprocessor has enough context to
2103avoid warning in these cases.
74291a4b
MM
2104
2105@item
2106A function declared external in one block and then used after the end of
2107the block.
2108
2109@item
2110A @code{switch} statement has an operand of type @code{long}.
db838bb8
KG
2111
2112@item
2113A non-@code{static} function declaration follows a @code{static} one.
2114This construct is not accepted by some traditional C compilers.
48776cde
KG
2115
2116@item
c1030c7c 2117The ISO type of an integer constant has a different width or
48776cde
KG
2118signedness from its traditional type. This warning is only issued if
2119the base of the constant is ten. I.e. hexadecimal or octal values, which
2120typically represent bit patterns, are not warned about.
bb66adca
KG
2121
2122@item
c1030c7c 2123Usage of ISO string concatenation is detected.
7f094a94 2124
895ea614
KG
2125@item
2126Initialization of automatic aggregates.
2127
2128@item
2129Identifier conflicts with labels. Traditional C lacks a separate
2130namespace for labels.
253b6b82
KG
2131
2132@item
2133Initialization of unions. If the initializer is zero, the warning is
2134omitted. This is done under the assumption that the zero initializer in
2135user code appears conditioned on e.g. @code{__STDC__} to avoid missing
2136initializer warnings and relies on default initialization to zero in the
2137traditional C case.
03829ad2
KG
2138
2139@item
3ed56f8a
KG
2140Conversions by prototypes between fixed/floating point values and vice
2141versa. The absence of these prototypes when compiling with traditional
2142C would cause serious problems. This is a subset of the possible
2143conversion warnings, for the full set use @samp{-Wconversion}.
74291a4b
MM
2144@end itemize
2145
861bb6c1
JL
2146@item -Wundef
2147Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2148
74291a4b 2149@item -Wshadow
d773df5a
DB
2150Warn whenever a local variable shadows another local variable, parameter or
2151global variable or whenever a built-in function is shadowed.
74291a4b
MM
2152
2153@item -Wid-clash-@var{len}
2154Warn whenever two distinct identifiers match in the first @var{len}
2155characters. This may help you prepare a program that will compile
2156with certain obsolete, brain-damaged compilers.
2157
2158@item -Wlarger-than-@var{len}
2159Warn whenever an object of larger than @var{len} bytes is defined.
2160
2161@item -Wpointer-arith
2162Warn about anything that depends on the ``size of'' a function type or
2163of @code{void}. GNU C assigns these types a size of 1, for
2164convenience in calculations with @code{void *} pointers and pointers
2165to functions.
2166
fe50c0eb 2167@item -Wbad-function-cast (C only)
74291a4b
MM
2168Warn whenever a function call is cast to a non-matching type.
2169For example, warn if @code{int malloc()} is cast to @code{anything *}.
2170
2171@item -Wcast-qual
2172Warn whenever a pointer is cast so as to remove a type qualifier from
2173the target type. For example, warn if a @code{const char *} is cast
2174to an ordinary @code{char *}.
2175
2176@item -Wcast-align
2177Warn whenever a pointer is cast such that the required alignment of the
2178target is increased. For example, warn if a @code{char *} is cast to
2179an @code{int *} on machines where integers can only be accessed at
2180two- or four-byte boundaries.
2181
2182@item -Wwrite-strings
2183Give string constants the type @code{const char[@var{length}]} so that
2184copying the address of one into a non-@code{const} @code{char *}
2185pointer will get a warning. These warnings will help you find at
2186compile time code that can try to write into a string constant, but
2187only if you have been very careful about using @code{const} in
2188declarations and prototypes. Otherwise, it will just be a nuisance;
2189this is why we did not make @samp{-Wall} request these warnings.
2190
2191@item -Wconversion
2192Warn if a prototype causes a type conversion that is different from what
2193would happen to the same argument in the absence of a prototype. This
2194includes conversions of fixed point to floating and vice versa, and
2195conversions changing the width or signedness of a fixed point argument
2196except when the same as the default promotion.
2197
2198Also, warn if a negative integer constant expression is implicitly
2199converted to an unsigned type. For example, warn about the assignment
2200@code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2201casts like @code{(unsigned) -1}.
2202
e9a25f70
JL
2203@item -Wsign-compare
2204@cindex warning for comparison of signed and unsigned values
2205@cindex comparison of signed and unsigned values, warning
2206@cindex signed and unsigned values, comparison warning
2207Warn when a comparison between signed and unsigned values could produce
2208an incorrect result when the signed value is converted to unsigned.
2209This warning is also enabled by @samp{-W}; to get the other warnings
2210of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2211
74291a4b
MM
2212@item -Waggregate-return
2213Warn if any functions that return structures or unions are defined or
2214called. (In languages where you can return an array, this also elicits
2215a warning.)
2216
fe50c0eb 2217@item -Wstrict-prototypes (C only)
74291a4b
MM
2218Warn if a function is declared or defined without specifying the
2219argument types. (An old-style function definition is permitted without
2220a warning if preceded by a declaration which specifies the argument
2221types.)
2222
fe50c0eb 2223@item -Wmissing-prototypes (C only)
74291a4b
MM
2224Warn if a global function is defined without a previous prototype
2225declaration. This warning is issued even if the definition itself
2226provides a prototype. The aim is to detect global functions that fail
2227to be declared in header files.
2228
2229@item -Wmissing-declarations
2230Warn if a global function is defined without a previous declaration.
2231Do so even if the definition itself provides a prototype.
2232Use this option to detect global functions that are not declared in
2233header files.
2234
0ca3fb0a
KG
2235@item -Wmissing-noreturn
2236Warn about functions which might be candidates for attribute @code{noreturn}.
2237Note these are only possible candidates, not absolute ones. Care should
2238be taken to manually verify functions actually do not ever return before
2239adding the @code{noreturn} attribute, otherwise subtle code generation
21c7361e
AJ
2240bugs could be introduced. You will not get a warning for @code{main} in
2241hosted C environments.
0ca3fb0a 2242
74ff4629
JM
2243@item -Wmissing-format-attribute
2244If @samp{-Wformat} is enabled, also warn about functions which might be
2245candidates for @code{format} attributes. Note these are only possible
2246candidates, not absolute ones. GCC will guess that @code{format}
2247attributes might be appropriate for any function that calls a function
2248like @code{vprintf} or @code{vscanf}, but this might not always be the
2249case, and some functions for which @code{format} attributes are
2250appropriate may not be detected. This option has no effect unless
2251@samp{-Wformat} is enabled (possibly by @samp{-Wall}).
2252
3c12fcc2
GM
2253@item -Wpacked
2254Warn if a structure is given the packed attribute, but the packed
2255attribute has no effect on the layout or size of the structure.
2256Such structures may be mis-aligned for little benefit. For
2257instance, in this code, the variable @code{f.x} in @code{struct bar}
2258will be misaligned even though @code{struct bar} does not itself
2259have the packed attribute:
2260
2261@smallexample
2262@group
2263struct foo @{
2264 int x;
2265 char a, b, c, d;
2266@} __attribute__((packed));
2267struct bar @{
2268 char z;
2269 struct foo f;
2270@};
2271@end group
2272@end smallexample
2273
2274@item -Wpadded
2275Warn if padding is included in a structure, either to align an element
2276of the structure or to align the whole structure. Sometimes when this
2277happens it is possible to rearrange the fields of the structure to
2278reduce the padding and so make the structure smaller.
2279
74291a4b
MM
2280@item -Wredundant-decls
2281Warn if anything is declared more than once in the same scope, even in
2282cases where multiple declaration is valid and changes nothing.
2283
fe50c0eb 2284@item -Wnested-externs (C only)
252215a7 2285Warn if an @code{extern} declaration is encountered within a function.
74291a4b 2286
312f6255
GK
2287@item -Wunreachable-code
2288Warn if the compiler detects that code will never be executed.
2289
2290This option is intended to warn when the compiler detects that at
2291least a whole line of source code will never be executed, because
2292some condition is never satisfied or because it is after a
2293procedure that never returns.
2294
2295It is possible for this option to produce a warning even though there
2296are circumstances under which part of the affected line can be executed,
2297so care should be taken when removing apparently-unreachable code.
2298
2299For instance, when a function is inlined, a warning may mean that the
2300line is unreachable in only one inlined copy of the function.
2301
2302This option is not made part of @samp{-Wall} because in a debugging
2303version of a program there is often substantial code which checks
2304correct functioning of the program and is, hopefully, unreachable
2305because the program does work. Another common use of unreachable
2306code is to provide behaviour which is selectable at compile-time.
2307
74291a4b 2308@item -Winline
c5c76735 2309Warn if a function can not be inlined and it was declared as inline.
74291a4b 2310
795add94
VM
2311@item -Wlong-long
2312Warn if @samp{long long} type is used. This is default. To inhibit
2313the warning messages, use @samp{-Wno-long-long}. Flags
2314@samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
2315only when @samp{-pedantic} flag is used.
2316
18424ae1
BL
2317@item -Wdisabled-optimization
2318Warn if a requested optimization pass is disabled. This warning does
2319not generally indicate that there is anything wrong with your code; it
2320merely indicates that GCC's optimizers were unable to handle the code
2321effectively. Often, the problem is that your code is too big or too
2322complex; GCC will refuse to optimize programs when the optimization
2323itself is likely to take inordinate amounts of time.
2324
74291a4b
MM
2325@item -Werror
2326Make all warnings into errors.
2327@end table
2328
2329@node Debugging Options
0c2d1a2a 2330@section Options for Debugging Your Program or GCC
74291a4b
MM
2331@cindex options, debugging
2332@cindex debugging information options
2333
0c2d1a2a 2334GCC has various special options that are used for debugging
74291a4b
MM
2335either your program or GCC:
2336
2642624b 2337@table @gcctabopt
74291a4b
MM
2338@item -g
2339Produce debugging information in the operating system's native format
2340(stabs, COFF, XCOFF, or DWARF). GDB can work with this debugging
2341information.
2342
2343On most systems that use stabs format, @samp{-g} enables use of extra
2344debugging information that only GDB can use; this extra information
2345makes debugging work better in GDB but will probably make other debuggers
2346crash or
2347refuse to read the program. If you want to control for certain whether
2348to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
861bb6c1 2349@samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
74291a4b
MM
2350(see below).
2351
0c2d1a2a 2352Unlike most other C compilers, GCC allows you to use @samp{-g} with
74291a4b
MM
2353@samp{-O}. The shortcuts taken by optimized code may occasionally
2354produce surprising results: some variables you declared may not exist
2355at all; flow of control may briefly move where you did not expect it;
2356some statements may not be executed because they compute constant
2357results or their values were already at hand; some statements may
2358execute in different places because they were moved out of loops.
2359
2360Nevertheless it proves possible to debug optimized output. This makes
2361it reasonable to use the optimizer for programs that might have bugs.
2362
0c2d1a2a 2363The following options are useful when GCC is generated with the
74291a4b
MM
2364capability for more than one debugging format.
2365
2366@item -ggdb
861bb6c1
JL
2367Produce debugging information for use by GDB. This means to use the
2368most expressive format available (DWARF 2, stabs, or the native format
2369if neither of those are supported), including GDB extensions if at all
2370possible.
74291a4b
MM
2371
2372@item -gstabs
2373Produce debugging information in stabs format (if that is supported),
2374without GDB extensions. This is the format used by DBX on most BSD
2375systems. On MIPS, Alpha and System V Release 4 systems this option
2376produces stabs debugging output which is not understood by DBX or SDB.
2377On System V Release 4 systems this option requires the GNU assembler.
2378
2379@item -gstabs+
2380Produce debugging information in stabs format (if that is supported),
2381using GNU extensions understood only by the GNU debugger (GDB). The
2382use of these extensions is likely to make other debuggers crash or
2383refuse to read the program.
2384
2385@item -gcoff
2386Produce debugging information in COFF format (if that is supported).
2387This is the format used by SDB on most System V systems prior to
2388System V Release 4.
2389
2390@item -gxcoff
2391Produce debugging information in XCOFF format (if that is supported).
2392This is the format used by the DBX debugger on IBM RS/6000 systems.
2393
2394@item -gxcoff+
2395Produce debugging information in XCOFF format (if that is supported),
2396using GNU extensions understood only by the GNU debugger (GDB). The
2397use of these extensions is likely to make other debuggers crash or
2398refuse to read the program, and may cause assemblers other than the GNU
2399assembler (GAS) to fail with an error.
2400
2401@item -gdwarf
861bb6c1
JL
2402Produce debugging information in DWARF version 1 format (if that is
2403supported). This is the format used by SDB on most System V Release 4
2404systems.
74291a4b
MM
2405
2406@item -gdwarf+
861bb6c1
JL
2407Produce debugging information in DWARF version 1 format (if that is
2408supported), using GNU extensions understood only by the GNU debugger
2409(GDB). The use of these extensions is likely to make other debuggers
2410crash or refuse to read the program.
2411
2412@item -gdwarf-2
2413Produce debugging information in DWARF version 2 format (if that is
2414supported). This is the format used by DBX on IRIX 6.
74291a4b
MM
2415
2416@item -g@var{level}
2417@itemx -ggdb@var{level}
2418@itemx -gstabs@var{level}
2419@itemx -gcoff@var{level}
2420@itemx -gxcoff@var{level}
2421@itemx -gdwarf@var{level}
861bb6c1 2422@itemx -gdwarf-2@var{level}
74291a4b
MM
2423Request debugging information and also use @var{level} to specify how
2424much information. The default level is 2.
2425
2426Level 1 produces minimal information, enough for making backtraces in
2427parts of the program that you don't plan to debug. This includes
2428descriptions of functions and external variables, but no information
2429about local variables and no line numbers.
2430
2431Level 3 includes extra information, such as all the macro definitions
2432present in the program. Some debuggers support macro expansion when
2433you use @samp{-g3}.
2434
2435@cindex @code{prof}
2436@item -p
2437Generate extra code to write profile information suitable for the
2438analysis program @code{prof}. You must use this option when compiling
2439the source files you want data about, and you must also use it when
2440linking.
2441
2442@cindex @code{gprof}
2443@item -pg
2444Generate extra code to write profile information suitable for the
2445analysis program @code{gprof}. You must use this option when compiling
2446the source files you want data about, and you must also use it when
2447linking.
2448
2449@cindex @code{tcov}
2450@item -a
2451Generate extra code to write profile information for basic blocks, which will
2452record the number of times each basic block is executed, the basic block start
2453address, and the function name containing the basic block. If @samp{-g} is
2454used, the line number and filename of the start of the basic block will also be
2455recorded. If not overridden by the machine description, the default action is
2456to append to the text file @file{bb.out}.
2457
2458This data could be analyzed by a program like @code{tcov}. Note,
2459however, that the format of the data is not what @code{tcov} expects.
2460Eventually GNU @code{gprof} should be extended to process this data.
2461
898f531b
JL
2462@item -Q
2463Makes the compiler print out each function name as it is compiled, and
2464print some statistics about each pass when it finishes.
2465
1f0c3120
JM
2466@item -ftime-report
2467Makes the compiler print some statistics about the time consumed by each
2468pass when it finishes.
2469
2470@item -fmem-report
2471Makes the compiler print some statistics about permanent memory
2472allocation when it finishes.
2473
74291a4b
MM
2474@item -ax
2475Generate extra code to profile basic blocks. Your executable will
2476produce output that is a superset of that produced when @samp{-a} is
2477used. Additional output is the source and target address of the basic
2478blocks where a jump takes place, the number of times a jump is executed,
2479and (optionally) the complete sequence of basic blocks being executed.
2480The output is appended to file @file{bb.out}.
2481
2482You can examine different profiling aspects without recompilation. Your
956d6950 2483executable will read a list of function names from file @file{bb.in}.
74291a4b
MM
2484Profiling starts when a function on the list is entered and stops when
2485that invocation is exited. To exclude a function from profiling, prefix
2486its name with `-'. If a function name is not unique, you can
2487disambiguate it by writing it in the form
2488@samp{/path/filename.d:functionname}. Your executable will write the
2489available paths and filenames in file @file{bb.out}.
2490
2491Several function names have a special meaning:
2492@table @code
2493@item __bb_jumps__
2494Write source, target and frequency of jumps to file @file{bb.out}.
2495@item __bb_hidecall__
2496Exclude function calls from frequency count.
2497@item __bb_showret__
2498Include function returns in frequency count.
2499@item __bb_trace__
2500Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2501The file will be compressed using the program @samp{gzip}, which must
bedc7537 2502exist in your @env{PATH}. On systems without the @samp{popen}
74291a4b
MM
2503function, the file will be named @file{bbtrace} and will not be
2504compressed. @strong{Profiling for even a few seconds on these systems
2505will produce a very large file.} Note: @code{__bb_hidecall__} and
2506@code{__bb_showret__} will not affect the sequence written to
2507@file{bbtrace.gz}.
2508@end table
2509
2510Here's a short example using different profiling parameters
2511in file @file{bb.in}. Assume function @code{foo} consists of basic blocks
25121 and 2 and is called twice from block 3 of function @code{main}. After
2513the calls, block 3 transfers control to block 4 of @code{main}.
2514
2515With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2516the following sequence of blocks is written to file @file{bbtrace.gz}:
25170 3 1 2 1 2 4. The return from block 2 to block 3 is not shown, because
2518the return is to a point inside the block and not to the top. The
2519block address 0 always indicates, that control is transferred
2520to the trace from somewhere outside the observed functions. With
2521@samp{-foo} added to @file{bb.in}, the blocks of function
2522@code{foo} are removed from the trace, so only 0 3 4 remains.
2523
2524With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2525jump frequencies will be written to file @file{bb.out}. The
2526frequencies are obtained by constructing a trace of blocks
2527and incrementing a counter for every neighbouring pair of blocks
2528in the trace. The trace 0 3 1 2 1 2 4 displays the following
2529frequencies:
2530
2531@example
2532Jump from block 0x0 to block 0x3 executed 1 time(s)
2533Jump from block 0x3 to block 0x1 executed 1 time(s)
2534Jump from block 0x1 to block 0x2 executed 2 time(s)
2535Jump from block 0x2 to block 0x1 executed 1 time(s)
2536Jump from block 0x2 to block 0x4 executed 1 time(s)
2537@end example
2538
2539With @code{__bb_hidecall__}, control transfer due to call instructions
2540is removed from the trace, that is the trace is cut into three parts: 0
25413 4, 0 1 2 and 0 1 2. With @code{__bb_showret__}, control transfer due
2542to return instructions is added to the trace. The trace becomes: 0 3 1
25432 3 1 2 3 4. Note, that this trace is not the same, as the sequence
2544written to @file{bbtrace.gz}. It is solely used for counting jump
2545frequencies.
2546
861bb6c1
JL
2547@item -fprofile-arcs
2548Instrument @dfn{arcs} during compilation. For each function of your
0c2d1a2a 2549program, GCC creates a program flow graph, then finds a spanning tree
861bb6c1
JL
2550for the graph. Only arcs that are not on the spanning tree have to be
2551instrumented: the compiler adds code to count the number of times that these
2552arcs are executed. When an arc is the only exit or only entrance to a
2553block, the instrumentation code can be added to the block; otherwise, a
2554new basic block must be created to hold the instrumentation code.
2555
2556Since not every arc in the program must be instrumented, programs
2557compiled with this option run faster than programs compiled with
2558@samp{-a}, which adds instrumentation code to every basic block in the
2559program. The tradeoff: since @code{gcov} does not have
2560execution counts for all branches, it must start with the execution
2561counts for the instrumented branches, and then iterate over the program
2562flow graph until the entire graph has been solved. Hence, @code{gcov}
2563runs a little more slowly than a program which uses information from
2564@samp{-a}.
2565
2566@samp{-fprofile-arcs} also makes it possible to estimate branch
2567probabilities, and to calculate basic block execution counts. In
2568general, basic block execution counts do not give enough information to
2569estimate all branch probabilities. When the compiled program exits, it
2570saves the arc execution counts to a file called
2571@file{@var{sourcename}.da}. Use the compiler option
2572@samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2573Control Optimization}) when recompiling, to optimize using estimated
2574branch probabilities.
2575
2576@need 2000
2577@item -ftest-coverage
2578Create data files for the @code{gcov} code-coverage utility
0c2d1a2a 2579(@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
861bb6c1
JL
2580The data file names begin with the name of your source file:
2581
2642624b 2582@table @gcctabopt
861bb6c1
JL
2583@item @var{sourcename}.bb
2584A mapping from basic blocks to line numbers, which @code{gcov} uses to
2585associate basic block execution counts with line numbers.
2586
2587@item @var{sourcename}.bbg
2588A list of all arcs in the program flow graph. This allows @code{gcov}
2589to reconstruct the program flow graph, so that it can compute all basic
2590block and arc execution counts from the information in the
2591@code{@var{sourcename}.da} file (this last file is the output from
2592@samp{-fprofile-arcs}).
2593@end table
2594
74291a4b
MM
2595@item -d@var{letters}
2596Says to make debugging dumps during compilation at times specified by
2597@var{letters}. This is used for debugging the compiler. The file names
375e2d5c 2598for most of the dumps are made by appending a pass number and a word to
923c2d86 2599the source file name (e.g. @file{foo.c.00.rtl} or @file{foo.c.01.sibling}).
375e2d5c 2600Here are the possible letters for use in @var{letters}, and their meanings:
74291a4b
MM
2601
2602@table @samp
375e2d5c
RH
2603@item A
2604Annotate the assembler output with miscellaneous debugging information.
956d6950 2605@item b
923c2d86 2606Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
48d9ade5 2607@item B
8bb16620 2608Dump after block reordering, to @file{@var{file}.26.bbro}.
032713aa 2609@item c
470fc13d
KH
2610Dump after instruction combination, to the file @file{@var{file}.14.combine}.
2611@item C
2612Dump after the first if conversion, to the file @file{@var{file}.15.ce}.
032713aa 2613@item d
8bb16620 2614Dump after delayed branch scheduling, to @file{@var{file}.29.dbr}.
032713aa 2615@item D
f5963e61
JL
2616Dump all macro definitions, at the end of preprocessing, in addition to
2617normal output.
48d9ade5
RK
2618@item e
2619Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2620@file{@var{file}.06.ussa}.
470fc13d 2621@item E
8bb16620 2622Dump after the second if conversion, to @file{@var{file}.24.ce2}.
74291a4b 2623@item f
470fc13d 2624Dump after life analysis, to @file{@var{file}.13.life}.
48d9ade5
RK
2625@item F
2626Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
74291a4b 2627@item g
470fc13d 2628Dump after global register allocation, to @file{@var{file}.19.greg}.
8bb16620
BS
2629@item o
2630Dump after post-reload CSE and other optimizations, to @file{@var{file}.20.postreload}.
7506f491 2631@item G
470fc13d 2632Dump after GCSE, to @file{@var{file}.08.gcse}.
48d9ade5
RK
2633@item i
2634Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
032713aa 2635@item j
470fc13d 2636Dump after the first jump optimization, to @file{@var{file}.02.jump}.
74291a4b 2637@item J
8bb16620 2638Dump after the last jump optimization, to @file{@var{file}.27.jump2}.
74291a4b 2639@item k
470fc13d 2640Dump after conversion from registers to stack, to @file{@var{file}.29.stack}.
032713aa 2641@item l
470fc13d 2642Dump after local register allocation, to @file{@var{file}.18.lreg}.
032713aa 2643@item L
470fc13d 2644Dump after loop optimization, to @file{@var{file}.09.loop}.
032713aa
NC
2645@item M
2646Dump after performing the machine dependent reorganisation pass, to
8bb16620 2647@file{@var{file}.28.mach}.
48d9ade5 2648@item n
470fc13d 2649Dump after register renumbering, to @file{@var{file}.23.rnreg}.
032713aa 2650@item N
470fc13d 2651Dump after the register move pass, to @file{@var{file}.16.regmove}.
032713aa 2652@item r
375e2d5c 2653Dump after RTL generation, to @file{@var{file}.00.rtl}.
032713aa 2654@item R
375e2d5c 2655Dump after the second instruction scheduling pass, to
8bb16620 2656@file{@var{file}.25.sched2}.
032713aa
NC
2657@item s
2658Dump after CSE (including the jump optimization that sometimes follows
48d9ade5 2659CSE), to @file{@var{file}.03.cse}.
032713aa 2660@item S
375e2d5c 2661Dump after the first instruction scheduling pass, to
470fc13d 2662@file{@var{file}.17.sched}.
032713aa
NC
2663@item t
2664Dump after the second CSE pass (including the jump optimization that
470fc13d 2665sometimes follows CSE), to @file{@var{file}.10.cse2}.
48d9ade5 2666@item w
8bb16620 2667Dump after the second flow pass, to @file{@var{file}.21.flow2}.
470fc13d
KH
2668@item X
2669Dump after dead code elimination, to @file{@var{file}.06.dce}.
48d9ade5 2670@item z
470fc13d 2671Dump after the peephole pass, to @file{@var{file}.22.peephole2}.
74291a4b
MM
2672@item a
2673Produce all the dumps listed above.
2674@item m
2675Print statistics on memory usage, at the end of the run, to
2676standard error.
2677@item p
2678Annotate the assembler output with a comment indicating which
f20b5577
MM
2679pattern and alternative was used. The length of each instruction is
2680also printed.
2856c3e3
SC
2681@item P
2682Dump the RTL in the assembler output as a comment before each instruction.
2683Also turns on @samp{-dp} annotation.
375e2d5c
RH
2684@item v
2685For each of the other indicated dump files (except for
2686@file{@var{file}.00.rtl}), dump a representation of the control flow graph
b192711e 2687suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
62a1403d
AS
2688@item x
2689Just generate RTL for a function instead of compiling it. Usually used
2690with @samp{r}.
032713aa
NC
2691@item y
2692Dump debugging information during parsing, to standard error.
74291a4b
MM
2693@end table
2694
b707b450
R
2695@item -fdump-unnumbered
2696When doing debugging dumps (see -d option above), suppress instruction
2697numbers and line number note output. This makes it more feasible to
b192711e 2698use diff on debugging dumps for compiler invocations with different
b707b450
R
2699options, in particular with and without -g.
2700
9965d119 2701@item -fdump-translation-unit=@var{file} (C and C++ only)
f71f87f9
MM
2702Dump a representation of the tree structure for the entire translation
2703unit to @var{file}.
2704
9965d119
NS
2705@item -fdump-class_layout=@var{file} (C++ only)
2706@item -fdump-class_layout (C++ only)
2707Dump a representation of each class's heirarchy to @var{file}, or
2708@code{stderr} if not specified.
2709
74291a4b
MM
2710@item -fpretend-float
2711When running a cross-compiler, pretend that the target machine uses the
2712same floating point format as the host machine. This causes incorrect
2713output of the actual floating constants, but the actual instruction
0c2d1a2a 2714sequence will probably be the same as GCC would make when running on
74291a4b
MM
2715the target machine.
2716
2717@item -save-temps
2718Store the usual ``temporary'' intermediate files permanently; place them
2719in the current directory and name them based on the source file. Thus,
2720compiling @file{foo.c} with @samp{-c -save-temps} would produce files
f2ecb02d
JM
2721@file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
2722preprocessed @file{foo.i} output file even though the compiler now
2723normally uses an integrated preprocessor.
74291a4b 2724
03c41c05
ZW
2725@item -time
2726Report the CPU time taken by each subprocess in the compilation
f2ecb02d
JM
2727sequence. For C source files, this is the compiler proper and assembler
2728(plus the linker if linking is done). The output looks like this:
03c41c05
ZW
2729
2730@smallexample
03c41c05
ZW
2731# cc1 0.12 0.01
2732# as 0.00 0.01
2733@end smallexample
2734
2735The first number on each line is the ``user time,'' that is time spent
2736executing the program itself. The second number is ``system time,''
2737time spent executing operating system routines on behalf of the program.
2738Both numbers are in seconds.
2739
74291a4b
MM
2740@item -print-file-name=@var{library}
2741Print the full absolute name of the library file @var{library} that
2742would be used when linking---and don't do anything else. With this
0c2d1a2a 2743option, GCC does not compile or link anything; it just prints the
74291a4b
MM
2744file name.
2745
2746@item -print-prog-name=@var{program}
2747Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2748
2749@item -print-libgcc-file-name
2750Same as @samp{-print-file-name=libgcc.a}.
2751
2752This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2753but you do want to link with @file{libgcc.a}. You can do
2754
2755@example
2756gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2757@end example
2758
2759@item -print-search-dirs
2760Print the name of the configured installation directory and a list of
2761program and library directories gcc will search---and don't do anything else.
2762
2763This is useful when gcc prints the error message
3c0b7970
JM
2764@samp{installation problem, cannot exec cpp0: No such file or directory}.
2765To resolve this you either need to put @file{cpp0} and the other compiler
74291a4b 2766components where gcc expects to find them, or you can set the environment
bedc7537 2767variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
74291a4b
MM
2768Don't forget the trailing '/'.
2769@xref{Environment Variables}.
1f0c3120
JM
2770
2771@item -dumpmachine
2772Print the compiler's target machine (for example,
2773@samp{i686-pc-linux-gnu})---and don't do anything else.
2774
2775@item -dumpversion
2776Print the compiler version (for example, @samp{3.0})---and don't do
2777anything else.
2778
2779@item -dumpspecs
2780Print the compiler's built-in specs---and don't do anything else. (This
2781is used when GCC itself is being built.) @xref{Spec Files}.
74291a4b
MM
2782@end table
2783
2784@node Optimize Options
2785@section Options That Control Optimization
2786@cindex optimize options
2787@cindex options, optimization
2788
2789These options control various sorts of optimizations:
2790
2642624b 2791@table @gcctabopt
74291a4b
MM
2792@item -O
2793@itemx -O1
2794Optimize. Optimizing compilation takes somewhat more time, and a lot
2795more memory for a large function.
2796
2797Without @samp{-O}, the compiler's goal is to reduce the cost of
2798compilation and to make debugging produce the expected results.
2799Statements are independent: if you stop the program with a breakpoint
2800between statements, you can then assign a new value to any variable or
2801change the program counter to any other statement in the function and
2802get exactly the results you would expect from the source code.
2803
2804Without @samp{-O}, the compiler only allocates variables declared
2805@code{register} in registers. The resulting compiled code is a little
2806worse than produced by PCC without @samp{-O}.
2807
2808With @samp{-O}, the compiler tries to reduce code size and execution
2809time.
2810
2811When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2812and @samp{-fdefer-pop} on all machines. The compiler turns on
2813@samp{-fdelayed-branch} on machines that have delay slots, and
2814@samp{-fomit-frame-pointer} on machines that can support debugging even
2815without a frame pointer. On some machines the compiler also turns
2816on other flags.@refill
2817
2818@item -O2
0c2d1a2a 2819Optimize even more. GCC performs nearly all supported optimizations
74291a4b
MM
2820that do not involve a space-speed tradeoff. The compiler does not
2821perform loop unrolling or function inlining when you specify @samp{-O2}.
2822As compared to @samp{-O}, this option increases both compilation time
2823and the performance of the generated code.
2824
2b2a8f1f
RH
2825@samp{-O2} turns on all optional optimizations except for loop unrolling,
2826function inlining, and register renaming. It also turns on the
2827@samp{-fforce-mem} option on all machines and frame pointer elimination
2828on machines where doing so does not interfere with debugging.
74291a4b
MM
2829
2830@item -O3
2831Optimize yet more. @samp{-O3} turns on all optimizations specified by
2b2a8f1f
RH
2832@samp{-O2} and also turns on the @samp{-finline-functions} and
2833@samp{-frename-registers} options.
74291a4b
MM
2834
2835@item -O0
2836Do not optimize.
2837
c6aded7c
AG
2838@item -Os
2839Optimize for size. @samp{-Os} enables all @samp{-O2} optimizations that
2840do not typically increase code size. It also performs further
2841optimizations designed to reduce code size.
2842
74291a4b
MM
2843If you use multiple @samp{-O} options, with or without level numbers,
2844the last such option is the one that is effective.
2845@end table
2846
2847Options of the form @samp{-f@var{flag}} specify machine-independent
2848flags. Most flags have both positive and negative forms; the negative
2849form of @samp{-ffoo} would be @samp{-fno-foo}. In the table below,
2850only one of the forms is listed---the one which is not the default.
2851You can figure out the other form by either removing @samp{no-} or
2852adding it.
2853
2642624b 2854@table @gcctabopt
74291a4b
MM
2855@item -ffloat-store
2856Do not store floating point variables in registers, and inhibit other
2857options that might change whether a floating point value is taken from a
2858register or memory.
2859
2860@cindex floating point precision
2861This option prevents undesirable excess precision on machines such as
2862the 68000 where the floating registers (of the 68881) keep more
2863precision than a @code{double} is supposed to have. Similarly for the
2864x86 architecture. For most programs, the excess precision does only
2865good, but a few programs rely on the precise definition of IEEE floating
6fd74494
CB
2866point. Use @samp{-ffloat-store} for such programs, after modifying
2867them to store all pertinent intermediate computations into variables.
74291a4b
MM
2868
2869@item -fno-default-inline
2870Do not make member functions inline by default merely because they are
2871defined inside the class scope (C++ only). Otherwise, when you specify
2872@w{@samp{-O}}, member functions defined inside class scope are compiled
2873inline by default; i.e., you don't need to add @samp{inline} in front of
2874the member function name.
2875
2876@item -fno-defer-pop
2877Always pop the arguments to each function call as soon as that function
2878returns. For machines which must pop arguments after a function call,
2879the compiler normally lets arguments accumulate on the stack for several
2880function calls and pops them all at once.
2881
2882@item -fforce-mem
2883Force memory operands to be copied into registers before doing
2884arithmetic on them. This produces better code by making all memory
2885references potential common subexpressions. When they are not common
2886subexpressions, instruction combination should eliminate the separate
2887register-load. The @samp{-O2} option turns on this option.
2888
2889@item -fforce-addr
2890Force memory address constants to be copied into registers before
2891doing arithmetic on them. This may produce better code just as
2892@samp{-fforce-mem} may.
2893
2894@item -fomit-frame-pointer
2895Don't keep the frame pointer in a register for functions that
2896don't need one. This avoids the instructions to save, set up and
2897restore frame pointers; it also makes an extra register available
2898in many functions. @strong{It also makes debugging impossible on
2899some machines.}
2900
2901@ifset INTERNALS
2902On some machines, such as the Vax, this flag has no effect, because
2903the standard calling sequence automatically handles the frame pointer
2904and nothing is saved by pretending it doesn't exist. The
2905machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2906whether a target machine supports this flag. @xref{Registers}.@refill
2907@end ifset
2908@ifclear INTERNALS
2909On some machines, such as the Vax, this flag has no effect, because
2910the standard calling sequence automatically handles the frame pointer
2911and nothing is saved by pretending it doesn't exist. The
2912machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2913whether a target machine supports this flag. @xref{Registers,,Register
2914Usage, gcc.info, Using and Porting GCC}.@refill
2915@end ifclear
2916
1aaef9c1
JH
2917@item -foptimize-sibling-calls
2918Optimize sibling and tail recursive calls.
2919
91ce572a
CC
2920@item -ftrapv
2921This option generates traps for signed overflow on addition, subtraction,
2922multiplication operations.
2923
74291a4b
MM
2924@item -fno-inline
2925Don't pay attention to the @code{inline} keyword. Normally this option
2926is used to keep the compiler from expanding any functions inline.
2927Note that if you are not optimizing, no functions can be expanded inline.
2928
2929@item -finline-functions
2930Integrate all simple functions into their callers. The compiler
2931heuristically decides which functions are simple enough to be worth
2932integrating in this way.
2933
2934If all calls to a given function are integrated, and the function is
2935declared @code{static}, then the function is normally not output as
2936assembler code in its own right.
2937
efa3896a 2938@item -finline-limit=@var{n}
f9e814f1
TP
2939By default, gcc limits the size of functions that can be inlined. This flag
2940allows the control of this limit for functions that are explicitly marked as
2941inline (ie marked with the inline keyword or defined within the class
2942definition in c++). @var{n} is the size of functions that can be inlined in
2943number of pseudo instructions (not counting parameter handling). The default
2944value of n is 10000. Increasing this value can result in more inlined code at
2945the cost of compilation time and memory consumption. Decreasing usually makes
2946the compilation faster and less code will be inlined (which presumably
2947means slower programs). This option is particularly useful for programs that
2948use inlining heavily such as those based on recursive templates with c++.
2949
2950@emph{Note:} pseudo instruction represents, in this particular context, an
2951abstract measurement of function's size. In no way, it represents a count
2952of assembly instructions and as such its exact meaning might change from one
2953release to an another.
2954
74291a4b
MM
2955@item -fkeep-inline-functions
2956Even if all calls to a given function are integrated, and the function
2957is declared @code{static}, nevertheless output a separate run-time
2958callable version of the function. This switch does not affect
2959@code{extern inline} functions.
2960
2961@item -fkeep-static-consts
2962Emit variables declared @code{static const} when optimization isn't turned
2963on, even if the variables aren't referenced.
2964
0c2d1a2a 2965GCC enables this option by default. If you want to force the compiler to
74291a4b
MM
2966check if the variable was referenced, regardless of whether or not
2967optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2968
2969@item -fno-function-cse
2970Do not put function addresses in registers; make each instruction that
2971calls a constant function contain the function's address explicitly.
2972
2973This option results in less efficient code, but some strange hacks
2974that alter the assembler output may be confused by the optimizations
2975performed when this option is not used.
2976
2977@item -ffast-math
de6c5979
BL
2978Sets @samp{-fno-math-errno}, @samp{-funsafe-math-optimizations},
2979and @samp{-fno-trapping-math}.
2980
2981This option causes the preprocessor macro __FAST_MATH__ to be defined.
74291a4b
MM
2982
2983This option should never be turned on by any @samp{-O} option since
2984it can result in incorrect output for programs which depend on
c1030c7c 2985an exact implementation of IEEE or ISO rules/specifications for
74291a4b 2986math functions.
9605da8a
BL
2987
2988@item -fno-math-errno
2989Do not set ERRNO after calling math functions that are executed
2990with a single instruction, e.g., sqrt. A program that relies on
2991IEEE exceptions for math error handling may want to use this flag
2992for speed while maintaining IEEE arithmetic compatibility.
2993
de6c5979
BL
2994This option should never be turned on by any @samp{-O} option since
2995it can result in incorrect output for programs which depend on
2996an exact implementation of IEEE or ISO rules/specifications for
2997math functions.
2998
9605da8a
BL
2999The default is @samp{-fmath-errno}. The @samp{-ffast-math} option
3000sets @samp{-fno-math-errno}.
de6c5979
BL
3001
3002@item -funsafe-math-optimizations
3003Allow optimizations for floating-point arithmetic that (a) assume
3004that arguments and results are valid and (b) may violate IEEE or
3005ANSI standards.
3006
3007This option should never be turned on by any @samp{-O} option since
3008it can result in incorrect output for programs which depend on
3009an exact implementation of IEEE or ISO rules/specifications for
3010math functions.
3011
3012The default is @samp{-fno-unsafe-math-optimizations}. The
3013@samp{-ffast-math} option sets @samp{-funsafe-math-optimizations}.
3014
3015@item -fno-trapping-math
3016Compile code assuming that floating-point operations cannot generate
3017user-visible traps. Setting this option may allow faster code
3018if one relies on ``non-stop'' IEEE arithmetic, for example.
3019
3020This option should never be turned on by any @samp{-O} option since
3021it can result in incorrect output for programs which depend on
3022an exact implementation of IEEE or ISO rules/specifications for
3023math functions.
3024
3025The default is @samp{-ftrapping-math}. The @samp{-ffast-math}
3026option sets @samp{-fno-trapping-math}.
74291a4b
MM
3027@end table
3028
3029@c following causes underfulls.. they don't look great, but we deal.
3030@c --mew 26jan93
3031The following options control specific optimizations. The @samp{-O2}
3032option turns on all of these optimizations except @samp{-funroll-loops}
3033and @samp{-funroll-all-loops}. On most machines, the @samp{-O} option
3034turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
3035but specific machines may handle it differently.
3036
3037You can use the following flags in the rare cases when ``fine-tuning''
3038of optimizations to be performed is desired.
3039
2642624b 3040@table @gcctabopt
74291a4b
MM
3041@item -fstrength-reduce
3042Perform the optimizations of loop strength reduction and
3043elimination of iteration variables.
3044
3045@item -fthread-jumps
3046Perform optimizations where we check to see if a jump branches to a
3047location where another comparison subsumed by the first is found. If
3048so, the first branch is redirected to either the destination of the
3049second branch or a point immediately following it, depending on whether
3050the condition is known to be true or false.
3051
3052@item -fcse-follow-jumps
3053In common subexpression elimination, scan through jump instructions
3054when the target of the jump is not reached by any other path. For
3055example, when CSE encounters an @code{if} statement with an
3056@code{else} clause, CSE will follow the jump when the condition
3057tested is false.
3058
3059@item -fcse-skip-blocks
3060This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
3061follow jumps which conditionally skip over blocks. When CSE
3062encounters a simple @code{if} statement with no else clause,
3063@samp{-fcse-skip-blocks} causes CSE to follow the jump around the
3064body of the @code{if}.
3065
3066@item -frerun-cse-after-loop
3067Re-run common subexpression elimination after loop optimizations has been
3068performed.
3069
6d6d0fa0
JL
3070@item -frerun-loop-opt
3071Run the loop optimizer twice.
3072
7506f491
DE
3073@item -fgcse
3074Perform a global common subexpression elimination pass.
3075This pass also performs global constant and copy propagation.
3076
a13d4ebf
AM
3077@item -fgcse-lm
3078When -fgcse-lm is enabled, global common subexpression elimination will
3079attempt to move loads which are only killed by stores into themselves. This
3080allows a loop containing a load/store sequence to be changed to a load outside
3081the loop, and a copy/store within the loop.
3082
3083@item -fgcse-sm
3084When -fgcse-sm is enabled, A store motion pass is run after global common
3085subexpression elimination. This pass will attempt to move stores out of loops.
3086When used in conjunction with -fgcse-lm, loops containing a load/store sequence
3087can be changed to a load before the loop and a store after the loop.
3088
b6d24183
JL
3089@item -fdelete-null-pointer-checks
3090Use global dataflow analysis to identify and eliminate useless null
3091pointer checks. Programs which rely on NULL pointer dereferences @emph{not}
3092halting the program may not work properly with this option. Use
3093-fno-delete-null-pointer-checks to disable this optimizing for programs
3094which depend on that behavior.
3095
74291a4b
MM
3096@item -fexpensive-optimizations
3097Perform a number of minor optimizations that are relatively expensive.
3098
639726ba 3099@item -foptimize-register-move
59d40964 3100@itemx -fregmove
9ec36da5
JL
3101Attempt to reassign register numbers in move instructions and as
3102operands of other simple instructions in order to maximize the amount of
56159047 3103register tying. This is especially helpful on machines with two-operand
0c2d1a2a 3104instructions. GCC enables this optimization by default with @samp{-O2}
9ec36da5
JL
3105or higher.
3106
bedc7537 3107Note @option{-fregmove} and @option{-foptimize-register-move} are the same
9ec36da5
JL
3108optimization.
3109
74291a4b
MM
3110@item -fdelayed-branch
3111If supported for the target machine, attempt to reorder instructions
3112to exploit instruction slots available after delayed branch
3113instructions.
3114
3115@item -fschedule-insns
3116If supported for the target machine, attempt to reorder instructions to
3117eliminate execution stalls due to required data being unavailable. This
3118helps machines that have slow floating point or memory load instructions
3119by allowing other instructions to be issued until the result of the load
3120or floating point instruction is required.
3121
3122@item -fschedule-insns2
3123Similar to @samp{-fschedule-insns}, but requests an additional pass of
3124instruction scheduling after register allocation has been done. This is
3125especially useful on machines with a relatively small number of
3126registers and where memory load instructions take more than one cycle.
3127
3128@item -ffunction-sections
59d40964 3129@itemx -fdata-sections
7d0756fb
CM
3130Place each function or data item into its own section in the output
3131file if the target supports arbitrary sections. The name of the
3132function or the name of the data item determines the section's name
3133in the output file.
74291a4b 3134
7d0756fb 3135Use these options on systems where the linker can perform optimizations
74291a4b
MM
3136to improve locality of reference in the instruction space. HPPA
3137processors running HP-UX and Sparc processors running Solaris 2 have
3138linkers with such optimizations. Other systems using the ELF object format
3139as well as AIX may have these optimizations in the future.
3140
7d0756fb
CM
3141Only use these options when there are significant benefits from doing
3142so. When you specify these options, the assembler and linker will
74291a4b
MM
3143create larger object and executable files and will also be slower.
3144You will not be able to use @code{gprof} on all systems if you
3145specify this option and you may have problems with debugging if
3146you specify both this option and @samp{-g}.
3147
3148@item -fcaller-saves
3149Enable values to be allocated in registers that will be clobbered by
3150function calls, by emitting extra instructions to save and restore the
3151registers around such calls. Such allocation is done only when it
3152seems to result in better code than would otherwise be produced.
3153
81610a0d
HPN
3154This option is always enabled by default on certain machines, usually
3155those which have no call-preserved registers to use instead.
3156
3157For all machines, optimization level 2 and higher enables this flag by
3158default.
74291a4b
MM
3159
3160@item -funroll-loops
3161Perform the optimization of loop unrolling. This is only done for loops
3162whose number of iterations can be determined at compile time or run time.
1bd31d56 3163@samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
74291a4b
MM
3164@samp{-frerun-cse-after-loop}.
3165
3166@item -funroll-all-loops
3167Perform the optimization of loop unrolling. This is done for all loops
3168and usually makes programs run more slowly. @samp{-funroll-all-loops}
3169implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
3170
e5eb27e5
JL
3171@item -fmove-all-movables
3172Forces all invariant computations in loops to be moved
3173outside the loop.
3174
3175@item -freduce-all-givs
3176Forces all general-induction variables in loops to be
3177strength-reduced.
3178
3179@emph{Note:} When compiling programs written in Fortran,
1bd31d56 3180@samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
e5eb27e5
JL
3181by default when you use the optimizer.
3182
3183These options may generate better or worse code; results are highly
3184dependent on the structure of loops within the source code.
3185
3186These two options are intended to be removed someday, once
3187they have helped determine the efficacy of various
3188approaches to improving loop optimizations.
3189
2642624b 3190Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
e5eb27e5
JL
3191know how use of these options affects
3192the performance of your production code.
3193We're very interested in code that runs @emph{slower}
3194when these options are @emph{enabled}.
3195
74291a4b
MM
3196@item -fno-peephole
3197Disable any machine-specific peephole optimizations.
861bb6c1
JL
3198
3199@item -fbranch-probabilities
3200After running a program compiled with @samp{-fprofile-arcs}
3201(@pxref{Debugging Options,, Options for Debugging Your Program or
bedc7537 3202@command{gcc}}), you can compile it a second time using
861bb6c1
JL
3203@samp{-fbranch-probabilities}, to improve optimizations based on
3204guessing the path a branch might take.
3205
3206@ifset INTERNALS
e5e809f4 3207With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
861bb6c1
JL
3208note on the first instruction of each basic block, and a
3209@samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3210These can be used to improve optimization. Currently, they are only
3211used in one place: in @file{reorg.c}, instead of guessing which path a
3212branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3213exactly determine which path is taken more often.
3214@end ifset
8c660648 3215
454d0cc7
AH
3216@item -fno-guess-branch-probability
3217Sometimes gcc will opt to guess branch probabilities when none are
3218available from either profile directed feedback (@samp{-fprofile-arcs})
2bab2366 3219or @samp{__builtin_expect}. In a hard real-time system, people don't
454d0cc7
AH
3220want different runs of the compiler to produce code that has different
3221behavior; minimizing non-determinism is of paramount import. This
3222switch allows users to reduce non-determinism, possibly at the expense
3223of inferior optimization.
3224
41472af8
MM
3225@item -fstrict-aliasing
3226Allows the compiler to assume the strictest aliasing rules applicable to
3227the language being compiled. For C (and C++), this activates
3228optimizations based on the type of expressions. In particular, an
3229object of one type is assumed never to reside at the same address as an
3230object of a different type, unless the types are almost the same. For
3231example, an @code{unsigned int} can alias an @code{int}, but not a
3232@code{void*} or a @code{double}. A character type may alias any other
3233type.
3234
3235Pay special attention to code like this:
3236@example
3237union a_union @{
3238 int i;
3239 double d;
3240@};
3241
3242int f() @{
3243 a_union t;
3244 t.d = 3.0;
3245 return t.i;
3246@}
3247@end example
3248The practice of reading from a different union member than the one most
3249recently written to (called ``type-punning'') is common. Even with
3250@samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
3251is accessed through the union type. So, the code above will work as
3252expected. However, this code might not:
3253@example
3254int f() @{
3255 a_union t;
3256 int* ip;
3257 t.d = 3.0;
3258 ip = &t.i;
3259 return *ip;
3260@}
3261@end example
3262
41472af8
MM
3263@ifset INTERNALS
3264Every language that wishes to perform language-specific alias analysis
3265should define a function that computes, given an @code{tree}
3266node, an alias set for the node. Nodes in different alias sets are not
3267allowed to alias. For an example, see the C front-end function
3268@code{c_get_alias_set}.
3269@end ifset
3270
efa3896a
GK
3271@item -falign-functions
3272@itemx -falign-functions=@var{n}
3273Align the start of functions to the next power-of-two greater than
3274@var{n}, skipping up to @var{n} bytes. For instance,
3275@samp{-falign-functions=32} aligns functions to the next 32-byte
3276boundary, but @samp{-falign-functions=24} would align to the next
327732-byte boundary only if this can be done by skipping 23 bytes or less.
3278
3279@samp{-fno-align-functions} and @samp{-falign-functions=1} are
3280equivalent and mean that functions will not be aligned.
3281
3282Some assemblers only support this flag when @var{n} is a power of two;
3283in that case, it is rounded up.
3284
3285If @var{n} is not specified, use a machine-dependent default.
3286
3287@item -falign-labels
3288@itemx -falign-labels=@var{n}
3289Align all branch targets to a power-of-two boundary, skipping up to
3290@var{n} bytes like @samp{-falign-functions}. This option can easily
3291make code slower, because it must insert dummy operations for when the
3292branch target is reached in the usual flow of the code.
3293
3294If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
3295are greater than this value, then their values are used instead.
3296
3297If @var{n} is not specified, use a machine-dependent default which is
3298very likely to be @samp{1}, meaning no alignment.
3299
3300@item -falign-loops
3301@itemx -falign-loops=@var{n}
3302Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3303like @samp{-falign-functions}. The hope is that the loop will be
3304executed many times, which will make up for any execution of the dummy
3305operations.
3306
3307If @var{n} is not specified, use a machine-dependent default.
3308
3309@item -falign-jumps
3310@itemx -falign-jumps=@var{n}
3311Align branch targets to a power-of-two boundary, for branch targets
3312where the targets can only be reached by jumping, skipping up to @var{n}
3313bytes like @samp{-falign-functions}. In this case, no dummy operations
3314need be executed.
3315
3316If @var{n} is not specified, use a machine-dependent default.
3317
4bae0b47
AS
3318@item -fssa
3319Perform optimizations in static single assignment form. Each function's
3320flow graph is translated into SSA form, optimizations are performed, and
b53978a3
JO
3321the flow graph is translated back from SSA form. User's should not
3322specify this option, since it is not yet ready for production use.
3323
3324@item -fdce
3325Perform dead-code elimination in SSA form. Requires @samp{-fssa}. Like
3326@samp{-fssa}, this is an experimental feature.
4bae0b47 3327
46d3a873
CC
3328@item -fsingle-precision-constant
3329Treat floating point constant as single precision constant instead of
3330implicitly converting it to double precision constant.
3331
2b2a8f1f
RH
3332@item -frename-registers
3333Attempt to avoid false dependancies in scheduled code by making use
3334of registers left over after register allocation. This optimization
3335will most benefit processors with lots of registers. It can, however,
3336make debugging impossible, since variables will no longer stay in
3337a ``home register''.
3af64fd6
MM
3338
3339@item --param @var{name}=@var{value}
3340In some places, GCC uses various constants to control the amount of
3341optimization that is done. For example, GCC will not inline functions
3342that contain more that a certain number of instructions. You can
3343control some of these constants on the command-line using the
3344@samp{--param} option.
3345
3346In each case, the @var{value} is a integer. The allowable choices for
3347@var{name} are given in the following table:
3348
3349@table @gcctabopt
3350@item max-inline-insns
3351If an function contains more than this many instructions, it
3352will not be inlined. This option is precisely equivalent to
3353@samp{-finline-limit}.
33d3b05b
MM
3354
3355@item max-gcse-memory
3356The approximate maximum amount of memory that will be allocated in
3357order to perform the global common subexpression elimination
3358optimization. If more memory than specified is required, the
3359optimization will not be done.
3af64fd6
MM
3360@end table
3361
74291a4b
MM
3362@end table
3363
3364@node Preprocessor Options
3365@section Options Controlling the Preprocessor
3366@cindex preprocessor options
3367@cindex options, preprocessor
3368
3369These options control the C preprocessor, which is run on each C source
3370file before actual compilation.
3371
3372If you use the @samp{-E} option, nothing is done except preprocessing.
3373Some of these options make sense only together with @samp{-E} because
3374they cause the preprocessor output to be unsuitable for actual
3375compilation.
3376
2642624b 3377@table @gcctabopt
74291a4b
MM
3378@item -include @var{file}
3379Process @var{file} as input before processing the regular input file.
3380In effect, the contents of @var{file} are compiled first. Any @samp{-D}
3381and @samp{-U} options on the command line are always processed before
3382@samp{-include @var{file}}, regardless of the order in which they are
3383written. All the @samp{-include} and @samp{-imacros} options are
3384processed in the order in which they are written.
3385
3386@item -imacros @var{file}
3387Process @var{file} as input, discarding the resulting output, before
3388processing the regular input file. Because the output generated from
3389@var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3390is to make the macros defined in @var{file} available for use in the
e582248c
NB
3391main input. All the @samp{-include} and @samp{-imacros} options are
3392processed in the order in which they are written.
74291a4b
MM
3393
3394@item -idirafter @var{dir}
3395@cindex second include path
3396Add the directory @var{dir} to the second include path. The directories
3397on the second include path are searched when a header file is not found
3398in any of the directories in the main include path (the one that
3399@samp{-I} adds to).
3400
3401@item -iprefix @var{prefix}
3402Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3403options.
3404
3405@item -iwithprefix @var{dir}
3406Add a directory to the second include path. The directory's name is
3407made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3408specified previously with @samp{-iprefix}. If you have not specified a
3409prefix yet, the directory containing the installed passes of the
3410compiler is used as the default.
3411
3412@item -iwithprefixbefore @var{dir}
3413Add a directory to the main include path. The directory's name is made
3414by concatenating @var{prefix} and @var{dir}, as in the case of
3415@samp{-iwithprefix}.
3416
3417@item -isystem @var{dir}
3418Add a directory to the beginning of the second include path, marking it
3419as a system directory, so that it gets the same special treatment as
3420is applied to the standard system directories.
3421
3422@item -nostdinc
3423Do not search the standard system directories for header files. Only
3424the directories you have specified with @samp{-I} options (and the
3425current directory, if appropriate) are searched. @xref{Directory
3426Options}, for information on @samp{-I}.
3427
3428By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3429search path to only those directories you specify explicitly.
3430
e582248c
NB
3431@item -remap
3432@findex -remap
3433When searching for a header file in a directory, remap file names if a
3434file named @file{header.gcc} exists in that directory. This can be used
3435to work around limitations of file systems with file name restrictions.
3436The @file{header.gcc} file should contain a series of lines with two
3437tokens on each line: the first token is the name to map, and the second
3438token is the actual name to use.
3439
74291a4b
MM
3440@item -undef
3441Do not predefine any nonstandard macros. (Including architecture flags).
3442
3443@item -E
3444Run only the C preprocessor. Preprocess all the C source files
3445specified and output the results to standard output or to the
3446specified output file.
3447
3448@item -C
3449Tell the preprocessor not to discard comments. Used with the
3450@samp{-E} option.
3451
3452@item -P
3453Tell the preprocessor not to generate @samp{#line} directives.
3454Used with the @samp{-E} option.
3455
3456@cindex make
3457@cindex dependencies, make
3458@item -M
e582248c
NB
3459@findex -M
3460Instead of outputting the result of preprocessing, output a rule
3461suitable for @code{make} describing the dependencies of the main source
3462file. The preprocessor outputs one @code{make} rule containing the
3463object file name for that source file, a colon, and the names of all the
48ce6bbb
NS
3464included files. Unless overridden explicitly, the object file name
3465consists of the basename of the source file with any suffix replaced with
3466object file suffix. If there are many included files then the
3467rule is split into several lines using @samp{\}-newline.
74291a4b
MM
3468
3469@samp{-M} implies @samp{-E}.
3470
e582248c
NB
3471@item -MM
3472@findex -MM
3473Like @samp{-M}, but mention only the files included with @samp{#include
3474"@var{file}"}. System header files included with @samp{#include
3475<@var{file}>} are omitted.
3476
7da723ef
NB
3477@item -MD
3478@findex -MD
3479Like @samp{-M} but the dependency information is written to a file
3480rather than stdout. @code{gcc} will use the same file name and
3481directory as the object file, but with the suffix ".d" instead.
3482
3483This is in addition to compiling the main file as specified ---
3484@samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
3485unless you also specify @samp{-MG}.
3486
3487With Mach, you can use the utility @code{md} to merge multiple
3488dependency files into a single dependency file suitable for using with
3489the @samp{make} command.
3490
d396403a 3491@item -MMD
7da723ef
NB
3492@findex -MMD
3493Like @samp{-MD} except mention only user header files, not system
3494-header files.
3495
e582248c
NB
3496@item -MF @var{file}
3497@findex -MF
3498When used with @samp{-M} or @samp{-MM}, specifies a file to write the
3499dependencies to. This allows the preprocessor to write the preprocessed
3500file to stdout normally. If no @samp{-MF} switch is given, CPP sends
3501the rules to stdout and suppresses normal preprocessed output.
3502
74291a4b 3503Another way to specify output of a @code{make} rule is by setting
bedc7537 3504the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
74291a4b
MM
3505Variables}).
3506
74291a4b 3507@item -MG
e582248c
NB
3508@findex -MG
3509When used with @samp{-M} or @samp{-MM}, @samp{-MG} says to treat missing
3510header files as generated files and assume they live in the same
3511directory as the source file. It suppresses preprocessed output, as a
3512missing header file is ordinarily an error.
3513
3514This feature is used in automatic updating of makefiles.
3515
3516@item -MP
3517@findex -MP
3518This option instructs CPP to add a phony target for each dependency
3519other than the main file, causing each to depend on nothing. These
3520dummy rules work around errors @code{make} gives if you remove header
3521files without updating the @code{Makefile} to match.
3522
3523This is typical output:-
3524
3525@smallexample
3526/tmp/test.o: /tmp/test.c /tmp/test.h
3527
3528/tmp/test.h:
3529@end smallexample
3530
3531@item -MQ @var{target}
3532@item -MT @var{target}
3533@findex -MQ
3534@findex -MT
3535By default CPP uses the main file name, including any path, and appends
3536the object suffix, normally ``.o'', to it to obtain the name of the
3537target for dependency generation. With @samp{-MT} you can specify a
3538target yourself, overriding the default one.
3539
3540If you want multiple targets, you can specify them as a single argument
3541to @samp{-MT}, or use multiple @samp{-MT} options.
3542
3543The targets you specify are output in the order they appear on the
3544command line. @samp{-MQ} is identical to @samp{-MT}, except that the
3545target name is quoted for Make, but with @samp{-MT} it isn't. For
3546example, -MT '$(objpfx)foo.o' gives
3547
3548@smallexample
3549$(objpfx)foo.o: /tmp/foo.c
3550@end smallexample
3551
3552but -MQ '$(objpfx)foo.o' gives
3553
3554@smallexample
3555$$(objpfx)foo.o: /tmp/foo.c
3556@end smallexample
3557
3558The default target is automatically quoted, as if it were given with
3559@samp{-MQ}.
74291a4b
MM
3560
3561@item -H
3562Print the name of each header file used, in addition to other normal
3563activities.
3564
3565@item -A@var{question}(@var{answer})
3566Assert the answer @var{answer} for @var{question}, in case it is tested
3567with a preprocessing conditional such as @samp{#if
3568#@var{question}(@var{answer})}. @samp{-A-} disables the standard
3569assertions that normally describe the target machine.
3570
3571@item -D@var{macro}
3572Define macro @var{macro} with the string @samp{1} as its definition.
3573
3574@item -D@var{macro}=@var{defn}
3575Define macro @var{macro} as @var{defn}. All instances of @samp{-D} on
3576the command line are processed before any @samp{-U} options.
3577
e582248c
NB
3578Any @samp{-D} and @samp{-U} options on the command line are processed in
3579order, and always before @samp{-imacros @var{file}}, regardless of the
3580order in which they are written.
3581
74291a4b
MM
3582@item -U@var{macro}
3583Undefine macro @var{macro}. @samp{-U} options are evaluated after all
3584@samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3585options.
3586
e582248c
NB
3587Any @samp{-D} and @samp{-U} options on the command line are processed in
3588order, and always before @samp{-imacros @var{file}}, regardless of the
3589order in which they are written.
3590
74291a4b
MM
3591@item -dM
3592Tell the preprocessor to output only a list of the macro definitions
3593that are in effect at the end of preprocessing. Used with the @samp{-E}
3594option.
3595
3596@item -dD
3597Tell the preprocessing to pass all macro definitions into the output, in
3598their proper sequence in the rest of the output.
3599
3600@item -dN
3601Like @samp{-dD} except that the macro arguments and contents are omitted.
3602Only @samp{#define @var{name}} is included in the output.
3603
e582248c
NB
3604@item -dI
3605@findex -dI
3606Output @samp{#include} directives in addition to the result of
3607preprocessing.
3608
74291a4b 3609@item -trigraphs
e582248c
NB
3610@findex -trigraphs
3611Process ISO standard trigraph sequences. These are three-character
3612sequences, all starting with @samp{??}, that are defined by ISO C to
3613stand for single characters. For example, @samp{??/} stands for
3614@samp{\}, so @samp{'??/n'} is a character constant for a newline. By
3615default, GCC ignores trigraphs, but in standard-conforming modes it
3616converts them. See the @samp{-std} and @samp{-ansi} options.
3617
3618The nine trigraph sequences are
3619@table @samp
3620@item ??(
3621-> @samp{[}
3622
3623@item ??)
3624-> @samp{]}
3625
3626@item ??<
3627-> @samp{@{}
3628
3629@item ??>
3630-> @samp{@}}
3631
3632@item ??=
3633-> @samp{#}
3634
3635@item ??/
3636-> @samp{\}
3637
3638@item ??'
3639-> @samp{^}
3640
3641@item ??!
3642-> @samp{|}
3643
3644@item ??-
3645-> @samp{~}
3646
3647@end table
3648
3649Trigraph support is not popular, so many compilers do not implement it
3650properly. Portable code should not rely on trigraphs being either
3651converted or ignored.
74291a4b 3652
371e300b 3653@item -Wp\,@var{option}
bedc7537 3654Pass @var{option} as an option to the preprocessor. If @var{option}
74291a4b
MM
3655contains commas, it is split into multiple options at the commas.
3656@end table
3657
3658@node Assembler Options
3659@section Passing Options to the Assembler
3660
3661@c prevent bad page break with this line
3662You can pass options to the assembler.
3663
2642624b 3664@table @gcctabopt
371e300b 3665@item -Wa\,@var{option}
74291a4b
MM
3666Pass @var{option} as an option to the assembler. If @var{option}
3667contains commas, it is split into multiple options at the commas.
3668@end table
3669
3670@node Link Options
3671@section Options for Linking
3672@cindex link options
3673@cindex options, linking
3674
3675These options come into play when the compiler links object files into
3676an executable output file. They are meaningless if the compiler is
3677not doing a link step.
3678
2642624b 3679@table @gcctabopt
74291a4b
MM
3680@cindex file names
3681@item @var{object-file-name}
3682A file name that does not end in a special recognized suffix is
3683considered to name an object file or library. (Object files are
3684distinguished from libraries by the linker according to the file
3685contents.) If linking is done, these object files are used as input
3686to the linker.
3687
3688@item -c
3689@itemx -S
3690@itemx -E
3691If any of these options is used, then the linker is not run, and
3692object file names should not be used as arguments. @xref{Overall
3693Options}.
3694
3695@cindex Libraries
3696@item -l@var{library}
3697Search the library named @var{library} when linking.
3698
3699It makes a difference where in the command you write this option; the
3700linker searches processes libraries and object files in the order they
3701are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3702after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
3703to functions in @samp{z}, those functions may not be loaded.
3704
3705The linker searches a standard list of directories for the library,
3706which is actually a file named @file{lib@var{library}.a}. The linker
3707then uses this file as if it had been specified precisely by name.
3708
3709The directories searched include several standard system directories
3710plus any that you specify with @samp{-L}.
3711
3712Normally the files found this way are library files---archive files
3713whose members are object files. The linker handles an archive file by
3714scanning through it for members which define symbols that have so far
3715been referenced but not defined. But if the file that is found is an
3716ordinary object file, it is linked in the usual fashion. The only
3717difference between using an @samp{-l} option and specifying a file name
3718is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3719and searches several directories.
3720
3721@item -lobjc
3722You need this special case of the @samp{-l} option in order to
3723link an Objective C program.
3724
3725@item -nostartfiles
3726Do not use the standard system startup files when linking.
bedc7537
NC
3727The standard system libraries are used normally, unless @option{-nostdlib}
3728or @option{-nodefaultlibs} is used.
74291a4b
MM
3729
3730@item -nodefaultlibs
3731Do not use the standard system libraries when linking.
3732Only the libraries you specify will be passed to the linker.
bedc7537 3733The standard startup files are used normally, unless @option{-nostartfiles}
4754172c 3734is used. The compiler may generate calls to memcmp, memset, and memcpy
c1030c7c 3735for System V (and ISO C) environments or to bcopy and bzero for
4754172c
CM
3736BSD environments. These entries are usually resolved by entries in
3737libc. These entry points should be supplied through some other
3738mechanism when this option is specified.
74291a4b
MM
3739
3740@item -nostdlib
3741Do not use the standard system startup files or libraries when linking.
3742No startup files and only the libraries you specify will be passed to
4754172c 3743the linker. The compiler may generate calls to memcmp, memset, and memcpy
c1030c7c 3744for System V (and ISO C) environments or to bcopy and bzero for
4754172c
CM
3745BSD environments. These entries are usually resolved by entries in
3746libc. These entry points should be supplied through some other
3747mechanism when this option is specified.
74291a4b
MM
3748
3749@cindex @code{-lgcc}, use with @code{-nostdlib}
3750@cindex @code{-nostdlib} and unresolved references
3751@cindex unresolved references and @code{-nostdlib}
3752@cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3753@cindex @code{-nodefaultlibs} and unresolved references
3754@cindex unresolved references and @code{-nodefaultlibs}
3755One of the standard libraries bypassed by @samp{-nostdlib} and
3756@samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
0c2d1a2a 3757that GCC uses to overcome shortcomings of particular machines, or special
74291a4b
MM
3758needs for some languages.
3759@ifset INTERNALS
0c2d1a2a 3760(@xref{Interface,,Interfacing to GCC Output}, for more discussion of
74291a4b
MM
3761@file{libgcc.a}.)
3762@end ifset
3763@ifclear INTERNALS
0c2d1a2a 3764(@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
74291a4b
MM
3765for more discussion of @file{libgcc.a}.)
3766@end ifclear
3767In most cases, you need @file{libgcc.a} even when you want to avoid
3768other standard libraries. In other words, when you specify @samp{-nostdlib}
3769or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
0c2d1a2a 3770This ensures that you have no unresolved references to internal GCC
74291a4b 3771library subroutines. (For example, @samp{__main}, used to ensure C++
bedc7537 3772constructors will be called; @pxref{Collect2,,@command{collect2}}.)
74291a4b
MM
3773
3774@item -s
3775Remove all symbol table and relocation information from the executable.
3776
3777@item -static
3778On systems that support dynamic linking, this prevents linking with the shared
3779libraries. On other systems, this option has no effect.
3780
3781@item -shared
3782Produce a shared object which can then be linked with other objects to
1d3b0e2c
ME
3783form an executable. Not all systems support this option. For predictable
3784results, you must also specify the same set of options that were used to
3785generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
2642624b 3786when you specify this option.@footnote{On some systems, @samp{gcc -shared}
1d3b0e2c 3787needs to build supplementary stub code for constructors to work. On
2642624b 3788multi-libbed systems, @samp{gcc -shared} must select the correct support
1d3b0e2c
ME
3789libraries to link against. Failing to supply the correct flags may lead
3790to subtle defects. Supplying them in cases where they are not necessary
3791is innocuous.}
74291a4b 3792
9db0819e
RH
3793@item -shared-libgcc
3794@itemx -static-libgcc
3795On systems that provide @file{libgcc} as a shared library, these options
3796force the use of either the shared or static version respectively.
3797If no shared version of @file{libgcc} was built when the compiler was
3798configured, these options have no effect.
3799
3800There are several situations in which an application should use the
3801shared @file{libgcc} instead of the static version. The most common
3802of these is when the application wishes to throw and catch exceptions
3803across different shared libraries. In that case, each of the libraries
3804as well as the application itself should use the shared @file{libgcc}.
3805
049f6ec9
MM
3806Therefore, whenever you specify the @samp{-shared} option, the GCC
3807driver automatically adds @samp{-shared-libgcc}, unless you explicitly
3808specify @samp{-static-libgcc}. The G++ driver automatically adds
3809@samp{-shared-libgcc} when you build a main executable as well because
3810for C++ programs that is typically the right thing to do.
3811(Exception-handling will not work reliably otherwise.)
3812
3813However, when linking a main executable written in C, you must
3814explicitly say @samp{-shared-libgcc} if you want to use the shared
3815@file{libgcc}.
9db0819e 3816
74291a4b
MM
3817@item -symbolic
3818Bind references to global symbols when building a shared object. Warn
3819about any unresolved references (unless overridden by the link editor
3820option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
3821this option.
3822
3823@item -Xlinker @var{option}
3824Pass @var{option} as an option to the linker. You can use this to
0c2d1a2a 3825supply system-specific linker options which GCC does not know how to
74291a4b
MM
3826recognize.
3827
3828If you want to pass an option that takes an argument, you must use
3829@samp{-Xlinker} twice, once for the option and once for the argument.
3830For example, to pass @samp{-assert definitions}, you must write
3831@samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
3832@samp{-Xlinker "-assert definitions"}, because this passes the entire
3833string as a single argument, which is not what the linker expects.
3834
371e300b 3835@item -Wl\,@var{option}
74291a4b
MM
3836Pass @var{option} as an option to the linker. If @var{option} contains
3837commas, it is split into multiple options at the commas.
3838
3839@item -u @var{symbol}
3840Pretend the symbol @var{symbol} is undefined, to force linking of
3841library modules to define it. You can use @samp{-u} multiple times with
3842different symbols to force loading of additional library modules.
3843@end table
3844
3845@node Directory Options
3846@section Options for Directory Search
3847@cindex directory options
3848@cindex options, directory search
3849@cindex search path
3850
3851These options specify directories to search for header files, for
3852libraries and for parts of the compiler:
3853
2642624b 3854@table @gcctabopt
74291a4b 3855@item -I@var{dir}
861bb6c1
JL
3856Add the directory @var{dir} to the head of the list of directories to be
3857searched for header files. This can be used to override a system header
3858file, substituting your own version, since these directories are
d0a5eb32
RK
3859searched before the system header file directories. However, you should
3860not use this option to add directories that contain vendor-supplied
3861system header files (use @samp{-isystem} for that). If you use more than
3862one @samp{-I} option, the directories are scanned in left-to-right
74291a4b
MM
3863order; the standard system directories come after.
3864
3865@item -I-
3866Any directories you specify with @samp{-I} options before the @samp{-I-}
3867option are searched only for the case of @samp{#include "@var{file}"};
3868they are not searched for @samp{#include <@var{file}>}.
3869
3870If additional directories are specified with @samp{-I} options after
3871the @samp{-I-}, these directories are searched for all @samp{#include}
3872directives. (Ordinarily @emph{all} @samp{-I} directories are used
3873this way.)
3874
3875In addition, the @samp{-I-} option inhibits the use of the current
3876directory (where the current input file came from) as the first search
3877directory for @samp{#include "@var{file}"}. There is no way to
3878override this effect of @samp{-I-}. With @samp{-I.} you can specify
3879searching the directory which was current when the compiler was
3880invoked. That is not exactly the same as what the preprocessor does
3881by default, but it is often satisfactory.
3882
3883@samp{-I-} does not inhibit the use of the standard system directories
3884for header files. Thus, @samp{-I-} and @samp{-nostdinc} are
3885independent.
3886
3887@item -L@var{dir}
3888Add directory @var{dir} to the list of directories to be searched
3889for @samp{-l}.
3890
3891@item -B@var{prefix}
3892This option specifies where to find the executables, libraries,
3893include files, and data files of the compiler itself.
3894
3895The compiler driver program runs one or more of the subprograms
3896@file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
3897@var{prefix} as a prefix for each program it tries to run, both with and
3898without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3899
3900For each subprogram to be run, the compiler driver first tries the
3901@samp{-B} prefix, if any. If that name is not found, or if @samp{-B}
3902was not specified, the driver tries two standard prefixes, which are
3903@file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}. If neither of
3904those results in a file name that is found, the unmodified program
3905name is searched for using the directories specified in your
bedc7537 3906@env{PATH} environment variable.
74291a4b
MM
3907
3908@samp{-B} prefixes that effectively specify directory names also apply
3909to libraries in the linker, because the compiler translates these
3910options into @samp{-L} options for the linker. They also apply to
3911includes files in the preprocessor, because the compiler translates these
3912options into @samp{-isystem} options for the preprocessor. In this case,
3913the compiler appends @samp{include} to the prefix.
3914
3915The run-time support file @file{libgcc.a} can also be searched for using
3916the @samp{-B} prefix, if needed. If it is not found there, the two
3917standard prefixes above are tried, and that is all. The file is left
3918out of the link if it is not found by those means.
3919
3920Another way to specify a prefix much like the @samp{-B} prefix is to use
bedc7537 3921the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
74291a4b 3922Variables}.
861bb6c1
JL
3923
3924@item -specs=@var{file}
3925Process @var{file} after the compiler reads in the standard @file{specs}
3926file, in order to override the defaults that the @file{gcc} driver
3927program uses when determining what switches to pass to @file{cc1},
3928@file{cc1plus}, @file{as}, @file{ld}, etc. More than one
3929@samp{-specs=}@var{file} can be specified on the command line, and they
3930are processed in order, from left to right.
74291a4b
MM
3931@end table
3932
ee457005
JM
3933@c man end
3934
a743d340
NC
3935@node Spec Files
3936@section Specifying subprocesses and the switches to pass to them
3937@cindex Spec Files
bedc7537 3938@command{gcc} is a driver program. It performs its job by invoking a
a743d340
NC
3939sequence of other programs to do the work of compiling, assembling and
3940linking. GCC interprets its command-line parameters and uses these to
3941deduce which programs it should invoke, and which command-line options
3942it ought to place on their command lines. This behaviour is controlled
3943by @dfn{spec strings}. In most cases there is one spec string for each
3944program that GCC can invoke, but a few programs have multiple spec
3945strings to control their behaviour. The spec strings built into GCC can
3946be overridden by using the @samp{-specs=} command-line switch to specify
3947a spec file.
3948
3949@dfn{Spec files} are plaintext files that are used to construct spec
3950strings. They consist of a sequence of directives separated by blank
3951lines. The type of directive is determined by the first non-whitespace
3952character on the line and it can be one of the following:
3953
3954@table @code
3955@item %@var{command}
3956Issues a @var{command} to the spec file processor. The commands that can
3957appear here are:
3958
3959@table @code
3960@item %include <@var{file}>
3961@cindex %include
3962Search for @var{file} and insert its text at the current point in the
3963specs file.
3964
3965@item %include_noerr <@var{file}>
3966@cindex %include_noerr
3967Just like @samp{%include}, but do not generate an error message if the include
3968file cannot be found.
3969
3970@item %rename @var{old_name} @var{new_name}
3971@cindex %rename
3972Rename the spec string @var{old_name} to @var{new_name}.
3973
3974@end table
3975
3976@item *[@var{spec_name}]:
3977This tells the compiler to create, override or delete the named spec
3978string. All lines after this directive up to the next directive or
3979blank line are considered to be the text for the spec string. If this
3980results in an empty string then the spec will be deleted. (Or, if the
3981spec did not exist, then nothing will happened.) Otherwise, if the spec
3982does not currently exist a new spec will be created. If the spec does
3983exist then its contents will be overridden by the text of this
3984directive, unless the first character of that text is the @samp{+}
3985character, in which case the text will be appended to the spec.
3986
3987@item [@var{suffix}]:
3988Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
3989and up to the next directive or blank line are considered to make up the
3990spec string for the indicated suffix. When the compiler encounters an
3991input file with the named suffix, it will processes the spec string in
3992order to work out how to compile that file. For example:
3993
3994@smallexample
3995.ZZ:
3996z-compile -input %i
3997@end smallexample
3998
3999This says that any input file whose name ends in @samp{.ZZ} should be
4000passed to the program @samp{z-compile}, which should be invoked with the
4001command-line switch @samp{-input} and with the result of performing the
4002@samp{%i} substitution. (See below.)
4003
4004As an alternative to providing a spec string, the text that follows a
4005suffix directive can be one of the following:
4006
4007@table @code
4008@item @@@var{language}
4009This says that the suffix is an alias for a known @var{language}. This is
bedc7537 4010similar to using the @option{-x} command-line switch to GCC to specify a
a743d340
NC
4011language explicitly. For example:
4012
4013@smallexample
4014.ZZ:
4015@@c++
4016@end smallexample
4017
4018Says that .ZZ files are, in fact, C++ source files.
4019
4020@item #@var{name}
4021This causes an error messages saying:
4022
4023@smallexample
4024@var{name} compiler not installed on this system.
4025@end smallexample
4026@end table
4027
4028GCC already has an extensive list of suffixes built into it.
4029This directive will add an entry to the end of the list of suffixes, but
4030since the list is searched from the end backwards, it is effectively
4031possible to override earlier entries using this technique.
4032
4033@end table
4034
4035GCC has the following spec strings built into it. Spec files can
4036override these strings or create their own. Note that individual
4037targets can also add their own spec strings to this list.
4038
4039@smallexample
4040asm Options to pass to the assembler
4041asm_final Options to pass to the assembler post-processor
4042cpp Options to pass to the C preprocessor
4043cc1 Options to pass to the C compiler
4044cc1plus Options to pass to the C++ compiler
4045endfile Object files to include at the end of the link
4046link Options to pass to the linker
4047lib Libraries to include on the command line to the linker
4048libgcc Decides which GCC support library to pass to the linker
4049linker Sets the name of the linker
4050predefines Defines to be passed to the C preprocessor
4051signed_char Defines to pass to CPP to say whether @code{char} is signed by default
4052startfile Object files to include at the start of the link
4053@end smallexample
4054
4055Here is a small example of a spec file:
4056
4057@smallexample
4058%rename lib old_lib
4059
4060*lib:
4061--start-group -lgcc -lc -leval1 --end-group %(old_lib)
4062@end smallexample
4063
4064This example renames the spec called @samp{lib} to @samp{old_lib} and
4065then overrides the previous definition of @samp{lib} with a new one.
4066The new definition adds in some extra command-line options before
4067including the text of the old definition.
4068
4069@dfn{Spec strings} are a list of command-line options to be passed to their
4070corresponding program. In addition, the spec strings can contain
4071@samp{%}-prefixed sequences to substitute variable text or to
4072conditionally insert text into the command line. Using these constructs
4073it is possible to generate quite complex command lines.
4074
4075Here is a table of all defined @samp{%}-sequences for spec
4076strings. Note that spaces are not generated automatically around the
4077results of expanding these sequences. Therefore you can concatenate them
4078together or combine them with constant text in a single argument.
4079
4080@table @code
4081@item %%
4082Substitute one @samp{%} into the program name or argument.
4083
4084@item %i
4085Substitute the name of the input file being processed.
4086
4087@item %b
4088Substitute the basename of the input file being processed.
4089This is the substring up to (and not including) the last period
4090and not including the directory.
4091
371e300b
NC
4092@item %B
4093This is the same as @samp{%b}, but include the file suffix (text after
4094the last period).
4095
a743d340
NC
4096@item %d
4097Marks the argument containing or following the @samp{%d} as a
4098temporary file name, so that that file will be deleted if GCC exits
4099successfully. Unlike @samp{%g}, this contributes no text to the
4100argument.
4101
4102@item %g@var{suffix}
4103Substitute a file name that has suffix @var{suffix} and is chosen
4104once per compilation, and mark the argument in the same way as
4105@samp{%d}. To reduce exposure to denial-of-service attacks, the file
4106name is now chosen in a way that is hard to predict even when previously
4107chosen file names are known. For example, @samp{%g.s ... %g.o ... %g.s}
4108might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
4109the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4110treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
4111was simply substituted with a file name chosen once per compilation,
4112without regard to any appended suffix (which was therefore treated
4113just like ordinary text), making such attacks more likely to succeed.
4114
4115@item %u@var{suffix}
4116Like @samp{%g}, but generates a new temporary file name even if
4117@samp{%u@var{suffix}} was already seen.
4118
4119@item %U@var{suffix}
4120Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4121new one if there is no such last file name. In the absence of any
4122@samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4123the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
4124would involve the generation of two distinct file names, one
4125for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
4126simply substituted with a file name chosen for the previous @samp{%u},
4127without regard to any appended suffix.
4128
371e300b
NC
4129@item %j@var{SUFFIX}
4130Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is
4131writable, and if save-temps is off; otherwise, substitute the name
4132of a temporary file, just like @samp{%u}. This temporary file is not
4133meant for communication between processes, but rather as a junk
4134disposal mechanism.
4135
4136@item %.@var{SUFFIX}
4137Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4138when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4139terminated by the next space or %.
4140
a743d340
NC
4141@item %w
4142Marks the argument containing or following the @samp{%w} as the
4143designated output file of this compilation. This puts the argument
4144into the sequence of arguments that @samp{%o} will substitute later.
4145
4146@item %o
4147Substitutes the names of all the output files, with spaces
4148automatically placed around them. You should write spaces
4149around the @samp{%o} as well or the results are undefined.
4150@samp{%o} is for use in the specs for running the linker.
4151Input files whose names have no recognized suffix are not compiled
4152at all, but they are included among the output files, so they will
4153be linked.
4154
4155@item %O
4156Substitutes the suffix for object files. Note that this is
4157handled specially when it immediately follows @samp{%g, %u, or %U},
4158because of the need for those to form complete file names. The
4159handling is such that @samp{%O} is treated exactly as if it had already
4160been substituted, except that @samp{%g, %u, and %U} do not currently
4161support additional @var{suffix} characters following @samp{%O} as they would
4162following, for example, @samp{.o}.
4163
4164@item %p
4165Substitutes the standard macro predefinitions for the
4166current target machine. Use this when running @code{cpp}.
4167
4168@item %P
4169Like @samp{%p}, but puts @samp{__} before and after the name of each
4170predefined macro, except for macros that start with @samp{__} or with
c1030c7c 4171@samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
a743d340
NC
4172C.
4173
4174@item %I
4175Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
4176
4177@item %s
4178Current argument is the name of a library or startup file of some sort.
4179Search for that file in a standard list of directories and substitute
4180the full name found.
4181
4182@item %e@var{str}
4183Print @var{str} as an error message. @var{str} is terminated by a newline.
4184Use this when inconsistent options are detected.
4185
4186@item %|
4187Output @samp{-} if the input for the current command is coming from a pipe.
4188
4189@item %(@var{name})
4190Substitute the contents of spec string @var{name} at this point.
4191
4192@item %[@var{name}]
4193Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
4194
4195@item %x@{@var{option}@}
4196Accumulate an option for @samp{%X}.
4197
4198@item %X
4199Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
4200spec string.
4201
4202@item %Y
4203Output the accumulated assembler options specified by @samp{-Wa}.
4204
4205@item %Z
4206Output the accumulated preprocessor options specified by @samp{-Wp}.
4207
4208@item %v1
4209Substitute the major version number of GCC.
4210(For version 2.9.5, this is 2.)
4211
4212@item %v2
4213Substitute the minor version number of GCC.
4214(For version 2.9.5, this is 9.)
4215
371e300b
NC
4216@item %v3
4217Substitute the patch level number of GCC.
4218(For version 2.9.5, this is 5.)
4219
a743d340
NC
4220@item %a
4221Process the @code{asm} spec. This is used to compute the
4222switches to be passed to the assembler.
4223
4224@item %A
4225Process the @code{asm_final} spec. This is a spec string for
4226passing switches to an assembler post-processor, if such a program is
4227needed.
4228
4229@item %l
4230Process the @code{link} spec. This is the spec for computing the
4231command line passed to the linker. Typically it will make use of the
4232@samp{%L %G %S %D and %E} sequences.
4233
4234@item %D
4235Dump out a @samp{-L} option for each directory that GCC believes might
4236contain startup files. If the target supports multilibs then the
4237current multilib directory will be prepended to each of these paths.
4238
371e300b
NC
4239@item %M
4240Output the multilib directory with directory seperators replaced with
4241"_". If multilib directories are not set, or the multilib directory is
4242"." then this option emits nothing.
4243
a743d340
NC
4244@item %L
4245Process the @code{lib} spec. This is a spec string for deciding which
4246libraries should be included on the command line to the linker.
4247
4248@item %G
4249Process the @code{libgcc} spec. This is a spec string for deciding
4250which GCC support library should be included on the command line to the linker.
4251
4252@item %S
4253Process the @code{startfile} spec. This is a spec for deciding which
4254object files should be the first ones passed to the linker. Typically
4255this might be a file named @file{crt0.o}.
4256
4257@item %E
4258Process the @code{endfile} spec. This is a spec string that specifies
4259the last object files that will be passed to the linker.
4260
4261@item %C
4262Process the @code{cpp} spec. This is used to construct the arguments
4263to be passed to the C preprocessor.
4264
4265@item %c
4266Process the @code{signed_char} spec. This is intended to be used
4267to tell cpp whether a char is signed. It typically has the definition:
4268@smallexample
4269%@{funsigned-char:-D__CHAR_UNSIGNED__@}
4270@end smallexample
4271
4272@item %1
4273Process the @code{cc1} spec. This is used to construct the options to be
4274passed to the actual C compiler (@samp{cc1}).
4275
4276@item %2
4277Process the @code{cc1plus} spec. This is used to construct the options to be
4278passed to the actual C++ compiler (@samp{cc1plus}).
4279
4280@item %*
4281Substitute the variable part of a matched option. See below.
4282Note that each comma in the substituted string is replaced by
4283a single space.
4284
4285@item %@{@code{S}@}
4286Substitutes the @code{-S} switch, if that switch was given to GCC.
4287If that switch was not specified, this substitutes nothing. Note that
4288the leading dash is omitted when specifying this option, and it is
4289automatically inserted if the substitution is performed. Thus the spec
4290string @samp{%@{foo@}} would match the command-line option @samp{-foo}
4291and would output the command line option @samp{-foo}.
4292
4293@item %W@{@code{S}@}
4294Like %@{@code{S}@} but mark last argument supplied within as a file to be
4295deleted on failure.
4296
4297@item %@{@code{S}*@}
4298Substitutes all the switches specified to GCC whose names start
4299with @code{-S}, but which also take an argument. This is used for
4300switches like @samp{-o, -D, -I}, etc. GCC considers @samp{-o foo} as being
4301one switch whose names starts with @samp{o}. %@{o*@} would substitute this
4302text, including the space. Thus two arguments would be generated.
4303
4304@item %@{^@code{S}*@}
4305Like %@{@code{S}*@}, but don't put a blank between a switch and its
4306argument. Thus %@{^o*@} would only generate one argument, not two.
4307
371e300b
NC
4308@item %@{@code{S}*&@code{T}*@}
4309Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4310(the order of @code{S} and @code{T} in the spec is not significant).
4311There can be any number of ampersand-separated variables; for each the
4312wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
4313
d630442f 4314@item %@{<@code{S}@}
50c57e7b 4315Remove all occurrences of @code{-S} from the command line. Note - this
d630442f 4316command is position dependent. @samp{%} commands in the spec string
50c57e7b 4317before this option will see @code{-S}, @samp{%} commands in the spec
d630442f
NC
4318string after this option will not.
4319
a743d340
NC
4320@item %@{@code{S}*:@code{X}@}
4321Substitutes @code{X} if one or more switches whose names start with
4322@code{-S} are specified to GCC. Note that the tail part of the
4323@code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
4324for each occurrence of @samp{%*} within @code{X}.
4325
4326@item %@{@code{S}:@code{X}@}
4327Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
4328
4329@item %@{!@code{S}:@code{X}@}
4330Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
4331
4332@item %@{|@code{S}:@code{X}@}
4333Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4334
4335@item %@{|!@code{S}:@code{X}@}
4336Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4337
4338@item %@{.@code{S}:@code{X}@}
4339Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4340
4341@item %@{!.@code{S}:@code{X}@}
4342Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4343
4344@item %@{@code{S}|@code{P}:@code{X}@}
4345Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC. This may be
4346combined with @samp{!} and @samp{.} sequences as well, although they
4347have a stronger binding than the @samp{|}. For example a spec string
4348like this:
4349
4350@smallexample
4351%@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4352@end smallexample
4353
4354will output the following command-line options from the following input
4355command-line options:
4356
4357@smallexample
4358fred.c -foo -baz
4359jim.d -bar -boggle
4360-d fred.c -foo -baz -boggle
4361-d jim.d -bar -baz -boggle
4362@end smallexample
4363
4364@end table
4365
4366The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4367%@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4368or spaces, or even newlines. They are processed as usual, as described
4369above.
4370
4371The @samp{-O, -f, -m, and -W} switches are handled specifically in these
4372constructs. If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
4373-W} switch is found later in the command line, the earlier switch
4374value is ignored, except with @{@code{S}*@} where @code{S} is just one
4375letter, which passes all matching options.
4376
4377The character @samp{|} at the beginning of the predicate text is used to indicate
4378that a command should be piped to the following command, but only if @samp{-pipe}
4379is specified.
4380
4381It is built into GCC which switches take arguments and which do not.
4382(You might think it would be useful to generalize this to allow each
4383compiler's spec to say which switches take arguments. But this cannot
4384be done in a consistent fashion. GCC cannot even decide which input
4385files have been specified without knowing which switches take arguments,
4386and it must know which input files to compile in order to tell which
4387compilers to run).
4388
4389GCC also knows implicitly that arguments starting in @samp{-l} are to be
4390treated as compiler output files, and passed to the linker in their
4391proper position among the other output files.
4392
ee457005
JM
4393@c man begin OPTIONS
4394
74291a4b
MM
4395@node Target Options
4396@section Specifying Target Machine and Compiler Version
4397@cindex target options
4398@cindex cross compiling
4399@cindex specifying machine version
4400@cindex specifying compiler version and target machine
4401@cindex compiler version, specifying
4402@cindex target machine, specifying
4403
0c2d1a2a 4404By default, GCC compiles code for the same type of machine that you
74291a4b
MM
4405are using. However, it can also be installed as a cross-compiler, to
4406compile for some other type of machine. In fact, several different
0c2d1a2a 4407configurations of GCC, for different target machines, can be
74291a4b
MM
4408installed side by side. Then you specify which one to use with the
4409@samp{-b} option.
4410
0c2d1a2a 4411In addition, older and newer versions of GCC can be installed side
74291a4b
MM
4412by side. One of them (probably the newest) will be the default, but
4413you may sometimes wish to use another.
4414
2642624b 4415@table @gcctabopt
74291a4b
MM
4416@item -b @var{machine}
4417The argument @var{machine} specifies the target machine for compilation.
0c2d1a2a 4418This is useful when you have installed GCC as a cross-compiler.
74291a4b
MM
4419
4420The value to use for @var{machine} is the same as was specified as the
0c2d1a2a 4421machine type when configuring GCC as a cross-compiler. For
74291a4b
MM
4422example, if a cross-compiler was configured with @samp{configure
4423i386v}, meaning to compile for an 80386 running System V, then you
4424would specify @samp{-b i386v} to run that cross compiler.
4425
4426When you do not specify @samp{-b}, it normally means to compile for
4427the same type of machine that you are using.
4428
4429@item -V @var{version}
0c2d1a2a 4430The argument @var{version} specifies which version of GCC to run.
74291a4b 4431This is useful when multiple versions are installed. For example,
0c2d1a2a 4432@var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
74291a4b
MM
4433
4434The default version, when you do not specify @samp{-V}, is the last
0c2d1a2a 4435version of GCC that you installed.
74291a4b
MM
4436@end table
4437
4438The @samp{-b} and @samp{-V} options actually work by controlling part of
4439the file name used for the executable files and libraries used for
0c2d1a2a 4440compilation. A given version of GCC, for a given target machine, is
74291a4b
MM
4441normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
4442
4443Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
4444changing the names of these directories or adding alternate names (or
4445symbolic links). If in directory @file{/usr/local/lib/gcc-lib/} the
4446file @file{80386} is a link to the file @file{i386v}, then @samp{-b
444780386} becomes an alias for @samp{-b i386v}.
4448
4449In one respect, the @samp{-b} or @samp{-V} do not completely change
bedc7537 4450to a different compiler: the top-level driver program @command{gcc}
74291a4b
MM
4451that you originally invoked continues to run and invoke the other
4452executables (preprocessor, compiler per se, assembler and linker)
4453that do the real work. However, since no real work is done in the
4454driver program, it usually does not matter that the driver program
8c7b74b9
JM
4455in use is not the one for the specified target. It is common for the
4456interface to the other executables to change incompatibly between
4457compiler versions, so unless the version specified is very close to that
4458of the driver (for example, @samp{-V 3.0} with a driver program from GCC
4459version 3.0.1), use of @samp{-V} may not work; for example, using
4460@samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
74291a4b
MM
4461
4462The only way that the driver program depends on the target machine is
4463in the parsing and handling of special machine-specific options.
4464However, this is controlled by a file which is found, along with the
4465other executables, in the directory for the specified version and
4466target machine. As a result, a single installed driver program adapts
8c7b74b9
JM
4467to any specified target machine, and sufficiently similar compiler
4468versions.
74291a4b
MM
4469
4470The driver program executable does control one significant thing,
4471however: the default version and target machine. Therefore, you can
4472install different instances of the driver program, compiled for
4473different targets or versions, under different names.
4474
bedc7537
NC
4475For example, if the driver for version 2.0 is installed as @command{ogcc}
4476and that for version 2.1 is installed as @command{gcc}, then the command
4477@command{gcc} will use version 2.1 by default, while @command{ogcc} will use
74291a4b
MM
44782.0 by default. However, you can choose either version with either
4479command with the @samp{-V} option.
4480
4481@node Submodel Options
4482@section Hardware Models and Configurations
4483@cindex submodel options
4484@cindex specifying hardware config
4485@cindex hardware models and configurations, specifying
4486@cindex machine dependent options
4487
4488Earlier we discussed the standard option @samp{-b} which chooses among
4489different installed compilers for completely different target
4490machines, such as Vax vs. 68000 vs. 80386.
4491
4492In addition, each of these target machine types can have its own
4493special options, starting with @samp{-m}, to choose among various
4494hardware models or configurations---for example, 68010 vs 68020,
4495floating coprocessor or none. A single installed version of the
4496compiler can compile for any model or configuration, according to the
4497options specified.
4498
4499Some configurations of the compiler also support additional special
4500options, usually for compatibility with other compilers on the same
4501platform.
4502
4503@ifset INTERNALS
4504These options are defined by the macro @code{TARGET_SWITCHES} in the
4505machine description. The default for the options is also defined by
4506that macro, which enables you to change the defaults.
4507@end ifset
4508
4509@menu
4510* M680x0 Options::
2856c3e3 4511* M68hc1x Options::
74291a4b
MM
4512* VAX Options::
4513* SPARC Options::
4514* Convex Options::
4515* AMD29K Options::
4516* ARM Options::
157a620e 4517* Thumb Options::
ecff22ab 4518* MN10200 Options::
6d6d0fa0 4519* MN10300 Options::
861bb6c1 4520* M32R/D Options::
74291a4b
MM
4521* M88K Options::
4522* RS/6000 and PowerPC Options::
4523* RT Options::
4524* MIPS Options::
4525* i386 Options::
4526* HPPA Options::
4527* Intel 960 Options::
4528* DEC Alpha Options::
4529* Clipper Options::
4530* H8/300 Options::
4531* SH Options::
4532* System V Options::
282a61e6 4533* TMS320C3x/C4x Options::
f84271d9 4534* V850 Options::
56b2d7a7 4535* ARC Options::
83575957 4536* NS32K Options::
052a4b28
DC
4537* AVR Options::
4538* MCore Options::
df6194d4 4539* IA-64 Options::
e8ad90e5 4540* D30V Options::
74291a4b
MM
4541@end menu
4542
4543@node M680x0 Options
4544@subsection M680x0 Options
4545@cindex M680x0 options
4546
4547These are the @samp{-m} options defined for the 68000 series. The default
4548values for these options depends on which style of 68000 was selected when
4549the compiler was configured; the defaults for the most common choices are
4550given below.
4551
2642624b 4552@table @gcctabopt
74291a4b
MM
4553@item -m68000
4554@itemx -mc68000
4555Generate output for a 68000. This is the default
4556when the compiler is configured for 68000-based systems.
4557
74cf1c6d
RK
4558Use this option for microcontrollers with a 68000 or EC000 core,
4559including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4560
74291a4b
MM
4561@item -m68020
4562@itemx -mc68020
4563Generate output for a 68020. This is the default
4564when the compiler is configured for 68020-based systems.
4565
4566@item -m68881
4567Generate output containing 68881 instructions for floating point.
4568This is the default for most 68020 systems unless @samp{-nfp} was
4569specified when the compiler was configured.
4570
4571@item -m68030
4572Generate output for a 68030. This is the default when the compiler is
4573configured for 68030-based systems.
4574
4575@item -m68040
4576Generate output for a 68040. This is the default when the compiler is
4577configured for 68040-based systems.
4578
4579This option inhibits the use of 68881/68882 instructions that have to be
74cf1c6d
RK
4580emulated by software on the 68040. Use this option if your 68040 does not
4581have code to emulate those instructions.
74291a4b
MM
4582
4583@item -m68060
4584Generate output for a 68060. This is the default when the compiler is
4585configured for 68060-based systems.
4586
4587This option inhibits the use of 68020 and 68881/68882 instructions that
74cf1c6d
RK
4588have to be emulated by software on the 68060. Use this option if your 68060
4589does not have code to emulate those instructions.
4590
4591@item -mcpu32
4592Generate output for a CPU32. This is the default
4593when the compiler is configured for CPU32-based systems.
4594
4595Use this option for microcontrollers with a
4596CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
459768336, 68340, 68341, 68349 and 68360.
74291a4b
MM
4598
4599@item -m5200
4600Generate output for a 520X "coldfire" family cpu. This is the default
4601when the compiler is configured for 520X-based systems.
4602
74cf1c6d
RK
4603Use this option for microcontroller with a 5200 core, including
4604the MCF5202, MCF5203, MCF5204 and MCF5202.
4605
74291a4b
MM
4606
4607@item -m68020-40
4608Generate output for a 68040, without using any of the new instructions.
4609This results in code which can run relatively efficiently on either a
461068020/68881 or a 68030 or a 68040. The generated code does use the
461168881 instructions that are emulated on the 68040.
4612
861bb6c1
JL
4613@item -m68020-60
4614Generate output for a 68060, without using any of the new instructions.
4615This results in code which can run relatively efficiently on either a
461668020/68881 or a 68030 or a 68040. The generated code does use the
461768881 instructions that are emulated on the 68060.
4618
74291a4b
MM
4619@item -mfpa
4620Generate output containing Sun FPA instructions for floating point.
4621
4622@item -msoft-float
4623Generate output containing library calls for floating point.
4624@strong{Warning:} the requisite libraries are not available for all m68k
4625targets. Normally the facilities of the machine's usual C compiler are
4626used, but this can't be done directly in cross-compilation. You must
4627make your own arrangements to provide suitable library functions for
4628cross-compilation. The embedded targets @samp{m68k-*-aout} and
4629@samp{m68k-*-coff} do provide software floating point support.
4630
4631@item -mshort
4632Consider type @code{int} to be 16 bits wide, like @code{short int}.
4633
4634@item -mnobitfield
74cf1c6d
RK
4635Do not use the bit-field instructions. The @samp{-m68000}, @samp{-mcpu32}
4636and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
74291a4b
MM
4637
4638@item -mbitfield
4639Do use the bit-field instructions. The @samp{-m68020} option implies
4640@samp{-mbitfield}. This is the default if you use a configuration
4641designed for a 68020.
4642
4643@item -mrtd
4644Use a different function-calling convention, in which functions
4645that take a fixed number of arguments return with the @code{rtd}
4646instruction, which pops their arguments while returning. This
4647saves one instruction in the caller since there is no need to pop
4648the arguments there.
4649
4650This calling convention is incompatible with the one normally
4651used on Unix, so you cannot use it if you need to call libraries
4652compiled with the Unix compiler.
4653
4654Also, you must provide function prototypes for all functions that
4655take variable numbers of arguments (including @code{printf});
4656otherwise incorrect code will be generated for calls to those
4657functions.
4658
4659In addition, seriously incorrect code will result if you call a
4660function with too many arguments. (Normally, extra arguments are
4661harmlessly ignored.)
4662
4663The @code{rtd} instruction is supported by the 68010, 68020, 68030,
74cf1c6d 466468040, 68060 and CPU32 processors, but not by the 68000 or 5200.
861bb6c1
JL
4665
4666@item -malign-int
4667@itemx -mno-align-int
0c2d1a2a 4668Control whether GCC aligns @code{int}, @code{long}, @code{long long},
861bb6c1
JL
4669@code{float}, @code{double}, and @code{long double} variables on a 32-bit
4670boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4671Aligning variables on 32-bit boundaries produces code that runs somewhat
4672faster on processors with 32-bit busses at the expense of more memory.
4673
0c2d1a2a 4674@strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
861bb6c1
JL
4675align structures containing the above types differently than
4676most published application binary interface specifications for the m68k.
4677
fb868474
DL
4678@item -mpcrel
4679Use the pc-relative addressing mode of the 68000 directly, instead of
4680using a global offset table. At present, this option implies -fpic,
4681allowing at most a 16-bit offset for pc-relative addressing. -fPIC is
4682not presently supported with -mpcrel, though this could be supported for
468368020 and higher processors.
4684
b71733d5
GM
4685@item -mno-strict-align
4686@itemx -mstrict-align
4687@kindex -mstrict-align
4688Do not (do) assume that unaligned memory references will be handled by
4689the system.
4690
74291a4b
MM
4691@end table
4692
2856c3e3
SC
4693@node M68hc1x Options
4694@subsection M68hc1x Options
4695@cindex M68hc1x options
4696
4697These are the @samp{-m} options defined for the 68hc11 and 68hc12
4698microcontrollers. The default values for these options depends on
4699which style of microcontroller was selected when the compiler was configured;
4700the defaults for the most common choices are given below.
4701
2642624b 4702@table @gcctabopt
2856c3e3
SC
4703@item -m6811
4704@itemx -m68hc11
4705Generate output for a 68HC11. This is the default
4706when the compiler is configured for 68HC11-based systems.
4707
4708@item -m6812
4709@itemx -m68hc12
4710Generate output for a 68HC12. This is the default
4711when the compiler is configured for 68HC12-based systems.
4712
4713@item -mauto-incdec
4714Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4715addressing modes.
4716
4717@item -mshort
4718Consider type @code{int} to be 16 bits wide, like @code{short int}.
4719
4720@item -msoft-reg-count=@var{count}
4721Specify the number of pseudo-soft registers which are used for the
4722code generation. The maximum number is 32. Using more pseudo-soft
4723register may or may not result in better code depending on the program.
4724The default is 4 for 68HC11 and 2 for 68HC12.
4725
4726@end table
4727
74291a4b
MM
4728@node VAX Options
4729@subsection VAX Options
4730@cindex VAX options
4731
4732These @samp{-m} options are defined for the Vax:
4733
2642624b 4734@table @gcctabopt
74291a4b
MM
4735@item -munix
4736Do not output certain jump instructions (@code{aobleq} and so on)
4737that the Unix assembler for the Vax cannot handle across long
4738ranges.
4739
4740@item -mgnu
4741Do output those jump instructions, on the assumption that you
4742will assemble with the GNU assembler.
4743
4744@item -mg
4745Output code for g-format floating point numbers instead of d-format.
4746@end table
4747
4748@node SPARC Options
4749@subsection SPARC Options
4750@cindex SPARC options
4751
4752These @samp{-m} switches are supported on the SPARC:
4753
2642624b 4754@table @gcctabopt
74291a4b
MM
4755@item -mno-app-regs
4756@itemx -mapp-regs
4757Specify @samp{-mapp-regs} to generate output using the global registers
47582 through 4, which the SPARC SVR4 ABI reserves for applications. This
4759is the default.
4760
4761To be fully SVR4 ABI compliant at the cost of some performance loss,
4762specify @samp{-mno-app-regs}. You should compile libraries and system
4763software with this option.
4764
4765@item -mfpu
4766@itemx -mhard-float
4767Generate output containing floating point instructions. This is the
4768default.
4769
4770@item -mno-fpu
4771@itemx -msoft-float
4772Generate output containing library calls for floating point.
4773@strong{Warning:} the requisite libraries are not available for all SPARC
4774targets. Normally the facilities of the machine's usual C compiler are
4775used, but this cannot be done directly in cross-compilation. You must make
4776your own arrangements to provide suitable library functions for
4777cross-compilation. The embedded targets @samp{sparc-*-aout} and
4778@samp{sparclite-*-*} do provide software floating point support.
4779
4780@samp{-msoft-float} changes the calling convention in the output file;
4781therefore, it is only useful if you compile @emph{all} of a program with
4782this option. In particular, you need to compile @file{libgcc.a}, the
0c2d1a2a 4783library that comes with GCC, with @samp{-msoft-float} in order for
74291a4b
MM
4784this to work.
4785
4786@item -mhard-quad-float
4787Generate output containing quad-word (long double) floating point
4788instructions.
4789
4790@item -msoft-quad-float
4791Generate output containing library calls for quad-word (long double)
4792floating point instructions. The functions called are those specified
4793in the SPARC ABI. This is the default.
4794
4795As of this writing, there are no sparc implementations that have hardware
4796support for the quad-word floating point instructions. They all invoke
4797a trap handler for one of these instructions, and then the trap handler
4798emulates the effect of the instruction. Because of the trap handler overhead,
4799this is much slower than calling the ABI library routines. Thus the
4800@samp{-msoft-quad-float} option is the default.
4801
4802@item -mno-epilogue
4803@itemx -mepilogue
4804With @samp{-mepilogue} (the default), the compiler always emits code for
4805function exit at the end of each function. Any function exit in
4806the middle of the function (such as a return statement in C) will
4807generate a jump to the exit code at the end of the function.
4808
4809With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4810at every function exit.
4811
4812@item -mno-flat
4813@itemx -mflat
4814With @samp{-mflat}, the compiler does not generate save/restore instructions
4815and will use a "flat" or single register window calling convention.
4816This model uses %i7 as the frame pointer and is compatible with the normal
4817register window model. Code from either may be intermixed.
4818The local registers and the input registers (0-5) are still treated as
4819"call saved" registers and will be saved on the stack as necessary.
4820
4821With @samp{-mno-flat} (the default), the compiler emits save/restore
4822instructions (except for leaf functions) and is the normal mode of operation.
4823
4824@item -mno-unaligned-doubles
4825@itemx -munaligned-doubles
4826Assume that doubles have 8 byte alignment. This is the default.
4827
0c2d1a2a 4828With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
74291a4b
MM
4829alignment only if they are contained in another type, or if they have an
4830absolute address. Otherwise, it assumes they have 4 byte alignment.
4831Specifying this option avoids some rare compatibility problems with code
4832generated by other compilers. It is not the default because it results
4833in a performance loss, especially for floating point code.
4834
c219ddf7
BK
4835@item -mno-faster-structs
4836@itemx -mfaster-structs
4837With @samp{-mfaster-structs}, the compiler assumes that structures
4838should have 8 byte alignment. This enables the use of pairs of
4839@code{ldd} and @code{std} instructions for copies in structure
4840assignment, in place of twice as many @code{ld} and @code{st} pairs.
4841However, the use of this changed alignment directly violates the Sparc
4842ABI. Thus, it's intended only for use on targets where the developer
4843acknowledges that their resulting code will not be directly in line with
4844the rules of the ABI.
4845
74291a4b
MM
4846@item -mv8
4847@itemx -msparclite
4848These two options select variations on the SPARC architecture.
4849
4850By default (unless specifically configured for the Fujitsu SPARClite),
4851GCC generates code for the v7 variant of the SPARC architecture.
4852
4853@samp{-mv8} will give you SPARC v8 code. The only difference from v7
4854code is that the compiler emits the integer multiply and integer
4855divide instructions which exist in SPARC v8 but not in SPARC v7.
4856
4857@samp{-msparclite} will give you SPARClite code. This adds the integer
4858multiply, integer divide step and scan (@code{ffs}) instructions which
4859exist in SPARClite but not in SPARC v7.
4860
0c2d1a2a 4861These options are deprecated and will be deleted in a future GCC release.
74291a4b
MM
4862They have been replaced with @samp{-mcpu=xxx}.
4863
4864@item -mcypress
4865@itemx -msupersparc
4866These two options select the processor for which the code is optimised.
4867
4868With @samp{-mcypress} (the default), the compiler optimizes code for the
4869Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4870This is also appropriate for the older SparcStation 1, 2, IPX etc.
4871
4872With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4873used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4874of the full SPARC v8 instruction set.
4875
0c2d1a2a 4876These options are deprecated and will be deleted in a future GCC release.
74291a4b
MM
4877They have been replaced with @samp{-mcpu=xxx}.
4878
4879@item -mcpu=@var{cpu_type}
c0498f43
DE
4880Set the instruction set, register set, and instruction scheduling parameters
4881for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
4882@samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
ad6843d7
RH
4883@samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4884@samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
c0498f43
DE
4885
4886Default instruction scheduling parameters are used for values that select
4887an architecture and not an implementation. These are @samp{v7}, @samp{v8},
4888@samp{sparclite}, @samp{sparclet}, @samp{v9}.
4889
4890Here is a list of each supported architecture and their supported
4891implementations.
4892
4893@smallexample
4894 v7: cypress
ad6843d7
RH
4895 v8: supersparc, hypersparc
4896 sparclite: f930, f934, sparclite86x
c0498f43
DE
4897 sparclet: tsc701
4898 v9: ultrasparc
4899@end smallexample
74291a4b
MM
4900
4901@item -mtune=@var{cpu_type}
4902Set the instruction scheduling parameters for machine type
c0498f43
DE
4903@var{cpu_type}, but do not set the instruction set or register set that the
4904option @samp{-mcpu=}@var{cpu_type} would.
4905
4906The same values for @samp{-mcpu=}@var{cpu_type} are used for
e5e809f4 4907@samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
c0498f43 4908select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
ad6843d7
RH
4909@samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4910@samp{tsc701}, @samp{ultrasparc}.
74291a4b
MM
4911
4912@end table
4913
4914These @samp{-m} switches are supported in addition to the above
4915on the SPARCLET processor.
4916
2642624b 4917@table @gcctabopt
74291a4b
MM
4918@item -mlittle-endian
4919Generate code for a processor running in little-endian mode.
4920
4921@item -mlive-g0
4922Treat register @code{%g0} as a normal register.
4923GCC will continue to clobber it as necessary but will not assume
4924it always reads as 0.
4925
4926@item -mbroken-saverestore
4927Generate code that does not use non-trivial forms of the @code{save} and
4928@code{restore} instructions. Early versions of the SPARCLET processor do
4929not correctly handle @code{save} and @code{restore} instructions used with
4930arguments. They correctly handle them used without arguments. A @code{save}
4931instruction used without arguments increments the current window pointer
4932but does not allocate a new stack frame. It is assumed that the window
4933overflow trap handler will properly handle this case as will interrupt
4934handlers.
4935@end table
4936
4937These @samp{-m} switches are supported in addition to the above
4938on SPARC V9 processors in 64 bit environments.
4939
2642624b 4940@table @gcctabopt
74291a4b
MM
4941@item -mlittle-endian
4942Generate code for a processor running in little-endian mode.
4943
ded17aad
DE
4944@item -m32
4945@itemx -m64
4946Generate code for a 32 bit or 64 bit environment.
4947The 32 bit environment sets int, long and pointer to 32 bits.
4948The 64 bit environment sets int to 32 bits and long and pointer
4949to 64 bits.
4950
4951@item -mcmodel=medlow
4952Generate code for the Medium/Low code model: the program must be linked
4953in the low 32 bits of the address space. Pointers are 64 bits.
4954Programs can be statically or dynamically linked.
4955
4956@item -mcmodel=medmid
4957Generate code for the Medium/Middle code model: the program must be linked
4958in the low 44 bits of the address space, the text segment must be less than
49592G bytes, and data segment must be within 2G of the text segment.
4960Pointers are 64 bits.
4961
4962@item -mcmodel=medany
4963Generate code for the Medium/Anywhere code model: the program may be linked
4964anywhere in the address space, the text segment must be less than
49652G bytes, and data segment must be within 2G of the text segment.
4966Pointers are 64 bits.
4967
4968@item -mcmodel=embmedany
4969Generate code for the Medium/Anywhere code model for embedded systems:
4970assume a 32 bit text and a 32 bit data segment, both starting anywhere
4971(determined at link time). Register %g4 points to the base of the
4972data segment. Pointers still 64 bits.
4973Programs are statically linked, PIC is not supported.
74291a4b
MM
4974
4975@item -mstack-bias
4976@itemx -mno-stack-bias
0c2d1a2a 4977With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
74291a4b
MM
4978frame pointer if present, are offset by -2047 which must be added back
4979when making stack frame references.
4980Otherwise, assume no such offset is present.
4981@end table
4982
4983@node Convex Options
4984@subsection Convex Options
4985@cindex Convex options
4986
4987These @samp{-m} options are defined for Convex:
4988
2642624b 4989@table @gcctabopt
74291a4b
MM
4990@item -mc1
4991Generate output for C1. The code will run on any Convex machine.
4992The preprocessor symbol @code{__convex__c1__} is defined.
4993
4994@item -mc2
4995Generate output for C2. Uses instructions not available on C1.
4996Scheduling and other optimizations are chosen for max performance on C2.
4997The preprocessor symbol @code{__convex_c2__} is defined.
4998
4999@item -mc32
5000Generate output for C32xx. Uses instructions not available on C1.
5001Scheduling and other optimizations are chosen for max performance on C32.
5002The preprocessor symbol @code{__convex_c32__} is defined.
5003
5004@item -mc34
5005Generate output for C34xx. Uses instructions not available on C1.
5006Scheduling and other optimizations are chosen for max performance on C34.
5007The preprocessor symbol @code{__convex_c34__} is defined.
5008
5009@item -mc38
5010Generate output for C38xx. Uses instructions not available on C1.
5011Scheduling and other optimizations are chosen for max performance on C38.
5012The preprocessor symbol @code{__convex_c38__} is defined.
5013
5014@item -margcount
5015Generate code which puts an argument count in the word preceding each
5016argument list. This is compatible with regular CC, and a few programs
5017may need the argument count word. GDB and other source-level debuggers
5018do not need it; this info is in the symbol table.
5019
5020@item -mnoargcount
5021Omit the argument count word. This is the default.
5022
5023@item -mvolatile-cache
5024Allow volatile references to be cached. This is the default.
5025
5026@item -mvolatile-nocache
5027Volatile references bypass the data cache, going all the way to memory.
5028This is only needed for multi-processor code that does not use standard
5029synchronization instructions. Making non-volatile references to volatile
5030locations will not necessarily work.
5031
5032@item -mlong32
5033Type long is 32 bits, the same as type int. This is the default.
5034
5035@item -mlong64
5036Type long is 64 bits, the same as type long long. This option is useless,
5037because no library support exists for it.
5038@end table
5039
5040@node AMD29K Options
5041@subsection AMD29K Options
5042@cindex AMD29K options
5043
5044These @samp{-m} options are defined for the AMD Am29000:
5045
2642624b 5046@table @gcctabopt
74291a4b
MM
5047@item -mdw
5048@kindex -mdw
5049@cindex DW bit (29k)
5050Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5051halfword operations are directly supported by the hardware. This is the
5052default.
5053
5054@item -mndw
5055@kindex -mndw
5056Generate code that assumes the @code{DW} bit is not set.
5057
5058@item -mbw
5059@kindex -mbw
5060@cindex byte writes (29k)
5061Generate code that assumes the system supports byte and halfword write
5062operations. This is the default.
5063
5064@item -mnbw
5065@kindex -mnbw
5066Generate code that assumes the systems does not support byte and
5067halfword write operations. @samp{-mnbw} implies @samp{-mndw}.
5068
5069@item -msmall
5070@kindex -msmall
5071@cindex memory model (29k)
5072Use a small memory model that assumes that all function addresses are
5073either within a single 256 KB segment or at an absolute address of less
5074than 256k. This allows the @code{call} instruction to be used instead
5075of a @code{const}, @code{consth}, @code{calli} sequence.
5076
5077@item -mnormal
5078@kindex -mnormal
5079Use the normal memory model: Generate @code{call} instructions only when
5080calling functions in the same file and @code{calli} instructions
5081otherwise. This works if each file occupies less than 256 KB but allows
5082the entire executable to be larger than 256 KB. This is the default.
5083
5084@item -mlarge
5085Always use @code{calli} instructions. Specify this option if you expect
5086a single file to compile into more than 256 KB of code.
5087
5088@item -m29050
5089@kindex -m29050
5090@cindex processor selection (29k)
5091Generate code for the Am29050.
5092
5093@item -m29000
5094@kindex -m29000
5095Generate code for the Am29000. This is the default.
5096
5097@item -mkernel-registers
5098@kindex -mkernel-registers
5099@cindex kernel and user registers (29k)
5100Generate references to registers @code{gr64-gr95} instead of to
5101registers @code{gr96-gr127}. This option can be used when compiling
5102kernel code that wants a set of global registers disjoint from that used
5103by user-mode code.
5104
5105Note that when this option is used, register names in @samp{-f} flags
5106must use the normal, user-mode, names.
5107
5108@item -muser-registers
5109@kindex -muser-registers
5110Use the normal set of global registers, @code{gr96-gr127}. This is the
5111default.
5112
5113@item -mstack-check
5114@itemx -mno-stack-check
5115@kindex -mstack-check
5116@cindex stack checks (29k)
5117Insert (or do not insert) a call to @code{__msp_check} after each stack
5118adjustment. This is often used for kernel code.
5119
5120@item -mstorem-bug
5121@itemx -mno-storem-bug
5122@kindex -mstorem-bug
5123@cindex storem bug (29k)
5124@samp{-mstorem-bug} handles 29k processors which cannot handle the
5125separation of a mtsrim insn and a storem instruction (most 29000 chips
5126to date, but not the 29050).
5127
5128@item -mno-reuse-arg-regs
5129@itemx -mreuse-arg-regs
5130@kindex -mreuse-arg-regs
5131@samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5132registers for copying out arguments. This helps detect calling a function
5133with fewer arguments than it was declared with.
5134
861bb6c1
JL
5135@item -mno-impure-text
5136@itemx -mimpure-text
5137@kindex -mimpure-text
5138@samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
5139not pass @samp{-assert pure-text} to the linker when linking a shared object.
5140
74291a4b
MM
5141@item -msoft-float
5142@kindex -msoft-float
5143Generate output containing library calls for floating point.
0c2d1a2a 5144@strong{Warning:} the requisite libraries are not part of GCC.
74291a4b
MM
5145Normally the facilities of the machine's usual C compiler are used, but
5146this can't be done directly in cross-compilation. You must make your
5147own arrangements to provide suitable library functions for
5148cross-compilation.
4e8d7ddc
JW
5149
5150@item -mno-multm
5151@kindex -mno-multm
5152Do not generate multm or multmu instructions. This is useful for some embedded
5153systems which do not have trap handlers for these instructions.
74291a4b
MM
5154@end table
5155
5156@node ARM Options
5157@subsection ARM Options
5158@cindex ARM options
5159
5160These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5161architectures:
5162
2642624b 5163@table @gcctabopt
74291a4b
MM
5164@item -mapcs-frame
5165@kindex -mapcs-frame
5166Generate a stack frame that is compliant with the ARM Procedure Call
5167Standard for all functions, even if this is not strictly necessary for
157a620e
NC
5168correct execution of the code. Specifying @samp{-fomit-frame-pointer}
5169with this option will cause the stack frames not to be generated for
5170leaf functions. The default is @samp{-mno-apcs-frame}.
5171
5172@item -mapcs
5173@kindex -mapcs
5174This is a synonym for @samp{-mapcs-frame}.
74291a4b
MM
5175
5176@item -mapcs-26
5177@kindex -mapcs-26
5178Generate code for a processor running with a 26-bit program counter,
5179and conforming to the function calling standards for the APCS 26-bit
5180option. This option replaces the @samp{-m2} and @samp{-m3} options
5181of previous releases of the compiler.
5182
5183@item -mapcs-32
5184@kindex -mapcs-32
5185Generate code for a processor running with a 32-bit program counter,
5186and conforming to the function calling standards for the APCS 32-bit
5187option. This option replaces the @samp{-m6} option of previous releases
5188of the compiler.
5189
157a620e
NC
5190@item -mapcs-stack-check
5191@kindex -mapcs-stack-check
5192@kindex -mno-apcs-stack-check
5193Generate code to check the amount of stack space available upon entry to
5194every function (that actually uses some stack space). If there is
5195insufficient space available then either the function
5196@samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5197called, depending upon the amount of stack space required. The run time
5198system is required to provide these functions. The default is
5199@samp{-mno-apcs-stack-check}, since this produces smaller code.
5200
5201@item -mapcs-float
5202@kindex -mapcs-float
5203@kindex -mno-apcs-float
5204Pass floating point arguments using the float point registers. This is
ed0e6530 5205one of the variants of the APCS. This option is recommended if the
157a620e
NC
5206target hardware has a floating point unit or if a lot of floating point
5207arithmetic is going to be performed by the code. The default is
5208@samp{-mno-apcs-float}, since integer only code is slightly increased in
5209size if @samp{-mapcs-float} is used.
5210
5211@item -mapcs-reentrant
5212@kindex -mapcs-reentrant
5213@kindex -mno-apcs-reentrant
5214Generate reentrant, position independent code. This is the equivalent
5215to specifying the @samp{-fpic} option. The default is
5216@samp{-mno-apcs-reentrant}.
5217
5218@item -mthumb-interwork
5219@kindex -mthumb-interwork
5220@kindex -mno-thumb-interwork
5221Generate code which supports calling between the ARM and THUMB
5222instruction sets. Without this option the two instruction sets cannot
5223be reliably used inside one program. The default is
5224@samp{-mno-thumb-interwork}, since slightly larger code is generated
5225when @samp{-mthumb-interwork} is specified.
5226
5227@item -mno-sched-prolog
5228@kindex -mno-sched-prolog
5229@kindex -msched-prolog
5230Prevent the reordering of instructions in the function prolog, or the
5231merging of those instruction with the instructions in the function's
ed0e6530
PB
5232body. This means that all functions will start with a recognizable set
5233of instructions (or in fact one of a choice from a small set of
157a620e
NC
5234different function prologues), and this information can be used to
5235locate the start if functions inside an executable piece of code. The
5236default is @samp{-msched-prolog}.
5237
74291a4b
MM
5238@item -mhard-float
5239Generate output containing floating point instructions. This is the
5240default.
5241
5242@item -msoft-float
5243Generate output containing library calls for floating point.
5244@strong{Warning:} the requisite libraries are not available for all ARM
5245targets. Normally the facilities of the machine's usual C compiler are
5246used, but this cannot be done directly in cross-compilation. You must make
5247your own arrangements to provide suitable library functions for
5248cross-compilation.
5249
5250@samp{-msoft-float} changes the calling convention in the output file;
5251therefore, it is only useful if you compile @emph{all} of a program with
5252this option. In particular, you need to compile @file{libgcc.a}, the
0c2d1a2a 5253library that comes with GCC, with @samp{-msoft-float} in order for
74291a4b
MM
5254this to work.
5255
5256@item -mlittle-endian
5257Generate code for a processor running in little-endian mode. This is
5258the default for all standard configurations.
5259
5260@item -mbig-endian
5261Generate code for a processor running in big-endian mode; the default is
5262to compile code for a little-endian processor.
5263
5264@item -mwords-little-endian
5265This option only applies when generating code for big-endian processors.
5266Generate code for a little-endian word order but a big-endian byte
5267order. That is, a byte order of the form @samp{32107654}. Note: this
5268option should only be used if you require compatibility with code for
5269big-endian ARM processors generated by versions of the compiler prior to
52702.8.
5271
5f1e6755
NC
5272@item -malignment-traps
5273@kindex -malignment-traps
5274Generate code that will not trap if the MMU has alignment traps enabled.
5275On ARM architectures prior to ARMv4, there were no instructions to
5276access half-word objects stored in memory. However, when reading from
5277memory a feature of the ARM architecture allows a word load to be used,
5278even if the address is unaligned, and the processor core will rotate the
5279data as it is being loaded. This option tells the compiler that such
5280misaligned accesses will cause a MMU trap and that it should instead
5281synthesise the access as a series of byte accesses. The compiler can
5282still use word accesses to load half-word data if it knows that the
5283address is aligned to a word boundary.
5284
5285This option is ignored when compiling for ARM architecture 4 or later,
5286since these processors have instructions to directly access half-word
5287objects in memory.
5288
5289@item -mno-alignment-traps
5290@kindex -mno-alignment-traps
5291Generate code that assumes that the MMU will not trap unaligned
5292accesses. This produces better code when the target instruction set
5293does not have half-word memory operations (implementations prior to
5294ARMv4).
5295
5296Note that you cannot use this option to access unaligned word objects,
5297since the processor will only fetch one 32-bit aligned object from
5298memory.
5299
5300The default setting for most targets is -mno-alignment-traps, since
5301this produces better code when there are no half-word memory
5302instructions available.
5303
74291a4b
MM
5304@item -mshort-load-bytes
5305@kindex -mshort-load-bytes
9e8fc4b8 5306This is a deprecated alias for @samp{-malignment-traps}.
74291a4b
MM
5307
5308@item -mno-short-load-bytes
5309@kindex -mno-short-load-bytes
9e8fc4b8 5310This is a deprecated alias for @samp{-mno-alignment-traps}.
74291a4b 5311
157a620e
NC
5312@item -mshort-load-words
5313@kindex -mshort-load-words
9e8fc4b8 5314This is a deprecated alias for @samp{-mno-alignment-traps}.
157a620e
NC
5315
5316@item -mno-short-load-words
5317@kindex -mno-short-load-words
9e8fc4b8 5318This is a deprecated alias for @samp{-malignment-traps}.
157a620e 5319
74291a4b
MM
5320@item -mbsd
5321@kindex -mbsd
5322This option only applies to RISC iX. Emulate the native BSD-mode
5323compiler. This is the default if @samp{-ansi} is not specified.
5324
5325@item -mxopen
5326@kindex -mxopen
5327This option only applies to RISC iX. Emulate the native X/Open-mode
5328compiler.
5329
5330@item -mno-symrename
5331@kindex -mno-symrename
5332This option only applies to RISC iX. Do not run the assembler
5333post-processor, @samp{symrename}, after code has been assembled.
5334Normally it is necessary to modify some of the standard symbols in
5335preparation for linking with the RISC iX C library; this option
5336suppresses this pass. The post-processor is never run when the
5337compiler is built for cross-compilation.
157a620e
NC
5338
5339@item -mcpu=<name>
5340@kindex -mcpu=
5341This specifies the name of the target ARM processor. GCC uses this name
5342to determine what kind of instructions it can use when generating
ed0e6530 5343assembly code. Permissible names are: arm2, arm250, arm3, arm6, arm60,
157a620e
NC
5344arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
5345arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
f5a1b0d2 5346arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
62b10bbc
NC
5347arm9, arm920, arm920t, arm9tdmi.
5348
5349@itemx -mtune=<name>
5350@kindex -mtune=
5351This option is very similar to the @samp{-mcpu=} option, except that
5352instead of specifying the actual target processor type, and hence
5353restricting which instructions can be used, it specifies that GCC should
5354tune the performance of the code as if the target were of the type
5355specified in this option, but still choosing the instructions that it
5356will generate based on the cpu specified by a @samp{-mcpu=} option.
5357For some arm implementations better performance can be obtained by using
5358this option.
157a620e
NC
5359
5360@item -march=<name>
5361@kindex -march=
5362This specifies the name of the target ARM architecture. GCC uses this
5363name to determine what kind of instructions it can use when generating
5364assembly code. This option can be used in conjunction with or instead
ed0e6530 5365of the @samp{-mcpu=} option. Permissible names are: armv2, armv2a,
62b10bbc 5366armv3, armv3m, armv4, armv4t, armv5.
157a620e
NC
5367
5368@item -mfpe=<number>
59d40964 5369@itemx -mfp=<number>
157a620e 5370@kindex -mfpe=
f5a1b0d2 5371@kindex -mfp=
b192711e 5372This specifies the version of the floating point emulation available on
ed0e6530 5373the target. Permissible values are 2 and 3. @samp{-mfp=} is a synonym
f5a1b0d2 5374for @samp{-mfpe=} to support older versions of GCC.
157a620e
NC
5375
5376@item -mstructure-size-boundary=<n>
5377@kindex -mstructure-size-boundary
5378The size of all structures and unions will be rounded up to a multiple
ed0e6530 5379of the number of bits set by this option. Permissible values are 8 and
157a620e
NC
538032. The default value varies for different toolchains. For the COFF
5381targeted toolchain the default value is 8. Specifying the larger number
ed0e6530 5382can produce faster, more efficient code, but can also increase the size
157a620e
NC
5383of the program. The two values are potentially incompatible. Code
5384compiled with one value cannot necessarily expect to work with code or
5385libraries compiled with the other value, if they exchange information
5386using structures or unions. Programmers are encouraged to use the 32
5387value as future versions of the toolchain may default to this value.
5388
f5a1b0d2
NC
5389@item -mabort-on-noreturn
5390@kindex -mabort-on-noreturn
5391@kindex -mnoabort-on-noreturn
5392Generate a call to the function abort at the end of a noreturn function.
5393It will be executed if the function tries to return.
5394
c27ba912
DM
5395@item -mlong-calls
5396@itemx -mno-long-calls
5397Tells the compiler to perform function calls by first loading the
5398address of the function into a register and then performing a subroutine
5399call on this register. This switch is needed if the target function
5400will lie outside of the 64 megabyte addressing range of the offset based
5401version of subroutine call instruction.
5402
5403Even if this switch is enabled, not all function calls will be turned
5404into long calls. The heuristic is that static functions, functions
5405which have the @samp{short-call} attribute, functions that are inside
5406the scope of a @samp{#pragma no_long_calls} directive and functions whose
5407definitions have already been compiled within the current compilation
5408unit, will not be turned into long calls. The exception to this rule is
b192711e 5409that weak function definitions, functions with the @samp{long-call}
c27ba912
DM
5410attribute or the @samp{section} attribute, and functions that are within
5411the scope of a @samp{#pragma long_calls} directive, will always be
5412turned into long calls.
5413
5414This feature is not enabled by default. Specifying
5415@samp{--no-long-calls} will restore the default behaviour, as will
5416placing the function calls within the scope of a @samp{#pragma
5417long_calls_off} directive. Note these switches have no effect on how
5418the compiler generates code to handle function calls via function
5419pointers.
5420
62b10bbc
NC
5421@item -mnop-fun-dllimport
5422@kindex -mnop-fun-dllimport
5423Disable the support for the @emph{dllimport} attribute.
5424
ed0e6530
PB
5425@item -msingle-pic-base
5426@kindex -msingle-pic-base
5427Treat the register used for PIC addressing as read-only, rather than
5428loading it in the prologue for each function. The run-time system is
5429responsible for initialising this register with an appropriate value
5430before execution begins.
5431
5432@item -mpic-register=<reg>
5433@kindex -mpic-register=
5434Specify the register to be used for PIC addressing. The default is R10
5435unless stack-checking is enabled, when R9 is used.
5436
74291a4b
MM
5437@end table
5438
157a620e
NC
5439@node Thumb Options
5440@subsection Thumb Options
5441@cindex Thumb Options
5442
2642624b 5443@table @gcctabopt
157a620e
NC
5444
5445@item -mthumb-interwork
5446@kindex -mthumb-interwork
5447@kindex -mno-thumb-interwork
5448Generate code which supports calling between the THUMB and ARM
5449instruction sets. Without this option the two instruction sets cannot
5450be reliably used inside one program. The default is
5451@samp{-mno-thumb-interwork}, since slightly smaller code is generated
5452with this option.
5453
5454@item -mtpcs-frame
5455@kindex -mtpcs-frame
5456@kindex -mno-tpcs-frame
5457Generate a stack frame that is compliant with the Thumb Procedure Call
5458Standard for all non-leaf functions. (A leaf function is one that does
5459not call any other functions). The default is @samp{-mno-apcs-frame}.
5460
5461@item -mtpcs-leaf-frame
5462@kindex -mtpcs-leaf-frame
5463@kindex -mno-tpcs-leaf-frame
5464Generate a stack frame that is compliant with the Thumb Procedure Call
5465Standard for all leaf functions. (A leaf function is one that does
5466not call any other functions). The default is @samp{-mno-apcs-leaf-frame}.
5467
5468@item -mlittle-endian
5469@kindex -mlittle-endian
5470Generate code for a processor running in little-endian mode. This is
5471the default for all standard configurations.
5472
5473@item -mbig-endian
5474@kindex -mbig-endian
5475Generate code for a processor running in big-endian mode.
5476
5477@item -mstructure-size-boundary=<n>
5478@kindex -mstructure-size-boundary
5479The size of all structures and unions will be rounded up to a multiple
4bdc1ac7 5480of the number of bits set by this option. Permissible values are 8 and
157a620e
NC
548132. The default value varies for different toolchains. For the COFF
5482targeted toolchain the default value is 8. Specifying the larger number
5483can produced faster, more efficient code, but can also increase the size
5484of the program. The two values are potentially incompatible. Code
5485compiled with one value cannot necessarily expect to work with code or
5486libraries compiled with the other value, if they exchange information
5487using structures or unions. Programmers are encouraged to use the 32
5488value as future versions of the toolchain may default to this value.
5489
62b10bbc
NC
5490@item -mnop-fun-dllimport
5491@kindex -mnop-fun-dllimport
5492Disable the support for the @emph{dllimport} attribute.
5493
5494@item -mcallee-super-interworking
5495@kindex -mcallee-super-interworking
5496Gives all externally visible functions in the file being compiled an ARM
5497instruction set header which switches to Thumb mode before executing the
5498rest of the function. This allows these functions to be called from
5499non-interworking code.
5500
5501@item -mcaller-super-interworking
5502@kindex -mcaller-super-interworking
5503Allows calls via function pointers (including virtual functions) to
5504execute correctly regardless of whether the target code has been
5505compiled for interworking or not. There is a small overhead in the cost
4bdc1ac7
PB
5506of executing a function pointer if this option is enabled.
5507
5508@item -msingle-pic-base
5509@kindex -msingle-pic-base
5510Treat the register used for PIC addressing as read-only, rather than
5511loading it in the prologue for each function. The run-time system is
5512responsible for initialising this register with an appropriate value
5513before execution begins.
5514
5515@item -mpic-register=<reg>
5516@kindex -mpic-register=
5517Specify the register to be used for PIC addressing. The default is R10.
62b10bbc 5518
157a620e
NC
5519@end table
5520
ecff22ab
JL
5521@node MN10200 Options
5522@subsection MN10200 Options
5523@cindex MN10200 options
5524These @samp{-m} options are defined for Matsushita MN10200 architectures:
2642624b 5525@table @gcctabopt
ecff22ab
JL
5526
5527@item -mrelax
5528Indicate to the linker that it should perform a relaxation optimization pass
5529to shorten branches, calls and absolute memory addresses. This option only
5530has an effect when used on the command line for the final link step.
5531
5532This option makes symbolic debugging impossible.
5533@end table
157a620e 5534
6d6d0fa0
JL
5535@node MN10300 Options
5536@subsection MN10300 Options
5537@cindex MN10300 options
5538These @samp{-m} options are defined for Matsushita MN10300 architectures:
5539
2642624b 5540@table @gcctabopt
6d6d0fa0
JL
5541@item -mmult-bug
5542Generate code to avoid bugs in the multiply instructions for the MN10300
5543processors. This is the default.
5544
5545@item -mno-mult-bug
5546Do not generate code to avoid bugs in the multiply instructions for the
5547MN10300 processors.
ecff22ab 5548
705ac34f
JL
5549@item -mam33
5550Generate code which uses features specific to the AM33 processor.
5551
5552@item -mno-am33
5553Do not generate code which uses features specific to the AM33 processor. This
5554is the default.
5555
ecff22ab
JL
5556@item -mrelax
5557Indicate to the linker that it should perform a relaxation optimization pass
5558to shorten branches, calls and absolute memory addresses. This option only
5559has an effect when used on the command line for the final link step.
5560
5561This option makes symbolic debugging impossible.
6d6d0fa0
JL
5562@end table
5563
ecff22ab 5564
861bb6c1
JL
5565@node M32R/D Options
5566@subsection M32R/D Options
5567@cindex M32R/D options
5568
5569These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5570
2642624b 5571@table @gcctabopt
861bb6c1
JL
5572@item -mcode-model=small
5573Assume all objects live in the lower 16MB of memory (so that their addresses
5574can be loaded with the @code{ld24} instruction), and assume all subroutines
5575are reachable with the @code{bl} instruction.
5576This is the default.
5577
5578The addressability of a particular object can be set with the
5579@code{model} attribute.
5580
5581@item -mcode-model=medium
5582Assume objects may be anywhere in the 32 bit address space (the compiler
5583will generate @code{seth/add3} instructions to load their addresses), and
5584assume all subroutines are reachable with the @code{bl} instruction.
5585
5586@item -mcode-model=large
5587Assume objects may be anywhere in the 32 bit address space (the compiler
5588will generate @code{seth/add3} instructions to load their addresses), and
5589assume subroutines may not be reachable with the @code{bl} instruction
5590(the compiler will generate the much slower @code{seth/add3/jl}
5591instruction sequence).
5592
5593@item -msdata=none
5594Disable use of the small data area. Variables will be put into
5595one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5596@code{section} attribute has been specified).
5597This is the default.
5598
5599The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5600Objects may be explicitly put in the small data area with the
5601@code{section} attribute using one of these sections.
5602
5603@item -msdata=sdata
5604Put small global and static data in the small data area, but do not
5605generate special code to reference them.
5606
5607@item -msdata=use
5608Put small global and static data in the small data area, and generate
5609special instructions to reference them.
5610
5611@item -G @var{num}
5612@cindex smaller data references
5613Put global and static objects less than or equal to @var{num} bytes
5614into the small data or bss sections instead of the normal data or bss
5615sections. The default value of @var{num} is 8.
5616The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5617for this option to have any effect.
5618
5619All modules should be compiled with the same @samp{-G @var{num}} value.
5620Compiling with different values of @var{num} may or may not work; if it
5621doesn't the linker will give an error message - incorrect code will not be
5622generated.
5623
5624@end table
5625
74291a4b
MM
5626@node M88K Options
5627@subsection M88K Options
5628@cindex M88k options
5629
5630These @samp{-m} options are defined for Motorola 88k architectures:
5631
2642624b 5632@table @gcctabopt
74291a4b
MM
5633@item -m88000
5634@kindex -m88000
5635Generate code that works well on both the m88100 and the
5636m88110.
5637
5638@item -m88100
5639@kindex -m88100
5640Generate code that works best for the m88100, but that also
5641runs on the m88110.
5642
5643@item -m88110
5644@kindex -m88110
5645Generate code that works best for the m88110, and may not run
5646on the m88100.
5647
5648@item -mbig-pic
5649@kindex -mbig-pic
5650Obsolete option to be removed from the next revision.
5651Use @samp{-fPIC}.
5652
5653@item -midentify-revision
5654@kindex -midentify-revision
5655@kindex ident
5656@cindex identifying source, compiler (88k)
5657Include an @code{ident} directive in the assembler output recording the
5658source file name, compiler name and version, timestamp, and compilation
5659flags used.
5660
5661@item -mno-underscores
5662@kindex -mno-underscores
5663@cindex underscores, avoiding (88k)
5664In assembler output, emit symbol names without adding an underscore
5665character at the beginning of each name. The default is to use an
5666underscore as prefix on each name.
5667
5668@item -mocs-debug-info
5669@itemx -mno-ocs-debug-info
5670@kindex -mocs-debug-info
5671@kindex -mno-ocs-debug-info
5672@cindex OCS (88k)
5673@cindex debugging, 88k OCS
5674Include (or omit) additional debugging information (about registers used
5675in each stack frame) as specified in the 88open Object Compatibility
5676Standard, ``OCS''. This extra information allows debugging of code that
5677has had the frame pointer eliminated. The default for DG/UX, SVr4, and
5678Delta 88 SVr3.2 is to include this information; other 88k configurations
5679omit this information by default.
5680
5681@item -mocs-frame-position
5682@kindex -mocs-frame-position
5683@cindex register positions in frame (88k)
5684When emitting COFF debugging information for automatic variables and
5685parameters stored on the stack, use the offset from the canonical frame
5686address, which is the stack pointer (register 31) on entry to the
5687function. The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5688@samp{-mocs-frame-position}; other 88k configurations have the default
5689@samp{-mno-ocs-frame-position}.
5690
5691@item -mno-ocs-frame-position
5692@kindex -mno-ocs-frame-position
5693@cindex register positions in frame (88k)
5694When emitting COFF debugging information for automatic variables and
5695parameters stored on the stack, use the offset from the frame pointer
5696register (register 30). When this option is in effect, the frame
5697pointer is not eliminated when debugging information is selected by the
5698-g switch.
5699
5700@item -moptimize-arg-area
5701@itemx -mno-optimize-arg-area
5702@kindex -moptimize-arg-area
5703@kindex -mno-optimize-arg-area
5704@cindex arguments in frame (88k)
5705Control how function arguments are stored in stack frames.
5706@samp{-moptimize-arg-area} saves space by optimizing them, but this
5707conflicts with the 88open specifications. The opposite alternative,
5708@samp{-mno-optimize-arg-area}, agrees with 88open standards. By default
0c2d1a2a 5709GCC does not optimize the argument area.
74291a4b
MM
5710
5711@item -mshort-data-@var{num}
5712@kindex -mshort-data-@var{num}
5713@cindex smaller data references (88k)
5714@cindex r0-relative references (88k)
5715Generate smaller data references by making them relative to @code{r0},
5716which allows loading a value using a single instruction (rather than the
5717usual two). You control which data references are affected by
5718specifying @var{num} with this option. For example, if you specify
5719@samp{-mshort-data-512}, then the data references affected are those
5720involving displacements of less than 512 bytes.
5721@samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5722than 64k.
5723
5724@item -mserialize-volatile
5725@kindex -mserialize-volatile
5726@itemx -mno-serialize-volatile
5727@kindex -mno-serialize-volatile
5728@cindex sequential consistency on 88k
5729Do, or don't, generate code to guarantee sequential consistency
5730of volatile memory references. By default, consistency is
5731guaranteed.
5732
5733The order of memory references made by the MC88110 processor does
5734not always match the order of the instructions requesting those
5735references. In particular, a load instruction may execute before
5736a preceding store instruction. Such reordering violates
5737sequential consistency of volatile memory references, when there
5738are multiple processors. When consistency must be guaranteed,
5739GNU C generates special instructions, as needed, to force
5740execution in the proper order.
5741
5742The MC88100 processor does not reorder memory references and so
5743always provides sequential consistency. However, by default, GNU
5744C generates the special instructions to guarantee consistency
5745even when you use @samp{-m88100}, so that the code may be run on an
5746MC88110 processor. If you intend to run your code only on the
5747MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5748
5749The extra code generated to guarantee consistency may affect the
5750performance of your application. If you know that you can safely
5751forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5752
5753@item -msvr4
5754@itemx -msvr3
5755@kindex -msvr4
5756@kindex -msvr3
5757@cindex assembler syntax, 88k
5758@cindex SVr4
5759Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5760related to System V release 4 (SVr4). This controls the following:
5761
5762@enumerate
5763@item
5764Which variant of the assembler syntax to emit.
5765@item
5766@samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5767that is used on System V release 4.
5768@item
0c2d1a2a 5769@samp{-msvr4} makes GCC issue additional declaration directives used in
74291a4b
MM
5770SVr4.
5771@end enumerate
5772
5773@samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5774m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5775other m88k configurations.
5776
5777@item -mversion-03.00
5778@kindex -mversion-03.00
5779This option is obsolete, and is ignored.
5780@c ??? which asm syntax better for GAS? option there too?
5781
5782@item -mno-check-zero-division
5783@itemx -mcheck-zero-division
5784@kindex -mno-check-zero-division
5785@kindex -mcheck-zero-division
5786@cindex zero division on 88k
5787Do, or don't, generate code to guarantee that integer division by
5788zero will be detected. By default, detection is guaranteed.
5789
5790Some models of the MC88100 processor fail to trap upon integer
5791division by zero under certain conditions. By default, when
5792compiling code that might be run on such a processor, GNU C
5793generates code that explicitly checks for zero-valued divisors
5794and traps with exception number 503 when one is detected. Use of
5795mno-check-zero-division suppresses such checking for code
5796generated to run on an MC88100 processor.
5797
5798GNU C assumes that the MC88110 processor correctly detects all
5799instances of integer division by zero. When @samp{-m88110} is
5800specified, both @samp{-mcheck-zero-division} and
5801@samp{-mno-check-zero-division} are ignored, and no explicit checks for
5802zero-valued divisors are generated.
5803
5804@item -muse-div-instruction
5805@kindex -muse-div-instruction
5806@cindex divide instruction, 88k
5807Use the div instruction for signed integer division on the
5808MC88100 processor. By default, the div instruction is not used.
5809
5810On the MC88100 processor the signed integer division instruction
5811div) traps to the operating system on a negative operand. The
5812operating system transparently completes the operation, but at a
5813large cost in execution time. By default, when compiling code
5814that might be run on an MC88100 processor, GNU C emulates signed
5815integer division using the unsigned integer division instruction
5816divu), thereby avoiding the large penalty of a trap to the
5817operating system. Such emulation has its own, smaller, execution
5818cost in both time and space. To the extent that your code's
5819important signed integer division operations are performed on two
5820nonnegative operands, it may be desirable to use the div
5821instruction directly.
5822
5823On the MC88110 processor the div instruction (also known as the
5824divs instruction) processes negative operands without trapping to
5825the operating system. When @samp{-m88110} is specified,
5826@samp{-muse-div-instruction} is ignored, and the div instruction is used
5827for signed integer division.
5828
5829Note that the result of dividing INT_MIN by -1 is undefined. In
5830particular, the behavior of such a division with and without
5831@samp{-muse-div-instruction} may differ.
5832
5833@item -mtrap-large-shift
5834@itemx -mhandle-large-shift
5835@kindex -mtrap-large-shift
5836@kindex -mhandle-large-shift
5837@cindex bit shift overflow (88k)
5838@cindex large bit shifts (88k)
5839Include code to detect bit-shifts of more than 31 bits; respectively,
0c2d1a2a 5840trap such shifts or emit code to handle them properly. By default GCC
74291a4b
MM
5841makes no special provision for large bit shifts.
5842
5843@item -mwarn-passed-structs
5844@kindex -mwarn-passed-structs
5845@cindex structure passing (88k)
5846Warn when a function passes a struct as an argument or result.
5847Structure-passing conventions have changed during the evolution of the C
5848language, and are often the source of portability problems. By default,
0c2d1a2a 5849GCC issues no such warning.
74291a4b
MM
5850@end table
5851
5852@node RS/6000 and PowerPC Options
5853@subsection IBM RS/6000 and PowerPC Options
5854@cindex RS/6000 and PowerPC Options
5855@cindex IBM RS/6000 and PowerPC Options
5856
5857These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
2642624b 5858@table @gcctabopt
74291a4b
MM
5859@item -mpower
5860@itemx -mno-power
5861@itemx -mpower2
5862@itemx -mno-power2
5863@itemx -mpowerpc
5864@itemx -mno-powerpc
5865@itemx -mpowerpc-gpopt
5866@itemx -mno-powerpc-gpopt
5867@itemx -mpowerpc-gfxopt
5868@itemx -mno-powerpc-gfxopt
7fe90e7b
DE
5869@itemx -mpowerpc64
5870@itemx -mno-powerpc64
74291a4b
MM
5871@kindex -mpower
5872@kindex -mpower2
5873@kindex -mpowerpc
5874@kindex -mpowerpc-gpopt
5875@kindex -mpowerpc-gfxopt
7fe90e7b 5876@kindex -mpowerpc64
0c2d1a2a 5877GCC supports two related instruction set architectures for the
74291a4b
MM
5878RS/6000 and PowerPC. The @dfn{POWER} instruction set are those
5879instructions supported by the @samp{rios} chip set used in the original
5880RS/6000 systems and the @dfn{PowerPC} instruction set is the
5881architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
861bb6c1 5882the IBM 4xx microprocessors.
74291a4b
MM
5883
5884Neither architecture is a subset of the other. However there is a
5885large common subset of instructions supported by both. An MQ
5886register is included in processors supporting the POWER architecture.
5887
5888You use these options to specify which instructions are available on the
5889processor you are using. The default value of these options is
0c2d1a2a 5890determined when configuring GCC. Specifying the
74291a4b
MM
5891@samp{-mcpu=@var{cpu_type}} overrides the specification of these
5892options. We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5893rather than the options listed above.
5894
0c2d1a2a 5895The @samp{-mpower} option allows GCC to generate instructions that
74291a4b 5896are found only in the POWER architecture and to use the MQ register.
0c2d1a2a 5897Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
74291a4b
MM
5898to generate instructions that are present in the POWER2 architecture but
5899not the original POWER architecture.
5900
0c2d1a2a 5901The @samp{-mpowerpc} option allows GCC to generate instructions that
74291a4b
MM
5902are found only in the 32-bit subset of the PowerPC architecture.
5903Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
0c2d1a2a 5904GCC to use the optional PowerPC architecture instructions in the
74291a4b 5905General Purpose group, including floating-point square root. Specifying
0c2d1a2a 5906@samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
74291a4b
MM
5907use the optional PowerPC architecture instructions in the Graphics
5908group, including floating-point select.
5909
0c2d1a2a 5910The @samp{-mpowerpc64} option allows GCC to generate the additional
7fe90e7b 591164-bit instructions that are found in the full PowerPC64 architecture
0c2d1a2a 5912and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
7fe90e7b
DE
5913@samp{-mno-powerpc64}.
5914
0c2d1a2a 5915If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
74291a4b
MM
5916will use only the instructions in the common subset of both
5917architectures plus some special AIX common-mode calls, and will not use
5918the MQ register. Specifying both @samp{-mpower} and @samp{-mpowerpc}
0c2d1a2a 5919permits GCC to use any instruction from either architecture and to
74291a4b
MM
5920allow use of the MQ register; specify this for the Motorola MPC601.
5921
5922@item -mnew-mnemonics
5923@itemx -mold-mnemonics
5924@kindex -mnew-mnemonics
5925@kindex -mold-mnemonics
5926Select which mnemonics to use in the generated assembler code.
5927@samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5928defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5929requests the assembler mnemonics defined for the POWER architecture.
5930Instructions defined in only one architecture have only one mnemonic;
0c2d1a2a 5931GCC uses that mnemonic irrespective of which of these options is
74291a4b
MM
5932specified.
5933
0c2d1a2a 5934GCC defaults to the mnemonics appropriate for the architecture in
7fe90e7b
DE
5935use. Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5936value of these option. Unless you are building a cross-compiler, you
5937should normally not specify either @samp{-mnew-mnemonics} or
74291a4b
MM
5938@samp{-mold-mnemonics}, but should instead accept the default.
5939
5940@item -mcpu=@var{cpu_type}
7fe90e7b 5941@kindex -mcpu
74291a4b
MM
5942Set architecture type, register usage, choice of mnemonics, and
5943instruction scheduling parameters for machine type @var{cpu_type}.
5f59ecb7
DE
5944Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5945@samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5946@samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5947@samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5948@samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5949@samp{823}, and @samp{860} and @samp{common}. @samp{-mcpu=power},
5950@samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5951specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5952and 64-bit PowerPC architecture machine types, with an appropriate,
bef84347 5953generic processor model assumed for scheduling purposes.@refill
74291a4b 5954
74291a4b
MM
5955Specifying any of the following options:
5956@samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5957@samp{-mcpu=power}, or @samp{-mcpu=power2}
5958enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option;
5959@samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5f59ecb7
DE
5960All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5961@samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5962@samp{-mcpu=740}, and @samp{-mcpu=750}
74291a4b
MM
5963enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5964Exactly similarly, all of @samp{-mcpu=403},
5965@samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc}
5966enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5967@samp{-mcpu=common} disables both the
5968@samp{-mpower} and @samp{-mpowerpc} options.@refill
74291a4b
MM
5969
5970AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5f59ecb7 5971that code will operate on all members of the RS/6000 POWER and PowerPC
0c2d1a2a 5972families. In that case, GCC will use only the instructions in the
74291a4b 5973common subset of both architectures plus some special AIX common-mode
0c2d1a2a 5974calls, and will not use the MQ register. GCC assumes a generic
74291a4b
MM
5975processor model for scheduling purposes.
5976
5977Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5978@samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5979disables the @samp{new-mnemonics} option. Specifying @samp{-mcpu=601},
5980@samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5f59ecb7
DE
5981@samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5982@samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5983the @samp{new-mnemonics} option.@refill
74291a4b
MM
5984
5985Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5986enables the @samp{-msoft-float} option.
5987
5988@item -mtune=@var{cpu_type}
5989Set the instruction scheduling parameters for machine type
5990@var{cpu_type}, but do not set the architecture type, register usage,
5991choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would. The same
5992values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5993for @samp{-mcpu=}@var{cpu_type}. The @samp{-mtune=}@var{cpu_type}
5994option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5995instruction scheduling parameters.
5996
5997@item -mfull-toc
5998@itemx -mno-fp-in-toc
5999@itemx -mno-sum-in-toc
6000@itemx -mminimal-toc
7fe90e7b 6001@kindex -mminimal-toc
74291a4b
MM
6002Modify generation of the TOC (Table Of Contents), which is created for
6003every executable file. The @samp{-mfull-toc} option is selected by
0c2d1a2a
JB
6004default. In that case, GCC will allocate at least one TOC entry for
6005each unique non-automatic variable reference in your program. GCC
74291a4b
MM
6006will also place floating-point constants in the TOC. However, only
600716,384 entries are available in the TOC.
6008
6009If you receive a linker error message that saying you have overflowed
6010the available TOC space, you can reduce the amount of TOC space used
6011with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
0c2d1a2a
JB
6012@samp{-mno-fp-in-toc} prevents GCC from putting floating-point
6013constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
74291a4b
MM
6014generate code to calculate the sum of an address and a constant at
6015run-time instead of putting that sum into the TOC. You may specify one
0c2d1a2a 6016or both of these options. Each causes GCC to produce very slightly
74291a4b
MM
6017slower and larger code at the expense of conserving TOC space.
6018
6019If you still run out of space in the TOC even when you specify both of
6020these options, specify @samp{-mminimal-toc} instead. This option causes
0c2d1a2a
JB
6021GCC to make only one TOC entry for every file. When you specify this
6022option, GCC will produce code that is slower and larger but which
74291a4b
MM
6023uses extremely little TOC space. You may wish to use this option
6024only on files that contain less frequently executed code. @refill
6025
fa06229f
GK
6026@item -maix64
6027@itemx -maix32
6028@kindex -maix64
6029@kindex -maix32
6030Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7fe90e7b 6031@code{long} type, and the infrastructure needed to support them.
fa06229f
GK
6032Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
6033@samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
6034implies @samp{-mno-powerpc64}. GCC defaults to @samp{-maix32}.
7fe90e7b 6035
74291a4b
MM
6036@item -mxl-call
6037@itemx -mno-xl-call
7fe90e7b 6038@kindex -mxl-call
74291a4b
MM
6039On AIX, pass floating-point arguments to prototyped functions beyond the
6040register save area (RSA) on the stack in addition to argument FPRs. The
6041AIX calling convention was extended but not initially documented to
6042handle an obscure K&R C case of calling a function that takes the
6043address of its arguments with fewer arguments than declared. AIX XL
7fe90e7b
DE
6044compilers access floating point arguments which do not fit in the
6045RSA from the stack when a subroutine is compiled without
74291a4b
MM
6046optimization. Because always storing floating-point arguments on the
6047stack is inefficient and rarely needed, this option is not enabled by
6048default and only is necessary when calling subroutines compiled by AIX
6049XL compilers without optimization.
6050
861bb6c1 6051@item -mthreads
7fe90e7b 6052@kindex -mthreads
861bb6c1
JL
6053Support @dfn{AIX Threads}. Link an application written to use
6054@dfn{pthreads} with special libraries and startup code to enable the
6055application to run.
6056
6057@item -mpe
7fe90e7b 6058@kindex -mpe
861bb6c1
JL
6059Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE). Link an
6060application written to use message passing with special startup code to
6061enable the application to run. The system must have PE installed in the
6062standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6063must be overridden with the @samp{-specs=} option to specify the
6064appropriate directory location. The Parallel Environment does not
6065support threads, so the @samp{-mpe} option and the @samp{-mthreads}
6066option are incompatible.
6067
74291a4b
MM
6068@item -msoft-float
6069@itemx -mhard-float
7fe90e7b 6070@kindex -msoft-float
74291a4b
MM
6071Generate code that does not use (uses) the floating-point register set.
6072Software floating point emulation is provided if you use the
0c2d1a2a 6073@samp{-msoft-float} option, and pass the option to GCC when linking.
74291a4b
MM
6074
6075@item -mmultiple
6076@itemx -mno-multiple
6077Generate code that uses (does not use) the load multiple word
6078instructions and the store multiple word instructions. These
6079instructions are generated by default on POWER systems, and not
6080generated on PowerPC systems. Do not use @samp{-mmultiple} on little
6081endian PowerPC systems, since those instructions do not work when the
bef84347
VM
6082processor is in little endian mode. The exceptions are PPC740 and
6083PPC750 which permit the instructions usage in little endian mode.
74291a4b
MM
6084
6085@item -mstring
6086@itemx -mno-string
7fe90e7b 6087@kindex -mstring
bef84347
VM
6088Generate code that uses (does not use) the load string instructions
6089and the store string word instructions to save multiple registers and
6090do small block moves. These instructions are generated by default on
6091POWER systems, and not generated on PowerPC systems. Do not use
6092@samp{-mstring} on little endian PowerPC systems, since those
6093instructions do not work when the processor is in little endian mode.
6094The exceptions are PPC740 and PPC750 which permit the instructions
6095usage in little endian mode.
74291a4b 6096
861bb6c1
JL
6097@item -mupdate
6098@itemx -mno-update
7fe90e7b 6099@kindex -mupdate
861bb6c1
JL
6100Generate code that uses (does not use) the load or store instructions
6101that update the base register to the address of the calculated memory
6102location. These instructions are generated by default. If you use
6103@samp{-mno-update}, there is a small window between the time that the
6104stack pointer is updated and the address of the previous frame is
6105stored, which means code that walks the stack frame across interrupts or
6106signals may get corrupted data.
6107
6108@item -mfused-madd
6109@itemx -mno-fused-madd
7fe90e7b 6110@kindex -mfused-madd
861bb6c1
JL
6111Generate code that uses (does not use) the floating point multiply and
6112accumulate instructions. These instructions are generated by default if
6113hardware floating is used.
6114
74291a4b
MM
6115@item -mno-bit-align
6116@itemx -mbit-align
7fe90e7b 6117@kindex -mbit-align
74291a4b
MM
6118On System V.4 and embedded PowerPC systems do not (do) force structures
6119and unions that contain bit fields to be aligned to the base type of the
6120bit field.
6121
6122For example, by default a structure containing nothing but 8
6123@code{unsigned} bitfields of length 1 would be aligned to a 4 byte
6124boundary and have a size of 4 bytes. By using @samp{-mno-bit-align},
6125the structure would be aligned to a 1 byte boundary and be one byte in
6126size.
6127
6128@item -mno-strict-align
6129@itemx -mstrict-align
7fe90e7b 6130@kindex -mstrict-align
74291a4b
MM
6131On System V.4 and embedded PowerPC systems do not (do) assume that
6132unaligned memory references will be handled by the system.
6133
6134@item -mrelocatable
6135@itemx -mno-relocatable
7fe90e7b 6136@kindex -mrelocatable
74291a4b
MM
6137On embedded PowerPC systems generate code that allows (does not allow)
6138the program to be relocated to a different address at runtime. If you
6139use @samp{-mrelocatable} on any module, all objects linked together must
6140be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
6141
6142@item -mrelocatable-lib
6143@itemx -mno-relocatable-lib
6144On embedded PowerPC systems generate code that allows (does not allow)
6145the program to be relocated to a different address at runtime. Modules
956d6950 6146compiled with @samp{-mrelocatable-lib} can be linked with either modules
74291a4b
MM
6147compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
6148with modules compiled with the @samp{-mrelocatable} options.
6149
6150@item -mno-toc
6151@itemx -mtoc
6152On System V.4 and embedded PowerPC systems do not (do) assume that
6153register 2 contains a pointer to a global area pointing to the addresses
6154used in the program.
6155
74291a4b
MM
6156@item -mlittle
6157@itemx -mlittle-endian
6158On System V.4 and embedded PowerPC systems compile code for the
6159processor in little endian mode. The @samp{-mlittle-endian} option is
6160the same as @samp{-mlittle}.
6161
6162@item -mbig
6163@itemx -mbig-endian
6164On System V.4 and embedded PowerPC systems compile code for the
6165processor in big endian mode. The @samp{-mbig-endian} option is
6166the same as @samp{-mbig}.
6167
6168@item -mcall-sysv
6169On System V.4 and embedded PowerPC systems compile code using calling
6170conventions that adheres to the March 1995 draft of the System V
6171Application Binary Interface, PowerPC processor supplement. This is the
6172default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6173
6174@item -mcall-sysv-eabi
6175Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
6176
6177@item -mcall-sysv-noeabi
6178Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
6179
6180@item -mcall-aix
6181On System V.4 and embedded PowerPC systems compile code using calling
6182conventions that are similar to those used on AIX. This is the
6183default if you configured GCC using @samp{powerpc-*-eabiaix}.
6184
6185@item -mcall-solaris
6186On System V.4 and embedded PowerPC systems compile code for the Solaris
6187operating system.
6188
6189@item -mcall-linux
861bb6c1
JL
6190On System V.4 and embedded PowerPC systems compile code for the
6191Linux-based GNU system.
74291a4b
MM
6192
6193@item -mprototype
e9a25f70 6194@itemx -mno-prototype
74291a4b
MM
6195On System V.4 and embedded PowerPC systems assume that all calls to
6196variable argument functions are properly prototyped. Otherwise, the
6197compiler must insert an instruction before every non prototyped call to
6198set or clear bit 6 of the condition code register (@var{CR}) to
6199indicate whether floating point values were passed in the floating point
6200registers in case the function takes a variable arguments. With
6201@samp{-mprototype}, only calls to prototyped variable argument functions
6202will set or clear the bit.
6203
6204@item -msim
6205On embedded PowerPC systems, assume that the startup module is called
6206@file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6207@file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
6208configurations.
6209
6210@item -mmvme
6211On embedded PowerPC systems, assume that the startup module is called
e9a25f70
JL
6212@file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6213@file{libc.a}.
6214
6215@item -mads
6216On embedded PowerPC systems, assume that the startup module is called
6217@file{crt0.o} and the standard C libraries are @file{libads.a} and
6218@file{libc.a}.
6219
6220@item -myellowknife
6221On embedded PowerPC systems, assume that the startup module is called
6222@file{crt0.o} and the standard C libraries are @file{libyk.a} and
74291a4b
MM
6223@file{libc.a}.
6224
bff46771
GK
6225@item -mvxworks
6226On System V.4 and embedded PowerPC systems, specify that you are
6227compiling for a VxWorks system.
6228
74291a4b
MM
6229@item -memb
6230On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6231header to indicate that @samp{eabi} extended relocations are used.
6232
6233@item -meabi
6234@itemx -mno-eabi
6235On System V.4 and embedded PowerPC systems do (do not) adhere to the
6236Embedded Applications Binary Interface (eabi) which is a set of
bedc7537 6237modifications to the System V.4 specifications. Selecting @option{-meabi}
74291a4b
MM
6238means that the stack is aligned to an 8 byte boundary, a function
6239@code{__eabi} is called to from @code{main} to set up the eabi
6240environment, and the @samp{-msdata} option can use both @code{r2} and
6241@code{r13} to point to two separate small data areas. Selecting
bedc7537 6242@option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
74291a4b
MM
6243do not call an initialization function from @code{main}, and the
6244@samp{-msdata} option will only use @code{r13} to point to a single
6245small data area. The @samp{-meabi} option is on by default if you
6246configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6247
6248@item -msdata=eabi
6249On System V.4 and embedded PowerPC systems, put small initialized
6250@code{const} global and static data in the @samp{.sdata2} section, which
6251is pointed to by register @code{r2}. Put small initialized
6252non-@code{const} global and static data in the @samp{.sdata} section,
6253which is pointed to by register @code{r13}. Put small uninitialized
6254global and static data in the @samp{.sbss} section, which is adjacent to
6255the @samp{.sdata} section. The @samp{-msdata=eabi} option is
6256incompatible with the @samp{-mrelocatable} option. The
6257@samp{-msdata=eabi} option also sets the @samp{-memb} option.
6258
6259@item -msdata=sysv
6260On System V.4 and embedded PowerPC systems, put small global and static
6261data in the @samp{.sdata} section, which is pointed to by register
6262@code{r13}. Put small uninitialized global and static data in the
6263@samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6264The @samp{-msdata=sysv} option is incompatible with the
6265@samp{-mrelocatable} option.
6266
6267@item -msdata=default
6268@itemx -msdata
6269On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
6270compile code the same as @samp{-msdata=eabi}, otherwise compile code the
6271same as @samp{-msdata=sysv}.
6272
6273@item -msdata-data
6274On System V.4 and embedded PowerPC systems, put small global and static
6275data in the @samp{.sdata} section. Put small uninitialized global and
6276static data in the @samp{.sbss} section. Do not use register @code{r13}
6277to address small data however. This is the default behavior unless
6278other @samp{-msdata} options are used.
6279
6280@item -msdata=none
6281@itemx -mno-sdata
6282On embedded PowerPC systems, put all initialized global and static data
6283in the @samp{.data} section, and all uninitialized data in the
6284@samp{.bss} section.
6285
6286@item -G @var{num}
6287@cindex smaller data references (PowerPC)
6288@cindex .sdata/.sdata2 references (PowerPC)
956d6950 6289On embedded PowerPC systems, put global and static items less than or
74291a4b
MM
6290equal to @var{num} bytes into the small data or bss sections instead of
6291the normal data or bss section. By default, @var{num} is 8. The
6292@samp{-G @var{num}} switch is also passed to the linker.
6293All modules should be compiled with the same @samp{-G @var{num}} value.
6294
6295@item -mregnames
6296@itemx -mno-regnames
6297On System V.4 and embedded PowerPC systems do (do not) emit register
6298names in the assembly language output using symbolic forms.
f5a1b0d2 6299
74291a4b 6300@end table
f5a1b0d2 6301
74291a4b
MM
6302@node RT Options
6303@subsection IBM RT Options
6304@cindex RT options
6305@cindex IBM RT options
6306
6307These @samp{-m} options are defined for the IBM RT PC:
6308
2642624b 6309@table @gcctabopt
74291a4b
MM
6310@item -min-line-mul
6311Use an in-line code sequence for integer multiplies. This is the
6312default.
6313
6314@item -mcall-lib-mul
6315Call @code{lmul$$} for integer multiples.
6316
6317@item -mfull-fp-blocks
6318Generate full-size floating point data blocks, including the minimum
6319amount of scratch space recommended by IBM. This is the default.
6320
6321@item -mminimum-fp-blocks
6322Do not include extra scratch space in floating point data blocks. This
6323results in smaller code, but slower execution, since scratch space must
6324be allocated dynamically.
6325
6326@cindex @file{varargs.h} and RT PC
6327@cindex @file{stdarg.h} and RT PC
6328@item -mfp-arg-in-fpregs
6329Use a calling sequence incompatible with the IBM calling convention in
6330which floating point arguments are passed in floating point registers.
6331Note that @code{varargs.h} and @code{stdargs.h} will not work with
6332floating point operands if this option is specified.
6333
6334@item -mfp-arg-in-gregs
6335Use the normal calling convention for floating point arguments. This is
6336the default.
6337
6338@item -mhc-struct-return
6339Return structures of more than one word in memory, rather than in a
6340register. This provides compatibility with the MetaWare HighC (hc)
6341compiler. Use the option @samp{-fpcc-struct-return} for compatibility
6342with the Portable C Compiler (pcc).
6343
6344@item -mnohc-struct-return
6345Return some structures of more than one word in registers, when
6346convenient. This is the default. For compatibility with the
6347IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
6348option @samp{-mhc-struct-return}.
6349@end table
6350
6351@node MIPS Options
6352@subsection MIPS Options
6353@cindex MIPS options
6354
6355These @samp{-m} options are defined for the MIPS family of computers:
6356
2642624b 6357@table @gcctabopt
74291a4b
MM
6358@item -mcpu=@var{cpu type}
6359Assume the defaults for the machine type @var{cpu type} when scheduling
6360instructions. The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
8b9243df
JJ
6361@samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6362@samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6363and @samp{orion}. Additionally, the @samp{r2000}, @samp{r3000},
6364@samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6365@samp{r2k} (or @samp{r2K}), @samp{r3k}, etc. While picking a specific
6366@var{cpu type} will schedule things appropriately for that particular
6367chip, the compiler will not generate any code that does not meet level 1
6368of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
6369or @samp{-mabi} switch being used.
74291a4b
MM
6370
6371@item -mips1
6372Issue instructions from level 1 of the MIPS ISA. This is the default.
6373@samp{r3000} is the default @var{cpu type} at this ISA level.
6374
6375@item -mips2
6376Issue instructions from level 2 of the MIPS ISA (branch likely, square
6377root instructions). @samp{r6000} is the default @var{cpu type} at this
6378ISA level.
6379
6380@item -mips3
6381Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
6382@samp{r4000} is the default @var{cpu type} at this ISA level.
74291a4b 6383
3398f47f 6384@item -mips4
8b9243df
JJ
6385Issue instructions from level 4 of the MIPS ISA (conditional move,
6386prefetch, enhanced FPU instructions). @samp{r8000} is the default
6387@var{cpu type} at this ISA level.
3398f47f 6388
74291a4b
MM
6389@item -mfp32
6390Assume that 32 32-bit floating point registers are available. This is
6391the default.
6392
6393@item -mfp64
6394Assume that 32 64-bit floating point registers are available. This is
6395the default when the @samp{-mips3} option is used.
6396
6397@item -mgp32
6398Assume that 32 32-bit general purpose registers are available. This is
6399the default.
6400
6401@item -mgp64
6402Assume that 32 64-bit general purpose registers are available. This is
6403the default when the @samp{-mips3} option is used.
6404
6405@item -mint64
3ce1ba83
GRK
6406Force int and long types to be 64 bits wide. See @samp{-mlong32} for an
6407explanation of the default, and the width of pointers.
74291a4b
MM
6408
6409@item -mlong64
3ce1ba83
GRK
6410Force long types to be 64 bits wide. See @samp{-mlong32} for an
6411explanation of the default, and the width of pointers.
fb1bf66d 6412
3ce1ba83
GRK
6413@item -mlong32
6414Force long, int, and pointer types to be 32 bits wide.
6415
6416If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
b192711e 6417the size of ints, longs, and pointers depends on the ABI and ISA chosen.
3ce1ba83
GRK
6418For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
6419wide. For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6420For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
6421and longs are 32 bits wide. For @samp{-mabi=eabi} and higher ISAs, ints
6422are 32 bits, and longs are 64 bits wide. The width of pointer types is
6423the smaller of the width of longs or the width of general purpose
6424registers (which in turn depends on the ISA).
74291a4b 6425
62a1403d 6426@item -mabi=32
8b9243df 6427@itemx -mabi=o64
3398f47f
MM
6428@itemx -mabi=n32
6429@itemx -mabi=64
6430@itemx -mabi=eabi
8b9243df
JJ
6431Generate code for the indicated ABI. The default instruction level is
6432@samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
6433@samp{-mips4} otherwise. Conversely, with @samp{-mips1} or
6434@samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
6435is @samp{64}.
3398f47f 6436
74291a4b
MM
6437@item -mmips-as
6438Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
6439add normal debug information. This is the default for all
6440platforms except for the OSF/1 reference platform, using the OSF/rose
6441object format. If the either of the @samp{-gstabs} or @samp{-gstabs+}
6442switches are used, the @file{mips-tfile} program will encapsulate the
6443stabs within MIPS ECOFF.
6444
6445@item -mgas
6446Generate code for the GNU assembler. This is the default on the OSF/1
861bb6c1
JL
6447reference platform, using the OSF/rose object format. Also, this is
6448the default if the configure option @samp{--with-gnu-as} is used.
6449
6450@item -msplit-addresses
6451@itemx -mno-split-addresses
6452Generate code to load the high and low parts of address constants separately.
6453This allows @code{gcc} to optimize away redundant loads of the high order
6454bits of addresses. This optimization requires GNU as and GNU ld.
6455This optimization is enabled by default for some embedded targets where
6456GNU as and GNU ld are standard.
74291a4b
MM
6457
6458@item -mrnames
6459@itemx -mno-rnames
6460The @samp{-mrnames} switch says to output code using the MIPS software
6461names for the registers, instead of the hardware names (ie, @var{a0}
6462instead of @var{$4}). The only known assembler that supports this option
6463is the Algorithmics assembler.
6464
6465@item -mgpopt
6466@itemx -mno-gpopt
6467The @samp{-mgpopt} switch says to write all of the data declarations
6468before the instructions in the text section, this allows the MIPS
6469assembler to generate one word memory references instead of using two
6470words for short global or static data items. This is on by default if
6471optimization is selected.
6472
6473@item -mstats
6474@itemx -mno-stats
6475For each non-inline function processed, the @samp{-mstats} switch
6476causes the compiler to emit one line to the standard error file to
6477print statistics about the program (number of registers saved, stack
6478size, etc.).
6479
6480@item -mmemcpy
6481@itemx -mno-memcpy
6482The @samp{-mmemcpy} switch makes all block moves call the appropriate
6483string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
6484generating inline code.
6485
6486@item -mmips-tfile
6487@itemx -mno-mips-tfile
6488The @samp{-mno-mips-tfile} switch causes the compiler not
6489postprocess the object file with the @file{mips-tfile} program,
6490after the MIPS assembler has generated it to add debug support. If
6491@file{mips-tfile} is not run, then no local variables will be
6492available to the debugger. In addition, @file{stage2} and
6493@file{stage3} objects will have the temporary file names passed to the
6494assembler embedded in the object file, which means the objects will
6495not compare the same. The @samp{-mno-mips-tfile} switch should only
6496be used when there are bugs in the @file{mips-tfile} program that
6497prevents compilation.
6498
6499@item -msoft-float
6500Generate output containing library calls for floating point.
0c2d1a2a 6501@strong{Warning:} the requisite libraries are not part of GCC.
74291a4b
MM
6502Normally the facilities of the machine's usual C compiler are used, but
6503this can't be done directly in cross-compilation. You must make your
6504own arrangements to provide suitable library functions for
6505cross-compilation.
6506
6507@item -mhard-float
6508Generate output containing floating point instructions. This is the
6509default if you use the unmodified sources.
6510
6511@item -mabicalls
6512@itemx -mno-abicalls
6513Emit (or do not emit) the pseudo operations @samp{.abicalls},
6514@samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
6515position independent code.
6516
6517@item -mlong-calls
6518@itemx -mno-long-calls
6519Do all calls with the @samp{JALR} instruction, which requires
6520loading up a function's address into a register before the call.
6521You need to use this switch, if you call outside of the current
6522512 megabyte segment to functions that are not through pointers.
6523
6524@item -mhalf-pic
6525@itemx -mno-half-pic
6526Put pointers to extern references into the data section and load them
6527up, rather than put the references in the text section.
6528
6529@item -membedded-pic
6530@itemx -mno-embedded-pic
69fa83cf
JW
6531Generate PIC code suitable for some embedded systems. All calls are
6532made using PC relative address, and all data is addressed using the $gp
6533register. No more than 65536 bytes of global data may be used. This
6534requires GNU as and GNU ld which do most of the work. This currently
6535only works on targets which use ECOFF; it does not work with ELF.
74291a4b
MM
6536
6537@item -membedded-data
6538@itemx -mno-embedded-data
6539Allocate variables to the read-only data section first if possible, then
6540next in the small data section if possible, otherwise in data. This gives
6541slightly slower code than the default, but reduces the amount of RAM required
6542when executing, and thus may be preferred for some embedded systems.
6543
919509ce
DN
6544@item -muninit-const-in-rodata
6545@itemx -mno-uninit-const-in-rodata
6546When used together with -membedded-data, it will always store uninitialized
6547const variables in the read-only data section.
6548
74291a4b
MM
6549@item -msingle-float
6550@itemx -mdouble-float
6551The @samp{-msingle-float} switch tells gcc to assume that the floating
6552point coprocessor only supports single precision operations, as on the
6553@samp{r4650} chip. The @samp{-mdouble-float} switch permits gcc to use
6554double precision operations. This is the default.
6555
6556@item -mmad
6557@itemx -mno-mad
6558Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6559as on the @samp{r4650} chip.
6560
6561@item -m4650
6562Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6563@samp{-mcpu=r4650}.
6564
8b9243df
JJ
6565@item -mips16
6566@itemx -mno-mips16
6567Enable 16-bit instructions.
6568
6569@item -mentry
6570Use the entry and exit pseudo ops. This option can only be used with
6571@samp{-mips16}.
6572
74291a4b
MM
6573@item -EL
6574Compile code for the processor in little endian mode.
6575The requisite libraries are assumed to exist.
6576
6577@item -EB
6578Compile code for the processor in big endian mode.
6579The requisite libraries are assumed to exist.
6580
6581@item -G @var{num}
6582@cindex smaller data references (MIPS)
6583@cindex gp-relative references (MIPS)
6584Put global and static items less than or equal to @var{num} bytes into
6585the small data or bss sections instead of the normal data or bss
6586section. This allows the assembler to emit one word memory reference
6587instructions based on the global pointer (@var{gp} or @var{$28}),
6588instead of the normal two words used. By default, @var{num} is 8 when
6589the MIPS assembler is used, and 0 when the GNU assembler is used. The
6590@samp{-G @var{num}} switch is also passed to the assembler and linker.
6591All modules should be compiled with the same @samp{-G @var{num}}
6592value.
6593
6594@item -nocpp
9ec36da5 6595Tell the MIPS assembler to not run its preprocessor over user
74291a4b 6596assembler files (with a @samp{.s} suffix) when assembling them.
63357d93 6597
1e387156
CM
6598@item -mfix7000
6599Pass an option to gas which will cause nops to be inserted if
6600the read of the destination register of an mfhi or mflo instruction
6601occurs in the following two instructions.
6602
63357d93
GRK
6603@item -no-crt0
6604Do not include the default crt0.
74291a4b
MM
6605@end table
6606
6607@ifset INTERNALS
6608These options are defined by the macro
6609@code{TARGET_SWITCHES} in the machine description. The default for the
6610options is also defined by that macro, which enables you to change the
6611defaults.
6612@end ifset
6613
6614@node i386 Options
6615@subsection Intel 386 Options
6616@cindex i386 Options
6617@cindex Intel 386 Options
6618
6619These @samp{-m} options are defined for the i386 family of computers:
6620
2642624b 6621@table @gcctabopt
a9f3e1a4
JL
6622@item -mcpu=@var{cpu type}
6623Assume the defaults for the machine type @var{cpu type} when scheduling
9d86bffc
JM
6624instructions. The choices for @var{cpu type} are @samp{i386},
6625@samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
b4e89e2d 6626@samp{pentiumpro}, @samp{pentium4}, @samp{k6}, and @samp{athlon}
6f670fde
RH
6627
6628While picking a specific @var{cpu type} will schedule things appropriately
6629for that particular chip, the compiler will not generate any code that
6630does not run on the i386 without the @samp{-march=@var{cpu type}} option
7001ee2d 6631being used. @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6ca3ad1b 6632is equivalent to @samp{pentiumpro}. @samp{k6} and @samp{athlon} are the
b4e89e2d 6633AMD chips as opposed to the Intel ones.
a9f3e1a4
JL
6634
6635@item -march=@var{cpu type}
6636Generate instructions for the machine type @var{cpu type}. The choices
6f670fde
RH
6637for @var{cpu type} are the same as for @samp{-mcpu}. Moreover,
6638specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
a9f3e1a4
JL
6639
6640@item -m386
6641@itemx -m486
6642@itemx -mpentium
6643@itemx -mpentiumpro
6644Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
7001ee2d 6645respectively. These synonyms are deprecated.
74291a4b 6646
04e149ab
KC
6647@item -mintel-syntax
6648Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6649
74291a4b
MM
6650@item -mieee-fp
6651@itemx -mno-ieee-fp
6652Control whether or not the compiler uses IEEE floating point
6653comparisons. These handle correctly the case where the result of a
6654comparison is unordered.
6655
6656@item -msoft-float
6657Generate output containing library calls for floating point.
0c2d1a2a 6658@strong{Warning:} the requisite libraries are not part of GCC.
74291a4b
MM
6659Normally the facilities of the machine's usual C compiler are used, but
6660this can't be done directly in cross-compilation. You must make your
6661own arrangements to provide suitable library functions for
6662cross-compilation.
6663
6664On machines where a function returns floating point results in the 80387
6665register stack, some floating point opcodes may be emitted even if
6666@samp{-msoft-float} is used.
6667
6668@item -mno-fp-ret-in-387
6669Do not use the FPU registers for return values of functions.
6670
6671The usual calling convention has functions return values of types
6672@code{float} and @code{double} in an FPU register, even if there
6673is no FPU. The idea is that the operating system should emulate
6674an FPU.
6675
6676The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6677in ordinary CPU registers instead.
6678
6679@item -mno-fancy-math-387
6680Some 387 emulators do not support the @code{sin}, @code{cos} and
6681@code{sqrt} instructions for the 387. Specify this option to avoid
6682generating those instructions. This option is the default on FreeBSD.
6683As of revision 2.6.1, these instructions are not generated unless you
de6c5979 6684also use the @samp{-funsafe-math-optimizations} switch.
74291a4b
MM
6685
6686@item -malign-double
6687@itemx -mno-align-double
0c2d1a2a 6688Control whether GCC aligns @code{double}, @code{long double}, and
74291a4b
MM
6689@code{long long} variables on a two word boundary or a one word
6690boundary. Aligning @code{double} variables on a two word boundary will
6691produce code that runs somewhat faster on a @samp{Pentium} at the
6692expense of more memory.
6693
2b589241
JH
6694@item -m128bit-long-double
6695@itemx -m128bit-long-double
6696Control the size of @code{long double} type. i386 application binary interface
6697specify the size to be 12 bytes, while modern architectures (Pentium and newer)
6698preffer @code{long double} aligned to 8 or 16 byte boundary. This is
6699impossible to reach with 12 byte long doubles in the array accesses.
6700
6701@strong{Warning:} if you use the @samp{-m128bit-long-double} switch, the
6702structures and arrays containing @code{long double} will change their size as
6703well as function calling convention for function taking @code{long double}
6704will be modified.
6705
6706@item -m96bit-long-double
6707@itemx -m96bit-long-double
0a75e5c3 6708Set the size of @code{long double} to 96 bits as required by the i386
2b589241 6709application binary interface. This is the default.
74291a4b
MM
6710
6711@item -msvr3-shlib
6712@itemx -mno-svr3-shlib
0c2d1a2a 6713Control whether GCC places uninitialized locals into @code{bss} or
74291a4b
MM
6714@code{data}. @samp{-msvr3-shlib} places these locals into @code{bss}.
6715These options are meaningful only on System V Release 3.
6716
6717@item -mno-wide-multiply
6718@itemx -mwide-multiply
0c2d1a2a 6719Control whether GCC uses the @code{mul} and @code{imul} that produce
74291a4b
MM
672064 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6721long} multiplies and 32-bit division by constants.
6722
6723@item -mrtd
6724Use a different function-calling convention, in which functions that
6725take a fixed number of arguments return with the @code{ret} @var{num}
6726instruction, which pops their arguments while returning. This saves one
6727instruction in the caller since there is no need to pop the arguments
6728there.
6729
6730You can specify that an individual function is called with this calling
6731sequence with the function attribute @samp{stdcall}. You can also
6732override the @samp{-mrtd} option by using the function attribute
0b433de6 6733@samp{cdecl}. @xref{Function Attributes}.
74291a4b
MM
6734
6735@strong{Warning:} this calling convention is incompatible with the one
6736normally used on Unix, so you cannot use it if you need to call
6737libraries compiled with the Unix compiler.
6738
6739Also, you must provide function prototypes for all functions that
6740take variable numbers of arguments (including @code{printf});
6741otherwise incorrect code will be generated for calls to those
6742functions.
6743
6744In addition, seriously incorrect code will result if you call a
6745function with too many arguments. (Normally, extra arguments are
6746harmlessly ignored.)
6747
74291a4b
MM
6748@item -mregparm=@var{num}
6749Control how many registers are used to pass integer arguments. By
6750default, no registers are used to pass arguments, and at most 3
6751registers can be used. You can control this behavior for a specific
0b433de6
JL
6752function by using the function attribute @samp{regparm}.
6753@xref{Function Attributes}.
74291a4b
MM
6754
6755@strong{Warning:} if you use this switch, and
6756@var{num} is nonzero, then you must build all modules with the same
6757value, including any libraries. This includes the system libraries and
6758startup modules.
6759
6760@item -malign-loops=@var{num}
6761Align loops to a 2 raised to a @var{num} byte boundary. If
9e423e6d
JW
6762@samp{-malign-loops} is not specified, the default is 2 unless
6763gas 2.8 (or later) is being used in which case the default is
6764to align the loop on a 16 byte boundary if it is less than 8
6765bytes away.
74291a4b
MM
6766
6767@item -malign-jumps=@var{num}
6768Align instructions that are only jumped to to a 2 raised to a @var{num}
6769byte boundary. If @samp{-malign-jumps} is not specified, the default is
9e423e6d
JW
67702 if optimizing for a 386, and 4 if optimizing for a 486 unless
6771gas 2.8 (or later) is being used in which case the default is
6772to align the instruction on a 16 byte boundary if it is less
6773than 8 bytes away.
74291a4b
MM
6774
6775@item -malign-functions=@var{num}
6776Align the start of functions to a 2 raised to @var{num} byte boundary.
6d4312dd 6777If @samp{-malign-functions} is not specified, the default is 2 if optimizing
74291a4b 6778for a 386, and 4 if optimizing for a 486.
74291a4b 6779
3af4bd89
JH
6780@item -mpreferred-stack-boundary=@var{num}
6781Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6782byte boundary. If @samp{-mpreferred-stack-boundary} is not specified,
6783the default is 4 (16 bytes or 128 bits).
6784
6785The stack is required to be aligned on a 4 byte boundary. On Pentium
6786and PentiumPro, @code{double} and @code{long double} values should be
6787aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6788significant run time performance penalties. On Pentium III, the
b192711e 6789Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
3af4bd89
JH
6790penalties if it is not 16 byte aligned.
6791
6792To ensure proper alignment of this values on the stack, the stack boundary
6793must be as aligned as that required by any value stored on the stack.
6794Further, every function must be generated such that it keeps the stack
6795aligned. Thus calling a function compiled with a higher preferred
6796stack boundary from a function compiled with a lower preferred stack
6797boundary will most likely misalign the stack. It is recommended that
6798libraries that use callbacks always use the default setting.
6799
6800This extra alignment does consume extra stack space. Code that is sensitive
6801to stack space usage, such as embedded systems and operating system kernels,
6802may want to reduce the preferred alignment to
6803@samp{-mpreferred-stack-boundary=2}.
f22a97d2 6804
f73ad30e
JH
6805@item -mpush-args
6806@kindex -mpush-args
6807Use PUSH operations to store outgoing parameters. This method is shorter
6808and usually equally fast as method using SUB/MOV operations and is enabled
6809by default. In some cases disabling it may improve performance because of
6810improved scheduling and reduced dependencies.
6811
6812@item -maccumulate-outgoing-args
6813@kindex -maccumulate-outgoing-args
6814If enabled, the maximum amount of space required for outgoing arguments will be
6815computed in the function prologue. This in faster on most modern CPUs
b192711e 6816because of reduced dependencies, improved scheduling and reduced stack usage
f73ad30e
JH
6817when preferred stack boundary is not equal to 2. The drawback is a notable
6818increase in code size. This switch implies -mno-push-args.
6819
f22a97d2
MK
6820@item -mthreads
6821@kindex -mthreads
6822Support thread-safe exception handling on @samp{Mingw32}. Code that relies
6823on thread-safe exception handling must compile and link all code with the
6824@samp{-mthreads} option. When compiling, @samp{-mthreads} defines
6825@samp{-D_MT}; when linking, it links in a special thread helper library
6826@samp{-lmingwthrd} which cleans up per thread exception handling data.
79f05c19
JH
6827
6828@item -mno-align-stringops
6829@kindex -mno-align-stringops
6830Do not align destination of inlined string operations. This switch reduces
6831code size and improves performance in case the destination is already aligned,
6832but gcc don't know about it.
6833
6834@item -minline-all-stringops
6835@kindex -minline-all-stringops
6836By default GCC inlines string operations only when destination is known to be
6837aligned at least to 4 byte boundary. This enables more inlining, increase code
6838size, but may improve performance of code that depends on fast memcpy, strlen
6839and memset for short lengths.
3af4bd89
JH
6840@end table
6841
74291a4b
MM
6842@node HPPA Options
6843@subsection HPPA Options
6844@cindex HPPA Options
6845
6846These @samp{-m} options are defined for the HPPA family of computers:
6847
2642624b 6848@table @gcctabopt
ea3bfbfe
JQ
6849@item -march=@var{architecture type}
6850Generate code for the specified architecture. The choices for
6851@var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
68521.1, and @samp{2.0} for PA 2.0 processors. Refer to
6853@file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6854architecture option for your machine. Code compiled for lower numbered
6855architectures will run on higher numbered architectures, but not the
6856other way around.
6857
6858PA 2.0 support currently requires gas snapshot 19990413 or later. The
6859next release of binutils (current is 2.9.1) will probably contain PA 2.0
6860support.
74291a4b 6861
ea3bfbfe 6862@item -mpa-risc-1-0
62a1403d
AS
6863@itemx -mpa-risc-1-1
6864@itemx -mpa-risc-2-0
ea3bfbfe 6865Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
74291a4b 6866
861bb6c1
JL
6867@item -mbig-switch
6868Generate code suitable for big switch tables. Use this option only if
6869the assembler/linker complain about out of range branches within a switch
6870table.
6871
74291a4b
MM
6872@item -mjump-in-delay
6873Fill delay slots of function calls with unconditional jump instructions
6874by modifying the return pointer for the function call to be the target
6875of the conditional jump.
6876
6877@item -mdisable-fpregs
6878Prevent floating point registers from being used in any manner. This is
6879necessary for compiling kernels which perform lazy context switching of
6880floating point registers. If you use this option and attempt to perform
6881floating point operations, the compiler will abort.
6882
6883@item -mdisable-indexing
6884Prevent the compiler from using indexing address modes. This avoids some
6885rather obscure problems when compiling MIG generated code under MACH.
6886
6887@item -mno-space-regs
6888Generate code that assumes the target has no space registers. This allows
6889GCC to generate faster indirect calls and use unscaled index address modes.
6890
6891Such code is suitable for level 0 PA systems and kernels.
6892
6893@item -mfast-indirect-calls
6894Generate code that assumes calls never cross space boundaries. This
6895allows GCC to emit code which performs faster indirect calls.
6896
b192711e 6897This option will not work in the presence of shared libraries or nested
74291a4b
MM
6898functions.
6899
74291a4b
MM
6900@item -mlong-load-store
6901Generate 3-instruction load and store sequences as sometimes required by
6902the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
6903the HP compilers.
6904
6905@item -mportable-runtime
6906Use the portable calling conventions proposed by HP for ELF systems.
6907
6908@item -mgas
6909Enable the use of assembler directives only GAS understands.
6910
6911@item -mschedule=@var{cpu type}
6912Schedule code according to the constraints for the machine type
732135bf 6913@var{cpu type}. The choices for @var{cpu type} are @samp{700}
e14b50ce 6914@samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}. Refer to
732135bf
JL
6915@file{/usr/lib/sched.models} on an HP-UX system to determine the
6916proper scheduling option for your machine.
74291a4b
MM
6917
6918@item -mlinker-opt
6919Enable the optimization pass in the HPUX linker. Note this makes symbolic
6920debugging impossible. It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6921in which they give bogus error messages when linking some programs.
6922
6923@item -msoft-float
6924Generate output containing library calls for floating point.
6925@strong{Warning:} the requisite libraries are not available for all HPPA
6926targets. Normally the facilities of the machine's usual C compiler are
6927used, but this cannot be done directly in cross-compilation. You must make
6928your own arrangements to provide suitable library functions for
6929cross-compilation. The embedded target @samp{hppa1.1-*-pro}
6930does provide software floating point support.
6931
6932@samp{-msoft-float} changes the calling convention in the output file;
6933therefore, it is only useful if you compile @emph{all} of a program with
6934this option. In particular, you need to compile @file{libgcc.a}, the
0c2d1a2a 6935library that comes with GCC, with @samp{-msoft-float} in order for
74291a4b
MM
6936this to work.
6937@end table
6938
6939@node Intel 960 Options
6940@subsection Intel 960 Options
6941
6942These @samp{-m} options are defined for the Intel 960 implementations:
6943
2642624b 6944@table @gcctabopt
74291a4b
MM
6945@item -m@var{cpu type}
6946Assume the defaults for the machine type @var{cpu type} for some of
6947the other options, including instruction scheduling, floating point
6948support, and addressing modes. The choices for @var{cpu type} are
6949@samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6950@samp{sa}, and @samp{sb}.
6951The default is
6952@samp{kb}.
6953
6954@item -mnumerics
6955@itemx -msoft-float
6956The @samp{-mnumerics} option indicates that the processor does support
6957floating-point instructions. The @samp{-msoft-float} option indicates
6958that floating-point support should not be assumed.
6959
6960@item -mleaf-procedures
6961@itemx -mno-leaf-procedures
6962Do (or do not) attempt to alter leaf procedures to be callable with the
6963@code{bal} instruction as well as @code{call}. This will result in more
6964efficient code for explicit calls when the @code{bal} instruction can be
6965substituted by the assembler or linker, but less efficient code in other
6966cases, such as calls via function pointers, or using a linker that doesn't
6967support this optimization.
6968
6969@item -mtail-call
6970@itemx -mno-tail-call
6971Do (or do not) make additional attempts (beyond those of the
6972machine-independent portions of the compiler) to optimize tail-recursive
6973calls into branches. You may not want to do this because the detection of
6974cases where this is not valid is not totally complete. The default is
6975@samp{-mno-tail-call}.
6976
6977@item -mcomplex-addr
6978@itemx -mno-complex-addr
6979Assume (or do not assume) that the use of a complex addressing mode is a
6980win on this implementation of the i960. Complex addressing modes may not
6981be worthwhile on the K-series, but they definitely are on the C-series.
6982The default is currently @samp{-mcomplex-addr} for all processors except
6983the CB and CC.
6984
6985@item -mcode-align
6986@itemx -mno-code-align
6987Align code to 8-byte boundaries for faster fetching (or don't bother).
6988Currently turned on by default for C-series implementations only.
6989
6990@ignore
6991@item -mclean-linkage
6992@itemx -mno-clean-linkage
6993These options are not fully implemented.
6994@end ignore
6995
6996@item -mic-compat
6997@itemx -mic2.0-compat
6998@itemx -mic3.0-compat
6999Enable compatibility with iC960 v2.0 or v3.0.
7000
7001@item -masm-compat
7002@itemx -mintel-asm
7003Enable compatibility with the iC960 assembler.
7004
7005@item -mstrict-align
7006@itemx -mno-strict-align
7007Do not permit (do permit) unaligned accesses.
7008
7009@item -mold-align
7010Enable structure-alignment compatibility with Intel's gcc release version
861bb6c1 70111.3 (based on gcc 1.37). This option implies @samp{-mstrict-align}.
eaa4b44c
VM
7012
7013@item -mlong-double-64
7014Implement type @samp{long double} as 64-bit floating point numbers.
7015Without the option @samp{long double} is implemented by 80-bit
7016floating point numbers. The only reason we have it because there is
7017no 128-bit @samp{long double} support in @samp{fp-bit.c} yet. So it
7018is only useful for people using soft-float targets. Otherwise, we
7019should recommend against use of it.
7020
74291a4b
MM
7021@end table
7022
7023@node DEC Alpha Options
7024@subsection DEC Alpha Options
7025
7026These @samp{-m} options are defined for the DEC Alpha implementations:
7027
2642624b 7028@table @gcctabopt
74291a4b
MM
7029@item -mno-soft-float
7030@itemx -msoft-float
7031Use (do not use) the hardware floating-point instructions for
bedc7537 7032floating-point operations. When @option{-msoft-float} is specified,
74291a4b
MM
7033functions in @file{libgcc1.c} will be used to perform floating-point
7034operations. Unless they are replaced by routines that emulate the
7035floating-point operations, or compiled in such a way as to call such
7036emulations routines, these routines will issue floating-point
7037operations. If you are compiling for an Alpha without floating-point
7038operations, you must ensure that the library is built so as not to call
7039them.
7040
7041Note that Alpha implementations without floating-point operations are
7042required to have floating-point registers.
7043
7044@item -mfp-reg
7045@itemx -mno-fp-regs
7046Generate code that uses (does not use) the floating-point register set.
bedc7537 7047@option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
74291a4b
MM
7048register set is not used, floating point operands are passed in integer
7049registers as if they were integers and floating-point results are passed
7050in $0 instead of $f0. This is a non-standard calling sequence, so any
7051function with a floating-point argument or return value called by code
bedc7537 7052compiled with @option{-mno-fp-regs} must also be compiled with that
74291a4b
MM
7053option.
7054
7055A typical use of this option is building a kernel that does not use,
7056and hence need not save and restore, any floating-point registers.
7057
7058@item -mieee
7059The Alpha architecture implements floating-point hardware optimized for
7060maximum performance. It is mostly compliant with the IEEE floating
7061point standard. However, for full compliance, software assistance is
7062required. This option generates code fully IEEE compliant code
7063@emph{except} that the @var{inexact flag} is not maintained (see below).
7064If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
7065during compilation. The option is a shorthand for: @samp{-D_IEEE_FP
7066-mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}. The resulting
7067code is less efficient but is able to correctly support denormalized
7068numbers and exceptional IEEE values such as not-a-number and plus/minus
7069infinity. Other Alpha compilers call this option
bedc7537 7070@option{-ieee_with_no_inexact}.
74291a4b
MM
7071
7072@item -mieee-with-inexact
7073@c overfull hbox here --bob 22 jul96
7074@c original text between ignore ... end ignore
7075@ignore
7076This is like @samp{-mieee} except the generated code also maintains the
7077IEEE @var{inexact flag}. Turning on this option causes the generated
7078code to implement fully-compliant IEEE math. The option is a shorthand
7079for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
7080@samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}. On some Alpha
7081implementations the resulting code may execute significantly slower than
7082the code generated by default. Since there is very little code that
7083depends on the @var{inexact flag}, you should normally not specify this
7084option. Other Alpha compilers call this option
7085@samp{-ieee_with_inexact}.
7086@end ignore
7087@c changed paragraph
7088This is like @samp{-mieee} except the generated code also maintains the
7089IEEE @var{inexact flag}. Turning on this option causes the generated
7090code to implement fully-compliant IEEE math. The option is a shorthand
7091for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
7092@samp{-mieee-conformant},
7093@samp{-mfp-trap-mode=sui},
7094and @samp{-mtrap-precision=i}.
7095On some Alpha implementations the resulting code may execute
7096significantly slower than the code generated by default. Since there
7097is very little code that depends on the @var{inexact flag}, you should
7098normally not specify this option. Other Alpha compilers call this
7099option @samp{-ieee_with_inexact}.
7100@c end changes to prevent overfull hboxes
7101
7102@item -mfp-trap-mode=@var{trap mode}
7103This option controls what floating-point related traps are enabled.
7104Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
7105The trap mode can be set to one of four values:
7106
7107@table @samp
7108@item n
7109This is the default (normal) setting. The only traps that are enabled
7110are the ones that cannot be disabled in software (e.g., division by zero
7111trap).
7112
7113@item u
7114In addition to the traps enabled by @samp{n}, underflow traps are enabled
7115as well.
7116
7117@item su
7118Like @samp{su}, but the instructions are marked to be safe for software
7119completion (see Alpha architecture manual for details).
7120
7121@item sui
7122Like @samp{su}, but inexact traps are enabled as well.
7123@end table
7124
7125@item -mfp-rounding-mode=@var{rounding mode}
7126Selects the IEEE rounding mode. Other Alpha compilers call this option
7127@samp{-fprm }@var{rounding mode}. The @var{rounding mode} can be one
7128of:
7129
7130@table @samp
7131@item n
7132Normal IEEE rounding mode. Floating point numbers are rounded towards
7133the nearest machine number or towards the even machine number in case
7134of a tie.
7135
7136@item m
7137Round towards minus infinity.
7138
7139@item c
7140Chopped rounding mode. Floating point numbers are rounded towards zero.
7141
7142@item d
7143Dynamic rounding mode. A field in the floating point control register
7144(@var{fpcr}, see Alpha architecture reference manual) controls the
7145rounding mode in effect. The C library initializes this register for
7146rounding towards plus infinity. Thus, unless your program modifies the
ec4b2ecb
CB
7147@var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7148@end table
74291a4b
MM
7149
7150@item -mtrap-precision=@var{trap precision}
7151In the Alpha architecture, floating point traps are imprecise. This
7152means without software assistance it is impossible to recover from a
7153floating trap and program execution normally needs to be terminated.
0c2d1a2a 7154GCC can generate code that can assist operating system trap handlers
74291a4b
MM
7155in determining the exact location that caused a floating point trap.
7156Depending on the requirements of an application, different levels of
7157precisions can be selected:
7158
7159@table @samp
7160@item p
7161Program precision. This option is the default and means a trap handler
7162can only identify which program caused a floating point exception.
7163
7164@item f
7165Function precision. The trap handler can determine the function that
7166caused a floating point exception.
7167
7168@item i
7169Instruction precision. The trap handler can determine the exact
7170instruction that caused a floating point exception.
7171@end table
7172
7173Other Alpha compilers provide the equivalent options called
7174@samp{-scope_safe} and @samp{-resumption_safe}.
7175
7176@item -mieee-conformant
7177This option marks the generated code as IEEE conformant. You must not
7178use this option unless you also specify @samp{-mtrap-precision=i} and either
7179@samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}. Its only effect
7180is to emit the line @samp{.eflag 48} in the function prologue of the
7181generated assembly file. Under DEC Unix, this has the effect that
7182IEEE-conformant math library routines will be linked in.
7183
7184@item -mbuild-constants
0c2d1a2a 7185Normally GCC examines a 32- or 64-bit integer constant to
74291a4b
MM
7186see if it can construct it from smaller constants in two or three
7187instructions. If it cannot, it will output the constant as a literal and
956d6950 7188generate code to load it from the data segment at runtime.
74291a4b 7189
0c2d1a2a 7190Use this option to require GCC to construct @emph{all} integer constants
74291a4b
MM
7191using code, even if it takes more instructions (the maximum is six).
7192
7193You would typically use this option to build a shared library dynamic
7194loader. Itself a shared library, it must relocate itself in memory
7195before it can find the variables and constants in its own data segment.
956d6950
JL
7196
7197@item -malpha-as
7198@itemx -mgas
7199Select whether to generate code to be assembled by the vendor-supplied
7200assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
7201
7202@item -mbwx
7203@itemx -mno-bwx
7204@itemx -mcix
7205@itemx -mno-cix
7206@itemx -mmax
7207@itemx -mno-max
0c2d1a2a 7208Indicate whether GCC should generate code to use the optional BWX,
956d6950
JL
7209CIX, and MAX instruction sets. The default is to use the instruction sets
7210supported by the CPU type specified via @samp{-mcpu=} option or that
0c2d1a2a 7211of the CPU on which GCC was built if none was specified.
956d6950 7212
956d6950
JL
7213@item -mcpu=@var{cpu_type}
7214Set the instruction set, register set, and instruction scheduling
7215parameters for machine type @var{cpu_type}. You can specify either the
0c2d1a2a 7216@samp{EV} style name or the corresponding chip number. GCC
956d6950
JL
7217supports scheduling parameters for the EV4 and EV5 family of processors
7218and will choose the default values for the instruction set from
7219the processor you specify. If you do not specify a processor type,
0c2d1a2a 7220GCC will default to the processor on which the compiler was built.
956d6950
JL
7221
7222Supported values for @var{cpu_type} are
7223
7224@table @samp
7225@item ev4
7226@itemx 21064
7227Schedules as an EV4 and has no instruction set extensions.
7228
7229@item ev5
7230@itemx 21164
7231Schedules as an EV5 and has no instruction set extensions.
7232
7233@item ev56
7234@itemx 21164a
7235Schedules as an EV5 and supports the BWX extension.
7236
7237@item pca56
4f69985c 7238@itemx 21164pc
956d6950
JL
7239@itemx 21164PC
7240Schedules as an EV5 and supports the BWX and MAX extensions.
7241
7242@item ev6
7243@itemx 21264
7244Schedules as an EV5 (until Digital releases the scheduling parameters
7245for the EV6) and supports the BWX, CIX, and MAX extensions.
4f69985c
RH
7246@end table
7247
7248@item -mmemory-latency=@var{time}
7249Sets the latency the scheduler should assume for typical memory
7250references as seen by the application. This number is highly
b192711e 7251dependent on the memory access patterns used by the application
4f69985c
RH
7252and the size of the external cache on the machine.
7253
7254Valid options for @var{time} are
7255
7256@table @samp
7257@item @var{number}
7258A decimal number representing clock cycles.
7259
7260@item L1
7261@itemx L2
7262@itemx L3
7263@itemx main
7264The compiler contains estimates of the number of clock cycles for
7265``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7266(also called Dcache, Scache, and Bcache), as well as to main memory.
7267Note that L3 is only valid for EV5.
7268
956d6950 7269@end table
74291a4b
MM
7270@end table
7271
7272@node Clipper Options
7273@subsection Clipper Options
7274
7275These @samp{-m} options are defined for the Clipper implementations:
7276
2642624b 7277@table @gcctabopt
74291a4b
MM
7278@item -mc300
7279Produce code for a C300 Clipper processor. This is the default.
7280
62a1403d 7281@item -mc400
74291a4b
MM
7282Produce code for a C400 Clipper processor i.e. use floating point
7283registers f8..f15.
7284@end table
7285
7286@node H8/300 Options
7287@subsection H8/300 Options
7288
7289These @samp{-m} options are defined for the H8/300 implementations:
7290
2642624b 7291@table @gcctabopt
74291a4b
MM
7292@item -mrelax
7293Shorten some address references at link time, when possible; uses the
7294linker option @samp{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
7295ld.info, Using ld}, for a fuller description.
7296
7297@item -mh
7298Generate code for the H8/300H.
7299
dcb9d1f0
JL
7300@item -ms
7301Generate code for the H8/S.
7302
17f0f8fa
KH
7303@item -ms2600
7304Generate code for the H8/S2600. This switch must be used with -ms.
7305
74291a4b
MM
7306@item -mint32
7307Make @code{int} data 32 bits by default.
7308
7309@item -malign-300
2c54abce
KH
7310On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
7311The default for the H8/300H and H8/S is to align longs and floats on 4
7312byte boundaries.
74291a4b 7313@samp{-malign-300} causes them to be aligned on 2 byte boundaries.
2c54abce 7314This option has no effect on the H8/300.
74291a4b
MM
7315@end table
7316
7317@node SH Options
7318@subsection SH Options
7319
7320These @samp{-m} options are defined for the SH implementations:
7321
2642624b 7322@table @gcctabopt
74291a4b
MM
7323@item -m1
7324Generate code for the SH1.
7325
7326@item -m2
7327Generate code for the SH2.
7328
7329@item -m3
7330Generate code for the SH3.
7331
7332@item -m3e
7333Generate code for the SH3e.
7334
3cadd778
AO
7335@item -m4-nofpu
7336Generate code for the SH4 without a floating-point unit.
7337
7338@item -m4-single-only
7339Generate code for the SH4 with a floating-point unit that only
7340supports single-precision arithmentic.
7341
7342@item -m4-single
7343Generate code for the SH4 assuming the floating-point unit is in
7344single-precision mode by default.
7345
7346@item -m4
7347Generate code for the SH4.
7348
74291a4b
MM
7349@item -mb
7350Compile code for the processor in big endian mode.
7351
7352@item -ml
7353Compile code for the processor in little endian mode.
7354
3d5a0820
R
7355@item -mdalign
7356Align doubles at 64 bit boundaries. Note that this changes the calling
7357conventions, and thus some functions from the standard C library will
7358not work unless you recompile it first with -mdalign.
7359
74291a4b
MM
7360@item -mrelax
7361Shorten some address references at link time, when possible; uses the
7362linker option @samp{-relax}.
3cadd778
AO
7363
7364@item -mbigtable
7365Use 32-bit offsets in @code{switch} tables. The default is to use
736616-bit offsets.
7367
7368@item -mfmovd
7369Enable the use of the instruction @code{fmovd}.
7370
7371@item -mhitachi
7372Comply with the calling conventions defined by Hitachi.
7373
7374@item -mnomacsave
7375Mark the @code{MAC} register as call-clobbered, even if
bedc7537 7376@option{-mhitachi} is given.
3cadd778
AO
7377
7378@item -misize
7379Dump instruction size and location in the assembly code.
7380
7381@item -mpadstruct
7382This option is deprecated. It pads structures to multiple of 4 bytes,
7383which is incompatible with the SH ABI.
7384
7385@item -mspace
bedc7537 7386Optimize for space instead of speed. Implied by @option{-Os}.
1a66cd67
AO
7387
7388@item -mprefergot
7389When generating position-independent code, emit function calls using
7390the Global Offset Table instead of the Procedure Linkage Table.
93ca1662
NY
7391
7392@item -musermode
7393Generate a library function call to invalidate instruction cache
7394entries, after fixing up a trampoline. This library function call
7395doesn't assume it can write to the whole memory address space. This
7396is the default when the target is @code{sh-*-linux*}.
74291a4b
MM
7397@end table
7398
7399@node System V Options
7400@subsection Options for System V
7401
7402These additional options are available on System V Release 4 for
7403compatibility with other compilers on those systems:
7404
2642624b 7405@table @gcctabopt
74291a4b
MM
7406@item -G
7407Create a shared object.
7408It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
7409
7410@item -Qy
7411Identify the versions of each tool used by the compiler, in a
7412@code{.ident} assembler directive in the output.
7413
7414@item -Qn
7415Refrain from adding @code{.ident} directives to the output file (this is
7416the default).
7417
371e300b 7418@item -YP\,@var{dirs}
74291a4b
MM
7419Search the directories @var{dirs}, and no others, for libraries
7420specified with @samp{-l}.
7421
371e300b 7422@item -Ym\,@var{dir}
bedc7537 7423Look in the directory @var{dir} to find the M4 preprocessor.
74291a4b
MM
7424The assembler uses this option.
7425@c This is supposed to go with a -Yd for predefined M4 macro files, but
7426@c the generic assembler that comes with Solaris takes just -Ym.
7427@end table
7428
282a61e6
MH
7429@node TMS320C3x/C4x Options
7430@subsection TMS320C3x/C4x Options
7431@cindex TMS320C3x/C4x Options
7432
7433These @samp{-m} options are defined for TMS320C3x/C4x implementations:
7434
2642624b 7435@table @gcctabopt
282a61e6
MH
7436
7437@item -mcpu=@var{cpu_type}
7438Set the instruction set, register set, and instruction scheduling
7439parameters for machine type @var{cpu_type}. Supported values for
7440@var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
7441@samp{c44}. The default is @samp{c40} to generate code for the
7442TMS320C40.
7443
7444@item -mbig-memory
7445@item -mbig
7446@itemx -msmall-memory
7447@itemx -msmall
7448Generates code for the big or small memory model. The small memory
7449model assumed that all data fits into one 64K word page. At run-time
7450the data page (DP) register must be set to point to the 64K page
7451containing the .bss and .data program sections. The big memory model is
7452the default and requires reloading of the DP register for every direct
7453memory access.
7454
7455@item -mbk
7456@itemx -mno-bk
7457Allow (disallow) allocation of general integer operands into the block
7458count register BK.
7459
7460@item -mdb
7461@itemx -mno-db
7462Enable (disable) generation of code using decrement and branch,
7463DBcond(D), instructions. This is enabled by default for the C4x. To be
7464on the safe side, this is disabled for the C3x, since the maximum
7465iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
74662^23 times on the C3x?). Note that GCC will try to reverse a loop so
7467that it can utilise the decrement and branch instruction, but will give
7468up if there is more than one memory reference in the loop. Thus a loop
7469where the loop counter is decremented can generate slightly more
7470efficient code, in cases where the RPTB instruction cannot be utilised.
7471
7472@item -mdp-isr-reload
7473@itemx -mparanoid
7474Force the DP register to be saved on entry to an interrupt service
7475routine (ISR), reloaded to point to the data section, and restored on
7476exit from the ISR. This should not be required unless someone has
7477violated the small memory model by modifying the DP register, say within
7478an object library.
7479
7480@item -mmpyi
7481@itemx -mno-mpyi
7482For the C3x use the 24-bit MPYI instruction for integer multiplies
7483instead of a library call to guarantee 32-bit results. Note that if one
7484of the operands is a constant, then the multiplication will be performed
7485using shifts and adds. If the -mmpyi option is not specified for the C3x,
7486then squaring operations are performed inline instead of a library call.
7487
7488@item -mfast-fix
7489@itemx -mno-fast-fix
7490The C3x/C4x FIX instruction to convert a floating point value to an
7491integer value chooses the nearest integer less than or equal to the
7492floating point value rather than to the nearest integer. Thus if the
7493floating point number is negative, the result will be incorrectly
7494truncated an additional code is necessary to detect and correct this
7495case. This option can be used to disable generation of the additional
7496code required to correct the result.
7497
7498@item -mrptb
7499@itemx -mno-rptb
7500Enable (disable) generation of repeat block sequences using the RPTB
7501instruction for zero overhead looping. The RPTB construct is only used
7502for innermost loops that do not call functions or jump across the loop
7503boundaries. There is no advantage having nested RPTB loops due to the
7504overhead required to save and restore the RC, RS, and RE registers.
7505This is enabled by default with -O2.
7506
7507@item -mrpts=@var{count}
7508@itemx -mno-rpts
7509Enable (disable) the use of the single instruction repeat instruction
7510RPTS. If a repeat block contains a single instruction, and the loop
7511count can be guaranteed to be less than the value @var{count}, GCC will
7512emit a RPTS instruction instead of a RPTB. If no value is specified,
7513then a RPTS will be emitted even if the loop count cannot be determined
7514at compile time. Note that the repeated instruction following RPTS does
7515not have to be reloaded from memory each iteration, thus freeing up the
b192711e 7516CPU buses for operands. However, since interrupts are blocked by this
282a61e6
MH
7517instruction, it is disabled by default.
7518
7519@item -mloop-unsigned
7520@itemx -mno-loop-unsigned
7521The maximum iteration count when using RPTS and RPTB (and DB on the C40)
7522is 2^31 + 1 since these instructions test if the iteration count is
7523negative to terminate the loop. If the iteration count is unsigned
7524there is a possibility than the 2^31 + 1 maximum iteration count may be
7525exceeded. This switch allows an unsigned iteration count.
7526
7527@item -mti
7528Try to emit an assembler syntax that the TI assembler (asm30) is happy
7529with. This also enforces compatibility with the API employed by the TI
7530C3x C compiler. For example, long doubles are passed as structures
7531rather than in floating point registers.
7532
7533@item -mregparm
7534@itemx -mmemparm
7535Generate code that uses registers (stack) for passing arguments to functions.
7536By default, arguments are passed in registers where possible rather
7537than by pushing arguments on to the stack.
7538
7539@item -mparallel-insns
7540@itemx -mno-parallel-insns
7541Allow the generation of parallel instructions. This is enabled by
7542default with -O2.
7543
7544@item -mparallel-mpy
7545@itemx -mno-parallel-mpy
7546Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7547provided -mparallel-insns is also specified. These instructions have
7548tight register constraints which can pessimize the code generation
7549of large functions.
7550
7551@end table
7552
f84271d9
JL
7553@node V850 Options
7554@subsection V850 Options
7555@cindex V850 Options
7556
7557These @samp{-m} options are defined for V850 implementations:
7558
2642624b 7559@table @gcctabopt
f84271d9
JL
7560@item -mlong-calls
7561@itemx -mno-long-calls
7562Treat all calls as being far away (near). If calls are assumed to be
7563far away, the compiler will always load the functions address up into a
7564register, and call indirect through the pointer.
7565
7566@item -mno-ep
bd762873 7567@itemx -mep
f84271d9
JL
7568Do not optimize (do optimize) basic blocks that use the same index
7569pointer 4 or more times to copy pointer into the @code{ep} register, and
7570use the shorter @code{sld} and @code{sst} instructions. The @samp{-mep}
7571option is on by default if you optimize.
7572
7573@item -mno-prolog-function
7574@itemx -mprolog-function
7575Do not use (do use) external functions to save and restore registers at
7576the prolog and epilog of a function. The external functions are slower,
7577but use less code space if more than one function saves the same number
7578of registers. The @samp{-mprolog-function} option is on by default if
7579you optimize.
7580
7581@item -mspace
7582Try to make the code as small as possible. At present, this just turns
7583on the @samp{-mep} and @samp{-mprolog-function} options.
7584
7585@item -mtda=@var{n}
7586Put static or global variables whose size is @var{n} bytes or less into
7587the tiny data area that register @code{ep} points to. The tiny data
7588area can hold up to 256 bytes in total (128 bytes for byte references).
7589
7590@item -msda=@var{n}
7591Put static or global variables whose size is @var{n} bytes or less into
7592the small data area that register @code{gp} points to. The small data
7593area can hold up to 64 kilobytes.
7594
7595@item -mzda=@var{n}
7596Put static or global variables whose size is @var{n} bytes or less into
7597the first 32 kilobytes of memory.
e9a25f70 7598
48f0be1b
SC
7599@item -mv850
7600Specify that the target processor is the V850.
7601
e9a25f70
JL
7602@item -mbig-switch
7603Generate code suitable for big switch tables. Use this option only if
7604the assembler/linker complain about out of range branches within a switch
7605table.
f84271d9
JL
7606@end table
7607
56b2d7a7
JL
7608@node ARC Options
7609@subsection ARC Options
7610@cindex ARC Options
7611
7612These options are defined for ARC implementations:
7613
2642624b 7614@table @gcctabopt
56b2d7a7
JL
7615@item -EL
7616Compile code for little endian mode. This is the default.
7617
7618@item -EB
7619Compile code for big endian mode.
7620
7621@item -mmangle-cpu
7622Prepend the name of the cpu to all public symbol names.
7623In multiple-processor systems, there are many ARC variants with different
7624instruction and register set characteristics. This flag prevents code
7625compiled for one cpu to be linked with code compiled for another.
7626No facility exists for handling variants that are "almost identical".
7627This is an all or nothing option.
7628
7629@item -mcpu=@var{cpu}
7630Compile code for ARC variant @var{cpu}.
7631Which variants are supported depend on the configuration.
7632All variants support @samp{-mcpu=base}, this is the default.
7633
7634@item -mtext=@var{text section}
59d40964
AS
7635@itemx -mdata=@var{data section}
7636@itemx -mrodata=@var{readonly data section}
56b2d7a7
JL
7637Put functions, data, and readonly data in @var{text section},
7638@var{data section}, and @var{readonly data section} respectively
7639by default. This can be overridden with the @code{section} attribute.
0b433de6 7640@xref{Variable Attributes}.
56b2d7a7
JL
7641
7642@end table
7643
83575957
ID
7644@node NS32K Options
7645@subsection NS32K Options
7646@cindex NS32K options
7647
7648These are the @samp{-m} options defined for the 32000 series. The default
7649values for these options depends on which style of 32000 was selected when
7650the compiler was configured; the defaults for the most common choices are
7651given below.
7652
2642624b 7653@table @gcctabopt
83575957
ID
7654@item -m32032
7655@itemx -m32032
7656Generate output for a 32032. This is the default
7657when the compiler is configured for 32032 and 32016 based systems.
7658
7659@item -m32332
7660@itemx -m32332
7661Generate output for a 32332. This is the default
7662when the compiler is configured for 32332-based systems.
7663
7664@item -m32532
7665@itemx -m32532
7666Generate output for a 32532. This is the default
7667when the compiler is configured for 32532-based systems.
7668
7669@item -m32081
7670Generate output containing 32081 instructions for floating point.
7671This is the default for all systems.
7672
7673@item -m32381
7674Generate output containing 32381 instructions for floating point. This
7675also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7676and 32532 cpus. This is the default for the pc532-netbsd configuration.
7677
7678@item -mmulti-add
7679Try and generate multiply-add floating point instructions @code{polyF}
7680and @code{dotF}. This option is only available if the @samp{-m32381}
7681option is in effect. Using these instructions requires changes to to
7682register allocation which generally has a negative impact on
7683performance. This option should only be enabled when compiling code
7684particularly likely to make heavy use of multiply-add instructions.
7685
7686@item -mnomulti-add
7687Do not try and generate multiply-add floating point instructions
7688@code{polyF} and @code{dotF}. This is the default on all platforms.
7689
7690@item -msoft-float
7691Generate output containing library calls for floating point.
7692@strong{Warning:} the requisite libraries may not be available.
7693
7694@item -mnobitfield
7695Do not use the bit-field instructions. On some machines it is faster to
7696use shifting and masking operations. This is the default for the pc532.
7697
7698@item -mbitfield
7699Do use the bit-field instructions. This is the default for all platforms
7700except the pc532.
7701
7702@item -mrtd
7703Use a different function-calling convention, in which functions
7704that take a fixed number of arguments return pop their
7705arguments on return with the @code{ret} instruction.
7706
7707This calling convention is incompatible with the one normally
7708used on Unix, so you cannot use it if you need to call libraries
7709compiled with the Unix compiler.
7710
7711Also, you must provide function prototypes for all functions that
7712take variable numbers of arguments (including @code{printf});
7713otherwise incorrect code will be generated for calls to those
7714functions.
7715
7716In addition, seriously incorrect code will result if you call a
7717function with too many arguments. (Normally, extra arguments are
7718harmlessly ignored.)
7719
7720This option takes its name from the 680x0 @code{rtd} instruction.
7721
7722
7723@item -mregparam
7724Use a different function-calling convention where the first two arguments
7725are passed in registers.
7726
7727This calling convention is incompatible with the one normally
7728used on Unix, so you cannot use it if you need to call libraries
7729compiled with the Unix compiler.
7730
7731@item -mnoregparam
7732Do not pass any arguments in registers. This is the default for all
7733targets.
7734
7735@item -msb
7736It is OK to use the sb as an index register which is always loaded with
7737zero. This is the default for the pc532-netbsd target.
7738
7739@item -mnosb
7740The sb register is not available for use or has not been initialized to
7741zero by the run time system. This is the default for all targets except
7742the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7743@samp{-fpic} is set.
7744
7745@item -mhimem
7746Many ns32000 series addressing modes use displacements of up to 512MB.
7747If an address is above 512MB then displacements from zero can not be used.
7748This option causes code to be generated which can be loaded above 512MB.
7749This may be useful for operating systems or ROM code.
7750
7751@item -mnohimem
7752Assume code will be loaded in the first 512MB of virtual address space.
7753This is the default for all platforms.
7754
7755
7756@end table
7757
052a4b28
DC
7758@node AVR Options
7759@subsection AVR Options
7760@cindex AVR Options
7761
7762These options are defined for AVR implementations:
7763
2642624b 7764@table @gcctabopt
052a4b28 7765@item -mmcu=@var{mcu}
3a69a7d5
MM
7766Specify ATMEL AVR instruction set or MCU type.
7767
7768Instruction set avr1 is for the minimal AVR core, not supported by the C
7769compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7770attiny11, attiny12, attiny15, attiny28).
7771
7772Instruction set avr2 (default) is for the classic AVR core with up to
77738K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7774at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7775at90c8534, at90s8535).
7776
7777Instruction set avr3 is for the classic AVR core with up to 128K program
7778memory space (MCU types: atmega103, atmega603).
7779
7780Instruction set avr4 is for the enhanced AVR core with up to 8K program
7781memory space (MCU types: atmega83, atmega85).
7782
7783Instruction set avr5 is for the enhanced AVR core with up to 128K program
7784memory space (MCU types: atmega161, atmega163, atmega32, at94k).
052a4b28
DC
7785
7786@item -msize
3a69a7d5 7787Output instruction sizes to the asm file.
052a4b28
DC
7788
7789@item -minit-stack=@var{N}
3a69a7d5
MM
7790Specify the initial stack address, which may be a symbol or numeric value,
7791__stack is the default.
052a4b28
DC
7792
7793@item -mno-interrupts
7794Generated code is not compatible with hardware interrupts.
7795Code size will be smaller.
7796
7797@item -mcall-prologues
7798Functions prologues/epilogues expanded as call to appropriate
7799subroutines. Code size will be smaller.
3a69a7d5
MM
7800
7801@item -mno-tablejump
7802Do not generate tablejump insns which sometimes increase code size.
7803
7804@item -mtiny-stack
7805Change only the low 8 bits of the stack pointer.
052a4b28
DC
7806@end table
7807
789a3090
NC
7808@node MCore Options
7809@subsection MCore Options
7810@cindex MCore options
7811
7812These are the @samp{-m} options defined for the Motorola M*Core
7813processors.
7814
2642624b 7815@table @gcctabopt
789a3090
NC
7816
7817@item -mhardlit
7818@itemx -mhardlit
7819@itemx -mno-hardlit
7820Inline constants into the code stream if it can be done in two
7821instructions or less.
7822
7823@item -mdiv
7824@itemx -mdiv
7825@itemx -mno-div
7826Use the divide instruction. (Enabled by default).
7827
7828@item -mrelax-immediate
7829@itemx -mrelax-immediate
7830@itemx -mno-relax-immediate
b192711e 7831Allow arbitrary sized immediates in bit operations.
789a3090
NC
7832
7833@item -mwide-bitfields
7834@itemx -mwide-bitfields
7835@itemx -mno-wide-bitfields
7836Always treat bitfields as int-sized.
7837
7838@item -m4byte-functions
7839@itemx -m4byte-functions
7840@itemx -mno-4byte-functions
b192711e 7841Force all functions to be aligned to a four byte boundary.
789a3090
NC
7842
7843@item -mcallgraph-data
7844@itemx -mcallgraph-data
7845@itemx -mno-callgraph-data
7846Emit callgraph information.
7847
7848@item -mslow-bytes
7849@itemx -mslow-bytes
7850@itemx -mno-slow-bytes
7851Prefer word access when reading byte quantities.
7852
7853@item -mlittle-endian
7854@itemx -mlittle-endian
7855@itemx -mbig-endian
b192711e 7856Generate code for a little endian target.
789a3090
NC
7857
7858@item -m210
7859@itemx -m210
7860@itemx -m340
7861Generate code for the 210 processor.
789a3090 7862@end table
83575957 7863
df6194d4
JW
7864@node IA-64 Options
7865@subsection IA-64 Options
7866@cindex IA-64 Options
7867
7868These are the @samp{-m} options defined for the Intel IA-64 architecture.
7869
7870@table @gcctabopt
7871@item -mbig-endian
7872Generate code for a big endian target. This is the default for HPUX.
7873
7874@item -mlittle-endian
7875Generate code for a little endian target. This is the default for AIX5
7876and Linux.
7877
7878@item -mgnu-as
7879@itemx -mno-gnu-as
15d3a111
JW
7880Generate (or don't) code for the GNU assembler. This is the default.
7881@c Also, this is the default if the configure option @samp{--with-gnu-as}
7882@c is used.
df6194d4
JW
7883
7884@item -mgnu-ld
7885@itemx -mno-gnu-ld
15d3a111
JW
7886Generate (or don't) code for the GNU linker. This is the default.
7887@c Also, this is the default if the configure option @samp{--with-gnu-ld}
7888@c is used.
df6194d4
JW
7889
7890@item -mno-pic
15d3a111
JW
7891Generate code that does not use a global pointer register. The result
7892is not position independent code, and violates the IA-64 ABI.
df6194d4
JW
7893
7894@item -mvolatile-asm-stop
7895@itemx -mno-volatile-asm-stop
15d3a111
JW
7896Generate (or don't) a stop bit immediately before and after volatile asm
7897statements.
df6194d4
JW
7898
7899@item -mb-step
7900Generate code that works around Itanium B step errata.
7901
7902@item -mregister-names
7903@itemx -mno-register-names
15d3a111
JW
7904Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
7905the stacked registers. This may make assembler output more readable.
df6194d4
JW
7906
7907@item -mno-sdata
7908@itemx -msdata
15d3a111
JW
7909Disable (or enable) optimizations that use the small data section. This may
7910be useful for working around optimizer bugs.
df6194d4
JW
7911
7912@item -mconstant-gp
7913Generate code that uses a single constant global pointer value. This is
7914useful when compiling kernel code.
7915
7916@item -mauto-pic
7917Generate code that is self-relocatable. This implies @samp{-mconstant-gp}.
7918This is useful when compiling firmware code.
7919
7920@item -minline-divide-min-latency
7921Generate code for inline divides using the minimum latency algorithm.
7922
7923@item -minline-divide-max-throughput
7924Generate code for inline divides using the maximum throughput algorithm.
7925
7926@item -mno-dwarf2-asm
7927@itemx -mdwarf2-asm
15d3a111
JW
7928Don't (or do) generate assembler code for the DWARF2 line number debugging
7929info. This may be useful when not using the GNU assembler.
df6194d4
JW
7930
7931@item -mfixed-range=@var{register range}
7932Generate code treating the given register range as fixed registers.
7933A fixed register is one that the register allocator can not use. This is
7934useful when compiling kernel code. A register range is specified as
7935two registers separated by a dash. Multiple register ranges can be
7936specified separated by a comma.
7937@end table
7938
e8ad90e5
MM
7939@node D30V Options
7940@subsection D30V Options
7941@cindex D30V Options
7942
7943These @samp{-m} options are defined for D30V implementations:
7944
2642624b 7945@table @gcctabopt
e8ad90e5
MM
7946@item -mextmem
7947Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7948@samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7949memory, which starts at location @code{0x80000000}.
7950
7951@item -mextmemory
7952Same as the @samp{-mextmem} switch.
7953
7954@item -monchip
7955Link the @samp{.text} section into onchip text memory, which starts at
7956location @code{0x0}. Also link @samp{.data}, @samp{.bss},
7957@samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
7958into onchip data memory, which starts at location @code{0x20000000}.
7959
7960@item -mno-asm-optimize
7961@itemx -masm-optimize
7962Disable (enable) passing @samp{-O} to the assembler when optimizing.
7963The assembler uses the @samp{-O} option to automatically parallelize
7964adjacent short instructions where possible.
7965
7966@item -mbranch-cost=@var{n}
7967Increase the internal costs of branches to @var{n}. Higher costs means
7968that the compiler will issue more instructions to avoid doing a branch.
7969The default is 2.
7970
7971@item -mcond-exec=@var{n}
7972Specify the maximum number of conditionally executed instructions that
7973replace a branch. The default is 4.
7974@end table
56b2d7a7 7975
74291a4b
MM
7976@node Code Gen Options
7977@section Options for Code Generation Conventions
7978@cindex code generation conventions
7979@cindex options, code generation
7980@cindex run-time options
7981
7982These machine-independent options control the interface conventions
7983used in code generation.
7984
7985Most of them have both positive and negative forms; the negative form
7986of @samp{-ffoo} would be @samp{-fno-foo}. In the table below, only
7987one of the forms is listed---the one which is not the default. You
7988can figure out the other form by either removing @samp{no-} or adding
7989it.
7990
2642624b 7991@table @gcctabopt
956d6950 7992@item -fexceptions
89ed4e9d 7993Enable exception handling. Generates extra code needed to propagate
c5c76735
JL
7994exceptions. For some targets, this implies GNU CC will generate frame
7995unwind information for all functions, which can produce significant data
7996size overhead, although it does not affect execution. If you do not
7997specify this option, GNU CC will enable it by default for languages like
7998C++ which normally require exception handling, and disable itfor
7999languages like C that do not normally require it. However, you may need
8000to enable this option when compiling C code that needs to interoperate
8001properly with exception handlers written in C++. You may also wish to
8002disable this option if you are compiling older C++ programs that don't
8003use exception handling.
956d6950 8004
14a774a9 8005@item -funwind-tables
bedc7537 8006Similar to @option{-fexceptions}, except that it will just generate any needed
14a774a9
RK
8007static data, but will not affect the generated code in any other way.
8008You will normally not enable this option; instead, a language processor
8009that needs this handling would enable it on your behalf.
8010
74291a4b
MM
8011@item -fpcc-struct-return
8012Return ``short'' @code{struct} and @code{union} values in memory like
8013longer ones, rather than in registers. This convention is less
8014efficient, but it has the advantage of allowing intercallability between
0c2d1a2a 8015GCC-compiled files and files compiled with other compilers.
74291a4b
MM
8016
8017The precise convention for returning structures in memory depends
8018on the target configuration macros.
8019
8020Short structures and unions are those whose size and alignment match
8021that of some integer type.
8022
8023@item -freg-struct-return
8024Use the convention that @code{struct} and @code{union} values are
8025returned in registers when possible. This is more efficient for small
8026structures than @samp{-fpcc-struct-return}.
8027
8028If you specify neither @samp{-fpcc-struct-return} nor its contrary
0c2d1a2a
JB
8029@samp{-freg-struct-return}, GCC defaults to whichever convention is
8030standard for the target. If there is no standard convention, GCC
8031defaults to @samp{-fpcc-struct-return}, except on targets where GCC
74291a4b
MM
8032is the principal compiler. In those cases, we can choose the standard,
8033and we chose the more efficient register return alternative.
8034
8035@item -fshort-enums
8036Allocate to an @code{enum} type only as many bytes as it needs for the
8037declared range of possible values. Specifically, the @code{enum} type
8038will be equivalent to the smallest integer type which has enough room.
8039
8040@item -fshort-double
8041Use the same size for @code{double} as for @code{float}.
8042
8043@item -fshared-data
8044Requests that the data and non-@code{const} variables of this
8045compilation be shared data rather than private data. The distinction
8046makes sense only on certain operating systems, where shared data is
8047shared between processes running the same program, while private data
8048exists in one copy per process.
8049
8050@item -fno-common
c5c76735 8051Allocate even uninitialized global variables in the data section of the
74291a4b
MM
8052object file, rather than generating them as common blocks. This has the
8053effect that if the same variable is declared (without @code{extern}) in
8054two different compilations, you will get an error when you link them.
8055The only reason this might be useful is if you wish to verify that the
8056program will work on other systems which always work this way.
8057
8058@item -fno-ident
8059Ignore the @samp{#ident} directive.
8060
8061@item -fno-gnu-linker
8062Do not output global initializations (such as C++ constructors and
8063destructors) in the form used by the GNU linker (on systems where the GNU
8064linker is the standard method of handling them). Use this option when
8065you want to use a non-GNU linker, which also requires using the
bedc7537
NC
8066@command{collect2} program to make sure the system linker includes
8067constructors and destructors. (@command{collect2} is included in the GCC
8068distribution.) For systems which @emph{must} use @command{collect2}, the
8069compiler driver @command{gcc} is configured to do this automatically.
74291a4b
MM
8070
8071@item -finhibit-size-directive
8072Don't output a @code{.size} assembler directive, or anything else that
8073would cause trouble if the function is split in the middle, and the
8074two halves are placed at locations far apart in memory. This option is
8075used when compiling @file{crtstuff.c}; you should not need to use it
8076for anything else.
8077
8078@item -fverbose-asm
8079Put extra commentary information in the generated assembly code to
8080make it more readable. This option is generally only of use to those
8081who actually need to read the generated assembly code (perhaps while
8082debugging the compiler itself).
8083
c85f7c16 8084@samp{-fno-verbose-asm}, the default, causes the
74291a4b
MM
8085extra information to be omitted and is useful when comparing two assembler
8086files.
8087
8088@item -fvolatile
8089Consider all memory references through pointers to be volatile.
8090
8091@item -fvolatile-global
8092Consider all memory references to extern and global data items to
0c2d1a2a 8093be volatile. GCC does not consider static data items to be volatile
ab87f8c8
JL
8094because of this switch.
8095
8096@item -fvolatile-static
8097Consider all memory references to static data to be volatile.
74291a4b
MM
8098
8099@item -fpic
8100@cindex global offset table
8101@cindex PIC
8102Generate position-independent code (PIC) suitable for use in a shared
8103library, if supported for the target machine. Such code accesses all
861bb6c1
JL
8104constant addresses through a global offset table (GOT). The dynamic
8105loader resolves the GOT entries when the program starts (the dynamic
0c2d1a2a 8106loader is not part of GCC; it is part of the operating system). If
861bb6c1
JL
8107the GOT size for the linked executable exceeds a machine-specific
8108maximum size, you get an error message from the linker indicating that
8109@samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
8110instead. (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
8111on the m68k and RS/6000. The 386 has no such limit.)
74291a4b
MM
8112
8113Position-independent code requires special support, and therefore works
0c2d1a2a 8114only on certain machines. For the 386, GCC supports PIC for System V
74291a4b
MM
8115but not for the Sun 386i. Code generated for the IBM RS/6000 is always
8116position-independent.
8117
74291a4b
MM
8118@item -fPIC
8119If supported for the target machine, emit position-independent code,
8120suitable for dynamic linking and avoiding any limit on the size of the
8121global offset table. This option makes a difference on the m68k, m88k,
8122and the Sparc.
8123
8124Position-independent code requires special support, and therefore works
8125only on certain machines.
8126
8127@item -ffixed-@var{reg}
8128Treat the register named @var{reg} as a fixed register; generated code
8129should never refer to it (except perhaps as a stack pointer, frame
8130pointer or in some other fixed role).
8131
8132@var{reg} must be the name of a register. The register names accepted
8133are machine-specific and are defined in the @code{REGISTER_NAMES}
8134macro in the machine description macro file.
8135
8136This flag does not have a negative form, because it specifies a
8137three-way choice.
8138
8139@item -fcall-used-@var{reg}
956d6950 8140Treat the register named @var{reg} as an allocable register that is
74291a4b
MM
8141clobbered by function calls. It may be allocated for temporaries or
8142variables that do not live across a call. Functions compiled this way
8143will not save and restore the register @var{reg}.
8144
cb2fdc84
GRK
8145It is an error to used this flag with the frame pointer or stack pointer.
8146Use of this flag for other registers that have fixed pervasive roles in
8147the machine's execution model will produce disastrous results.
74291a4b
MM
8148
8149This flag does not have a negative form, because it specifies a
8150three-way choice.
8151
8152@item -fcall-saved-@var{reg}
956d6950 8153Treat the register named @var{reg} as an allocable register saved by
74291a4b
MM
8154functions. It may be allocated even for temporaries or variables that
8155live across a call. Functions compiled this way will save and restore
8156the register @var{reg} if they use it.
8157
cb2fdc84
GRK
8158It is an error to used this flag with the frame pointer or stack pointer.
8159Use of this flag for other registers that have fixed pervasive roles in
8160the machine's execution model will produce disastrous results.
74291a4b
MM
8161
8162A different sort of disaster will result from the use of this flag for
8163a register in which function values may be returned.
8164
8165This flag does not have a negative form, because it specifies a
8166three-way choice.
8167
8168@item -fpack-struct
8169Pack all structure members together without holes. Usually you would
8170not want to use this option, since it makes the code suboptimal, and
8171the offsets of structure members won't agree with system libraries.
8172
861bb6c1 8173@item -fcheck-memory-usage
0c2d1a2a 8174Generate extra code to check each memory access. GCC will generate
861bb6c1 8175code that is suitable for a detector of bad memory accesses such as
7d384cc0 8176@file{Checker}.
861bb6c1 8177
d3111037
CB
8178Normally, you should compile all, or none, of your code with this option.
8179
8180If you do mix code compiled with and without this option,
8181you must ensure that all code that has side effects
8182and that is called by code compiled with this option
8183is, itself, compiled with this option.
8184If you do not, you might get erroneous messages from the detector.
8185
861bb6c1 8186If you use functions from a library that have side-effects (such as
d3111037 8187@code{read}), you might not be able to recompile the library and
861bb6c1 8188specify this option. In that case, you can enable the
0c2d1a2a 8189@samp{-fprefix-function-name} option, which requests GCC to encapsulate
861bb6c1
JL
8190your code and make other functions look as if they were compiled with
8191@samp{-fcheck-memory-usage}. This is done by calling ``stubs'',
8192which are provided by the detector. If you cannot find or build
d3111037 8193stubs for every function you call, you might have to specify
861bb6c1
JL
8194@samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
8195
7d384cc0 8196If you specify this option, you can not use the @code{asm} or
c5c76735
JL
8197@code{__asm__} keywords in functions with memory checking enabled. GNU
8198CC cannot understand what the @code{asm} statement may do, and therefore
8199cannot generate the appropriate code, so it will reject it. However, if
ee457005
JM
8200you specify the function attribute @code{no_check_memory_usage}
8201(@pxref{Function Attributes}), GNU CC will disable memory checking within a
c5c76735
JL
8202function; you may use @code{asm} statements inside such functions. You
8203may have an inline expansion of a non-checked function within a checked
8204function; in that case GNU CC will not generate checks for the inlined
8205function's memory accesses.
8206
8207If you move your @code{asm} statements to non-checked inline functions
8208and they do access memory, you can add calls to the support code in your
7d384cc0
KR
8209inline function, to indicate any reads, writes, or copies being done.
8210These calls would be similar to those done in the stubs described above.
8211
861bb6c1 8212@item -fprefix-function-name
0c2d1a2a
JB
8213Request GCC to add a prefix to the symbols generated for function names.
8214GCC adds a prefix to the names of functions defined as well as
861bb6c1 8215functions called. Code compiled with this option and code compiled
d3111037 8216without the option can't be linked together, unless stubs are used.
861bb6c1
JL
8217
8218If you compile the following code with @samp{-fprefix-function-name}
8219@example
8220extern void bar (int);
8221void
8222foo (int a)
8223@{
8224 return bar (a + 5);
861bb6c1
JL
8225@}
8226@end example
8227
8228@noindent
0c2d1a2a 8229GCC will compile the code as if it was written:
861bb6c1
JL
8230@example
8231extern void prefix_bar (int);
8232void
8233prefix_foo (int a)
8234@{
8235 return prefix_bar (a + 5);
8236@}
8237@end example
8238This option is designed to be used with @samp{-fcheck-memory-usage}.
8239
07417085
KR
8240@item -finstrument-functions
8241Generate instrumentation calls for entry and exit to functions. Just
8242after function entry and just before function exit, the following
8243profiling functions will be called with the address of the current
8244function and its call site. (On some platforms,
8245@code{__builtin_return_address} does not work beyond the current
8246function, so the call site information may not be available to the
8247profiling functions otherwise.)
8248
8249@example
8250void __cyg_profile_func_enter (void *this_fn, void *call_site);
8251void __cyg_profile_func_exit (void *this_fn, void *call_site);
8252@end example
8253
8254The first argument is the address of the start of the current function,
8255which may be looked up exactly in the symbol table.
8256
8257This instrumentation is also done for functions expanded inline in other
8258functions. The profiling calls will indicate where, conceptually, the
8259inline function is entered and exited. This means that addressable
8260versions of such functions must be available. If all your uses of a
8261function are expanded inline, this may mean an additional expansion of
8262code size. If you use @samp{extern inline} in your C code, an
8263addressable version of such functions must be provided. (This is
8264normally the case anyways, but if you get lucky and the optimizer always
8265expands the functions inline, you might have gotten away without
8266providing static copies.)
8267
8268A function may be given the attribute @code{no_instrument_function}, in
8269which case this instrumentation will not be done. This can be used, for
8270example, for the profiling functions listed above, high-priority
8271interrupt routines, and any functions from which the profiling functions
8272cannot safely be called (perhaps signal handlers, if the profiling
8273routines generate output or allocate memory).
8274
861bb6c1
JL
8275@item -fstack-check
8276Generate code to verify that you do not go beyond the boundary of the
8277stack. You should specify this flag if you are running in an
8278environment with multiple threads, but only rarely need to specify it in
8279a single-threaded environment since stack overflow is automatically
8280detected on nearly all systems if there is only one stack.
8281
a157febd
GK
8282Note that this switch does not actually cause checking to be done; the
8283operating system must do that. The switch causes generation of code
8284to ensure that the operating system sees the stack being extended.
8285
8286@item -fstack-limit-register=@var{reg}
8287@itemx -fstack-limit-symbol=@var{sym}
8288@itemx -fno-stack-limit
8289Generate code to ensure that the stack does not grow beyond a certain value,
8290either the value of a register or the address of a symbol. If the stack
8291would grow beyond the value, a signal is raised. For most targets,
8292the signal is raised before the stack overruns the boundary, so
8293it is possible to catch the signal without taking special precautions.
8294
8295For instance, if the stack starts at address @samp{0x80000000} and grows
8296downwards you can use the flags
8297@samp{-fstack-limit-symbol=__stack_limit}
8298@samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
8299limit of 128K.
8300
e5eb27e5
JL
8301@cindex aliasing of parameters
8302@cindex parameters, aliased
8303@item -fargument-alias
04afd9d6
JL
8304@itemx -fargument-noalias
8305@itemx -fargument-noalias-global
e5eb27e5
JL
8306Specify the possible relationships among parameters and between
8307parameters and global data.
8308
8309@samp{-fargument-alias} specifies that arguments (parameters) may
8310alias each other and may alias global storage.
8311@samp{-fargument-noalias} specifies that arguments do not alias
8312each other, but may alias global storage.
8313@samp{-fargument-noalias-global} specifies that arguments do not
8314alias each other and do not alias global storage.
8315
8316Each language will automatically use whatever option is required by
8317the language standard. You should not need to use these options yourself.
19283265
RH
8318
8319@item -fleading-underscore
8320This option and its counterpart, -fno-leading-underscore, forcibly
8321change the way C symbols are represented in the object file. One use
8322is to help link with legacy assembly code.
8323
8324Be warned that you should know what you are doing when invoking this
8325option, and that not all targets provide complete support for it.
74291a4b
MM
8326@end table
8327
ee457005
JM
8328@c man end
8329
74291a4b 8330@node Environment Variables
0c2d1a2a 8331@section Environment Variables Affecting GCC
74291a4b
MM
8332@cindex environment variables
8333
ee457005
JM
8334@c man begin ENVIRONMENT
8335
0c2d1a2a
JB
8336This section describes several environment variables that affect how GCC
8337operates. Some of them work by specifying directories or prefixes to use
56f48ce9 8338when searching for various kinds of files. Some are used to specify other
46103ab4 8339aspects of the compilation environment.
74291a4b
MM
8340
8341@ifclear INTERNALS
8342Note that you can also specify places to search using options such as
8343@samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}). These
8344take precedence over places specified using environment variables, which
0c2d1a2a
JB
8345in turn take precedence over those specified by the configuration of GCC.
8346
74291a4b
MM
8347@end ifclear
8348@ifset INTERNALS
8349Note that you can also specify places to search using options such as
8350@samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}). These
8351take precedence over places specified using environment variables, which
0c2d1a2a
JB
8352in turn take precedence over those specified by the configuration of GCC.
8353@xref{Driver}.
74291a4b
MM
8354@end ifset
8355
bedc7537 8356@table @env
ab87f8c8
JL
8357@item LANG
8358@itemx LC_CTYPE
8359@c @itemx LC_COLLATE
8360@itemx LC_MESSAGES
8361@c @itemx LC_MONETARY
8362@c @itemx LC_NUMERIC
8363@c @itemx LC_TIME
8364@itemx LC_ALL
8365@findex LANG
8366@findex LC_CTYPE
8367@c @findex LC_COLLATE
8368@findex LC_MESSAGES
8369@c @findex LC_MONETARY
8370@c @findex LC_NUMERIC
8371@c @findex LC_TIME
8372@findex LC_ALL
8373@cindex locale
0c2d1a2a
JB
8374These environment variables control the way that GCC uses
8375localization information that allow GCC to work with different
8376national conventions. GCC inspects the locale categories
bedc7537 8377@env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
ab87f8c8
JL
8378so. These locale categories can be set to any value supported by your
8379installation. A typical value is @samp{en_UK} for English in the United
8380Kingdom.
8381
bedc7537 8382The @env{LC_CTYPE} environment variable specifies character
0c2d1a2a 8383classification. GCC uses it to determine the character boundaries in
ab87f8c8
JL
8384a string; this is needed for some multibyte encodings that contain quote
8385and escape characters that would otherwise be interpreted as a string
8386end or escape.
8387
bedc7537 8388The @env{LC_MESSAGES} environment variable specifies the language to
ab87f8c8
JL
8389use in diagnostic messages.
8390
bedc7537
NC
8391If the @env{LC_ALL} environment variable is set, it overrides the value
8392of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
8393and @env{LC_MESSAGES} default to the value of the @env{LANG}
0c2d1a2a 8394environment variable. If none of these variables are set, GCC
ab87f8c8
JL
8395defaults to traditional C English behavior.
8396
74291a4b
MM
8397@item TMPDIR
8398@findex TMPDIR
bedc7537 8399If @env{TMPDIR} is set, it specifies the directory to use for temporary
0c2d1a2a 8400files. GCC uses temporary files to hold the output of one stage of
74291a4b
MM
8401compilation which is to be used as input to the next stage: for example,
8402the output of the preprocessor, which is the input to the compiler
8403proper.
8404
8405@item GCC_EXEC_PREFIX
8406@findex GCC_EXEC_PREFIX
bedc7537 8407If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
74291a4b
MM
8408names of the subprograms executed by the compiler. No slash is added
8409when this prefix is combined with the name of a subprogram, but you can
8410specify a prefix that ends with a slash if you wish.
8411
bedc7537 8412If @env{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
0deb20df
TT
8413an appropriate prefix to use based on the pathname it was invoked with.
8414
0c2d1a2a 8415If GCC cannot find the subprogram using the specified prefix, it
74291a4b
MM
8416tries looking in the usual places for the subprogram.
8417
bedc7537 8418The default value of @env{GCC_EXEC_PREFIX} is
74291a4b
MM
8419@file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
8420of @code{prefix} when you ran the @file{configure} script.
8421
8422Other prefixes specified with @samp{-B} take precedence over this prefix.
8423
8424This prefix is also used for finding files such as @file{crt0.o} that are
8425used for linking.
8426
8427In addition, the prefix is used in an unusual way in finding the
8428directories to search for header files. For each of the standard
8429directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
bedc7537 8430(more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
74291a4b 8431replacing that beginning with the specified prefix to produce an
0c2d1a2a 8432alternate directory name. Thus, with @samp{-Bfoo/}, GCC will search
74291a4b
MM
8433@file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
8434These alternate directories are searched first; the standard directories
8435come next.
8436
8437@item COMPILER_PATH
8438@findex COMPILER_PATH
bedc7537
NC
8439The value of @env{COMPILER_PATH} is a colon-separated list of
8440directories, much like @env{PATH}. GCC tries the directories thus
74291a4b 8441specified when searching for subprograms, if it can't find the
bedc7537 8442subprograms using @env{GCC_EXEC_PREFIX}.
74291a4b
MM
8443
8444@item LIBRARY_PATH
8445@findex LIBRARY_PATH
bedc7537
NC
8446The value of @env{LIBRARY_PATH} is a colon-separated list of
8447directories, much like @env{PATH}. When configured as a native compiler,
0c2d1a2a 8448GCC tries the directories thus specified when searching for special
bedc7537 8449linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
0c2d1a2a 8450using GCC also uses these directories when searching for ordinary
74291a4b
MM
8451libraries for the @samp{-l} option (but directories specified with
8452@samp{-L} come first).
8453
8454@item C_INCLUDE_PATH
8455@itemx CPLUS_INCLUDE_PATH
8456@itemx OBJC_INCLUDE_PATH
8457@findex C_INCLUDE_PATH
8458@findex CPLUS_INCLUDE_PATH
8459@findex OBJC_INCLUDE_PATH
8460@c @itemx OBJCPLUS_INCLUDE_PATH
8461These environment variables pertain to particular languages. Each
8462variable's value is a colon-separated list of directories, much like
bedc7537 8463@env{PATH}. When GCC searches for header files, it tries the
74291a4b
MM
8464directories listed in the variable for the language you are using, after
8465the directories specified with @samp{-I} but before the standard header
8466file directories.
8467
8468@item DEPENDENCIES_OUTPUT
8469@findex DEPENDENCIES_OUTPUT
8470@cindex dependencies for make as output
8471If this variable is set, its value specifies how to output dependencies
8472for Make based on the header files processed by the compiler. This
8473output looks much like the output from the @samp{-M} option
8474(@pxref{Preprocessor Options}), but it goes to a separate file, and is
8475in addition to the usual results of compilation.
8476
bedc7537 8477The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
74291a4b
MM
8478which case the Make rules are written to that file, guessing the target
8479name from the source file name. Or the value can have the form
8480@samp{@var{file} @var{target}}, in which case the rules are written to
8481file @var{file} using @var{target} as the target name.
56f48ce9
DB
8482
8483@item LANG
8484@findex LANG
8485@cindex locale definition
8486This variable is used to pass locale information to the compiler. One way in
8487which this information is used is to determine the character set to be used
8488when character literals, string literals and comments are parsed in C and C++.
8489When the compiler is configured to allow multibyte characters,
bedc7537 8490the following values for @env{LANG} are recognized:
56f48ce9 8491
2642624b 8492@table @samp
56f48ce9
DB
8493@item C-JIS
8494Recognize JIS characters.
8495@item C-SJIS
8496Recognize SJIS characters.
8497@item C-EUCJP
8498Recognize EUCJP characters.
8499@end table
8500
bedc7537 8501If @env{LANG} is not defined, or if it has some other value, then the
56f48ce9
DB
8502compiler will use mblen and mbtowc as defined by the default locale to
8503recognize and translate multibyte characters.
74291a4b
MM
8504@end table
8505
9d86bffc
JM
8506@c man end
8507
74291a4b
MM
8508@node Running Protoize
8509@section Running Protoize
8510
8511The program @code{protoize} is an optional part of GNU C. You can use
c1030c7c 8512it to add prototypes to a program, thus converting the program to ISO
74291a4b
MM
8513C in one respect. The companion program @code{unprotoize} does the
8514reverse: it removes argument types from any prototypes that are found.
8515
8516When you run these programs, you must specify a set of source files as
8517command line arguments. The conversion programs start out by compiling
8518these files to see what functions they define. The information gathered
8519about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
8520
8521After scanning comes actual conversion. The specified files are all
8522eligible to be converted; any files they include (whether sources or
8523just headers) are eligible as well.
8524
8525But not all the eligible files are converted. By default,
8526@code{protoize} and @code{unprotoize} convert only source and header
8527files in the current directory. You can specify additional directories
8528whose files should be converted with the @samp{-d @var{directory}}
8529option. You can also specify particular files to exclude with the
8530@samp{-x @var{file}} option. A file is converted if it is eligible, its
8531directory name matches one of the specified directory names, and its
8532name within the directory has not been excluded.
8533
8534Basic conversion with @code{protoize} consists of rewriting most
8535function definitions and function declarations to specify the types of
8536the arguments. The only ones not rewritten are those for varargs
8537functions.
8538
8539@code{protoize} optionally inserts prototype declarations at the
8540beginning of the source file, to make them available for any calls that
8541precede the function's definition. Or it can insert prototype
8542declarations with block scope in the blocks where undeclared functions
8543are called.
8544
8545Basic conversion with @code{unprotoize} consists of rewriting most
8546function declarations to remove any argument types, and rewriting
c1030c7c 8547function definitions to the old-style pre-ISO form.
74291a4b
MM
8548
8549Both conversion programs print a warning for any function declaration or
8550definition that they can't convert. You can suppress these warnings
8551with @samp{-q}.
8552
8553The output from @code{protoize} or @code{unprotoize} replaces the
8554original source file. The original file is renamed to a name ending
a7db8bbb
MK
8555with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
8556without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
8557for DOS) file already exists, then the source file is simply discarded.
74291a4b 8558
0c2d1a2a 8559@code{protoize} and @code{unprotoize} both depend on GCC itself to
74291a4b 8560scan the program and collect information about the functions it uses.
0c2d1a2a 8561So neither of these programs will work until GCC is installed.
74291a4b
MM
8562
8563Here is a table of the options you can use with @code{protoize} and
8564@code{unprotoize}. Each option works with both programs unless
8565otherwise stated.
8566
8567@table @code
8568@item -B @var{directory}
8569Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
8570usual directory (normally @file{/usr/local/lib}). This file contains
8571prototype information about standard system functions. This option
8572applies only to @code{protoize}.
8573
8574@item -c @var{compilation-options}
8575Use @var{compilation-options} as the options when running @code{gcc} to
8576produce the @samp{.X} files. The special option @samp{-aux-info} is
8577always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
8578
8579Note that the compilation options must be given as a single argument to
8580@code{protoize} or @code{unprotoize}. If you want to specify several
8581@code{gcc} options, you must quote the entire set of compilation options
8582to make them a single word in the shell.
8583
8584There are certain @code{gcc} arguments that you cannot use, because they
8585would produce the wrong kind of output. These include @samp{-g},
8586@samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
8587the @var{compilation-options}, they are ignored.
8588
8589@item -C
a7db8bbb
MK
8590Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
8591systems) instead of @samp{.c}. This is convenient if you are converting
ee77eda5 8592a C program to C++. This option applies only to @code{protoize}.
74291a4b
MM
8593
8594@item -g
8595Add explicit global declarations. This means inserting explicit
8596declarations at the beginning of each source file for each function
8597that is called in the file and was not declared. These declarations
8598precede the first function definition that contains a call to an
8599undeclared function. This option applies only to @code{protoize}.
8600
8601@item -i @var{string}
8602Indent old-style parameter declarations with the string @var{string}.
8603This option applies only to @code{protoize}.
8604
8605@code{unprotoize} converts prototyped function definitions to old-style
8606function definitions, where the arguments are declared between the
8607argument list and the initial @samp{@{}. By default, @code{unprotoize}
8608uses five spaces as the indentation. If you want to indent with just
8609one space instead, use @samp{-i " "}.
8610
8611@item -k
8612Keep the @samp{.X} files. Normally, they are deleted after conversion
8613is finished.
8614
8615@item -l
8616Add explicit local declarations. @code{protoize} with @samp{-l} inserts
8617a prototype declaration for each function in each block which calls the
8618function without any declaration. This option applies only to
8619@code{protoize}.
8620
8621@item -n
8622Make no real changes. This mode just prints information about the conversions
8623that would have been done without @samp{-n}.
8624
8625@item -N
8626Make no @samp{.save} files. The original files are simply deleted.
8627Use this option with caution.
8628
8629@item -p @var{program}
8630Use the program @var{program} as the compiler. Normally, the name
8631@file{gcc} is used.
8632
8633@item -q
8634Work quietly. Most warnings are suppressed.
8635
8636@item -v
8637Print the version number, just like @samp{-v} for @code{gcc}.
8638@end table
8639
8640If you need special compiler options to compile one of your program's
8641source files, then you should generate that file's @samp{.X} file
8642specially, by running @code{gcc} on that source file with the
8643appropriate options and the option @samp{-aux-info}. Then run
8644@code{protoize} on the entire set of files. @code{protoize} will use
8645the existing @samp{.X} file because it is newer than the source file.
8646For example:
8647
8648@example
8649gcc -Dfoo=bar file1.c -aux-info
8650protoize *.c
8651@end example
8652
8653@noindent
8654You need to include the special files along with the rest in the
8655@code{protoize} command, even though their @samp{.X} files already
8656exist, because otherwise they won't get converted.
8657
8658@xref{Protoize Caveats}, for more information on how to use
8659@code{protoize} successfully.
8660
This page took 1.899732 seconds and 5 git commands to generate.