]> gcc.gnu.org Git - gcc.git/blame_incremental - gcc/doc/invoke.texi
re PR target/7531 (-mcmodel not documented for x86-64)
[gcc.git] / gcc / doc / invoke.texi
... / ...
CommitLineData
1@c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2@c 2000, 2001, 2002 Free Software Foundation, Inc.
3@c This is part of the GCC manual.
4@c For copying conditions, see the file gcc.texi.
5
6@ignore
7@c man begin COPYRIGHT
8Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
91998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
10
11Permission is granted to copy, distribute and/or modify this document
12under the terms of the GNU Free Documentation License, Version 1.1 or
13any later version published by the Free Software Foundation; with the
14Invariant Sections being ``GNU General Public License'' and ``Funding
15Free Software'', the Front-Cover texts being (a) (see below), and with
16the Back-Cover Texts being (b) (see below). A copy of the license is
17included in the gfdl(7) man page.
18
19(a) The FSF's Front-Cover Text is:
20
21 A GNU Manual
22
23(b) The FSF's Back-Cover Text is:
24
25 You have freedom to copy and modify this GNU Manual, like GNU
26 software. Copies published by the Free Software Foundation raise
27 funds for GNU development.
28@c man end
29@c Set file name and title for the man page.
30@setfilename gcc
31@settitle GNU project C and C++ compiler
32@c man begin SYNOPSIS
33gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39 [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41Only the most useful options are listed here; see below for the
42remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
43@c man end
44@c man begin SEEALSO
45gpl(7), gfdl(7), fsf-funding(7),
46cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48@file{ld}, @file{binutils} and @file{gdb}.
49@c man end
50@c man begin BUGS
51For instructions on reporting bugs, see
52@w{@uref{http://gcc.gnu.org/bugs.html}}. Use of the @command{gccbug}
53script to report bugs is recommended.
54@c man end
55@c man begin AUTHOR
56See the Info entry for @command{gcc}, or
57@w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58for contributors to GCC@.
59@c man end
60@end ignore
61
62@node Invoking GCC
63@chapter GCC Command Options
64@cindex GCC command options
65@cindex command options
66@cindex options, GCC command
67
68@c man begin DESCRIPTION
69
70When you invoke GCC, it normally does preprocessing, compilation,
71assembly and linking. The ``overall options'' allow you to stop this
72process at an intermediate stage. For example, the @option{-c} option
73says not to run the linker. Then the output consists of object files
74output by the assembler.
75
76Other options are passed on to one stage of processing. Some options
77control the preprocessor and others the compiler itself. Yet other
78options control the assembler and linker; most of these are not
79documented here, since you rarely need to use any of them.
80
81@cindex C compilation options
82Most of the command line options that you can use with GCC are useful
83for C programs; when an option is only useful with another language
84(usually C++), the explanation says so explicitly. If the description
85for a particular option does not mention a source language, you can use
86that option with all supported languages.
87
88@cindex C++ compilation options
89@xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90options for compiling C++ programs.
91
92@cindex grouping options
93@cindex options, grouping
94The @command{gcc} program accepts options and file names as operands. Many
95options have multi-letter names; therefore multiple single-letter options
96may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
97-r}}.
98
99@cindex order of options
100@cindex options, order
101You can mix options and other arguments. For the most part, the order
102you use doesn't matter. Order does matter when you use several options
103of the same kind; for example, if you specify @option{-L} more than once,
104the directories are searched in the order specified.
105
106Many options have long names starting with @samp{-f} or with
107@samp{-W}---for example, @option{-fforce-mem},
108@option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
109these have both positive and negative forms; the negative form of
110@option{-ffoo} would be @option{-fno-foo}. This manual documents
111only one of these two forms, whichever one is not the default.
112
113@c man end
114
115@xref{Option Index}, for an index to GCC's options.
116
117@menu
118* Option Summary:: Brief list of all options, without explanations.
119* Overall Options:: Controlling the kind of output:
120 an executable, object files, assembler files,
121 or preprocessed source.
122* Invoking G++:: Compiling C++ programs.
123* C Dialect Options:: Controlling the variant of C language compiled.
124* C++ Dialect Options:: Variations on C++.
125* Objective-C Dialect Options:: Variations on Objective-C.
126* Language Independent Options:: Controlling how diagnostics should be
127 formatted.
128* Warning Options:: How picky should the compiler be?
129* Debugging Options:: Symbol tables, measurements, and debugging dumps.
130* Optimize Options:: How much optimization?
131* Preprocessor Options:: Controlling header files and macro definitions.
132 Also, getting dependency information for Make.
133* Assembler Options:: Passing options to the assembler.
134* Link Options:: Specifying libraries and so on.
135* Directory Options:: Where to find header files and libraries.
136 Where to find the compiler executable files.
137* Spec Files:: How to pass switches to sub-processes.
138* Target Options:: Running a cross-compiler, or an old version of GCC.
139* Submodel Options:: Specifying minor hardware or convention variations,
140 such as 68010 vs 68020.
141* Code Gen Options:: Specifying conventions for function calls, data layout
142 and register usage.
143* Environment Variables:: Env vars that affect GCC.
144* Running Protoize:: Automatically adding or removing function prototypes.
145@end menu
146
147@c man begin OPTIONS
148
149@node Option Summary
150@section Option Summary
151
152Here is a summary of all the options, grouped by type. Explanations are
153in the following sections.
154
155@table @emph
156@item Overall Options
157@xref{Overall Options,,Options Controlling the Kind of Output}.
158@gccoptlist{
159-c -S -E -o @var{file} -pipe -pass-exit-codes -x @var{language} @gol
160-v -### --target-help --help}
161
162@item C Language Options
163@xref{C Dialect Options,,Options Controlling C Dialect}.
164@gccoptlist{
165-ansi -std=@var{standard} -aux-info @var{filename} @gol
166-fno-asm -fno-builtin -fno-builtin-@var{function} @gol
167-fhosted -ffreestanding -fms-extensions @gol
168-trigraphs -traditional -traditional-cpp @gol
169-fallow-single-precision -fcond-mismatch @gol
170-fsigned-bitfields -fsigned-char @gol
171-funsigned-bitfields -funsigned-char @gol
172-fwritable-strings -fshort-wchar}
173
174@item C++ Language Options
175@xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
176@gccoptlist{
177-fno-access-control -fcheck-new -fconserve-space @gol
178-fno-const-strings -fdollars-in-identifiers @gol
179-fno-elide-constructors @gol
180-fno-enforce-eh-specs -fexternal-templates @gol
181-falt-external-templates @gol
182-ffor-scope -fno-for-scope -fno-gnu-keywords @gol
183-fno-implicit-templates @gol
184-fno-implicit-inline-templates @gol
185-fno-implement-inlines -fms-extensions @gol
186-fno-nonansi-builtins -fno-operator-names @gol
187-fno-optional-diags -fpermissive @gol
188-frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
189-fuse-cxa-atexit -fvtable-gc -fno-weak -nostdinc++ @gol
190-fno-default-inline -Wctor-dtor-privacy @gol
191-Wnon-virtual-dtor -Wreorder @gol
192-Weffc++ -Wno-deprecated @gol
193-Wno-non-template-friend -Wold-style-cast @gol
194-Woverloaded-virtual -Wno-pmf-conversions @gol
195-Wsign-promo -Wsynth}
196
197@item Objective-C Language Options
198@xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
199@gccoptlist{
200-fconstant-string-class=@var{class-name} @gol
201-fgnu-runtime -fnext-runtime -gen-decls @gol
202-Wno-protocol -Wselector}
203
204@item Language Independent Options
205@xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
206@gccoptlist{
207-fmessage-length=@var{n} @gol
208-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209
210@item Warning Options
211@xref{Warning Options,,Options to Request or Suppress Warnings}.
212@gccoptlist{
213-fsyntax-only -pedantic -pedantic-errors @gol
214-w -W -Wall -Waggregate-return @gol
215-Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
216-Wconversion -Wno-deprecated-declarations @gol
217-Wdisabled-optimization -Wno-div-by-zero -Werror @gol
218-Wfloat-equal -Wformat -Wformat=2 @gol
219-Wformat-nonliteral -Wformat-security @gol
220-Wimplicit -Wimplicit-int @gol
221-Wimplicit-function-declaration @gol
222-Werror-implicit-function-declaration @gol
223-Wimport -Winline -Wno-endif-labels @gol
224-Wlarger-than-@var{len} -Wlong-long @gol
225-Wmain -Wmissing-braces -Wmissing-declarations @gol
226-Wmissing-format-attribute -Wmissing-noreturn @gol
227-Wno-multichar -Wno-format-extra-args -Wno-format-y2k @gol
228-Wno-import -Wnonnull -Wpacked -Wpadded @gol
229-Wparentheses -Wpointer-arith -Wredundant-decls @gol
230-Wreturn-type -Wsequence-point -Wshadow @gol
231-Wsign-compare -Wswitch -Wswitch-default -Wswitch-enum @gol
232-Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
233-Wunknown-pragmas -Wunreachable-code @gol
234-Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
235-Wunused-value -Wunused-variable -Wwrite-strings}
236
237@item C-only Warning Options
238@gccoptlist{
239-Wbad-function-cast -Wmissing-prototypes -Wnested-externs @gol
240-Wstrict-prototypes -Wtraditional}
241
242@item Debugging Options
243@xref{Debugging Options,,Options for Debugging Your Program or GCC}.
244@gccoptlist{
245-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
246-fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
247-fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
248-fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
249-fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
250-fmem-report @gol
251-fprofile-arcs -ftest-coverage -ftime-report @gol
252-g -g@var{level} -gcoff -gdwarf -gdwarf-1 -gdwarf-1+ -gdwarf-2 @gol
253-ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
254-p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
255-print-multi-directory -print-multi-lib @gol
256-print-prog-name=@var{program} -print-search-dirs -Q @gol
257-save-temps -time}
258
259@item Optimization Options
260@xref{Optimize Options,,Options that Control Optimization}.
261@gccoptlist{
262-falign-functions=@var{n} -falign-jumps=@var{n} @gol
263-falign-labels=@var{n} -falign-loops=@var{n} @gol
264-fbranch-probabilities -fcaller-saves -fcprop-registers @gol
265-fcse-follow-jumps -fcse-skip-blocks -fdata-sections @gol
266-fdelayed-branch -fdelete-null-pointer-checks @gol
267-fexpensive-optimizations -ffast-math -ffloat-store @gol
268-fforce-addr -fforce-mem -ffunction-sections @gol
269-fgcse -fgcse-lm -fgcse-sm -floop-optimize -fcrossjumping @gol
270-fif-conversion -fif-conversion2 @gol
271-finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
272-fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
273-fmove-all-movables -fnew-ra -fno-default-inline -fno-defer-pop @gol
274-fno-function-cse -fno-guess-branch-probability @gol
275-fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
276-funsafe-math-optimizations -ffinite-math-only -fno-trapping-math @gol
277-fno-zero-initialized-in-bss @gol
278-fomit-frame-pointer -foptimize-register-move @gol
279-foptimize-sibling-calls -fprefetch-loop-arrays @gol
280-freduce-all-givs -fregmove -frename-registers @gol
281-freorder-blocks -freorder-functions @gol
282-frerun-cse-after-loop -frerun-loop-opt @gol
283-fschedule-insns -fschedule-insns2 -fsignaling-nans @gol
284-fsingle-precision-constant -fssa -fssa-ccp -fssa-dce @gol
285-fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps -ftrapv @gol
286-funroll-all-loops -funroll-loops @gol
287--param @var{name}=@var{value}
288-O -O0 -O1 -O2 -O3 -Os}
289
290@item Preprocessor Options
291@xref{Preprocessor Options,,Options Controlling the Preprocessor}.
292@gccoptlist{
293-$ -A@var{question}=@var{answer} -A-@var{question}@r{[}=@var{answer}@r{]} @gol
294-C -dD -dI -dM -dN @gol
295-D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
296-idirafter @var{dir} @gol
297-include @var{file} -imacros @var{file} @gol
298-iprefix @var{file} -iwithprefix @var{dir} @gol
299-iwithprefixbefore @var{dir} -isystem @var{dir} @gol
300-M -MM -MF -MG -MP -MQ -MT -nostdinc -P -remap @gol
301-trigraphs -undef -U@var{macro} -Wp,@var{option}}
302
303@item Assembler Option
304@xref{Assembler Options,,Passing Options to the Assembler}.
305@gccoptlist{
306-Wa,@var{option}}
307
308@item Linker Options
309@xref{Link Options,,Options for Linking}.
310@gccoptlist{
311@var{object-file-name} -l@var{library} @gol
312-nostartfiles -nodefaultlibs -nostdlib @gol
313-s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
314-Wl,@var{option} -Xlinker @var{option} @gol
315-u @var{symbol}}
316
317@item Directory Options
318@xref{Directory Options,,Options for Directory Search}.
319@gccoptlist{
320-B@var{prefix} -I@var{dir} -I- -L@var{dir} -specs=@var{file}}
321
322@item Target Options
323@c I wrote this xref this way to avoid overfull hbox. -- rms
324@xref{Target Options}.
325@gccoptlist{
326-V @var{version} -b @var{machine}}
327
328@item Machine Dependent Options
329@xref{Submodel Options,,Hardware Models and Configurations}.
330
331@emph{M680x0 Options}
332@gccoptlist{
333-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
334-m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
335-mfpa -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
336-malign-int -mstrict-align}
337
338@emph{M68hc1x Options}
339@gccoptlist{
340-m6811 -m6812 -m68hc11 -m68hc12 @gol
341-mauto-incdec -mshort -msoft-reg-count=@var{count}}
342
343@emph{VAX Options}
344@gccoptlist{
345-mg -mgnu -munix}
346
347@emph{SPARC Options}
348@gccoptlist{
349-mcpu=@var{cpu-type} @gol
350-mtune=@var{cpu-type} @gol
351-mcmodel=@var{code-model} @gol
352-m32 -m64 @gol
353-mapp-regs -mbroken-saverestore -mcypress @gol
354-mfaster-structs -mflat @gol
355-mfpu -mhard-float -mhard-quad-float @gol
356-mimpure-text -mlive-g0 -mno-app-regs @gol
357-mno-faster-structs -mno-flat -mno-fpu @gol
358-mno-impure-text -mno-stack-bias -mno-unaligned-doubles @gol
359-msoft-float -msoft-quad-float -msparclite -mstack-bias @gol
360-msupersparc -munaligned-doubles -mv8}
361
362@emph{Convex Options}
363@gccoptlist{
364-mc1 -mc2 -mc32 -mc34 -mc38 @gol
365-margcount -mnoargcount @gol
366-mlong32 -mlong64 @gol
367-mvolatile-cache -mvolatile-nocache}
368
369@emph{AMD29K Options}
370@gccoptlist{
371-m29000 -m29050 -mbw -mnbw -mdw -mndw @gol
372-mlarge -mnormal -msmall @gol
373-mkernel-registers -mno-reuse-arg-regs @gol
374-mno-stack-check -mno-storem-bug @gol
375-mreuse-arg-regs -msoft-float -mstack-check @gol
376-mstorem-bug -muser-registers}
377
378@emph{ARM Options}
379@gccoptlist{
380-mapcs-frame -mno-apcs-frame @gol
381-mapcs-26 -mapcs-32 @gol
382-mapcs-stack-check -mno-apcs-stack-check @gol
383-mapcs-float -mno-apcs-float @gol
384-mapcs-reentrant -mno-apcs-reentrant @gol
385-msched-prolog -mno-sched-prolog @gol
386-mlittle-endian -mbig-endian -mwords-little-endian @gol
387-malignment-traps -mno-alignment-traps @gol
388-msoft-float -mhard-float -mfpe @gol
389-mthumb-interwork -mno-thumb-interwork @gol
390-mcpu=@var{name} -march=@var{name} -mfpe=@var{name} @gol
391-mstructure-size-boundary=@var{n} @gol
392-mbsd -mxopen -mno-symrename @gol
393-mabort-on-noreturn @gol
394-mlong-calls -mno-long-calls @gol
395-msingle-pic-base -mno-single-pic-base @gol
396-mpic-register=@var{reg} @gol
397-mnop-fun-dllimport @gol
398-mpoke-function-name @gol
399-mthumb -marm @gol
400-mtpcs-frame -mtpcs-leaf-frame @gol
401-mcaller-super-interworking -mcallee-super-interworking }
402
403@emph{MN10200 Options}
404@gccoptlist{
405-mrelax}
406
407@emph{MN10300 Options}
408@gccoptlist{
409-mmult-bug -mno-mult-bug @gol
410-mam33 -mno-am33 @gol
411-mno-crt0 -mrelax}
412
413@emph{M32R/D Options}
414@gccoptlist{
415-m32rx -m32r -mcode-model=@var{model-type} -msdata=@var{sdata-type} @gol
416-G @var{num}}
417
418@emph{M88K Options}
419@gccoptlist{
420-m88000 -m88100 -m88110 -mbig-pic @gol
421-mcheck-zero-division -mhandle-large-shift @gol
422-midentify-revision -mno-check-zero-division @gol
423-mno-ocs-debug-info -mno-ocs-frame-position @gol
424-mno-optimize-arg-area -mno-serialize-volatile @gol
425-mno-underscores -mocs-debug-info @gol
426-mocs-frame-position -moptimize-arg-area @gol
427-mserialize-volatile -mshort-data-@var{num} -msvr3 @gol
428-msvr4 -mtrap-large-shift -muse-div-instruction @gol
429-mversion-03.00 -mwarn-passed-structs}
430
431@emph{RS/6000 and PowerPC Options}
432@gccoptlist{
433-mcpu=@var{cpu-type} @gol
434-mtune=@var{cpu-type} @gol
435-mpower -mno-power -mpower2 -mno-power2 @gol
436-mpowerpc -mpowerpc64 -mno-powerpc @gol
437-maltivec -mno-altivec @gol
438-mpowerpc-gpopt -mno-powerpc-gpopt @gol
439-mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
440-mnew-mnemonics -mold-mnemonics @gol
441-mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
442-m64 -m32 -mxl-call -mno-xl-call -mpe @gol
443-msoft-float -mhard-float -mmultiple -mno-multiple @gol
444-mstring -mno-string -mupdate -mno-update @gol
445-mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
446-mstrict-align -mno-strict-align -mrelocatable @gol
447-mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
448-mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
449-mcall-aix -mcall-sysv -mcall-netbsd @gol
450-maix-struct-return -msvr4-struct-return
451-mabi=altivec -mabi=no-altivec @gol
452-mabi=spe -mabi=no-spe @gol
453-misel=yes -misel=no @gol
454-mprototype -mno-prototype @gol
455-msim -mmvme -mads -myellowknife -memb -msdata @gol
456-msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
457
458@emph{RT Options}
459@gccoptlist{
460-mcall-lib-mul -mfp-arg-in-fpregs -mfp-arg-in-gregs @gol
461-mfull-fp-blocks -mhc-struct-return -min-line-mul @gol
462-mminimum-fp-blocks -mnohc-struct-return}
463
464@emph{MIPS Options}
465@gccoptlist{
466-mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
467-mcpu=@var{cpu-type} -membedded-data -muninit-const-in-rodata @gol
468-membedded-pic -mfp32 -mfp64 -mfused-madd -mno-fused-madd @gol
469-mgas -mgp32 -mgp64 @gol
470-mgpopt -mhalf-pic -mhard-float -mint64 -mips1 @gol
471-mips2 -mips3 -mips4 -mlong64 -mlong32 -mlong-calls -mmemcpy @gol
472-mmips-as -mmips-tfile -mno-abicalls @gol
473-mno-embedded-data -mno-uninit-const-in-rodata @gol
474-mno-embedded-pic -mno-gpopt -mno-long-calls @gol
475-mno-memcpy -mno-mips-tfile -mno-rnames -mno-stats @gol
476-mrnames -msoft-float @gol
477-m4650 -msingle-float -mmad @gol
478-mstats -EL -EB -G @var{num} -nocpp @gol
479-mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
480-mfix7000 -mno-crt0 -mflush-func=@var{func} -mno-flush-func
481-mbranch-likely -mno-branch-likely}
482
483@emph{i386 and x86-64 Options}
484@gccoptlist{
485-mcpu=@var{cpu-type} -march=@var{cpu-type} -mfpmath=@var{unit} @gol
486-masm=@var{dialect} -mno-fancy-math-387 @gol
487-mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
488-mno-wide-multiply -mrtd -malign-double @gol
489-mpreferred-stack-boundary=@var{num} @gol
490-mmmx -msse -msse2 -msse-math -m3dnow @gol
491-mthreads -mno-align-stringops -minline-all-stringops @gol
492-mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
493-m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
494-mno-red-zone@gol
495-mcmodel=@var{code-model} @gol
496-m32 -m64}
497
498@emph{HPPA Options}
499@gccoptlist{
500-march=@var{architecture-type} @gol
501-mbig-switch -mdisable-fpregs -mdisable-indexing @gol
502-mfast-indirect-calls -mgas -mjump-in-delay @gol
503-mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
504-mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
505-mno-jump-in-delay -mno-long-load-store @gol
506-mno-portable-runtime -mno-soft-float @gol
507-mno-space-regs -msoft-float -mpa-risc-1-0 @gol
508-mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
509-mschedule=@var{cpu-type} -mspace-regs}
510
511@emph{Intel 960 Options}
512@gccoptlist{
513-m@var{cpu-type} -masm-compat -mclean-linkage @gol
514-mcode-align -mcomplex-addr -mleaf-procedures @gol
515-mic-compat -mic2.0-compat -mic3.0-compat @gol
516-mintel-asm -mno-clean-linkage -mno-code-align @gol
517-mno-complex-addr -mno-leaf-procedures @gol
518-mno-old-align -mno-strict-align -mno-tail-call @gol
519-mnumerics -mold-align -msoft-float -mstrict-align @gol
520-mtail-call}
521
522@emph{DEC Alpha Options}
523@gccoptlist{
524-mno-fp-regs -msoft-float -malpha-as -mgas @gol
525-mieee -mieee-with-inexact -mieee-conformant @gol
526-mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
527-mtrap-precision=@var{mode} -mbuild-constants @gol
528-mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
529-mbwx -mmax -mfix -mcix @gol
530-mfloat-vax -mfloat-ieee @gol
531-mexplicit-relocs -msmall-data -mlarge-data @gol
532-mmemory-latency=@var{time}}
533
534@emph{DEC Alpha/VMS Options}
535@gccoptlist{
536-mvms-return-codes}
537
538@emph{Clipper Options}
539@gccoptlist{
540-mc300 -mc400}
541
542@emph{H8/300 Options}
543@gccoptlist{
544-mrelax -mh -ms -mint32 -malign-300}
545
546@emph{SH Options}
547@gccoptlist{
548-m1 -m2 -m3 -m3e @gol
549-m4-nofpu -m4-single-only -m4-single -m4 @gol
550-m5-64media -m5-64media-nofpu @gol
551-m5-32media -m5-32media-nofpu @gol
552-m5-compact -m5-compact-nofpu @gol
553-mb -ml -mdalign -mrelax @gol
554-mbigtable -mfmovd -mhitachi -mnomacsave @gol
555-mieee -misize -mpadstruct -mspace @gol
556-mprefergot -musermode}
557
558@emph{System V Options}
559@gccoptlist{
560-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
561
562@emph{ARC Options}
563@gccoptlist{
564-EB -EL @gol
565-mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
566-mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
567
568@emph{TMS320C3x/C4x Options}
569@gccoptlist{
570-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
571-mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
572-mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
573-mparallel-insns -mparallel-mpy -mpreserve-float}
574
575@emph{V850 Options}
576@gccoptlist{
577-mlong-calls -mno-long-calls -mep -mno-ep @gol
578-mprolog-function -mno-prolog-function -mspace @gol
579-mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
580-mv850 -mbig-switch}
581
582@emph{NS32K Options}
583@gccoptlist{
584-m32032 -m32332 -m32532 -m32081 -m32381 @gol
585-mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
586-mregparam -mnoregparam -msb -mnosb @gol
587-mbitfield -mnobitfield -mhimem -mnohimem}
588
589@emph{AVR Options}
590@gccoptlist{
591-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
592-mcall-prologues -mno-tablejump -mtiny-stack}
593
594@emph{MCore Options}
595@gccoptlist{
596-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
597-mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
598-m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
599-mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
600-mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
601
602@emph{MMIX Options}
603@gccoptlist{
604-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
605-mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
606-melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
607-mno-base-addresses -msingle-exit -mno-single-exit}
608
609@emph{IA-64 Options}
610@gccoptlist{
611-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
612-mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
613-mconstant-gp -mauto-pic -minline-divide-min-latency @gol
614-minline-divide-max-throughput -mno-dwarf2-asm @gol
615-mfixed-range=@var{register-range}}
616
617@emph{D30V Options}
618@gccoptlist{
619-mextmem -mextmemory -monchip -mno-asm-optimize -masm-optimize @gol
620-mbranch-cost=@var{n} -mcond-exec=@var{n}}
621
622@emph{S/390 and zSeries Options}
623@gccoptlist{
624-mhard-float -msoft-float -mbackchain -mno-backchain @gol
625-msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
626-m64 -m31 -mdebug -mno-debug}
627
628@emph{CRIS Options}
629@gccoptlist{
630-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
631-mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
632-metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
633-mstack-align -mdata-align -mconst-align @gol
634-m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
635-melf -maout -melinux -mlinux -sim -sim2}
636
637@emph{PDP-11 Options}
638@gccoptlist{
639-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
640-mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
641-mint16 -mno-int32 -mfloat32 -mno-float64 @gol
642-mfloat64 -mno-float32 -mabshi -mno-abshi @gol
643-mbranch-expensive -mbranch-cheap @gol
644-msplit -mno-split -munix-asm -mdec-asm}
645
646@emph{Xstormy16 Options}
647@gccoptlist{
648-msim}
649
650@emph{Xtensa Options}
651@gccoptlist{
652-mbig-endian -mlittle-endian @gol
653-mdensity -mno-density @gol
654-mmac16 -mno-mac16 @gol
655-mmul16 -mno-mul16 @gol
656-mmul32 -mno-mul32 @gol
657-mnsa -mno-nsa @gol
658-mminmax -mno-minmax @gol
659-msext -mno-sext @gol
660-mbooleans -mno-booleans @gol
661-mhard-float -msoft-float @gol
662-mfused-madd -mno-fused-madd @gol
663-mserialize-volatile -mno-serialize-volatile @gol
664-mtext-section-literals -mno-text-section-literals @gol
665-mtarget-align -mno-target-align @gol
666-mlongcalls -mno-longcalls}
667
668@item Code Generation Options
669@xref{Code Gen Options,,Options for Code Generation Conventions}.
670@gccoptlist{
671-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
672-ffixed-@var{reg} -fexceptions @gol
673-fnon-call-exceptions -funwind-tables @gol
674-fasynchronous-unwind-tables @gol
675-finhibit-size-directive -finstrument-functions @gol
676-fno-common -fno-ident -fno-gnu-linker @gol
677-fpcc-struct-return -fpic -fPIC @gol
678-freg-struct-return -fshared-data -fshort-enums @gol
679-fshort-double -fvolatile @gol
680-fvolatile-global -fvolatile-static @gol
681-fverbose-asm -fpack-struct -fstack-check @gol
682-fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
683-fargument-alias -fargument-noalias @gol
684-fargument-noalias-global -fleading-underscore -ftls-model=@var{model}}
685@end table
686
687@menu
688* Overall Options:: Controlling the kind of output:
689 an executable, object files, assembler files,
690 or preprocessed source.
691* C Dialect Options:: Controlling the variant of C language compiled.
692* C++ Dialect Options:: Variations on C++.
693* Objective-C Dialect Options:: Variations on Objective-C.
694* Language Independent Options:: Controlling how diagnostics should be
695 formatted.
696* Warning Options:: How picky should the compiler be?
697* Debugging Options:: Symbol tables, measurements, and debugging dumps.
698* Optimize Options:: How much optimization?
699* Preprocessor Options:: Controlling header files and macro definitions.
700 Also, getting dependency information for Make.
701* Assembler Options:: Passing options to the assembler.
702* Link Options:: Specifying libraries and so on.
703* Directory Options:: Where to find header files and libraries.
704 Where to find the compiler executable files.
705* Spec Files:: How to pass switches to sub-processes.
706* Target Options:: Running a cross-compiler, or an old version of GCC.
707@end menu
708
709@node Overall Options
710@section Options Controlling the Kind of Output
711
712Compilation can involve up to four stages: preprocessing, compilation
713proper, assembly and linking, always in that order. The first three
714stages apply to an individual source file, and end by producing an
715object file; linking combines all the object files (those newly
716compiled, and those specified as input) into an executable file.
717
718@cindex file name suffix
719For any given input file, the file name suffix determines what kind of
720compilation is done:
721
722@table @gcctabopt
723@item @var{file}.c
724C source code which must be preprocessed.
725
726@item @var{file}.i
727C source code which should not be preprocessed.
728
729@item @var{file}.ii
730C++ source code which should not be preprocessed.
731
732@item @var{file}.m
733Objective-C source code. Note that you must link with the library
734@file{libobjc.a} to make an Objective-C program work.
735
736@item @var{file}.mi
737Objective-C source code which should not be preprocessed.
738
739@item @var{file}.h
740C header file (not to be compiled or linked).
741
742@item @var{file}.cc
743@itemx @var{file}.cp
744@itemx @var{file}.cxx
745@itemx @var{file}.cpp
746@itemx @var{file}.c++
747@itemx @var{file}.C
748C++ source code which must be preprocessed. Note that in @samp{.cxx},
749the last two letters must both be literally @samp{x}. Likewise,
750@samp{.C} refers to a literal capital C@.
751
752@item @var{file}.f
753@itemx @var{file}.for
754@itemx @var{file}.FOR
755Fortran source code which should not be preprocessed.
756
757@item @var{file}.F
758@itemx @var{file}.fpp
759@itemx @var{file}.FPP
760Fortran source code which must be preprocessed (with the traditional
761preprocessor).
762
763@item @var{file}.r
764Fortran source code which must be preprocessed with a RATFOR
765preprocessor (not included with GCC)@.
766
767@xref{Overall Options,,Options Controlling the Kind of Output, g77,
768Using and Porting GNU Fortran}, for more details of the handling of
769Fortran input files.
770
771@c FIXME: Descriptions of Java file types.
772@c @var{file}.java
773@c @var{file}.class
774@c @var{file}.zip
775@c @var{file}.jar
776
777@item @var{file}.ads
778Ada source code file which contains a library unit declaration (a
779declaration of a package, subprogram, or generic, or a generic
780instantiation), or a library unit renaming declaration (a package,
781generic, or subprogram renaming declaration). Such files are also
782called @dfn{specs}.
783
784@itemx @var{file}.adb
785Ada source code file containing a library unit body (a subprogram or
786package body). Such files are also called @dfn{bodies}.
787
788@c GCC also knows about some suffixes for languages not yet included:
789@c Pascal:
790@c @var{file}.p
791@c @var{file}.pas
792
793@item @var{file}.s
794Assembler code.
795
796@item @var{file}.S
797Assembler code which must be preprocessed.
798
799@item @var{other}
800An object file to be fed straight into linking.
801Any file name with no recognized suffix is treated this way.
802@end table
803
804@opindex x
805You can specify the input language explicitly with the @option{-x} option:
806
807@table @gcctabopt
808@item -x @var{language}
809Specify explicitly the @var{language} for the following input files
810(rather than letting the compiler choose a default based on the file
811name suffix). This option applies to all following input files until
812the next @option{-x} option. Possible values for @var{language} are:
813@example
814c c-header cpp-output
815c++ c++-cpp-output
816objective-c objc-cpp-output
817assembler assembler-with-cpp
818ada
819f77 f77-cpp-input ratfor
820java
821treelang
822@end example
823
824@item -x none
825Turn off any specification of a language, so that subsequent files are
826handled according to their file name suffixes (as they are if @option{-x}
827has not been used at all).
828
829@item -pass-exit-codes
830@opindex pass-exit-codes
831Normally the @command{gcc} program will exit with the code of 1 if any
832phase of the compiler returns a non-success return code. If you specify
833@option{-pass-exit-codes}, the @command{gcc} program will instead return with
834numerically highest error produced by any phase that returned an error
835indication.
836@end table
837
838If you only want some of the stages of compilation, you can use
839@option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
840one of the options @option{-c}, @option{-S}, or @option{-E} to say where
841@command{gcc} is to stop. Note that some combinations (for example,
842@samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
843
844@table @gcctabopt
845@item -c
846@opindex c
847Compile or assemble the source files, but do not link. The linking
848stage simply is not done. The ultimate output is in the form of an
849object file for each source file.
850
851By default, the object file name for a source file is made by replacing
852the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
853
854Unrecognized input files, not requiring compilation or assembly, are
855ignored.
856
857@item -S
858@opindex S
859Stop after the stage of compilation proper; do not assemble. The output
860is in the form of an assembler code file for each non-assembler input
861file specified.
862
863By default, the assembler file name for a source file is made by
864replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
865
866Input files that don't require compilation are ignored.
867
868@item -E
869@opindex E
870Stop after the preprocessing stage; do not run the compiler proper. The
871output is in the form of preprocessed source code, which is sent to the
872standard output.
873
874Input files which don't require preprocessing are ignored.
875
876@cindex output file option
877@item -o @var{file}
878@opindex o
879Place output in file @var{file}. This applies regardless to whatever
880sort of output is being produced, whether it be an executable file,
881an object file, an assembler file or preprocessed C code.
882
883Since only one output file can be specified, it does not make sense to
884use @option{-o} when compiling more than one input file, unless you are
885producing an executable file as output.
886
887If @option{-o} is not specified, the default is to put an executable file
888in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
889@file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
890all preprocessed C source on standard output.
891
892@item -v
893@opindex v
894Print (on standard error output) the commands executed to run the stages
895of compilation. Also print the version number of the compiler driver
896program and of the preprocessor and the compiler proper.
897
898@item -###
899@opindex ###
900Like @option{-v} except the commands are not executed and all command
901arguments are quoted. This is useful for shell scripts to capture the
902driver-generated command lines.
903
904@item -pipe
905@opindex pipe
906Use pipes rather than temporary files for communication between the
907various stages of compilation. This fails to work on some systems where
908the assembler is unable to read from a pipe; but the GNU assembler has
909no trouble.
910
911@item --help
912@opindex help
913Print (on the standard output) a description of the command line options
914understood by @command{gcc}. If the @option{-v} option is also specified
915then @option{--help} will also be passed on to the various processes
916invoked by @command{gcc}, so that they can display the command line options
917they accept. If the @option{-W} option is also specified then command
918line options which have no documentation associated with them will also
919be displayed.
920
921@item --target-help
922@opindex target-help
923Print (on the standard output) a description of target specific command
924line options for each tool.
925@end table
926
927@node Invoking G++
928@section Compiling C++ Programs
929
930@cindex suffixes for C++ source
931@cindex C++ source file suffixes
932C++ source files conventionally use one of the suffixes @samp{.C},
933@samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
934preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
935files with these names and compiles them as C++ programs even if you
936call the compiler the same way as for compiling C programs (usually with
937the name @command{gcc}).
938
939@findex g++
940@findex c++
941However, C++ programs often require class libraries as well as a
942compiler that understands the C++ language---and under some
943circumstances, you might want to compile programs from standard input,
944or otherwise without a suffix that flags them as C++ programs.
945@command{g++} is a program that calls GCC with the default language
946set to C++, and automatically specifies linking against the C++
947library. On many systems, @command{g++} is also
948installed with the name @command{c++}.
949
950@cindex invoking @command{g++}
951When you compile C++ programs, you may specify many of the same
952command-line options that you use for compiling programs in any
953language; or command-line options meaningful for C and related
954languages; or options that are meaningful only for C++ programs.
955@xref{C Dialect Options,,Options Controlling C Dialect}, for
956explanations of options for languages related to C@.
957@xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
958explanations of options that are meaningful only for C++ programs.
959
960@node C Dialect Options
961@section Options Controlling C Dialect
962@cindex dialect options
963@cindex language dialect options
964@cindex options, dialect
965
966The following options control the dialect of C (or languages derived
967from C, such as C++ and Objective-C) that the compiler accepts:
968
969@table @gcctabopt
970@cindex ANSI support
971@cindex ISO support
972@item -ansi
973@opindex ansi
974In C mode, support all ISO C90 programs. In C++ mode,
975remove GNU extensions that conflict with ISO C++.
976
977This turns off certain features of GCC that are incompatible with ISO
978C90 (when compiling C code), or of standard C++ (when compiling C++ code),
979such as the @code{asm} and @code{typeof} keywords, and
980predefined macros such as @code{unix} and @code{vax} that identify the
981type of system you are using. It also enables the undesirable and
982rarely used ISO trigraph feature. For the C compiler,
983it disables recognition of C++ style @samp{//} comments as well as
984the @code{inline} keyword.
985
986The alternate keywords @code{__asm__}, @code{__extension__},
987@code{__inline__} and @code{__typeof__} continue to work despite
988@option{-ansi}. You would not want to use them in an ISO C program, of
989course, but it is useful to put them in header files that might be included
990in compilations done with @option{-ansi}. Alternate predefined macros
991such as @code{__unix__} and @code{__vax__} are also available, with or
992without @option{-ansi}.
993
994The @option{-ansi} option does not cause non-ISO programs to be
995rejected gratuitously. For that, @option{-pedantic} is required in
996addition to @option{-ansi}. @xref{Warning Options}.
997
998The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
999option is used. Some header files may notice this macro and refrain
1000from declaring certain functions or defining certain macros that the
1001ISO standard doesn't call for; this is to avoid interfering with any
1002programs that might use these names for other things.
1003
1004Functions which would normally be built in but do not have semantics
1005defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1006functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1007built-in functions provided by GCC}, for details of the functions
1008affected.
1009
1010@item -std=
1011@opindex std
1012Determine the language standard. This option is currently only
1013supported when compiling C or C++. A value for this option must be
1014provided; possible values are
1015
1016@table @samp
1017@item c89
1018@itemx iso9899:1990
1019ISO C90 (same as @option{-ansi}).
1020
1021@item iso9899:199409
1022ISO C90 as modified in amendment 1.
1023
1024@item c99
1025@itemx c9x
1026@itemx iso9899:1999
1027@itemx iso9899:199x
1028ISO C99. Note that this standard is not yet fully supported; see
1029@w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1030names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1031
1032@item gnu89
1033Default, ISO C90 plus GNU extensions (including some C99 features).
1034
1035@item gnu99
1036@item gnu9x
1037ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1038this will become the default. The name @samp{gnu9x} is deprecated.
1039
1040@item c++98
1041The 1998 ISO C++ standard plus amendments.
1042
1043@item gnu++98
1044The same as @option{-std=c++98} plus GNU extensions. This is the
1045default for C++ code.
1046@end table
1047
1048Even when this option is not specified, you can still use some of the
1049features of newer standards in so far as they do not conflict with
1050previous C standards. For example, you may use @code{__restrict__} even
1051when @option{-std=c99} is not specified.
1052
1053The @option{-std} options specifying some version of ISO C have the same
1054effects as @option{-ansi}, except that features that were not in ISO C90
1055but are in the specified version (for example, @samp{//} comments and
1056the @code{inline} keyword in ISO C99) are not disabled.
1057
1058@xref{Standards,,Language Standards Supported by GCC}, for details of
1059these standard versions.
1060
1061@item -aux-info @var{filename}
1062@opindex aux-info
1063Output to the given filename prototyped declarations for all functions
1064declared and/or defined in a translation unit, including those in header
1065files. This option is silently ignored in any language other than C@.
1066
1067Besides declarations, the file indicates, in comments, the origin of
1068each declaration (source file and line), whether the declaration was
1069implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1070@samp{O} for old, respectively, in the first character after the line
1071number and the colon), and whether it came from a declaration or a
1072definition (@samp{C} or @samp{F}, respectively, in the following
1073character). In the case of function definitions, a K&R-style list of
1074arguments followed by their declarations is also provided, inside
1075comments, after the declaration.
1076
1077@item -fno-asm
1078@opindex fno-asm
1079Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1080keyword, so that code can use these words as identifiers. You can use
1081the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1082instead. @option{-ansi} implies @option{-fno-asm}.
1083
1084In C++, this switch only affects the @code{typeof} keyword, since
1085@code{asm} and @code{inline} are standard keywords. You may want to
1086use the @option{-fno-gnu-keywords} flag instead, which has the same
1087effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1088switch only affects the @code{asm} and @code{typeof} keywords, since
1089@code{inline} is a standard keyword in ISO C99.
1090
1091@item -fno-builtin
1092@itemx -fno-builtin-@var{function}
1093@opindex fno-builtin
1094@cindex built-in functions
1095Don't recognize built-in functions that do not begin with
1096@samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1097functions provided by GCC}, for details of the functions affected,
1098including those which are not built-in functions when @option{-ansi} or
1099@option{-std} options for strict ISO C conformance are used because they
1100do not have an ISO standard meaning.
1101
1102GCC normally generates special code to handle certain built-in functions
1103more efficiently; for instance, calls to @code{alloca} may become single
1104instructions that adjust the stack directly, and calls to @code{memcpy}
1105may become inline copy loops. The resulting code is often both smaller
1106and faster, but since the function calls no longer appear as such, you
1107cannot set a breakpoint on those calls, nor can you change the behavior
1108of the functions by linking with a different library.
1109
1110With the @option{-fno-builtin-@var{function}} option
1111only the built-in function @var{function} is
1112disabled. @var{function} must not begin with @samp{__builtin_}. If a
1113function is named this is not built-in in this version of GCC, this
1114option is ignored. There is no corresponding
1115@option{-fbuiltin-@var{function}} option; if you wish to enable
1116built-in functions selectively when using @option{-fno-builtin} or
1117@option{-ffreestanding}, you may define macros such as:
1118
1119@smallexample
1120#define abs(n) __builtin_abs ((n))
1121#define strcpy(d, s) __builtin_strcpy ((d), (s))
1122@end smallexample
1123
1124@item -fhosted
1125@opindex fhosted
1126@cindex hosted environment
1127
1128Assert that compilation takes place in a hosted environment. This implies
1129@option{-fbuiltin}. A hosted environment is one in which the
1130entire standard library is available, and in which @code{main} has a return
1131type of @code{int}. Examples are nearly everything except a kernel.
1132This is equivalent to @option{-fno-freestanding}.
1133
1134@item -ffreestanding
1135@opindex ffreestanding
1136@cindex hosted environment
1137
1138Assert that compilation takes place in a freestanding environment. This
1139implies @option{-fno-builtin}. A freestanding environment
1140is one in which the standard library may not exist, and program startup may
1141not necessarily be at @code{main}. The most obvious example is an OS kernel.
1142This is equivalent to @option{-fno-hosted}.
1143
1144@xref{Standards,,Language Standards Supported by GCC}, for details of
1145freestanding and hosted environments.
1146
1147@item -fms-extensions
1148@opindex fms-extensions
1149Accept some non-standard constructs used in Microsoft header files.
1150
1151@item -trigraphs
1152@opindex trigraphs
1153Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1154options for strict ISO C conformance) implies @option{-trigraphs}.
1155
1156@cindex traditional C language
1157@cindex C language, traditional
1158@item -traditional
1159@itemx -traditional-cpp
1160@opindex traditional-cpp
1161@opindex traditional
1162Formerly, these options caused GCC to attempt to emulate a pre-standard
1163C compiler. They are now only supported with the @option{-E} switch.
1164The preprocessor continues to support a pre-standard mode. See the GNU
1165CPP manual for details.
1166
1167@item -fcond-mismatch
1168@opindex fcond-mismatch
1169Allow conditional expressions with mismatched types in the second and
1170third arguments. The value of such an expression is void. This option
1171is not supported for C++.
1172
1173@item -funsigned-char
1174@opindex funsigned-char
1175Let the type @code{char} be unsigned, like @code{unsigned char}.
1176
1177Each kind of machine has a default for what @code{char} should
1178be. It is either like @code{unsigned char} by default or like
1179@code{signed char} by default.
1180
1181Ideally, a portable program should always use @code{signed char} or
1182@code{unsigned char} when it depends on the signedness of an object.
1183But many programs have been written to use plain @code{char} and
1184expect it to be signed, or expect it to be unsigned, depending on the
1185machines they were written for. This option, and its inverse, let you
1186make such a program work with the opposite default.
1187
1188The type @code{char} is always a distinct type from each of
1189@code{signed char} or @code{unsigned char}, even though its behavior
1190is always just like one of those two.
1191
1192@item -fsigned-char
1193@opindex fsigned-char
1194Let the type @code{char} be signed, like @code{signed char}.
1195
1196Note that this is equivalent to @option{-fno-unsigned-char}, which is
1197the negative form of @option{-funsigned-char}. Likewise, the option
1198@option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1199
1200@item -fsigned-bitfields
1201@itemx -funsigned-bitfields
1202@itemx -fno-signed-bitfields
1203@itemx -fno-unsigned-bitfields
1204@opindex fsigned-bitfields
1205@opindex funsigned-bitfields
1206@opindex fno-signed-bitfields
1207@opindex fno-unsigned-bitfields
1208These options control whether a bit-field is signed or unsigned, when the
1209declaration does not use either @code{signed} or @code{unsigned}. By
1210default, such a bit-field is signed, because this is consistent: the
1211basic integer types such as @code{int} are signed types.
1212
1213@item -fwritable-strings
1214@opindex fwritable-strings
1215Store string constants in the writable data segment and don't uniquize
1216them. This is for compatibility with old programs which assume they can
1217write into string constants.
1218
1219Writing into string constants is a very bad idea; ``constants'' should
1220be constant.
1221
1222@item -fshort-wchar
1223@opindex fshort-wchar
1224Override the underlying type for @samp{wchar_t} to be @samp{short
1225unsigned int} instead of the default for the target. This option is
1226useful for building programs to run under WINE@.
1227@end table
1228
1229@node C++ Dialect Options
1230@section Options Controlling C++ Dialect
1231
1232@cindex compiler options, C++
1233@cindex C++ options, command line
1234@cindex options, C++
1235This section describes the command-line options that are only meaningful
1236for C++ programs; but you can also use most of the GNU compiler options
1237regardless of what language your program is in. For example, you
1238might compile a file @code{firstClass.C} like this:
1239
1240@example
1241g++ -g -frepo -O -c firstClass.C
1242@end example
1243
1244@noindent
1245In this example, only @option{-frepo} is an option meant
1246only for C++ programs; you can use the other options with any
1247language supported by GCC@.
1248
1249Here is a list of options that are @emph{only} for compiling C++ programs:
1250
1251@table @gcctabopt
1252@item -fno-access-control
1253@opindex fno-access-control
1254Turn off all access checking. This switch is mainly useful for working
1255around bugs in the access control code.
1256
1257@item -fcheck-new
1258@opindex fcheck-new
1259Check that the pointer returned by @code{operator new} is non-null
1260before attempting to modify the storage allocated. The current Working
1261Paper requires that @code{operator new} never return a null pointer, so
1262this check is normally unnecessary.
1263
1264An alternative to using this option is to specify that your
1265@code{operator new} does not throw any exceptions; if you declare it
1266@samp{throw()}, G++ will check the return value. See also @samp{new
1267(nothrow)}.
1268
1269@item -fconserve-space
1270@opindex fconserve-space
1271Put uninitialized or runtime-initialized global variables into the
1272common segment, as C does. This saves space in the executable at the
1273cost of not diagnosing duplicate definitions. If you compile with this
1274flag and your program mysteriously crashes after @code{main()} has
1275completed, you may have an object that is being destroyed twice because
1276two definitions were merged.
1277
1278This option is no longer useful on most targets, now that support has
1279been added for putting variables into BSS without making them common.
1280
1281@item -fno-const-strings
1282@opindex fno-const-strings
1283Give string constants type @code{char *} instead of type @code{const
1284char *}. By default, G++ uses type @code{const char *} as required by
1285the standard. Even if you use @option{-fno-const-strings}, you cannot
1286actually modify the value of a string constant, unless you also use
1287@option{-fwritable-strings}.
1288
1289This option might be removed in a future release of G++. For maximum
1290portability, you should structure your code so that it works with
1291string constants that have type @code{const char *}.
1292
1293@item -fdollars-in-identifiers
1294@opindex fdollars-in-identifiers
1295Accept @samp{$} in identifiers. You can also explicitly prohibit use of
1296@samp{$} with the option @option{-fno-dollars-in-identifiers}. (GNU C allows
1297@samp{$} by default on most target systems, but there are a few exceptions.)
1298Traditional C allowed the character @samp{$} to form part of
1299identifiers. However, ISO C and C++ forbid @samp{$} in identifiers.
1300
1301@item -fno-elide-constructors
1302@opindex fno-elide-constructors
1303The C++ standard allows an implementation to omit creating a temporary
1304which is only used to initialize another object of the same type.
1305Specifying this option disables that optimization, and forces G++ to
1306call the copy constructor in all cases.
1307
1308@item -fno-enforce-eh-specs
1309@opindex fno-enforce-eh-specs
1310Don't check for violation of exception specifications at runtime. This
1311option violates the C++ standard, but may be useful for reducing code
1312size in production builds, much like defining @samp{NDEBUG}. The compiler
1313will still optimize based on the exception specifications.
1314
1315@item -fexternal-templates
1316@opindex fexternal-templates
1317
1318Cause @samp{#pragma interface} and @samp{implementation} to apply to
1319template instantiation; template instances are emitted or not according
1320to the location of the template definition. @xref{Template
1321Instantiation}, for more information.
1322
1323This option is deprecated.
1324
1325@item -falt-external-templates
1326@opindex falt-external-templates
1327Similar to @option{-fexternal-templates}, but template instances are
1328emitted or not according to the place where they are first instantiated.
1329@xref{Template Instantiation}, for more information.
1330
1331This option is deprecated.
1332
1333@item -ffor-scope
1334@itemx -fno-for-scope
1335@opindex ffor-scope
1336@opindex fno-for-scope
1337If @option{-ffor-scope} is specified, the scope of variables declared in
1338a @i{for-init-statement} is limited to the @samp{for} loop itself,
1339as specified by the C++ standard.
1340If @option{-fno-for-scope} is specified, the scope of variables declared in
1341a @i{for-init-statement} extends to the end of the enclosing scope,
1342as was the case in old versions of G++, and other (traditional)
1343implementations of C++.
1344
1345The default if neither flag is given to follow the standard,
1346but to allow and give a warning for old-style code that would
1347otherwise be invalid, or have different behavior.
1348
1349@item -fno-gnu-keywords
1350@opindex fno-gnu-keywords
1351Do not recognize @code{typeof} as a keyword, so that code can use this
1352word as an identifier. You can use the keyword @code{__typeof__} instead.
1353@option{-ansi} implies @option{-fno-gnu-keywords}.
1354
1355@item -fno-implicit-templates
1356@opindex fno-implicit-templates
1357Never emit code for non-inline templates which are instantiated
1358implicitly (i.e.@: by use); only emit code for explicit instantiations.
1359@xref{Template Instantiation}, for more information.
1360
1361@item -fno-implicit-inline-templates
1362@opindex fno-implicit-inline-templates
1363Don't emit code for implicit instantiations of inline templates, either.
1364The default is to handle inlines differently so that compiles with and
1365without optimization will need the same set of explicit instantiations.
1366
1367@item -fno-implement-inlines
1368@opindex fno-implement-inlines
1369To save space, do not emit out-of-line copies of inline functions
1370controlled by @samp{#pragma implementation}. This will cause linker
1371errors if these functions are not inlined everywhere they are called.
1372
1373@item -fms-extensions
1374@opindex fms-extensions
1375Disable pedantic warnings about constructs used in MFC, such as implicit
1376int and getting a pointer to member function via non-standard syntax.
1377
1378@item -fno-nonansi-builtins
1379@opindex fno-nonansi-builtins
1380Disable built-in declarations of functions that are not mandated by
1381ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1382@code{index}, @code{bzero}, @code{conjf}, and other related functions.
1383
1384@item -fno-operator-names
1385@opindex fno-operator-names
1386Do not treat the operator name keywords @code{and}, @code{bitand},
1387@code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1388synonyms as keywords.
1389
1390@item -fno-optional-diags
1391@opindex fno-optional-diags
1392Disable diagnostics that the standard says a compiler does not need to
1393issue. Currently, the only such diagnostic issued by G++ is the one for
1394a name having multiple meanings within a class.
1395
1396@item -fpermissive
1397@opindex fpermissive
1398Downgrade messages about nonconformant code from errors to warnings. By
1399default, G++ effectively sets @option{-pedantic-errors} without
1400@option{-pedantic}; this option reverses that. This behavior and this
1401option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1402
1403@item -frepo
1404@opindex frepo
1405Enable automatic template instantiation at link time. This option also
1406implies @option{-fno-implicit-templates}. @xref{Template
1407Instantiation}, for more information.
1408
1409@item -fno-rtti
1410@opindex fno-rtti
1411Disable generation of information about every class with virtual
1412functions for use by the C++ runtime type identification features
1413(@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1414of the language, you can save some space by using this flag. Note that
1415exception handling uses the same information, but it will generate it as
1416needed.
1417
1418@item -fstats
1419@opindex fstats
1420Emit statistics about front-end processing at the end of the compilation.
1421This information is generally only useful to the G++ development team.
1422
1423@item -ftemplate-depth-@var{n}
1424@opindex ftemplate-depth
1425Set the maximum instantiation depth for template classes to @var{n}.
1426A limit on the template instantiation depth is needed to detect
1427endless recursions during template class instantiation. ANSI/ISO C++
1428conforming programs must not rely on a maximum depth greater than 17.
1429
1430@item -fuse-cxa-atexit
1431@opindex fuse-cxa-atexit
1432Register destructors for objects with static storage duration with the
1433@code{__cxa_atexit} function rather than the @code{atexit} function.
1434This option is required for fully standards-compliant handling of static
1435destructors, but will only work if your C library supports
1436@code{__cxa_atexit}.
1437
1438@item -fvtable-gc
1439@opindex fvtable-gc
1440Emit special relocations for vtables and virtual function references
1441so that the linker can identify unused virtual functions and zero out
1442vtable slots that refer to them. This is most useful with
1443@option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1444also discard the functions themselves.
1445
1446This optimization requires GNU as and GNU ld. Not all systems support
1447this option. @option{-Wl,--gc-sections} is ignored without @option{-static}.
1448
1449@item -fno-weak
1450@opindex fno-weak
1451Do not use weak symbol support, even if it is provided by the linker.
1452By default, G++ will use weak symbols if they are available. This
1453option exists only for testing, and should not be used by end-users;
1454it will result in inferior code and has no benefits. This option may
1455be removed in a future release of G++.
1456
1457@item -nostdinc++
1458@opindex nostdinc++
1459Do not search for header files in the standard directories specific to
1460C++, but do still search the other standard directories. (This option
1461is used when building the C++ library.)
1462@end table
1463
1464In addition, these optimization, warning, and code generation options
1465have meanings only for C++ programs:
1466
1467@table @gcctabopt
1468@item -fno-default-inline
1469@opindex fno-default-inline
1470Do not assume @samp{inline} for functions defined inside a class scope.
1471@xref{Optimize Options,,Options That Control Optimization}. Note that these
1472functions will have linkage like inline functions; they just won't be
1473inlined by default.
1474
1475@item -Wctor-dtor-privacy @r{(C++ only)}
1476@opindex Wctor-dtor-privacy
1477Warn when a class seems unusable, because all the constructors or
1478destructors in a class are private and the class has no friends or
1479public static member functions.
1480
1481@item -Wnon-virtual-dtor @r{(C++ only)}
1482@opindex Wnon-virtual-dtor
1483Warn when a class declares a non-virtual destructor that should probably
1484be virtual, because it looks like the class will be used polymorphically.
1485
1486@item -Wreorder @r{(C++ only)}
1487@opindex Wreorder
1488@cindex reordering, warning
1489@cindex warning for reordering of member initializers
1490Warn when the order of member initializers given in the code does not
1491match the order in which they must be executed. For instance:
1492
1493@smallexample
1494struct A @{
1495 int i;
1496 int j;
1497 A(): j (0), i (1) @{ @}
1498@};
1499@end smallexample
1500
1501Here the compiler will warn that the member initializers for @samp{i}
1502and @samp{j} will be rearranged to match the declaration order of the
1503members.
1504@end table
1505
1506The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1507
1508@table @gcctabopt
1509@item -Weffc++ @r{(C++ only)}
1510@opindex Weffc++
1511Warn about violations of the following style guidelines from Scott Meyers'
1512@cite{Effective C++} book:
1513
1514@itemize @bullet
1515@item
1516Item 11: Define a copy constructor and an assignment operator for classes
1517with dynamically allocated memory.
1518
1519@item
1520Item 12: Prefer initialization to assignment in constructors.
1521
1522@item
1523Item 14: Make destructors virtual in base classes.
1524
1525@item
1526Item 15: Have @code{operator=} return a reference to @code{*this}.
1527
1528@item
1529Item 23: Don't try to return a reference when you must return an object.
1530
1531@end itemize
1532
1533and about violations of the following style guidelines from Scott Meyers'
1534@cite{More Effective C++} book:
1535
1536@itemize @bullet
1537@item
1538Item 6: Distinguish between prefix and postfix forms of increment and
1539decrement operators.
1540
1541@item
1542Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1543
1544@end itemize
1545
1546If you use this option, you should be aware that the standard library
1547headers do not obey all of these guidelines; you can use @samp{grep -v}
1548to filter out those warnings.
1549
1550@item -Wno-deprecated @r{(C++ only)}
1551@opindex Wno-deprecated
1552Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1553
1554@item -Wno-non-template-friend @r{(C++ only)}
1555@opindex Wno-non-template-friend
1556Disable warnings when non-templatized friend functions are declared
1557within a template. With the advent of explicit template specification
1558support in G++, if the name of the friend is an unqualified-id (i.e.,
1559@samp{friend foo(int)}), the C++ language specification demands that the
1560friend declare or define an ordinary, nontemplate function. (Section
156114.5.3). Before G++ implemented explicit specification, unqualified-ids
1562could be interpreted as a particular specialization of a templatized
1563function. Because this non-conforming behavior is no longer the default
1564behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1565check existing code for potential trouble spots, and is on by default.
1566This new compiler behavior can be turned off with
1567@option{-Wno-non-template-friend} which keeps the conformant compiler code
1568but disables the helpful warning.
1569
1570@item -Wold-style-cast @r{(C++ only)}
1571@opindex Wold-style-cast
1572Warn if an old-style (C-style) cast to a non-void type is used within
1573a C++ program. The new-style casts (@samp{static_cast},
1574@samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1575unintended effects, and much easier to grep for.
1576
1577@item -Woverloaded-virtual @r{(C++ only)}
1578@opindex Woverloaded-virtual
1579@cindex overloaded virtual fn, warning
1580@cindex warning for overloaded virtual fn
1581Warn when a function declaration hides virtual functions from a
1582base class. For example, in:
1583
1584@smallexample
1585struct A @{
1586 virtual void f();
1587@};
1588
1589struct B: public A @{
1590 void f(int);
1591@};
1592@end smallexample
1593
1594the @code{A} class version of @code{f} is hidden in @code{B}, and code
1595like this:
1596
1597@smallexample
1598B* b;
1599b->f();
1600@end smallexample
1601
1602will fail to compile.
1603
1604@item -Wno-pmf-conversions @r{(C++ only)}
1605@opindex Wno-pmf-conversions
1606Disable the diagnostic for converting a bound pointer to member function
1607to a plain pointer.
1608
1609@item -Wsign-promo @r{(C++ only)}
1610@opindex Wsign-promo
1611Warn when overload resolution chooses a promotion from unsigned or
1612enumeral type to a signed type over a conversion to an unsigned type of
1613the same size. Previous versions of G++ would try to preserve
1614unsignedness, but the standard mandates the current behavior.
1615
1616@item -Wsynth @r{(C++ only)}
1617@opindex Wsynth
1618@cindex warning for synthesized methods
1619@cindex synthesized methods, warning
1620Warn when G++'s synthesis behavior does not match that of cfront. For
1621instance:
1622
1623@smallexample
1624struct A @{
1625 operator int ();
1626 A& operator = (int);
1627@};
1628
1629main ()
1630@{
1631 A a,b;
1632 a = b;
1633@}
1634@end smallexample
1635
1636In this example, G++ will synthesize a default @samp{A& operator =
1637(const A&);}, while cfront will use the user-defined @samp{operator =}.
1638@end table
1639
1640@node Objective-C Dialect Options
1641@section Options Controlling Objective-C Dialect
1642
1643@cindex compiler options, Objective-C
1644@cindex Objective-C options, command line
1645@cindex options, Objective-C
1646This section describes the command-line options that are only meaningful
1647for Objective-C programs; but you can also use most of the GNU compiler
1648options regardless of what language your program is in. For example,
1649you might compile a file @code{some_class.m} like this:
1650
1651@example
1652gcc -g -fgnu-runtime -O -c some_class.m
1653@end example
1654
1655@noindent
1656In this example, only @option{-fgnu-runtime} is an option meant only for
1657Objective-C programs; you can use the other options with any language
1658supported by GCC@.
1659
1660Here is a list of options that are @emph{only} for compiling Objective-C
1661programs:
1662
1663@table @gcctabopt
1664@item -fconstant-string-class=@var{class-name}
1665@opindex fconstant-string-class
1666Use @var{class-name} as the name of the class to instantiate for each
1667literal string specified with the syntax @code{@@"@dots{}"}. The default
1668class name is @code{NXConstantString}.
1669
1670@item -fgnu-runtime
1671@opindex fgnu-runtime
1672Generate object code compatible with the standard GNU Objective-C
1673runtime. This is the default for most types of systems.
1674
1675@item -fnext-runtime
1676@opindex fnext-runtime
1677Generate output compatible with the NeXT runtime. This is the default
1678for NeXT-based systems, including Darwin and Mac OS X@.
1679
1680@item -gen-decls
1681@opindex gen-decls
1682Dump interface declarations for all classes seen in the source file to a
1683file named @file{@var{sourcename}.decl}.
1684
1685@item -Wno-protocol
1686@opindex Wno-protocol
1687Do not warn if methods required by a protocol are not implemented
1688in the class adopting it.
1689
1690@item -Wselector
1691@opindex Wselector
1692Warn if a selector has multiple methods of different types defined.
1693
1694@c not documented because only avail via -Wp
1695@c @item -print-objc-runtime-info
1696
1697@end table
1698
1699@node Language Independent Options
1700@section Options to Control Diagnostic Messages Formatting
1701@cindex options to control diagnostics formatting
1702@cindex diagnostic messages
1703@cindex message formatting
1704
1705Traditionally, diagnostic messages have been formatted irrespective of
1706the output device's aspect (e.g.@: its width, @dots{}). The options described
1707below can be used to control the diagnostic messages formatting
1708algorithm, e.g.@: how many characters per line, how often source location
1709information should be reported. Right now, only the C++ front end can
1710honor these options. However it is expected, in the near future, that
1711the remaining front ends would be able to digest them correctly.
1712
1713@table @gcctabopt
1714@item -fmessage-length=@var{n}
1715@opindex fmessage-length
1716Try to format error messages so that they fit on lines of about @var{n}
1717characters. The default is 72 characters for @command{g++} and 0 for the rest of
1718the front ends supported by GCC@. If @var{n} is zero, then no
1719line-wrapping will be done; each error message will appear on a single
1720line.
1721
1722@opindex fdiagnostics-show-location
1723@item -fdiagnostics-show-location=once
1724Only meaningful in line-wrapping mode. Instructs the diagnostic messages
1725reporter to emit @emph{once} source location information; that is, in
1726case the message is too long to fit on a single physical line and has to
1727be wrapped, the source location won't be emitted (as prefix) again,
1728over and over, in subsequent continuation lines. This is the default
1729behavior.
1730
1731@item -fdiagnostics-show-location=every-line
1732Only meaningful in line-wrapping mode. Instructs the diagnostic
1733messages reporter to emit the same source location information (as
1734prefix) for physical lines that result from the process of breaking
1735a message which is too long to fit on a single line.
1736
1737@end table
1738
1739@node Warning Options
1740@section Options to Request or Suppress Warnings
1741@cindex options to control warnings
1742@cindex warning messages
1743@cindex messages, warning
1744@cindex suppressing warnings
1745
1746Warnings are diagnostic messages that report constructions which
1747are not inherently erroneous but which are risky or suggest there
1748may have been an error.
1749
1750You can request many specific warnings with options beginning @samp{-W},
1751for example @option{-Wimplicit} to request warnings on implicit
1752declarations. Each of these specific warning options also has a
1753negative form beginning @samp{-Wno-} to turn off warnings;
1754for example, @option{-Wno-implicit}. This manual lists only one of the
1755two forms, whichever is not the default.
1756
1757The following options control the amount and kinds of warnings produced
1758by GCC; for further, language-specific options also refer to
1759@ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1760
1761@table @gcctabopt
1762@cindex syntax checking
1763@item -fsyntax-only
1764@opindex fsyntax-only
1765Check the code for syntax errors, but don't do anything beyond that.
1766
1767@item -pedantic
1768@opindex pedantic
1769Issue all the warnings demanded by strict ISO C and ISO C++;
1770reject all programs that use forbidden extensions, and some other
1771programs that do not follow ISO C and ISO C++. For ISO C, follows the
1772version of the ISO C standard specified by any @option{-std} option used.
1773
1774Valid ISO C and ISO C++ programs should compile properly with or without
1775this option (though a rare few will require @option{-ansi} or a
1776@option{-std} option specifying the required version of ISO C)@. However,
1777without this option, certain GNU extensions and traditional C and C++
1778features are supported as well. With this option, they are rejected.
1779
1780@option{-pedantic} does not cause warning messages for use of the
1781alternate keywords whose names begin and end with @samp{__}. Pedantic
1782warnings are also disabled in the expression that follows
1783@code{__extension__}. However, only system header files should use
1784these escape routes; application programs should avoid them.
1785@xref{Alternate Keywords}.
1786
1787Some users try to use @option{-pedantic} to check programs for strict ISO
1788C conformance. They soon find that it does not do quite what they want:
1789it finds some non-ISO practices, but not all---only those for which
1790ISO C @emph{requires} a diagnostic, and some others for which
1791diagnostics have been added.
1792
1793A feature to report any failure to conform to ISO C might be useful in
1794some instances, but would require considerable additional work and would
1795be quite different from @option{-pedantic}. We don't have plans to
1796support such a feature in the near future.
1797
1798Where the standard specified with @option{-std} represents a GNU
1799extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1800corresponding @dfn{base standard}, the version of ISO C on which the GNU
1801extended dialect is based. Warnings from @option{-pedantic} are given
1802where they are required by the base standard. (It would not make sense
1803for such warnings to be given only for features not in the specified GNU
1804C dialect, since by definition the GNU dialects of C include all
1805features the compiler supports with the given option, and there would be
1806nothing to warn about.)
1807
1808@item -pedantic-errors
1809@opindex pedantic-errors
1810Like @option{-pedantic}, except that errors are produced rather than
1811warnings.
1812
1813@item -w
1814@opindex w
1815Inhibit all warning messages.
1816
1817@item -Wno-import
1818@opindex Wno-import
1819Inhibit warning messages about the use of @samp{#import}.
1820
1821@item -Wchar-subscripts
1822@opindex Wchar-subscripts
1823Warn if an array subscript has type @code{char}. This is a common cause
1824of error, as programmers often forget that this type is signed on some
1825machines.
1826
1827@item -Wcomment
1828@opindex Wcomment
1829Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1830comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1831
1832@item -Wformat
1833@opindex Wformat
1834Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1835the arguments supplied have types appropriate to the format string
1836specified, and that the conversions specified in the format string make
1837sense. This includes standard functions, and others specified by format
1838attributes (@pxref{Function Attributes}), in the @code{printf},
1839@code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1840not in the C standard) families.
1841
1842The formats are checked against the format features supported by GNU
1843libc version 2.2. These include all ISO C90 and C99 features, as well
1844as features from the Single Unix Specification and some BSD and GNU
1845extensions. Other library implementations may not support all these
1846features; GCC does not support warning about features that go beyond a
1847particular library's limitations. However, if @option{-pedantic} is used
1848with @option{-Wformat}, warnings will be given about format features not
1849in the selected standard version (but not for @code{strfmon} formats,
1850since those are not in any version of the C standard). @xref{C Dialect
1851Options,,Options Controlling C Dialect}.
1852
1853Since @option{-Wformat} also checks for null format arguments for
1854several functions, @option{-Wformat} also implies @option{-Wnonnull}.
1855
1856@option{-Wformat} is included in @option{-Wall}. For more control over some
1857aspects of format checking, the options @option{-Wno-format-y2k},
1858@option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
1859@option{-Wformat-nonliteral}, @option{-Wformat-security}, and
1860@option{-Wformat=2} are available, but are not included in @option{-Wall}.
1861
1862@item -Wno-format-y2k
1863@opindex Wno-format-y2k
1864If @option{-Wformat} is specified, do not warn about @code{strftime}
1865formats which may yield only a two-digit year.
1866
1867@item -Wno-format-extra-args
1868@opindex Wno-format-extra-args
1869If @option{-Wformat} is specified, do not warn about excess arguments to a
1870@code{printf} or @code{scanf} format function. The C standard specifies
1871that such arguments are ignored.
1872
1873Where the unused arguments lie between used arguments that are
1874specified with @samp{$} operand number specifications, normally
1875warnings are still given, since the implementation could not know what
1876type to pass to @code{va_arg} to skip the unused arguments. However,
1877in the case of @code{scanf} formats, this option will suppress the
1878warning if the unused arguments are all pointers, since the Single
1879Unix Specification says that such unused arguments are allowed.
1880
1881@item -Wno-format-zero-length
1882@opindex Wno-format-zero-length
1883If @option{-Wformat} is specified, do not warn about zero-length formats.
1884The C standard specifies that zero-length formats are allowed.
1885
1886@item -Wformat-nonliteral
1887@opindex Wformat-nonliteral
1888If @option{-Wformat} is specified, also warn if the format string is not a
1889string literal and so cannot be checked, unless the format function
1890takes its format arguments as a @code{va_list}.
1891
1892@item -Wformat-security
1893@opindex Wformat-security
1894If @option{-Wformat} is specified, also warn about uses of format
1895functions that represent possible security problems. At present, this
1896warns about calls to @code{printf} and @code{scanf} functions where the
1897format string is not a string literal and there are no format arguments,
1898as in @code{printf (foo);}. This may be a security hole if the format
1899string came from untrusted input and contains @samp{%n}. (This is
1900currently a subset of what @option{-Wformat-nonliteral} warns about, but
1901in future warnings may be added to @option{-Wformat-security} that are not
1902included in @option{-Wformat-nonliteral}.)
1903
1904@item -Wformat=2
1905@opindex Wformat=2
1906Enable @option{-Wformat} plus format checks not included in
1907@option{-Wformat}. Currently equivalent to @samp{-Wformat
1908-Wformat-nonliteral -Wformat-security}.
1909
1910@item -Wnonnull
1911@opindex Wnonnull
1912Enable warning about passing a null pointer for arguments marked as
1913requiring a non-null value by the @code{nonnull} function attribute.
1914
1915@option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
1916can be disabled with the @option{-Wno-nonnull} option.
1917
1918@item -Wimplicit-int
1919@opindex Wimplicit-int
1920Warn when a declaration does not specify a type.
1921
1922@item -Wimplicit-function-declaration
1923@itemx -Werror-implicit-function-declaration
1924@opindex Wimplicit-function-declaration
1925@opindex Werror-implicit-function-declaration
1926Give a warning (or error) whenever a function is used before being
1927declared.
1928
1929@item -Wimplicit
1930@opindex Wimplicit
1931Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
1932
1933@item -Wmain
1934@opindex Wmain
1935Warn if the type of @samp{main} is suspicious. @samp{main} should be a
1936function with external linkage, returning int, taking either zero
1937arguments, two, or three arguments of appropriate types.
1938
1939@item -Wmissing-braces
1940@opindex Wmissing-braces
1941Warn if an aggregate or union initializer is not fully bracketed. In
1942the following example, the initializer for @samp{a} is not fully
1943bracketed, but that for @samp{b} is fully bracketed.
1944
1945@smallexample
1946int a[2][2] = @{ 0, 1, 2, 3 @};
1947int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1948@end smallexample
1949
1950@item -Wparentheses
1951@opindex Wparentheses
1952Warn if parentheses are omitted in certain contexts, such
1953as when there is an assignment in a context where a truth value
1954is expected, or when operators are nested whose precedence people
1955often get confused about.
1956
1957Also warn about constructions where there may be confusion to which
1958@code{if} statement an @code{else} branch belongs. Here is an example of
1959such a case:
1960
1961@smallexample
1962@group
1963@{
1964 if (a)
1965 if (b)
1966 foo ();
1967 else
1968 bar ();
1969@}
1970@end group
1971@end smallexample
1972
1973In C, every @code{else} branch belongs to the innermost possible @code{if}
1974statement, which in this example is @code{if (b)}. This is often not
1975what the programmer expected, as illustrated in the above example by
1976indentation the programmer chose. When there is the potential for this
1977confusion, GCC will issue a warning when this flag is specified.
1978To eliminate the warning, add explicit braces around the innermost
1979@code{if} statement so there is no way the @code{else} could belong to
1980the enclosing @code{if}. The resulting code would look like this:
1981
1982@smallexample
1983@group
1984@{
1985 if (a)
1986 @{
1987 if (b)
1988 foo ();
1989 else
1990 bar ();
1991 @}
1992@}
1993@end group
1994@end smallexample
1995
1996@item -Wsequence-point
1997@opindex Wsequence-point
1998Warn about code that may have undefined semantics because of violations
1999of sequence point rules in the C standard.
2000
2001The C standard defines the order in which expressions in a C program are
2002evaluated in terms of @dfn{sequence points}, which represent a partial
2003ordering between the execution of parts of the program: those executed
2004before the sequence point, and those executed after it. These occur
2005after the evaluation of a full expression (one which is not part of a
2006larger expression), after the evaluation of the first operand of a
2007@code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2008function is called (but after the evaluation of its arguments and the
2009expression denoting the called function), and in certain other places.
2010Other than as expressed by the sequence point rules, the order of
2011evaluation of subexpressions of an expression is not specified. All
2012these rules describe only a partial order rather than a total order,
2013since, for example, if two functions are called within one expression
2014with no sequence point between them, the order in which the functions
2015are called is not specified. However, the standards committee have
2016ruled that function calls do not overlap.
2017
2018It is not specified when between sequence points modifications to the
2019values of objects take effect. Programs whose behavior depends on this
2020have undefined behavior; the C standard specifies that ``Between the
2021previous and next sequence point an object shall have its stored value
2022modified at most once by the evaluation of an expression. Furthermore,
2023the prior value shall be read only to determine the value to be
2024stored.''. If a program breaks these rules, the results on any
2025particular implementation are entirely unpredictable.
2026
2027Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2028= b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2029diagnosed by this option, and it may give an occasional false positive
2030result, but in general it has been found fairly effective at detecting
2031this sort of problem in programs.
2032
2033The present implementation of this option only works for C programs. A
2034future implementation may also work for C++ programs.
2035
2036The C standard is worded confusingly, therefore there is some debate
2037over the precise meaning of the sequence point rules in subtle cases.
2038Links to discussions of the problem, including proposed formal
2039definitions, may be found on our readings page, at
2040@w{@uref{http://gcc.gnu.org/readings.html}}.
2041
2042@item -Wreturn-type
2043@opindex Wreturn-type
2044Warn whenever a function is defined with a return-type that defaults to
2045@code{int}. Also warn about any @code{return} statement with no
2046return-value in a function whose return-type is not @code{void}.
2047
2048For C++, a function without return type always produces a diagnostic
2049message, even when @option{-Wno-return-type} is specified. The only
2050exceptions are @samp{main} and functions defined in system headers.
2051
2052@item -Wswitch
2053@opindex Wswitch
2054Warn whenever a @code{switch} statement has an index of enumeral type
2055and lacks a @code{case} for one or more of the named codes of that
2056enumeration. (The presence of a @code{default} label prevents this
2057warning.) @code{case} labels outside the enumeration range also
2058provoke warnings when this option is used.
2059
2060@item -Wswitch-default
2061@opindex Wswitch-switch
2062Warn whenever a @code{switch} statement does not have a @code{default}
2063case.
2064
2065@item -Wswitch-enum
2066@opindex Wswitch-enum
2067Warn whenever a @code{switch} statement has an index of enumeral type
2068and lacks a @code{case} for one or more of the named codes of that
2069enumeration. @code{case} labels outside the enumeration range also
2070provoke warnings when this option is used.
2071
2072@item -Wtrigraphs
2073@opindex Wtrigraphs
2074Warn if any trigraphs are encountered that might change the meaning of
2075the program (trigraphs within comments are not warned about).
2076
2077@item -Wunused-function
2078@opindex Wunused-function
2079Warn whenever a static function is declared but not defined or a
2080non\-inline static function is unused.
2081
2082@item -Wunused-label
2083@opindex Wunused-label
2084Warn whenever a label is declared but not used.
2085
2086To suppress this warning use the @samp{unused} attribute
2087(@pxref{Variable Attributes}).
2088
2089@item -Wunused-parameter
2090@opindex Wunused-parameter
2091Warn whenever a function parameter is unused aside from its declaration.
2092
2093To suppress this warning use the @samp{unused} attribute
2094(@pxref{Variable Attributes}).
2095
2096@item -Wunused-variable
2097@opindex Wunused-variable
2098Warn whenever a local variable or non-constant static variable is unused
2099aside from its declaration
2100
2101To suppress this warning use the @samp{unused} attribute
2102(@pxref{Variable Attributes}).
2103
2104@item -Wunused-value
2105@opindex Wunused-value
2106Warn whenever a statement computes a result that is explicitly not used.
2107
2108To suppress this warning cast the expression to @samp{void}.
2109
2110@item -Wunused
2111@opindex Wunused
2112All all the above @option{-Wunused} options combined.
2113
2114In order to get a warning about an unused function parameter, you must
2115either specify @samp{-W -Wunused} or separately specify
2116@option{-Wunused-parameter}.
2117
2118@item -Wuninitialized
2119@opindex Wuninitialized
2120Warn if an automatic variable is used without first being initialized or
2121if a variable may be clobbered by a @code{setjmp} call.
2122
2123These warnings are possible only in optimizing compilation,
2124because they require data flow information that is computed only
2125when optimizing. If you don't specify @option{-O}, you simply won't
2126get these warnings.
2127
2128These warnings occur only for variables that are candidates for
2129register allocation. Therefore, they do not occur for a variable that
2130is declared @code{volatile}, or whose address is taken, or whose size
2131is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
2132structures, unions or arrays, even when they are in registers.
2133
2134Note that there may be no warning about a variable that is used only
2135to compute a value that itself is never used, because such
2136computations may be deleted by data flow analysis before the warnings
2137are printed.
2138
2139These warnings are made optional because GCC is not smart
2140enough to see all the reasons why the code might be correct
2141despite appearing to have an error. Here is one example of how
2142this can happen:
2143
2144@smallexample
2145@group
2146@{
2147 int x;
2148 switch (y)
2149 @{
2150 case 1: x = 1;
2151 break;
2152 case 2: x = 4;
2153 break;
2154 case 3: x = 5;
2155 @}
2156 foo (x);
2157@}
2158@end group
2159@end smallexample
2160
2161@noindent
2162If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2163always initialized, but GCC doesn't know this. Here is
2164another common case:
2165
2166@smallexample
2167@{
2168 int save_y;
2169 if (change_y) save_y = y, y = new_y;
2170 @dots{}
2171 if (change_y) y = save_y;
2172@}
2173@end smallexample
2174
2175@noindent
2176This has no bug because @code{save_y} is used only if it is set.
2177
2178@cindex @code{longjmp} warnings
2179This option also warns when a non-volatile automatic variable might be
2180changed by a call to @code{longjmp}. These warnings as well are possible
2181only in optimizing compilation.
2182
2183The compiler sees only the calls to @code{setjmp}. It cannot know
2184where @code{longjmp} will be called; in fact, a signal handler could
2185call it at any point in the code. As a result, you may get a warning
2186even when there is in fact no problem because @code{longjmp} cannot
2187in fact be called at the place which would cause a problem.
2188
2189Some spurious warnings can be avoided if you declare all the functions
2190you use that never return as @code{noreturn}. @xref{Function
2191Attributes}.
2192
2193@item -Wreorder @r{(C++ only)}
2194@opindex Wreorder
2195@cindex reordering, warning
2196@cindex warning for reordering of member initializers
2197Warn when the order of member initializers given in the code does not
2198match the order in which they must be executed. For instance:
2199
2200@item -Wunknown-pragmas
2201@opindex Wunknown-pragmas
2202@cindex warning for unknown pragmas
2203@cindex unknown pragmas, warning
2204@cindex pragmas, warning of unknown
2205Warn when a #pragma directive is encountered which is not understood by
2206GCC@. If this command line option is used, warnings will even be issued
2207for unknown pragmas in system header files. This is not the case if
2208the warnings were only enabled by the @option{-Wall} command line option.
2209
2210@item -Wall
2211@opindex Wall
2212All of the above @samp{-W} options combined. This enables all the
2213warnings about constructions that some users consider questionable, and
2214that are easy to avoid (or modify to prevent the warning), even in
2215conjunction with macros.
2216@end table
2217
2218The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2219Some of them warn about constructions that users generally do not
2220consider questionable, but which occasionally you might wish to check
2221for; others warn about constructions that are necessary or hard to avoid
2222in some cases, and there is no simple way to modify the code to suppress
2223the warning.
2224
2225@table @gcctabopt
2226@item -W
2227@opindex W
2228Print extra warning messages for these events:
2229
2230@itemize @bullet
2231@item
2232A function can return either with or without a value. (Falling
2233off the end of the function body is considered returning without
2234a value.) For example, this function would evoke such a
2235warning:
2236
2237@smallexample
2238@group
2239foo (a)
2240@{
2241 if (a > 0)
2242 return a;
2243@}
2244@end group
2245@end smallexample
2246
2247@item
2248An expression-statement or the left-hand side of a comma expression
2249contains no side effects.
2250To suppress the warning, cast the unused expression to void.
2251For example, an expression such as @samp{x[i,j]} will cause a warning,
2252but @samp{x[(void)i,j]} will not.
2253
2254@item
2255An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2256
2257@item
2258A comparison like @samp{x<=y<=z} appears; this is equivalent to
2259@samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2260that of ordinary mathematical notation.
2261
2262@item
2263Storage-class specifiers like @code{static} are not the first things in
2264a declaration. According to the C Standard, this usage is obsolescent.
2265
2266@item
2267The return type of a function has a type qualifier such as @code{const}.
2268Such a type qualifier has no effect, since the value returned by a
2269function is not an lvalue. (But don't warn about the GNU extension of
2270@code{volatile void} return types. That extension will be warned about
2271if @option{-pedantic} is specified.)
2272
2273@item
2274If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2275arguments.
2276
2277@item
2278A comparison between signed and unsigned values could produce an
2279incorrect result when the signed value is converted to unsigned.
2280(But don't warn if @option{-Wno-sign-compare} is also specified.)
2281
2282@item
2283An aggregate has a partly bracketed initializer.
2284For example, the following code would evoke such a warning,
2285because braces are missing around the initializer for @code{x.h}:
2286
2287@smallexample
2288struct s @{ int f, g; @};
2289struct t @{ struct s h; int i; @};
2290struct t x = @{ 1, 2, 3 @};
2291@end smallexample
2292
2293@item
2294An aggregate has an initializer which does not initialize all members.
2295For example, the following code would cause such a warning, because
2296@code{x.h} would be implicitly initialized to zero:
2297
2298@smallexample
2299struct s @{ int f, g, h; @};
2300struct s x = @{ 3, 4 @};
2301@end smallexample
2302@end itemize
2303
2304@item -Wno-div-by-zero
2305@opindex Wno-div-by-zero
2306@opindex Wdiv-by-zero
2307Do not warn about compile-time integer division by zero. Floating point
2308division by zero is not warned about, as it can be a legitimate way of
2309obtaining infinities and NaNs.
2310
2311@item -Wsystem-headers
2312@opindex Wsystem-headers
2313@cindex warnings from system headers
2314@cindex system headers, warnings from
2315Print warning messages for constructs found in system header files.
2316Warnings from system headers are normally suppressed, on the assumption
2317that they usually do not indicate real problems and would only make the
2318compiler output harder to read. Using this command line option tells
2319GCC to emit warnings from system headers as if they occurred in user
2320code. However, note that using @option{-Wall} in conjunction with this
2321option will @emph{not} warn about unknown pragmas in system
2322headers---for that, @option{-Wunknown-pragmas} must also be used.
2323
2324@item -Wfloat-equal
2325@opindex Wfloat-equal
2326Warn if floating point values are used in equality comparisons.
2327
2328The idea behind this is that sometimes it is convenient (for the
2329programmer) to consider floating-point values as approximations to
2330infinitely precise real numbers. If you are doing this, then you need
2331to compute (by analysing the code, or in some other way) the maximum or
2332likely maximum error that the computation introduces, and allow for it
2333when performing comparisons (and when producing output, but that's a
2334different problem). In particular, instead of testing for equality, you
2335would check to see whether the two values have ranges that overlap; and
2336this is done with the relational operators, so equality comparisons are
2337probably mistaken.
2338
2339@item -Wtraditional @r{(C only)}
2340@opindex Wtraditional
2341Warn about certain constructs that behave differently in traditional and
2342ISO C@. Also warn about ISO C constructs that have no traditional C
2343equivalent, and/or problematic constructs which should be avoided.
2344
2345@itemize @bullet
2346@item
2347Macro parameters that appear within string literals in the macro body.
2348In traditional C macro replacement takes place within string literals,
2349but does not in ISO C@.
2350
2351@item
2352In traditional C, some preprocessor directives did not exist.
2353Traditional preprocessors would only consider a line to be a directive
2354if the @samp{#} appeared in column 1 on the line. Therefore
2355@option{-Wtraditional} warns about directives that traditional C
2356understands but would ignore because the @samp{#} does not appear as the
2357first character on the line. It also suggests you hide directives like
2358@samp{#pragma} not understood by traditional C by indenting them. Some
2359traditional implementations would not recognize @samp{#elif}, so it
2360suggests avoiding it altogether.
2361
2362@item
2363A function-like macro that appears without arguments.
2364
2365@item
2366The unary plus operator.
2367
2368@item
2369The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2370constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2371constants.) Note, these suffixes appear in macros defined in the system
2372headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2373Use of these macros in user code might normally lead to spurious
2374warnings, however gcc's integrated preprocessor has enough context to
2375avoid warning in these cases.
2376
2377@item
2378A function declared external in one block and then used after the end of
2379the block.
2380
2381@item
2382A @code{switch} statement has an operand of type @code{long}.
2383
2384@item
2385A non-@code{static} function declaration follows a @code{static} one.
2386This construct is not accepted by some traditional C compilers.
2387
2388@item
2389The ISO type of an integer constant has a different width or
2390signedness from its traditional type. This warning is only issued if
2391the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2392typically represent bit patterns, are not warned about.
2393
2394@item
2395Usage of ISO string concatenation is detected.
2396
2397@item
2398Initialization of automatic aggregates.
2399
2400@item
2401Identifier conflicts with labels. Traditional C lacks a separate
2402namespace for labels.
2403
2404@item
2405Initialization of unions. If the initializer is zero, the warning is
2406omitted. This is done under the assumption that the zero initializer in
2407user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2408initializer warnings and relies on default initialization to zero in the
2409traditional C case.
2410
2411@item
2412Conversions by prototypes between fixed/floating point values and vice
2413versa. The absence of these prototypes when compiling with traditional
2414C would cause serious problems. This is a subset of the possible
2415conversion warnings, for the full set use @option{-Wconversion}.
2416
2417@item
2418Use of ISO C style function definitions. This warning intentionally is
2419@emph{not} issued for prototype declarations or variadic functions
2420because these ISO C features will appear in your code when using
2421libiberty's traditional C compatibility macros, @code{PARAMS} and
2422@code{VPARAMS}. This warning is also bypassed for nested functions
2423because that feature is already a gcc extension and thus not relevant to
2424traditional C compatibility.
2425@end itemize
2426
2427@item -Wundef
2428@opindex Wundef
2429Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2430
2431@item -Wendif-labels
2432@opindex Wendif-labels
2433Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2434
2435@item -Wshadow
2436@opindex Wshadow
2437Warn whenever a local variable shadows another local variable, parameter or
2438global variable or whenever a built-in function is shadowed.
2439
2440@item -Wlarger-than-@var{len}
2441@opindex Wlarger-than
2442Warn whenever an object of larger than @var{len} bytes is defined.
2443
2444@item -Wpointer-arith
2445@opindex Wpointer-arith
2446Warn about anything that depends on the ``size of'' a function type or
2447of @code{void}. GNU C assigns these types a size of 1, for
2448convenience in calculations with @code{void *} pointers and pointers
2449to functions.
2450
2451@item -Wbad-function-cast @r{(C only)}
2452@opindex Wbad-function-cast
2453Warn whenever a function call is cast to a non-matching type.
2454For example, warn if @code{int malloc()} is cast to @code{anything *}.
2455
2456@item -Wcast-qual
2457@opindex Wcast-qual
2458Warn whenever a pointer is cast so as to remove a type qualifier from
2459the target type. For example, warn if a @code{const char *} is cast
2460to an ordinary @code{char *}.
2461
2462@item -Wcast-align
2463@opindex Wcast-align
2464Warn whenever a pointer is cast such that the required alignment of the
2465target is increased. For example, warn if a @code{char *} is cast to
2466an @code{int *} on machines where integers can only be accessed at
2467two- or four-byte boundaries.
2468
2469@item -Wwrite-strings
2470@opindex Wwrite-strings
2471When compiling C, give string constants the type @code{const
2472char[@var{length}]} so that
2473copying the address of one into a non-@code{const} @code{char *}
2474pointer will get a warning; when compiling C++, warn about the
2475deprecated conversion from string constants to @code{char *}.
2476These warnings will help you find at
2477compile time code that can try to write into a string constant, but
2478only if you have been very careful about using @code{const} in
2479declarations and prototypes. Otherwise, it will just be a nuisance;
2480this is why we did not make @option{-Wall} request these warnings.
2481
2482@item -Wconversion
2483@opindex Wconversion
2484Warn if a prototype causes a type conversion that is different from what
2485would happen to the same argument in the absence of a prototype. This
2486includes conversions of fixed point to floating and vice versa, and
2487conversions changing the width or signedness of a fixed point argument
2488except when the same as the default promotion.
2489
2490Also, warn if a negative integer constant expression is implicitly
2491converted to an unsigned type. For example, warn about the assignment
2492@code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2493casts like @code{(unsigned) -1}.
2494
2495@item -Wsign-compare
2496@opindex Wsign-compare
2497@cindex warning for comparison of signed and unsigned values
2498@cindex comparison of signed and unsigned values, warning
2499@cindex signed and unsigned values, comparison warning
2500Warn when a comparison between signed and unsigned values could produce
2501an incorrect result when the signed value is converted to unsigned.
2502This warning is also enabled by @option{-W}; to get the other warnings
2503of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2504
2505@item -Waggregate-return
2506@opindex Waggregate-return
2507Warn if any functions that return structures or unions are defined or
2508called. (In languages where you can return an array, this also elicits
2509a warning.)
2510
2511@item -Wstrict-prototypes @r{(C only)}
2512@opindex Wstrict-prototypes
2513Warn if a function is declared or defined without specifying the
2514argument types. (An old-style function definition is permitted without
2515a warning if preceded by a declaration which specifies the argument
2516types.)
2517
2518@item -Wmissing-prototypes @r{(C only)}
2519@opindex Wmissing-prototypes
2520Warn if a global function is defined without a previous prototype
2521declaration. This warning is issued even if the definition itself
2522provides a prototype. The aim is to detect global functions that fail
2523to be declared in header files.
2524
2525@item -Wmissing-declarations
2526@opindex Wmissing-declarations
2527Warn if a global function is defined without a previous declaration.
2528Do so even if the definition itself provides a prototype.
2529Use this option to detect global functions that are not declared in
2530header files.
2531
2532@item -Wmissing-noreturn
2533@opindex Wmissing-noreturn
2534Warn about functions which might be candidates for attribute @code{noreturn}.
2535Note these are only possible candidates, not absolute ones. Care should
2536be taken to manually verify functions actually do not ever return before
2537adding the @code{noreturn} attribute, otherwise subtle code generation
2538bugs could be introduced. You will not get a warning for @code{main} in
2539hosted C environments.
2540
2541@item -Wmissing-format-attribute
2542@opindex Wmissing-format-attribute
2543@opindex Wformat
2544If @option{-Wformat} is enabled, also warn about functions which might be
2545candidates for @code{format} attributes. Note these are only possible
2546candidates, not absolute ones. GCC will guess that @code{format}
2547attributes might be appropriate for any function that calls a function
2548like @code{vprintf} or @code{vscanf}, but this might not always be the
2549case, and some functions for which @code{format} attributes are
2550appropriate may not be detected. This option has no effect unless
2551@option{-Wformat} is enabled (possibly by @option{-Wall}).
2552
2553@item -Wno-multichar
2554@opindex Wno-multichar
2555@opindex Wmultichar
2556Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2557Usually they indicate a typo in the user's code, as they have
2558implementation-defined values, and should not be used in portable code.
2559
2560@item -Wno-deprecated-declarations
2561@opindex Wno-deprecated-declarations
2562Do not warn about uses of functions, variables, and types marked as
2563deprecated by using the @code{deprecated} attribute.
2564(@pxref{Function Attributes}, @pxref{Variable Attributes},
2565@pxref{Type Attributes}.)
2566
2567@item -Wpacked
2568@opindex Wpacked
2569Warn if a structure is given the packed attribute, but the packed
2570attribute has no effect on the layout or size of the structure.
2571Such structures may be mis-aligned for little benefit. For
2572instance, in this code, the variable @code{f.x} in @code{struct bar}
2573will be misaligned even though @code{struct bar} does not itself
2574have the packed attribute:
2575
2576@smallexample
2577@group
2578struct foo @{
2579 int x;
2580 char a, b, c, d;
2581@} __attribute__((packed));
2582struct bar @{
2583 char z;
2584 struct foo f;
2585@};
2586@end group
2587@end smallexample
2588
2589@item -Wpadded
2590@opindex Wpadded
2591Warn if padding is included in a structure, either to align an element
2592of the structure or to align the whole structure. Sometimes when this
2593happens it is possible to rearrange the fields of the structure to
2594reduce the padding and so make the structure smaller.
2595
2596@item -Wredundant-decls
2597@opindex Wredundant-decls
2598Warn if anything is declared more than once in the same scope, even in
2599cases where multiple declaration is valid and changes nothing.
2600
2601@item -Wnested-externs @r{(C only)}
2602@opindex Wnested-externs
2603Warn if an @code{extern} declaration is encountered within a function.
2604
2605@item -Wunreachable-code
2606@opindex Wunreachable-code
2607Warn if the compiler detects that code will never be executed.
2608
2609This option is intended to warn when the compiler detects that at
2610least a whole line of source code will never be executed, because
2611some condition is never satisfied or because it is after a
2612procedure that never returns.
2613
2614It is possible for this option to produce a warning even though there
2615are circumstances under which part of the affected line can be executed,
2616so care should be taken when removing apparently-unreachable code.
2617
2618For instance, when a function is inlined, a warning may mean that the
2619line is unreachable in only one inlined copy of the function.
2620
2621This option is not made part of @option{-Wall} because in a debugging
2622version of a program there is often substantial code which checks
2623correct functioning of the program and is, hopefully, unreachable
2624because the program does work. Another common use of unreachable
2625code is to provide behavior which is selectable at compile-time.
2626
2627@item -Winline
2628@opindex Winline
2629Warn if a function can not be inlined and it was declared as inline.
2630
2631@item -Wlong-long
2632@opindex Wlong-long
2633@opindex Wno-long-long
2634Warn if @samp{long long} type is used. This is default. To inhibit
2635the warning messages, use @option{-Wno-long-long}. Flags
2636@option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2637only when @option{-pedantic} flag is used.
2638
2639@item -Wdisabled-optimization
2640@opindex Wdisabled-optimization
2641Warn if a requested optimization pass is disabled. This warning does
2642not generally indicate that there is anything wrong with your code; it
2643merely indicates that GCC's optimizers were unable to handle the code
2644effectively. Often, the problem is that your code is too big or too
2645complex; GCC will refuse to optimize programs when the optimization
2646itself is likely to take inordinate amounts of time.
2647
2648@item -Werror
2649@opindex Werror
2650Make all warnings into errors.
2651@end table
2652
2653@node Debugging Options
2654@section Options for Debugging Your Program or GCC
2655@cindex options, debugging
2656@cindex debugging information options
2657
2658GCC has various special options that are used for debugging
2659either your program or GCC:
2660
2661@table @gcctabopt
2662@item -g
2663@opindex g
2664Produce debugging information in the operating system's native format
2665(stabs, COFF, XCOFF, or DWARF)@. GDB can work with this debugging
2666information.
2667
2668On most systems that use stabs format, @option{-g} enables use of extra
2669debugging information that only GDB can use; this extra information
2670makes debugging work better in GDB but will probably make other debuggers
2671crash or
2672refuse to read the program. If you want to control for certain whether
2673to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2674@option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2675or @option{-gvms} (see below).
2676
2677Unlike most other C compilers, GCC allows you to use @option{-g} with
2678@option{-O}. The shortcuts taken by optimized code may occasionally
2679produce surprising results: some variables you declared may not exist
2680at all; flow of control may briefly move where you did not expect it;
2681some statements may not be executed because they compute constant
2682results or their values were already at hand; some statements may
2683execute in different places because they were moved out of loops.
2684
2685Nevertheless it proves possible to debug optimized output. This makes
2686it reasonable to use the optimizer for programs that might have bugs.
2687
2688The following options are useful when GCC is generated with the
2689capability for more than one debugging format.
2690
2691@item -ggdb
2692@opindex ggdb
2693Produce debugging information for use by GDB@. This means to use the
2694most expressive format available (DWARF 2, stabs, or the native format
2695if neither of those are supported), including GDB extensions if at all
2696possible.
2697
2698@item -gstabs
2699@opindex gstabs
2700Produce debugging information in stabs format (if that is supported),
2701without GDB extensions. This is the format used by DBX on most BSD
2702systems. On MIPS, Alpha and System V Release 4 systems this option
2703produces stabs debugging output which is not understood by DBX or SDB@.
2704On System V Release 4 systems this option requires the GNU assembler.
2705
2706@item -gstabs+
2707@opindex gstabs+
2708Produce debugging information in stabs format (if that is supported),
2709using GNU extensions understood only by the GNU debugger (GDB)@. The
2710use of these extensions is likely to make other debuggers crash or
2711refuse to read the program.
2712
2713@item -gcoff
2714@opindex gcoff
2715Produce debugging information in COFF format (if that is supported).
2716This is the format used by SDB on most System V systems prior to
2717System V Release 4.
2718
2719@item -gxcoff
2720@opindex gxcoff
2721Produce debugging information in XCOFF format (if that is supported).
2722This is the format used by the DBX debugger on IBM RS/6000 systems.
2723
2724@item -gxcoff+
2725@opindex gxcoff+
2726Produce debugging information in XCOFF format (if that is supported),
2727using GNU extensions understood only by the GNU debugger (GDB)@. The
2728use of these extensions is likely to make other debuggers crash or
2729refuse to read the program, and may cause assemblers other than the GNU
2730assembler (GAS) to fail with an error.
2731
2732@item -gdwarf
2733@opindex gdwarf
2734Produce debugging information in DWARF version 1 format (if that is
2735supported). This is the format used by SDB on most System V Release 4
2736systems.
2737
2738This option is deprecated.
2739
2740@item -gdwarf+
2741@opindex gdwarf+
2742Produce debugging information in DWARF version 1 format (if that is
2743supported), using GNU extensions understood only by the GNU debugger
2744(GDB)@. The use of these extensions is likely to make other debuggers
2745crash or refuse to read the program.
2746
2747This option is deprecated.
2748
2749@item -gdwarf-2
2750@opindex gdwarf-2
2751Produce debugging information in DWARF version 2 format (if that is
2752supported). This is the format used by DBX on IRIX 6.
2753
2754@item -gvms
2755@opindex gvms
2756Produce debugging information in VMS debug format (if that is
2757supported). This is the format used by DEBUG on VMS systems.
2758
2759@item -g@var{level}
2760@itemx -ggdb@var{level}
2761@itemx -gstabs@var{level}
2762@itemx -gcoff@var{level}
2763@itemx -gxcoff@var{level}
2764@itemx -gvms@var{level}
2765Request debugging information and also use @var{level} to specify how
2766much information. The default level is 2.
2767
2768Level 1 produces minimal information, enough for making backtraces in
2769parts of the program that you don't plan to debug. This includes
2770descriptions of functions and external variables, but no information
2771about local variables and no line numbers.
2772
2773Level 3 includes extra information, such as all the macro definitions
2774present in the program. Some debuggers support macro expansion when
2775you use @option{-g3}.
2776
2777Note that in order to avoid confusion between DWARF1 debug level 2,
2778and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2779a concatenated debug level. Instead use an additional @option{-g@var{level}}
2780option to change the debug level for DWARF1 or DWARF2.
2781
2782@cindex @code{prof}
2783@item -p
2784@opindex p
2785Generate extra code to write profile information suitable for the
2786analysis program @code{prof}. You must use this option when compiling
2787the source files you want data about, and you must also use it when
2788linking.
2789
2790@cindex @code{gprof}
2791@item -pg
2792@opindex pg
2793Generate extra code to write profile information suitable for the
2794analysis program @code{gprof}. You must use this option when compiling
2795the source files you want data about, and you must also use it when
2796linking.
2797
2798@cindex @code{tcov}
2799@item -a
2800@opindex a
2801Generate extra code to write profile information for basic blocks, which will
2802record the number of times each basic block is executed, the basic block start
2803address, and the function name containing the basic block. If @option{-g} is
2804used, the line number and filename of the start of the basic block will also be
2805recorded. If not overridden by the machine description, the default action is
2806to append to the text file @file{bb.out}.
2807
2808This data could be analyzed by a program like @code{tcov}. Note,
2809however, that the format of the data is not what @code{tcov} expects.
2810Eventually GNU @code{gprof} should be extended to process this data.
2811
2812@item -Q
2813@opindex Q
2814Makes the compiler print out each function name as it is compiled, and
2815print some statistics about each pass when it finishes.
2816
2817@item -ftime-report
2818@opindex ftime-report
2819Makes the compiler print some statistics about the time consumed by each
2820pass when it finishes.
2821
2822@item -fmem-report
2823@opindex fmem-report
2824Makes the compiler print some statistics about permanent memory
2825allocation when it finishes.
2826
2827@item -fprofile-arcs
2828@opindex fprofile-arcs
2829Instrument @dfn{arcs} during compilation to generate coverage data or
2830for profile-directed block ordering. During execution the program
2831records how many times each branch is executed and how many times it is
2832taken. When the compiled program exits it saves this data to a file
2833called @file{@var{auxname}.da} for each source file. @var{auxname} is
2834generated from the name of the output file, if explicitly specified and
2835it is not the final executable, otherwise it is the basename of the
2836source file. In both cases any suffix is removed (e.g. @file{foo.da}
2837for input file @file{dir/foo.c}, or @file{dir/foo.da} for output file
2838specified as @option{-o dir/foo.o}).
2839
2840For profile-directed block ordering, compile the program with
2841@option{-fprofile-arcs} plus optimization and code generation options,
2842generate the arc profile information by running the program on a
2843selected workload, and then compile the program again with the same
2844optimization and code generation options plus
2845@option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2846Control Optimization}).
2847
2848The other use of @option{-fprofile-arcs} is for use with @code{gcov},
2849when it is used with the @option{-ftest-coverage} option. GCC
2850supports two methods of determining code coverage: the options that
2851support @code{gcov}, and options @option{-a} and @option{-ax}, which
2852write information to text files. The options that support @code{gcov}
2853do not need to instrument every arc in the program, so a program compiled
2854with them runs faster than a program compiled with @option{-a}, which
2855adds instrumentation code to every basic block in the program. The
2856tradeoff: since @code{gcov} does not have execution counts for all
2857branches, it must start with the execution counts for the instrumented
2858branches, and then iterate over the program flow graph until the entire
2859graph has been solved. Hence, @code{gcov} runs a little more slowly than
2860a program which uses information from @option{-a} and @option{-ax}.
2861
2862With @option{-fprofile-arcs}, for each function of your program GCC
2863creates a program flow graph, then finds a spanning tree for the graph.
2864Only arcs that are not on the spanning tree have to be instrumented: the
2865compiler adds code to count the number of times that these arcs are
2866executed. When an arc is the only exit or only entrance to a block, the
2867instrumentation code can be added to the block; otherwise, a new basic
2868block must be created to hold the instrumentation code.
2869
2870This option makes it possible to estimate branch probabilities and to
2871calculate basic block execution counts. In general, basic block
2872execution counts as provided by @option{-a} do not give enough
2873information to estimate all branch probabilities.
2874
2875@need 2000
2876@item -ftest-coverage
2877@opindex ftest-coverage
2878Create data files for the @code{gcov} code-coverage utility
2879(@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}). See
2880@option{-fprofile-arcs} option above for a description of @var{auxname}.
2881
2882@table @gcctabopt
2883@item @var{auxname}.bb
2884A mapping from basic blocks to line numbers, which @code{gcov} uses to
2885associate basic block execution counts with line numbers.
2886
2887@item @var{auxname}.bbg
2888A list of all arcs in the program flow graph. This allows @code{gcov}
2889to reconstruct the program flow graph, so that it can compute all basic
2890block and arc execution counts from the information in the
2891@file{@var{auxname}.da} file.
2892@end table
2893
2894Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
2895option adds instrumentation to the program, which then writes
2896execution counts to another data file:
2897
2898@table @gcctabopt
2899@item @var{auxname}.da
2900Runtime arc execution counts, used in conjunction with the arc
2901information in the file @file{@var{auxname}.bbg}.
2902@end table
2903
2904Coverage data will map better to the source files if
2905@option{-ftest-coverage} is used without optimization.
2906
2907@item -d@var{letters}
2908@opindex d
2909Says to make debugging dumps during compilation at times specified by
2910@var{letters}. This is used for debugging the compiler. The file names
2911for most of the dumps are made by appending a pass number and a word to
2912the @var{dumpname}. @var{dumpname} is generated from the name of the
2913output file, if explicitly specified and it is not an executable,
2914otherwise it is the basename of the source file. In both cases any
2915suffix is removed (e.g. @file{foo.00.rtl} or @file{foo.01.sibling}).
2916Here are the possible letters for use in @var{letters}, and their
2917meanings:
2918
2919@table @samp
2920@item A
2921@opindex dA
2922Annotate the assembler output with miscellaneous debugging information.
2923@item b
2924@opindex db
2925Dump after computing branch probabilities, to @file{@var{file}.15.bp}.
2926@item B
2927@opindex dB
2928Dump after block reordering, to @file{@var{file}.30.bbro}.
2929@item c
2930@opindex dc
2931Dump after instruction combination, to the file @file{@var{file}.17.combine}.
2932@item C
2933@opindex dC
2934Dump after the first if conversion, to the file @file{@var{file}.18.ce}.
2935@item d
2936@opindex dd
2937Dump after delayed branch scheduling, to @file{@var{file}.32.dbr}.
2938@item D
2939@opindex dD
2940Dump all macro definitions, at the end of preprocessing, in addition to
2941normal output.
2942@item e
2943@opindex de
2944Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
2945@file{@var{file}.07.ussa}.
2946@item E
2947@opindex dE
2948Dump after the second if conversion, to @file{@var{file}.27.ce2}.
2949@item f
2950@opindex df
2951Dump after life analysis, to @file{@var{file}.16.life}.
2952@item F
2953@opindex dF
2954Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
2955@item g
2956@opindex dg
2957Dump after global register allocation, to @file{@var{file}.22.greg}.
2958@item h
2959@opindex dh
2960Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
2961@item k
2962@opindex dk
2963Dump after reg-to-stack conversion, to @file{@var{file}.29.stack}.
2964@item o
2965@opindex do
2966Dump after post-reload optimizations, to @file{@var{file}.23.postreload}.
2967@item G
2968@opindex dG
2969Dump after GCSE, to @file{@var{file}.11.gcse}.
2970@item i
2971@opindex di
2972Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2973@item j
2974@opindex dj
2975Dump after the first jump optimization, to @file{@var{file}.03.jump}.
2976@item k
2977@opindex dk
2978Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
2979@item l
2980@opindex dl
2981Dump after local register allocation, to @file{@var{file}.21.lreg}.
2982@item L
2983@opindex dL
2984Dump after loop optimization, to @file{@var{file}.12.loop}.
2985@item M
2986@opindex dM
2987Dump after performing the machine dependent reorganisation pass, to
2988@file{@var{file}.31.mach}.
2989@item n
2990@opindex dn
2991Dump after register renumbering, to @file{@var{file}.26.rnreg}.
2992@item N
2993@opindex dN
2994Dump after the register move pass, to @file{@var{file}.19.regmove}.
2995@item r
2996@opindex dr
2997Dump after RTL generation, to @file{@var{file}.00.rtl}.
2998@item R
2999@opindex dR
3000Dump after the second scheduling pass, to @file{@var{file}.28.sched2}.
3001@item s
3002@opindex ds
3003Dump after CSE (including the jump optimization that sometimes follows
3004CSE), to @file{@var{file}.09.cse}.
3005@item S
3006@opindex dS
3007Dump after the first scheduling pass, to @file{@var{file}.20.sched}.
3008@item t
3009@opindex dt
3010Dump after the second CSE pass (including the jump optimization that
3011sometimes follows CSE), to @file{@var{file}.13.cse2}.
3012@item u
3013@opindex du
3014Dump after null pointer ellimination pass ti @file{@var{file}.08.null}.
3015@item w
3016@opindex dw
3017Dump after the second flow pass, to @file{@var{file}.24.flow2}.
3018@item X
3019@opindex dX
3020Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3021@item z
3022@opindex dz
3023Dump after the peephole pass, to @file{@var{file}.25.peephole2}.
3024@item a
3025@opindex da
3026Produce all the dumps listed above.
3027@item m
3028@opindex dm
3029Print statistics on memory usage, at the end of the run, to
3030standard error.
3031@item p
3032@opindex dp
3033Annotate the assembler output with a comment indicating which
3034pattern and alternative was used. The length of each instruction is
3035also printed.
3036@item P
3037@opindex dP
3038Dump the RTL in the assembler output as a comment before each instruction.
3039Also turns on @option{-dp} annotation.
3040@item v
3041@opindex dv
3042For each of the other indicated dump files (except for
3043@file{@var{file}.00.rtl}), dump a representation of the control flow graph
3044suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3045@item x
3046@opindex dx
3047Just generate RTL for a function instead of compiling it. Usually used
3048with @samp{r}.
3049@item y
3050@opindex dy
3051Dump debugging information during parsing, to standard error.
3052@end table
3053
3054@item -fdump-unnumbered
3055@opindex fdump-unnumbered
3056When doing debugging dumps (see @option{-d} option above), suppress instruction
3057numbers and line number note output. This makes it more feasible to
3058use diff on debugging dumps for compiler invocations with different
3059options, in particular with and without @option{-g}.
3060
3061@item -fdump-translation-unit @r{(C and C++ only)}
3062@itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3063@opindex fdump-translation-unit
3064Dump a representation of the tree structure for the entire translation
3065unit to a file. The file name is made by appending @file{.tu} to the
3066source file name. If the @samp{-@var{options}} form is used, @var{options}
3067controls the details of the dump as described for the
3068@option{-fdump-tree} options.
3069
3070@item -fdump-class-hierarchy @r{(C++ only)}
3071@itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3072@opindex fdump-class-hierarchy
3073Dump a representation of each class's hierarchy and virtual function
3074table layout to a file. The file name is made by appending @file{.class}
3075to the source file name. If the @samp{-@var{options}} form is used,
3076@var{options} controls the details of the dump as described for the
3077@option{-fdump-tree} options.
3078
3079@item -fdump-tree-@var{switch} @r{(C++ only)}
3080@itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3081@opindex fdump-tree
3082Control the dumping at various stages of processing the intermediate
3083language tree to a file. The file name is generated by appending a switch
3084specific suffix to the source file name. If the @samp{-@var{options}}
3085form is used, @var{options} is a list of @samp{-} separated options that
3086control the details of the dump. Not all options are applicable to all
3087dumps, those which are not meaningful will be ignored. The following
3088options are available
3089
3090@table @samp
3091@item address
3092Print the address of each node. Usually this is not meaningful as it
3093changes according to the environment and source file. Its primary use
3094is for tying up a dump file with a debug environment.
3095@item slim
3096Inhibit dumping of members of a scope or body of a function merely
3097because that scope has been reached. Only dump such items when they
3098are directly reachable by some other path.
3099@item all
3100Turn on all options.
3101@end table
3102
3103The following tree dumps are possible:
3104@table @samp
3105@item original
3106Dump before any tree based optimization, to @file{@var{file}.original}.
3107@item optimized
3108Dump after all tree based optimization, to @file{@var{file}.optimized}.
3109@item inlined
3110Dump after function inlining, to @file{@var{file}.inlined}.
3111@end table
3112
3113@item -save-temps
3114@opindex save-temps
3115Store the usual ``temporary'' intermediate files permanently; place them
3116in the current directory and name them based on the source file. Thus,
3117compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3118@file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
3119preprocessed @file{foo.i} output file even though the compiler now
3120normally uses an integrated preprocessor.
3121
3122@item -time
3123@opindex time
3124Report the CPU time taken by each subprocess in the compilation
3125sequence. For C source files, this is the compiler proper and assembler
3126(plus the linker if linking is done). The output looks like this:
3127
3128@smallexample
3129# cc1 0.12 0.01
3130# as 0.00 0.01
3131@end smallexample
3132
3133The first number on each line is the ``user time,'' that is time spent
3134executing the program itself. The second number is ``system time,''
3135time spent executing operating system routines on behalf of the program.
3136Both numbers are in seconds.
3137
3138@item -print-file-name=@var{library}
3139@opindex print-file-name
3140Print the full absolute name of the library file @var{library} that
3141would be used when linking---and don't do anything else. With this
3142option, GCC does not compile or link anything; it just prints the
3143file name.
3144
3145@item -print-multi-directory
3146@opindex print-multi-directory
3147Print the directory name corresponding to the multilib selected by any
3148other switches present in the command line. This directory is supposed
3149to exist in @env{GCC_EXEC_PREFIX}.
3150
3151@item -print-multi-lib
3152@opindex print-multi-lib
3153Print the mapping from multilib directory names to compiler switches
3154that enable them. The directory name is separated from the switches by
3155@samp{;}, and each switch starts with an @samp{@@} instead of the
3156@samp{-}, without spaces between multiple switches. This is supposed to
3157ease shell-processing.
3158
3159@item -print-prog-name=@var{program}
3160@opindex print-prog-name
3161Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3162
3163@item -print-libgcc-file-name
3164@opindex print-libgcc-file-name
3165Same as @option{-print-file-name=libgcc.a}.
3166
3167This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3168but you do want to link with @file{libgcc.a}. You can do
3169
3170@example
3171gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3172@end example
3173
3174@item -print-search-dirs
3175@opindex print-search-dirs
3176Print the name of the configured installation directory and a list of
3177program and library directories gcc will search---and don't do anything else.
3178
3179This is useful when gcc prints the error message
3180@samp{installation problem, cannot exec cpp0: No such file or directory}.
3181To resolve this you either need to put @file{cpp0} and the other compiler
3182components where gcc expects to find them, or you can set the environment
3183variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3184Don't forget the trailing '/'.
3185@xref{Environment Variables}.
3186
3187@item -dumpmachine
3188@opindex dumpmachine
3189Print the compiler's target machine (for example,
3190@samp{i686-pc-linux-gnu})---and don't do anything else.
3191
3192@item -dumpversion
3193@opindex dumpversion
3194Print the compiler version (for example, @samp{3.0})---and don't do
3195anything else.
3196
3197@item -dumpspecs
3198@opindex dumpspecs
3199Print the compiler's built-in specs---and don't do anything else. (This
3200is used when GCC itself is being built.) @xref{Spec Files}.
3201@end table
3202
3203@node Optimize Options
3204@section Options That Control Optimization
3205@cindex optimize options
3206@cindex options, optimization
3207
3208These options control various sorts of optimizations:
3209
3210@table @gcctabopt
3211@item -O
3212@itemx -O1
3213@opindex O
3214@opindex O1
3215Optimize. Optimizing compilation takes somewhat more time, and a lot
3216more memory for a large function.
3217
3218Without @option{-O}, the compiler's goal is to reduce the cost of
3219compilation and to make debugging produce the expected results.
3220Statements are independent: if you stop the program with a breakpoint
3221between statements, you can then assign a new value to any variable or
3222change the program counter to any other statement in the function and
3223get exactly the results you would expect from the source code.
3224
3225With @option{-O}, the compiler tries to reduce code size and execution
3226time, without performing any optimizations that take a great deal of
3227compilation time.
3228
3229@item -O2
3230@opindex O2
3231Optimize even more. GCC performs nearly all supported optimizations
3232that do not involve a space-speed tradeoff. The compiler does not
3233perform loop unrolling or function inlining when you specify @option{-O2}.
3234As compared to @option{-O}, this option increases both compilation time
3235and the performance of the generated code.
3236
3237@option{-O2} turns on all optional optimizations except for loop
3238unrolling, function inlining, and register renaming. It also turns on
3239the @option{-fforce-mem} and @option{-fstrict-aliasing} option on all
3240machines and frame pointer elimination on machines where doing so does
3241not interfere with debugging.
3242
3243Please note the warning under @option{-fgcse} about
3244invoking @option{-O2} on programs that use computed gotos.
3245
3246@item -O3
3247@opindex O3
3248Optimize yet more. @option{-O3} turns on all optimizations specified by
3249@option{-O2} and also turns on the @option{-finline-functions} and
3250@option{-frename-registers} options.
3251
3252@item -O0
3253@opindex O0
3254Do not optimize.
3255
3256@item -Os
3257@opindex Os
3258Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
3259do not typically increase code size. It also performs further
3260optimizations designed to reduce code size.
3261
3262If you use multiple @option{-O} options, with or without level numbers,
3263the last such option is the one that is effective.
3264@end table
3265
3266Options of the form @option{-f@var{flag}} specify machine-independent
3267flags. Most flags have both positive and negative forms; the negative
3268form of @option{-ffoo} would be @option{-fno-foo}. In the table below,
3269only one of the forms is listed---the one which is not the default.
3270You can figure out the other form by either removing @samp{no-} or
3271adding it.
3272
3273@table @gcctabopt
3274@item -ffloat-store
3275@opindex ffloat-store
3276Do not store floating point variables in registers, and inhibit other
3277options that might change whether a floating point value is taken from a
3278register or memory.
3279
3280@cindex floating point precision
3281This option prevents undesirable excess precision on machines such as
3282the 68000 where the floating registers (of the 68881) keep more
3283precision than a @code{double} is supposed to have. Similarly for the
3284x86 architecture. For most programs, the excess precision does only
3285good, but a few programs rely on the precise definition of IEEE floating
3286point. Use @option{-ffloat-store} for such programs, after modifying
3287them to store all pertinent intermediate computations into variables.
3288
3289@item -fno-default-inline
3290@opindex fno-default-inline
3291Do not make member functions inline by default merely because they are
3292defined inside the class scope (C++ only). Otherwise, when you specify
3293@w{@option{-O}}, member functions defined inside class scope are compiled
3294inline by default; i.e., you don't need to add @samp{inline} in front of
3295the member function name.
3296
3297@item -fno-defer-pop
3298@opindex fno-defer-pop
3299Always pop the arguments to each function call as soon as that function
3300returns. For machines which must pop arguments after a function call,
3301the compiler normally lets arguments accumulate on the stack for several
3302function calls and pops them all at once.
3303
3304@item -fforce-mem
3305@opindex fforce-mem
3306Force memory operands to be copied into registers before doing
3307arithmetic on them. This produces better code by making all memory
3308references potential common subexpressions. When they are not common
3309subexpressions, instruction combination should eliminate the separate
3310register-load. The @option{-O2} option turns on this option.
3311
3312@item -fforce-addr
3313@opindex fforce-addr
3314Force memory address constants to be copied into registers before
3315doing arithmetic on them. This may produce better code just as
3316@option{-fforce-mem} may.
3317
3318@item -fomit-frame-pointer
3319@opindex fomit-frame-pointer
3320Don't keep the frame pointer in a register for functions that
3321don't need one. This avoids the instructions to save, set up and
3322restore frame pointers; it also makes an extra register available
3323in many functions. @strong{It also makes debugging impossible on
3324some machines.}
3325
3326On some machines, such as the VAX, this flag has no effect, because
3327the standard calling sequence automatically handles the frame pointer
3328and nothing is saved by pretending it doesn't exist. The
3329machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3330whether a target machine supports this flag. @xref{Registers,,Register
3331Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3332
3333@item -foptimize-sibling-calls
3334@opindex foptimize-sibling-calls
3335Optimize sibling and tail recursive calls.
3336
3337@item -ftrapv
3338@opindex ftrapv
3339This option generates traps for signed overflow on addition, subtraction,
3340multiplication operations.
3341
3342@item -fno-inline
3343@opindex fno-inline
3344Don't pay attention to the @code{inline} keyword. Normally this option
3345is used to keep the compiler from expanding any functions inline.
3346Note that if you are not optimizing, no functions can be expanded inline.
3347
3348@item -finline-functions
3349@opindex finline-functions
3350Integrate all simple functions into their callers. The compiler
3351heuristically decides which functions are simple enough to be worth
3352integrating in this way.
3353
3354If all calls to a given function are integrated, and the function is
3355declared @code{static}, then the function is normally not output as
3356assembler code in its own right.
3357
3358@item -finline-limit=@var{n}
3359@opindex finline-limit
3360By default, gcc limits the size of functions that can be inlined. This flag
3361allows the control of this limit for functions that are explicitly marked as
3362inline (ie marked with the inline keyword or defined within the class
3363definition in c++). @var{n} is the size of functions that can be inlined in
3364number of pseudo instructions (not counting parameter handling). The default
3365value of @var{n} is 600.
3366Increasing this value can result in more inlined code at
3367the cost of compilation time and memory consumption. Decreasing usually makes
3368the compilation faster and less code will be inlined (which presumably
3369means slower programs). This option is particularly useful for programs that
3370use inlining heavily such as those based on recursive templates with C++.
3371
3372@emph{Note:} pseudo instruction represents, in this particular context, an
3373abstract measurement of function's size. In no way, it represents a count
3374of assembly instructions and as such its exact meaning might change from one
3375release to an another.
3376
3377@item -fkeep-inline-functions
3378@opindex fkeep-inline-functions
3379Even if all calls to a given function are integrated, and the function
3380is declared @code{static}, nevertheless output a separate run-time
3381callable version of the function. This switch does not affect
3382@code{extern inline} functions.
3383
3384@item -fkeep-static-consts
3385@opindex fkeep-static-consts
3386Emit variables declared @code{static const} when optimization isn't turned
3387on, even if the variables aren't referenced.
3388
3389GCC enables this option by default. If you want to force the compiler to
3390check if the variable was referenced, regardless of whether or not
3391optimization is turned on, use the @option{-fno-keep-static-consts} option.
3392
3393@item -fmerge-constants
3394Attempt to merge identical constants (string constants and floating point
3395constants) accross compilation units.
3396
3397This option is default for optimized compilation if assembler and linker
3398support it. Use @option{-fno-merge-constants} to inhibit this behavior.
3399
3400@item -fmerge-all-constants
3401Attempt to merge identical constants and identical variables.
3402
3403This option implies @option{-fmerge-constants}. In addition to
3404@option{-fmerge-constants} this considers e.g. even constant initialized
3405arrays or initialized constant variables with integral or floating point
3406types. Languages like C or C++ require each non-automatic variable to
3407have distinct location, so using this option will result in non-conforming
3408behavior.
3409
3410@item -fnew-ra
3411@opindex fnew-ra
3412Use a graph coloring register allocator. Currently this option is meant
3413for testing, so we are interested to hear about miscompilations with
3414@option{-fnew-ra}.
3415
3416@item -fno-function-cse
3417@opindex fno-function-cse
3418Do not put function addresses in registers; make each instruction that
3419calls a constant function contain the function's address explicitly.
3420
3421This option results in less efficient code, but some strange hacks
3422that alter the assembler output may be confused by the optimizations
3423performed when this option is not used.
3424
3425@item -ffast-math
3426@opindex ffast-math
3427Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
3428@option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
3429@option{-fno-signaling-nans}.
3430
3431This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3432
3433This option should never be turned on by any @option{-O} option since
3434it can result in incorrect output for programs which depend on
3435an exact implementation of IEEE or ISO rules/specifications for
3436math functions.
3437
3438@item -fno-math-errno
3439@opindex fno-math-errno
3440Do not set ERRNO after calling math functions that are executed
3441with a single instruction, e.g., sqrt. A program that relies on
3442IEEE exceptions for math error handling may want to use this flag
3443for speed while maintaining IEEE arithmetic compatibility.
3444
3445This option should never be turned on by any @option{-O} option since
3446it can result in incorrect output for programs which depend on
3447an exact implementation of IEEE or ISO rules/specifications for
3448math functions.
3449
3450The default is @option{-fmath-errno}.
3451
3452@item -funsafe-math-optimizations
3453@opindex funsafe-math-optimizations
3454Allow optimizations for floating-point arithmetic that (a) assume
3455that arguments and results are valid and (b) may violate IEEE or
3456ANSI standards. When used at link-time, it may include libraries
3457or startup files that change the default FPU control word or other
3458similar optimizations.
3459
3460This option should never be turned on by any @option{-O} option since
3461it can result in incorrect output for programs which depend on
3462an exact implementation of IEEE or ISO rules/specifications for
3463math functions.
3464
3465The default is @option{-fno-unsafe-math-optimizations}.
3466
3467@item -ffinite-math-only
3468@opindex ffinite-math-only
3469Allow optimizations for floating-point arithmetic that assume
3470that arguments and results are not NaNs or +-Infs.
3471
3472This option should never be turned on by any @option{-O} option since
3473it can result in incorrect output for programs which depend on
3474an exact implementation of IEEE or ISO rules/specifications.
3475
3476The default is @option{-fno-finite-math-only}.
3477
3478@item -fno-trapping-math
3479@opindex fno-trapping-math
3480Compile code assuming that floating-point operations cannot generate
3481user-visible traps. These traps include division by zero, overflow,
3482underflow, inexact result and invalid operation. This option implies
3483@option{-fno-signaling-nans}. Setting this option may allow faster
3484code if one relies on ``non-stop'' IEEE arithmetic, for example.
3485
3486This option should never be turned on by any @option{-O} option since
3487it can result in incorrect output for programs which depend on
3488an exact implementation of IEEE or ISO rules/specifications for
3489math functions.
3490
3491The default is @option{-ftrapping-math}.
3492
3493@item -fsignaling-nans
3494@opindex fsignaling-nans
3495Compile code assuming that IEEE signaling NaNs may generate user-visible
3496traps during floating-point operations. Setting this option disables
3497optimizations that may change the number of exceptions visible with
3498signaling NaNs. This option implies @option{-ftrapping-math}.
3499
3500This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
3501be defined.
3502
3503The default is @option{-fno-signaling-nans}.
3504
3505This option is experimental and does not currently guarantee to
3506disable all GCC optimizations that affect signaling NaN behavior.
3507
3508@item -fno-zero-initialized-in-bss
3509@opindex fno-zero-initialized-in-bss
3510If the target supports a BSS section, GCC by default puts variables that
3511are initialized to zero into BSS@. This can save space in the resulting
3512code.
3513
3514This option turns off this behavior because some programs explicitly
3515rely on variables going to the data section. E.g., so that the
3516resulting executable can find the beginning of that section and/or make
3517assumptions based on that.
3518
3519The default is @option{-fzero-initialized-in-bss}.
3520@end table
3521
3522The following options control specific optimizations. The @option{-O2}
3523option turns on all of these optimizations except @option{-funroll-loops}
3524and @option{-funroll-all-loops}. On most machines, the @option{-O} option
3525turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
3526but specific machines may handle it differently.
3527
3528You can use the following flags in the rare cases when ``fine-tuning''
3529of optimizations to be performed is desired.
3530
3531Not all of the optimizations performed by GCC have @option{-f} options
3532to control them.
3533
3534@table @gcctabopt
3535@item -fstrength-reduce
3536@opindex fstrength-reduce
3537Perform the optimizations of loop strength reduction and
3538elimination of iteration variables.
3539
3540@item -fthread-jumps
3541@opindex fthread-jumps
3542Perform optimizations where we check to see if a jump branches to a
3543location where another comparison subsumed by the first is found. If
3544so, the first branch is redirected to either the destination of the
3545second branch or a point immediately following it, depending on whether
3546the condition is known to be true or false.
3547
3548@item -fcse-follow-jumps
3549@opindex fcse-follow-jumps
3550In common subexpression elimination, scan through jump instructions
3551when the target of the jump is not reached by any other path. For
3552example, when CSE encounters an @code{if} statement with an
3553@code{else} clause, CSE will follow the jump when the condition
3554tested is false.
3555
3556@item -fcse-skip-blocks
3557@opindex fcse-skip-blocks
3558This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3559follow jumps which conditionally skip over blocks. When CSE
3560encounters a simple @code{if} statement with no else clause,
3561@option{-fcse-skip-blocks} causes CSE to follow the jump around the
3562body of the @code{if}.
3563
3564@item -frerun-cse-after-loop
3565@opindex frerun-cse-after-loop
3566Re-run common subexpression elimination after loop optimizations has been
3567performed.
3568
3569@item -frerun-loop-opt
3570@opindex frerun-loop-opt
3571Run the loop optimizer twice.
3572
3573@item -fgcse
3574@opindex fgcse
3575Perform a global common subexpression elimination pass.
3576This pass also performs global constant and copy propagation.
3577
3578@emph{Note:} When compiling a program using computed gotos, a GCC
3579extension, you may get better runtime performance if you disable
3580the global common subexpression elmination pass by adding
3581@option{-fno-gcse} to the command line.
3582
3583@item -fgcse-lm
3584@opindex fgcse-lm
3585When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3586attempt to move loads which are only killed by stores into themselves. This
3587allows a loop containing a load/store sequence to be changed to a load outside
3588the loop, and a copy/store within the loop.
3589
3590@item -fgcse-sm
3591@opindex fgcse-sm
3592When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3593subexpression elimination. This pass will attempt to move stores out of loops.
3594When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3595can be changed to a load before the loop and a store after the loop.
3596
3597@item -floop-optimize
3598@opindex floop-optimize
3599Perform loop optimizations: move constant expressions out of loops, simplify
3600exit test conditions and optionally do strength-reduction and loop unrolling as
3601well.
3602
3603@item -fcrossjumping
3604@opindex crossjumping
3605Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3606resulting code may or may not perform better than without cross-jumping.
3607
3608@item -fif-conversion
3609@opindex if-conversion
3610Attempt to transform conditional jumps into branch-less equivalents. This
3611include use of conditional moves, min, max, set flags and abs instructions, and
3612some tricks doable by standard arithmetics. The use of conditional execution
3613on chips where it is available is controlled by @code{if-conversion2}.
3614
3615@item -fif-conversion2
3616@opindex if-conversion2
3617Use conditional execution (where available) to transform conditional jumps into
3618branch-less equivalents.
3619
3620@item -fdelete-null-pointer-checks
3621@opindex fdelete-null-pointer-checks
3622Use global dataflow analysis to identify and eliminate useless checks
3623for null pointers. The compiler assumes that dereferencing a null
3624pointer would have halted the program. If a pointer is checked after
3625it has already been dereferenced, it cannot be null.
3626
3627In some environments, this assumption is not true, and programs can
3628safely dereference null pointers. Use
3629@option{-fno-delete-null-pointer-checks} to disable this optimization
3630for programs which depend on that behavior.
3631
3632@item -fexpensive-optimizations
3633@opindex fexpensive-optimizations
3634Perform a number of minor optimizations that are relatively expensive.
3635
3636@item -foptimize-register-move
3637@itemx -fregmove
3638@opindex foptimize-register-move
3639@opindex fregmove
3640Attempt to reassign register numbers in move instructions and as
3641operands of other simple instructions in order to maximize the amount of
3642register tying. This is especially helpful on machines with two-operand
3643instructions. GCC enables this optimization by default with @option{-O2}
3644or higher.
3645
3646Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3647optimization.
3648
3649@item -fdelayed-branch
3650@opindex fdelayed-branch
3651If supported for the target machine, attempt to reorder instructions
3652to exploit instruction slots available after delayed branch
3653instructions.
3654
3655@item -fschedule-insns
3656@opindex fschedule-insns
3657If supported for the target machine, attempt to reorder instructions to
3658eliminate execution stalls due to required data being unavailable. This
3659helps machines that have slow floating point or memory load instructions
3660by allowing other instructions to be issued until the result of the load
3661or floating point instruction is required.
3662
3663@item -fschedule-insns2
3664@opindex fschedule-insns2
3665Similar to @option{-fschedule-insns}, but requests an additional pass of
3666instruction scheduling after register allocation has been done. This is
3667especially useful on machines with a relatively small number of
3668registers and where memory load instructions take more than one cycle.
3669
3670@item -ffunction-sections
3671@itemx -fdata-sections
3672@opindex ffunction-sections
3673@opindex fdata-sections
3674Place each function or data item into its own section in the output
3675file if the target supports arbitrary sections. The name of the
3676function or the name of the data item determines the section's name
3677in the output file.
3678
3679Use these options on systems where the linker can perform optimizations
3680to improve locality of reference in the instruction space. HPPA
3681processors running HP-UX and Sparc processors running Solaris 2 have
3682linkers with such optimizations. Other systems using the ELF object format
3683as well as AIX may have these optimizations in the future.
3684
3685Only use these options when there are significant benefits from doing
3686so. When you specify these options, the assembler and linker will
3687create larger object and executable files and will also be slower.
3688You will not be able to use @code{gprof} on all systems if you
3689specify this option and you may have problems with debugging if
3690you specify both this option and @option{-g}.
3691
3692@item -fcaller-saves
3693@opindex fcaller-saves
3694Enable values to be allocated in registers that will be clobbered by
3695function calls, by emitting extra instructions to save and restore the
3696registers around such calls. Such allocation is done only when it
3697seems to result in better code than would otherwise be produced.
3698
3699This option is always enabled by default on certain machines, usually
3700those which have no call-preserved registers to use instead.
3701
3702For all machines, optimization level 2 and higher enables this flag by
3703default.
3704
3705@item -ftracer
3706@opindex ftracer
3707Perform tail duplication to enlarge superblock size. This transformation
3708simplifies the control flow of the function allowing other optimizations to do
3709better job.
3710
3711@item -funroll-loops
3712@opindex funroll-loops
3713Unroll loops whose number of iterations can be determined at compile
3714time or upon entry to the loop. @option{-funroll-loops} implies both
3715@option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
3716option makes code larger, and may or may not make it run faster.
3717
3718@item -funroll-all-loops
3719@opindex funroll-all-loops
3720Unroll all loops, even if their number of iterations is uncertain when
3721the loop is entered. This usually makes programs run more slowly.
3722@option{-funroll-all-loops} implies the same options as
3723@option{-funroll-loops},
3724
3725@item -fprefetch-loop-arrays
3726@opindex fprefetch-loop-arrays
3727If supported by the target machine, generate instructions to prefetch
3728memory to improve the performance of loops that access large arrays.
3729
3730@item -fmove-all-movables
3731@opindex fmove-all-movables
3732Forces all invariant computations in loops to be moved
3733outside the loop.
3734
3735@item -freduce-all-givs
3736@opindex freduce-all-givs
3737Forces all general-induction variables in loops to be
3738strength-reduced.
3739
3740@emph{Note:} When compiling programs written in Fortran,
3741@option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3742by default when you use the optimizer.
3743
3744These options may generate better or worse code; results are highly
3745dependent on the structure of loops within the source code.
3746
3747These two options are intended to be removed someday, once
3748they have helped determine the efficacy of various
3749approaches to improving loop optimizations.
3750
3751Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3752know how use of these options affects
3753the performance of your production code.
3754We're very interested in code that runs @emph{slower}
3755when these options are @emph{enabled}.
3756
3757@item -fno-peephole
3758@itemx -fno-peephole2
3759@opindex fno-peephole
3760@opindex fno-peephole2
3761Disable any machine-specific peephole optimizations. The difference
3762between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3763are implemented in the compiler; some targets use one, some use the
3764other, a few use both.
3765
3766@item -fbranch-probabilities
3767@opindex fbranch-probabilities
3768After running a program compiled with @option{-fprofile-arcs}
3769(@pxref{Debugging Options,, Options for Debugging Your Program or
3770@command{gcc}}), you can compile it a second time using
3771@option{-fbranch-probabilities}, to improve optimizations based on
3772the number of times each branch was taken. When the program
3773compiled with @option{-fprofile-arcs} exits it saves arc execution
3774counts to a file called @file{@var{sourcename}.da} for each source
3775file The information in this data file is very dependent on the
3776structure of the generated code, so you must use the same source code
3777and the same optimization options for both compilations.
3778
3779With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3780note on the first instruction of each basic block, and a
3781@samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3782These can be used to improve optimization. Currently, they are only
3783used in one place: in @file{reorg.c}, instead of guessing which path a
3784branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3785exactly determine which path is taken more often.
3786
3787@item -fno-guess-branch-probability
3788@opindex fno-guess-branch-probability
3789Do not guess branch probabilities using a randomized model.
3790
3791Sometimes gcc will opt to use a randomized model to guess branch
3792probabilities, when none are available from either profiling feedback
3793(@option{-fprofile-arcs}) or @samp{__builtin_expect}. This means that
3794different runs of the compiler on the same program may produce different
3795object code.
3796
3797In a hard real-time system, people don't want different runs of the
3798compiler to produce code that has different behavior; minimizing
3799non-determinism is of paramount import. This switch allows users to
3800reduce non-determinism, possibly at the expense of inferior
3801optimization.
3802
3803@item -freorder-blocks
3804@opindex freorder-blocks
3805Reorder basic blocks in the compiled function in order to reduce number of
3806taken branches and improve code locality.
3807
3808@item -freorder-functions
3809@opindex freorder-functions
3810Reorder basic blocks in the compiled function in order to reduce number of
3811taken branches and improve code locality. This is implemented by using special
3812subsections @code{text.hot} for most frequently executed functions and
3813@code{text.unlikely} for unlikely executed functions. Reordering is done by
3814the linker so object file format must support named sections and linker must
3815place them in resonable way.
3816
3817Also profile feedback must be available in to make this option effective. See
3818@option{-fprofile-arcs} for details.
3819
3820@item -fstrict-aliasing
3821@opindex fstrict-aliasing
3822Allows the compiler to assume the strictest aliasing rules applicable to
3823the language being compiled. For C (and C++), this activates
3824optimizations based on the type of expressions. In particular, an
3825object of one type is assumed never to reside at the same address as an
3826object of a different type, unless the types are almost the same. For
3827example, an @code{unsigned int} can alias an @code{int}, but not a
3828@code{void*} or a @code{double}. A character type may alias any other
3829type.
3830
3831Pay special attention to code like this:
3832@example
3833union a_union @{
3834 int i;
3835 double d;
3836@};
3837
3838int f() @{
3839 a_union t;
3840 t.d = 3.0;
3841 return t.i;
3842@}
3843@end example
3844The practice of reading from a different union member than the one most
3845recently written to (called ``type-punning'') is common. Even with
3846@option{-fstrict-aliasing}, type-punning is allowed, provided the memory
3847is accessed through the union type. So, the code above will work as
3848expected. However, this code might not:
3849@example
3850int f() @{
3851 a_union t;
3852 int* ip;
3853 t.d = 3.0;
3854 ip = &t.i;
3855 return *ip;
3856@}
3857@end example
3858
3859Every language that wishes to perform language-specific alias analysis
3860should define a function that computes, given an @code{tree}
3861node, an alias set for the node. Nodes in different alias sets are not
3862allowed to alias. For an example, see the C front-end function
3863@code{c_get_alias_set}.
3864
3865For all machines, optimization level 2 and higher enables this flag by
3866default.
3867
3868@item -falign-functions
3869@itemx -falign-functions=@var{n}
3870@opindex falign-functions
3871Align the start of functions to the next power-of-two greater than
3872@var{n}, skipping up to @var{n} bytes. For instance,
3873@option{-falign-functions=32} aligns functions to the next 32-byte
3874boundary, but @option{-falign-functions=24} would align to the next
387532-byte boundary only if this can be done by skipping 23 bytes or less.
3876
3877@option{-fno-align-functions} and @option{-falign-functions=1} are
3878equivalent and mean that functions will not be aligned.
3879
3880Some assemblers only support this flag when @var{n} is a power of two;
3881in that case, it is rounded up.
3882
3883If @var{n} is not specified, use a machine-dependent default.
3884
3885@item -falign-labels
3886@itemx -falign-labels=@var{n}
3887@opindex falign-labels
3888Align all branch targets to a power-of-two boundary, skipping up to
3889@var{n} bytes like @option{-falign-functions}. This option can easily
3890make code slower, because it must insert dummy operations for when the
3891branch target is reached in the usual flow of the code.
3892
3893If @option{-falign-loops} or @option{-falign-jumps} are applicable and
3894are greater than this value, then their values are used instead.
3895
3896If @var{n} is not specified, use a machine-dependent default which is
3897very likely to be @samp{1}, meaning no alignment.
3898
3899@item -falign-loops
3900@itemx -falign-loops=@var{n}
3901@opindex falign-loops
3902Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3903like @option{-falign-functions}. The hope is that the loop will be
3904executed many times, which will make up for any execution of the dummy
3905operations.
3906
3907If @var{n} is not specified, use a machine-dependent default.
3908
3909@item -falign-jumps
3910@itemx -falign-jumps=@var{n}
3911@opindex falign-jumps
3912Align branch targets to a power-of-two boundary, for branch targets
3913where the targets can only be reached by jumping, skipping up to @var{n}
3914bytes like @option{-falign-functions}. In this case, no dummy operations
3915need be executed.
3916
3917If @var{n} is not specified, use a machine-dependent default.
3918
3919@item -fssa
3920@opindex fssa
3921Perform optimizations in static single assignment form. Each function's
3922flow graph is translated into SSA form, optimizations are performed, and
3923the flow graph is translated back from SSA form. Users should not
3924specify this option, since it is not yet ready for production use.
3925
3926@item -fssa-ccp
3927@opindex fssa-ccp
3928Perform Sparse Conditional Constant Propagation in SSA form. Requires
3929@option{-fssa}. Like @option{-fssa}, this is an experimental feature.
3930
3931@item -fssa-dce
3932@opindex fssa-dce
3933Perform aggressive dead-code elimination in SSA form. Requires @option{-fssa}.
3934Like @option{-fssa}, this is an experimental feature.
3935
3936@item -fsingle-precision-constant
3937@opindex fsingle-precision-constant
3938Treat floating point constant as single precision constant instead of
3939implicitly converting it to double precision constant.
3940
3941@item -frename-registers
3942@opindex frename-registers
3943Attempt to avoid false dependencies in scheduled code by making use
3944of registers left over after register allocation. This optimization
3945will most benefit processors with lots of registers. It can, however,
3946make debugging impossible, since variables will no longer stay in
3947a ``home register''.
3948
3949@item -fno-cprop-registers
3950@opindex fno-cprop-registers
3951After register allocation and post-register allocation instruction splitting,
3952we perform a copy-propagation pass to try to reduce scheduling dependencies
3953and occasionally eliminate the copy.
3954
3955@item --param @var{name}=@var{value}
3956@opindex param
3957In some places, GCC uses various constants to control the amount of
3958optimization that is done. For example, GCC will not inline functions
3959that contain more that a certain number of instructions. You can
3960control some of these constants on the command-line using the
3961@option{--param} option.
3962
3963In each case, the @var{value} is an integer. The allowable choices for
3964@var{name} are given in the following table:
3965
3966@table @gcctabopt
3967@item max-delay-slot-insn-search
3968The maximum number of instructions to consider when looking for an
3969instruction to fill a delay slot. If more than this arbitrary number of
3970instructions is searched, the time savings from filling the delay slot
3971will be minimal so stop searching. Increasing values mean more
3972aggressive optimization, making the compile time increase with probably
3973small improvement in executable run time.
3974
3975@item max-delay-slot-live-search
3976When trying to fill delay slots, the maximum number of instructions to
3977consider when searching for a block with valid live register
3978information. Increasing this arbitrarily chosen value means more
3979aggressive optimization, increasing the compile time. This parameter
3980should be removed when the delay slot code is rewritten to maintain the
3981control-flow graph.
3982
3983@item max-gcse-memory
3984The approximate maximum amount of memory that will be allocated in
3985order to perform the global common subexpression elimination
3986optimization. If more memory than specified is required, the
3987optimization will not be done.
3988
3989@item max-gcse-passes
3990The maximum number of passes of GCSE to run.
3991
3992@item max-pending-list-length
3993The maximum number of pending dependencies scheduling will allow
3994before flushing the current state and starting over. Large functions
3995with few branches or calls can create excessively large lists which
3996needlessly consume memory and resources.
3997
3998@item max-inline-insns
3999If an function contains more than this many instructions, it
4000will not be inlined. This option is precisely equivalent to
4001@option{-finline-limit}.
4002
4003@item max-unrolled-insns
4004The maximum number of instructions that a loop should have if that loop
4005is unrolled, and if the loop is unrolled, it determines how many times
4006the loop code is unrolled.
4007
4008@item hot-bb-count-fraction
4009Select fraction of the maximal count of repetitions of basic block in program
4010given basic block needs to have to be considered hot.
4011
4012@item hot-bb-frequency-fraction
4013Select fraction of the maximal frequency of executions of basic block in
4014function given basic block needs to have to be considered hot
4015
4016@item tracer-dynamic-coverage
4017@itemx tracer-dynamic-coverage-feedback
4018
4019This value is used to limit superblock formation once given percentage of
4020executed instructions is covered. This limits unnecesary code size expansion.
4021
4022The @option{tracer-dynamic-coverage-feedback} is used only when profile
4023feedback is available. The real profiles (as opposed to statically estimated
4024ones) are much less balanced allowing the threshold to be larger value.
4025
4026@item tracer-max-code-growth
4027Stop tail duplication once code growth has reached given percentage. This is
4028rather hokey argument, as most of the duplicates will be elliminated later in
4029cross jumping, so it may be set to much higher values than is the desired code
4030growth.
4031
4032@item tracer-min-branch-ratio
4033
4034Stop reverse growth when the reverse probability of best edge is less than this
4035threshold (in percent).
4036
4037@item tracer-min-branch-ratio
4038@itemx tracer-min-branch-ratio-feedback
4039
4040Stop forward growth if the best edge do have probability lower than this
4041threshold.
4042
4043Similary to @option{tracer-dynamic-coverage} two values are present, one for
4044compilation for profile feedback and one for compilation without. The value
4045for compilation with profile feedback needs to be more conservative (higher) in
4046order to make tracer effective.
4047
4048@end table
4049@end table
4050
4051@node Preprocessor Options
4052@section Options Controlling the Preprocessor
4053@cindex preprocessor options
4054@cindex options, preprocessor
4055
4056These options control the C preprocessor, which is run on each C source
4057file before actual compilation.
4058
4059If you use the @option{-E} option, nothing is done except preprocessing.
4060Some of these options make sense only together with @option{-E} because
4061they cause the preprocessor output to be unsuitable for actual
4062compilation.
4063
4064@opindex Wp
4065You can use @option{-Wp,@var{option}} to bypass the compiler driver
4066and pass @var{option} directly through to the preprocessor. If
4067@var{option} contains commas, it is split into multiple options at the
4068commas. However, many options are modified, translated or interpreted
4069by the compiler driver before being passed to the preprocessor, and
4070@option{-Wp} forcibly bypasses this phase. The preprocessor's direct
4071interface is undocumented and subject to change, so whenever possible
4072you should avoid using @option{-Wp} and let the driver handle the
4073options instead.
4074
4075@include cppopts.texi
4076
4077@node Assembler Options
4078@section Passing Options to the Assembler
4079
4080@c prevent bad page break with this line
4081You can pass options to the assembler.
4082
4083@table @gcctabopt
4084@item -Wa,@var{option}
4085@opindex Wa
4086Pass @var{option} as an option to the assembler. If @var{option}
4087contains commas, it is split into multiple options at the commas.
4088@end table
4089
4090@node Link Options
4091@section Options for Linking
4092@cindex link options
4093@cindex options, linking
4094
4095These options come into play when the compiler links object files into
4096an executable output file. They are meaningless if the compiler is
4097not doing a link step.
4098
4099@table @gcctabopt
4100@cindex file names
4101@item @var{object-file-name}
4102A file name that does not end in a special recognized suffix is
4103considered to name an object file or library. (Object files are
4104distinguished from libraries by the linker according to the file
4105contents.) If linking is done, these object files are used as input
4106to the linker.
4107
4108@item -c
4109@itemx -S
4110@itemx -E
4111@opindex c
4112@opindex S
4113@opindex E
4114If any of these options is used, then the linker is not run, and
4115object file names should not be used as arguments. @xref{Overall
4116Options}.
4117
4118@cindex Libraries
4119@item -l@var{library}
4120@itemx -l @var{library}
4121@opindex l
4122Search the library named @var{library} when linking. (The second
4123alternative with the library as a separate argument is only for
4124POSIX compliance and is not recommended.)
4125
4126It makes a difference where in the command you write this option; the
4127linker searches and processes libraries and object files in the order they
4128are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4129after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
4130to functions in @samp{z}, those functions may not be loaded.
4131
4132The linker searches a standard list of directories for the library,
4133which is actually a file named @file{lib@var{library}.a}. The linker
4134then uses this file as if it had been specified precisely by name.
4135
4136The directories searched include several standard system directories
4137plus any that you specify with @option{-L}.
4138
4139Normally the files found this way are library files---archive files
4140whose members are object files. The linker handles an archive file by
4141scanning through it for members which define symbols that have so far
4142been referenced but not defined. But if the file that is found is an
4143ordinary object file, it is linked in the usual fashion. The only
4144difference between using an @option{-l} option and specifying a file name
4145is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4146and searches several directories.
4147
4148@item -lobjc
4149@opindex lobjc
4150You need this special case of the @option{-l} option in order to
4151link an Objective-C program.
4152
4153@item -nostartfiles
4154@opindex nostartfiles
4155Do not use the standard system startup files when linking.
4156The standard system libraries are used normally, unless @option{-nostdlib}
4157or @option{-nodefaultlibs} is used.
4158
4159@item -nodefaultlibs
4160@opindex nodefaultlibs
4161Do not use the standard system libraries when linking.
4162Only the libraries you specify will be passed to the linker.
4163The standard startup files are used normally, unless @option{-nostartfiles}
4164is used. The compiler may generate calls to memcmp, memset, and memcpy
4165for System V (and ISO C) environments or to bcopy and bzero for
4166BSD environments. These entries are usually resolved by entries in
4167libc. These entry points should be supplied through some other
4168mechanism when this option is specified.
4169
4170@item -nostdlib
4171@opindex nostdlib
4172Do not use the standard system startup files or libraries when linking.
4173No startup files and only the libraries you specify will be passed to
4174the linker. The compiler may generate calls to memcmp, memset, and memcpy
4175for System V (and ISO C) environments or to bcopy and bzero for
4176BSD environments. These entries are usually resolved by entries in
4177libc. These entry points should be supplied through some other
4178mechanism when this option is specified.
4179
4180@cindex @option{-lgcc}, use with @option{-nostdlib}
4181@cindex @option{-nostdlib} and unresolved references
4182@cindex unresolved references and @option{-nostdlib}
4183@cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4184@cindex @option{-nodefaultlibs} and unresolved references
4185@cindex unresolved references and @option{-nodefaultlibs}
4186One of the standard libraries bypassed by @option{-nostdlib} and
4187@option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4188that GCC uses to overcome shortcomings of particular machines, or special
4189needs for some languages.
4190(@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4191Collection (GCC) Internals},
4192for more discussion of @file{libgcc.a}.)
4193In most cases, you need @file{libgcc.a} even when you want to avoid
4194other standard libraries. In other words, when you specify @option{-nostdlib}
4195or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4196This ensures that you have no unresolved references to internal GCC
4197library subroutines. (For example, @samp{__main}, used to ensure C++
4198constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4199GNU Compiler Collection (GCC) Internals}.)
4200
4201@item -s
4202@opindex s
4203Remove all symbol table and relocation information from the executable.
4204
4205@item -static
4206@opindex static
4207On systems that support dynamic linking, this prevents linking with the shared
4208libraries. On other systems, this option has no effect.
4209
4210@item -shared
4211@opindex shared
4212Produce a shared object which can then be linked with other objects to
4213form an executable. Not all systems support this option. For predictable
4214results, you must also specify the same set of options that were used to
4215generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4216when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4217needs to build supplementary stub code for constructors to work. On
4218multi-libbed systems, @samp{gcc -shared} must select the correct support
4219libraries to link against. Failing to supply the correct flags may lead
4220to subtle defects. Supplying them in cases where they are not necessary
4221is innocuous.}
4222
4223@item -shared-libgcc
4224@itemx -static-libgcc
4225@opindex shared-libgcc
4226@opindex static-libgcc
4227On systems that provide @file{libgcc} as a shared library, these options
4228force the use of either the shared or static version respectively.
4229If no shared version of @file{libgcc} was built when the compiler was
4230configured, these options have no effect.
4231
4232There are several situations in which an application should use the
4233shared @file{libgcc} instead of the static version. The most common
4234of these is when the application wishes to throw and catch exceptions
4235across different shared libraries. In that case, each of the libraries
4236as well as the application itself should use the shared @file{libgcc}.
4237
4238Therefore, the G++ and GCJ drivers automatically add
4239@option{-shared-libgcc} whenever you build a shared library or a main
4240executable, because C++ and Java programs typically use exceptions, so
4241this is the right thing to do.
4242
4243If, instead, you use the GCC driver to create shared libraries, you may
4244find that they will not always be linked with the shared @file{libgcc}.
4245If GCC finds, at its configuration time, that you have a GNU linker that
4246does not support option @option{--eh-frame-hdr}, it will link the shared
4247version of @file{libgcc} into shared libraries by default. Otherwise,
4248it will take advantage of the linker and optimize away the linking with
4249the shared version of @file{libgcc}, linking with the static version of
4250libgcc by default. This allows exceptions to propagate through such
4251shared libraries, without incurring relocation costs at library load
4252time.
4253
4254However, if a library or main executable is supposed to throw or catch
4255exceptions, you must link it using the G++ or GCJ driver, as appropriate
4256for the languages used in the program, or using the option
4257@option{-shared-libgcc}, such that it is linked with the shared
4258@file{libgcc}.
4259
4260@item -symbolic
4261@opindex symbolic
4262Bind references to global symbols when building a shared object. Warn
4263about any unresolved references (unless overridden by the link editor
4264option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
4265this option.
4266
4267@item -Xlinker @var{option}
4268@opindex Xlinker
4269Pass @var{option} as an option to the linker. You can use this to
4270supply system-specific linker options which GCC does not know how to
4271recognize.
4272
4273If you want to pass an option that takes an argument, you must use
4274@option{-Xlinker} twice, once for the option and once for the argument.
4275For example, to pass @option{-assert definitions}, you must write
4276@samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
4277@option{-Xlinker "-assert definitions"}, because this passes the entire
4278string as a single argument, which is not what the linker expects.
4279
4280@item -Wl,@var{option}
4281@opindex Wl
4282Pass @var{option} as an option to the linker. If @var{option} contains
4283commas, it is split into multiple options at the commas.
4284
4285@item -u @var{symbol}
4286@opindex u
4287Pretend the symbol @var{symbol} is undefined, to force linking of
4288library modules to define it. You can use @option{-u} multiple times with
4289different symbols to force loading of additional library modules.
4290@end table
4291
4292@node Directory Options
4293@section Options for Directory Search
4294@cindex directory options
4295@cindex options, directory search
4296@cindex search path
4297
4298These options specify directories to search for header files, for
4299libraries and for parts of the compiler:
4300
4301@table @gcctabopt
4302@item -I@var{dir}
4303@opindex I
4304Add the directory @var{dir} to the head of the list of directories to be
4305searched for header files. This can be used to override a system header
4306file, substituting your own version, since these directories are
4307searched before the system header file directories. However, you should
4308not use this option to add directories that contain vendor-supplied
4309system header files (use @option{-isystem} for that). If you use more than
4310one @option{-I} option, the directories are scanned in left-to-right
4311order; the standard system directories come after.
4312
4313If a standard system include directory, or a directory specified with
4314@option{-isystem}, is also specified with @option{-I}, it will be
4315searched only in the position requested by @option{-I}. Also, it will
4316not be considered a system include directory. If that directory really
4317does contain system headers, there is a good chance that they will
4318break. For instance, if GCC's installation procedure edited the headers
4319in @file{/usr/include} to fix bugs, @samp{-I/usr/include} will cause the
4320original, buggy headers to be found instead of the corrected ones. GCC
4321will issue a warning when a system include directory is hidden in this
4322way.
4323
4324@item -I-
4325@opindex I-
4326Any directories you specify with @option{-I} options before the @option{-I-}
4327option are searched only for the case of @samp{#include "@var{file}"};
4328they are not searched for @samp{#include <@var{file}>}.
4329
4330If additional directories are specified with @option{-I} options after
4331the @option{-I-}, these directories are searched for all @samp{#include}
4332directives. (Ordinarily @emph{all} @option{-I} directories are used
4333this way.)
4334
4335In addition, the @option{-I-} option inhibits the use of the current
4336directory (where the current input file came from) as the first search
4337directory for @samp{#include "@var{file}"}. There is no way to
4338override this effect of @option{-I-}. With @option{-I.} you can specify
4339searching the directory which was current when the compiler was
4340invoked. That is not exactly the same as what the preprocessor does
4341by default, but it is often satisfactory.
4342
4343@option{-I-} does not inhibit the use of the standard system directories
4344for header files. Thus, @option{-I-} and @option{-nostdinc} are
4345independent.
4346
4347@item -L@var{dir}
4348@opindex L
4349Add directory @var{dir} to the list of directories to be searched
4350for @option{-l}.
4351
4352@item -B@var{prefix}
4353@opindex B
4354This option specifies where to find the executables, libraries,
4355include files, and data files of the compiler itself.
4356
4357The compiler driver program runs one or more of the subprograms
4358@file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
4359@var{prefix} as a prefix for each program it tries to run, both with and
4360without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4361
4362For each subprogram to be run, the compiler driver first tries the
4363@option{-B} prefix, if any. If that name is not found, or if @option{-B}
4364was not specified, the driver tries two standard prefixes, which are
4365@file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}. If neither of
4366those results in a file name that is found, the unmodified program
4367name is searched for using the directories specified in your
4368@env{PATH} environment variable.
4369
4370The compiler will check to see if the path provided by the @option{-B}
4371refers to a directory, and if necessary it will add a directory
4372separator character at the end of the path.
4373
4374@option{-B} prefixes that effectively specify directory names also apply
4375to libraries in the linker, because the compiler translates these
4376options into @option{-L} options for the linker. They also apply to
4377includes files in the preprocessor, because the compiler translates these
4378options into @option{-isystem} options for the preprocessor. In this case,
4379the compiler appends @samp{include} to the prefix.
4380
4381The run-time support file @file{libgcc.a} can also be searched for using
4382the @option{-B} prefix, if needed. If it is not found there, the two
4383standard prefixes above are tried, and that is all. The file is left
4384out of the link if it is not found by those means.
4385
4386Another way to specify a prefix much like the @option{-B} prefix is to use
4387the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
4388Variables}.
4389
4390As a special kludge, if the path provided by @option{-B} is
4391@file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
43929, then it will be replaced by @file{[dir/]include}. This is to help
4393with boot-strapping the compiler.
4394
4395@item -specs=@var{file}
4396@opindex specs
4397Process @var{file} after the compiler reads in the standard @file{specs}
4398file, in order to override the defaults that the @file{gcc} driver
4399program uses when determining what switches to pass to @file{cc1},
4400@file{cc1plus}, @file{as}, @file{ld}, etc. More than one
4401@option{-specs=@var{file}} can be specified on the command line, and they
4402are processed in order, from left to right.
4403@end table
4404
4405@c man end
4406
4407@node Spec Files
4408@section Specifying subprocesses and the switches to pass to them
4409@cindex Spec Files
4410@command{gcc} is a driver program. It performs its job by invoking a
4411sequence of other programs to do the work of compiling, assembling and
4412linking. GCC interprets its command-line parameters and uses these to
4413deduce which programs it should invoke, and which command-line options
4414it ought to place on their command lines. This behavior is controlled
4415by @dfn{spec strings}. In most cases there is one spec string for each
4416program that GCC can invoke, but a few programs have multiple spec
4417strings to control their behavior. The spec strings built into GCC can
4418be overridden by using the @option{-specs=} command-line switch to specify
4419a spec file.
4420
4421@dfn{Spec files} are plaintext files that are used to construct spec
4422strings. They consist of a sequence of directives separated by blank
4423lines. The type of directive is determined by the first non-whitespace
4424character on the line and it can be one of the following:
4425
4426@table @code
4427@item %@var{command}
4428Issues a @var{command} to the spec file processor. The commands that can
4429appear here are:
4430
4431@table @code
4432@item %include <@var{file}>
4433@cindex %include
4434Search for @var{file} and insert its text at the current point in the
4435specs file.
4436
4437@item %include_noerr <@var{file}>
4438@cindex %include_noerr
4439Just like @samp{%include}, but do not generate an error message if the include
4440file cannot be found.
4441
4442@item %rename @var{old_name} @var{new_name}
4443@cindex %rename
4444Rename the spec string @var{old_name} to @var{new_name}.
4445
4446@end table
4447
4448@item *[@var{spec_name}]:
4449This tells the compiler to create, override or delete the named spec
4450string. All lines after this directive up to the next directive or
4451blank line are considered to be the text for the spec string. If this
4452results in an empty string then the spec will be deleted. (Or, if the
4453spec did not exist, then nothing will happened.) Otherwise, if the spec
4454does not currently exist a new spec will be created. If the spec does
4455exist then its contents will be overridden by the text of this
4456directive, unless the first character of that text is the @samp{+}
4457character, in which case the text will be appended to the spec.
4458
4459@item [@var{suffix}]:
4460Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
4461and up to the next directive or blank line are considered to make up the
4462spec string for the indicated suffix. When the compiler encounters an
4463input file with the named suffix, it will processes the spec string in
4464order to work out how to compile that file. For example:
4465
4466@smallexample
4467.ZZ:
4468z-compile -input %i
4469@end smallexample
4470
4471This says that any input file whose name ends in @samp{.ZZ} should be
4472passed to the program @samp{z-compile}, which should be invoked with the
4473command-line switch @option{-input} and with the result of performing the
4474@samp{%i} substitution. (See below.)
4475
4476As an alternative to providing a spec string, the text that follows a
4477suffix directive can be one of the following:
4478
4479@table @code
4480@item @@@var{language}
4481This says that the suffix is an alias for a known @var{language}. This is
4482similar to using the @option{-x} command-line switch to GCC to specify a
4483language explicitly. For example:
4484
4485@smallexample
4486.ZZ:
4487@@c++
4488@end smallexample
4489
4490Says that .ZZ files are, in fact, C++ source files.
4491
4492@item #@var{name}
4493This causes an error messages saying:
4494
4495@smallexample
4496@var{name} compiler not installed on this system.
4497@end smallexample
4498@end table
4499
4500GCC already has an extensive list of suffixes built into it.
4501This directive will add an entry to the end of the list of suffixes, but
4502since the list is searched from the end backwards, it is effectively
4503possible to override earlier entries using this technique.
4504
4505@end table
4506
4507GCC has the following spec strings built into it. Spec files can
4508override these strings or create their own. Note that individual
4509targets can also add their own spec strings to this list.
4510
4511@smallexample
4512asm Options to pass to the assembler
4513asm_final Options to pass to the assembler post-processor
4514cpp Options to pass to the C preprocessor
4515cc1 Options to pass to the C compiler
4516cc1plus Options to pass to the C++ compiler
4517endfile Object files to include at the end of the link
4518link Options to pass to the linker
4519lib Libraries to include on the command line to the linker
4520libgcc Decides which GCC support library to pass to the linker
4521linker Sets the name of the linker
4522predefines Defines to be passed to the C preprocessor
4523signed_char Defines to pass to CPP to say whether @code{char} is signed
4524 by default
4525startfile Object files to include at the start of the link
4526@end smallexample
4527
4528Here is a small example of a spec file:
4529
4530@smallexample
4531%rename lib old_lib
4532
4533*lib:
4534--start-group -lgcc -lc -leval1 --end-group %(old_lib)
4535@end smallexample
4536
4537This example renames the spec called @samp{lib} to @samp{old_lib} and
4538then overrides the previous definition of @samp{lib} with a new one.
4539The new definition adds in some extra command-line options before
4540including the text of the old definition.
4541
4542@dfn{Spec strings} are a list of command-line options to be passed to their
4543corresponding program. In addition, the spec strings can contain
4544@samp{%}-prefixed sequences to substitute variable text or to
4545conditionally insert text into the command line. Using these constructs
4546it is possible to generate quite complex command lines.
4547
4548Here is a table of all defined @samp{%}-sequences for spec
4549strings. Note that spaces are not generated automatically around the
4550results of expanding these sequences. Therefore you can concatenate them
4551together or combine them with constant text in a single argument.
4552
4553@table @code
4554@item %%
4555Substitute one @samp{%} into the program name or argument.
4556
4557@item %i
4558Substitute the name of the input file being processed.
4559
4560@item %b
4561Substitute the basename of the input file being processed.
4562This is the substring up to (and not including) the last period
4563and not including the directory.
4564
4565@item %B
4566This is the same as @samp{%b}, but include the file suffix (text after
4567the last period).
4568
4569@item %d
4570Marks the argument containing or following the @samp{%d} as a
4571temporary file name, so that that file will be deleted if GCC exits
4572successfully. Unlike @samp{%g}, this contributes no text to the
4573argument.
4574
4575@item %g@var{suffix}
4576Substitute a file name that has suffix @var{suffix} and is chosen
4577once per compilation, and mark the argument in the same way as
4578@samp{%d}. To reduce exposure to denial-of-service attacks, the file
4579name is now chosen in a way that is hard to predict even when previously
4580chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4581might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
4582the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4583treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
4584was simply substituted with a file name chosen once per compilation,
4585without regard to any appended suffix (which was therefore treated
4586just like ordinary text), making such attacks more likely to succeed.
4587
4588@item %u@var{suffix}
4589Like @samp{%g}, but generates a new temporary file name even if
4590@samp{%u@var{suffix}} was already seen.
4591
4592@item %U@var{suffix}
4593Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4594new one if there is no such last file name. In the absence of any
4595@samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4596the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
4597would involve the generation of two distinct file names, one
4598for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
4599simply substituted with a file name chosen for the previous @samp{%u},
4600without regard to any appended suffix.
4601
4602@item %j@var{SUFFIX}
4603Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
4604writable, and if save-temps is off; otherwise, substitute the name
4605of a temporary file, just like @samp{%u}. This temporary file is not
4606meant for communication between processes, but rather as a junk
4607disposal mechanism.
4608
4609@item %.@var{SUFFIX}
4610Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4611when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4612terminated by the next space or %.
4613
4614@item %w
4615Marks the argument containing or following the @samp{%w} as the
4616designated output file of this compilation. This puts the argument
4617into the sequence of arguments that @samp{%o} will substitute later.
4618
4619@item %o
4620Substitutes the names of all the output files, with spaces
4621automatically placed around them. You should write spaces
4622around the @samp{%o} as well or the results are undefined.
4623@samp{%o} is for use in the specs for running the linker.
4624Input files whose names have no recognized suffix are not compiled
4625at all, but they are included among the output files, so they will
4626be linked.
4627
4628@item %O
4629Substitutes the suffix for object files. Note that this is
4630handled specially when it immediately follows @samp{%g, %u, or %U},
4631because of the need for those to form complete file names. The
4632handling is such that @samp{%O} is treated exactly as if it had already
4633been substituted, except that @samp{%g, %u, and %U} do not currently
4634support additional @var{suffix} characters following @samp{%O} as they would
4635following, for example, @samp{.o}.
4636
4637@item %p
4638Substitutes the standard macro predefinitions for the
4639current target machine. Use this when running @code{cpp}.
4640
4641@item %P
4642Like @samp{%p}, but puts @samp{__} before and after the name of each
4643predefined macro, except for macros that start with @samp{__} or with
4644@samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
4645C@.
4646
4647@item %I
4648Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
4649
4650@item %s
4651Current argument is the name of a library or startup file of some sort.
4652Search for that file in a standard list of directories and substitute
4653the full name found.
4654
4655@item %e@var{str}
4656Print @var{str} as an error message. @var{str} is terminated by a newline.
4657Use this when inconsistent options are detected.
4658
4659@item %|
4660Output @samp{-} if the input for the current command is coming from a pipe.
4661
4662@item %(@var{name})
4663Substitute the contents of spec string @var{name} at this point.
4664
4665@item %[@var{name}]
4666Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
4667
4668@item %x@{@var{option}@}
4669Accumulate an option for @samp{%X}.
4670
4671@item %X
4672Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
4673spec string.
4674
4675@item %Y
4676Output the accumulated assembler options specified by @option{-Wa}.
4677
4678@item %Z
4679Output the accumulated preprocessor options specified by @option{-Wp}.
4680
4681@item %v1
4682Substitute the major version number of GCC@.
4683(For version 2.9.5, this is 2.)
4684
4685@item %v2
4686Substitute the minor version number of GCC@.
4687(For version 2.9.5, this is 9.)
4688
4689@item %v3
4690Substitute the patch level number of GCC@.
4691(For version 2.9.5, this is 5.)
4692
4693@item %a
4694Process the @code{asm} spec. This is used to compute the
4695switches to be passed to the assembler.
4696
4697@item %A
4698Process the @code{asm_final} spec. This is a spec string for
4699passing switches to an assembler post-processor, if such a program is
4700needed.
4701
4702@item %l
4703Process the @code{link} spec. This is the spec for computing the
4704command line passed to the linker. Typically it will make use of the
4705@samp{%L %G %S %D and %E} sequences.
4706
4707@item %D
4708Dump out a @option{-L} option for each directory that GCC believes might
4709contain startup files. If the target supports multilibs then the
4710current multilib directory will be prepended to each of these paths.
4711
4712@item %M
4713Output the multilib directory with directory separators replaced with
4714@samp{_}. If multilib directories are not set, or the multilib directory is
4715@file{.} then this option emits nothing.
4716
4717@item %L
4718Process the @code{lib} spec. This is a spec string for deciding which
4719libraries should be included on the command line to the linker.
4720
4721@item %G
4722Process the @code{libgcc} spec. This is a spec string for deciding
4723which GCC support library should be included on the command line to the linker.
4724
4725@item %S
4726Process the @code{startfile} spec. This is a spec for deciding which
4727object files should be the first ones passed to the linker. Typically
4728this might be a file named @file{crt0.o}.
4729
4730@item %E
4731Process the @code{endfile} spec. This is a spec string that specifies
4732the last object files that will be passed to the linker.
4733
4734@item %C
4735Process the @code{cpp} spec. This is used to construct the arguments
4736to be passed to the C preprocessor.
4737
4738@item %c
4739Process the @code{signed_char} spec. This is intended to be used
4740to tell cpp whether a char is signed. It typically has the definition:
4741@smallexample
4742%@{funsigned-char:-D__CHAR_UNSIGNED__@}
4743@end smallexample
4744
4745@item %1
4746Process the @code{cc1} spec. This is used to construct the options to be
4747passed to the actual C compiler (@samp{cc1}).
4748
4749@item %2
4750Process the @code{cc1plus} spec. This is used to construct the options to be
4751passed to the actual C++ compiler (@samp{cc1plus}).
4752
4753@item %*
4754Substitute the variable part of a matched option. See below.
4755Note that each comma in the substituted string is replaced by
4756a single space.
4757
4758@item %@{@code{S}@}
4759Substitutes the @code{-S} switch, if that switch was given to GCC@.
4760If that switch was not specified, this substitutes nothing. Note that
4761the leading dash is omitted when specifying this option, and it is
4762automatically inserted if the substitution is performed. Thus the spec
4763string @samp{%@{foo@}} would match the command-line option @option{-foo}
4764and would output the command line option @option{-foo}.
4765
4766@item %W@{@code{S}@}
4767Like %@{@code{S}@} but mark last argument supplied within as a file to be
4768deleted on failure.
4769
4770@item %@{@code{S}*@}
4771Substitutes all the switches specified to GCC whose names start
4772with @code{-S}, but which also take an argument. This is used for
4773switches like @option{-o}, @option{-D}, @option{-I}, etc.
4774GCC considers @option{-o foo} as being
4775one switch whose names starts with @samp{o}. %@{o*@} would substitute this
4776text, including the space. Thus two arguments would be generated.
4777
4778@item %@{^@code{S}*@}
4779Like %@{@code{S}*@}, but don't put a blank between a switch and its
4780argument. Thus %@{^o*@} would only generate one argument, not two.
4781
4782@item %@{@code{S}*&@code{T}*@}
4783Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4784(the order of @code{S} and @code{T} in the spec is not significant).
4785There can be any number of ampersand-separated variables; for each the
4786wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
4787
4788@item %@{<@code{S}@}
4789Remove all occurrences of @code{-S} from the command line. Note---this
4790command is position dependent. @samp{%} commands in the spec string
4791before this option will see @code{-S}, @samp{%} commands in the spec
4792string after this option will not.
4793
4794@item %@{@code{S}*:@code{X}@}
4795Substitutes @code{X} if one or more switches whose names start with
4796@code{-S} are specified to GCC@. Note that the tail part of the
4797@code{-S} option (i.e.@: the part matched by the @samp{*}) will be substituted
4798for each occurrence of @samp{%*} within @code{X}.
4799
4800@item %@{@code{S}:@code{X}@}
4801Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC@.
4802
4803@item %@{!@code{S}:@code{X}@}
4804Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC@.
4805
4806@item %@{|@code{S}:@code{X}@}
4807Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4808
4809@item %@{|!@code{S}:@code{X}@}
4810Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4811
4812@item %@{.@code{S}:@code{X}@}
4813Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4814
4815@item %@{!.@code{S}:@code{X}@}
4816Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4817
4818@item %@{@code{S}|@code{P}:@code{X}@}
4819Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@. This may be
4820combined with @samp{!} and @samp{.} sequences as well, although they
4821have a stronger binding than the @samp{|}. For example a spec string
4822like this:
4823
4824@smallexample
4825%@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4826@end smallexample
4827
4828will output the following command-line options from the following input
4829command-line options:
4830
4831@smallexample
4832fred.c -foo -baz
4833jim.d -bar -boggle
4834-d fred.c -foo -baz -boggle
4835-d jim.d -bar -baz -boggle
4836@end smallexample
4837
4838@end table
4839
4840The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4841%@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4842or spaces, or even newlines. They are processed as usual, as described
4843above.
4844
4845The @option{-O}, @option{-f}, @option{-m}, and @option{-W}
4846switches are handled specifically in these
4847constructs. If another value of @option{-O} or the negated form of a @option{-f}, @option{-m}, or
4848@option{-W} switch is found later in the command line, the earlier switch
4849value is ignored, except with @{@code{S}*@} where @code{S} is just one
4850letter, which passes all matching options.
4851
4852The character @samp{|} at the beginning of the predicate text is used to indicate
4853that a command should be piped to the following command, but only if @option{-pipe}
4854is specified.
4855
4856It is built into GCC which switches take arguments and which do not.
4857(You might think it would be useful to generalize this to allow each
4858compiler's spec to say which switches take arguments. But this cannot
4859be done in a consistent fashion. GCC cannot even decide which input
4860files have been specified without knowing which switches take arguments,
4861and it must know which input files to compile in order to tell which
4862compilers to run).
4863
4864GCC also knows implicitly that arguments starting in @option{-l} are to be
4865treated as compiler output files, and passed to the linker in their
4866proper position among the other output files.
4867
4868@c man begin OPTIONS
4869
4870@node Target Options
4871@section Specifying Target Machine and Compiler Version
4872@cindex target options
4873@cindex cross compiling
4874@cindex specifying machine version
4875@cindex specifying compiler version and target machine
4876@cindex compiler version, specifying
4877@cindex target machine, specifying
4878
4879The usual way to run GCC is to run the executable called @file{gcc}, or
4880@file{<machine>-gcc} when cross-compiling, or
4881@file{<machine>-gcc-<version>} to run a version other than the one that
4882was installed last. Sometimes this is inconvenient, so GCC provides
4883options that will switch to another cross-compiler or version.
4884
4885@table @gcctabopt
4886@item -b @var{machine}
4887@opindex b
4888The argument @var{machine} specifies the target machine for compilation.
4889
4890The value to use for @var{machine} is the same as was specified as the
4891machine type when configuring GCC as a cross-compiler. For
4892example, if a cross-compiler was configured with @samp{configure
4893i386v}, meaning to compile for an 80386 running System V, then you
4894would specify @option{-b i386v} to run that cross compiler.
4895
4896@item -V @var{version}
4897@opindex V
4898The argument @var{version} specifies which version of GCC to run.
4899This is useful when multiple versions are installed. For example,
4900@var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4901@end table
4902
4903The @option{-V} and @option{-b} options work by running the
4904@file{<machine>-gcc-<version>} executable, so there's no real reason to
4905use them if you can just run that directly.
4906
4907@node Submodel Options
4908@section Hardware Models and Configurations
4909@cindex submodel options
4910@cindex specifying hardware config
4911@cindex hardware models and configurations, specifying
4912@cindex machine dependent options
4913
4914Earlier we discussed the standard option @option{-b} which chooses among
4915different installed compilers for completely different target
4916machines, such as VAX vs.@: 68000 vs.@: 80386.
4917
4918In addition, each of these target machine types can have its own
4919special options, starting with @samp{-m}, to choose among various
4920hardware models or configurations---for example, 68010 vs 68020,
4921floating coprocessor or none. A single installed version of the
4922compiler can compile for any model or configuration, according to the
4923options specified.
4924
4925Some configurations of the compiler also support additional special
4926options, usually for compatibility with other compilers on the same
4927platform.
4928
4929These options are defined by the macro @code{TARGET_SWITCHES} in the
4930machine description. The default for the options is also defined by
4931that macro, which enables you to change the defaults.
4932
4933@menu
4934* M680x0 Options::
4935* M68hc1x Options::
4936* VAX Options::
4937* SPARC Options::
4938* Convex Options::
4939* AMD29K Options::
4940* ARM Options::
4941* MN10200 Options::
4942* MN10300 Options::
4943* M32R/D Options::
4944* M88K Options::
4945* RS/6000 and PowerPC Options::
4946* RT Options::
4947* MIPS Options::
4948* i386 and x86-64 Options::
4949* HPPA Options::
4950* Intel 960 Options::
4951* DEC Alpha Options::
4952* DEC Alpha/VMS Options::
4953* Clipper Options::
4954* H8/300 Options::
4955* SH Options::
4956* System V Options::
4957* TMS320C3x/C4x Options::
4958* V850 Options::
4959* ARC Options::
4960* NS32K Options::
4961* AVR Options::
4962* MCore Options::
4963* IA-64 Options::
4964* D30V Options::
4965* S/390 and zSeries Options::
4966* CRIS Options::
4967* MMIX Options::
4968* PDP-11 Options::
4969* Xstormy16 Options::
4970* Xtensa Options::
4971@end menu
4972
4973@node M680x0 Options
4974@subsection M680x0 Options
4975@cindex M680x0 options
4976
4977These are the @samp{-m} options defined for the 68000 series. The default
4978values for these options depends on which style of 68000 was selected when
4979the compiler was configured; the defaults for the most common choices are
4980given below.
4981
4982@table @gcctabopt
4983@item -m68000
4984@itemx -mc68000
4985@opindex m68000
4986@opindex mc68000
4987Generate output for a 68000. This is the default
4988when the compiler is configured for 68000-based systems.
4989
4990Use this option for microcontrollers with a 68000 or EC000 core,
4991including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4992
4993@item -m68020
4994@itemx -mc68020
4995@opindex m68020
4996@opindex mc68020
4997Generate output for a 68020. This is the default
4998when the compiler is configured for 68020-based systems.
4999
5000@item -m68881
5001@opindex m68881
5002Generate output containing 68881 instructions for floating point.
5003This is the default for most 68020 systems unless @option{--nfp} was
5004specified when the compiler was configured.
5005
5006@item -m68030
5007@opindex m68030
5008Generate output for a 68030. This is the default when the compiler is
5009configured for 68030-based systems.
5010
5011@item -m68040
5012@opindex m68040
5013Generate output for a 68040. This is the default when the compiler is
5014configured for 68040-based systems.
5015
5016This option inhibits the use of 68881/68882 instructions that have to be
5017emulated by software on the 68040. Use this option if your 68040 does not
5018have code to emulate those instructions.
5019
5020@item -m68060
5021@opindex m68060
5022Generate output for a 68060. This is the default when the compiler is
5023configured for 68060-based systems.
5024
5025This option inhibits the use of 68020 and 68881/68882 instructions that
5026have to be emulated by software on the 68060. Use this option if your 68060
5027does not have code to emulate those instructions.
5028
5029@item -mcpu32
5030@opindex mcpu32
5031Generate output for a CPU32. This is the default
5032when the compiler is configured for CPU32-based systems.
5033
5034Use this option for microcontrollers with a
5035CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
503668336, 68340, 68341, 68349 and 68360.
5037
5038@item -m5200
5039@opindex m5200
5040Generate output for a 520X ``coldfire'' family cpu. This is the default
5041when the compiler is configured for 520X-based systems.
5042
5043Use this option for microcontroller with a 5200 core, including
5044the MCF5202, MCF5203, MCF5204 and MCF5202.
5045
5046
5047@item -m68020-40
5048@opindex m68020-40
5049Generate output for a 68040, without using any of the new instructions.
5050This results in code which can run relatively efficiently on either a
505168020/68881 or a 68030 or a 68040. The generated code does use the
505268881 instructions that are emulated on the 68040.
5053
5054@item -m68020-60
5055@opindex m68020-60
5056Generate output for a 68060, without using any of the new instructions.
5057This results in code which can run relatively efficiently on either a
505868020/68881 or a 68030 or a 68040. The generated code does use the
505968881 instructions that are emulated on the 68060.
5060
5061@item -mfpa
5062@opindex mfpa
5063Generate output containing Sun FPA instructions for floating point.
5064
5065@item -msoft-float
5066@opindex msoft-float
5067Generate output containing library calls for floating point.
5068@strong{Warning:} the requisite libraries are not available for all m68k
5069targets. Normally the facilities of the machine's usual C compiler are
5070used, but this can't be done directly in cross-compilation. You must
5071make your own arrangements to provide suitable library functions for
5072cross-compilation. The embedded targets @samp{m68k-*-aout} and
5073@samp{m68k-*-coff} do provide software floating point support.
5074
5075@item -mshort
5076@opindex mshort
5077Consider type @code{int} to be 16 bits wide, like @code{short int}.
5078
5079@item -mnobitfield
5080@opindex mnobitfield
5081Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
5082and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5083
5084@item -mbitfield
5085@opindex mbitfield
5086Do use the bit-field instructions. The @option{-m68020} option implies
5087@option{-mbitfield}. This is the default if you use a configuration
5088designed for a 68020.
5089
5090@item -mrtd
5091@opindex mrtd
5092Use a different function-calling convention, in which functions
5093that take a fixed number of arguments return with the @code{rtd}
5094instruction, which pops their arguments while returning. This
5095saves one instruction in the caller since there is no need to pop
5096the arguments there.
5097
5098This calling convention is incompatible with the one normally
5099used on Unix, so you cannot use it if you need to call libraries
5100compiled with the Unix compiler.
5101
5102Also, you must provide function prototypes for all functions that
5103take variable numbers of arguments (including @code{printf});
5104otherwise incorrect code will be generated for calls to those
5105functions.
5106
5107In addition, seriously incorrect code will result if you call a
5108function with too many arguments. (Normally, extra arguments are
5109harmlessly ignored.)
5110
5111The @code{rtd} instruction is supported by the 68010, 68020, 68030,
511268040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5113
5114@item -malign-int
5115@itemx -mno-align-int
5116@opindex malign-int
5117@opindex mno-align-int
5118Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5119@code{float}, @code{double}, and @code{long double} variables on a 32-bit
5120boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5121Aligning variables on 32-bit boundaries produces code that runs somewhat
5122faster on processors with 32-bit busses at the expense of more memory.
5123
5124@strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5125align structures containing the above types differently than
5126most published application binary interface specifications for the m68k.
5127
5128@item -mpcrel
5129@opindex mpcrel
5130Use the pc-relative addressing mode of the 68000 directly, instead of
5131using a global offset table. At present, this option implies @option{-fpic},
5132allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
5133not presently supported with @option{-mpcrel}, though this could be supported for
513468020 and higher processors.
5135
5136@item -mno-strict-align
5137@itemx -mstrict-align
5138@opindex mno-strict-align
5139@opindex mstrict-align
5140Do not (do) assume that unaligned memory references will be handled by
5141the system.
5142
5143@end table
5144
5145@node M68hc1x Options
5146@subsection M68hc1x Options
5147@cindex M68hc1x options
5148
5149These are the @samp{-m} options defined for the 68hc11 and 68hc12
5150microcontrollers. The default values for these options depends on
5151which style of microcontroller was selected when the compiler was configured;
5152the defaults for the most common choices are given below.
5153
5154@table @gcctabopt
5155@item -m6811
5156@itemx -m68hc11
5157@opindex m6811
5158@opindex m68hc11
5159Generate output for a 68HC11. This is the default
5160when the compiler is configured for 68HC11-based systems.
5161
5162@item -m6812
5163@itemx -m68hc12
5164@opindex m6812
5165@opindex m68hc12
5166Generate output for a 68HC12. This is the default
5167when the compiler is configured for 68HC12-based systems.
5168
5169@item -mauto-incdec
5170@opindex mauto-incdec
5171Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5172addressing modes.
5173
5174@item -mshort
5175@opindex mshort
5176Consider type @code{int} to be 16 bits wide, like @code{short int}.
5177
5178@item -msoft-reg-count=@var{count}
5179@opindex msoft-reg-count
5180Specify the number of pseudo-soft registers which are used for the
5181code generation. The maximum number is 32. Using more pseudo-soft
5182register may or may not result in better code depending on the program.
5183The default is 4 for 68HC11 and 2 for 68HC12.
5184
5185@end table
5186
5187@node VAX Options
5188@subsection VAX Options
5189@cindex VAX options
5190
5191These @samp{-m} options are defined for the VAX:
5192
5193@table @gcctabopt
5194@item -munix
5195@opindex munix
5196Do not output certain jump instructions (@code{aobleq} and so on)
5197that the Unix assembler for the VAX cannot handle across long
5198ranges.
5199
5200@item -mgnu
5201@opindex mgnu
5202Do output those jump instructions, on the assumption that you
5203will assemble with the GNU assembler.
5204
5205@item -mg
5206@opindex mg
5207Output code for g-format floating point numbers instead of d-format.
5208@end table
5209
5210@node SPARC Options
5211@subsection SPARC Options
5212@cindex SPARC options
5213
5214These @samp{-m} switches are supported on the SPARC:
5215
5216@table @gcctabopt
5217@item -mno-app-regs
5218@itemx -mapp-regs
5219@opindex mno-app-regs
5220@opindex mapp-regs
5221Specify @option{-mapp-regs} to generate output using the global registers
52222 through 4, which the SPARC SVR4 ABI reserves for applications. This
5223is the default.
5224
5225To be fully SVR4 ABI compliant at the cost of some performance loss,
5226specify @option{-mno-app-regs}. You should compile libraries and system
5227software with this option.
5228
5229@item -mfpu
5230@itemx -mhard-float
5231@opindex mfpu
5232@opindex mhard-float
5233Generate output containing floating point instructions. This is the
5234default.
5235
5236@item -mno-fpu
5237@itemx -msoft-float
5238@opindex mno-fpu
5239@opindex msoft-float
5240Generate output containing library calls for floating point.
5241@strong{Warning:} the requisite libraries are not available for all SPARC
5242targets. Normally the facilities of the machine's usual C compiler are
5243used, but this cannot be done directly in cross-compilation. You must make
5244your own arrangements to provide suitable library functions for
5245cross-compilation. The embedded targets @samp{sparc-*-aout} and
5246@samp{sparclite-*-*} do provide software floating point support.
5247
5248@option{-msoft-float} changes the calling convention in the output file;
5249therefore, it is only useful if you compile @emph{all} of a program with
5250this option. In particular, you need to compile @file{libgcc.a}, the
5251library that comes with GCC, with @option{-msoft-float} in order for
5252this to work.
5253
5254@item -mhard-quad-float
5255@opindex mhard-quad-float
5256Generate output containing quad-word (long double) floating point
5257instructions.
5258
5259@item -msoft-quad-float
5260@opindex msoft-quad-float
5261Generate output containing library calls for quad-word (long double)
5262floating point instructions. The functions called are those specified
5263in the SPARC ABI@. This is the default.
5264
5265As of this writing, there are no sparc implementations that have hardware
5266support for the quad-word floating point instructions. They all invoke
5267a trap handler for one of these instructions, and then the trap handler
5268emulates the effect of the instruction. Because of the trap handler overhead,
5269this is much slower than calling the ABI library routines. Thus the
5270@option{-msoft-quad-float} option is the default.
5271
5272@item -mno-flat
5273@itemx -mflat
5274@opindex mno-flat
5275@opindex mflat
5276With @option{-mflat}, the compiler does not generate save/restore instructions
5277and will use a ``flat'' or single register window calling convention.
5278This model uses %i7 as the frame pointer and is compatible with the normal
5279register window model. Code from either may be intermixed.
5280The local registers and the input registers (0--5) are still treated as
5281``call saved'' registers and will be saved on the stack as necessary.
5282
5283With @option{-mno-flat} (the default), the compiler emits save/restore
5284instructions (except for leaf functions) and is the normal mode of operation.
5285
5286@item -mno-unaligned-doubles
5287@itemx -munaligned-doubles
5288@opindex mno-unaligned-doubles
5289@opindex munaligned-doubles
5290Assume that doubles have 8 byte alignment. This is the default.
5291
5292With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5293alignment only if they are contained in another type, or if they have an
5294absolute address. Otherwise, it assumes they have 4 byte alignment.
5295Specifying this option avoids some rare compatibility problems with code
5296generated by other compilers. It is not the default because it results
5297in a performance loss, especially for floating point code.
5298
5299@item -mno-faster-structs
5300@itemx -mfaster-structs
5301@opindex mno-faster-structs
5302@opindex mfaster-structs
5303With @option{-mfaster-structs}, the compiler assumes that structures
5304should have 8 byte alignment. This enables the use of pairs of
5305@code{ldd} and @code{std} instructions for copies in structure
5306assignment, in place of twice as many @code{ld} and @code{st} pairs.
5307However, the use of this changed alignment directly violates the Sparc
5308ABI@. Thus, it's intended only for use on targets where the developer
5309acknowledges that their resulting code will not be directly in line with
5310the rules of the ABI@.
5311
5312@item -mv8
5313@itemx -msparclite
5314@opindex mv8
5315@opindex msparclite
5316These two options select variations on the SPARC architecture.
5317
5318By default (unless specifically configured for the Fujitsu SPARClite),
5319GCC generates code for the v7 variant of the SPARC architecture.
5320
5321@option{-mv8} will give you SPARC v8 code. The only difference from v7
5322code is that the compiler emits the integer multiply and integer
5323divide instructions which exist in SPARC v8 but not in SPARC v7.
5324
5325@option{-msparclite} will give you SPARClite code. This adds the integer
5326multiply, integer divide step and scan (@code{ffs}) instructions which
5327exist in SPARClite but not in SPARC v7.
5328
5329These options are deprecated and will be deleted in a future GCC release.
5330They have been replaced with @option{-mcpu=xxx}.
5331
5332@item -mcypress
5333@itemx -msupersparc
5334@opindex mcypress
5335@opindex msupersparc
5336These two options select the processor for which the code is optimized.
5337
5338With @option{-mcypress} (the default), the compiler optimizes code for the
5339Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
5340This is also appropriate for the older SparcStation 1, 2, IPX etc.
5341
5342With @option{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
5343used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
5344of the full SPARC v8 instruction set.
5345
5346These options are deprecated and will be deleted in a future GCC release.
5347They have been replaced with @option{-mcpu=xxx}.
5348
5349@item -mcpu=@var{cpu_type}
5350@opindex mcpu
5351Set the instruction set, register set, and instruction scheduling parameters
5352for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
5353@samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5354@samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5355@samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
5356
5357Default instruction scheduling parameters are used for values that select
5358an architecture and not an implementation. These are @samp{v7}, @samp{v8},
5359@samp{sparclite}, @samp{sparclet}, @samp{v9}.
5360
5361Here is a list of each supported architecture and their supported
5362implementations.
5363
5364@smallexample
5365 v7: cypress
5366 v8: supersparc, hypersparc
5367 sparclite: f930, f934, sparclite86x
5368 sparclet: tsc701
5369 v9: ultrasparc
5370@end smallexample
5371
5372@item -mtune=@var{cpu_type}
5373@opindex mtune
5374Set the instruction scheduling parameters for machine type
5375@var{cpu_type}, but do not set the instruction set or register set that the
5376option @option{-mcpu=@var{cpu_type}} would.
5377
5378The same values for @option{-mcpu=@var{cpu_type}} can be used for
5379@option{-mtune=@var{cpu_type}}, but the only useful values are those
5380that select a particular cpu implementation. Those are @samp{cypress},
5381@samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5382@samp{sparclite86x}, @samp{tsc701}, and @samp{ultrasparc}.
5383
5384@end table
5385
5386These @samp{-m} switches are supported in addition to the above
5387on the SPARCLET processor.
5388
5389@table @gcctabopt
5390@item -mlittle-endian
5391@opindex mlittle-endian
5392Generate code for a processor running in little-endian mode.
5393
5394@item -mlive-g0
5395@opindex mlive-g0
5396Treat register @code{%g0} as a normal register.
5397GCC will continue to clobber it as necessary but will not assume
5398it always reads as 0.
5399
5400@item -mbroken-saverestore
5401@opindex mbroken-saverestore
5402Generate code that does not use non-trivial forms of the @code{save} and
5403@code{restore} instructions. Early versions of the SPARCLET processor do
5404not correctly handle @code{save} and @code{restore} instructions used with
5405arguments. They correctly handle them used without arguments. A @code{save}
5406instruction used without arguments increments the current window pointer
5407but does not allocate a new stack frame. It is assumed that the window
5408overflow trap handler will properly handle this case as will interrupt
5409handlers.
5410@end table
5411
5412These @samp{-m} switches are supported in addition to the above
5413on SPARC V9 processors in 64-bit environments.
5414
5415@table @gcctabopt
5416@item -mlittle-endian
5417@opindex mlittle-endian
5418Generate code for a processor running in little-endian mode.
5419
5420@item -m32
5421@itemx -m64
5422@opindex m32
5423@opindex m64
5424Generate code for a 32-bit or 64-bit environment.
5425The 32-bit environment sets int, long and pointer to 32 bits.
5426The 64-bit environment sets int to 32 bits and long and pointer
5427to 64 bits.
5428
5429@item -mcmodel=medlow
5430@opindex mcmodel=medlow
5431Generate code for the Medium/Low code model: the program must be linked
5432in the low 32 bits of the address space. Pointers are 64 bits.
5433Programs can be statically or dynamically linked.
5434
5435@item -mcmodel=medmid
5436@opindex mcmodel=medmid
5437Generate code for the Medium/Middle code model: the program must be linked
5438in the low 44 bits of the address space, the text segment must be less than
54392G bytes, and data segment must be within 2G of the text segment.
5440Pointers are 64 bits.
5441
5442@item -mcmodel=medany
5443@opindex mcmodel=medany
5444Generate code for the Medium/Anywhere code model: the program may be linked
5445anywhere in the address space, the text segment must be less than
54462G bytes, and data segment must be within 2G of the text segment.
5447Pointers are 64 bits.
5448
5449@item -mcmodel=embmedany
5450@opindex mcmodel=embmedany
5451Generate code for the Medium/Anywhere code model for embedded systems:
5452assume a 32-bit text and a 32-bit data segment, both starting anywhere
5453(determined at link time). Register %g4 points to the base of the
5454data segment. Pointers are still 64 bits.
5455Programs are statically linked, PIC is not supported.
5456
5457@item -mstack-bias
5458@itemx -mno-stack-bias
5459@opindex mstack-bias
5460@opindex mno-stack-bias
5461With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5462frame pointer if present, are offset by @minus{}2047 which must be added back
5463when making stack frame references.
5464Otherwise, assume no such offset is present.
5465@end table
5466
5467@node Convex Options
5468@subsection Convex Options
5469@cindex Convex options
5470
5471These @samp{-m} options are defined for Convex:
5472
5473@table @gcctabopt
5474@item -mc1
5475@opindex mc1
5476Generate output for C1. The code will run on any Convex machine.
5477The preprocessor symbol @code{__convex__c1__} is defined.
5478
5479@item -mc2
5480@opindex mc2
5481Generate output for C2. Uses instructions not available on C1.
5482Scheduling and other optimizations are chosen for max performance on C2.
5483The preprocessor symbol @code{__convex_c2__} is defined.
5484
5485@item -mc32
5486@opindex mc32
5487Generate output for C32xx. Uses instructions not available on C1.
5488Scheduling and other optimizations are chosen for max performance on C32.
5489The preprocessor symbol @code{__convex_c32__} is defined.
5490
5491@item -mc34
5492@opindex mc34
5493Generate output for C34xx. Uses instructions not available on C1.
5494Scheduling and other optimizations are chosen for max performance on C34.
5495The preprocessor symbol @code{__convex_c34__} is defined.
5496
5497@item -mc38
5498@opindex mc38
5499Generate output for C38xx. Uses instructions not available on C1.
5500Scheduling and other optimizations are chosen for max performance on C38.
5501The preprocessor symbol @code{__convex_c38__} is defined.
5502
5503@item -margcount
5504@opindex margcount
5505Generate code which puts an argument count in the word preceding each
5506argument list. This is compatible with regular CC, and a few programs
5507may need the argument count word. GDB and other source-level debuggers
5508do not need it; this info is in the symbol table.
5509
5510@item -mnoargcount
5511@opindex mnoargcount
5512Omit the argument count word. This is the default.
5513
5514@item -mvolatile-cache
5515@opindex mvolatile-cache
5516Allow volatile references to be cached. This is the default.
5517
5518@item -mvolatile-nocache
5519@opindex mvolatile-nocache
5520Volatile references bypass the data cache, going all the way to memory.
5521This is only needed for multi-processor code that does not use standard
5522synchronization instructions. Making non-volatile references to volatile
5523locations will not necessarily work.
5524
5525@item -mlong32
5526@opindex mlong32
5527Type long is 32 bits, the same as type int. This is the default.
5528
5529@item -mlong64
5530@opindex mlong64
5531Type long is 64 bits, the same as type long long. This option is useless,
5532because no library support exists for it.
5533@end table
5534
5535@node AMD29K Options
5536@subsection AMD29K Options
5537@cindex AMD29K options
5538
5539These @samp{-m} options are defined for the AMD Am29000:
5540
5541@table @gcctabopt
5542@item -mdw
5543@opindex mdw
5544@cindex DW bit (29k)
5545Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5546halfword operations are directly supported by the hardware. This is the
5547default.
5548
5549@item -mndw
5550@opindex mndw
5551Generate code that assumes the @code{DW} bit is not set.
5552
5553@item -mbw
5554@opindex mbw
5555@cindex byte writes (29k)
5556Generate code that assumes the system supports byte and halfword write
5557operations. This is the default.
5558
5559@item -mnbw
5560@opindex mnbw
5561Generate code that assumes the systems does not support byte and
5562halfword write operations. @option{-mnbw} implies @option{-mndw}.
5563
5564@item -msmall
5565@opindex msmall
5566@cindex memory model (29k)
5567Use a small memory model that assumes that all function addresses are
5568either within a single 256 KB segment or at an absolute address of less
5569than 256k. This allows the @code{call} instruction to be used instead
5570of a @code{const}, @code{consth}, @code{calli} sequence.
5571
5572@item -mnormal
5573@opindex mnormal
5574Use the normal memory model: Generate @code{call} instructions only when
5575calling functions in the same file and @code{calli} instructions
5576otherwise. This works if each file occupies less than 256 KB but allows
5577the entire executable to be larger than 256 KB@. This is the default.
5578
5579@item -mlarge
5580@opindex mlarge
5581Always use @code{calli} instructions. Specify this option if you expect
5582a single file to compile into more than 256 KB of code.
5583
5584@item -m29050
5585@opindex m29050
5586@cindex processor selection (29k)
5587Generate code for the Am29050.
5588
5589@item -m29000
5590@opindex m29000
5591Generate code for the Am29000. This is the default.
5592
5593@item -mkernel-registers
5594@opindex mkernel-registers
5595@cindex kernel and user registers (29k)
5596Generate references to registers @code{gr64-gr95} instead of to
5597registers @code{gr96-gr127}. This option can be used when compiling
5598kernel code that wants a set of global registers disjoint from that used
5599by user-mode code.
5600
5601Note that when this option is used, register names in @samp{-f} flags
5602must use the normal, user-mode, names.
5603
5604@item -muser-registers
5605@opindex muser-registers
5606Use the normal set of global registers, @code{gr96-gr127}. This is the
5607default.
5608
5609@item -mstack-check
5610@itemx -mno-stack-check
5611@opindex mstack-check
5612@opindex mno-stack-check
5613@cindex stack checks (29k)
5614Insert (or do not insert) a call to @code{__msp_check} after each stack
5615adjustment. This is often used for kernel code.
5616
5617@item -mstorem-bug
5618@itemx -mno-storem-bug
5619@opindex mstorem-bug
5620@opindex mno-storem-bug
5621@cindex storem bug (29k)
5622@option{-mstorem-bug} handles 29k processors which cannot handle the
5623separation of a mtsrim insn and a storem instruction (most 29000 chips
5624to date, but not the 29050).
5625
5626@item -mno-reuse-arg-regs
5627@itemx -mreuse-arg-regs
5628@opindex mno-reuse-arg-regs
5629@opindex mreuse-arg-regs
5630@option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5631registers for copying out arguments. This helps detect calling a function
5632with fewer arguments than it was declared with.
5633
5634@item -mno-impure-text
5635@itemx -mimpure-text
5636@opindex mno-impure-text
5637@opindex mimpure-text
5638@option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5639not pass @option{-assert pure-text} to the linker when linking a shared object.
5640
5641@item -msoft-float
5642@opindex msoft-float
5643Generate output containing library calls for floating point.
5644@strong{Warning:} the requisite libraries are not part of GCC@.
5645Normally the facilities of the machine's usual C compiler are used, but
5646this can't be done directly in cross-compilation. You must make your
5647own arrangements to provide suitable library functions for
5648cross-compilation.
5649
5650@item -mno-multm
5651@opindex mno-multm
5652Do not generate multm or multmu instructions. This is useful for some embedded
5653systems which do not have trap handlers for these instructions.
5654@end table
5655
5656@node ARM Options
5657@subsection ARM Options
5658@cindex ARM options
5659
5660These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5661architectures:
5662
5663@table @gcctabopt
5664@item -mapcs-frame
5665@opindex mapcs-frame
5666Generate a stack frame that is compliant with the ARM Procedure Call
5667Standard for all functions, even if this is not strictly necessary for
5668correct execution of the code. Specifying @option{-fomit-frame-pointer}
5669with this option will cause the stack frames not to be generated for
5670leaf functions. The default is @option{-mno-apcs-frame}.
5671
5672@item -mapcs
5673@opindex mapcs
5674This is a synonym for @option{-mapcs-frame}.
5675
5676@item -mapcs-26
5677@opindex mapcs-26
5678Generate code for a processor running with a 26-bit program counter,
5679and conforming to the function calling standards for the APCS 26-bit
5680option. This option replaces the @option{-m2} and @option{-m3} options
5681of previous releases of the compiler.
5682
5683@item -mapcs-32
5684@opindex mapcs-32
5685Generate code for a processor running with a 32-bit program counter,
5686and conforming to the function calling standards for the APCS 32-bit
5687option. This option replaces the @option{-m6} option of previous releases
5688of the compiler.
5689
5690@ignore
5691@c not currently implemented
5692@item -mapcs-stack-check
5693@opindex mapcs-stack-check
5694Generate code to check the amount of stack space available upon entry to
5695every function (that actually uses some stack space). If there is
5696insufficient space available then either the function
5697@samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5698called, depending upon the amount of stack space required. The run time
5699system is required to provide these functions. The default is
5700@option{-mno-apcs-stack-check}, since this produces smaller code.
5701
5702@c not currently implemented
5703@item -mapcs-float
5704@opindex mapcs-float
5705Pass floating point arguments using the float point registers. This is
5706one of the variants of the APCS@. This option is recommended if the
5707target hardware has a floating point unit or if a lot of floating point
5708arithmetic is going to be performed by the code. The default is
5709@option{-mno-apcs-float}, since integer only code is slightly increased in
5710size if @option{-mapcs-float} is used.
5711
5712@c not currently implemented
5713@item -mapcs-reentrant
5714@opindex mapcs-reentrant
5715Generate reentrant, position independent code. The default is
5716@option{-mno-apcs-reentrant}.
5717@end ignore
5718
5719@item -mthumb-interwork
5720@opindex mthumb-interwork
5721Generate code which supports calling between the ARM and Thumb
5722instruction sets. Without this option the two instruction sets cannot
5723be reliably used inside one program. The default is
5724@option{-mno-thumb-interwork}, since slightly larger code is generated
5725when @option{-mthumb-interwork} is specified.
5726
5727@item -mno-sched-prolog
5728@opindex mno-sched-prolog
5729Prevent the reordering of instructions in the function prolog, or the
5730merging of those instruction with the instructions in the function's
5731body. This means that all functions will start with a recognizable set
5732of instructions (or in fact one of a choice from a small set of
5733different function prologues), and this information can be used to
5734locate the start if functions inside an executable piece of code. The
5735default is @option{-msched-prolog}.
5736
5737@item -mhard-float
5738@opindex mhard-float
5739Generate output containing floating point instructions. This is the
5740default.
5741
5742@item -msoft-float
5743@opindex msoft-float
5744Generate output containing library calls for floating point.
5745@strong{Warning:} the requisite libraries are not available for all ARM
5746targets. Normally the facilities of the machine's usual C compiler are
5747used, but this cannot be done directly in cross-compilation. You must make
5748your own arrangements to provide suitable library functions for
5749cross-compilation.
5750
5751@option{-msoft-float} changes the calling convention in the output file;
5752therefore, it is only useful if you compile @emph{all} of a program with
5753this option. In particular, you need to compile @file{libgcc.a}, the
5754library that comes with GCC, with @option{-msoft-float} in order for
5755this to work.
5756
5757@item -mlittle-endian
5758@opindex mlittle-endian
5759Generate code for a processor running in little-endian mode. This is
5760the default for all standard configurations.
5761
5762@item -mbig-endian
5763@opindex mbig-endian
5764Generate code for a processor running in big-endian mode; the default is
5765to compile code for a little-endian processor.
5766
5767@item -mwords-little-endian
5768@opindex mwords-little-endian
5769This option only applies when generating code for big-endian processors.
5770Generate code for a little-endian word order but a big-endian byte
5771order. That is, a byte order of the form @samp{32107654}. Note: this
5772option should only be used if you require compatibility with code for
5773big-endian ARM processors generated by versions of the compiler prior to
57742.8.
5775
5776@item -malignment-traps
5777@opindex malignment-traps
5778Generate code that will not trap if the MMU has alignment traps enabled.
5779On ARM architectures prior to ARMv4, there were no instructions to
5780access half-word objects stored in memory. However, when reading from
5781memory a feature of the ARM architecture allows a word load to be used,
5782even if the address is unaligned, and the processor core will rotate the
5783data as it is being loaded. This option tells the compiler that such
5784misaligned accesses will cause a MMU trap and that it should instead
5785synthesise the access as a series of byte accesses. The compiler can
5786still use word accesses to load half-word data if it knows that the
5787address is aligned to a word boundary.
5788
5789This option is ignored when compiling for ARM architecture 4 or later,
5790since these processors have instructions to directly access half-word
5791objects in memory.
5792
5793@item -mno-alignment-traps
5794@opindex mno-alignment-traps
5795Generate code that assumes that the MMU will not trap unaligned
5796accesses. This produces better code when the target instruction set
5797does not have half-word memory operations (i.e.@: implementations prior to
5798ARMv4).
5799
5800Note that you cannot use this option to access unaligned word objects,
5801since the processor will only fetch one 32-bit aligned object from
5802memory.
5803
5804The default setting for most targets is @option{-mno-alignment-traps}, since
5805this produces better code when there are no half-word memory
5806instructions available.
5807
5808@item -mshort-load-bytes
5809@itemx -mno-short-load-words
5810@opindex mshort-load-bytes
5811@opindex mno-short-load-words
5812These are deprecated aliases for @option{-malignment-traps}.
5813
5814@item -mno-short-load-bytes
5815@itemx -mshort-load-words
5816@opindex mno-short-load-bytes
5817@opindex mshort-load-words
5818This are deprecated aliases for @option{-mno-alignment-traps}.
5819
5820@item -mbsd
5821@opindex mbsd
5822This option only applies to RISC iX@. Emulate the native BSD-mode
5823compiler. This is the default if @option{-ansi} is not specified.
5824
5825@item -mxopen
5826@opindex mxopen
5827This option only applies to RISC iX@. Emulate the native X/Open-mode
5828compiler.
5829
5830@item -mno-symrename
5831@opindex mno-symrename
5832This option only applies to RISC iX@. Do not run the assembler
5833post-processor, @samp{symrename}, after code has been assembled.
5834Normally it is necessary to modify some of the standard symbols in
5835preparation for linking with the RISC iX C library; this option
5836suppresses this pass. The post-processor is never run when the
5837compiler is built for cross-compilation.
5838
5839@item -mcpu=@var{name}
5840@opindex mcpu
5841This specifies the name of the target ARM processor. GCC uses this name
5842to determine what kind of instructions it can emit when generating
5843assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
5844@samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
5845@samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
5846@samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
5847@samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
5848@samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
5849@samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
5850@samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
5851@samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
5852@samp{arm1020t}, @samp{xscale}.
5853
5854@itemx -mtune=@var{name}
5855@opindex mtune
5856This option is very similar to the @option{-mcpu=} option, except that
5857instead of specifying the actual target processor type, and hence
5858restricting which instructions can be used, it specifies that GCC should
5859tune the performance of the code as if the target were of the type
5860specified in this option, but still choosing the instructions that it
5861will generate based on the cpu specified by a @option{-mcpu=} option.
5862For some ARM implementations better performance can be obtained by using
5863this option.
5864
5865@item -march=@var{name}
5866@opindex march
5867This specifies the name of the target ARM architecture. GCC uses this
5868name to determine what kind of instructions it can emit when generating
5869assembly code. This option can be used in conjunction with or instead
5870of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
5871@samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
5872@samp{armv5}, @samp{armv5t}, @samp{armv5te}.
5873
5874@item -mfpe=@var{number}
5875@itemx -mfp=@var{number}
5876@opindex mfpe
5877@opindex mfp
5878This specifies the version of the floating point emulation available on
5879the target. Permissible values are 2 and 3. @option{-mfp=} is a synonym
5880for @option{-mfpe=}, for compatibility with older versions of GCC@.
5881
5882@item -mstructure-size-boundary=@var{n}
5883@opindex mstructure-size-boundary
5884The size of all structures and unions will be rounded up to a multiple
5885of the number of bits set by this option. Permissible values are 8 and
588632. The default value varies for different toolchains. For the COFF
5887targeted toolchain the default value is 8. Specifying the larger number
5888can produce faster, more efficient code, but can also increase the size
5889of the program. The two values are potentially incompatible. Code
5890compiled with one value cannot necessarily expect to work with code or
5891libraries compiled with the other value, if they exchange information
5892using structures or unions.
5893
5894@item -mabort-on-noreturn
5895@opindex mabort-on-noreturn
5896Generate a call to the function @code{abort} at the end of a
5897@code{noreturn} function. It will be executed if the function tries to
5898return.
5899
5900@item -mlong-calls
5901@itemx -mno-long-calls
5902@opindex mlong-calls
5903@opindex mno-long-calls
5904Tells the compiler to perform function calls by first loading the
5905address of the function into a register and then performing a subroutine
5906call on this register. This switch is needed if the target function
5907will lie outside of the 64 megabyte addressing range of the offset based
5908version of subroutine call instruction.
5909
5910Even if this switch is enabled, not all function calls will be turned
5911into long calls. The heuristic is that static functions, functions
5912which have the @samp{short-call} attribute, functions that are inside
5913the scope of a @samp{#pragma no_long_calls} directive and functions whose
5914definitions have already been compiled within the current compilation
5915unit, will not be turned into long calls. The exception to this rule is
5916that weak function definitions, functions with the @samp{long-call}
5917attribute or the @samp{section} attribute, and functions that are within
5918the scope of a @samp{#pragma long_calls} directive, will always be
5919turned into long calls.
5920
5921This feature is not enabled by default. Specifying
5922@option{-mno-long-calls} will restore the default behavior, as will
5923placing the function calls within the scope of a @samp{#pragma
5924long_calls_off} directive. Note these switches have no effect on how
5925the compiler generates code to handle function calls via function
5926pointers.
5927
5928@item -mnop-fun-dllimport
5929@opindex mnop-fun-dllimport
5930Disable support for the @code{dllimport} attribute.
5931
5932@item -msingle-pic-base
5933@opindex msingle-pic-base
5934Treat the register used for PIC addressing as read-only, rather than
5935loading it in the prologue for each function. The run-time system is
5936responsible for initializing this register with an appropriate value
5937before execution begins.
5938
5939@item -mpic-register=@var{reg}
5940@opindex mpic-register
5941Specify the register to be used for PIC addressing. The default is R10
5942unless stack-checking is enabled, when R9 is used.
5943
5944@item -mpoke-function-name
5945@opindex mpoke-function-name
5946Write the name of each function into the text section, directly
5947preceding the function prologue. The generated code is similar to this:
5948
5949@smallexample
5950 t0
5951 .ascii "arm_poke_function_name", 0
5952 .align
5953 t1
5954 .word 0xff000000 + (t1 - t0)
5955 arm_poke_function_name
5956 mov ip, sp
5957 stmfd sp!, @{fp, ip, lr, pc@}
5958 sub fp, ip, #4
5959@end smallexample
5960
5961When performing a stack backtrace, code can inspect the value of
5962@code{pc} stored at @code{fp + 0}. If the trace function then looks at
5963location @code{pc - 12} and the top 8 bits are set, then we know that
5964there is a function name embedded immediately preceding this location
5965and has length @code{((pc[-3]) & 0xff000000)}.
5966
5967@item -mthumb
5968@opindex mthumb
5969Generate code for the 16-bit Thumb instruction set. The default is to
5970use the 32-bit ARM instruction set.
5971
5972@item -mtpcs-frame
5973@opindex mtpcs-frame
5974Generate a stack frame that is compliant with the Thumb Procedure Call
5975Standard for all non-leaf functions. (A leaf function is one that does
5976not call any other functions.) The default is @option{-mno-tpcs-frame}.
5977
5978@item -mtpcs-leaf-frame
5979@opindex mtpcs-leaf-frame
5980Generate a stack frame that is compliant with the Thumb Procedure Call
5981Standard for all leaf functions. (A leaf function is one that does
5982not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
5983
5984@item -mcallee-super-interworking
5985@opindex mcallee-super-interworking
5986Gives all externally visible functions in the file being compiled an ARM
5987instruction set header which switches to Thumb mode before executing the
5988rest of the function. This allows these functions to be called from
5989non-interworking code.
5990
5991@item -mcaller-super-interworking
5992@opindex mcaller-super-interworking
5993Allows calls via function pointers (including virtual functions) to
5994execute correctly regardless of whether the target code has been
5995compiled for interworking or not. There is a small overhead in the cost
5996of executing a function pointer if this option is enabled.
5997
5998@end table
5999
6000@node MN10200 Options
6001@subsection MN10200 Options
6002@cindex MN10200 options
6003These @option{-m} options are defined for Matsushita MN10200 architectures:
6004@table @gcctabopt
6005
6006@item -mrelax
6007@opindex mrelax
6008Indicate to the linker that it should perform a relaxation optimization pass
6009to shorten branches, calls and absolute memory addresses. This option only
6010has an effect when used on the command line for the final link step.
6011
6012This option makes symbolic debugging impossible.
6013@end table
6014
6015@node MN10300 Options
6016@subsection MN10300 Options
6017@cindex MN10300 options
6018These @option{-m} options are defined for Matsushita MN10300 architectures:
6019
6020@table @gcctabopt
6021@item -mmult-bug
6022@opindex mmult-bug
6023Generate code to avoid bugs in the multiply instructions for the MN10300
6024processors. This is the default.
6025
6026@item -mno-mult-bug
6027@opindex mno-mult-bug
6028Do not generate code to avoid bugs in the multiply instructions for the
6029MN10300 processors.
6030
6031@item -mam33
6032@opindex mam33
6033Generate code which uses features specific to the AM33 processor.
6034
6035@item -mno-am33
6036@opindex mno-am33
6037Do not generate code which uses features specific to the AM33 processor. This
6038is the default.
6039
6040@item -mno-crt0
6041@opindex mno-crt0
6042Do not link in the C run-time initialization object file.
6043
6044@item -mrelax
6045@opindex mrelax
6046Indicate to the linker that it should perform a relaxation optimization pass
6047to shorten branches, calls and absolute memory addresses. This option only
6048has an effect when used on the command line for the final link step.
6049
6050This option makes symbolic debugging impossible.
6051@end table
6052
6053
6054@node M32R/D Options
6055@subsection M32R/D Options
6056@cindex M32R/D options
6057
6058These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6059
6060@table @gcctabopt
6061@item -m32rx
6062@opindex m32rx
6063Generate code for the M32R/X@.
6064
6065@item -m32r
6066@opindex m32r
6067Generate code for the M32R@. This is the default.
6068
6069@item -mcode-model=small
6070@opindex mcode-model=small
6071Assume all objects live in the lower 16MB of memory (so that their addresses
6072can be loaded with the @code{ld24} instruction), and assume all subroutines
6073are reachable with the @code{bl} instruction.
6074This is the default.
6075
6076The addressability of a particular object can be set with the
6077@code{model} attribute.
6078
6079@item -mcode-model=medium
6080@opindex mcode-model=medium
6081Assume objects may be anywhere in the 32-bit address space (the compiler
6082will generate @code{seth/add3} instructions to load their addresses), and
6083assume all subroutines are reachable with the @code{bl} instruction.
6084
6085@item -mcode-model=large
6086@opindex mcode-model=large
6087Assume objects may be anywhere in the 32-bit address space (the compiler
6088will generate @code{seth/add3} instructions to load their addresses), and
6089assume subroutines may not be reachable with the @code{bl} instruction
6090(the compiler will generate the much slower @code{seth/add3/jl}
6091instruction sequence).
6092
6093@item -msdata=none
6094@opindex msdata=none
6095Disable use of the small data area. Variables will be put into
6096one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6097@code{section} attribute has been specified).
6098This is the default.
6099
6100The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6101Objects may be explicitly put in the small data area with the
6102@code{section} attribute using one of these sections.
6103
6104@item -msdata=sdata
6105@opindex msdata=sdata
6106Put small global and static data in the small data area, but do not
6107generate special code to reference them.
6108
6109@item -msdata=use
6110@opindex msdata=use
6111Put small global and static data in the small data area, and generate
6112special instructions to reference them.
6113
6114@item -G @var{num}
6115@opindex G
6116@cindex smaller data references
6117Put global and static objects less than or equal to @var{num} bytes
6118into the small data or bss sections instead of the normal data or bss
6119sections. The default value of @var{num} is 8.
6120The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6121for this option to have any effect.
6122
6123All modules should be compiled with the same @option{-G @var{num}} value.
6124Compiling with different values of @var{num} may or may not work; if it
6125doesn't the linker will give an error message---incorrect code will not be
6126generated.
6127
6128@end table
6129
6130@node M88K Options
6131@subsection M88K Options
6132@cindex M88k options
6133
6134These @samp{-m} options are defined for Motorola 88k architectures:
6135
6136@table @gcctabopt
6137@item -m88000
6138@opindex m88000
6139Generate code that works well on both the m88100 and the
6140m88110.
6141
6142@item -m88100
6143@opindex m88100
6144Generate code that works best for the m88100, but that also
6145runs on the m88110.
6146
6147@item -m88110
6148@opindex m88110
6149Generate code that works best for the m88110, and may not run
6150on the m88100.
6151
6152@item -mbig-pic
6153@opindex mbig-pic
6154Obsolete option to be removed from the next revision.
6155Use @option{-fPIC}.
6156
6157@item -midentify-revision
6158@opindex midentify-revision
6159@cindex identifying source, compiler (88k)
6160Include an @code{ident} directive in the assembler output recording the
6161source file name, compiler name and version, timestamp, and compilation
6162flags used.
6163
6164@item -mno-underscores
6165@opindex mno-underscores
6166@cindex underscores, avoiding (88k)
6167In assembler output, emit symbol names without adding an underscore
6168character at the beginning of each name. The default is to use an
6169underscore as prefix on each name.
6170
6171@item -mocs-debug-info
6172@itemx -mno-ocs-debug-info
6173@opindex mocs-debug-info
6174@opindex mno-ocs-debug-info
6175@cindex OCS (88k)
6176@cindex debugging, 88k OCS
6177Include (or omit) additional debugging information (about registers used
6178in each stack frame) as specified in the 88open Object Compatibility
6179Standard, ``OCS''@. This extra information allows debugging of code that
6180has had the frame pointer eliminated. The default for DG/UX, SVr4, and
6181Delta 88 SVr3.2 is to include this information; other 88k configurations
6182omit this information by default.
6183
6184@item -mocs-frame-position
6185@opindex mocs-frame-position
6186@cindex register positions in frame (88k)
6187When emitting COFF debugging information for automatic variables and
6188parameters stored on the stack, use the offset from the canonical frame
6189address, which is the stack pointer (register 31) on entry to the
6190function. The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
6191@option{-mocs-frame-position}; other 88k configurations have the default
6192@option{-mno-ocs-frame-position}.
6193
6194@item -mno-ocs-frame-position
6195@opindex mno-ocs-frame-position
6196@cindex register positions in frame (88k)
6197When emitting COFF debugging information for automatic variables and
6198parameters stored on the stack, use the offset from the frame pointer
6199register (register 30). When this option is in effect, the frame
6200pointer is not eliminated when debugging information is selected by the
6201-g switch.
6202
6203@item -moptimize-arg-area
6204@opindex moptimize-arg-area
6205@cindex arguments in frame (88k)
6206Save space by reorganizing the stack frame. This option generates code
6207that does not agree with the 88open specifications, but uses less
6208memory.
6209
6210@itemx -mno-optimize-arg-area
6211@opindex mno-optimize-arg-area
6212Do not reorganize the stack frame to save space. This is the default.
6213The generated conforms to the specification, but uses more memory.
6214
6215@item -mshort-data-@var{num}
6216@opindex mshort-data
6217@cindex smaller data references (88k)
6218@cindex r0-relative references (88k)
6219Generate smaller data references by making them relative to @code{r0},
6220which allows loading a value using a single instruction (rather than the
6221usual two). You control which data references are affected by
6222specifying @var{num} with this option. For example, if you specify
6223@option{-mshort-data-512}, then the data references affected are those
6224involving displacements of less than 512 bytes.
6225@option{-mshort-data-@var{num}} is not effective for @var{num} greater
6226than 64k.
6227
6228@item -mserialize-volatile
6229@opindex mserialize-volatile
6230@itemx -mno-serialize-volatile
6231@opindex mno-serialize-volatile
6232@cindex sequential consistency on 88k
6233Do, or don't, generate code to guarantee sequential consistency
6234of volatile memory references. By default, consistency is
6235guaranteed.
6236
6237The order of memory references made by the MC88110 processor does
6238not always match the order of the instructions requesting those
6239references. In particular, a load instruction may execute before
6240a preceding store instruction. Such reordering violates
6241sequential consistency of volatile memory references, when there
6242are multiple processors. When consistency must be guaranteed,
6243GCC generates special instructions, as needed, to force
6244execution in the proper order.
6245
6246The MC88100 processor does not reorder memory references and so
6247always provides sequential consistency. However, by default, GCC
6248generates the special instructions to guarantee consistency
6249even when you use @option{-m88100}, so that the code may be run on an
6250MC88110 processor. If you intend to run your code only on the
6251MC88100 processor, you may use @option{-mno-serialize-volatile}.
6252
6253The extra code generated to guarantee consistency may affect the
6254performance of your application. If you know that you can safely
6255forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6256
6257@item -msvr4
6258@itemx -msvr3
6259@opindex msvr4
6260@opindex msvr3
6261@cindex assembler syntax, 88k
6262@cindex SVr4
6263Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6264related to System V release 4 (SVr4). This controls the following:
6265
6266@enumerate
6267@item
6268Which variant of the assembler syntax to emit.
6269@item
6270@option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6271that is used on System V release 4.
6272@item
6273@option{-msvr4} makes GCC issue additional declaration directives used in
6274SVr4.
6275@end enumerate
6276
6277@option{-msvr4} is the default for the m88k-motorola-sysv4 and
6278m88k-dg-dgux m88k configurations. @option{-msvr3} is the default for all
6279other m88k configurations.
6280
6281@item -mversion-03.00
6282@opindex mversion-03.00
6283This option is obsolete, and is ignored.
6284@c ??? which asm syntax better for GAS? option there too?
6285
6286@item -mno-check-zero-division
6287@itemx -mcheck-zero-division
6288@opindex mno-check-zero-division
6289@opindex mcheck-zero-division
6290@cindex zero division on 88k
6291Do, or don't, generate code to guarantee that integer division by
6292zero will be detected. By default, detection is guaranteed.
6293
6294Some models of the MC88100 processor fail to trap upon integer
6295division by zero under certain conditions. By default, when
6296compiling code that might be run on such a processor, GCC
6297generates code that explicitly checks for zero-valued divisors
6298and traps with exception number 503 when one is detected. Use of
6299@option{-mno-check-zero-division} suppresses such checking for code
6300generated to run on an MC88100 processor.
6301
6302GCC assumes that the MC88110 processor correctly detects all instances
6303of integer division by zero. When @option{-m88110} is specified, no
6304explicit checks for zero-valued divisors are generated, and both
6305@option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6306ignored.
6307
6308@item -muse-div-instruction
6309@opindex muse-div-instruction
6310@cindex divide instruction, 88k
6311Use the div instruction for signed integer division on the
6312MC88100 processor. By default, the div instruction is not used.
6313
6314On the MC88100 processor the signed integer division instruction
6315div) traps to the operating system on a negative operand. The
6316operating system transparently completes the operation, but at a
6317large cost in execution time. By default, when compiling code
6318that might be run on an MC88100 processor, GCC emulates signed
6319integer division using the unsigned integer division instruction
6320divu), thereby avoiding the large penalty of a trap to the
6321operating system. Such emulation has its own, smaller, execution
6322cost in both time and space. To the extent that your code's
6323important signed integer division operations are performed on two
6324nonnegative operands, it may be desirable to use the div
6325instruction directly.
6326
6327On the MC88110 processor the div instruction (also known as the
6328divs instruction) processes negative operands without trapping to
6329the operating system. When @option{-m88110} is specified,
6330@option{-muse-div-instruction} is ignored, and the div instruction is used
6331for signed integer division.
6332
6333Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined. In
6334particular, the behavior of such a division with and without
6335@option{-muse-div-instruction} may differ.
6336
6337@item -mtrap-large-shift
6338@itemx -mhandle-large-shift
6339@opindex mtrap-large-shift
6340@opindex mhandle-large-shift
6341@cindex bit shift overflow (88k)
6342@cindex large bit shifts (88k)
6343Include code to detect bit-shifts of more than 31 bits; respectively,
6344trap such shifts or emit code to handle them properly. By default GCC
6345makes no special provision for large bit shifts.
6346
6347@item -mwarn-passed-structs
6348@opindex mwarn-passed-structs
6349@cindex structure passing (88k)
6350Warn when a function passes a struct as an argument or result.
6351Structure-passing conventions have changed during the evolution of the C
6352language, and are often the source of portability problems. By default,
6353GCC issues no such warning.
6354@end table
6355
6356@c break page here to avoid unsightly interparagraph stretch.
6357@c -zw, 2001-8-17
6358@page
6359
6360@node RS/6000 and PowerPC Options
6361@subsection IBM RS/6000 and PowerPC Options
6362@cindex RS/6000 and PowerPC Options
6363@cindex IBM RS/6000 and PowerPC Options
6364
6365These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6366@table @gcctabopt
6367@item -mpower
6368@itemx -mno-power
6369@itemx -mpower2
6370@itemx -mno-power2
6371@itemx -mpowerpc
6372@itemx -mno-powerpc
6373@itemx -mpowerpc-gpopt
6374@itemx -mno-powerpc-gpopt
6375@itemx -mpowerpc-gfxopt
6376@itemx -mno-powerpc-gfxopt
6377@itemx -mpowerpc64
6378@itemx -mno-powerpc64
6379@opindex mpower
6380@opindex mno-power
6381@opindex mpower2
6382@opindex mno-power2
6383@opindex mpowerpc
6384@opindex mno-powerpc
6385@opindex mpowerpc-gpopt
6386@opindex mno-powerpc-gpopt
6387@opindex mpowerpc-gfxopt
6388@opindex mno-powerpc-gfxopt
6389@opindex mpowerpc64
6390@opindex mno-powerpc64
6391GCC supports two related instruction set architectures for the
6392RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
6393instructions supported by the @samp{rios} chip set used in the original
6394RS/6000 systems and the @dfn{PowerPC} instruction set is the
6395architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6396the IBM 4xx microprocessors.
6397
6398Neither architecture is a subset of the other. However there is a
6399large common subset of instructions supported by both. An MQ
6400register is included in processors supporting the POWER architecture.
6401
6402You use these options to specify which instructions are available on the
6403processor you are using. The default value of these options is
6404determined when configuring GCC@. Specifying the
6405@option{-mcpu=@var{cpu_type}} overrides the specification of these
6406options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
6407rather than the options listed above.
6408
6409The @option{-mpower} option allows GCC to generate instructions that
6410are found only in the POWER architecture and to use the MQ register.
6411Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6412to generate instructions that are present in the POWER2 architecture but
6413not the original POWER architecture.
6414
6415The @option{-mpowerpc} option allows GCC to generate instructions that
6416are found only in the 32-bit subset of the PowerPC architecture.
6417Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6418GCC to use the optional PowerPC architecture instructions in the
6419General Purpose group, including floating-point square root. Specifying
6420@option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6421use the optional PowerPC architecture instructions in the Graphics
6422group, including floating-point select.
6423
6424The @option{-mpowerpc64} option allows GCC to generate the additional
642564-bit instructions that are found in the full PowerPC64 architecture
6426and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
6427@option{-mno-powerpc64}.
6428
6429If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6430will use only the instructions in the common subset of both
6431architectures plus some special AIX common-mode calls, and will not use
6432the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
6433permits GCC to use any instruction from either architecture and to
6434allow use of the MQ register; specify this for the Motorola MPC601.
6435
6436@item -mnew-mnemonics
6437@itemx -mold-mnemonics
6438@opindex mnew-mnemonics
6439@opindex mold-mnemonics
6440Select which mnemonics to use in the generated assembler code. With
6441@option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6442the PowerPC architecture. With @option{-mold-mnemonics} it uses the
6443assembler mnemonics defined for the POWER architecture. Instructions
6444defined in only one architecture have only one mnemonic; GCC uses that
6445mnemonic irrespective of which of these options is specified.
6446
6447GCC defaults to the mnemonics appropriate for the architecture in
6448use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6449value of these option. Unless you are building a cross-compiler, you
6450should normally not specify either @option{-mnew-mnemonics} or
6451@option{-mold-mnemonics}, but should instead accept the default.
6452
6453@item -mcpu=@var{cpu_type}
6454@opindex mcpu
6455Set architecture type, register usage, choice of mnemonics, and
6456instruction scheduling parameters for machine type @var{cpu_type}.
6457Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6458@samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6459@samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6460@samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6461@samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6462@samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6463
6464@option{-mcpu=common} selects a completely generic processor. Code
6465generated under this option will run on any POWER or PowerPC processor.
6466GCC will use only the instructions in the common subset of both
6467architectures, and will not use the MQ register. GCC assumes a generic
6468processor model for scheduling purposes.
6469
6470@option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6471@option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6472PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6473types, with an appropriate, generic processor model assumed for
6474scheduling purposes.
6475
6476The other options specify a specific processor. Code generated under
6477those options will run best on that processor, and may not run at all on
6478others.
6479
6480The @option{-mcpu} options automatically enable or disable other
6481@option{-m} options as follows:
6482
6483@table @samp
6484@item common
6485@option{-mno-power}, @option{-mno-powerc}
6486
6487@item power
6488@itemx power2
6489@itemx rios1
6490@itemx rios2
6491@itemx rsc
6492@option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6493
6494@item powerpc
6495@itemx rs64a
6496@itemx 602
6497@itemx 603
6498@itemx 603e
6499@itemx 604
6500@itemx 620
6501@itemx 630
6502@itemx 740
6503@itemx 7400
6504@itemx 7450
6505@itemx 750
6506@itemx 505
6507@option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6508
6509@item 601
6510@option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6511
6512@item 403
6513@itemx 821
6514@itemx 860
6515@option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6516@end table
6517
6518@item -mtune=@var{cpu_type}
6519@opindex mtune
6520Set the instruction scheduling parameters for machine type
6521@var{cpu_type}, but do not set the architecture type, register usage, or
6522choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
6523values for @var{cpu_type} are used for @option{-mtune} as for
6524@option{-mcpu}. If both are specified, the code generated will use the
6525architecture, registers, and mnemonics set by @option{-mcpu}, but the
6526scheduling parameters set by @option{-mtune}.
6527
6528@item -maltivec
6529@itemx -mno-altivec
6530@opindex maltivec
6531@opindex mno-altivec
6532These switches enable or disable the use of built-in functions that
6533allow access to the AltiVec instruction set. You may also need to set
6534@option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6535enhancements.
6536
6537@item -mabi=spe
6538@opindex mabi=spe
6539Extend the current ABI with SPE ABI extensions. This does not change
6540the default ABI, instead it adds the SPE ABI extensions to the current
6541ABI@.
6542
6543@item -mabi=no-spe
6544@opindex mabi=no-spe
6545Disable Booke SPE ABI extensions for the current ABI.
6546
6547@item -misel=@var{yes/no}
6548@itemx -misel
6549@opindex misel
6550This switch enables or disables the generation of ISEL instructions.
6551
6552@item -mfull-toc
6553@itemx -mno-fp-in-toc
6554@itemx -mno-sum-in-toc
6555@itemx -mminimal-toc
6556@opindex mfull-toc
6557@opindex mno-fp-in-toc
6558@opindex mno-sum-in-toc
6559@opindex mminimal-toc
6560Modify generation of the TOC (Table Of Contents), which is created for
6561every executable file. The @option{-mfull-toc} option is selected by
6562default. In that case, GCC will allocate at least one TOC entry for
6563each unique non-automatic variable reference in your program. GCC
6564will also place floating-point constants in the TOC@. However, only
656516,384 entries are available in the TOC@.
6566
6567If you receive a linker error message that saying you have overflowed
6568the available TOC space, you can reduce the amount of TOC space used
6569with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6570@option{-mno-fp-in-toc} prevents GCC from putting floating-point
6571constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6572generate code to calculate the sum of an address and a constant at
6573run-time instead of putting that sum into the TOC@. You may specify one
6574or both of these options. Each causes GCC to produce very slightly
6575slower and larger code at the expense of conserving TOC space.
6576
6577If you still run out of space in the TOC even when you specify both of
6578these options, specify @option{-mminimal-toc} instead. This option causes
6579GCC to make only one TOC entry for every file. When you specify this
6580option, GCC will produce code that is slower and larger but which
6581uses extremely little TOC space. You may wish to use this option
6582only on files that contain less frequently executed code.
6583
6584@item -maix64
6585@itemx -maix32
6586@opindex maix64
6587@opindex maix32
6588Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6589@code{long} type, and the infrastructure needed to support them.
6590Specifying @option{-maix64} implies @option{-mpowerpc64} and
6591@option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6592implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
6593
6594@item -mxl-call
6595@itemx -mno-xl-call
6596@opindex mxl-call
6597@opindex mno-xl-call
6598On AIX, pass floating-point arguments to prototyped functions beyond the
6599register save area (RSA) on the stack in addition to argument FPRs. The
6600AIX calling convention was extended but not initially documented to
6601handle an obscure K&R C case of calling a function that takes the
6602address of its arguments with fewer arguments than declared. AIX XL
6603compilers access floating point arguments which do not fit in the
6604RSA from the stack when a subroutine is compiled without
6605optimization. Because always storing floating-point arguments on the
6606stack is inefficient and rarely needed, this option is not enabled by
6607default and only is necessary when calling subroutines compiled by AIX
6608XL compilers without optimization.
6609
6610@item -mpe
6611@opindex mpe
6612Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
6613application written to use message passing with special startup code to
6614enable the application to run. The system must have PE installed in the
6615standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6616must be overridden with the @option{-specs=} option to specify the
6617appropriate directory location. The Parallel Environment does not
6618support threads, so the @option{-mpe} option and the @option{-pthread}
6619option are incompatible.
6620
6621@item -msoft-float
6622@itemx -mhard-float
6623@opindex msoft-float
6624@opindex mhard-float
6625Generate code that does not use (uses) the floating-point register set.
6626Software floating point emulation is provided if you use the
6627@option{-msoft-float} option, and pass the option to GCC when linking.
6628
6629@item -mmultiple
6630@itemx -mno-multiple
6631@opindex mmultiple
6632@opindex mno-multiple
6633Generate code that uses (does not use) the load multiple word
6634instructions and the store multiple word instructions. These
6635instructions are generated by default on POWER systems, and not
6636generated on PowerPC systems. Do not use @option{-mmultiple} on little
6637endian PowerPC systems, since those instructions do not work when the
6638processor is in little endian mode. The exceptions are PPC740 and
6639PPC750 which permit the instructions usage in little endian mode.
6640
6641@item -mstring
6642@itemx -mno-string
6643@opindex mstring
6644@opindex mno-string
6645Generate code that uses (does not use) the load string instructions
6646and the store string word instructions to save multiple registers and
6647do small block moves. These instructions are generated by default on
6648POWER systems, and not generated on PowerPC systems. Do not use
6649@option{-mstring} on little endian PowerPC systems, since those
6650instructions do not work when the processor is in little endian mode.
6651The exceptions are PPC740 and PPC750 which permit the instructions
6652usage in little endian mode.
6653
6654@item -mupdate
6655@itemx -mno-update
6656@opindex mupdate
6657@opindex mno-update
6658Generate code that uses (does not use) the load or store instructions
6659that update the base register to the address of the calculated memory
6660location. These instructions are generated by default. If you use
6661@option{-mno-update}, there is a small window between the time that the
6662stack pointer is updated and the address of the previous frame is
6663stored, which means code that walks the stack frame across interrupts or
6664signals may get corrupted data.
6665
6666@item -mfused-madd
6667@itemx -mno-fused-madd
6668@opindex mfused-madd
6669@opindex mno-fused-madd
6670Generate code that uses (does not use) the floating point multiply and
6671accumulate instructions. These instructions are generated by default if
6672hardware floating is used.
6673
6674@item -mno-bit-align
6675@itemx -mbit-align
6676@opindex mno-bit-align
6677@opindex mbit-align
6678On System V.4 and embedded PowerPC systems do not (do) force structures
6679and unions that contain bit-fields to be aligned to the base type of the
6680bit-field.
6681
6682For example, by default a structure containing nothing but 8
6683@code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
6684boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
6685the structure would be aligned to a 1 byte boundary and be one byte in
6686size.
6687
6688@item -mno-strict-align
6689@itemx -mstrict-align
6690@opindex mno-strict-align
6691@opindex mstrict-align
6692On System V.4 and embedded PowerPC systems do not (do) assume that
6693unaligned memory references will be handled by the system.
6694
6695@item -mrelocatable
6696@itemx -mno-relocatable
6697@opindex mrelocatable
6698@opindex mno-relocatable
6699On embedded PowerPC systems generate code that allows (does not allow)
6700the program to be relocated to a different address at runtime. If you
6701use @option{-mrelocatable} on any module, all objects linked together must
6702be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
6703
6704@item -mrelocatable-lib
6705@itemx -mno-relocatable-lib
6706@opindex mrelocatable-lib
6707@opindex mno-relocatable-lib
6708On embedded PowerPC systems generate code that allows (does not allow)
6709the program to be relocated to a different address at runtime. Modules
6710compiled with @option{-mrelocatable-lib} can be linked with either modules
6711compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
6712with modules compiled with the @option{-mrelocatable} options.
6713
6714@item -mno-toc
6715@itemx -mtoc
6716@opindex mno-toc
6717@opindex mtoc
6718On System V.4 and embedded PowerPC systems do not (do) assume that
6719register 2 contains a pointer to a global area pointing to the addresses
6720used in the program.
6721
6722@item -mlittle
6723@itemx -mlittle-endian
6724@opindex mlittle
6725@opindex mlittle-endian
6726On System V.4 and embedded PowerPC systems compile code for the
6727processor in little endian mode. The @option{-mlittle-endian} option is
6728the same as @option{-mlittle}.
6729
6730@item -mbig
6731@itemx -mbig-endian
6732@opindex mbig
6733@opindex mbig-endian
6734On System V.4 and embedded PowerPC systems compile code for the
6735processor in big endian mode. The @option{-mbig-endian} option is
6736the same as @option{-mbig}.
6737
6738@item -mcall-sysv
6739@opindex mcall-sysv
6740On System V.4 and embedded PowerPC systems compile code using calling
6741conventions that adheres to the March 1995 draft of the System V
6742Application Binary Interface, PowerPC processor supplement. This is the
6743default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6744
6745@item -mcall-sysv-eabi
6746@opindex mcall-sysv-eabi
6747Specify both @option{-mcall-sysv} and @option{-meabi} options.
6748
6749@item -mcall-sysv-noeabi
6750@opindex mcall-sysv-noeabi
6751Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
6752
6753@item -mcall-aix
6754@opindex mcall-aix
6755On System V.4 and embedded PowerPC systems compile code using calling
6756conventions that are similar to those used on AIX@. This is the
6757default if you configured GCC using @samp{powerpc-*-eabiaix}.
6758
6759@item -mcall-solaris
6760@opindex mcall-solaris
6761On System V.4 and embedded PowerPC systems compile code for the Solaris
6762operating system.
6763
6764@item -mcall-linux
6765@opindex mcall-linux
6766On System V.4 and embedded PowerPC systems compile code for the
6767Linux-based GNU system.
6768
6769@item -mcall-gnu
6770@opindex mcall-gnu
6771On System V.4 and embedded PowerPC systems compile code for the
6772Hurd-based GNU system.
6773
6774@item -mcall-netbsd
6775@opindex mcall-netbsd
6776On System V.4 and embedded PowerPC systems compile code for the
6777NetBSD operating system.
6778
6779@item -maix-struct-return
6780@opindex maix-struct-return
6781Return all structures in memory (as specified by the AIX ABI)@.
6782
6783@item -msvr4-struct-return
6784@opindex msvr4-struct-return
6785Return structures smaller than 8 bytes in registers (as specified by the
6786SVR4 ABI)@.
6787
6788@item -mabi=altivec
6789@opindex mabi=altivec
6790Extend the current ABI with AltiVec ABI extensions. This does not
6791change the default ABI, instead it adds the AltiVec ABI extensions to
6792the current ABI@.
6793
6794@item -mabi=no-altivec
6795@opindex mabi=no-altivec
6796Disable AltiVec ABI extensions for the current ABI.
6797
6798@item -mprototype
6799@itemx -mno-prototype
6800@opindex mprototype
6801@opindex mno-prototype
6802On System V.4 and embedded PowerPC systems assume that all calls to
6803variable argument functions are properly prototyped. Otherwise, the
6804compiler must insert an instruction before every non prototyped call to
6805set or clear bit 6 of the condition code register (@var{CR}) to
6806indicate whether floating point values were passed in the floating point
6807registers in case the function takes a variable arguments. With
6808@option{-mprototype}, only calls to prototyped variable argument functions
6809will set or clear the bit.
6810
6811@item -msim
6812@opindex msim
6813On embedded PowerPC systems, assume that the startup module is called
6814@file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6815@file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
6816configurations.
6817
6818@item -mmvme
6819@opindex mmvme
6820On embedded PowerPC systems, assume that the startup module is called
6821@file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6822@file{libc.a}.
6823
6824@item -mads
6825@opindex mads
6826On embedded PowerPC systems, assume that the startup module is called
6827@file{crt0.o} and the standard C libraries are @file{libads.a} and
6828@file{libc.a}.
6829
6830@item -myellowknife
6831@opindex myellowknife
6832On embedded PowerPC systems, assume that the startup module is called
6833@file{crt0.o} and the standard C libraries are @file{libyk.a} and
6834@file{libc.a}.
6835
6836@item -mvxworks
6837@opindex mvxworks
6838On System V.4 and embedded PowerPC systems, specify that you are
6839compiling for a VxWorks system.
6840
6841@item -mwindiss
6842@opindex mwindiss
6843Specify that you are compiling for the WindISS simulation environment.
6844
6845@item -memb
6846@opindex memb
6847On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6848header to indicate that @samp{eabi} extended relocations are used.
6849
6850@item -meabi
6851@itemx -mno-eabi
6852@opindex meabi
6853@opindex mno-eabi
6854On System V.4 and embedded PowerPC systems do (do not) adhere to the
6855Embedded Applications Binary Interface (eabi) which is a set of
6856modifications to the System V.4 specifications. Selecting @option{-meabi}
6857means that the stack is aligned to an 8 byte boundary, a function
6858@code{__eabi} is called to from @code{main} to set up the eabi
6859environment, and the @option{-msdata} option can use both @code{r2} and
6860@code{r13} to point to two separate small data areas. Selecting
6861@option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6862do not call an initialization function from @code{main}, and the
6863@option{-msdata} option will only use @code{r13} to point to a single
6864small data area. The @option{-meabi} option is on by default if you
6865configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6866
6867@item -msdata=eabi
6868@opindex msdata=eabi
6869On System V.4 and embedded PowerPC systems, put small initialized
6870@code{const} global and static data in the @samp{.sdata2} section, which
6871is pointed to by register @code{r2}. Put small initialized
6872non-@code{const} global and static data in the @samp{.sdata} section,
6873which is pointed to by register @code{r13}. Put small uninitialized
6874global and static data in the @samp{.sbss} section, which is adjacent to
6875the @samp{.sdata} section. The @option{-msdata=eabi} option is
6876incompatible with the @option{-mrelocatable} option. The
6877@option{-msdata=eabi} option also sets the @option{-memb} option.
6878
6879@item -msdata=sysv
6880@opindex msdata=sysv
6881On System V.4 and embedded PowerPC systems, put small global and static
6882data in the @samp{.sdata} section, which is pointed to by register
6883@code{r13}. Put small uninitialized global and static data in the
6884@samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6885The @option{-msdata=sysv} option is incompatible with the
6886@option{-mrelocatable} option.
6887
6888@item -msdata=default
6889@itemx -msdata
6890@opindex msdata=default
6891@opindex msdata
6892On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
6893compile code the same as @option{-msdata=eabi}, otherwise compile code the
6894same as @option{-msdata=sysv}.
6895
6896@item -msdata-data
6897@opindex msdata-data
6898On System V.4 and embedded PowerPC systems, put small global and static
6899data in the @samp{.sdata} section. Put small uninitialized global and
6900static data in the @samp{.sbss} section. Do not use register @code{r13}
6901to address small data however. This is the default behavior unless
6902other @option{-msdata} options are used.
6903
6904@item -msdata=none
6905@itemx -mno-sdata
6906@opindex msdata=none
6907@opindex mno-sdata
6908On embedded PowerPC systems, put all initialized global and static data
6909in the @samp{.data} section, and all uninitialized data in the
6910@samp{.bss} section.
6911
6912@item -G @var{num}
6913@opindex G
6914@cindex smaller data references (PowerPC)
6915@cindex .sdata/.sdata2 references (PowerPC)
6916On embedded PowerPC systems, put global and static items less than or
6917equal to @var{num} bytes into the small data or bss sections instead of
6918the normal data or bss section. By default, @var{num} is 8. The
6919@option{-G @var{num}} switch is also passed to the linker.
6920All modules should be compiled with the same @option{-G @var{num}} value.
6921
6922@item -mregnames
6923@itemx -mno-regnames
6924@opindex mregnames
6925@opindex mno-regnames
6926On System V.4 and embedded PowerPC systems do (do not) emit register
6927names in the assembly language output using symbolic forms.
6928
6929@item -mlongcall
6930@itemx -mno-longcall
6931@opindex mlongcall
6932@opindex mno-longcall
6933Default to making all function calls via pointers, so that functions
6934which reside further than 64 megabytes (67,108,864 bytes) from the
6935current location can be called. This setting can be overridden by the
6936@code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
6937
6938Some linkers are capable of detecting out-of-range calls and generating
6939glue code on the fly. On these systems, long calls are unnecessary and
6940generate slower code. As of this writing, the AIX linker can do this,
6941as can the GNU linker for PowerPC/64. It is planned to add this feature
6942to the GNU linker for 32-bit PowerPC systems as well.
6943
6944In the future, we may cause GCC to ignore all longcall specifications
6945when the linker is known to generate glue.
6946
6947@item -pthread
6948@opindex pthread
6949Adds support for multithreading with the @dfn{pthreads} library.
6950This option sets flags for both the preprocessor and linker.
6951
6952@end table
6953
6954@node RT Options
6955@subsection IBM RT Options
6956@cindex RT options
6957@cindex IBM RT options
6958
6959These @samp{-m} options are defined for the IBM RT PC:
6960
6961@table @gcctabopt
6962@item -min-line-mul
6963@opindex min-line-mul
6964Use an in-line code sequence for integer multiplies. This is the
6965default.
6966
6967@item -mcall-lib-mul
6968@opindex mcall-lib-mul
6969Call @code{lmul$$} for integer multiples.
6970
6971@item -mfull-fp-blocks
6972@opindex mfull-fp-blocks
6973Generate full-size floating point data blocks, including the minimum
6974amount of scratch space recommended by IBM@. This is the default.
6975
6976@item -mminimum-fp-blocks
6977@opindex mminimum-fp-blocks
6978Do not include extra scratch space in floating point data blocks. This
6979results in smaller code, but slower execution, since scratch space must
6980be allocated dynamically.
6981
6982@cindex @file{stdarg.h} and RT PC
6983@item -mfp-arg-in-fpregs
6984@opindex mfp-arg-in-fpregs
6985Use a calling sequence incompatible with the IBM calling convention in
6986which floating point arguments are passed in floating point registers.
6987Note that @code{stdarg.h} will not work with floating point operands
6988if this option is specified.
6989
6990@item -mfp-arg-in-gregs
6991@opindex mfp-arg-in-gregs
6992Use the normal calling convention for floating point arguments. This is
6993the default.
6994
6995@item -mhc-struct-return
6996@opindex mhc-struct-return
6997Return structures of more than one word in memory, rather than in a
6998register. This provides compatibility with the MetaWare HighC (hc)
6999compiler. Use the option @option{-fpcc-struct-return} for compatibility
7000with the Portable C Compiler (pcc).
7001
7002@item -mnohc-struct-return
7003@opindex mnohc-struct-return
7004Return some structures of more than one word in registers, when
7005convenient. This is the default. For compatibility with the
7006IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7007option @option{-mhc-struct-return}.
7008@end table
7009
7010@node MIPS Options
7011@subsection MIPS Options
7012@cindex MIPS options
7013
7014These @samp{-m} options are defined for the MIPS family of computers:
7015
7016@table @gcctabopt
7017
7018@item -march=@var{arch}
7019@opindex march
7020Generate code that will run on @var{arch}, which can be the name of a
7021generic MIPS ISA, or the name of a particular processor. The ISA names
7022are: @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4}, @samp{mips32}
7023and @samp{mips64}. The processor names are: @samp{r2000},
7024@samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{vr4100}, @samp{vr4300},
7025@samp{r4400}, @samp{r4600}, @samp{r4650}, @samp{vr5000}, @samp{r6000},
7026@samp{r8000}, @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7027@samp{orion}, and @samp{sb1}. The special value @samp{from-abi} selects the
7028most compatible architecture for the selected ABI (that is,
7029@samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7030
7031In processor names, a final @samp{000} can be abbreviated as @samp{k}
7032(for example, @samp{-march=r2k}). Prefixes are optional, and
7033@samp{vr} may be written @samp{r}.
7034
7035GCC defines two macros based on the value of this option. The first
7036is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7037a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
7038where @var{foo} is the capitialized value of @samp{_MIPS_ARCH}@.
7039For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7040to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7041
7042Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7043above. In other words, it will have the full prefix and will not
7044abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
7045the macro names the resolved architecture (either @samp{"mips1"} or
7046@samp{"mips3"}). It names the default architecture when no
7047@option{-march} option is given.
7048
7049@item -mtune=@var{arch}
7050@opindex mtune
7051Optimize for @var{arch}. Among other things, this option controls
7052the way instructions are scheduled, and the perceived cost of arithmetic
7053operations. The list of @var{arch} values is the same as for
7054@option{-march}.
7055
7056When this option is not used, GCC will optimize for the processor
7057specified by @option{-march}. By using @option{-march} and
7058@option{-mtune} together, it is possible to generate code that will
7059run on a family of processors, but optimize the code for one
7060particular member of that family.
7061
7062@samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7063@samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7064@samp{-march} ones described above.
7065
7066@item -mips1
7067@opindex mips1
7068Equivalent to @samp{-march=mips1}.
7069
7070@item -mips2
7071@opindex mips2
7072Equivalent to @samp{-march=mips2}.
7073
7074@item -mips3
7075@opindex mips3
7076Equivalent to @samp{-march=mips3}.
7077
7078@item -mips4
7079@opindex mips4
7080Equivalent to @samp{-march=mips4}.
7081
7082@item -mips32
7083@opindex mips32
7084Equivalent to @samp{-march=mips32}.
7085
7086@item -mips64
7087@opindex mips64
7088Equivalent to @samp{-march=mips64}.
7089
7090@item -mfused-madd
7091@itemx -mno-fused-madd
7092@opindex mfused-madd
7093@opindex mno-fused-madd
7094Generate code that uses (does not use) the floating point multiply and
7095accumulate instructions, when they are available. These instructions
7096are generated by default if they are available, but this may be
7097undesirable if the extra precision causes problems or on certain chips
7098in the mode where denormals are rounded to zero where denormals
7099generated by multiply and accumulate instructions cause exceptions
7100anyway.
7101
7102@item -mfp32
7103@opindex mfp32
7104Assume that floating point registers are 32 bits wide.
7105
7106@item -mfp64
7107@opindex mfp64
7108Assume that floating point registers are 64 bits wide.
7109
7110@item -mgp32
7111@opindex mgp32
7112Assume that general purpose registers are 32 bits wide.
7113
7114@item -mgp64
7115@opindex mgp64
7116Assume that general purpose registers are 64 bits wide.
7117
7118@item -mint64
7119@opindex mint64
7120Force int and long types to be 64 bits wide. See @option{-mlong32} for an
7121explanation of the default, and the width of pointers.
7122
7123@item -mlong64
7124@opindex mlong64
7125Force long types to be 64 bits wide. See @option{-mlong32} for an
7126explanation of the default, and the width of pointers.
7127
7128@item -mlong32
7129@opindex mlong32
7130Force long, int, and pointer types to be 32 bits wide.
7131
7132The default size of ints, longs and pointers depends on the ABI@. All
7133the supported ABIs use 32-bit ints. The n64 ABI uses 64-bit longs, as
7134does the 64-bit Cygnus EABI; the others use 32-bit longs. Pointers
7135are the same size as longs, or the same size as integer registers,
7136whichever is smaller.
7137
7138@item -mabi=32
7139@itemx -mabi=o64
7140@itemx -mabi=n32
7141@itemx -mabi=64
7142@itemx -mabi=eabi
7143@itemx -mabi=meabi
7144@opindex mabi=32
7145@opindex mabi=o64
7146@opindex mabi=n32
7147@opindex mabi=64
7148@opindex mabi=eabi
7149@opindex mabi=meabi
7150Generate code for the given ABI@.
7151
7152Note that there are two embedded ABIs: @option{-mabi=eabi}
7153selects the one defined by Cygnus while @option{-meabi=meabi}
7154selects the one defined by MIPS@. Both these ABIs have
715532-bit and 64-bit variants. Normally, GCC will generate
715664-bit code when you select a 64-bit architecture, but you
7157can use @option{-mgp32} to get 32-bit code instead.
7158
7159@item -mmips-as
7160@opindex mmips-as
7161Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7162add normal debug information. This is the default for all
7163platforms except for the OSF/1 reference platform, using the OSF/rose
7164object format. If the either of the @option{-gstabs} or @option{-gstabs+}
7165switches are used, the @file{mips-tfile} program will encapsulate the
7166stabs within MIPS ECOFF@.
7167
7168@item -mgas
7169@opindex mgas
7170Generate code for the GNU assembler. This is the default on the OSF/1
7171reference platform, using the OSF/rose object format. Also, this is
7172the default if the configure option @option{--with-gnu-as} is used.
7173
7174@item -msplit-addresses
7175@itemx -mno-split-addresses
7176@opindex msplit-addresses
7177@opindex mno-split-addresses
7178Generate code to load the high and low parts of address constants separately.
7179This allows GCC to optimize away redundant loads of the high order
7180bits of addresses. This optimization requires GNU as and GNU ld.
7181This optimization is enabled by default for some embedded targets where
7182GNU as and GNU ld are standard.
7183
7184@item -mrnames
7185@itemx -mno-rnames
7186@opindex mrnames
7187@opindex mno-rnames
7188The @option{-mrnames} switch says to output code using the MIPS software
7189names for the registers, instead of the hardware names (ie, @var{a0}
7190instead of @var{$4}). The only known assembler that supports this option
7191is the Algorithmics assembler.
7192
7193@item -mgpopt
7194@itemx -mno-gpopt
7195@opindex mgpopt
7196@opindex mno-gpopt
7197The @option{-mgpopt} switch says to write all of the data declarations
7198before the instructions in the text section, this allows the MIPS
7199assembler to generate one word memory references instead of using two
7200words for short global or static data items. This is on by default if
7201optimization is selected.
7202
7203@item -mstats
7204@itemx -mno-stats
7205@opindex mstats
7206@opindex mno-stats
7207For each non-inline function processed, the @option{-mstats} switch
7208causes the compiler to emit one line to the standard error file to
7209print statistics about the program (number of registers saved, stack
7210size, etc.).
7211
7212@item -mmemcpy
7213@itemx -mno-memcpy
7214@opindex mmemcpy
7215@opindex mno-memcpy
7216The @option{-mmemcpy} switch makes all block moves call the appropriate
7217string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7218generating inline code.
7219
7220@item -mmips-tfile
7221@itemx -mno-mips-tfile
7222@opindex mmips-tfile
7223@opindex mno-mips-tfile
7224The @option{-mno-mips-tfile} switch causes the compiler not
7225postprocess the object file with the @file{mips-tfile} program,
7226after the MIPS assembler has generated it to add debug support. If
7227@file{mips-tfile} is not run, then no local variables will be
7228available to the debugger. In addition, @file{stage2} and
7229@file{stage3} objects will have the temporary file names passed to the
7230assembler embedded in the object file, which means the objects will
7231not compare the same. The @option{-mno-mips-tfile} switch should only
7232be used when there are bugs in the @file{mips-tfile} program that
7233prevents compilation.
7234
7235@item -msoft-float
7236@opindex msoft-float
7237Generate output containing library calls for floating point.
7238@strong{Warning:} the requisite libraries are not part of GCC@.
7239Normally the facilities of the machine's usual C compiler are used, but
7240this can't be done directly in cross-compilation. You must make your
7241own arrangements to provide suitable library functions for
7242cross-compilation.
7243
7244@item -mhard-float
7245@opindex mhard-float
7246Generate output containing floating point instructions. This is the
7247default if you use the unmodified sources.
7248
7249@item -mabicalls
7250@itemx -mno-abicalls
7251@opindex mabicalls
7252@opindex mno-abicalls
7253Emit (or do not emit) the pseudo operations @samp{.abicalls},
7254@samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7255position independent code.
7256
7257@item -mlong-calls
7258@itemx -mno-long-calls
7259@opindex mlong-calls
7260@opindex mno-long-calls
7261Do all calls with the @samp{JALR} instruction, which requires
7262loading up a function's address into a register before the call.
7263You need to use this switch, if you call outside of the current
7264512 megabyte segment to functions that are not through pointers.
7265
7266@item -mhalf-pic
7267@itemx -mno-half-pic
7268@opindex mhalf-pic
7269@opindex mno-half-pic
7270Put pointers to extern references into the data section and load them
7271up, rather than put the references in the text section.
7272
7273@item -membedded-pic
7274@itemx -mno-embedded-pic
7275@opindex membedded-pic
7276@opindex mno-embedded-pic
7277Generate PIC code suitable for some embedded systems. All calls are
7278made using PC relative address, and all data is addressed using the $gp
7279register. No more than 65536 bytes of global data may be used. This
7280requires GNU as and GNU ld which do most of the work. This currently
7281only works on targets which use ECOFF; it does not work with ELF@.
7282
7283@item -membedded-data
7284@itemx -mno-embedded-data
7285@opindex membedded-data
7286@opindex mno-embedded-data
7287Allocate variables to the read-only data section first if possible, then
7288next in the small data section if possible, otherwise in data. This gives
7289slightly slower code than the default, but reduces the amount of RAM required
7290when executing, and thus may be preferred for some embedded systems.
7291
7292@item -muninit-const-in-rodata
7293@itemx -mno-uninit-const-in-rodata
7294@opindex muninit-const-in-rodata
7295@opindex mno-uninit-const-in-rodata
7296When used together with @option{-membedded-data}, it will always store uninitialized
7297const variables in the read-only data section.
7298
7299@item -msingle-float
7300@itemx -mdouble-float
7301@opindex msingle-float
7302@opindex mdouble-float
7303The @option{-msingle-float} switch tells gcc to assume that the floating
7304point coprocessor only supports single precision operations, as on the
7305@samp{r4650} chip. The @option{-mdouble-float} switch permits gcc to use
7306double precision operations. This is the default.
7307
7308@item -mmad
7309@itemx -mno-mad
7310@opindex mmad
7311@opindex mno-mad
7312Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7313as on the @samp{r4650} chip.
7314
7315@item -m4650
7316@opindex m4650
7317Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7318@option{-mcpu=r4650}.
7319
7320@item -mips16
7321@itemx -mno-mips16
7322@opindex mips16
7323@opindex mno-mips16
7324Enable 16-bit instructions.
7325
7326@item -mentry
7327@opindex mentry
7328Use the entry and exit pseudo ops. This option can only be used with
7329@option{-mips16}.
7330
7331@item -EL
7332@opindex EL
7333Compile code for the processor in little endian mode.
7334The requisite libraries are assumed to exist.
7335
7336@item -EB
7337@opindex EB
7338Compile code for the processor in big endian mode.
7339The requisite libraries are assumed to exist.
7340
7341@item -G @var{num}
7342@opindex G
7343@cindex smaller data references (MIPS)
7344@cindex gp-relative references (MIPS)
7345Put global and static items less than or equal to @var{num} bytes into
7346the small data or bss sections instead of the normal data or bss
7347section. This allows the assembler to emit one word memory reference
7348instructions based on the global pointer (@var{gp} or @var{$28}),
7349instead of the normal two words used. By default, @var{num} is 8 when
7350the MIPS assembler is used, and 0 when the GNU assembler is used. The
7351@option{-G @var{num}} switch is also passed to the assembler and linker.
7352All modules should be compiled with the same @option{-G @var{num}}
7353value.
7354
7355@item -nocpp
7356@opindex nocpp
7357Tell the MIPS assembler to not run its preprocessor over user
7358assembler files (with a @samp{.s} suffix) when assembling them.
7359
7360@item -mfix7000
7361@opindex mfix7000
7362Pass an option to gas which will cause nops to be inserted if
7363the read of the destination register of an mfhi or mflo instruction
7364occurs in the following two instructions.
7365
7366@item -no-crt0
7367@opindex no-crt0
7368Do not include the default crt0.
7369
7370@item -mflush-func=@var{func}
7371@itemx -mno-flush-func
7372@opindex mflush-func
7373Specifies the function to call to flush the I and D caches, or to not
7374call any such function. If called, the function must take the same
7375arguments as the common @code{_flush_func()}, that is, the address of the
7376memory range for which the cache is being flushed, the size of the
7377memory range, and the number 3 (to flush both caches). The default
7378depends on the target gcc was configured for, but commonly is either
7379@samp{_flush_func} or @samp{__cpu_flush}.
7380
7381@item -mbranch-likely
7382@itemx -mno-branch-likely
7383@opindex mbranch-likely
7384@opindex mno-branch-likely
7385Enable or disable use of Branch Likely instructions, regardless of the
7386default for the selected architecture. By default, Branch Likely
7387instructions may be generated if they are supported by the selected
7388architecture. An exception is for the MIPS32 and MIPS64 architectures
7389and processors which implement those architectures; for those, Branch
7390Likely instructions will not be generated by default because the MIPS32
7391and MIPS64 architectures specifically deprecate their use.
7392@end table
7393
7394@node i386 and x86-64 Options
7395@subsection Intel 386 and AMD x86-64 Options
7396@cindex i386 Options
7397@cindex x86-64 Options
7398@cindex Intel 386 Options
7399@cindex AMD x86-64 Options
7400
7401These @samp{-m} options are defined for the i386 and x86-64 family of
7402computers:
7403
7404@table @gcctabopt
7405@item -mcpu=@var{cpu-type}
7406@opindex mcpu
7407Tune to @var{cpu-type} everything applicable about the generated code, except
7408for the ABI and the set of available instructions. The choices for
7409@var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7410@samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7411@samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7412@samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp}
7413and @samp{athlon-mp}.
7414
7415While picking a specific @var{cpu-type} will schedule things appropriately
7416for that particular chip, the compiler will not generate any code that
7417does not run on the i386 without the @option{-march=@var{cpu-type}} option
7418being used. @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7419is equivalent to @samp{pentiumpro}. @samp{k6} and @samp{athlon} are the
7420AMD chips as opposed to the Intel ones.
7421
7422@item -march=@var{cpu-type}
7423@opindex march
7424Generate instructions for the machine type @var{cpu-type}. The choices
7425for @var{cpu-type} are the same as for @option{-mcpu}. Moreover,
7426specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7427
7428@item -m386
7429@itemx -m486
7430@itemx -mpentium
7431@itemx -mpentiumpro
7432@opindex m386
7433@opindex m486
7434@opindex mpentium
7435@opindex mpentiumpro
7436These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7437@option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7438These synonyms are deprecated.
7439
7440@item -mfpmath=@var{unit}
7441@opindex march
7442generate floating point arithmetics for selected unit @var{unit}. the choices
7443for @var{unit} are:
7444
7445@table @samp
7446@item 387
7447Use the standard 387 floating point coprocessor present majority of chips and
7448emulated otherwise. Code compiled with this option will run almost everywhere.
7449The temporary results are computed in 80bit precesion instead of precision
7450specified by the type resulting in slightly different results compared to most
7451of other chips. See @option{-ffloat-store} for more detailed description.
7452
7453This is the default choice for i386 compiler.
7454
7455@item sse
7456Use scalar floating point instructions present in the SSE instruction set.
7457This instruction set is supported by Pentium3 and newer chips, in the AMD line
7458by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
7459instruction set supports only single precision arithmetics, thus the double and
7460extended precision arithmetics is still done using 387. Later version, present
7461only in Pentium4 and the future AMD x86-64 chips supports double precision
7462arithmetics too.
7463
7464For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7465@option{-msse2} switches to enable SSE extensions and make this option
7466effective. For x86-64 compiler, these extensions are enabled by default.
7467
7468The resulting code should be considerably faster in majority of cases and avoid
7469the numerical instability problems of 387 code, but may break some existing
7470code that expects temporaries to be 80bit.
7471
7472This is the default choice for x86-64 compiler.
7473
7474@item sse,387
7475Attempt to utilize both instruction sets at once. This effectivly double the
7476amount of available registers and on chips with separate execution units for
7477387 and SSE the execution resources too. Use this option with care, as it is
7478still experimental, because gcc register allocator does not model separate
7479functional units well resulting in instable performance.
7480@end table
7481
7482@item -masm=@var{dialect}
7483@opindex masm=@var{dialect}
7484Output asm instructions using selected @var{dialect}. Supported choices are
7485@samp{intel} or @samp{att} (the default one).
7486
7487@item -mieee-fp
7488@itemx -mno-ieee-fp
7489@opindex mieee-fp
7490@opindex mno-ieee-fp
7491Control whether or not the compiler uses IEEE floating point
7492comparisons. These handle correctly the case where the result of a
7493comparison is unordered.
7494
7495@item -msoft-float
7496@opindex msoft-float
7497Generate output containing library calls for floating point.
7498@strong{Warning:} the requisite libraries are not part of GCC@.
7499Normally the facilities of the machine's usual C compiler are used, but
7500this can't be done directly in cross-compilation. You must make your
7501own arrangements to provide suitable library functions for
7502cross-compilation.
7503
7504On machines where a function returns floating point results in the 80387
7505register stack, some floating point opcodes may be emitted even if
7506@option{-msoft-float} is used.
7507
7508@item -mno-fp-ret-in-387
7509@opindex mno-fp-ret-in-387
7510Do not use the FPU registers for return values of functions.
7511
7512The usual calling convention has functions return values of types
7513@code{float} and @code{double} in an FPU register, even if there
7514is no FPU@. The idea is that the operating system should emulate
7515an FPU@.
7516
7517The option @option{-mno-fp-ret-in-387} causes such values to be returned
7518in ordinary CPU registers instead.
7519
7520@item -mno-fancy-math-387
7521@opindex mno-fancy-math-387
7522Some 387 emulators do not support the @code{sin}, @code{cos} and
7523@code{sqrt} instructions for the 387. Specify this option to avoid
7524generating those instructions. This option is the default on FreeBSD,
7525OpenBSD and NetBSD@. This option is overridden when @option{-march}
7526indicates that the target cpu will always have an FPU and so the
7527instruction will not need emulation. As of revision 2.6.1, these
7528instructions are not generated unless you also use the
7529@option{-funsafe-math-optimizations} switch.
7530
7531@item -malign-double
7532@itemx -mno-align-double
7533@opindex malign-double
7534@opindex mno-align-double
7535Control whether GCC aligns @code{double}, @code{long double}, and
7536@code{long long} variables on a two word boundary or a one word
7537boundary. Aligning @code{double} variables on a two word boundary will
7538produce code that runs somewhat faster on a @samp{Pentium} at the
7539expense of more memory.
7540
7541@strong{Warning:} if you use the @samp{-malign-double} switch,
7542structures containing the above types will be aligned differently than
7543the published application binary interface specifications for the 386.
7544
7545@item -m128bit-long-double
7546@opindex m128bit-long-double
7547Control the size of @code{long double} type. i386 application binary interface
7548specify the size to be 12 bytes, while modern architectures (Pentium and newer)
7549prefer @code{long double} aligned to 8 or 16 byte boundary. This is
7550impossible to reach with 12 byte long doubles in the array accesses.
7551
7552@strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
7553structures and arrays containing @code{long double} will change their size as
7554well as function calling convention for function taking @code{long double}
7555will be modified.
7556
7557@item -m96bit-long-double
7558@opindex m96bit-long-double
7559Set the size of @code{long double} to 96 bits as required by the i386
7560application binary interface. This is the default.
7561
7562@item -msvr3-shlib
7563@itemx -mno-svr3-shlib
7564@opindex msvr3-shlib
7565@opindex mno-svr3-shlib
7566Control whether GCC places uninitialized local variables into the
7567@code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
7568into @code{bss}. These options are meaningful only on System V Release 3.
7569
7570@item -mrtd
7571@opindex mrtd
7572Use a different function-calling convention, in which functions that
7573take a fixed number of arguments return with the @code{ret} @var{num}
7574instruction, which pops their arguments while returning. This saves one
7575instruction in the caller since there is no need to pop the arguments
7576there.
7577
7578You can specify that an individual function is called with this calling
7579sequence with the function attribute @samp{stdcall}. You can also
7580override the @option{-mrtd} option by using the function attribute
7581@samp{cdecl}. @xref{Function Attributes}.
7582
7583@strong{Warning:} this calling convention is incompatible with the one
7584normally used on Unix, so you cannot use it if you need to call
7585libraries compiled with the Unix compiler.
7586
7587Also, you must provide function prototypes for all functions that
7588take variable numbers of arguments (including @code{printf});
7589otherwise incorrect code will be generated for calls to those
7590functions.
7591
7592In addition, seriously incorrect code will result if you call a
7593function with too many arguments. (Normally, extra arguments are
7594harmlessly ignored.)
7595
7596@item -mregparm=@var{num}
7597@opindex mregparm
7598Control how many registers are used to pass integer arguments. By
7599default, no registers are used to pass arguments, and at most 3
7600registers can be used. You can control this behavior for a specific
7601function by using the function attribute @samp{regparm}.
7602@xref{Function Attributes}.
7603
7604@strong{Warning:} if you use this switch, and
7605@var{num} is nonzero, then you must build all modules with the same
7606value, including any libraries. This includes the system libraries and
7607startup modules.
7608
7609@item -mpreferred-stack-boundary=@var{num}
7610@opindex mpreferred-stack-boundary
7611Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
7612byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
7613the default is 4 (16 bytes or 128 bits), except when optimizing for code
7614size (@option{-Os}), in which case the default is the minimum correct
7615alignment (4 bytes for x86, and 8 bytes for x86-64).
7616
7617On Pentium and PentiumPro, @code{double} and @code{long double} values
7618should be aligned to an 8 byte boundary (see @option{-malign-double}) or
7619suffer significant run time performance penalties. On Pentium III, the
7620Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
7621penalties if it is not 16 byte aligned.
7622
7623To ensure proper alignment of this values on the stack, the stack boundary
7624must be as aligned as that required by any value stored on the stack.
7625Further, every function must be generated such that it keeps the stack
7626aligned. Thus calling a function compiled with a higher preferred
7627stack boundary from a function compiled with a lower preferred stack
7628boundary will most likely misalign the stack. It is recommended that
7629libraries that use callbacks always use the default setting.
7630
7631This extra alignment does consume extra stack space, and generally
7632increases code size. Code that is sensitive to stack space usage, such
7633as embedded systems and operating system kernels, may want to reduce the
7634preferred alignment to @option{-mpreferred-stack-boundary=2}.
7635
7636@item -mmmx
7637@itemx -mno-mmx
7638@item -msse
7639@itemx -mno-sse
7640@item -msse2
7641@itemx -mno-sse2
7642@item -m3dnow
7643@itemx -mno-3dnow
7644@opindex mmmx
7645@opindex mno-mmx
7646@opindex msse
7647@opindex mno-sse
7648@opindex m3dnow
7649@opindex mno-3dnow
7650These switches enable or disable the use of built-in functions that allow
7651direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
7652
7653@xref{X86 Built-in Functions}, for details of the functions enabled
7654and disabled by these switches.
7655
7656@item -mpush-args
7657@itemx -mno-push-args
7658@opindex mpush-args
7659@opindex mno-push-args
7660Use PUSH operations to store outgoing parameters. This method is shorter
7661and usually equally fast as method using SUB/MOV operations and is enabled
7662by default. In some cases disabling it may improve performance because of
7663improved scheduling and reduced dependencies.
7664
7665@item -maccumulate-outgoing-args
7666@opindex maccumulate-outgoing-args
7667If enabled, the maximum amount of space required for outgoing arguments will be
7668computed in the function prologue. This is faster on most modern CPUs
7669because of reduced dependencies, improved scheduling and reduced stack usage
7670when preferred stack boundary is not equal to 2. The drawback is a notable
7671increase in code size. This switch implies @option{-mno-push-args}.
7672
7673@item -mthreads
7674@opindex mthreads
7675Support thread-safe exception handling on @samp{Mingw32}. Code that relies
7676on thread-safe exception handling must compile and link all code with the
7677@option{-mthreads} option. When compiling, @option{-mthreads} defines
7678@option{-D_MT}; when linking, it links in a special thread helper library
7679@option{-lmingwthrd} which cleans up per thread exception handling data.
7680
7681@item -mno-align-stringops
7682@opindex mno-align-stringops
7683Do not align destination of inlined string operations. This switch reduces
7684code size and improves performance in case the destination is already aligned,
7685but gcc don't know about it.
7686
7687@item -minline-all-stringops
7688@opindex minline-all-stringops
7689By default GCC inlines string operations only when destination is known to be
7690aligned at least to 4 byte boundary. This enables more inlining, increase code
7691size, but may improve performance of code that depends on fast memcpy, strlen
7692and memset for short lengths.
7693
7694@item -momit-leaf-frame-pointer
7695@opindex momit-leaf-frame-pointer
7696Don't keep the frame pointer in a register for leaf functions. This
7697avoids the instructions to save, set up and restore frame pointers and
7698makes an extra register available in leaf functions. The option
7699@option{-fomit-frame-pointer} removes the frame pointer for all functions
7700which might make debugging harder.
7701@end table
7702
7703These @samp{-m} switches are supported in addition to the above
7704on AMD x86-64 processors in 64-bit environments.
7705
7706@table @gcctabopt
7707@item -m32
7708@itemx -m64
7709@opindex m32
7710@opindex m64
7711Generate code for a 32-bit or 64-bit environment.
7712The 32-bit environment sets int, long and pointer to 32 bits and
7713generates code that runs on any i386 system.
7714The 64-bit environment sets int to 32 bits and long and pointer
7715to 64 bits and generates code for AMD's x86-64 architecture.
7716
7717@item -mno-red-zone
7718@opindex no-red-zone
7719Do not use a so called red zone for x86-64 code. The red zone is mandated
7720by the x86-64 ABI, it is a 128-byte area beyond the location of the
7721stack pointer that will not be modified by signal or interrupt handlers
7722and therefore can be used for temporary data without adjusting the stack
7723pointer. The flag @option{-mno-red-zone} disables this red zone.
7724
7725@item -mcmodel=small
7726@opindex mcmodel=small
7727Generate code for the small code model: the program and its symbols must
7728be linked in the lower 2 GB of the address space. Pointers are 64 bits.
7729Programs can be statically or dynamically linked. This is the default
7730code model.
7731
7732@item -mcmodel=kernel
7733@opindex mcmodel=kernel
7734Generate code for the kernel code model. The kernel runs in the
7735negative 2 GB of the address space.
7736This model has to be used for Linux kernel code.
7737
7738@item -mcmodel=medium
7739@opindex mcmodel=medium
7740Generate code for the medium model: The program is linked in the lower 2
7741GB of the address space but symbols can be located anywhere in the
7742address space. Programs can be statically or dynamically linked, but
7743building of shared libraries are not supported with the medium model.
7744
7745@item -mcmodel=large
7746@opindex mcmodel=large
7747Generate code for the large model: This model makes no assumptions
7748about addresses and sizes of sections. Currently GCC does not implement
7749this model.
7750@end table
7751
7752@node HPPA Options
7753@subsection HPPA Options
7754@cindex HPPA Options
7755
7756These @samp{-m} options are defined for the HPPA family of computers:
7757
7758@table @gcctabopt
7759@item -march=@var{architecture-type}
7760@opindex march
7761Generate code for the specified architecture. The choices for
7762@var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
77631.1, and @samp{2.0} for PA 2.0 processors. Refer to
7764@file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7765architecture option for your machine. Code compiled for lower numbered
7766architectures will run on higher numbered architectures, but not the
7767other way around.
7768
7769PA 2.0 support currently requires gas snapshot 19990413 or later. The
7770next release of binutils (current is 2.9.1) will probably contain PA 2.0
7771support.
7772
7773@item -mpa-risc-1-0
7774@itemx -mpa-risc-1-1
7775@itemx -mpa-risc-2-0
7776@opindex mpa-risc-1-0
7777@opindex mpa-risc-1-1
7778@opindex mpa-risc-2-0
7779Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
7780
7781@item -mbig-switch
7782@opindex mbig-switch
7783Generate code suitable for big switch tables. Use this option only if
7784the assembler/linker complain about out of range branches within a switch
7785table.
7786
7787@item -mjump-in-delay
7788@opindex mjump-in-delay
7789Fill delay slots of function calls with unconditional jump instructions
7790by modifying the return pointer for the function call to be the target
7791of the conditional jump.
7792
7793@item -mdisable-fpregs
7794@opindex mdisable-fpregs
7795Prevent floating point registers from being used in any manner. This is
7796necessary for compiling kernels which perform lazy context switching of
7797floating point registers. If you use this option and attempt to perform
7798floating point operations, the compiler will abort.
7799
7800@item -mdisable-indexing
7801@opindex mdisable-indexing
7802Prevent the compiler from using indexing address modes. This avoids some
7803rather obscure problems when compiling MIG generated code under MACH@.
7804
7805@item -mno-space-regs
7806@opindex mno-space-regs
7807Generate code that assumes the target has no space registers. This allows
7808GCC to generate faster indirect calls and use unscaled index address modes.
7809
7810Such code is suitable for level 0 PA systems and kernels.
7811
7812@item -mfast-indirect-calls
7813@opindex mfast-indirect-calls
7814Generate code that assumes calls never cross space boundaries. This
7815allows GCC to emit code which performs faster indirect calls.
7816
7817This option will not work in the presence of shared libraries or nested
7818functions.
7819
7820@item -mlong-load-store
7821@opindex mlong-load-store
7822Generate 3-instruction load and store sequences as sometimes required by
7823the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
7824the HP compilers.
7825
7826@item -mportable-runtime
7827@opindex mportable-runtime
7828Use the portable calling conventions proposed by HP for ELF systems.
7829
7830@item -mgas
7831@opindex mgas
7832Enable the use of assembler directives only GAS understands.
7833
7834@item -mschedule=@var{cpu-type}
7835@opindex mschedule
7836Schedule code according to the constraints for the machine type
7837@var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
7838@samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
7839to @file{/usr/lib/sched.models} on an HP-UX system to determine the
7840proper scheduling option for your machine. The default scheduling is
7841@samp{8000}.
7842
7843@item -mlinker-opt
7844@opindex mlinker-opt
7845Enable the optimization pass in the HPUX linker. Note this makes symbolic
7846debugging impossible. It also triggers a bug in the HPUX 8 and HPUX 9 linkers
7847in which they give bogus error messages when linking some programs.
7848
7849@item -msoft-float
7850@opindex msoft-float
7851Generate output containing library calls for floating point.
7852@strong{Warning:} the requisite libraries are not available for all HPPA
7853targets. Normally the facilities of the machine's usual C compiler are
7854used, but this cannot be done directly in cross-compilation. You must make
7855your own arrangements to provide suitable library functions for
7856cross-compilation. The embedded target @samp{hppa1.1-*-pro}
7857does provide software floating point support.
7858
7859@option{-msoft-float} changes the calling convention in the output file;
7860therefore, it is only useful if you compile @emph{all} of a program with
7861this option. In particular, you need to compile @file{libgcc.a}, the
7862library that comes with GCC, with @option{-msoft-float} in order for
7863this to work.
7864@end table
7865
7866@node Intel 960 Options
7867@subsection Intel 960 Options
7868
7869These @samp{-m} options are defined for the Intel 960 implementations:
7870
7871@table @gcctabopt
7872@item -m@var{cpu-type}
7873@opindex mka
7874@opindex mkb
7875@opindex mmc
7876@opindex mca
7877@opindex mcf
7878@opindex msa
7879@opindex msb
7880Assume the defaults for the machine type @var{cpu-type} for some of
7881the other options, including instruction scheduling, floating point
7882support, and addressing modes. The choices for @var{cpu-type} are
7883@samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
7884@samp{sa}, and @samp{sb}.
7885The default is
7886@samp{kb}.
7887
7888@item -mnumerics
7889@itemx -msoft-float
7890@opindex mnumerics
7891@opindex msoft-float
7892The @option{-mnumerics} option indicates that the processor does support
7893floating-point instructions. The @option{-msoft-float} option indicates
7894that floating-point support should not be assumed.
7895
7896@item -mleaf-procedures
7897@itemx -mno-leaf-procedures
7898@opindex mleaf-procedures
7899@opindex mno-leaf-procedures
7900Do (or do not) attempt to alter leaf procedures to be callable with the
7901@code{bal} instruction as well as @code{call}. This will result in more
7902efficient code for explicit calls when the @code{bal} instruction can be
7903substituted by the assembler or linker, but less efficient code in other
7904cases, such as calls via function pointers, or using a linker that doesn't
7905support this optimization.
7906
7907@item -mtail-call
7908@itemx -mno-tail-call
7909@opindex mtail-call
7910@opindex mno-tail-call
7911Do (or do not) make additional attempts (beyond those of the
7912machine-independent portions of the compiler) to optimize tail-recursive
7913calls into branches. You may not want to do this because the detection of
7914cases where this is not valid is not totally complete. The default is
7915@option{-mno-tail-call}.
7916
7917@item -mcomplex-addr
7918@itemx -mno-complex-addr
7919@opindex mcomplex-addr
7920@opindex mno-complex-addr
7921Assume (or do not assume) that the use of a complex addressing mode is a
7922win on this implementation of the i960. Complex addressing modes may not
7923be worthwhile on the K-series, but they definitely are on the C-series.
7924The default is currently @option{-mcomplex-addr} for all processors except
7925the CB and CC@.
7926
7927@item -mcode-align
7928@itemx -mno-code-align
7929@opindex mcode-align
7930@opindex mno-code-align
7931Align code to 8-byte boundaries for faster fetching (or don't bother).
7932Currently turned on by default for C-series implementations only.
7933
7934@ignore
7935@item -mclean-linkage
7936@itemx -mno-clean-linkage
7937@opindex mclean-linkage
7938@opindex mno-clean-linkage
7939These options are not fully implemented.
7940@end ignore
7941
7942@item -mic-compat
7943@itemx -mic2.0-compat
7944@itemx -mic3.0-compat
7945@opindex mic-compat
7946@opindex mic2.0-compat
7947@opindex mic3.0-compat
7948Enable compatibility with iC960 v2.0 or v3.0.
7949
7950@item -masm-compat
7951@itemx -mintel-asm
7952@opindex masm-compat
7953@opindex mintel-asm
7954Enable compatibility with the iC960 assembler.
7955
7956@item -mstrict-align
7957@itemx -mno-strict-align
7958@opindex mstrict-align
7959@opindex mno-strict-align
7960Do not permit (do permit) unaligned accesses.
7961
7962@item -mold-align
7963@opindex mold-align
7964Enable structure-alignment compatibility with Intel's gcc release version
79651.3 (based on gcc 1.37). This option implies @option{-mstrict-align}.
7966
7967@item -mlong-double-64
7968@opindex mlong-double-64
7969Implement type @samp{long double} as 64-bit floating point numbers.
7970Without the option @samp{long double} is implemented by 80-bit
7971floating point numbers. The only reason we have it because there is
7972no 128-bit @samp{long double} support in @samp{fp-bit.c} yet. So it
7973is only useful for people using soft-float targets. Otherwise, we
7974should recommend against use of it.
7975
7976@end table
7977
7978@node DEC Alpha Options
7979@subsection DEC Alpha Options
7980
7981These @samp{-m} options are defined for the DEC Alpha implementations:
7982
7983@table @gcctabopt
7984@item -mno-soft-float
7985@itemx -msoft-float
7986@opindex mno-soft-float
7987@opindex msoft-float
7988Use (do not use) the hardware floating-point instructions for
7989floating-point operations. When @option{-msoft-float} is specified,
7990functions in @file{libgcc.a} will be used to perform floating-point
7991operations. Unless they are replaced by routines that emulate the
7992floating-point operations, or compiled in such a way as to call such
7993emulations routines, these routines will issue floating-point
7994operations. If you are compiling for an Alpha without floating-point
7995operations, you must ensure that the library is built so as not to call
7996them.
7997
7998Note that Alpha implementations without floating-point operations are
7999required to have floating-point registers.
8000
8001@item -mfp-reg
8002@itemx -mno-fp-regs
8003@opindex mfp-reg
8004@opindex mno-fp-regs
8005Generate code that uses (does not use) the floating-point register set.
8006@option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
8007register set is not used, floating point operands are passed in integer
8008registers as if they were integers and floating-point results are passed
8009in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
8010so any function with a floating-point argument or return value called by code
8011compiled with @option{-mno-fp-regs} must also be compiled with that
8012option.
8013
8014A typical use of this option is building a kernel that does not use,
8015and hence need not save and restore, any floating-point registers.
8016
8017@item -mieee
8018@opindex mieee
8019The Alpha architecture implements floating-point hardware optimized for
8020maximum performance. It is mostly compliant with the IEEE floating
8021point standard. However, for full compliance, software assistance is
8022required. This option generates code fully IEEE compliant code
8023@emph{except} that the @var{inexact-flag} is not maintained (see below).
8024If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8025defined during compilation. The resulting code is less efficient but is
8026able to correctly support denormalized numbers and exceptional IEEE
8027values such as not-a-number and plus/minus infinity. Other Alpha
8028compilers call this option @option{-ieee_with_no_inexact}.
8029
8030@item -mieee-with-inexact
8031@opindex mieee-with-inexact
8032This is like @option{-mieee} except the generated code also maintains
8033the IEEE @var{inexact-flag}. Turning on this option causes the
8034generated code to implement fully-compliant IEEE math. In addition to
8035@code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8036macro. On some Alpha implementations the resulting code may execute
8037significantly slower than the code generated by default. Since there is
8038very little code that depends on the @var{inexact-flag}, you should
8039normally not specify this option. Other Alpha compilers call this
8040option @option{-ieee_with_inexact}.
8041
8042@item -mfp-trap-mode=@var{trap-mode}
8043@opindex mfp-trap-mode
8044This option controls what floating-point related traps are enabled.
8045Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8046The trap mode can be set to one of four values:
8047
8048@table @samp
8049@item n
8050This is the default (normal) setting. The only traps that are enabled
8051are the ones that cannot be disabled in software (e.g., division by zero
8052trap).
8053
8054@item u
8055In addition to the traps enabled by @samp{n}, underflow traps are enabled
8056as well.
8057
8058@item su
8059Like @samp{su}, but the instructions are marked to be safe for software
8060completion (see Alpha architecture manual for details).
8061
8062@item sui
8063Like @samp{su}, but inexact traps are enabled as well.
8064@end table
8065
8066@item -mfp-rounding-mode=@var{rounding-mode}
8067@opindex mfp-rounding-mode
8068Selects the IEEE rounding mode. Other Alpha compilers call this option
8069@option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
8070of:
8071
8072@table @samp
8073@item n
8074Normal IEEE rounding mode. Floating point numbers are rounded towards
8075the nearest machine number or towards the even machine number in case
8076of a tie.
8077
8078@item m
8079Round towards minus infinity.
8080
8081@item c
8082Chopped rounding mode. Floating point numbers are rounded towards zero.
8083
8084@item d
8085Dynamic rounding mode. A field in the floating point control register
8086(@var{fpcr}, see Alpha architecture reference manual) controls the
8087rounding mode in effect. The C library initializes this register for
8088rounding towards plus infinity. Thus, unless your program modifies the
8089@var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8090@end table
8091
8092@item -mtrap-precision=@var{trap-precision}
8093@opindex mtrap-precision
8094In the Alpha architecture, floating point traps are imprecise. This
8095means without software assistance it is impossible to recover from a
8096floating trap and program execution normally needs to be terminated.
8097GCC can generate code that can assist operating system trap handlers
8098in determining the exact location that caused a floating point trap.
8099Depending on the requirements of an application, different levels of
8100precisions can be selected:
8101
8102@table @samp
8103@item p
8104Program precision. This option is the default and means a trap handler
8105can only identify which program caused a floating point exception.
8106
8107@item f
8108Function precision. The trap handler can determine the function that
8109caused a floating point exception.
8110
8111@item i
8112Instruction precision. The trap handler can determine the exact
8113instruction that caused a floating point exception.
8114@end table
8115
8116Other Alpha compilers provide the equivalent options called
8117@option{-scope_safe} and @option{-resumption_safe}.
8118
8119@item -mieee-conformant
8120@opindex mieee-conformant
8121This option marks the generated code as IEEE conformant. You must not
8122use this option unless you also specify @option{-mtrap-precision=i} and either
8123@option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
8124is to emit the line @samp{.eflag 48} in the function prologue of the
8125generated assembly file. Under DEC Unix, this has the effect that
8126IEEE-conformant math library routines will be linked in.
8127
8128@item -mbuild-constants
8129@opindex mbuild-constants
8130Normally GCC examines a 32- or 64-bit integer constant to
8131see if it can construct it from smaller constants in two or three
8132instructions. If it cannot, it will output the constant as a literal and
8133generate code to load it from the data segment at runtime.
8134
8135Use this option to require GCC to construct @emph{all} integer constants
8136using code, even if it takes more instructions (the maximum is six).
8137
8138You would typically use this option to build a shared library dynamic
8139loader. Itself a shared library, it must relocate itself in memory
8140before it can find the variables and constants in its own data segment.
8141
8142@item -malpha-as
8143@itemx -mgas
8144@opindex malpha-as
8145@opindex mgas
8146Select whether to generate code to be assembled by the vendor-supplied
8147assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8148
8149@item -mbwx
8150@itemx -mno-bwx
8151@itemx -mcix
8152@itemx -mno-cix
8153@itemx -mfix
8154@itemx -mno-fix
8155@itemx -mmax
8156@itemx -mno-max
8157@opindex mbwx
8158@opindex mno-bwx
8159@opindex mcix
8160@opindex mno-cix
8161@opindex mfix
8162@opindex mno-fix
8163@opindex mmax
8164@opindex mno-max
8165Indicate whether GCC should generate code to use the optional BWX,
8166CIX, FIX and MAX instruction sets. The default is to use the instruction
8167sets supported by the CPU type specified via @option{-mcpu=} option or that
8168of the CPU on which GCC was built if none was specified.
8169
8170@item -mfloat-vax
8171@itemx -mfloat-ieee
8172@opindex mfloat-vax
8173@opindex mfloat-ieee
8174Generate code that uses (does not use) VAX F and G floating point
8175arithmetic instead of IEEE single and double precision.
8176
8177@item -mexplicit-relocs
8178@itemx -mno-explicit-relocs
8179@opindex mexplicit-relocs
8180@opindex mno-explicit-relocs
8181Older Alpha assemblers provided no way to generate symbol relocations
8182except via assembler macros. Use of these macros does not allow
8183optimial instruction scheduling. GNU binutils as of version 2.12
8184supports a new syntax that allows the compiler to explicitly mark
8185which relocations should apply to which instructions. This option
8186is mostly useful for debugging, as GCC detects the capabilities of
8187the assembler when it is built and sets the default accordingly.
8188
8189@item -msmall-data
8190@itemx -mlarge-data
8191@opindex msmall-data
8192@opindex mlarge-data
8193When @option{-mexplicit-relocs} is in effect, static data is
8194accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8195is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8196(the @code{.sdata} and @code{.sbss} sections) and are accessed via
819716-bit relocations off of the @code{$gp} register. This limits the
8198size of the small data area to 64KB, but allows the variables to be
8199directly accessed via a single instruction.
8200
8201The default is @option{-mlarge-data}. With this option the data area
8202is limited to just below 2GB. Programs that require more than 2GB of
8203data must use @code{malloc} or @code{mmap} to allocate the data in the
8204heap instead of in the program's data segment.
8205
8206When generating code for shared libraries, @option{-fpic} implies
8207@option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8208
8209@item -mcpu=@var{cpu_type}
8210@opindex mcpu
8211Set the instruction set and instruction scheduling parameters for
8212machine type @var{cpu_type}. You can specify either the @samp{EV}
8213style name or the corresponding chip number. GCC supports scheduling
8214parameters for the EV4, EV5 and EV6 family of processors and will
8215choose the default values for the instruction set from the processor
8216you specify. If you do not specify a processor type, GCC will default
8217to the processor on which the compiler was built.
8218
8219Supported values for @var{cpu_type} are
8220
8221@table @samp
8222@item ev4
8223@item ev45
8224@itemx 21064
8225Schedules as an EV4 and has no instruction set extensions.
8226
8227@item ev5
8228@itemx 21164
8229Schedules as an EV5 and has no instruction set extensions.
8230
8231@item ev56
8232@itemx 21164a
8233Schedules as an EV5 and supports the BWX extension.
8234
8235@item pca56
8236@itemx 21164pc
8237@itemx 21164PC
8238Schedules as an EV5 and supports the BWX and MAX extensions.
8239
8240@item ev6
8241@itemx 21264
8242Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8243
8244@item ev67
8245@item 21264a
8246Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8247@end table
8248
8249@item -mtune=@var{cpu_type}
8250@opindex mtune
8251Set only the instruction scheduling parameters for machine type
8252@var{cpu_type}. The instruction set is not changed.
8253
8254@item -mmemory-latency=@var{time}
8255@opindex mmemory-latency
8256Sets the latency the scheduler should assume for typical memory
8257references as seen by the application. This number is highly
8258dependent on the memory access patterns used by the application
8259and the size of the external cache on the machine.
8260
8261Valid options for @var{time} are
8262
8263@table @samp
8264@item @var{number}
8265A decimal number representing clock cycles.
8266
8267@item L1
8268@itemx L2
8269@itemx L3
8270@itemx main
8271The compiler contains estimates of the number of clock cycles for
8272``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8273(also called Dcache, Scache, and Bcache), as well as to main memory.
8274Note that L3 is only valid for EV5.
8275
8276@end table
8277@end table
8278
8279@node DEC Alpha/VMS Options
8280@subsection DEC Alpha/VMS Options
8281
8282These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8283
8284@table @gcctabopt
8285@item -mvms-return-codes
8286@opindex mvms-return-codes
8287Return VMS condition codes from main. The default is to return POSIX
8288style condition (e.g.@ error) codes.
8289@end table
8290
8291@node Clipper Options
8292@subsection Clipper Options
8293
8294These @samp{-m} options are defined for the Clipper implementations:
8295
8296@table @gcctabopt
8297@item -mc300
8298@opindex mc300
8299Produce code for a C300 Clipper processor. This is the default.
8300
8301@item -mc400
8302@opindex mc400
8303Produce code for a C400 Clipper processor, i.e.@: use floating point
8304registers f8--f15.
8305@end table
8306
8307@node H8/300 Options
8308@subsection H8/300 Options
8309
8310These @samp{-m} options are defined for the H8/300 implementations:
8311
8312@table @gcctabopt
8313@item -mrelax
8314@opindex mrelax
8315Shorten some address references at link time, when possible; uses the
8316linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8317ld.info, Using ld}, for a fuller description.
8318
8319@item -mh
8320@opindex mh
8321Generate code for the H8/300H@.
8322
8323@item -ms
8324@opindex ms
8325Generate code for the H8/S@.
8326
8327@item -ms2600
8328@opindex ms2600
8329Generate code for the H8/S2600. This switch must be used with @option{-ms}.
8330
8331@item -mint32
8332@opindex mint32
8333Make @code{int} data 32 bits by default.
8334
8335@item -malign-300
8336@opindex malign-300
8337On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
8338The default for the H8/300H and H8/S is to align longs and floats on 4
8339byte boundaries.
8340@option{-malign-300} causes them to be aligned on 2 byte boundaries.
8341This option has no effect on the H8/300.
8342@end table
8343
8344@node SH Options
8345@subsection SH Options
8346
8347These @samp{-m} options are defined for the SH implementations:
8348
8349@table @gcctabopt
8350@item -m1
8351@opindex m1
8352Generate code for the SH1.
8353
8354@item -m2
8355@opindex m2
8356Generate code for the SH2.
8357
8358@item -m3
8359@opindex m3
8360Generate code for the SH3.
8361
8362@item -m3e
8363@opindex m3e
8364Generate code for the SH3e.
8365
8366@item -m4-nofpu
8367@opindex m4-nofpu
8368Generate code for the SH4 without a floating-point unit.
8369
8370@item -m4-single-only
8371@opindex m4-single-only
8372Generate code for the SH4 with a floating-point unit that only
8373supports single-precision arithmetic.
8374
8375@item -m4-single
8376@opindex m4-single
8377Generate code for the SH4 assuming the floating-point unit is in
8378single-precision mode by default.
8379
8380@item -m4
8381@opindex m4
8382Generate code for the SH4.
8383
8384@item -mb
8385@opindex mb
8386Compile code for the processor in big endian mode.
8387
8388@item -ml
8389@opindex ml
8390Compile code for the processor in little endian mode.
8391
8392@item -mdalign
8393@opindex mdalign
8394Align doubles at 64-bit boundaries. Note that this changes the calling
8395conventions, and thus some functions from the standard C library will
8396not work unless you recompile it first with @option{-mdalign}.
8397
8398@item -mrelax
8399@opindex mrelax
8400Shorten some address references at link time, when possible; uses the
8401linker option @option{-relax}.
8402
8403@item -mbigtable
8404@opindex mbigtable
8405Use 32-bit offsets in @code{switch} tables. The default is to use
840616-bit offsets.
8407
8408@item -mfmovd
8409@opindex mfmovd
8410Enable the use of the instruction @code{fmovd}.
8411
8412@item -mhitachi
8413@opindex mhitachi
8414Comply with the calling conventions defined by Hitachi.
8415
8416@item -mnomacsave
8417@opindex mnomacsave
8418Mark the @code{MAC} register as call-clobbered, even if
8419@option{-mhitachi} is given.
8420
8421@item -mieee
8422@opindex mieee
8423Increase IEEE-compliance of floating-point code.
8424
8425@item -misize
8426@opindex misize
8427Dump instruction size and location in the assembly code.
8428
8429@item -mpadstruct
8430@opindex mpadstruct
8431This option is deprecated. It pads structures to multiple of 4 bytes,
8432which is incompatible with the SH ABI@.
8433
8434@item -mspace
8435@opindex mspace
8436Optimize for space instead of speed. Implied by @option{-Os}.
8437
8438@item -mprefergot
8439@opindex mprefergot
8440When generating position-independent code, emit function calls using
8441the Global Offset Table instead of the Procedure Linkage Table.
8442
8443@item -musermode
8444@opindex musermode
8445Generate a library function call to invalidate instruction cache
8446entries, after fixing up a trampoline. This library function call
8447doesn't assume it can write to the whole memory address space. This
8448is the default when the target is @code{sh-*-linux*}.
8449@end table
8450
8451@node System V Options
8452@subsection Options for System V
8453
8454These additional options are available on System V Release 4 for
8455compatibility with other compilers on those systems:
8456
8457@table @gcctabopt
8458@item -G
8459@opindex G
8460Create a shared object.
8461It is recommended that @option{-symbolic} or @option{-shared} be used instead.
8462
8463@item -Qy
8464@opindex Qy
8465Identify the versions of each tool used by the compiler, in a
8466@code{.ident} assembler directive in the output.
8467
8468@item -Qn
8469@opindex Qn
8470Refrain from adding @code{.ident} directives to the output file (this is
8471the default).
8472
8473@item -YP,@var{dirs}
8474@opindex YP
8475Search the directories @var{dirs}, and no others, for libraries
8476specified with @option{-l}.
8477
8478@item -Ym,@var{dir}
8479@opindex Ym
8480Look in the directory @var{dir} to find the M4 preprocessor.
8481The assembler uses this option.
8482@c This is supposed to go with a -Yd for predefined M4 macro files, but
8483@c the generic assembler that comes with Solaris takes just -Ym.
8484@end table
8485
8486@node TMS320C3x/C4x Options
8487@subsection TMS320C3x/C4x Options
8488@cindex TMS320C3x/C4x Options
8489
8490These @samp{-m} options are defined for TMS320C3x/C4x implementations:
8491
8492@table @gcctabopt
8493
8494@item -mcpu=@var{cpu_type}
8495@opindex mcpu
8496Set the instruction set, register set, and instruction scheduling
8497parameters for machine type @var{cpu_type}. Supported values for
8498@var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
8499@samp{c44}. The default is @samp{c40} to generate code for the
8500TMS320C40.
8501
8502@item -mbig-memory
8503@item -mbig
8504@itemx -msmall-memory
8505@itemx -msmall
8506@opindex mbig-memory
8507@opindex mbig
8508@opindex msmall-memory
8509@opindex msmall
8510Generates code for the big or small memory model. The small memory
8511model assumed that all data fits into one 64K word page. At run-time
8512the data page (DP) register must be set to point to the 64K page
8513containing the .bss and .data program sections. The big memory model is
8514the default and requires reloading of the DP register for every direct
8515memory access.
8516
8517@item -mbk
8518@itemx -mno-bk
8519@opindex mbk
8520@opindex mno-bk
8521Allow (disallow) allocation of general integer operands into the block
8522count register BK@.
8523
8524@item -mdb
8525@itemx -mno-db
8526@opindex mdb
8527@opindex mno-db
8528Enable (disable) generation of code using decrement and branch,
8529DBcond(D), instructions. This is enabled by default for the C4x. To be
8530on the safe side, this is disabled for the C3x, since the maximum
8531iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
8532@math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
8533that it can utilise the decrement and branch instruction, but will give
8534up if there is more than one memory reference in the loop. Thus a loop
8535where the loop counter is decremented can generate slightly more
8536efficient code, in cases where the RPTB instruction cannot be utilised.
8537
8538@item -mdp-isr-reload
8539@itemx -mparanoid
8540@opindex mdp-isr-reload
8541@opindex mparanoid
8542Force the DP register to be saved on entry to an interrupt service
8543routine (ISR), reloaded to point to the data section, and restored on
8544exit from the ISR@. This should not be required unless someone has
8545violated the small memory model by modifying the DP register, say within
8546an object library.
8547
8548@item -mmpyi
8549@itemx -mno-mpyi
8550@opindex mmpyi
8551@opindex mno-mpyi
8552For the C3x use the 24-bit MPYI instruction for integer multiplies
8553instead of a library call to guarantee 32-bit results. Note that if one
8554of the operands is a constant, then the multiplication will be performed
8555using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
8556then squaring operations are performed inline instead of a library call.
8557
8558@item -mfast-fix
8559@itemx -mno-fast-fix
8560@opindex mfast-fix
8561@opindex mno-fast-fix
8562The C3x/C4x FIX instruction to convert a floating point value to an
8563integer value chooses the nearest integer less than or equal to the
8564floating point value rather than to the nearest integer. Thus if the
8565floating point number is negative, the result will be incorrectly
8566truncated an additional code is necessary to detect and correct this
8567case. This option can be used to disable generation of the additional
8568code required to correct the result.
8569
8570@item -mrptb
8571@itemx -mno-rptb
8572@opindex mrptb
8573@opindex mno-rptb
8574Enable (disable) generation of repeat block sequences using the RPTB
8575instruction for zero overhead looping. The RPTB construct is only used
8576for innermost loops that do not call functions or jump across the loop
8577boundaries. There is no advantage having nested RPTB loops due to the
8578overhead required to save and restore the RC, RS, and RE registers.
8579This is enabled by default with @option{-O2}.
8580
8581@item -mrpts=@var{count}
8582@itemx -mno-rpts
8583@opindex mrpts
8584@opindex mno-rpts
8585Enable (disable) the use of the single instruction repeat instruction
8586RPTS@. If a repeat block contains a single instruction, and the loop
8587count can be guaranteed to be less than the value @var{count}, GCC will
8588emit a RPTS instruction instead of a RPTB@. If no value is specified,
8589then a RPTS will be emitted even if the loop count cannot be determined
8590at compile time. Note that the repeated instruction following RPTS does
8591not have to be reloaded from memory each iteration, thus freeing up the
8592CPU buses for operands. However, since interrupts are blocked by this
8593instruction, it is disabled by default.
8594
8595@item -mloop-unsigned
8596@itemx -mno-loop-unsigned
8597@opindex mloop-unsigned
8598@opindex mno-loop-unsigned
8599The maximum iteration count when using RPTS and RPTB (and DB on the C40)
8600is @math{2^{31} + 1} since these instructions test if the iteration count is
8601negative to terminate the loop. If the iteration count is unsigned
8602there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
8603exceeded. This switch allows an unsigned iteration count.
8604
8605@item -mti
8606@opindex mti
8607Try to emit an assembler syntax that the TI assembler (asm30) is happy
8608with. This also enforces compatibility with the API employed by the TI
8609C3x C compiler. For example, long doubles are passed as structures
8610rather than in floating point registers.
8611
8612@item -mregparm
8613@itemx -mmemparm
8614@opindex mregparm
8615@opindex mmemparm
8616Generate code that uses registers (stack) for passing arguments to functions.
8617By default, arguments are passed in registers where possible rather
8618than by pushing arguments on to the stack.
8619
8620@item -mparallel-insns
8621@itemx -mno-parallel-insns
8622@opindex mparallel-insns
8623@opindex mno-parallel-insns
8624Allow the generation of parallel instructions. This is enabled by
8625default with @option{-O2}.
8626
8627@item -mparallel-mpy
8628@itemx -mno-parallel-mpy
8629@opindex mparallel-mpy
8630@opindex mno-parallel-mpy
8631Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
8632provided @option{-mparallel-insns} is also specified. These instructions have
8633tight register constraints which can pessimize the code generation
8634of large functions.
8635
8636@end table
8637
8638@node V850 Options
8639@subsection V850 Options
8640@cindex V850 Options
8641
8642These @samp{-m} options are defined for V850 implementations:
8643
8644@table @gcctabopt
8645@item -mlong-calls
8646@itemx -mno-long-calls
8647@opindex mlong-calls
8648@opindex mno-long-calls
8649Treat all calls as being far away (near). If calls are assumed to be
8650far away, the compiler will always load the functions address up into a
8651register, and call indirect through the pointer.
8652
8653@item -mno-ep
8654@itemx -mep
8655@opindex mno-ep
8656@opindex mep
8657Do not optimize (do optimize) basic blocks that use the same index
8658pointer 4 or more times to copy pointer into the @code{ep} register, and
8659use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
8660option is on by default if you optimize.
8661
8662@item -mno-prolog-function
8663@itemx -mprolog-function
8664@opindex mno-prolog-function
8665@opindex mprolog-function
8666Do not use (do use) external functions to save and restore registers at
8667the prolog and epilog of a function. The external functions are slower,
8668but use less code space if more than one function saves the same number
8669of registers. The @option{-mprolog-function} option is on by default if
8670you optimize.
8671
8672@item -mspace
8673@opindex mspace
8674Try to make the code as small as possible. At present, this just turns
8675on the @option{-mep} and @option{-mprolog-function} options.
8676
8677@item -mtda=@var{n}
8678@opindex mtda
8679Put static or global variables whose size is @var{n} bytes or less into
8680the tiny data area that register @code{ep} points to. The tiny data
8681area can hold up to 256 bytes in total (128 bytes for byte references).
8682
8683@item -msda=@var{n}
8684@opindex msda
8685Put static or global variables whose size is @var{n} bytes or less into
8686the small data area that register @code{gp} points to. The small data
8687area can hold up to 64 kilobytes.
8688
8689@item -mzda=@var{n}
8690@opindex mzda
8691Put static or global variables whose size is @var{n} bytes or less into
8692the first 32 kilobytes of memory.
8693
8694@item -mv850
8695@opindex mv850
8696Specify that the target processor is the V850.
8697
8698@item -mbig-switch
8699@opindex mbig-switch
8700Generate code suitable for big switch tables. Use this option only if
8701the assembler/linker complain about out of range branches within a switch
8702table.
8703@end table
8704
8705@node ARC Options
8706@subsection ARC Options
8707@cindex ARC Options
8708
8709These options are defined for ARC implementations:
8710
8711@table @gcctabopt
8712@item -EL
8713@opindex EL
8714Compile code for little endian mode. This is the default.
8715
8716@item -EB
8717@opindex EB
8718Compile code for big endian mode.
8719
8720@item -mmangle-cpu
8721@opindex mmangle-cpu
8722Prepend the name of the cpu to all public symbol names.
8723In multiple-processor systems, there are many ARC variants with different
8724instruction and register set characteristics. This flag prevents code
8725compiled for one cpu to be linked with code compiled for another.
8726No facility exists for handling variants that are ``almost identical''.
8727This is an all or nothing option.
8728
8729@item -mcpu=@var{cpu}
8730@opindex mcpu
8731Compile code for ARC variant @var{cpu}.
8732Which variants are supported depend on the configuration.
8733All variants support @option{-mcpu=base}, this is the default.
8734
8735@item -mtext=@var{text-section}
8736@itemx -mdata=@var{data-section}
8737@itemx -mrodata=@var{readonly-data-section}
8738@opindex mtext
8739@opindex mdata
8740@opindex mrodata
8741Put functions, data, and readonly data in @var{text-section},
8742@var{data-section}, and @var{readonly-data-section} respectively
8743by default. This can be overridden with the @code{section} attribute.
8744@xref{Variable Attributes}.
8745
8746@end table
8747
8748@node NS32K Options
8749@subsection NS32K Options
8750@cindex NS32K options
8751
8752These are the @samp{-m} options defined for the 32000 series. The default
8753values for these options depends on which style of 32000 was selected when
8754the compiler was configured; the defaults for the most common choices are
8755given below.
8756
8757@table @gcctabopt
8758@item -m32032
8759@itemx -m32032
8760@opindex m32032
8761@opindex m32032
8762Generate output for a 32032. This is the default
8763when the compiler is configured for 32032 and 32016 based systems.
8764
8765@item -m32332
8766@itemx -m32332
8767@opindex m32332
8768@opindex m32332
8769Generate output for a 32332. This is the default
8770when the compiler is configured for 32332-based systems.
8771
8772@item -m32532
8773@itemx -m32532
8774@opindex m32532
8775@opindex m32532
8776Generate output for a 32532. This is the default
8777when the compiler is configured for 32532-based systems.
8778
8779@item -m32081
8780@opindex m32081
8781Generate output containing 32081 instructions for floating point.
8782This is the default for all systems.
8783
8784@item -m32381
8785@opindex m32381
8786Generate output containing 32381 instructions for floating point. This
8787also implies @option{-m32081}. The 32381 is only compatible with the 32332
8788and 32532 cpus. This is the default for the pc532-netbsd configuration.
8789
8790@item -mmulti-add
8791@opindex mmulti-add
8792Try and generate multiply-add floating point instructions @code{polyF}
8793and @code{dotF}. This option is only available if the @option{-m32381}
8794option is in effect. Using these instructions requires changes to
8795register allocation which generally has a negative impact on
8796performance. This option should only be enabled when compiling code
8797particularly likely to make heavy use of multiply-add instructions.
8798
8799@item -mnomulti-add
8800@opindex mnomulti-add
8801Do not try and generate multiply-add floating point instructions
8802@code{polyF} and @code{dotF}. This is the default on all platforms.
8803
8804@item -msoft-float
8805@opindex msoft-float
8806Generate output containing library calls for floating point.
8807@strong{Warning:} the requisite libraries may not be available.
8808
8809@item -mieee-compare
8810@itemx -mno-ieee-compare
8811@opindex mieee-compare
8812@opindex mno-ieee-compare
8813Control whether or not the compiler uses IEEE floating point
8814comparisons. These handle correctly the case where the result of a
8815comparison is unordered.
8816@strong{Warning:} the requisite kernel support may not be available.
8817
8818@item -mnobitfield
8819@opindex mnobitfield
8820Do not use the bit-field instructions. On some machines it is faster to
8821use shifting and masking operations. This is the default for the pc532.
8822
8823@item -mbitfield
8824@opindex mbitfield
8825Do use the bit-field instructions. This is the default for all platforms
8826except the pc532.
8827
8828@item -mrtd
8829@opindex mrtd
8830Use a different function-calling convention, in which functions
8831that take a fixed number of arguments return pop their
8832arguments on return with the @code{ret} instruction.
8833
8834This calling convention is incompatible with the one normally
8835used on Unix, so you cannot use it if you need to call libraries
8836compiled with the Unix compiler.
8837
8838Also, you must provide function prototypes for all functions that
8839take variable numbers of arguments (including @code{printf});
8840otherwise incorrect code will be generated for calls to those
8841functions.
8842
8843In addition, seriously incorrect code will result if you call a
8844function with too many arguments. (Normally, extra arguments are
8845harmlessly ignored.)
8846
8847This option takes its name from the 680x0 @code{rtd} instruction.
8848
8849
8850@item -mregparam
8851@opindex mregparam
8852Use a different function-calling convention where the first two arguments
8853are passed in registers.
8854
8855This calling convention is incompatible with the one normally
8856used on Unix, so you cannot use it if you need to call libraries
8857compiled with the Unix compiler.
8858
8859@item -mnoregparam
8860@opindex mnoregparam
8861Do not pass any arguments in registers. This is the default for all
8862targets.
8863
8864@item -msb
8865@opindex msb
8866It is OK to use the sb as an index register which is always loaded with
8867zero. This is the default for the pc532-netbsd target.
8868
8869@item -mnosb
8870@opindex mnosb
8871The sb register is not available for use or has not been initialized to
8872zero by the run time system. This is the default for all targets except
8873the pc532-netbsd. It is also implied whenever @option{-mhimem} or
8874@option{-fpic} is set.
8875
8876@item -mhimem
8877@opindex mhimem
8878Many ns32000 series addressing modes use displacements of up to 512MB@.
8879If an address is above 512MB then displacements from zero can not be used.
8880This option causes code to be generated which can be loaded above 512MB@.
8881This may be useful for operating systems or ROM code.
8882
8883@item -mnohimem
8884@opindex mnohimem
8885Assume code will be loaded in the first 512MB of virtual address space.
8886This is the default for all platforms.
8887
8888
8889@end table
8890
8891@node AVR Options
8892@subsection AVR Options
8893@cindex AVR Options
8894
8895These options are defined for AVR implementations:
8896
8897@table @gcctabopt
8898@item -mmcu=@var{mcu}
8899@opindex mmcu
8900Specify ATMEL AVR instruction set or MCU type.
8901
8902Instruction set avr1 is for the minimal AVR core, not supported by the C
8903compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8904attiny11, attiny12, attiny15, attiny28).
8905
8906Instruction set avr2 (default) is for the classic AVR core with up to
89078K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8908at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8909at90c8534, at90s8535).
8910
8911Instruction set avr3 is for the classic AVR core with up to 128K program
8912memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8913
8914Instruction set avr4 is for the enhanced AVR core with up to 8K program
8915memory space (MCU types: atmega8, atmega83, atmega85).
8916
8917Instruction set avr5 is for the enhanced AVR core with up to 128K program
8918memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8919atmega64, atmega128, at43usb355, at94k).
8920
8921@item -msize
8922@opindex msize
8923Output instruction sizes to the asm file.
8924
8925@item -minit-stack=@var{N}
8926@opindex minit-stack
8927Specify the initial stack address, which may be a symbol or numeric value,
8928@samp{__stack} is the default.
8929
8930@item -mno-interrupts
8931@opindex mno-interrupts
8932Generated code is not compatible with hardware interrupts.
8933Code size will be smaller.
8934
8935@item -mcall-prologues
8936@opindex mcall-prologues
8937Functions prologues/epilogues expanded as call to appropriate
8938subroutines. Code size will be smaller.
8939
8940@item -mno-tablejump
8941@opindex mno-tablejump
8942Do not generate tablejump insns which sometimes increase code size.
8943
8944@item -mtiny-stack
8945@opindex mtiny-stack
8946Change only the low 8 bits of the stack pointer.
8947@end table
8948
8949@node MCore Options
8950@subsection MCore Options
8951@cindex MCore options
8952
8953These are the @samp{-m} options defined for the Motorola M*Core
8954processors.
8955
8956@table @gcctabopt
8957
8958@item -mhardlit
8959@itemx -mhardlit
8960@itemx -mno-hardlit
8961@opindex mhardlit
8962@opindex mhardlit
8963@opindex mno-hardlit
8964Inline constants into the code stream if it can be done in two
8965instructions or less.
8966
8967@item -mdiv
8968@itemx -mdiv
8969@itemx -mno-div
8970@opindex mdiv
8971@opindex mdiv
8972@opindex mno-div
8973Use the divide instruction. (Enabled by default).
8974
8975@item -mrelax-immediate
8976@itemx -mrelax-immediate
8977@itemx -mno-relax-immediate
8978@opindex mrelax-immediate
8979@opindex mrelax-immediate
8980@opindex mno-relax-immediate
8981Allow arbitrary sized immediates in bit operations.
8982
8983@item -mwide-bitfields
8984@itemx -mwide-bitfields
8985@itemx -mno-wide-bitfields
8986@opindex mwide-bitfields
8987@opindex mwide-bitfields
8988@opindex mno-wide-bitfields
8989Always treat bit-fields as int-sized.
8990
8991@item -m4byte-functions
8992@itemx -m4byte-functions
8993@itemx -mno-4byte-functions
8994@opindex m4byte-functions
8995@opindex m4byte-functions
8996@opindex mno-4byte-functions
8997Force all functions to be aligned to a four byte boundary.
8998
8999@item -mcallgraph-data
9000@itemx -mcallgraph-data
9001@itemx -mno-callgraph-data
9002@opindex mcallgraph-data
9003@opindex mcallgraph-data
9004@opindex mno-callgraph-data
9005Emit callgraph information.
9006
9007@item -mslow-bytes
9008@itemx -mslow-bytes
9009@itemx -mno-slow-bytes
9010@opindex mslow-bytes
9011@opindex mslow-bytes
9012@opindex mno-slow-bytes
9013Prefer word access when reading byte quantities.
9014
9015@item -mlittle-endian
9016@itemx -mlittle-endian
9017@itemx -mbig-endian
9018@opindex mlittle-endian
9019@opindex mlittle-endian
9020@opindex mbig-endian
9021Generate code for a little endian target.
9022
9023@item -m210
9024@itemx -m210
9025@itemx -m340
9026@opindex m210
9027@opindex m210
9028@opindex m340
9029Generate code for the 210 processor.
9030@end table
9031
9032@node IA-64 Options
9033@subsection IA-64 Options
9034@cindex IA-64 Options
9035
9036These are the @samp{-m} options defined for the Intel IA-64 architecture.
9037
9038@table @gcctabopt
9039@item -mbig-endian
9040@opindex mbig-endian
9041Generate code for a big endian target. This is the default for HPUX@.
9042
9043@item -mlittle-endian
9044@opindex mlittle-endian
9045Generate code for a little endian target. This is the default for AIX5
9046and Linux.
9047
9048@item -mgnu-as
9049@itemx -mno-gnu-as
9050@opindex mgnu-as
9051@opindex mno-gnu-as
9052Generate (or don't) code for the GNU assembler. This is the default.
9053@c Also, this is the default if the configure option @option{--with-gnu-as}
9054@c is used.
9055
9056@item -mgnu-ld
9057@itemx -mno-gnu-ld
9058@opindex mgnu-ld
9059@opindex mno-gnu-ld
9060Generate (or don't) code for the GNU linker. This is the default.
9061@c Also, this is the default if the configure option @option{--with-gnu-ld}
9062@c is used.
9063
9064@item -mno-pic
9065@opindex mno-pic
9066Generate code that does not use a global pointer register. The result
9067is not position independent code, and violates the IA-64 ABI@.
9068
9069@item -mvolatile-asm-stop
9070@itemx -mno-volatile-asm-stop
9071@opindex mvolatile-asm-stop
9072@opindex mno-volatile-asm-stop
9073Generate (or don't) a stop bit immediately before and after volatile asm
9074statements.
9075
9076@item -mb-step
9077@opindex mb-step
9078Generate code that works around Itanium B step errata.
9079
9080@item -mregister-names
9081@itemx -mno-register-names
9082@opindex mregister-names
9083@opindex mno-register-names
9084Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9085the stacked registers. This may make assembler output more readable.
9086
9087@item -mno-sdata
9088@itemx -msdata
9089@opindex mno-sdata
9090@opindex msdata
9091Disable (or enable) optimizations that use the small data section. This may
9092be useful for working around optimizer bugs.
9093
9094@item -mconstant-gp
9095@opindex mconstant-gp
9096Generate code that uses a single constant global pointer value. This is
9097useful when compiling kernel code.
9098
9099@item -mauto-pic
9100@opindex mauto-pic
9101Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9102This is useful when compiling firmware code.
9103
9104@item -minline-divide-min-latency
9105@opindex minline-divide-min-latency
9106Generate code for inline divides using the minimum latency algorithm.
9107
9108@item -minline-divide-max-throughput
9109@opindex minline-divide-max-throughput
9110Generate code for inline divides using the maximum throughput algorithm.
9111
9112@item -mno-dwarf2-asm
9113@itemx -mdwarf2-asm
9114@opindex mno-dwarf2-asm
9115@opindex mdwarf2-asm
9116Don't (or do) generate assembler code for the DWARF2 line number debugging
9117info. This may be useful when not using the GNU assembler.
9118
9119@item -mfixed-range=@var{register-range}
9120@opindex mfixed-range
9121Generate code treating the given register range as fixed registers.
9122A fixed register is one that the register allocator can not use. This is
9123useful when compiling kernel code. A register range is specified as
9124two registers separated by a dash. Multiple register ranges can be
9125specified separated by a comma.
9126@end table
9127
9128@node D30V Options
9129@subsection D30V Options
9130@cindex D30V Options
9131
9132These @samp{-m} options are defined for D30V implementations:
9133
9134@table @gcctabopt
9135@item -mextmem
9136@opindex mextmem
9137Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9138@samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9139memory, which starts at location @code{0x80000000}.
9140
9141@item -mextmemory
9142@opindex mextmemory
9143Same as the @option{-mextmem} switch.
9144
9145@item -monchip
9146@opindex monchip
9147Link the @samp{.text} section into onchip text memory, which starts at
9148location @code{0x0}. Also link @samp{.data}, @samp{.bss},
9149@samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9150into onchip data memory, which starts at location @code{0x20000000}.
9151
9152@item -mno-asm-optimize
9153@itemx -masm-optimize
9154@opindex mno-asm-optimize
9155@opindex masm-optimize
9156Disable (enable) passing @option{-O} to the assembler when optimizing.
9157The assembler uses the @option{-O} option to automatically parallelize
9158adjacent short instructions where possible.
9159
9160@item -mbranch-cost=@var{n}
9161@opindex mbranch-cost
9162Increase the internal costs of branches to @var{n}. Higher costs means
9163that the compiler will issue more instructions to avoid doing a branch.
9164The default is 2.
9165
9166@item -mcond-exec=@var{n}
9167@opindex mcond-exec
9168Specify the maximum number of conditionally executed instructions that
9169replace a branch. The default is 4.
9170@end table
9171
9172@node S/390 and zSeries Options
9173@subsection S/390 and zSeries Options
9174@cindex S/390 and zSeries Options
9175
9176These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9177
9178@table @gcctabopt
9179@item -mhard-float
9180@itemx -msoft-float
9181@opindex mhard-float
9182@opindex msoft-float
9183Use (do not use) the hardware floating-point instructions and registers
9184for floating-point operations. When @option{-msoft-float} is specified,
9185functions in @file{libgcc.a} will be used to perform floating-point
9186operations. When @option{-mhard-float} is specified, the compiler
9187generates IEEE floating-point instructions. This is the default.
9188
9189@item -mbackchain
9190@itemx -mno-backchain
9191@opindex mbackchain
9192@opindex mno-backchain
9193Generate (or do not generate) code which maintains an explicit
9194backchain within the stack frame that points to the caller's frame.
9195This is currently needed to allow debugging. The default is to
9196generate the backchain.
9197
9198@item -msmall-exec
9199@itemx -mno-small-exec
9200@opindex msmall-exec
9201@opindex mno-small-exec
9202Generate (or do not generate) code using the @code{bras} instruction
9203to do subroutine calls.
9204This only works reliably if the total executable size does not
9205exceed 64k. The default is to use the @code{basr} instruction instead,
9206which does not have this limitation.
9207
9208@item -m64
9209@itemx -m31
9210@opindex m64
9211@opindex m31
9212When @option{-m31} is specified, generate code compliant to the
9213Linux for S/390 ABI@. When @option{-m64} is specified, generate
9214code compliant to the Linux for zSeries ABI@. This allows GCC in
9215particular to generate 64-bit instructions. For the @samp{s390}
9216targets, the default is @option{-m31}, while the @samp{s390x}
9217targets default to @option{-m64}.
9218
9219@item -mmvcle
9220@itemx -mno-mvcle
9221@opindex mmvcle
9222@opindex mno-mvcle
9223Generate (or do not generate) code using the @code{mvcle} instruction
9224to perform block moves. When @option{-mno-mvcle} is specifed,
9225use a @code{mvc} loop instead. This is the default.
9226
9227@item -mdebug
9228@itemx -mno-debug
9229@opindex mdebug
9230@opindex mno-debug
9231Print (or do not print) additional debug information when compiling.
9232The default is to not print debug information.
9233
9234@end table
9235
9236@node CRIS Options
9237@subsection CRIS Options
9238@cindex CRIS Options
9239
9240These options are defined specifically for the CRIS ports.
9241
9242@table @gcctabopt
9243@item -march=@var{architecture-type}
9244@itemx -mcpu=@var{architecture-type}
9245@opindex march
9246@opindex mcpu
9247Generate code for the specified architecture. The choices for
9248@var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9249respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9250Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9251@samp{v10}.
9252
9253@item -mtune=@var{architecture-type}
9254@opindex mtune
9255Tune to @var{architecture-type} everything applicable about the generated
9256code, except for the ABI and the set of available instructions. The
9257choices for @var{architecture-type} are the same as for
9258@option{-march=@var{architecture-type}}.
9259
9260@item -mmax-stack-frame=@var{n}
9261@opindex mmax-stack-frame
9262Warn when the stack frame of a function exceeds @var{n} bytes.
9263
9264@item -melinux-stacksize=@var{n}
9265@opindex melinux-stacksize
9266Only available with the @samp{cris-axis-aout} target. Arranges for
9267indications in the program to the kernel loader that the stack of the
9268program should be set to @var{n} bytes.
9269
9270@item -metrax4
9271@itemx -metrax100
9272@opindex metrax4
9273@opindex metrax100
9274The options @option{-metrax4} and @option{-metrax100} are synonyms for
9275@option{-march=v3} and @option{-march=v8} respectively.
9276
9277@item -mpdebug
9278@opindex mpdebug
9279Enable CRIS-specific verbose debug-related information in the assembly
9280code. This option also has the effect to turn off the @samp{#NO_APP}
9281formatted-code indicator to the assembler at the beginning of the
9282assembly file.
9283
9284@item -mcc-init
9285@opindex mcc-init
9286Do not use condition-code results from previous instruction; always emit
9287compare and test instructions before use of condition codes.
9288
9289@item -mno-side-effects
9290@opindex mno-side-effects
9291Do not emit instructions with side-effects in addressing modes other than
9292post-increment.
9293
9294@item -mstack-align
9295@itemx -mno-stack-align
9296@itemx -mdata-align
9297@itemx -mno-data-align
9298@itemx -mconst-align
9299@itemx -mno-const-align
9300@opindex mstack-align
9301@opindex mno-stack-align
9302@opindex mdata-align
9303@opindex mno-data-align
9304@opindex mconst-align
9305@opindex mno-const-align
9306These options (no-options) arranges (eliminate arrangements) for the
9307stack-frame, individual data and constants to be aligned for the maximum
9308single data access size for the chosen CPU model. The default is to
9309arrange for 32-bit alignment. ABI details such as structure layout are
9310not affected by these options.
9311
9312@item -m32-bit
9313@itemx -m16-bit
9314@itemx -m8-bit
9315@opindex m32-bit
9316@opindex m16-bit
9317@opindex m8-bit
9318Similar to the stack- data- and const-align options above, these options
9319arrange for stack-frame, writable data and constants to all be 32-bit,
932016-bit or 8-bit aligned. The default is 32-bit alignment.
9321
9322@item -mno-prologue-epilogue
9323@itemx -mprologue-epilogue
9324@opindex mno-prologue-epilogue
9325@opindex mprologue-epilogue
9326With @option{-mno-prologue-epilogue}, the normal function prologue and
9327epilogue that sets up the stack-frame are omitted and no return
9328instructions or return sequences are generated in the code. Use this
9329option only together with visual inspection of the compiled code: no
9330warnings or errors are generated when call-saved registers must be saved,
9331or storage for local variable needs to be allocated.
9332
9333@item -mno-gotplt
9334@itemx -mgotplt
9335@opindex mno-gotplt
9336@opindex mgotplt
9337With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9338instruction sequences that load addresses for functions from the PLT part
9339of the GOT rather than (traditional on other architectures) calls to the
9340PLT. The default is @option{-mgotplt}.
9341
9342@item -maout
9343@opindex maout
9344Legacy no-op option only recognized with the cris-axis-aout target.
9345
9346@item -melf
9347@opindex melf
9348Legacy no-op option only recognized with the cris-axis-elf and
9349cris-axis-linux-gnu targets.
9350
9351@item -melinux
9352@opindex melinux
9353Only recognized with the cris-axis-aout target, where it selects a
9354GNU/linux-like multilib, include files and instruction set for
9355@option{-march=v8}.
9356
9357@item -mlinux
9358@opindex mlinux
9359Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9360
9361@item -sim
9362@opindex sim
9363This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9364to link with input-output functions from a simulator library. Code,
9365initialized data and zero-initialized data are allocated consecutively.
9366
9367@item -sim2
9368@opindex sim2
9369Like @option{-sim}, but pass linker options to locate initialized data at
93700x40000000 and zero-initialized data at 0x80000000.
9371@end table
9372
9373@node MMIX Options
9374@subsection MMIX Options
9375@cindex MMIX Options
9376
9377These options are defined for the MMIX:
9378
9379@table @gcctabopt
9380@item -mlibfuncs
9381@itemx -mno-libfuncs
9382@opindex mlibfuncs
9383@opindex mno-libfuncs
9384Specify that intrinsic library functions are being compiled, passing all
9385values in registers, no matter the size.
9386
9387@item -mepsilon
9388@itemx -mno-epsilon
9389@opindex mepsilon
9390@opindex mno-epsilon
9391Generate floating-point comparison instructions that compare with respect
9392to the @code{rE} epsilon register.
9393
9394@item -mabi=mmixware
9395@itemx -mabi=gnu
9396@opindex mabi-mmixware
9397@opindex mabi=gnu
9398Generate code that passes function parameters and return values that (in
9399the called function) are seen as registers @code{$0} and up, as opposed to
9400the GNU ABI which uses global registers @code{$231} and up.
9401
9402@item -mzero-extend
9403@itemx -mno-zero-extend
9404@opindex mzero-extend
9405@opindex mno-zero-extend
9406When reading data from memory in sizes shorter than 64 bits, use (do not
9407use) zero-extending load instructions by default, rather than
9408sign-extending ones.
9409
9410@item -mknuthdiv
9411@itemx -mno-knuthdiv
9412@opindex mknuthdiv
9413@opindex mno-knuthdiv
9414Make the result of a division yielding a remainder have the same sign as
9415the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
9416remainder follows the sign of the dividend. Both methods are
9417arithmetically valid, the latter being almost exclusively used.
9418
9419@item -mtoplevel-symbols
9420@itemx -mno-toplevel-symbols
9421@opindex mtoplevel-symbols
9422@opindex mno-toplevel-symbols
9423Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9424code can be used with the @code{PREFIX} assembly directive.
9425
9426@item -melf
9427@opindex melf
9428Generate an executable in the ELF format, rather than the default
9429@samp{mmo} format used by the @command{mmix} simulator.
9430
9431@item -mbranch-predict
9432@itemx -mno-branch-predict
9433@opindex mbranch-predict
9434@opindex mno-branch-predict
9435Use (do not use) the probable-branch instructions, when static branch
9436prediction indicates a probable branch.
9437
9438@item -mbase-addresses
9439@itemx -mno-base-addresses
9440@opindex mbase-addresses
9441@opindex mno-base-addresses
9442Generate (do not generate) code that uses @emph{base addresses}. Using a
9443base address automatically generates a request (handled by the assembler
9444and the linker) for a constant to be set up in a global register. The
9445register is used for one or more base address requests within the range 0
9446to 255 from the value held in the register. The generally leads to short
9447and fast code, but the number of different data items that can be
9448addressed is limited. This means that a program that uses lots of static
9449data may require @option{-mno-base-addresses}.
9450
9451@item -msingle-exit
9452@itemx -mno-single-exit
9453@opindex msingle-exit
9454@opindex mno-single-exit
9455Force (do not force) generated code to have a single exit point in each
9456function.
9457@end table
9458
9459@node PDP-11 Options
9460@subsection PDP-11 Options
9461@cindex PDP-11 Options
9462
9463These options are defined for the PDP-11:
9464
9465@table @gcctabopt
9466@item -mfpu
9467@opindex mfpu
9468Use hardware FPP floating point. This is the default. (FIS floating
9469point on the PDP-11/40 is not supported.)
9470
9471@item -msoft-float
9472@opindex msoft-float
9473Do not use hardware floating point.
9474
9475@item -mac0
9476@opindex mac0
9477Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9478
9479@item -mno-ac0
9480@opindex mno-ac0
9481Return floating-point results in memory. This is the default.
9482
9483@item -m40
9484@opindex m40
9485Generate code for a PDP-11/40.
9486
9487@item -m45
9488@opindex m45
9489Generate code for a PDP-11/45. This is the default.
9490
9491@item -m10
9492@opindex m10
9493Generate code for a PDP-11/10.
9494
9495@item -mbcopy-builtin
9496@opindex bcopy-builtin
9497Use inline @code{movstrhi} patterns for copying memory. This is the
9498default.
9499
9500@item -mbcopy
9501@opindex mbcopy
9502Do not use inline @code{movstrhi} patterns for copying memory.
9503
9504@item -mint16
9505@itemx -mno-int32
9506@opindex mint16
9507@opindex mno-int32
9508Use 16-bit @code{int}. This is the default.
9509
9510@item -mint32
9511@itemx -mno-int16
9512@opindex mint32
9513@opindex mno-int16
9514Use 32-bit @code{int}.
9515
9516@item -mfloat64
9517@itemx -mno-float32
9518@opindex mfloat64
9519@opindex mno-float32
9520Use 64-bit @code{float}. This is the default.
9521
9522@item -mfloat32
9523@item -mno-float64
9524@opindex mfloat32
9525@opindex mno-float64
9526Use 32-bit @code{float}.
9527
9528@item -mabshi
9529@opindex mabshi
9530Use @code{abshi2} pattern. This is the default.
9531
9532@item -mno-abshi
9533@opindex mno-abshi
9534Do not use @code{abshi2} pattern.
9535
9536@item -mbranch-expensive
9537@opindex mbranch-expensive
9538Pretend that branches are expensive. This is for experimenting with
9539code generation only.
9540
9541@item -mbranch-cheap
9542@opindex mbranch-cheap
9543Do not pretend that branches are expensive. This is the default.
9544
9545@item -msplit
9546@opindex msplit
9547Generate code for a system with split I&D.
9548
9549@item -mno-split
9550@opindex mno-split
9551Generate code for a system without split I&D. This is the default.
9552
9553@item -munix-asm
9554@opindex munix-asm
9555Use Unix assembler syntax. This is the default when configured for
9556@samp{pdp11-*-bsd}.
9557
9558@item -mdec-asm
9559@opindex mdec-asm
9560Use DEC assembler syntax. This is the default when configured for any
9561PDP-11 target other than @samp{pdp11-*-bsd}.
9562@end table
9563
9564@node Xstormy16 Options
9565@subsection Xstormy16 Options
9566@cindex Xstormy16 Options
9567
9568These options are defined for Xstormy16:
9569
9570@table @gcctabopt
9571@item -msim
9572@opindex msim
9573Choose startup files and linker script suitable for the simulator.
9574@end table
9575
9576@node Xtensa Options
9577@subsection Xtensa Options
9578@cindex Xtensa Options
9579
9580The Xtensa architecture is designed to support many different
9581configurations. The compiler's default options can be set to match a
9582particular Xtensa configuration by copying a configuration file into the
9583GCC sources when building GCC@. The options below may be used to
9584override the default options.
9585
9586@table @gcctabopt
9587@item -mbig-endian
9588@itemx -mlittle-endian
9589@opindex mbig-endian
9590@opindex mlittle-endian
9591Specify big-endian or little-endian byte ordering for the target Xtensa
9592processor.
9593
9594@item -mdensity
9595@itemx -mno-density
9596@opindex mdensity
9597@opindex mno-density
9598Enable or disable use of the optional Xtensa code density instructions.
9599
9600@item -mmac16
9601@itemx -mno-mac16
9602@opindex mmac16
9603@opindex mno-mac16
9604Enable or disable use of the Xtensa MAC16 option. When enabled, GCC
9605will generate MAC16 instructions from standard C code, with the
9606limitation that it will use neither the MR register file nor any
9607instruction that operates on the MR registers. When this option is
9608disabled, GCC will translate 16-bit multiply/accumulate operations to a
9609combination of core instructions and library calls, depending on whether
9610any other multiplier options are enabled.
9611
9612@item -mmul16
9613@itemx -mno-mul16
9614@opindex mmul16
9615@opindex mno-mul16
9616Enable or disable use of the 16-bit integer multiplier option. When
9617enabled, the compiler will generate 16-bit multiply instructions for
9618multiplications of 16 bits or smaller in standard C code. When this
9619option is disabled, the compiler will either use 32-bit multiply or
9620MAC16 instructions if they are available or generate library calls to
9621perform the multiply operations using shifts and adds.
9622
9623@item -mmul32
9624@itemx -mno-mul32
9625@opindex mmul32
9626@opindex mno-mul32
9627Enable or disable use of the 32-bit integer multiplier option. When
9628enabled, the compiler will generate 32-bit multiply instructions for
9629multiplications of 32 bits or smaller in standard C code. When this
9630option is disabled, the compiler will generate library calls to perform
9631the multiply operations using either shifts and adds or 16-bit multiply
9632instructions if they are available.
9633
9634@item -mnsa
9635@itemx -mno-nsa
9636@opindex mnsa
9637@opindex mno-nsa
9638Enable or disable use of the optional normalization shift amount
9639(@code{NSA}) instructions to implement the built-in @code{ffs} function.
9640
9641@item -mminmax
9642@itemx -mno-minmax
9643@opindex mminmax
9644@opindex mno-minmax
9645Enable or disable use of the optional minimum and maximum value
9646instructions.
9647
9648@item -msext
9649@itemx -mno-sext
9650@opindex msext
9651@opindex mno-sext
9652Enable or disable use of the optional sign extend (@code{SEXT})
9653instruction.
9654
9655@item -mbooleans
9656@itemx -mno-booleans
9657@opindex mbooleans
9658@opindex mno-booleans
9659Enable or disable support for the boolean register file used by Xtensa
9660coprocessors. This is not typically useful by itself but may be
9661required for other options that make use of the boolean registers (e.g.,
9662the floating-point option).
9663
9664@item -mhard-float
9665@itemx -msoft-float
9666@opindex mhard-float
9667@opindex msoft-float
9668Enable or disable use of the floating-point option. When enabled, GCC
9669generates floating-point instructions for 32-bit @code{float}
9670operations. When this option is disabled, GCC generates library calls
9671to emulate 32-bit floating-point operations using integer instructions.
9672Regardless of this option, 64-bit @code{double} operations are always
9673emulated with calls to library functions.
9674
9675@item -mfused-madd
9676@itemx -mno-fused-madd
9677@opindex mfused-madd
9678@opindex mno-fused-madd
9679Enable or disable use of fused multiply/add and multiply/subtract
9680instructions in the floating-point option. This has no effect if the
9681floating-point option is not also enabled. Disabling fused multiply/add
9682and multiply/subtract instructions forces the compiler to use separate
9683instructions for the multiply and add/subtract operations. This may be
9684desirable in some cases where strict IEEE 754-compliant results are
9685required: the fused multiply add/subtract instructions do not round the
9686intermediate result, thereby producing results with @emph{more} bits of
9687precision than specified by the IEEE standard. Disabling fused multiply
9688add/subtract instructions also ensures that the program output is not
9689sensitive to the compiler's ability to combine multiply and add/subtract
9690operations.
9691
9692@item -mserialize-volatile
9693@itemx -mno-serialize-volatile
9694@opindex mserialize-volatile
9695@opindex mno-serialize-volatile
9696When this option is enabled, GCC inserts @code{MEMW} instructions before
9697@code{volatile} memory references to guarantee sequential consistency.
9698The default is @option{-mserialize-volatile}. Use
9699@option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
9700
9701@item -mtext-section-literals
9702@itemx -mno-text-section-literals
9703@opindex mtext-section-literals
9704@opindex mno-text-section-literals
9705Control the treatment of literal pools. The default is
9706@option{-mno-text-section-literals}, which places literals in a separate
9707section in the output file. This allows the literal pool to be placed
9708in a data RAM/ROM, and it also allows the linker to combine literal
9709pools from separate object files to remove redundant literals and
9710improve code size. With @option{-mtext-section-literals}, the literals
9711are interspersed in the text section in order to keep them as close as
9712possible to their references. This may be necessary for large assembly
9713files.
9714
9715@item -mtarget-align
9716@itemx -mno-target-align
9717@opindex mtarget-align
9718@opindex mno-target-align
9719When this option is enabled, GCC instructs the assembler to
9720automatically align instructions to reduce branch penalties at the
9721expense of some code density. The assembler attempts to widen density
9722instructions to align branch targets and the instructions following call
9723instructions. If there are not enough preceding safe density
9724instructions to align a target, no widening will be performed. The
9725default is @option{-mtarget-align}. These options do not affect the
9726treatment of auto-aligned instructions like @code{LOOP}, which the
9727assembler will always align, either by widening density instructions or
9728by inserting no-op instructions.
9729
9730@item -mlongcalls
9731@itemx -mno-longcalls
9732@opindex mlongcalls
9733@opindex mno-longcalls
9734When this option is enabled, GCC instructs the assembler to translate
9735direct calls to indirect calls unless it can determine that the target
9736of a direct call is in the range allowed by the call instruction. This
9737translation typically occurs for calls to functions in other source
9738files. Specifically, the assembler translates a direct @code{CALL}
9739instruction into an @code{L32R} followed by a @code{CALLX} instruction.
9740The default is @option{-mno-longcalls}. This option should be used in
9741programs where the call target can potentially be out of range. This
9742option is implemented in the assembler, not the compiler, so the
9743assembly code generated by GCC will still show direct call
9744instructions---look at the disassembled object code to see the actual
9745instructions. Note that the assembler will use an indirect call for
9746every cross-file call, not just those that really will be out of range.
9747@end table
9748
9749@node Code Gen Options
9750@section Options for Code Generation Conventions
9751@cindex code generation conventions
9752@cindex options, code generation
9753@cindex run-time options
9754
9755These machine-independent options control the interface conventions
9756used in code generation.
9757
9758Most of them have both positive and negative forms; the negative form
9759of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
9760one of the forms is listed---the one which is not the default. You
9761can figure out the other form by either removing @samp{no-} or adding
9762it.
9763
9764@table @gcctabopt
9765@item -fexceptions
9766@opindex fexceptions
9767Enable exception handling. Generates extra code needed to propagate
9768exceptions. For some targets, this implies GCC will generate frame
9769unwind information for all functions, which can produce significant data
9770size overhead, although it does not affect execution. If you do not
9771specify this option, GCC will enable it by default for languages like
9772C++ which normally require exception handling, and disable it for
9773languages like C that do not normally require it. However, you may need
9774to enable this option when compiling C code that needs to interoperate
9775properly with exception handlers written in C++. You may also wish to
9776disable this option if you are compiling older C++ programs that don't
9777use exception handling.
9778
9779@item -fnon-call-exceptions
9780@opindex fnon-call-exceptions
9781Generate code that allows trapping instructions to throw exceptions.
9782Note that this requires platform-specific runtime support that does
9783not exist everywhere. Moreover, it only allows @emph{trapping}
9784instructions to throw exceptions, i.e.@: memory references or floating
9785point instructions. It does not allow exceptions to be thrown from
9786arbitrary signal handlers such as @code{SIGALRM}.
9787
9788@item -funwind-tables
9789@opindex funwind-tables
9790Similar to @option{-fexceptions}, except that it will just generate any needed
9791static data, but will not affect the generated code in any other way.
9792You will normally not enable this option; instead, a language processor
9793that needs this handling would enable it on your behalf.
9794
9795@item -fasynchronous-unwind-tables
9796@opindex funwind-tables
9797Generate unwind table in dwarf2 format, if supported by target machine. The
9798table is exact at each instruction boundary, so it can be used for stack
9799unwinding from asynchronous events (such as debugger or garbage collector).
9800
9801@item -fpcc-struct-return
9802@opindex fpcc-struct-return
9803Return ``short'' @code{struct} and @code{union} values in memory like
9804longer ones, rather than in registers. This convention is less
9805efficient, but it has the advantage of allowing intercallability between
9806GCC-compiled files and files compiled with other compilers.
9807
9808The precise convention for returning structures in memory depends
9809on the target configuration macros.
9810
9811Short structures and unions are those whose size and alignment match
9812that of some integer type.
9813
9814@item -freg-struct-return
9815@opindex freg-struct-return
9816Return @code{struct} and @code{union} values in registers when possible.
9817This is more efficient for small structures than
9818@option{-fpcc-struct-return}.
9819
9820If you specify neither @option{-fpcc-struct-return} nor
9821@option{-freg-struct-return}, GCC defaults to whichever convention is
9822standard for the target. If there is no standard convention, GCC
9823defaults to @option{-fpcc-struct-return}, except on targets where GCC is
9824the principal compiler. In those cases, we can choose the standard, and
9825we chose the more efficient register return alternative.
9826
9827@item -fshort-enums
9828@opindex fshort-enums
9829Allocate to an @code{enum} type only as many bytes as it needs for the
9830declared range of possible values. Specifically, the @code{enum} type
9831will be equivalent to the smallest integer type which has enough room.
9832
9833@item -fshort-double
9834@opindex fshort-double
9835Use the same size for @code{double} as for @code{float}.
9836
9837@item -fshared-data
9838@opindex fshared-data
9839Requests that the data and non-@code{const} variables of this
9840compilation be shared data rather than private data. The distinction
9841makes sense only on certain operating systems, where shared data is
9842shared between processes running the same program, while private data
9843exists in one copy per process.
9844
9845@item -fno-common
9846@opindex fno-common
9847In C, allocate even uninitialized global variables in the data section of the
9848object file, rather than generating them as common blocks. This has the
9849effect that if the same variable is declared (without @code{extern}) in
9850two different compilations, you will get an error when you link them.
9851The only reason this might be useful is if you wish to verify that the
9852program will work on other systems which always work this way.
9853
9854@item -fno-ident
9855@opindex fno-ident
9856Ignore the @samp{#ident} directive.
9857
9858@item -fno-gnu-linker
9859@opindex fno-gnu-linker
9860Do not output global initializations (such as C++ constructors and
9861destructors) in the form used by the GNU linker (on systems where the GNU
9862linker is the standard method of handling them). Use this option when
9863you want to use a non-GNU linker, which also requires using the
9864@command{collect2} program to make sure the system linker includes
9865constructors and destructors. (@command{collect2} is included in the GCC
9866distribution.) For systems which @emph{must} use @command{collect2}, the
9867compiler driver @command{gcc} is configured to do this automatically.
9868
9869@item -finhibit-size-directive
9870@opindex finhibit-size-directive
9871Don't output a @code{.size} assembler directive, or anything else that
9872would cause trouble if the function is split in the middle, and the
9873two halves are placed at locations far apart in memory. This option is
9874used when compiling @file{crtstuff.c}; you should not need to use it
9875for anything else.
9876
9877@item -fverbose-asm
9878@opindex fverbose-asm
9879Put extra commentary information in the generated assembly code to
9880make it more readable. This option is generally only of use to those
9881who actually need to read the generated assembly code (perhaps while
9882debugging the compiler itself).
9883
9884@option{-fno-verbose-asm}, the default, causes the
9885extra information to be omitted and is useful when comparing two assembler
9886files.
9887
9888@item -fvolatile
9889@opindex fvolatile
9890Consider all memory references through pointers to be volatile.
9891
9892@item -fvolatile-global
9893@opindex fvolatile-global
9894Consider all memory references to extern and global data items to
9895be volatile. GCC does not consider static data items to be volatile
9896because of this switch.
9897
9898@item -fvolatile-static
9899@opindex fvolatile-static
9900Consider all memory references to static data to be volatile.
9901
9902@item -fpic
9903@opindex fpic
9904@cindex global offset table
9905@cindex PIC
9906Generate position-independent code (PIC) suitable for use in a shared
9907library, if supported for the target machine. Such code accesses all
9908constant addresses through a global offset table (GOT)@. The dynamic
9909loader resolves the GOT entries when the program starts (the dynamic
9910loader is not part of GCC; it is part of the operating system). If
9911the GOT size for the linked executable exceeds a machine-specific
9912maximum size, you get an error message from the linker indicating that
9913@option{-fpic} does not work; in that case, recompile with @option{-fPIC}
9914instead. (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
9915on the m68k and RS/6000. The 386 has no such limit.)
9916
9917Position-independent code requires special support, and therefore works
9918only on certain machines. For the 386, GCC supports PIC for System V
9919but not for the Sun 386i. Code generated for the IBM RS/6000 is always
9920position-independent.
9921
9922@item -fPIC
9923@opindex fPIC
9924If supported for the target machine, emit position-independent code,
9925suitable for dynamic linking and avoiding any limit on the size of the
9926global offset table. This option makes a difference on the m68k, m88k,
9927and the Sparc.
9928
9929Position-independent code requires special support, and therefore works
9930only on certain machines.
9931
9932@item -ffixed-@var{reg}
9933@opindex ffixed
9934Treat the register named @var{reg} as a fixed register; generated code
9935should never refer to it (except perhaps as a stack pointer, frame
9936pointer or in some other fixed role).
9937
9938@var{reg} must be the name of a register. The register names accepted
9939are machine-specific and are defined in the @code{REGISTER_NAMES}
9940macro in the machine description macro file.
9941
9942This flag does not have a negative form, because it specifies a
9943three-way choice.
9944
9945@item -fcall-used-@var{reg}
9946@opindex fcall-used
9947Treat the register named @var{reg} as an allocable register that is
9948clobbered by function calls. It may be allocated for temporaries or
9949variables that do not live across a call. Functions compiled this way
9950will not save and restore the register @var{reg}.
9951
9952It is an error to used this flag with the frame pointer or stack pointer.
9953Use of this flag for other registers that have fixed pervasive roles in
9954the machine's execution model will produce disastrous results.
9955
9956This flag does not have a negative form, because it specifies a
9957three-way choice.
9958
9959@item -fcall-saved-@var{reg}
9960@opindex fcall-saved
9961Treat the register named @var{reg} as an allocable register saved by
9962functions. It may be allocated even for temporaries or variables that
9963live across a call. Functions compiled this way will save and restore
9964the register @var{reg} if they use it.
9965
9966It is an error to used this flag with the frame pointer or stack pointer.
9967Use of this flag for other registers that have fixed pervasive roles in
9968the machine's execution model will produce disastrous results.
9969
9970A different sort of disaster will result from the use of this flag for
9971a register in which function values may be returned.
9972
9973This flag does not have a negative form, because it specifies a
9974three-way choice.
9975
9976@item -fpack-struct
9977@opindex fpack-struct
9978Pack all structure members together without holes. Usually you would
9979not want to use this option, since it makes the code suboptimal, and
9980the offsets of structure members won't agree with system libraries.
9981
9982@item -finstrument-functions
9983@opindex finstrument-functions
9984Generate instrumentation calls for entry and exit to functions. Just
9985after function entry and just before function exit, the following
9986profiling functions will be called with the address of the current
9987function and its call site. (On some platforms,
9988@code{__builtin_return_address} does not work beyond the current
9989function, so the call site information may not be available to the
9990profiling functions otherwise.)
9991
9992@example
9993void __cyg_profile_func_enter (void *this_fn,
9994 void *call_site);
9995void __cyg_profile_func_exit (void *this_fn,
9996 void *call_site);
9997@end example
9998
9999The first argument is the address of the start of the current function,
10000which may be looked up exactly in the symbol table.
10001
10002This instrumentation is also done for functions expanded inline in other
10003functions. The profiling calls will indicate where, conceptually, the
10004inline function is entered and exited. This means that addressable
10005versions of such functions must be available. If all your uses of a
10006function are expanded inline, this may mean an additional expansion of
10007code size. If you use @samp{extern inline} in your C code, an
10008addressable version of such functions must be provided. (This is
10009normally the case anyways, but if you get lucky and the optimizer always
10010expands the functions inline, you might have gotten away without
10011providing static copies.)
10012
10013A function may be given the attribute @code{no_instrument_function}, in
10014which case this instrumentation will not be done. This can be used, for
10015example, for the profiling functions listed above, high-priority
10016interrupt routines, and any functions from which the profiling functions
10017cannot safely be called (perhaps signal handlers, if the profiling
10018routines generate output or allocate memory).
10019
10020@item -fstack-check
10021@opindex fstack-check
10022Generate code to verify that you do not go beyond the boundary of the
10023stack. You should specify this flag if you are running in an
10024environment with multiple threads, but only rarely need to specify it in
10025a single-threaded environment since stack overflow is automatically
10026detected on nearly all systems if there is only one stack.
10027
10028Note that this switch does not actually cause checking to be done; the
10029operating system must do that. The switch causes generation of code
10030to ensure that the operating system sees the stack being extended.
10031
10032@item -fstack-limit-register=@var{reg}
10033@itemx -fstack-limit-symbol=@var{sym}
10034@itemx -fno-stack-limit
10035@opindex fstack-limit-register
10036@opindex fstack-limit-symbol
10037@opindex fno-stack-limit
10038Generate code to ensure that the stack does not grow beyond a certain value,
10039either the value of a register or the address of a symbol. If the stack
10040would grow beyond the value, a signal is raised. For most targets,
10041the signal is raised before the stack overruns the boundary, so
10042it is possible to catch the signal without taking special precautions.
10043
10044For instance, if the stack starts at absolute address @samp{0x80000000}
10045and grows downwards, you can use the flags
10046@option{-fstack-limit-symbol=__stack_limit} and
10047@option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10048of 128KB@. Note that this may only work with the GNU linker.
10049
10050@cindex aliasing of parameters
10051@cindex parameters, aliased
10052@item -fargument-alias
10053@itemx -fargument-noalias
10054@itemx -fargument-noalias-global
10055@opindex fargument-alias
10056@opindex fargument-noalias
10057@opindex fargument-noalias-global
10058Specify the possible relationships among parameters and between
10059parameters and global data.
10060
10061@option{-fargument-alias} specifies that arguments (parameters) may
10062alias each other and may alias global storage.@*
10063@option{-fargument-noalias} specifies that arguments do not alias
10064each other, but may alias global storage.@*
10065@option{-fargument-noalias-global} specifies that arguments do not
10066alias each other and do not alias global storage.
10067
10068Each language will automatically use whatever option is required by
10069the language standard. You should not need to use these options yourself.
10070
10071@item -fleading-underscore
10072@opindex fleading-underscore
10073This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10074change the way C symbols are represented in the object file. One use
10075is to help link with legacy assembly code.
10076
10077Be warned that you should know what you are doing when invoking this
10078option, and that not all targets provide complete support for it.
10079
10080@item -ftls-model=@var{model}
10081Alter the thread-local storage model to be used (@pxref{Thread-Local}).
10082The @var{model} argument should be one of @code{global-dynamic},
10083@code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
10084
10085The default without @option{-fpic} is @code{initial-exec}; with
10086@option{-fpic} the default is @code{global-dynamic}.
10087@end table
10088
10089@c man end
10090
10091@node Environment Variables
10092@section Environment Variables Affecting GCC
10093@cindex environment variables
10094
10095@c man begin ENVIRONMENT
10096
10097This section describes several environment variables that affect how GCC
10098operates. Some of them work by specifying directories or prefixes to use
10099when searching for various kinds of files. Some are used to specify other
10100aspects of the compilation environment.
10101
10102Note that you can also specify places to search using options such as
10103@option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
10104take precedence over places specified using environment variables, which
10105in turn take precedence over those specified by the configuration of GCC@.
10106@xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
10107GNU Compiler Collection (GCC) Internals}.
10108
10109@table @env
10110@item LANG
10111@itemx LC_CTYPE
10112@c @itemx LC_COLLATE
10113@itemx LC_MESSAGES
10114@c @itemx LC_MONETARY
10115@c @itemx LC_NUMERIC
10116@c @itemx LC_TIME
10117@itemx LC_ALL
10118@findex LANG
10119@findex LC_CTYPE
10120@c @findex LC_COLLATE
10121@findex LC_MESSAGES
10122@c @findex LC_MONETARY
10123@c @findex LC_NUMERIC
10124@c @findex LC_TIME
10125@findex LC_ALL
10126@cindex locale
10127These environment variables control the way that GCC uses
10128localization information that allow GCC to work with different
10129national conventions. GCC inspects the locale categories
10130@env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
10131so. These locale categories can be set to any value supported by your
10132installation. A typical value is @samp{en_UK} for English in the United
10133Kingdom.
10134
10135The @env{LC_CTYPE} environment variable specifies character
10136classification. GCC uses it to determine the character boundaries in
10137a string; this is needed for some multibyte encodings that contain quote
10138and escape characters that would otherwise be interpreted as a string
10139end or escape.
10140
10141The @env{LC_MESSAGES} environment variable specifies the language to
10142use in diagnostic messages.
10143
10144If the @env{LC_ALL} environment variable is set, it overrides the value
10145of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
10146and @env{LC_MESSAGES} default to the value of the @env{LANG}
10147environment variable. If none of these variables are set, GCC
10148defaults to traditional C English behavior.
10149
10150@item TMPDIR
10151@findex TMPDIR
10152If @env{TMPDIR} is set, it specifies the directory to use for temporary
10153files. GCC uses temporary files to hold the output of one stage of
10154compilation which is to be used as input to the next stage: for example,
10155the output of the preprocessor, which is the input to the compiler
10156proper.
10157
10158@item GCC_EXEC_PREFIX
10159@findex GCC_EXEC_PREFIX
10160If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
10161names of the subprograms executed by the compiler. No slash is added
10162when this prefix is combined with the name of a subprogram, but you can
10163specify a prefix that ends with a slash if you wish.
10164
10165If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
10166an appropriate prefix to use based on the pathname it was invoked with.
10167
10168If GCC cannot find the subprogram using the specified prefix, it
10169tries looking in the usual places for the subprogram.
10170
10171The default value of @env{GCC_EXEC_PREFIX} is
10172@file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
10173of @code{prefix} when you ran the @file{configure} script.
10174
10175Other prefixes specified with @option{-B} take precedence over this prefix.
10176
10177This prefix is also used for finding files such as @file{crt0.o} that are
10178used for linking.
10179
10180In addition, the prefix is used in an unusual way in finding the
10181directories to search for header files. For each of the standard
10182directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
10183(more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
10184replacing that beginning with the specified prefix to produce an
10185alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
10186@file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
10187These alternate directories are searched first; the standard directories
10188come next.
10189
10190@item COMPILER_PATH
10191@findex COMPILER_PATH
10192The value of @env{COMPILER_PATH} is a colon-separated list of
10193directories, much like @env{PATH}. GCC tries the directories thus
10194specified when searching for subprograms, if it can't find the
10195subprograms using @env{GCC_EXEC_PREFIX}.
10196
10197@item LIBRARY_PATH
10198@findex LIBRARY_PATH
10199The value of @env{LIBRARY_PATH} is a colon-separated list of
10200directories, much like @env{PATH}. When configured as a native compiler,
10201GCC tries the directories thus specified when searching for special
10202linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
10203using GCC also uses these directories when searching for ordinary
10204libraries for the @option{-l} option (but directories specified with
10205@option{-L} come first).
10206
10207@item LANG
10208@findex LANG
10209@cindex locale definition
10210This variable is used to pass locale information to the compiler. One way in
10211which this information is used is to determine the character set to be used
10212when character literals, string literals and comments are parsed in C and C++.
10213When the compiler is configured to allow multibyte characters,
10214the following values for @env{LANG} are recognized:
10215
10216@table @samp
10217@item C-JIS
10218Recognize JIS characters.
10219@item C-SJIS
10220Recognize SJIS characters.
10221@item C-EUCJP
10222Recognize EUCJP characters.
10223@end table
10224
10225If @env{LANG} is not defined, or if it has some other value, then the
10226compiler will use mblen and mbtowc as defined by the default locale to
10227recognize and translate multibyte characters.
10228@end table
10229
10230@noindent
10231Some additional environments variables affect the behavior of the
10232preprocessor.
10233
10234@include cppenv.texi
10235
10236@c man end
10237
10238@node Running Protoize
10239@section Running Protoize
10240
10241The program @code{protoize} is an optional part of GCC@. You can use
10242it to add prototypes to a program, thus converting the program to ISO
10243C in one respect. The companion program @code{unprotoize} does the
10244reverse: it removes argument types from any prototypes that are found.
10245
10246When you run these programs, you must specify a set of source files as
10247command line arguments. The conversion programs start out by compiling
10248these files to see what functions they define. The information gathered
10249about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
10250
10251After scanning comes actual conversion. The specified files are all
10252eligible to be converted; any files they include (whether sources or
10253just headers) are eligible as well.
10254
10255But not all the eligible files are converted. By default,
10256@code{protoize} and @code{unprotoize} convert only source and header
10257files in the current directory. You can specify additional directories
10258whose files should be converted with the @option{-d @var{directory}}
10259option. You can also specify particular files to exclude with the
10260@option{-x @var{file}} option. A file is converted if it is eligible, its
10261directory name matches one of the specified directory names, and its
10262name within the directory has not been excluded.
10263
10264Basic conversion with @code{protoize} consists of rewriting most
10265function definitions and function declarations to specify the types of
10266the arguments. The only ones not rewritten are those for varargs
10267functions.
10268
10269@code{protoize} optionally inserts prototype declarations at the
10270beginning of the source file, to make them available for any calls that
10271precede the function's definition. Or it can insert prototype
10272declarations with block scope in the blocks where undeclared functions
10273are called.
10274
10275Basic conversion with @code{unprotoize} consists of rewriting most
10276function declarations to remove any argument types, and rewriting
10277function definitions to the old-style pre-ISO form.
10278
10279Both conversion programs print a warning for any function declaration or
10280definition that they can't convert. You can suppress these warnings
10281with @option{-q}.
10282
10283The output from @code{protoize} or @code{unprotoize} replaces the
10284original source file. The original file is renamed to a name ending
10285with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
10286without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
10287for DOS) file already exists, then the source file is simply discarded.
10288
10289@code{protoize} and @code{unprotoize} both depend on GCC itself to
10290scan the program and collect information about the functions it uses.
10291So neither of these programs will work until GCC is installed.
10292
10293Here is a table of the options you can use with @code{protoize} and
10294@code{unprotoize}. Each option works with both programs unless
10295otherwise stated.
10296
10297@table @code
10298@item -B @var{directory}
10299Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
10300usual directory (normally @file{/usr/local/lib}). This file contains
10301prototype information about standard system functions. This option
10302applies only to @code{protoize}.
10303
10304@item -c @var{compilation-options}
10305Use @var{compilation-options} as the options when running @code{gcc} to
10306produce the @samp{.X} files. The special option @option{-aux-info} is
10307always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
10308
10309Note that the compilation options must be given as a single argument to
10310@code{protoize} or @code{unprotoize}. If you want to specify several
10311@code{gcc} options, you must quote the entire set of compilation options
10312to make them a single word in the shell.
10313
10314There are certain @code{gcc} arguments that you cannot use, because they
10315would produce the wrong kind of output. These include @option{-g},
10316@option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
10317the @var{compilation-options}, they are ignored.
10318
10319@item -C
10320Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
10321systems) instead of @samp{.c}. This is convenient if you are converting
10322a C program to C++. This option applies only to @code{protoize}.
10323
10324@item -g
10325Add explicit global declarations. This means inserting explicit
10326declarations at the beginning of each source file for each function
10327that is called in the file and was not declared. These declarations
10328precede the first function definition that contains a call to an
10329undeclared function. This option applies only to @code{protoize}.
10330
10331@item -i @var{string}
10332Indent old-style parameter declarations with the string @var{string}.
10333This option applies only to @code{protoize}.
10334
10335@code{unprotoize} converts prototyped function definitions to old-style
10336function definitions, where the arguments are declared between the
10337argument list and the initial @samp{@{}. By default, @code{unprotoize}
10338uses five spaces as the indentation. If you want to indent with just
10339one space instead, use @option{-i " "}.
10340
10341@item -k
10342Keep the @samp{.X} files. Normally, they are deleted after conversion
10343is finished.
10344
10345@item -l
10346Add explicit local declarations. @code{protoize} with @option{-l} inserts
10347a prototype declaration for each function in each block which calls the
10348function without any declaration. This option applies only to
10349@code{protoize}.
10350
10351@item -n
10352Make no real changes. This mode just prints information about the conversions
10353that would have been done without @option{-n}.
10354
10355@item -N
10356Make no @samp{.save} files. The original files are simply deleted.
10357Use this option with caution.
10358
10359@item -p @var{program}
10360Use the program @var{program} as the compiler. Normally, the name
10361@file{gcc} is used.
10362
10363@item -q
10364Work quietly. Most warnings are suppressed.
10365
10366@item -v
10367Print the version number, just like @option{-v} for @code{gcc}.
10368@end table
10369
10370If you need special compiler options to compile one of your program's
10371source files, then you should generate that file's @samp{.X} file
10372specially, by running @code{gcc} on that source file with the
10373appropriate options and the option @option{-aux-info}. Then run
10374@code{protoize} on the entire set of files. @code{protoize} will use
10375the existing @samp{.X} file because it is newer than the source file.
10376For example:
10377
10378@example
10379gcc -Dfoo=bar file1.c -aux-info file1.X
10380protoize *.c
10381@end example
10382
10383@noindent
10384You need to include the special files along with the rest in the
10385@code{protoize} command, even though their @samp{.X} files already
10386exist, because otherwise they won't get converted.
10387
10388@xref{Protoize Caveats}, for more information on how to use
10389@code{protoize} successfully.
This page took 0.10594 seconds and 5 git commands to generate.