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