xref: /openbsd/gnu/gcc/gcc/doc/invoke.texi (revision cecf84d4)
1@c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2@c 2000, 2001, 2002, 2003, 2004, 2005, 2006 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 INCLUDE
8@include gcc-vers.texi
9@c man end
10
11@c man begin COPYRIGHT
12Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
131999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
14
15Permission is granted to copy, distribute and/or modify this document
16under the terms of the GNU Free Documentation License, Version 1.2 or
17any later version published by the Free Software Foundation; with the
18Invariant Sections being ``GNU General Public License'' and ``Funding
19Free Software'', the Front-Cover texts being (a) (see below), and with
20the Back-Cover Texts being (b) (see below).  A copy of the license is
21included in the gfdl(7) man page.
22
23(a) The FSF's Front-Cover Text is:
24
25     A GNU Manual
26
27(b) The FSF's Back-Cover Text is:
28
29     You have freedom to copy and modify this GNU Manual, like GNU
30     software.  Copies published by the Free Software Foundation raise
31     funds for GNU development.
32@c man end
33@c Set file name and title for the man page.
34@setfilename gcc
35@settitle GNU project C and C++ compiler
36@c man begin SYNOPSIS
37gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38    [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39    [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40    [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41    [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42    [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
43    [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
44
45Only the most useful options are listed here; see below for the
46remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
47@c man end
48@c man begin SEEALSO
49gpl(7), gfdl(7), fsf-funding(7),
50cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51and the Info entries for @file{gcc}, @file{cpp}, @file{as},
52@file{ld}, @file{binutils} and @file{gdb}.
53@c man end
54@c man begin BUGS
55For instructions on reporting bugs, see
56@w{@uref{http://gcc.gnu.org/bugs.html}}.
57@c man end
58@c man begin AUTHOR
59See the Info entry for @command{gcc}, or
60@w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61for contributors to GCC@.
62@c man end
63@end ignore
64
65@node Invoking GCC
66@chapter GCC Command Options
67@cindex GCC command options
68@cindex command options
69@cindex options, GCC command
70
71@c man begin DESCRIPTION
72When you invoke GCC, it normally does preprocessing, compilation,
73assembly and linking.  The ``overall options'' allow you to stop this
74process at an intermediate stage.  For example, the @option{-c} option
75says not to run the linker.  Then the output consists of object files
76output by the assembler.
77
78Other options are passed on to one stage of processing.  Some options
79control the preprocessor and others the compiler itself.  Yet other
80options control the assembler and linker; most of these are not
81documented here, since you rarely need to use any of them.
82
83@cindex C compilation options
84Most of the command line options that you can use with GCC are useful
85for C programs; when an option is only useful with another language
86(usually C++), the explanation says so explicitly.  If the description
87for a particular option does not mention a source language, you can use
88that option with all supported languages.
89
90@cindex C++ compilation options
91@xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92options for compiling C++ programs.
93
94@cindex grouping options
95@cindex options, grouping
96The @command{gcc} program accepts options and file names as operands.  Many
97options have multi-letter names; therefore multiple single-letter options
98may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
99-r}}.
100
101@cindex order of options
102@cindex options, order
103You can mix options and other arguments.  For the most part, the order
104you use doesn't matter.  Order does matter when you use several options
105of the same kind; for example, if you specify @option{-L} more than once,
106the directories are searched in the order specified.
107
108Many options have long names starting with @samp{-f} or with
109@samp{-W}---for example,
110@option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
111these have both positive and negative forms; the negative form of
112@option{-ffoo} would be @option{-fno-foo}.  This manual documents
113only one of these two forms, whichever one is not the default.
114
115@c man end
116
117@xref{Option Index}, for an index to GCC's options.
118
119@menu
120* Option Summary::	Brief list of all options, without explanations.
121* Overall Options::     Controlling the kind of output:
122                        an executable, object files, assembler files,
123                        or preprocessed source.
124* Invoking G++::	Compiling C++ programs.
125* C Dialect Options::   Controlling the variant of C language compiled.
126* C++ Dialect Options:: Variations on C++.
127* Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128                        and Objective-C++.
129* Language Independent Options:: Controlling how diagnostics should be
130                        formatted.
131* Warning Options::     How picky should the compiler be?
132* Debugging Options::   Symbol tables, measurements, and debugging dumps.
133* Optimize Options::    How much optimization?
134* Preprocessor Options:: Controlling header files and macro definitions.
135                         Also, getting dependency information for Make.
136* Assembler Options::   Passing options to the assembler.
137* Link Options::        Specifying libraries and so on.
138* Directory Options::   Where to find header files and libraries.
139                        Where to find the compiler executable files.
140* Spec Files::          How to pass switches to sub-processes.
141* Target Options::      Running a cross-compiler, or an old version of GCC.
142* Submodel Options::    Specifying minor hardware or convention variations,
143                        such as 68010 vs 68020.
144* Code Gen Options::    Specifying conventions for function calls, data layout
145                        and register usage.
146* Environment Variables:: Env vars that affect GCC.
147* Precompiled Headers:: Compiling a header once, and using it many times.
148* Running Protoize::    Automatically adding or removing function prototypes.
149@end menu
150
151@c man begin OPTIONS
152
153@node Option Summary
154@section Option Summary
155
156Here is a summary of all the options, grouped by type.  Explanations are
157in the following sections.
158
159@table @emph
160@item Overall Options
161@xref{Overall Options,,Options Controlling the Kind of Output}.
162@gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
163-x @var{language}  -v  -###  --help  --target-help  --version @@@var{file}}
164
165@item C Language Options
166@xref{C Dialect Options,,Options Controlling C Dialect}.
167@gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
168-aux-info @var{filename} @gol
169-fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
170-fhosted  -ffreestanding -fopenmp -fms-extensions @gol
171-trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
172-fallow-single-precision  -fcond-mismatch @gol
173-fsigned-bitfields  -fsigned-char @gol
174-funsigned-bitfields  -funsigned-char}
175
176@item C++ Language Options
177@xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
178@gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
179-fconserve-space  -ffriend-injection @gol
180-fno-elide-constructors @gol
181-fno-enforce-eh-specs @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-fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
190-fno-default-inline  -fvisibility-inlines-hidden @gol
191-Wabi  -Wctor-dtor-privacy @gol
192-Wnon-virtual-dtor  -Wreorder @gol
193-Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
194-Wno-non-template-friend  -Wold-style-cast @gol
195-Woverloaded-virtual  -Wno-pmf-conversions @gol
196-Wsign-promo}
197
198@item Objective-C and Objective-C++ Language Options
199@xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
200Objective-C and Objective-C++ Dialects}.
201@gccoptlist{-fconstant-string-class=@var{class-name} @gol
202-fgnu-runtime  -fnext-runtime @gol
203-fno-nil-receivers @gol
204-fobjc-call-cxx-cdtors @gol
205-fobjc-direct-dispatch @gol
206-fobjc-exceptions @gol
207-fobjc-gc @gol
208-freplace-objc-classes @gol
209-fzero-link @gol
210-gen-decls @gol
211-Wassign-intercept @gol
212-Wno-protocol  -Wselector @gol
213-Wstrict-selector-match @gol
214-Wundeclared-selector}
215
216@item Language Independent Options
217@xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
218@gccoptlist{-fmessage-length=@var{n}  @gol
219-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
220-fdiagnostics-show-option}
221
222@item Warning Options
223@xref{Warning Options,,Options to Request or Suppress Warnings}.
224@gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
225-w  -Wextra  -Wall  -Waddress  -Waggregate-return -Wno-attributes @gol
226-Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
227-Wconversion  -Wno-deprecated-declarations @gol
228-Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
229-Werror  -Werror=* -Werror-implicit-function-declaration @gol
230-Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
231-Wno-format-extra-args -Wformat-nonliteral @gol
232-Wformat-security  -Wformat-y2k @gol
233-Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
234-Wimport  -Wno-import  -Winit-self  -Winline @gol
235-Wno-int-to-pointer-cast @gol
236-Wno-invalid-offsetof  -Winvalid-pch @gol
237-Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
238-Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
239-Wmissing-format-attribute  -Wmissing-include-dirs @gol
240-Wmissing-noreturn @gol
241-Wno-multichar  -Wnonnull  -Wno-overflow @gol
242-Woverlength-strings  -Wpacked  -Wpadded @gol
243-Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
244-Wredundant-decls @gol
245-Wreturn-type  -Wsequence-point  -Wshadow @gol
246-Wsign-compare  -Wstack-protector @gol
247-Wstrict-aliasing -Wstrict-aliasing=2 @gol
248-Wstrict-overflow -Wstrict-overflow=@var{n} @gol
249-Wswitch  -Wswitch-default  -Wswitch-enum @gol
250-Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
251-Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
252-Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
253-Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
254-Wvolatile-register-var  -Wwrite-strings}
255
256@item C-only Warning Options
257@gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
258-Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
259-Wstrict-prototypes  -Wtraditional @gol
260-Wdeclaration-after-statement -Wpointer-sign}
261
262@item Debugging Options
263@xref{Debugging Options,,Options for Debugging Your Program or GCC}.
264@gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
265-fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
266-fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
267-fdump-ipa-all -fdump-ipa-cgraph @gol
268-fdump-tree-all @gol
269-fdump-tree-original@r{[}-@var{n}@r{]}  @gol
270-fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
271-fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
272-fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
273-fdump-tree-ch @gol
274-fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
275-fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
276-fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
277-fdump-tree-dom@r{[}-@var{n}@r{]} @gol
278-fdump-tree-dse@r{[}-@var{n}@r{]} @gol
279-fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
280-fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
281-fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
282-fdump-tree-nrv -fdump-tree-vect @gol
283-fdump-tree-sink @gol
284-fdump-tree-sra@r{[}-@var{n}@r{]} @gol
285-fdump-tree-salias @gol
286-fdump-tree-fre@r{[}-@var{n}@r{]} @gol
287-fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
288-ftree-vectorizer-verbose=@var{n} @gol
289-fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
290-feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
291-feliminate-unused-debug-symbols -femit-class-debug-always @gol
292-fmem-report -fprofile-arcs @gol
293-frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
294-ftest-coverage  -ftime-report -fvar-tracking @gol
295-g  -g@var{level}  -gcoff -gdwarf-2 @gol
296-ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
297-p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
298-print-multi-directory  -print-multi-lib @gol
299-print-prog-name=@var{program}  -print-search-dirs  -Q @gol
300-save-temps  -time}
301
302@item Optimization Options
303@xref{Optimize Options,,Options that Control Optimization}.
304@gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
305-falign-labels=@var{n}  -falign-loops=@var{n}  @gol
306-fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
307-fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
308-fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
309-fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
310-fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
311-fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
312-fexpensive-optimizations  -ffast-math  -ffloat-store @gol
313-fforce-addr  -ffunction-sections @gol
314-fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
315-fcrossjumping  -fif-conversion  -fif-conversion2 @gol
316-finline-functions  -finline-functions-called-once @gol
317-finline-limit=@var{n}  -fkeep-inline-functions @gol
318-fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
319-fmodulo-sched -fno-branch-count-reg @gol
320-fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
321-fno-function-cse  -fno-guess-branch-probability @gol
322-fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
323-funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
324-fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
325-fomit-frame-pointer  -foptimize-register-move @gol
326-foptimize-sibling-calls  -fprefetch-loop-arrays @gol
327-fprofile-generate -fprofile-use @gol
328-fregmove  -frename-registers @gol
329-freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
330-frerun-cse-after-loop @gol
331-frounding-math -frtl-abstract-sequences @gol
332-fschedule-insns  -fschedule-insns2 @gol
333-fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
334-fsched-spec-load-dangerous  @gol
335-fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
336-fsched2-use-superblocks @gol
337-fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
338-fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
339-fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
340-fstrict-aliasing  -fstrict-overflow  -ftracer  -fthread-jumps @gol
341-funroll-all-loops  -funroll-loops  -fpeel-loops @gol
342-fsplit-ivs-in-unroller -funswitch-loops @gol
343-fvariable-expansion-in-unroller @gol
344-ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
345-ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
346-ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
347-ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
348-ftree-vect-loop-version -ftree-salias -fipa-pta -fweb @gol
349-ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
350--param @var{name}=@var{value}
351-O  -O0  -O1  -O2  -O3  -Os}
352
353@item Preprocessor Options
354@xref{Preprocessor Options,,Options Controlling the Preprocessor}.
355@gccoptlist{-A@var{question}=@var{answer} @gol
356-A-@var{question}@r{[}=@var{answer}@r{]} @gol
357-C  -dD  -dI  -dM  -dN @gol
358-D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
359-idirafter @var{dir} @gol
360-include @var{file}  -imacros @var{file} @gol
361-iprefix @var{file}  -iwithprefix @var{dir} @gol
362-iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
363-imultilib @var{dir} -isysroot @var{dir} @gol
364-M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
365-P  -fworking-directory  -remap @gol
366-trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
367-Xpreprocessor @var{option}}
368
369@item Assembler Option
370@xref{Assembler Options,,Passing Options to the Assembler}.
371@gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
372
373@item Linker Options
374@xref{Link Options,,Options for Linking}.
375@gccoptlist{@var{object-file-name}  -l@var{library} @gol
376-nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
377-s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
378-Wl,@var{option}  -Xlinker @var{option} @gol
379-u @var{symbol}}
380
381@item Directory Options
382@xref{Directory Options,,Options for Directory Search}.
383@gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
384-specs=@var{file}  -I- --sysroot=@var{dir}}
385
386@item Target Options
387@c I wrote this xref this way to avoid overfull hbox. -- rms
388@xref{Target Options}.
389@gccoptlist{-V @var{version}  -b @var{machine}}
390
391@item Machine Dependent Options
392@xref{Submodel Options,,Hardware Models and Configurations}.
393@c This list is ordered alphanumerically by subsection name.
394@c Try and put the significant identifier (CPU or system) first,
395@c so users have a clue at guessing where the ones they want will be.
396
397@emph{ARC Options}
398@gccoptlist{-EB  -EL @gol
399-mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
400-mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
401
402@emph{ARM Options}
403@gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
404-mabi=@var{name} @gol
405-mapcs-stack-check  -mno-apcs-stack-check @gol
406-mapcs-float  -mno-apcs-float @gol
407-mapcs-reentrant  -mno-apcs-reentrant @gol
408-msched-prolog  -mno-sched-prolog @gol
409-mlittle-endian  -mbig-endian  -mwords-little-endian @gol
410-mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
411-mthumb-interwork  -mno-thumb-interwork @gol
412-mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
413-mstructure-size-boundary=@var{n} @gol
414-mabort-on-noreturn @gol
415-mlong-calls  -mno-long-calls @gol
416-msingle-pic-base  -mno-single-pic-base @gol
417-mpic-register=@var{reg} @gol
418-mnop-fun-dllimport @gol
419-mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
420-mpoke-function-name @gol
421-mthumb  -marm @gol
422-mtpcs-frame  -mtpcs-leaf-frame @gol
423-mcaller-super-interworking  -mcallee-super-interworking @gol
424-mtp=@var{name}}
425
426@emph{AVR Options}
427@gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
428-mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
429
430@emph{Blackfin Options}
431@gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
432-mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
433-mlow-64k -mno-low64k -mid-shared-library @gol
434-mno-id-shared-library -mshared-library-id=@var{n} @gol
435-mlong-calls  -mno-long-calls}
436
437@emph{CRIS Options}
438@gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
439-mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
440-metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
441-mstack-align  -mdata-align  -mconst-align @gol
442-m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
443-melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
444-mmul-bug-workaround  -mno-mul-bug-workaround}
445
446@emph{CRX Options}
447@gccoptlist{-mmac -mpush-args}
448
449@emph{Darwin Options}
450@gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
451-arch_only  -bind_at_load  -bundle  -bundle_loader @gol
452-client_name  -compatibility_version  -current_version @gol
453-dead_strip @gol
454-dependency-file  -dylib_file  -dylinker_install_name @gol
455-dynamic  -dynamiclib  -exported_symbols_list @gol
456-filelist  -flat_namespace  -force_cpusubtype_ALL @gol
457-force_flat_namespace  -headerpad_max_install_names @gol
458-image_base  -init  -install_name  -keep_private_externs @gol
459-multi_module  -multiply_defined  -multiply_defined_unused @gol
460-noall_load   -no_dead_strip_inits_and_terms @gol
461-nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
462-pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
463-private_bundle  -read_only_relocs  -sectalign @gol
464-sectobjectsymbols  -whyload  -seg1addr @gol
465-sectcreate  -sectobjectsymbols  -sectorder @gol
466-segaddr -segs_read_only_addr -segs_read_write_addr @gol
467-seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
468-segprot  -segs_read_only_addr  -segs_read_write_addr @gol
469-single_module  -static  -sub_library  -sub_umbrella @gol
470-twolevel_namespace  -umbrella  -undefined @gol
471-unexported_symbols_list  -weak_reference_mismatches @gol
472-whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
473-mkernel -mone-byte-bool}
474
475@emph{DEC Alpha Options}
476@gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
477-mieee  -mieee-with-inexact  -mieee-conformant @gol
478-mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
479-mtrap-precision=@var{mode}  -mbuild-constants @gol
480-mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
481-mbwx  -mmax  -mfix  -mcix @gol
482-mfloat-vax  -mfloat-ieee @gol
483-mexplicit-relocs  -msmall-data  -mlarge-data @gol
484-msmall-text  -mlarge-text @gol
485-mmemory-latency=@var{time}}
486
487@emph{DEC Alpha/VMS Options}
488@gccoptlist{-mvms-return-codes}
489
490@emph{FRV Options}
491@gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
492-mhard-float  -msoft-float @gol
493-malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
494-mdouble  -mno-double @gol
495-mmedia  -mno-media  -mmuladd  -mno-muladd @gol
496-mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
497-mlinked-fp  -mlong-calls  -malign-labels @gol
498-mlibrary-pic  -macc-4  -macc-8 @gol
499-mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
500-moptimize-membar -mno-optimize-membar @gol
501-mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
502-mvliw-branch  -mno-vliw-branch @gol
503-mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
504-mno-nested-cond-exec  -mtomcat-stats @gol
505-mTLS -mtls @gol
506-mcpu=@var{cpu}}
507
508@emph{GNU/Linux Options}
509@gccoptlist{-muclibc}
510
511@emph{H8/300 Options}
512@gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
513
514@emph{HPPA Options}
515@gccoptlist{-march=@var{architecture-type} @gol
516-mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
517-mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
518-mfixed-range=@var{register-range} @gol
519-mjump-in-delay -mlinker-opt -mlong-calls @gol
520-mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
521-mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
522-mno-jump-in-delay  -mno-long-load-store @gol
523-mno-portable-runtime  -mno-soft-float @gol
524-mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
525-mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
526-mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
527-munix=@var{unix-std}  -nolibdld  -static  -threads}
528
529@emph{i386 and x86-64 Options}
530@gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
531-mfpmath=@var{unit} @gol
532-masm=@var{dialect}  -mno-fancy-math-387 @gol
533-mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
534-mno-wide-multiply  -mrtd  -malign-double @gol
535-mpreferred-stack-boundary=@var{num} @gol
536-mmmx  -msse  -msse2 -msse3 -m3dnow @gol
537-mthreads  -mno-align-stringops  -minline-all-stringops @gol
538-mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
539-m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
540-mstackrealign @gol
541-momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
542-mcmodel=@var{code-model} @gol
543-m32  -m64 -mlarge-data-threshold=@var{num}}
544
545@emph{IA-64 Options}
546@gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
547-mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
548-mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
549-minline-float-divide-max-throughput @gol
550-minline-int-divide-min-latency @gol
551-minline-int-divide-max-throughput  @gol
552-minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
553-mno-dwarf2-asm -mearly-stop-bits @gol
554-mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
555-mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
556-mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
557-msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
558-msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
559-mno-sched-prefer-non-data-spec-insns @gol
560-mno-sched-prefer-non-control-spec-insns @gol
561-mno-sched-count-spec-in-critical-path}
562
563@emph{M32R/D Options}
564@gccoptlist{-m32r2 -m32rx -m32r @gol
565-mdebug @gol
566-malign-loops -mno-align-loops @gol
567-missue-rate=@var{number} @gol
568-mbranch-cost=@var{number} @gol
569-mmodel=@var{code-size-model-type} @gol
570-msdata=@var{sdata-type} @gol
571-mno-flush-func -mflush-func=@var{name} @gol
572-mno-flush-trap -mflush-trap=@var{number} @gol
573-G @var{num}}
574
575@emph{M32C Options}
576@gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
577
578@emph{M680x0 Options}
579@gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
580-m68060  -mcpu32  -m5200  -mcfv4e -m68881  -mbitfield  @gol
581-mc68000  -mc68020   @gol
582-mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
583-malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
584-mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
585
586@emph{M68hc1x Options}
587@gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
588-mauto-incdec  -minmax  -mlong-calls  -mshort @gol
589-msoft-reg-count=@var{count}}
590
591@emph{MCore Options}
592@gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
593-mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
594-m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
595-mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
596-mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
597
598@emph{MIPS Options}
599@gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
600-mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
601-mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
602-mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64  @gol
603-mfp32  -mfp64  -mhard-float  -msoft-float  @gol
604-msingle-float  -mdouble-float  -mdsp  -mpaired-single  -mips3d @gol
605-mlong64  -mlong32  -msym32  -mno-sym32 @gol
606-G@var{num}  -membedded-data  -mno-embedded-data @gol
607-muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
608-msplit-addresses  -mno-split-addresses  @gol
609-mexplicit-relocs  -mno-explicit-relocs  @gol
610-mcheck-zero-division  -mno-check-zero-division @gol
611-mdivide-traps  -mdivide-breaks @gol
612-mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
613-mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
614-mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
615-mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
616-mfix-sb1  -mno-fix-sb1 @gol
617-mflush-func=@var{func}  -mno-flush-func @gol
618-mbranch-likely  -mno-branch-likely @gol
619-mfp-exceptions -mno-fp-exceptions @gol
620-mvr4130-align -mno-vr4130-align}
621
622@emph{MMIX Options}
623@gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
624-mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
625-melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
626-mno-base-addresses  -msingle-exit  -mno-single-exit}
627
628@emph{MN10300 Options}
629@gccoptlist{-mmult-bug  -mno-mult-bug @gol
630-mam33  -mno-am33 @gol
631-mam33-2  -mno-am33-2 @gol
632-mreturn-pointer-on-d0 @gol
633-mno-crt0  -mrelax}
634
635@emph{MT Options}
636@gccoptlist{-mno-crt0 -mbacc -msim @gol
637-march=@var{cpu-type} }
638
639@emph{PDP-11 Options}
640@gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
641-mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
642-mint16  -mno-int32  -mfloat32  -mno-float64 @gol
643-mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
644-mbranch-expensive  -mbranch-cheap @gol
645-msplit  -mno-split  -munix-asm  -mdec-asm}
646
647@emph{PowerPC Options}
648See RS/6000 and PowerPC Options.
649
650@emph{RS/6000 and PowerPC Options}
651@gccoptlist{-mcpu=@var{cpu-type} @gol
652-mtune=@var{cpu-type} @gol
653-mpower  -mno-power  -mpower2  -mno-power2 @gol
654-mpowerpc  -mpowerpc64  -mno-powerpc @gol
655-maltivec  -mno-altivec @gol
656-mpowerpc-gpopt  -mno-powerpc-gpopt @gol
657-mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
658-mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
659-mnew-mnemonics  -mold-mnemonics @gol
660-mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
661-m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
662-malign-power  -malign-natural @gol
663-msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
664-mstring  -mno-string  -mupdate  -mno-update @gol
665-mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
666-mstrict-align  -mno-strict-align  -mrelocatable @gol
667-mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
668-mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
669-mdynamic-no-pic  -maltivec  -mswdiv @gol
670-mprioritize-restricted-insns=@var{priority} @gol
671-msched-costly-dep=@var{dependence_type} @gol
672-minsert-sched-nops=@var{scheme} @gol
673-mcall-sysv  -mcall-netbsd @gol
674-maix-struct-return  -msvr4-struct-return @gol
675-mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
676-misel -mno-isel @gol
677-misel=yes  -misel=no @gol
678-mspe -mno-spe @gol
679-mspe=yes  -mspe=no @gol
680-mvrsave -mno-vrsave @gol
681-mmulhw -mno-mulhw @gol
682-mdlmzb -mno-dlmzb @gol
683-mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
684-mprototype  -mno-prototype @gol
685-msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
686-msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
687
688@emph{S/390 and zSeries Options}
689@gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
690-mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
691-mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
692-msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
693-m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
694-mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
695-mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
696
697@emph{Score Options}
698@gccoptlist{-meb -mel @gol
699-mnhwloop @gol
700-muls @gol
701-mmac @gol
702-mscore5 -mscore5u -mscore7 -mscore7d}
703
704@emph{SH Options}
705@gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
706-m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
707-m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
708-m5-64media  -m5-64media-nofpu @gol
709-m5-32media  -m5-32media-nofpu @gol
710-m5-compact  -m5-compact-nofpu @gol
711-mb  -ml  -mdalign  -mrelax @gol
712-mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
713-mieee  -misize  -mpadstruct  -mspace @gol
714-mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
715-mdivsi3_libfunc=@var{name}  @gol
716-madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
717 -minvalid-symbols}
718
719@emph{SPARC Options}
720@gccoptlist{-mcpu=@var{cpu-type} @gol
721-mtune=@var{cpu-type} @gol
722-mcmodel=@var{code-model} @gol
723-m32  -m64  -mapp-regs  -mno-app-regs @gol
724-mfaster-structs  -mno-faster-structs @gol
725-mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
726-mhard-quad-float  -msoft-quad-float @gol
727-mimpure-text  -mno-impure-text  -mlittle-endian @gol
728-mstack-bias  -mno-stack-bias @gol
729-munaligned-doubles  -mno-unaligned-doubles @gol
730-mv8plus  -mno-v8plus  -mvis  -mno-vis
731-threads -pthreads -pthread}
732
733@emph{System V Options}
734@gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
735
736@emph{TMS320C3x/C4x Options}
737@gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
738-mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
739-mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
740-mparallel-insns  -mparallel-mpy  -mpreserve-float}
741
742@emph{V850 Options}
743@gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
744-mprolog-function  -mno-prolog-function  -mspace @gol
745-mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
746-mapp-regs  -mno-app-regs @gol
747-mdisable-callt  -mno-disable-callt @gol
748-mv850e1 @gol
749-mv850e @gol
750-mv850  -mbig-switch}
751
752@emph{VAX Options}
753@gccoptlist{-mg  -mgnu  -munix}
754
755@emph{x86-64 Options}
756See i386 and x86-64 Options.
757
758@emph{Xstormy16 Options}
759@gccoptlist{-msim}
760
761@emph{Xtensa Options}
762@gccoptlist{-mconst16 -mno-const16 @gol
763-mfused-madd  -mno-fused-madd @gol
764-mtext-section-literals  -mno-text-section-literals @gol
765-mtarget-align  -mno-target-align @gol
766-mlongcalls  -mno-longcalls}
767
768@emph{zSeries Options}
769See S/390 and zSeries Options.
770
771@item Code Generation Options
772@xref{Code Gen Options,,Options for Code Generation Conventions}.
773@gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
774-ffixed-@var{reg}  -fexceptions @gol
775-fnon-call-exceptions  -funwind-tables @gol
776-fasynchronous-unwind-tables @gol
777-finhibit-size-directive  -finstrument-functions @gol
778-fno-common  -fno-ident @gol
779-fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
780-fno-jump-tables @gol
781-freg-struct-return  -fshort-enums @gol
782-fshort-double  -fshort-wchar @gol
783-fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
784-fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
785-fargument-alias  -fargument-noalias @gol
786-fargument-noalias-global  -fargument-noalias-anything
787-fleading-underscore  -ftls-model=@var{model} @gol
788-ftrapv  -fwrapv  -fbounds-check @gol
789-fvisibility}
790@end table
791
792@menu
793* Overall Options::     Controlling the kind of output:
794                        an executable, object files, assembler files,
795                        or preprocessed source.
796* C Dialect Options::   Controlling the variant of C language compiled.
797* C++ Dialect Options:: Variations on C++.
798* Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
799                        and Objective-C++.
800* Language Independent Options:: Controlling how diagnostics should be
801                        formatted.
802* Warning Options::     How picky should the compiler be?
803* Debugging Options::   Symbol tables, measurements, and debugging dumps.
804* Optimize Options::    How much optimization?
805* Preprocessor Options:: Controlling header files and macro definitions.
806                         Also, getting dependency information for Make.
807* Assembler Options::   Passing options to the assembler.
808* Link Options::        Specifying libraries and so on.
809* Directory Options::   Where to find header files and libraries.
810                        Where to find the compiler executable files.
811* Spec Files::          How to pass switches to sub-processes.
812* Target Options::      Running a cross-compiler, or an old version of GCC.
813@end menu
814
815@node Overall Options
816@section Options Controlling the Kind of Output
817
818Compilation can involve up to four stages: preprocessing, compilation
819proper, assembly and linking, always in that order.  GCC is capable of
820preprocessing and compiling several files either into several
821assembler input files, or into one assembler input file; then each
822assembler input file produces an object file, and linking combines all
823the object files (those newly compiled, and those specified as input)
824into an executable file.
825
826@cindex file name suffix
827For any given input file, the file name suffix determines what kind of
828compilation is done:
829
830@table @gcctabopt
831@item @var{file}.c
832C source code which must be preprocessed.
833
834@item @var{file}.i
835C source code which should not be preprocessed.
836
837@item @var{file}.ii
838C++ source code which should not be preprocessed.
839
840@item @var{file}.m
841Objective-C source code.  Note that you must link with the @file{libobjc}
842library to make an Objective-C program work.
843
844@item @var{file}.mi
845Objective-C source code which should not be preprocessed.
846
847@item @var{file}.mm
848@itemx @var{file}.M
849Objective-C++ source code.  Note that you must link with the @file{libobjc}
850library to make an Objective-C++ program work.  Note that @samp{.M} refers
851to a literal capital M@.
852
853@item @var{file}.mii
854Objective-C++ source code which should not be preprocessed.
855
856@item @var{file}.h
857C, C++, Objective-C or Objective-C++ header file to be turned into a
858precompiled header.
859
860@item @var{file}.cc
861@itemx @var{file}.cp
862@itemx @var{file}.cxx
863@itemx @var{file}.cpp
864@itemx @var{file}.CPP
865@itemx @var{file}.c++
866@itemx @var{file}.C
867C++ source code which must be preprocessed.  Note that in @samp{.cxx},
868the last two letters must both be literally @samp{x}.  Likewise,
869@samp{.C} refers to a literal capital C@.
870
871@item @var{file}.mm
872@itemx @var{file}.M
873Objective-C++ source code which must be preprocessed.
874
875@item @var{file}.mii
876Objective-C++ source code which should not be preprocessed.
877
878@item @var{file}.hh
879@itemx @var{file}.H
880C++ header file to be turned into a precompiled header.
881
882@item @var{file}.f
883@itemx @var{file}.for
884@itemx @var{file}.FOR
885Fixed form Fortran source code which should not be preprocessed.
886
887@item @var{file}.F
888@itemx @var{file}.fpp
889@itemx @var{file}.FPP
890Fixed form Fortran source code which must be preprocessed (with the traditional
891preprocessor).
892
893@item @var{file}.f90
894@itemx @var{file}.f95
895Free form Fortran source code which should not be preprocessed.
896
897@item @var{file}.F90
898@itemx @var{file}.F95
899Free form Fortran source code which must be preprocessed (with the
900traditional preprocessor).
901
902@c FIXME: Descriptions of Java file types.
903@c @var{file}.java
904@c @var{file}.class
905@c @var{file}.zip
906@c @var{file}.jar
907
908@item @var{file}.ads
909Ada source code file which contains a library unit declaration (a
910declaration of a package, subprogram, or generic, or a generic
911instantiation), or a library unit renaming declaration (a package,
912generic, or subprogram renaming declaration).  Such files are also
913called @dfn{specs}.
914
915@itemx @var{file}.adb
916Ada source code file containing a library unit body (a subprogram or
917package body).  Such files are also called @dfn{bodies}.
918
919@c GCC also knows about some suffixes for languages not yet included:
920@c Pascal:
921@c @var{file}.p
922@c @var{file}.pas
923@c Ratfor:
924@c @var{file}.r
925
926@item @var{file}.s
927Assembler code.
928
929@item @var{file}.S
930Assembler code which must be preprocessed.
931
932@item @var{other}
933An object file to be fed straight into linking.
934Any file name with no recognized suffix is treated this way.
935@end table
936
937@opindex x
938You can specify the input language explicitly with the @option{-x} option:
939
940@table @gcctabopt
941@item -x @var{language}
942Specify explicitly the @var{language} for the following input files
943(rather than letting the compiler choose a default based on the file
944name suffix).  This option applies to all following input files until
945the next @option{-x} option.  Possible values for @var{language} are:
946@smallexample
947c  c-header  c-cpp-output
948c++  c++-header  c++-cpp-output
949objective-c  objective-c-header  objective-c-cpp-output
950objective-c++ objective-c++-header objective-c++-cpp-output
951assembler  assembler-with-cpp
952ada
953f95  f95-cpp-input
954java
955treelang
956@end smallexample
957
958@item -x none
959Turn off any specification of a language, so that subsequent files are
960handled according to their file name suffixes (as they are if @option{-x}
961has not been used at all).
962
963@item -pass-exit-codes
964@opindex pass-exit-codes
965Normally the @command{gcc} program will exit with the code of 1 if any
966phase of the compiler returns a non-success return code.  If you specify
967@option{-pass-exit-codes}, the @command{gcc} program will instead return with
968numerically highest error produced by any phase that returned an error
969indication.  The C, C++, and Fortran frontends return 4, if an internal
970compiler error is encountered.
971@end table
972
973If you only want some of the stages of compilation, you can use
974@option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
975one of the options @option{-c}, @option{-S}, or @option{-E} to say where
976@command{gcc} is to stop.  Note that some combinations (for example,
977@samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
978
979@table @gcctabopt
980@item -c
981@opindex c
982Compile or assemble the source files, but do not link.  The linking
983stage simply is not done.  The ultimate output is in the form of an
984object file for each source file.
985
986By default, the object file name for a source file is made by replacing
987the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
988
989Unrecognized input files, not requiring compilation or assembly, are
990ignored.
991
992@item -S
993@opindex S
994Stop after the stage of compilation proper; do not assemble.  The output
995is in the form of an assembler code file for each non-assembler input
996file specified.
997
998By default, the assembler file name for a source file is made by
999replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1000
1001Input files that don't require compilation are ignored.
1002
1003@item -E
1004@opindex E
1005Stop after the preprocessing stage; do not run the compiler proper.  The
1006output is in the form of preprocessed source code, which is sent to the
1007standard output.
1008
1009Input files which don't require preprocessing are ignored.
1010
1011@cindex output file option
1012@item -o @var{file}
1013@opindex o
1014Place output in file @var{file}.  This applies regardless to whatever
1015sort of output is being produced, whether it be an executable file,
1016an object file, an assembler file or preprocessed C code.
1017
1018If @option{-o} is not specified, the default is to put an executable
1019file in @file{a.out}, the object file for
1020@file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1021assembler file in @file{@var{source}.s}, a precompiled header file in
1022@file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1023standard output.
1024
1025@item -v
1026@opindex v
1027Print (on standard error output) the commands executed to run the stages
1028of compilation.  Also print the version number of the compiler driver
1029program and of the preprocessor and the compiler proper.
1030
1031@item -###
1032@opindex ###
1033Like @option{-v} except the commands are not executed and all command
1034arguments are quoted.  This is useful for shell scripts to capture the
1035driver-generated command lines.
1036
1037@item -pipe
1038@opindex pipe
1039Use pipes rather than temporary files for communication between the
1040various stages of compilation.  This fails to work on some systems where
1041the assembler is unable to read from a pipe; but the GNU assembler has
1042no trouble.
1043
1044@item -combine
1045@opindex combine
1046If you are compiling multiple source files, this option tells the driver
1047to pass all the source files to the compiler at once (for those
1048languages for which the compiler can handle this).  This will allow
1049intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1050language for which this is supported is C@.  If you pass source files for
1051multiple languages to the driver, using this option, the driver will invoke
1052the compiler(s) that support IMA once each, passing each compiler all the
1053source files appropriate for it.  For those languages that do not support
1054IMA this option will be ignored, and the compiler will be invoked once for
1055each source file in that language.  If you use this option in conjunction
1056with @option{-save-temps}, the compiler will generate multiple
1057pre-processed files
1058(one for each source file), but only one (combined) @file{.o} or
1059@file{.s} file.
1060
1061@item --help
1062@opindex help
1063Print (on the standard output) a description of the command line options
1064understood by @command{gcc}.  If the @option{-v} option is also specified
1065then @option{--help} will also be passed on to the various processes
1066invoked by @command{gcc}, so that they can display the command line options
1067they accept.  If the @option{-Wextra} option is also specified then command
1068line options which have no documentation associated with them will also
1069be displayed.
1070
1071@item --target-help
1072@opindex target-help
1073Print (on the standard output) a description of target specific command
1074line options for each tool.
1075
1076@item --version
1077@opindex version
1078Display the version number and copyrights of the invoked GCC@.
1079
1080@include @value{srcdir}/at-file.texi
1081@end table
1082
1083@node Invoking G++
1084@section Compiling C++ Programs
1085
1086@cindex suffixes for C++ source
1087@cindex C++ source file suffixes
1088C++ source files conventionally use one of the suffixes @samp{.C},
1089@samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1090@samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1091preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1092files with these names and compiles them as C++ programs even if you
1093call the compiler the same way as for compiling C programs (usually
1094with the name @command{gcc}).
1095
1096@findex g++
1097@findex c++
1098However, the use of @command{gcc} does not add the C++ library.
1099@command{g++} is a program that calls GCC and treats @samp{.c},
1100@samp{.h} and @samp{.i} files as C++ source files instead of C source
1101files unless @option{-x} is used, and automatically specifies linking
1102against the C++ library.  This program is also useful when
1103precompiling a C header file with a @samp{.h} extension for use in C++
1104compilations.  On many systems, @command{g++} is also installed with
1105the name @command{c++}.
1106
1107@cindex invoking @command{g++}
1108When you compile C++ programs, you may specify many of the same
1109command-line options that you use for compiling programs in any
1110language; or command-line options meaningful for C and related
1111languages; or options that are meaningful only for C++ programs.
1112@xref{C Dialect Options,,Options Controlling C Dialect}, for
1113explanations of options for languages related to C@.
1114@xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1115explanations of options that are meaningful only for C++ programs.
1116
1117@node C Dialect Options
1118@section Options Controlling C Dialect
1119@cindex dialect options
1120@cindex language dialect options
1121@cindex options, dialect
1122
1123The following options control the dialect of C (or languages derived
1124from C, such as C++, Objective-C and Objective-C++) that the compiler
1125accepts:
1126
1127@table @gcctabopt
1128@cindex ANSI support
1129@cindex ISO support
1130@item -ansi
1131@opindex ansi
1132In C mode, support all ISO C90 programs.  In C++ mode,
1133remove GNU extensions that conflict with ISO C++.
1134
1135This turns off certain features of GCC that are incompatible with ISO
1136C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1137such as the @code{asm} and @code{typeof} keywords, and
1138predefined macros such as @code{unix} and @code{vax} that identify the
1139type of system you are using.  It also enables the undesirable and
1140rarely used ISO trigraph feature.  For the C compiler,
1141it disables recognition of C++ style @samp{//} comments as well as
1142the @code{inline} keyword.
1143
1144The alternate keywords @code{__asm__}, @code{__extension__},
1145@code{__inline__} and @code{__typeof__} continue to work despite
1146@option{-ansi}.  You would not want to use them in an ISO C program, of
1147course, but it is useful to put them in header files that might be included
1148in compilations done with @option{-ansi}.  Alternate predefined macros
1149such as @code{__unix__} and @code{__vax__} are also available, with or
1150without @option{-ansi}.
1151
1152The @option{-ansi} option does not cause non-ISO programs to be
1153rejected gratuitously.  For that, @option{-pedantic} is required in
1154addition to @option{-ansi}.  @xref{Warning Options}.
1155
1156The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1157option is used.  Some header files may notice this macro and refrain
1158from declaring certain functions or defining certain macros that the
1159ISO standard doesn't call for; this is to avoid interfering with any
1160programs that might use these names for other things.
1161
1162Functions which would normally be built in but do not have semantics
1163defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1164functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1165built-in functions provided by GCC}, for details of the functions
1166affected.
1167
1168@item -std=
1169@opindex std
1170Determine the language standard.  This option is currently only
1171supported when compiling C or C++.  A value for this option must be
1172provided; possible values are
1173
1174@table @samp
1175@item c89
1176@itemx iso9899:1990
1177ISO C90 (same as @option{-ansi}).
1178
1179@item iso9899:199409
1180ISO C90 as modified in amendment 1.
1181
1182@item c99
1183@itemx c9x
1184@itemx iso9899:1999
1185@itemx iso9899:199x
1186ISO C99.  Note that this standard is not yet fully supported; see
1187@w{@uref{http://gcc.gnu.org/gcc-4.2/c99status.html}} for more information.  The
1188names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1189
1190@item gnu89
1191Default, ISO C90 plus GNU extensions (including some C99 features).
1192
1193@item gnu99
1194@itemx gnu9x
1195ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1196this will become the default.  The name @samp{gnu9x} is deprecated.
1197
1198@item c++98
1199The 1998 ISO C++ standard plus amendments.
1200
1201@item gnu++98
1202The same as @option{-std=c++98} plus GNU extensions.  This is the
1203default for C++ code.
1204@end table
1205
1206Even when this option is not specified, you can still use some of the
1207features of newer standards in so far as they do not conflict with
1208previous C standards.  For example, you may use @code{__restrict__} even
1209when @option{-std=c99} is not specified.
1210
1211The @option{-std} options specifying some version of ISO C have the same
1212effects as @option{-ansi}, except that features that were not in ISO C90
1213but are in the specified version (for example, @samp{//} comments and
1214the @code{inline} keyword in ISO C99) are not disabled.
1215
1216@xref{Standards,,Language Standards Supported by GCC}, for details of
1217these standard versions.
1218
1219@item -fgnu89-inline
1220@opindex fgnu89-inline
1221The option @option{-fgnu89-inline} tells GCC to use the traditional
1222GNU semantics for @code{inline} functions when in C99 mode.
1223@xref{Inline,,An Inline Function is As Fast As a Macro}.  Using this
1224option is roughly equivalent to adding the @code{gnu_inline} function
1225attribute to all inline functions (@pxref{Function Attributes}).
1226
1227This option is accepted by GCC versions 4.1.3 and up.  In GCC versions
1228prior to 4.3, C99 inline semantics are not supported, and thus this
1229option is effectively assumed to be present regardless of whether or not
1230it is specified; the only effect of specifying it explicitly is to
1231disable warnings about using inline functions in C99 mode.  Likewise,
1232the option @option{-fno-gnu89-inline} is not supported in versions of
1233GCC before 4.3.  It will be supported only in C99 or gnu99 mode, not in
1234C89 or gnu89 mode.
1235
1236The preprocesor macros @code{__GNUC_GNU_INLINE__} and
1237@code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1238in effect for @code{inline} functions.  @xref{Common Predefined
1239Macros,,,cpp,The C Preprocessor}.
1240
1241@item -aux-info @var{filename}
1242@opindex aux-info
1243Output to the given filename prototyped declarations for all functions
1244declared and/or defined in a translation unit, including those in header
1245files.  This option is silently ignored in any language other than C@.
1246
1247Besides declarations, the file indicates, in comments, the origin of
1248each declaration (source file and line), whether the declaration was
1249implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1250@samp{O} for old, respectively, in the first character after the line
1251number and the colon), and whether it came from a declaration or a
1252definition (@samp{C} or @samp{F}, respectively, in the following
1253character).  In the case of function definitions, a K&R-style list of
1254arguments followed by their declarations is also provided, inside
1255comments, after the declaration.
1256
1257@item -fno-asm
1258@opindex fno-asm
1259Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1260keyword, so that code can use these words as identifiers.  You can use
1261the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1262instead.  @option{-ansi} implies @option{-fno-asm}.
1263
1264In C++, this switch only affects the @code{typeof} keyword, since
1265@code{asm} and @code{inline} are standard keywords.  You may want to
1266use the @option{-fno-gnu-keywords} flag instead, which has the same
1267effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1268switch only affects the @code{asm} and @code{typeof} keywords, since
1269@code{inline} is a standard keyword in ISO C99.
1270
1271@item -fno-builtin
1272@itemx -fno-builtin-@var{function}
1273@opindex fno-builtin
1274@cindex built-in functions
1275Don't recognize built-in functions that do not begin with
1276@samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1277functions provided by GCC}, for details of the functions affected,
1278including those which are not built-in functions when @option{-ansi} or
1279@option{-std} options for strict ISO C conformance are used because they
1280do not have an ISO standard meaning.
1281
1282GCC normally generates special code to handle certain built-in functions
1283more efficiently; for instance, calls to @code{alloca} may become single
1284instructions that adjust the stack directly, and calls to @code{memcpy}
1285may become inline copy loops.  The resulting code is often both smaller
1286and faster, but since the function calls no longer appear as such, you
1287cannot set a breakpoint on those calls, nor can you change the behavior
1288of the functions by linking with a different library.  In addition,
1289when a function is recognized as a built-in function, GCC may use
1290information about that function to warn about problems with calls to
1291that function, or to generate more efficient code, even if the
1292resulting code still contains calls to that function.  For example,
1293warnings are given with @option{-Wformat} for bad calls to
1294@code{printf}, when @code{printf} is built in, and @code{strlen} is
1295known not to modify global memory.
1296
1297With the @option{-fno-builtin-@var{function}} option
1298only the built-in function @var{function} is
1299disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1300function is named this is not built-in in this version of GCC, this
1301option is ignored.  There is no corresponding
1302@option{-fbuiltin-@var{function}} option; if you wish to enable
1303built-in functions selectively when using @option{-fno-builtin} or
1304@option{-ffreestanding}, you may define macros such as:
1305
1306@smallexample
1307#define abs(n)          __builtin_abs ((n))
1308#define strcpy(d, s)    __builtin_strcpy ((d), (s))
1309@end smallexample
1310
1311@item -fhosted
1312@opindex fhosted
1313@cindex hosted environment
1314
1315Assert that compilation takes place in a hosted environment.  This implies
1316@option{-fbuiltin}.  A hosted environment is one in which the
1317entire standard library is available, and in which @code{main} has a return
1318type of @code{int}.  Examples are nearly everything except a kernel.
1319This is equivalent to @option{-fno-freestanding}.
1320
1321@item -ffreestanding
1322@opindex ffreestanding
1323@cindex hosted environment
1324
1325Assert that compilation takes place in a freestanding environment.  This
1326implies @option{-fno-builtin}.  A freestanding environment
1327is one in which the standard library may not exist, and program startup may
1328not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1329This is equivalent to @option{-fno-hosted}.
1330
1331@xref{Standards,,Language Standards Supported by GCC}, for details of
1332freestanding and hosted environments.
1333
1334@item -fopenmp
1335@opindex fopenmp
1336@cindex openmp parallel
1337Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1338@code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1339compiler generates parallel code according to the OpenMP Application
1340Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1341
1342@item -fms-extensions
1343@opindex fms-extensions
1344Accept some non-standard constructs used in Microsoft header files.
1345
1346Some cases of unnamed fields in structures and unions are only
1347accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1348fields within structs/unions}, for details.
1349
1350@item -trigraphs
1351@opindex trigraphs
1352Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1353options for strict ISO C conformance) implies @option{-trigraphs}.
1354
1355@item -no-integrated-cpp
1356@opindex no-integrated-cpp
1357Performs a compilation in two passes: preprocessing and compiling.  This
1358option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1359@option{-B} option.  The user supplied compilation step can then add in
1360an additional preprocessing step after normal preprocessing but before
1361compiling.  The default is to use the integrated cpp (internal cpp)
1362
1363The semantics of this option will change if "cc1", "cc1plus", and
1364"cc1obj" are merged.
1365
1366@cindex traditional C language
1367@cindex C language, traditional
1368@item -traditional
1369@itemx -traditional-cpp
1370@opindex traditional-cpp
1371@opindex traditional
1372Formerly, these options caused GCC to attempt to emulate a pre-standard
1373C compiler.  They are now only supported with the @option{-E} switch.
1374The preprocessor continues to support a pre-standard mode.  See the GNU
1375CPP manual for details.
1376
1377@item -fcond-mismatch
1378@opindex fcond-mismatch
1379Allow conditional expressions with mismatched types in the second and
1380third arguments.  The value of such an expression is void.  This option
1381is not supported for C++.
1382
1383@item -funsigned-char
1384@opindex funsigned-char
1385Let the type @code{char} be unsigned, like @code{unsigned char}.
1386
1387Each kind of machine has a default for what @code{char} should
1388be.  It is either like @code{unsigned char} by default or like
1389@code{signed char} by default.
1390
1391Ideally, a portable program should always use @code{signed char} or
1392@code{unsigned char} when it depends on the signedness of an object.
1393But many programs have been written to use plain @code{char} and
1394expect it to be signed, or expect it to be unsigned, depending on the
1395machines they were written for.  This option, and its inverse, let you
1396make such a program work with the opposite default.
1397
1398The type @code{char} is always a distinct type from each of
1399@code{signed char} or @code{unsigned char}, even though its behavior
1400is always just like one of those two.
1401
1402@item -fsigned-char
1403@opindex fsigned-char
1404Let the type @code{char} be signed, like @code{signed char}.
1405
1406Note that this is equivalent to @option{-fno-unsigned-char}, which is
1407the negative form of @option{-funsigned-char}.  Likewise, the option
1408@option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1409
1410@item -fsigned-bitfields
1411@itemx -funsigned-bitfields
1412@itemx -fno-signed-bitfields
1413@itemx -fno-unsigned-bitfields
1414@opindex fsigned-bitfields
1415@opindex funsigned-bitfields
1416@opindex fno-signed-bitfields
1417@opindex fno-unsigned-bitfields
1418These options control whether a bit-field is signed or unsigned, when the
1419declaration does not use either @code{signed} or @code{unsigned}.  By
1420default, such a bit-field is signed, because this is consistent: the
1421basic integer types such as @code{int} are signed types.
1422@end table
1423
1424@node C++ Dialect Options
1425@section Options Controlling C++ Dialect
1426
1427@cindex compiler options, C++
1428@cindex C++ options, command line
1429@cindex options, C++
1430This section describes the command-line options that are only meaningful
1431for C++ programs; but you can also use most of the GNU compiler options
1432regardless of what language your program is in.  For example, you
1433might compile a file @code{firstClass.C} like this:
1434
1435@smallexample
1436g++ -g -frepo -O -c firstClass.C
1437@end smallexample
1438
1439@noindent
1440In this example, only @option{-frepo} is an option meant
1441only for C++ programs; you can use the other options with any
1442language supported by GCC@.
1443
1444Here is a list of options that are @emph{only} for compiling C++ programs:
1445
1446@table @gcctabopt
1447
1448@item -fabi-version=@var{n}
1449@opindex fabi-version
1450Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1451C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1452the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1453the version that conforms most closely to the C++ ABI specification.
1454Therefore, the ABI obtained using version 0 will change as ABI bugs
1455are fixed.
1456
1457The default is version 2.
1458
1459@item -fno-access-control
1460@opindex fno-access-control
1461Turn off all access checking.  This switch is mainly useful for working
1462around bugs in the access control code.
1463
1464@item -fcheck-new
1465@opindex fcheck-new
1466Check that the pointer returned by @code{operator new} is non-null
1467before attempting to modify the storage allocated.  This check is
1468normally unnecessary because the C++ standard specifies that
1469@code{operator new} will only return @code{0} if it is declared
1470@samp{throw()}, in which case the compiler will always check the
1471return value even without this option.  In all other cases, when
1472@code{operator new} has a non-empty exception specification, memory
1473exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1474@samp{new (nothrow)}.
1475
1476@item -fconserve-space
1477@opindex fconserve-space
1478Put uninitialized or runtime-initialized global variables into the
1479common segment, as C does.  This saves space in the executable at the
1480cost of not diagnosing duplicate definitions.  If you compile with this
1481flag and your program mysteriously crashes after @code{main()} has
1482completed, you may have an object that is being destroyed twice because
1483two definitions were merged.
1484
1485This option is no longer useful on most targets, now that support has
1486been added for putting variables into BSS without making them common.
1487
1488@item -ffriend-injection
1489@opindex ffriend-injection
1490Inject friend functions into the enclosing namespace, so that they are
1491visible outside the scope of the class in which they are declared.
1492Friend functions were documented to work this way in the old Annotated
1493C++ Reference Manual, and versions of G++ before 4.1 always worked
1494that way.  However, in ISO C++ a friend function which is not declared
1495in an enclosing scope can only be found using argument dependent
1496lookup.  This option causes friends to be injected as they were in
1497earlier releases.
1498
1499This option is for compatibility, and may be removed in a future
1500release of G++.
1501
1502@item -fno-elide-constructors
1503@opindex fno-elide-constructors
1504The C++ standard allows an implementation to omit creating a temporary
1505which is only used to initialize another object of the same type.
1506Specifying this option disables that optimization, and forces G++ to
1507call the copy constructor in all cases.
1508
1509@item -fno-enforce-eh-specs
1510@opindex fno-enforce-eh-specs
1511Don't generate code to check for violation of exception specifications
1512at runtime.  This option violates the C++ standard, but may be useful
1513for reducing code size in production builds, much like defining
1514@samp{NDEBUG}.  This does not give user code permission to throw
1515exceptions in violation of the exception specifications; the compiler
1516will still optimize based on the specifications, so throwing an
1517unexpected exception will result in undefined behavior.
1518
1519@item -ffor-scope
1520@itemx -fno-for-scope
1521@opindex ffor-scope
1522@opindex fno-for-scope
1523If @option{-ffor-scope} is specified, the scope of variables declared in
1524a @i{for-init-statement} is limited to the @samp{for} loop itself,
1525as specified by the C++ standard.
1526If @option{-fno-for-scope} is specified, the scope of variables declared in
1527a @i{for-init-statement} extends to the end of the enclosing scope,
1528as was the case in old versions of G++, and other (traditional)
1529implementations of C++.
1530
1531The default if neither flag is given to follow the standard,
1532but to allow and give a warning for old-style code that would
1533otherwise be invalid, or have different behavior.
1534
1535@item -fno-gnu-keywords
1536@opindex fno-gnu-keywords
1537Do not recognize @code{typeof} as a keyword, so that code can use this
1538word as an identifier.  You can use the keyword @code{__typeof__} instead.
1539@option{-ansi} implies @option{-fno-gnu-keywords}.
1540
1541@item -fno-implicit-templates
1542@opindex fno-implicit-templates
1543Never emit code for non-inline templates which are instantiated
1544implicitly (i.e.@: by use); only emit code for explicit instantiations.
1545@xref{Template Instantiation}, for more information.
1546
1547@item -fno-implicit-inline-templates
1548@opindex fno-implicit-inline-templates
1549Don't emit code for implicit instantiations of inline templates, either.
1550The default is to handle inlines differently so that compiles with and
1551without optimization will need the same set of explicit instantiations.
1552
1553@item -fno-implement-inlines
1554@opindex fno-implement-inlines
1555To save space, do not emit out-of-line copies of inline functions
1556controlled by @samp{#pragma implementation}.  This will cause linker
1557errors if these functions are not inlined everywhere they are called.
1558
1559@item -fms-extensions
1560@opindex fms-extensions
1561Disable pedantic warnings about constructs used in MFC, such as implicit
1562int and getting a pointer to member function via non-standard syntax.
1563
1564@item -fno-nonansi-builtins
1565@opindex fno-nonansi-builtins
1566Disable built-in declarations of functions that are not mandated by
1567ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1568@code{index}, @code{bzero}, @code{conjf}, and other related functions.
1569
1570@item -fno-operator-names
1571@opindex fno-operator-names
1572Do not treat the operator name keywords @code{and}, @code{bitand},
1573@code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1574synonyms as keywords.
1575
1576@item -fno-optional-diags
1577@opindex fno-optional-diags
1578Disable diagnostics that the standard says a compiler does not need to
1579issue.  Currently, the only such diagnostic issued by G++ is the one for
1580a name having multiple meanings within a class.
1581
1582@item -fpermissive
1583@opindex fpermissive
1584Downgrade some diagnostics about nonconformant code from errors to
1585warnings.  Thus, using @option{-fpermissive} will allow some
1586nonconforming code to compile.
1587
1588@item -frepo
1589@opindex frepo
1590Enable automatic template instantiation at link time.  This option also
1591implies @option{-fno-implicit-templates}.  @xref{Template
1592Instantiation}, for more information.
1593
1594@item -fno-rtti
1595@opindex fno-rtti
1596Disable generation of information about every class with virtual
1597functions for use by the C++ runtime type identification features
1598(@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1599of the language, you can save some space by using this flag.  Note that
1600exception handling uses the same information, but it will generate it as
1601needed. The @samp{dynamic_cast} operator can still be used for casts that
1602do not require runtime type information, i.e. casts to @code{void *} or to
1603unambiguous base classes.
1604
1605@item -fstats
1606@opindex fstats
1607Emit statistics about front-end processing at the end of the compilation.
1608This information is generally only useful to the G++ development team.
1609
1610@item -ftemplate-depth-@var{n}
1611@opindex ftemplate-depth
1612Set the maximum instantiation depth for template classes to @var{n}.
1613A limit on the template instantiation depth is needed to detect
1614endless recursions during template class instantiation.  ANSI/ISO C++
1615conforming programs must not rely on a maximum depth greater than 17.
1616
1617@item -fno-threadsafe-statics
1618@opindex fno-threadsafe-statics
1619Do not emit the extra code to use the routines specified in the C++
1620ABI for thread-safe initialization of local statics.  You can use this
1621option to reduce code size slightly in code that doesn't need to be
1622thread-safe.
1623
1624@item -fuse-cxa-atexit
1625@opindex fuse-cxa-atexit
1626Register destructors for objects with static storage duration with the
1627@code{__cxa_atexit} function rather than the @code{atexit} function.
1628This option is required for fully standards-compliant handling of static
1629destructors, but will only work if your C library supports
1630@code{__cxa_atexit}.
1631
1632@item -fno-use-cxa-get-exception-ptr
1633@opindex fno-use-cxa-get-exception-ptr
1634Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1635will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1636if the runtime routine is not available.
1637
1638@item -fvisibility-inlines-hidden
1639@opindex fvisibility-inlines-hidden
1640This switch declares that the user does not attempt to compare
1641pointers to inline methods where the addresses of the two functions
1642were taken in different shared objects.
1643
1644The effect of this is that GCC may, effectively, mark inline methods with
1645@code{__attribute__ ((visibility ("hidden")))} so that they do not
1646appear in the export table of a DSO and do not require a PLT indirection
1647when used within the DSO@.  Enabling this option can have a dramatic effect
1648on load and link times of a DSO as it massively reduces the size of the
1649dynamic export table when the library makes heavy use of templates.
1650
1651The behaviour of this switch is not quite the same as marking the
1652methods as hidden directly, because it does not affect static variables
1653local to the function or cause the compiler to deduce that
1654the function is defined in only one shared object.
1655
1656You may mark a method as having a visibility explicitly to negate the
1657effect of the switch for that method.  For example, if you do want to
1658compare pointers to a particular inline method, you might mark it as
1659having default visibility.  Marking the enclosing class with explicit
1660visibility will have no effect.
1661
1662Explicitly instantiated inline methods are unaffected by this option
1663as their linkage might otherwise cross a shared library boundary.
1664@xref{Template Instantiation}.
1665
1666@item -fno-weak
1667@opindex fno-weak
1668Do not use weak symbol support, even if it is provided by the linker.
1669By default, G++ will use weak symbols if they are available.  This
1670option exists only for testing, and should not be used by end-users;
1671it will result in inferior code and has no benefits.  This option may
1672be removed in a future release of G++.
1673
1674@item -nostdinc++
1675@opindex nostdinc++
1676Do not search for header files in the standard directories specific to
1677C++, but do still search the other standard directories.  (This option
1678is used when building the C++ library.)
1679@end table
1680
1681In addition, these optimization, warning, and code generation options
1682have meanings only for C++ programs:
1683
1684@table @gcctabopt
1685@item -fno-default-inline
1686@opindex fno-default-inline
1687Do not assume @samp{inline} for functions defined inside a class scope.
1688@xref{Optimize Options,,Options That Control Optimization}.  Note that these
1689functions will have linkage like inline functions; they just won't be
1690inlined by default.
1691
1692@item -Wabi @r{(C++ only)}
1693@opindex Wabi
1694Warn when G++ generates code that is probably not compatible with the
1695vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1696all such cases, there are probably some cases that are not warned about,
1697even though G++ is generating incompatible code.  There may also be
1698cases where warnings are emitted even though the code that is generated
1699will be compatible.
1700
1701You should rewrite your code to avoid these warnings if you are
1702concerned about the fact that code generated by G++ may not be binary
1703compatible with code generated by other compilers.
1704
1705The known incompatibilities at this point include:
1706
1707@itemize @bullet
1708
1709@item
1710Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1711pack data into the same byte as a base class.  For example:
1712
1713@smallexample
1714struct A @{ virtual void f(); int f1 : 1; @};
1715struct B : public A @{ int f2 : 1; @};
1716@end smallexample
1717
1718@noindent
1719In this case, G++ will place @code{B::f2} into the same byte
1720as@code{A::f1}; other compilers will not.  You can avoid this problem
1721by explicitly padding @code{A} so that its size is a multiple of the
1722byte size on your platform; that will cause G++ and other compilers to
1723layout @code{B} identically.
1724
1725@item
1726Incorrect handling of tail-padding for virtual bases.  G++ does not use
1727tail padding when laying out virtual bases.  For example:
1728
1729@smallexample
1730struct A @{ virtual void f(); char c1; @};
1731struct B @{ B(); char c2; @};
1732struct C : public A, public virtual B @{@};
1733@end smallexample
1734
1735@noindent
1736In this case, G++ will not place @code{B} into the tail-padding for
1737@code{A}; other compilers will.  You can avoid this problem by
1738explicitly padding @code{A} so that its size is a multiple of its
1739alignment (ignoring virtual base classes); that will cause G++ and other
1740compilers to layout @code{C} identically.
1741
1742@item
1743Incorrect handling of bit-fields with declared widths greater than that
1744of their underlying types, when the bit-fields appear in a union.  For
1745example:
1746
1747@smallexample
1748union U @{ int i : 4096; @};
1749@end smallexample
1750
1751@noindent
1752Assuming that an @code{int} does not have 4096 bits, G++ will make the
1753union too small by the number of bits in an @code{int}.
1754
1755@item
1756Empty classes can be placed at incorrect offsets.  For example:
1757
1758@smallexample
1759struct A @{@};
1760
1761struct B @{
1762  A a;
1763  virtual void f ();
1764@};
1765
1766struct C : public B, public A @{@};
1767@end smallexample
1768
1769@noindent
1770G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1771it should be placed at offset zero.  G++ mistakenly believes that the
1772@code{A} data member of @code{B} is already at offset zero.
1773
1774@item
1775Names of template functions whose types involve @code{typename} or
1776template template parameters can be mangled incorrectly.
1777
1778@smallexample
1779template <typename Q>
1780void f(typename Q::X) @{@}
1781
1782template <template <typename> class Q>
1783void f(typename Q<int>::X) @{@}
1784@end smallexample
1785
1786@noindent
1787Instantiations of these templates may be mangled incorrectly.
1788
1789@end itemize
1790
1791@item -Wctor-dtor-privacy @r{(C++ only)}
1792@opindex Wctor-dtor-privacy
1793Warn when a class seems unusable because all the constructors or
1794destructors in that class are private, and it has neither friends nor
1795public static member functions.
1796
1797@item -Wnon-virtual-dtor @r{(C++ only)}
1798@opindex Wnon-virtual-dtor
1799Warn when a class appears to be polymorphic, thereby requiring a virtual
1800destructor, yet it declares a non-virtual one.  This warning is also
1801enabled if -Weffc++ is specified.
1802
1803@item -Wreorder @r{(C++ only)}
1804@opindex Wreorder
1805@cindex reordering, warning
1806@cindex warning for reordering of member initializers
1807Warn when the order of member initializers given in the code does not
1808match the order in which they must be executed.  For instance:
1809
1810@smallexample
1811struct A @{
1812  int i;
1813  int j;
1814  A(): j (0), i (1) @{ @}
1815@};
1816@end smallexample
1817
1818The compiler will rearrange the member initializers for @samp{i}
1819and @samp{j} to match the declaration order of the members, emitting
1820a warning to that effect.  This warning is enabled by @option{-Wall}.
1821@end table
1822
1823The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1824
1825@table @gcctabopt
1826@item -Weffc++ @r{(C++ only)}
1827@opindex Weffc++
1828Warn about violations of the following style guidelines from Scott Meyers'
1829@cite{Effective C++} book:
1830
1831@itemize @bullet
1832@item
1833Item 11:  Define a copy constructor and an assignment operator for classes
1834with dynamically allocated memory.
1835
1836@item
1837Item 12:  Prefer initialization to assignment in constructors.
1838
1839@item
1840Item 14:  Make destructors virtual in base classes.
1841
1842@item
1843Item 15:  Have @code{operator=} return a reference to @code{*this}.
1844
1845@item
1846Item 23:  Don't try to return a reference when you must return an object.
1847
1848@end itemize
1849
1850Also warn about violations of the following style guidelines from
1851Scott Meyers' @cite{More Effective C++} book:
1852
1853@itemize @bullet
1854@item
1855Item 6:  Distinguish between prefix and postfix forms of increment and
1856decrement operators.
1857
1858@item
1859Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1860
1861@end itemize
1862
1863When selecting this option, be aware that the standard library
1864headers do not obey all of these guidelines; use @samp{grep -v}
1865to filter out those warnings.
1866
1867@item -Wno-deprecated @r{(C++ only)}
1868@opindex Wno-deprecated
1869Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1870
1871@item -Wstrict-null-sentinel @r{(C++ only)}
1872@opindex Wstrict-null-sentinel
1873Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1874compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1875to @code{__null}.  Although it is a null pointer constant not a null pointer,
1876it is guaranteed to of the same size as a pointer.  But this use is
1877not portable across different compilers.
1878
1879@item -Wno-non-template-friend @r{(C++ only)}
1880@opindex Wno-non-template-friend
1881Disable warnings when non-templatized friend functions are declared
1882within a template.  Since the advent of explicit template specification
1883support in G++, if the name of the friend is an unqualified-id (i.e.,
1884@samp{friend foo(int)}), the C++ language specification demands that the
1885friend declare or define an ordinary, nontemplate function.  (Section
188614.5.3).  Before G++ implemented explicit specification, unqualified-ids
1887could be interpreted as a particular specialization of a templatized
1888function.  Because this non-conforming behavior is no longer the default
1889behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1890check existing code for potential trouble spots and is on by default.
1891This new compiler behavior can be turned off with
1892@option{-Wno-non-template-friend} which keeps the conformant compiler code
1893but disables the helpful warning.
1894
1895@item -Wold-style-cast @r{(C++ only)}
1896@opindex Wold-style-cast
1897Warn if an old-style (C-style) cast to a non-void type is used within
1898a C++ program.  The new-style casts (@samp{dynamic_cast},
1899@samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1900less vulnerable to unintended effects and much easier to search for.
1901
1902@item -Woverloaded-virtual @r{(C++ only)}
1903@opindex Woverloaded-virtual
1904@cindex overloaded virtual fn, warning
1905@cindex warning for overloaded virtual fn
1906Warn when a function declaration hides virtual functions from a
1907base class.  For example, in:
1908
1909@smallexample
1910struct A @{
1911  virtual void f();
1912@};
1913
1914struct B: public A @{
1915  void f(int);
1916@};
1917@end smallexample
1918
1919the @code{A} class version of @code{f} is hidden in @code{B}, and code
1920like:
1921
1922@smallexample
1923B* b;
1924b->f();
1925@end smallexample
1926
1927will fail to compile.
1928
1929@item -Wno-pmf-conversions @r{(C++ only)}
1930@opindex Wno-pmf-conversions
1931Disable the diagnostic for converting a bound pointer to member function
1932to a plain pointer.
1933
1934@item -Wsign-promo @r{(C++ only)}
1935@opindex Wsign-promo
1936Warn when overload resolution chooses a promotion from unsigned or
1937enumerated type to a signed type, over a conversion to an unsigned type of
1938the same size.  Previous versions of G++ would try to preserve
1939unsignedness, but the standard mandates the current behavior.
1940
1941@smallexample
1942struct A @{
1943  operator int ();
1944  A& operator = (int);
1945@};
1946
1947main ()
1948@{
1949  A a,b;
1950  a = b;
1951@}
1952@end smallexample
1953
1954In this example, G++ will synthesize a default @samp{A& operator =
1955(const A&);}, while cfront will use the user-defined @samp{operator =}.
1956@end table
1957
1958@node Objective-C and Objective-C++ Dialect Options
1959@section Options Controlling Objective-C and Objective-C++ Dialects
1960
1961@cindex compiler options, Objective-C and Objective-C++
1962@cindex Objective-C and Objective-C++ options, command line
1963@cindex options, Objective-C and Objective-C++
1964(NOTE: This manual does not describe the Objective-C and Objective-C++
1965languages themselves.  See @xref{Standards,,Language Standards
1966Supported by GCC}, for references.)
1967
1968This section describes the command-line options that are only meaningful
1969for Objective-C and Objective-C++ programs, but you can also use most of
1970the language-independent GNU compiler options.
1971For example, you might compile a file @code{some_class.m} like this:
1972
1973@smallexample
1974gcc -g -fgnu-runtime -O -c some_class.m
1975@end smallexample
1976
1977@noindent
1978In this example, @option{-fgnu-runtime} is an option meant only for
1979Objective-C and Objective-C++ programs; you can use the other options with
1980any language supported by GCC@.
1981
1982Note that since Objective-C is an extension of the C language, Objective-C
1983compilations may also use options specific to the C front-end (e.g.,
1984@option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1985C++-specific options (e.g., @option{-Wabi}).
1986
1987Here is a list of options that are @emph{only} for compiling Objective-C
1988and Objective-C++ programs:
1989
1990@table @gcctabopt
1991@item -fconstant-string-class=@var{class-name}
1992@opindex fconstant-string-class
1993Use @var{class-name} as the name of the class to instantiate for each
1994literal string specified with the syntax @code{@@"@dots{}"}.  The default
1995class name is @code{NXConstantString} if the GNU runtime is being used, and
1996@code{NSConstantString} if the NeXT runtime is being used (see below).  The
1997@option{-fconstant-cfstrings} option, if also present, will override the
1998@option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1999to be laid out as constant CoreFoundation strings.
2000
2001@item -fgnu-runtime
2002@opindex fgnu-runtime
2003Generate object code compatible with the standard GNU Objective-C
2004runtime.  This is the default for most types of systems.
2005
2006@item -fnext-runtime
2007@opindex fnext-runtime
2008Generate output compatible with the NeXT runtime.  This is the default
2009for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2010@code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2011used.
2012
2013@item -fno-nil-receivers
2014@opindex fno-nil-receivers
2015Assume that all Objective-C message dispatches (e.g.,
2016@code{[receiver message:arg]}) in this translation unit ensure that the receiver
2017is not @code{nil}.  This allows for more efficient entry points in the runtime
2018to be used.  Currently, this option is only available in conjunction with
2019the NeXT runtime on Mac OS X 10.3 and later.
2020
2021@item -fobjc-call-cxx-cdtors
2022@opindex fobjc-call-cxx-cdtors
2023For each Objective-C class, check if any of its instance variables is a
2024C++ object with a non-trivial default constructor.  If so, synthesize a
2025special @code{- (id) .cxx_construct} instance method that will run
2026non-trivial default constructors on any such instance variables, in order,
2027and then return @code{self}.  Similarly, check if any instance variable
2028is a C++ object with a non-trivial destructor, and if so, synthesize a
2029special @code{- (void) .cxx_destruct} method that will run
2030all such default destructors, in reverse order.
2031
2032The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2033thusly generated will only operate on instance variables declared in the
2034current Objective-C class, and not those inherited from superclasses.  It
2035is the responsibility of the Objective-C runtime to invoke all such methods
2036in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2037will be invoked by the runtime immediately after a new object
2038instance is allocated; the @code{- (void) .cxx_destruct} methods will
2039be invoked immediately before the runtime deallocates an object instance.
2040
2041As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2042support for invoking the @code{- (id) .cxx_construct} and
2043@code{- (void) .cxx_destruct} methods.
2044
2045@item -fobjc-direct-dispatch
2046@opindex fobjc-direct-dispatch
2047Allow fast jumps to the message dispatcher.  On Darwin this is
2048accomplished via the comm page.
2049
2050@item -fobjc-exceptions
2051@opindex fobjc-exceptions
2052Enable syntactic support for structured exception handling in Objective-C,
2053similar to what is offered by C++ and Java.  This option is
2054unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2055earlier.
2056
2057@smallexample
2058  @@try @{
2059    @dots{}
2060       @@throw expr;
2061    @dots{}
2062  @}
2063  @@catch (AnObjCClass *exc) @{
2064    @dots{}
2065      @@throw expr;
2066    @dots{}
2067      @@throw;
2068    @dots{}
2069  @}
2070  @@catch (AnotherClass *exc) @{
2071    @dots{}
2072  @}
2073  @@catch (id allOthers) @{
2074    @dots{}
2075  @}
2076  @@finally @{
2077    @dots{}
2078      @@throw expr;
2079    @dots{}
2080  @}
2081@end smallexample
2082
2083The @code{@@throw} statement may appear anywhere in an Objective-C or
2084Objective-C++ program; when used inside of a @code{@@catch} block, the
2085@code{@@throw} may appear without an argument (as shown above), in which case
2086the object caught by the @code{@@catch} will be rethrown.
2087
2088Note that only (pointers to) Objective-C objects may be thrown and
2089caught using this scheme.  When an object is thrown, it will be caught
2090by the nearest @code{@@catch} clause capable of handling objects of that type,
2091analogously to how @code{catch} blocks work in C++ and Java.  A
2092@code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2093any and all Objective-C exceptions not caught by previous @code{@@catch}
2094clauses (if any).
2095
2096The @code{@@finally} clause, if present, will be executed upon exit from the
2097immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2098regardless of whether any exceptions are thrown, caught or rethrown
2099inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2100of the @code{finally} clause in Java.
2101
2102There are several caveats to using the new exception mechanism:
2103
2104@itemize @bullet
2105@item
2106Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2107idioms provided by the @code{NSException} class, the new
2108exceptions can only be used on Mac OS X 10.3 (Panther) and later
2109systems, due to additional functionality needed in the (NeXT) Objective-C
2110runtime.
2111
2112@item
2113As mentioned above, the new exceptions do not support handling
2114types other than Objective-C objects.   Furthermore, when used from
2115Objective-C++, the Objective-C exception model does not interoperate with C++
2116exceptions at this time.  This means you cannot @code{@@throw} an exception
2117from Objective-C and @code{catch} it in C++, or vice versa
2118(i.e., @code{throw @dots{} @@catch}).
2119@end itemize
2120
2121The @option{-fobjc-exceptions} switch also enables the use of synchronization
2122blocks for thread-safe execution:
2123
2124@smallexample
2125  @@synchronized (ObjCClass *guard) @{
2126    @dots{}
2127  @}
2128@end smallexample
2129
2130Upon entering the @code{@@synchronized} block, a thread of execution shall
2131first check whether a lock has been placed on the corresponding @code{guard}
2132object by another thread.  If it has, the current thread shall wait until
2133the other thread relinquishes its lock.  Once @code{guard} becomes available,
2134the current thread will place its own lock on it, execute the code contained in
2135the @code{@@synchronized} block, and finally relinquish the lock (thereby
2136making @code{guard} available to other threads).
2137
2138Unlike Java, Objective-C does not allow for entire methods to be marked
2139@code{@@synchronized}.  Note that throwing exceptions out of
2140@code{@@synchronized} blocks is allowed, and will cause the guarding object
2141to be unlocked properly.
2142
2143@item -fobjc-gc
2144@opindex fobjc-gc
2145Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2146
2147@item -freplace-objc-classes
2148@opindex freplace-objc-classes
2149Emit a special marker instructing @command{ld(1)} not to statically link in
2150the resulting object file, and allow @command{dyld(1)} to load it in at
2151run time instead.  This is used in conjunction with the Fix-and-Continue
2152debugging mode, where the object file in question may be recompiled and
2153dynamically reloaded in the course of program execution, without the need
2154to restart the program itself.  Currently, Fix-and-Continue functionality
2155is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2156and later.
2157
2158@item -fzero-link
2159@opindex fzero-link
2160When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2161to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2162compile time) with static class references that get initialized at load time,
2163which improves run-time performance.  Specifying the @option{-fzero-link} flag
2164suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2165to be retained.  This is useful in Zero-Link debugging mode, since it allows
2166for individual class implementations to be modified during program execution.
2167
2168@item -gen-decls
2169@opindex gen-decls
2170Dump interface declarations for all classes seen in the source file to a
2171file named @file{@var{sourcename}.decl}.
2172
2173@item -Wassign-intercept
2174@opindex Wassign-intercept
2175Warn whenever an Objective-C assignment is being intercepted by the
2176garbage collector.
2177
2178@item -Wno-protocol
2179@opindex Wno-protocol
2180If a class is declared to implement a protocol, a warning is issued for
2181every method in the protocol that is not implemented by the class.  The
2182default behavior is to issue a warning for every method not explicitly
2183implemented in the class, even if a method implementation is inherited
2184from the superclass.  If you use the @option{-Wno-protocol} option, then
2185methods inherited from the superclass are considered to be implemented,
2186and no warning is issued for them.
2187
2188@item -Wselector
2189@opindex Wselector
2190Warn if multiple methods of different types for the same selector are
2191found during compilation.  The check is performed on the list of methods
2192in the final stage of compilation.  Additionally, a check is performed
2193for each selector appearing in a @code{@@selector(@dots{})}
2194expression, and a corresponding method for that selector has been found
2195during compilation.  Because these checks scan the method table only at
2196the end of compilation, these warnings are not produced if the final
2197stage of compilation is not reached, for example because an error is
2198found during compilation, or because the @option{-fsyntax-only} option is
2199being used.
2200
2201@item -Wstrict-selector-match
2202@opindex Wstrict-selector-match
2203Warn if multiple methods with differing argument and/or return types are
2204found for a given selector when attempting to send a message using this
2205selector to a receiver of type @code{id} or @code{Class}.  When this flag
2206is off (which is the default behavior), the compiler will omit such warnings
2207if any differences found are confined to types which share the same size
2208and alignment.
2209
2210@item -Wundeclared-selector
2211@opindex Wundeclared-selector
2212Warn if a @code{@@selector(@dots{})} expression referring to an
2213undeclared selector is found.  A selector is considered undeclared if no
2214method with that name has been declared before the
2215@code{@@selector(@dots{})} expression, either explicitly in an
2216@code{@@interface} or @code{@@protocol} declaration, or implicitly in
2217an @code{@@implementation} section.  This option always performs its
2218checks as soon as a @code{@@selector(@dots{})} expression is found,
2219while @option{-Wselector} only performs its checks in the final stage of
2220compilation.  This also enforces the coding style convention
2221that methods and selectors must be declared before being used.
2222
2223@item -print-objc-runtime-info
2224@opindex print-objc-runtime-info
2225Generate C header describing the largest structure that is passed by
2226value, if any.
2227
2228@end table
2229
2230@node Language Independent Options
2231@section Options to Control Diagnostic Messages Formatting
2232@cindex options to control diagnostics formatting
2233@cindex diagnostic messages
2234@cindex message formatting
2235
2236Traditionally, diagnostic messages have been formatted irrespective of
2237the output device's aspect (e.g.@: its width, @dots{}).  The options described
2238below can be used to control the diagnostic messages formatting
2239algorithm, e.g.@: how many characters per line, how often source location
2240information should be reported.  Right now, only the C++ front end can
2241honor these options.  However it is expected, in the near future, that
2242the remaining front ends would be able to digest them correctly.
2243
2244@table @gcctabopt
2245@item -fmessage-length=@var{n}
2246@opindex fmessage-length
2247Try to format error messages so that they fit on lines of about @var{n}
2248characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2249the front ends supported by GCC@.  If @var{n} is zero, then no
2250line-wrapping will be done; each error message will appear on a single
2251line.
2252
2253@opindex fdiagnostics-show-location
2254@item -fdiagnostics-show-location=once
2255Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2256reporter to emit @emph{once} source location information; that is, in
2257case the message is too long to fit on a single physical line and has to
2258be wrapped, the source location won't be emitted (as prefix) again,
2259over and over, in subsequent continuation lines.  This is the default
2260behavior.
2261
2262@item -fdiagnostics-show-location=every-line
2263Only meaningful in line-wrapping mode.  Instructs the diagnostic
2264messages reporter to emit the same source location information (as
2265prefix) for physical lines that result from the process of breaking
2266a message which is too long to fit on a single line.
2267
2268@item -fdiagnostics-show-option
2269@opindex fdiagnostics-show-option
2270This option instructs the diagnostic machinery to add text to each
2271diagnostic emitted, which indicates which command line option directly
2272controls that diagnostic, when such an option is known to the
2273diagnostic machinery.
2274
2275@end table
2276
2277@node Warning Options
2278@section Options to Request or Suppress Warnings
2279@cindex options to control warnings
2280@cindex warning messages
2281@cindex messages, warning
2282@cindex suppressing warnings
2283
2284Warnings are diagnostic messages that report constructions which
2285are not inherently erroneous but which are risky or suggest there
2286may have been an error.
2287
2288You can request many specific warnings with options beginning @samp{-W},
2289for example @option{-Wimplicit} to request warnings on implicit
2290declarations.  Each of these specific warning options also has a
2291negative form beginning @samp{-Wno-} to turn off warnings;
2292for example, @option{-Wno-implicit}.  This manual lists only one of the
2293two forms, whichever is not the default.
2294
2295The following options control the amount and kinds of warnings produced
2296by GCC; for further, language-specific options also refer to
2297@ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2298Options}.
2299
2300@table @gcctabopt
2301@cindex syntax checking
2302@item -fsyntax-only
2303@opindex fsyntax-only
2304Check the code for syntax errors, but don't do anything beyond that.
2305
2306@item -pedantic
2307@opindex pedantic
2308Issue all the warnings demanded by strict ISO C and ISO C++;
2309reject all programs that use forbidden extensions, and some other
2310programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2311version of the ISO C standard specified by any @option{-std} option used.
2312
2313Valid ISO C and ISO C++ programs should compile properly with or without
2314this option (though a rare few will require @option{-ansi} or a
2315@option{-std} option specifying the required version of ISO C)@.  However,
2316without this option, certain GNU extensions and traditional C and C++
2317features are supported as well.  With this option, they are rejected.
2318
2319@option{-pedantic} does not cause warning messages for use of the
2320alternate keywords whose names begin and end with @samp{__}.  Pedantic
2321warnings are also disabled in the expression that follows
2322@code{__extension__}.  However, only system header files should use
2323these escape routes; application programs should avoid them.
2324@xref{Alternate Keywords}.
2325
2326Some users try to use @option{-pedantic} to check programs for strict ISO
2327C conformance.  They soon find that it does not do quite what they want:
2328it finds some non-ISO practices, but not all---only those for which
2329ISO C @emph{requires} a diagnostic, and some others for which
2330diagnostics have been added.
2331
2332A feature to report any failure to conform to ISO C might be useful in
2333some instances, but would require considerable additional work and would
2334be quite different from @option{-pedantic}.  We don't have plans to
2335support such a feature in the near future.
2336
2337Where the standard specified with @option{-std} represents a GNU
2338extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2339corresponding @dfn{base standard}, the version of ISO C on which the GNU
2340extended dialect is based.  Warnings from @option{-pedantic} are given
2341where they are required by the base standard.  (It would not make sense
2342for such warnings to be given only for features not in the specified GNU
2343C dialect, since by definition the GNU dialects of C include all
2344features the compiler supports with the given option, and there would be
2345nothing to warn about.)
2346
2347@item -pedantic-errors
2348@opindex pedantic-errors
2349Like @option{-pedantic}, except that errors are produced rather than
2350warnings.
2351
2352@item -w
2353@opindex w
2354Inhibit all warning messages.
2355
2356@item -Wno-import
2357@opindex Wno-import
2358Inhibit warning messages about the use of @samp{#import}.
2359
2360@item -Wchar-subscripts
2361@opindex Wchar-subscripts
2362Warn if an array subscript has type @code{char}.  This is a common cause
2363of error, as programmers often forget that this type is signed on some
2364machines.
2365This warning is enabled by @option{-Wall}.
2366
2367@item -Wcomment
2368@opindex Wcomment
2369Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2370comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2371This warning is enabled by @option{-Wall}.
2372
2373@item -Wfatal-errors
2374@opindex Wfatal-errors
2375This option causes the compiler to abort compilation on the first error
2376occurred rather than trying to keep going and printing further error
2377messages.
2378
2379@item -Wformat
2380@opindex Wformat
2381@opindex ffreestanding
2382@opindex fno-builtin
2383Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2384the arguments supplied have types appropriate to the format string
2385specified, and that the conversions specified in the format string make
2386sense.  This includes standard functions, and others specified by format
2387attributes (@pxref{Function Attributes}), in the @code{printf},
2388@code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2389not in the C standard) families (or other target-specific families).
2390Which functions are checked without format attributes having been
2391specified depends on the standard version selected, and such checks of
2392functions without the attribute specified are disabled by
2393@option{-ffreestanding} or @option{-fno-builtin}.
2394
2395The formats are checked against the format features supported by GNU
2396libc version 2.2.  These include all ISO C90 and C99 features, as well
2397as features from the Single Unix Specification and some BSD and GNU
2398extensions.  Other library implementations may not support all these
2399features; GCC does not support warning about features that go beyond a
2400particular library's limitations.  However, if @option{-pedantic} is used
2401with @option{-Wformat}, warnings will be given about format features not
2402in the selected standard version (but not for @code{strfmon} formats,
2403since those are not in any version of the C standard).  @xref{C Dialect
2404Options,,Options Controlling C Dialect}.
2405
2406Since @option{-Wformat} also checks for null format arguments for
2407several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2408
2409@option{-Wformat} is included in @option{-Wall}.  For more control over some
2410aspects of format checking, the options @option{-Wformat-y2k},
2411@option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2412@option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2413@option{-Wformat=2} are available, but are not included in @option{-Wall}.
2414
2415@item -Wformat-y2k
2416@opindex Wformat-y2k
2417If @option{-Wformat} is specified, also warn about @code{strftime}
2418formats which may yield only a two-digit year.
2419
2420@item -Wno-format-extra-args
2421@opindex Wno-format-extra-args
2422If @option{-Wformat} is specified, do not warn about excess arguments to a
2423@code{printf} or @code{scanf} format function.  The C standard specifies
2424that such arguments are ignored.
2425
2426Where the unused arguments lie between used arguments that are
2427specified with @samp{$} operand number specifications, normally
2428warnings are still given, since the implementation could not know what
2429type to pass to @code{va_arg} to skip the unused arguments.  However,
2430in the case of @code{scanf} formats, this option will suppress the
2431warning if the unused arguments are all pointers, since the Single
2432Unix Specification says that such unused arguments are allowed.
2433
2434@item -Wno-format-zero-length
2435@opindex Wno-format-zero-length
2436If @option{-Wformat} is specified, do not warn about zero-length formats.
2437The C standard specifies that zero-length formats are allowed.
2438
2439@item -Wformat-nonliteral
2440@opindex Wformat-nonliteral
2441If @option{-Wformat} is specified, also warn if the format string is not a
2442string literal and so cannot be checked, unless the format function
2443takes its format arguments as a @code{va_list}.
2444
2445@item -Wformat-security
2446@opindex Wformat-security
2447If @option{-Wformat} is specified, also warn about uses of format
2448functions that represent possible security problems.  At present, this
2449warns about calls to @code{printf} and @code{scanf} functions where the
2450format string is not a string literal and there are no format arguments,
2451as in @code{printf (foo);}.  This may be a security hole if the format
2452string came from untrusted input and contains @samp{%n}.  (This is
2453currently a subset of what @option{-Wformat-nonliteral} warns about, but
2454in future warnings may be added to @option{-Wformat-security} that are not
2455included in @option{-Wformat-nonliteral}.)
2456
2457@item -Wformat=2
2458@opindex Wformat=2
2459Enable @option{-Wformat} plus format checks not included in
2460@option{-Wformat}.  Currently equivalent to @samp{-Wformat
2461-Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2462
2463@item -Wnonnull
2464@opindex Wnonnull
2465Warn about passing a null pointer for arguments marked as
2466requiring a non-null value by the @code{nonnull} function attribute.
2467
2468@option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2469can be disabled with the @option{-Wno-nonnull} option.
2470
2471@item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2472@opindex Winit-self
2473Warn about uninitialized variables which are initialized with themselves.
2474Note this option can only be used with the @option{-Wuninitialized} option,
2475which in turn only works with @option{-O1} and above.
2476
2477For example, GCC will warn about @code{i} being uninitialized in the
2478following snippet only when @option{-Winit-self} has been specified:
2479@smallexample
2480@group
2481int f()
2482@{
2483  int i = i;
2484  return i;
2485@}
2486@end group
2487@end smallexample
2488
2489@item -Wimplicit-int
2490@opindex Wimplicit-int
2491Warn when a declaration does not specify a type.
2492This warning is enabled by @option{-Wall}.
2493
2494@item -Wimplicit-function-declaration
2495@itemx -Werror-implicit-function-declaration
2496@opindex Wimplicit-function-declaration
2497@opindex Werror-implicit-function-declaration
2498Give a warning (or error) whenever a function is used before being
2499declared.  The form @option{-Wno-error-implicit-function-declaration}
2500is not supported.
2501This warning is enabled by @option{-Wall} (as a warning, not an error).
2502
2503@item -Wimplicit
2504@opindex Wimplicit
2505Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2506This warning is enabled by @option{-Wall}.
2507
2508@item -Wmain
2509@opindex Wmain
2510Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2511function with external linkage, returning int, taking either zero
2512arguments, two, or three arguments of appropriate types.
2513This warning is enabled by @option{-Wall}.
2514
2515@item -Wmissing-braces
2516@opindex Wmissing-braces
2517Warn if an aggregate or union initializer is not fully bracketed.  In
2518the following example, the initializer for @samp{a} is not fully
2519bracketed, but that for @samp{b} is fully bracketed.
2520
2521@smallexample
2522int a[2][2] = @{ 0, 1, 2, 3 @};
2523int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2524@end smallexample
2525
2526This warning is enabled by @option{-Wall}.
2527
2528@item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2529@opindex Wmissing-include-dirs
2530Warn if a user-supplied include directory does not exist.
2531
2532@item -Wparentheses
2533@opindex Wparentheses
2534Warn if parentheses are omitted in certain contexts, such
2535as when there is an assignment in a context where a truth value
2536is expected, or when operators are nested whose precedence people
2537often get confused about.  Only the warning for an assignment used as
2538a truth value is supported when compiling C++; the other warnings are
2539only supported when compiling C@.
2540
2541Also warn if a comparison like @samp{x<=y<=z} appears; this is
2542equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2543interpretation from that of ordinary mathematical notation.
2544
2545Also warn about constructions where there may be confusion to which
2546@code{if} statement an @code{else} branch belongs.  Here is an example of
2547such a case:
2548
2549@smallexample
2550@group
2551@{
2552  if (a)
2553    if (b)
2554      foo ();
2555  else
2556    bar ();
2557@}
2558@end group
2559@end smallexample
2560
2561In C, every @code{else} branch belongs to the innermost possible @code{if}
2562statement, which in this example is @code{if (b)}.  This is often not
2563what the programmer expected, as illustrated in the above example by
2564indentation the programmer chose.  When there is the potential for this
2565confusion, GCC will issue a warning when this flag is specified.
2566To eliminate the warning, add explicit braces around the innermost
2567@code{if} statement so there is no way the @code{else} could belong to
2568the enclosing @code{if}.  The resulting code would look like this:
2569
2570@smallexample
2571@group
2572@{
2573  if (a)
2574    @{
2575      if (b)
2576        foo ();
2577      else
2578        bar ();
2579    @}
2580@}
2581@end group
2582@end smallexample
2583
2584This warning is enabled by @option{-Wall}.
2585
2586@item -Wsequence-point
2587@opindex Wsequence-point
2588Warn about code that may have undefined semantics because of violations
2589of sequence point rules in the C and C++ standards.
2590
2591The C and C++ standards defines the order in which expressions in a C/C++
2592program are evaluated in terms of @dfn{sequence points}, which represent
2593a partial ordering between the execution of parts of the program: those
2594executed before the sequence point, and those executed after it.  These
2595occur after the evaluation of a full expression (one which is not part
2596of a larger expression), after the evaluation of the first operand of a
2597@code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2598function is called (but after the evaluation of its arguments and the
2599expression denoting the called function), and in certain other places.
2600Other than as expressed by the sequence point rules, the order of
2601evaluation of subexpressions of an expression is not specified.  All
2602these rules describe only a partial order rather than a total order,
2603since, for example, if two functions are called within one expression
2604with no sequence point between them, the order in which the functions
2605are called is not specified.  However, the standards committee have
2606ruled that function calls do not overlap.
2607
2608It is not specified when between sequence points modifications to the
2609values of objects take effect.  Programs whose behavior depends on this
2610have undefined behavior; the C and C++ standards specify that ``Between
2611the previous and next sequence point an object shall have its stored
2612value modified at most once by the evaluation of an expression.
2613Furthermore, the prior value shall be read only to determine the value
2614to be stored.''.  If a program breaks these rules, the results on any
2615particular implementation are entirely unpredictable.
2616
2617Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2618= b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2619diagnosed by this option, and it may give an occasional false positive
2620result, but in general it has been found fairly effective at detecting
2621this sort of problem in programs.
2622
2623The standard is worded confusingly, therefore there is some debate
2624over the precise meaning of the sequence point rules in subtle cases.
2625Links to discussions of the problem, including proposed formal
2626definitions, may be found on the GCC readings page, at
2627@w{@uref{http://gcc.gnu.org/readings.html}}.
2628
2629This warning is enabled by @option{-Wall} for C and C++.
2630
2631@item -Wreturn-type
2632@opindex Wreturn-type
2633Warn whenever a function is defined with a return-type that defaults to
2634@code{int}.  Also warn about any @code{return} statement with no
2635return-value in a function whose return-type is not @code{void}.
2636
2637For C, also warn if the return type of a function has a type qualifier
2638such as @code{const}.  Such a type qualifier has no effect, since the
2639value returned by a function is not an lvalue.  ISO C prohibits
2640qualified @code{void} return types on function definitions, so such
2641return types always receive a warning even without this option.
2642
2643For C++, a function without return type always produces a diagnostic
2644message, even when @option{-Wno-return-type} is specified.  The only
2645exceptions are @samp{main} and functions defined in system headers.
2646
2647This warning is enabled by @option{-Wall}.
2648
2649@item -Wswitch
2650@opindex Wswitch
2651Warn whenever a @code{switch} statement has an index of enumerated type
2652and lacks a @code{case} for one or more of the named codes of that
2653enumeration.  (The presence of a @code{default} label prevents this
2654warning.)  @code{case} labels outside the enumeration range also
2655provoke warnings when this option is used.
2656This warning is enabled by @option{-Wall}.
2657
2658@item -Wswitch-default
2659@opindex Wswitch-switch
2660Warn whenever a @code{switch} statement does not have a @code{default}
2661case.
2662
2663@item -Wswitch-enum
2664@opindex Wswitch-enum
2665Warn whenever a @code{switch} statement has an index of enumerated type
2666and lacks a @code{case} for one or more of the named codes of that
2667enumeration.  @code{case} labels outside the enumeration range also
2668provoke warnings when this option is used.
2669
2670@item -Wtrigraphs
2671@opindex Wtrigraphs
2672Warn if any trigraphs are encountered that might change the meaning of
2673the program (trigraphs within comments are not warned about).
2674This warning is enabled by @option{-Wall}.
2675
2676@item -Wunused-function
2677@opindex Wunused-function
2678Warn whenever a static function is declared but not defined or a
2679non-inline static function is unused.
2680This warning is enabled by @option{-Wall}.
2681
2682@item -Wunused-label
2683@opindex Wunused-label
2684Warn whenever a label is declared but not used.
2685This warning is enabled by @option{-Wall}.
2686
2687To suppress this warning use the @samp{unused} attribute
2688(@pxref{Variable Attributes}).
2689
2690@item -Wunused-parameter
2691@opindex Wunused-parameter
2692Warn whenever a function parameter is unused aside from its declaration.
2693
2694To suppress this warning use the @samp{unused} attribute
2695(@pxref{Variable Attributes}).
2696
2697@item -Wunused-variable
2698@opindex Wunused-variable
2699Warn whenever a local variable or non-constant static variable is unused
2700aside from its declaration.
2701This warning is enabled by @option{-Wall}.
2702
2703To suppress this warning use the @samp{unused} attribute
2704(@pxref{Variable Attributes}).
2705
2706@item -Wunused-value
2707@opindex Wunused-value
2708Warn whenever a statement computes a result that is explicitly not used.
2709This warning is enabled by @option{-Wall}.
2710
2711To suppress this warning cast the expression to @samp{void}.
2712
2713@item -Wunused
2714@opindex Wunused
2715All the above @option{-Wunused} options combined.
2716
2717In order to get a warning about an unused function parameter, you must
2718either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2719@samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2720
2721@item -Wuninitialized
2722@opindex Wuninitialized
2723Warn if an automatic variable is used without first being initialized or
2724if a variable may be clobbered by a @code{setjmp} call.
2725
2726These warnings are possible only in optimizing compilation,
2727because they require data flow information that is computed only
2728when optimizing.  If you do not specify @option{-O}, you will not get
2729these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2730requiring @option{-O}.
2731
2732If you want to warn about code which uses the uninitialized value of the
2733variable in its own initializer, use the @option{-Winit-self} option.
2734
2735These warnings occur for individual uninitialized or clobbered
2736elements of structure, union or array variables as well as for
2737variables which are uninitialized or clobbered as a whole.  They do
2738not occur for variables or elements declared @code{volatile}.  Because
2739these warnings depend on optimization, the exact variables or elements
2740for which there are warnings will depend on the precise optimization
2741options and version of GCC used.
2742
2743Note that there may be no warning about a variable that is used only
2744to compute a value that itself is never used, because such
2745computations may be deleted by data flow analysis before the warnings
2746are printed.
2747
2748These warnings are made optional because GCC is not smart
2749enough to see all the reasons why the code might be correct
2750despite appearing to have an error.  Here is one example of how
2751this can happen:
2752
2753@smallexample
2754@group
2755@{
2756  int x;
2757  switch (y)
2758    @{
2759    case 1: x = 1;
2760      break;
2761    case 2: x = 4;
2762      break;
2763    case 3: x = 5;
2764    @}
2765  foo (x);
2766@}
2767@end group
2768@end smallexample
2769
2770@noindent
2771If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2772always initialized, but GCC doesn't know this.  Here is
2773another common case:
2774
2775@smallexample
2776@{
2777  int save_y;
2778  if (change_y) save_y = y, y = new_y;
2779  @dots{}
2780  if (change_y) y = save_y;
2781@}
2782@end smallexample
2783
2784@noindent
2785This has no bug because @code{save_y} is used only if it is set.
2786
2787@cindex @code{longjmp} warnings
2788This option also warns when a non-volatile automatic variable might be
2789changed by a call to @code{longjmp}.  These warnings as well are possible
2790only in optimizing compilation.
2791
2792The compiler sees only the calls to @code{setjmp}.  It cannot know
2793where @code{longjmp} will be called; in fact, a signal handler could
2794call it at any point in the code.  As a result, you may get a warning
2795even when there is in fact no problem because @code{longjmp} cannot
2796in fact be called at the place which would cause a problem.
2797
2798Some spurious warnings can be avoided if you declare all the functions
2799you use that never return as @code{noreturn}.  @xref{Function
2800Attributes}.
2801
2802This warning is enabled by @option{-Wall}.
2803
2804@item -Wunknown-pragmas
2805@opindex Wunknown-pragmas
2806@cindex warning for unknown pragmas
2807@cindex unknown pragmas, warning
2808@cindex pragmas, warning of unknown
2809Warn when a #pragma directive is encountered which is not understood by
2810GCC@.  If this command line option is used, warnings will even be issued
2811for unknown pragmas in system header files.  This is not the case if
2812the warnings were only enabled by the @option{-Wall} command line option.
2813
2814@item -Wno-pragmas
2815@opindex Wno-pragmas
2816@opindex Wpragmas
2817Do not warn about misuses of pragmas, such as incorrect parameters,
2818invalid syntax, or conflicts between pragmas.  See also
2819@samp{-Wunknown-pragmas}.
2820
2821@item -Wstrict-aliasing
2822@opindex Wstrict-aliasing
2823This option is only active when @option{-fstrict-aliasing} is active.
2824It warns about code which might break the strict aliasing rules that the
2825compiler is using for optimization.  The warning does not catch all
2826cases, but does attempt to catch the more common pitfalls.  It is
2827included in @option{-Wall}.
2828
2829@item -Wstrict-aliasing=2
2830@opindex Wstrict-aliasing=2
2831This option is only active when @option{-fstrict-aliasing} is active.
2832It warns about code which might break the strict aliasing rules that the
2833compiler is using for optimization.  This warning catches more cases than
2834@option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2835cases that are safe.
2836
2837@item -Wstrict-overflow
2838@item -Wstrict-overflow=@var{n}
2839@opindex Wstrict-overflow
2840This option is only active when @option{-fstrict-overflow} is active.
2841It warns about cases where the compiler optimizes based on the
2842assumption that signed overflow does not occur.  Note that it does not
2843warn about all cases where the code might overflow: it only warns
2844about cases where the compiler implements some optimization.  Thus
2845this warning depends on the optimization level.
2846
2847An optimization which assumes that signed overflow does not occur is
2848perfectly safe if the values of the variables involved are such that
2849overflow never does, in fact, occur.  Therefore this warning can
2850easily give a false positive: a warning about code which is not
2851actually a problem.  To help focus on important issues, several
2852warning levels are defined.  No warnings are issued for the use of
2853undefined signed overflow when estimating how many iterations a loop
2854will require, in particular when determining whether a loop will be
2855executed at all.
2856
2857@table @option
2858@item -Wstrict-overflow=1
2859Warn about cases which are both questionable and easy to avoid.  For
2860example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
2861compiler will simplify this to @code{1}.  This level of
2862@option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
2863are not, and must be explicitly requested.
2864
2865@item -Wstrict-overflow=2
2866Also warn about other cases where a comparison is simplified to a
2867constant.  For example: @code{abs (x) >= 0}.  This can only be
2868simplified when @option{-fstrict-overflow} is in effect, because
2869@code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
2870zero.  @option{-Wstrict-overflow} (with no level) is the same as
2871@option{-Wstrict-overflow=2}.
2872
2873@item -Wstrict-overflow=3
2874Also warn about other cases where a comparison is simplified.  For
2875example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
2876
2877@item -Wstrict-overflow=4
2878Also warn about other simplifications not covered by the above cases.
2879For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
2880
2881@item -Wstrict-overflow=5
2882Also warn about cases where the compiler reduces the magnitude of a
2883constant involved in a comparison.  For example: @code{x + 2 > y} will
2884be simplified to @code{x + 1 >= y}.  This is reported only at the
2885highest warning level because this simplification applies to many
2886comparisons, so this warning level will give a very large number of
2887false positives.
2888@end table
2889
2890@item -Wall
2891@opindex Wall
2892All of the above @samp{-W} options combined.  This enables all the
2893warnings about constructions that some users consider questionable, and
2894that are easy to avoid (or modify to prevent the warning), even in
2895conjunction with macros.  This also enables some language-specific
2896warnings described in @ref{C++ Dialect Options} and
2897@ref{Objective-C and Objective-C++ Dialect Options}.
2898@end table
2899
2900The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2901Some of them warn about constructions that users generally do not
2902consider questionable, but which occasionally you might wish to check
2903for; others warn about constructions that are necessary or hard to avoid
2904in some cases, and there is no simple way to modify the code to suppress
2905the warning.
2906
2907@table @gcctabopt
2908@item -Wextra
2909@opindex W
2910@opindex Wextra
2911(This option used to be called @option{-W}.  The older name is still
2912supported, but the newer name is more descriptive.)  Print extra warning
2913messages for these events:
2914
2915@itemize @bullet
2916@item
2917A function can return either with or without a value.  (Falling
2918off the end of the function body is considered returning without
2919a value.)  For example, this function would evoke such a
2920warning:
2921
2922@smallexample
2923@group
2924foo (a)
2925@{
2926  if (a > 0)
2927    return a;
2928@}
2929@end group
2930@end smallexample
2931
2932@item
2933An expression-statement or the left-hand side of a comma expression
2934contains no side effects.
2935To suppress the warning, cast the unused expression to void.
2936For example, an expression such as @samp{x[i,j]} will cause a warning,
2937but @samp{x[(void)i,j]} will not.
2938
2939@item
2940An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2941
2942@item
2943Storage-class specifiers like @code{static} are not the first things in
2944a declaration.  According to the C Standard, this usage is obsolescent.
2945
2946@item
2947If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2948arguments.
2949
2950@item
2951A comparison between signed and unsigned values could produce an
2952incorrect result when the signed value is converted to unsigned.
2953(But don't warn if @option{-Wno-sign-compare} is also specified.)
2954
2955@item
2956An aggregate has an initializer which does not initialize all members.
2957This warning can be independently controlled by
2958@option{-Wmissing-field-initializers}.
2959
2960@item
2961An initialized field without side effects is overridden when using
2962designated initializers (@pxref{Designated Inits, , Designated
2963Initializers}).  This warning can be independently controlled by
2964@option{-Woverride-init}.
2965
2966@item
2967A function parameter is declared without a type specifier in K&R-style
2968functions:
2969
2970@smallexample
2971void foo(bar) @{ @}
2972@end smallexample
2973
2974@item
2975An empty body occurs in an @samp{if} or @samp{else} statement.
2976
2977@item
2978A pointer is compared against integer zero with @samp{<}, @samp{<=},
2979@samp{>}, or @samp{>=}.
2980
2981@item
2982A variable might be changed by @samp{longjmp} or @samp{vfork}.
2983
2984@item @r{(C++ only)}
2985An enumerator and a non-enumerator both appear in a conditional expression.
2986
2987@item @r{(C++ only)}
2988A non-static reference or non-static @samp{const} member appears in a
2989class without constructors.
2990
2991@item @r{(C++ only)}
2992Ambiguous virtual bases.
2993
2994@item @r{(C++ only)}
2995Subscripting an array which has been declared @samp{register}.
2996
2997@item @r{(C++ only)}
2998Taking the address of a variable which has been declared @samp{register}.
2999
3000@item @r{(C++ only)}
3001A base class is not initialized in a derived class' copy constructor.
3002@end itemize
3003
3004@item -Wno-div-by-zero
3005@opindex Wno-div-by-zero
3006@opindex Wdiv-by-zero
3007Do not warn about compile-time integer division by zero.  Floating point
3008division by zero is not warned about, as it can be a legitimate way of
3009obtaining infinities and NaNs.
3010
3011@item -Wsystem-headers
3012@opindex Wsystem-headers
3013@cindex warnings from system headers
3014@cindex system headers, warnings from
3015Print warning messages for constructs found in system header files.
3016Warnings from system headers are normally suppressed, on the assumption
3017that they usually do not indicate real problems and would only make the
3018compiler output harder to read.  Using this command line option tells
3019GCC to emit warnings from system headers as if they occurred in user
3020code.  However, note that using @option{-Wall} in conjunction with this
3021option will @emph{not} warn about unknown pragmas in system
3022headers---for that, @option{-Wunknown-pragmas} must also be used.
3023
3024@item -Wfloat-equal
3025@opindex Wfloat-equal
3026Warn if floating point values are used in equality comparisons.
3027
3028The idea behind this is that sometimes it is convenient (for the
3029programmer) to consider floating-point values as approximations to
3030infinitely precise real numbers.  If you are doing this, then you need
3031to compute (by analyzing the code, or in some other way) the maximum or
3032likely maximum error that the computation introduces, and allow for it
3033when performing comparisons (and when producing output, but that's a
3034different problem).  In particular, instead of testing for equality, you
3035would check to see whether the two values have ranges that overlap; and
3036this is done with the relational operators, so equality comparisons are
3037probably mistaken.
3038
3039@item -Wtraditional @r{(C only)}
3040@opindex Wtraditional
3041Warn about certain constructs that behave differently in traditional and
3042ISO C@.  Also warn about ISO C constructs that have no traditional C
3043equivalent, and/or problematic constructs which should be avoided.
3044
3045@itemize @bullet
3046@item
3047Macro parameters that appear within string literals in the macro body.
3048In traditional C macro replacement takes place within string literals,
3049but does not in ISO C@.
3050
3051@item
3052In traditional C, some preprocessor directives did not exist.
3053Traditional preprocessors would only consider a line to be a directive
3054if the @samp{#} appeared in column 1 on the line.  Therefore
3055@option{-Wtraditional} warns about directives that traditional C
3056understands but would ignore because the @samp{#} does not appear as the
3057first character on the line.  It also suggests you hide directives like
3058@samp{#pragma} not understood by traditional C by indenting them.  Some
3059traditional implementations would not recognize @samp{#elif}, so it
3060suggests avoiding it altogether.
3061
3062@item
3063A function-like macro that appears without arguments.
3064
3065@item
3066The unary plus operator.
3067
3068@item
3069The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3070constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3071constants.)  Note, these suffixes appear in macros defined in the system
3072headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3073Use of these macros in user code might normally lead to spurious
3074warnings, however GCC's integrated preprocessor has enough context to
3075avoid warning in these cases.
3076
3077@item
3078A function declared external in one block and then used after the end of
3079the block.
3080
3081@item
3082A @code{switch} statement has an operand of type @code{long}.
3083
3084@item
3085A non-@code{static} function declaration follows a @code{static} one.
3086This construct is not accepted by some traditional C compilers.
3087
3088@item
3089The ISO type of an integer constant has a different width or
3090signedness from its traditional type.  This warning is only issued if
3091the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3092typically represent bit patterns, are not warned about.
3093
3094@item
3095Usage of ISO string concatenation is detected.
3096
3097@item
3098Initialization of automatic aggregates.
3099
3100@item
3101Identifier conflicts with labels.  Traditional C lacks a separate
3102namespace for labels.
3103
3104@item
3105Initialization of unions.  If the initializer is zero, the warning is
3106omitted.  This is done under the assumption that the zero initializer in
3107user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3108initializer warnings and relies on default initialization to zero in the
3109traditional C case.
3110
3111@item
3112Conversions by prototypes between fixed/floating point values and vice
3113versa.  The absence of these prototypes when compiling with traditional
3114C would cause serious problems.  This is a subset of the possible
3115conversion warnings, for the full set use @option{-Wconversion}.
3116
3117@item
3118Use of ISO C style function definitions.  This warning intentionally is
3119@emph{not} issued for prototype declarations or variadic functions
3120because these ISO C features will appear in your code when using
3121libiberty's traditional C compatibility macros, @code{PARAMS} and
3122@code{VPARAMS}.  This warning is also bypassed for nested functions
3123because that feature is already a GCC extension and thus not relevant to
3124traditional C compatibility.
3125@end itemize
3126
3127@item -Wdeclaration-after-statement @r{(C only)}
3128@opindex Wdeclaration-after-statement
3129Warn when a declaration is found after a statement in a block.  This
3130construct, known from C++, was introduced with ISO C99 and is by default
3131allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3132GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3133
3134@item -Wundef
3135@opindex Wundef
3136Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3137
3138@item -Wno-endif-labels
3139@opindex Wno-endif-labels
3140@opindex Wendif-labels
3141Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3142
3143@item -Wshadow
3144@opindex Wshadow
3145Warn whenever a local variable shadows another local variable, parameter or
3146global variable or whenever a built-in function is shadowed.
3147
3148@item -Wlarger-than-@var{len}
3149@opindex Wlarger-than
3150Warn whenever an object of larger than @var{len} bytes is defined.
3151
3152@item -Wunsafe-loop-optimizations
3153@opindex Wunsafe-loop-optimizations
3154Warn if the loop cannot be optimized because the compiler could not
3155assume anything on the bounds of the loop indices.  With
3156@option{-funsafe-loop-optimizations} warn if the compiler made
3157such assumptions.
3158
3159@item -Wpointer-arith
3160@opindex Wpointer-arith
3161Warn about anything that depends on the ``size of'' a function type or
3162of @code{void}.  GNU C assigns these types a size of 1, for
3163convenience in calculations with @code{void *} pointers and pointers
3164to functions.
3165
3166@item -Wbad-function-cast @r{(C only)}
3167@opindex Wbad-function-cast
3168Warn whenever a function call is cast to a non-matching type.
3169For example, warn if @code{int malloc()} is cast to @code{anything *}.
3170
3171@item -Wc++-compat
3172Warn about ISO C constructs that are outside of the common subset of
3173ISO C and ISO C++, e.g.@: request for implicit conversion from
3174@code{void *} to a pointer to non-@code{void} type.
3175
3176@item -Wcast-qual
3177@opindex Wcast-qual
3178Warn whenever a pointer is cast so as to remove a type qualifier from
3179the target type.  For example, warn if a @code{const char *} is cast
3180to an ordinary @code{char *}.
3181
3182@item -Wcast-align
3183@opindex Wcast-align
3184Warn whenever a pointer is cast such that the required alignment of the
3185target is increased.  For example, warn if a @code{char *} is cast to
3186an @code{int *} on machines where integers can only be accessed at
3187two- or four-byte boundaries.
3188
3189@item -Wwrite-strings
3190@opindex Wwrite-strings
3191When compiling C, give string constants the type @code{const
3192char[@var{length}]} so that
3193copying the address of one into a non-@code{const} @code{char *}
3194pointer will get a warning; when compiling C++, warn about the
3195deprecated conversion from string literals to @code{char *}.  This
3196warning, by default, is enabled for C++ programs.
3197These warnings will help you find at
3198compile time code that can try to write into a string constant, but
3199only if you have been very careful about using @code{const} in
3200declarations and prototypes.  Otherwise, it will just be a nuisance;
3201this is why we did not make @option{-Wall} request these warnings.
3202
3203@item -Wconversion
3204@opindex Wconversion
3205Warn if a prototype causes a type conversion that is different from what
3206would happen to the same argument in the absence of a prototype.  This
3207includes conversions of fixed point to floating and vice versa, and
3208conversions changing the width or signedness of a fixed point argument
3209except when the same as the default promotion.
3210
3211Also, warn if a negative integer constant expression is implicitly
3212converted to an unsigned type.  For example, warn about the assignment
3213@code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3214casts like @code{(unsigned) -1}.
3215
3216@item -Wsign-compare
3217@opindex Wsign-compare
3218@cindex warning for comparison of signed and unsigned values
3219@cindex comparison of signed and unsigned values, warning
3220@cindex signed and unsigned values, comparison warning
3221Warn when a comparison between signed and unsigned values could produce
3222an incorrect result when the signed value is converted to unsigned.
3223This warning is also enabled by @option{-Wextra}; to get the other warnings
3224of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3225
3226@item -Waddress
3227@opindex Waddress
3228@opindex Wno-address
3229Warn about suspicious uses of memory addresses. These include using
3230the address of a function in a conditional expression, such as
3231@code{void func(void); if (func)}, and comparisons against the memory
3232address of a string literal, such as @code{if (x == "abc")}.  Such
3233uses typically indicate a programmer error: the address of a function
3234always evaluates to true, so their use in a conditional usually
3235indicate that the programmer forgot the parentheses in a function
3236call; and comparisons against string literals result in unspecified
3237behavior and are not portable in C, so they usually indicate that the
3238programmer intended to use @code{strcmp}.  This warning is enabled by
3239@option{-Wall}.
3240
3241@item -Waggregate-return
3242@opindex Waggregate-return
3243Warn if any functions that return structures or unions are defined or
3244called.  (In languages where you can return an array, this also elicits
3245a warning.)
3246
3247@item -Wno-attributes
3248@opindex Wno-attributes
3249@opindex Wattributes
3250Do not warn if an unexpected @code{__attribute__} is used, such as
3251unrecognized attributes, function attributes applied to variables,
3252etc.  This will not stop errors for incorrect use of supported
3253attributes.
3254
3255@item -Wstrict-prototypes @r{(C only)}
3256@opindex Wstrict-prototypes
3257Warn if a function is declared or defined without specifying the
3258argument types.  (An old-style function definition is permitted without
3259a warning if preceded by a declaration which specifies the argument
3260types.)
3261
3262@item -Wold-style-definition @r{(C only)}
3263@opindex Wold-style-definition
3264Warn if an old-style function definition is used.  A warning is given
3265even if there is a previous prototype.
3266
3267@item -Wmissing-prototypes @r{(C only)}
3268@opindex Wmissing-prototypes
3269Warn if a global function is defined without a previous prototype
3270declaration.  This warning is issued even if the definition itself
3271provides a prototype.  The aim is to detect global functions that fail
3272to be declared in header files.
3273
3274@item -Wmissing-declarations @r{(C only)}
3275@opindex Wmissing-declarations
3276Warn if a global function is defined without a previous declaration.
3277Do so even if the definition itself provides a prototype.
3278Use this option to detect global functions that are not declared in
3279header files.
3280
3281@item -Wmissing-field-initializers
3282@opindex Wmissing-field-initializers
3283@opindex W
3284@opindex Wextra
3285Warn if a structure's initializer has some fields missing.  For
3286example, the following code would cause such a warning, because
3287@code{x.h} is implicitly zero:
3288
3289@smallexample
3290struct s @{ int f, g, h; @};
3291struct s x = @{ 3, 4 @};
3292@end smallexample
3293
3294This option does not warn about designated initializers, so the following
3295modification would not trigger a warning:
3296
3297@smallexample
3298struct s @{ int f, g, h; @};
3299struct s x = @{ .f = 3, .g = 4 @};
3300@end smallexample
3301
3302This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3303warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3304
3305@item -Wmissing-noreturn
3306@opindex Wmissing-noreturn
3307Warn about functions which might be candidates for attribute @code{noreturn}.
3308Note these are only possible candidates, not absolute ones.  Care should
3309be taken to manually verify functions actually do not ever return before
3310adding the @code{noreturn} attribute, otherwise subtle code generation
3311bugs could be introduced.  You will not get a warning for @code{main} in
3312hosted C environments.
3313
3314@item -Wmissing-format-attribute
3315@opindex Wmissing-format-attribute
3316@opindex Wformat
3317Warn about function pointers which might be candidates for @code{format}
3318attributes.  Note these are only possible candidates, not absolute ones.
3319GCC will guess that function pointers with @code{format} attributes that
3320are used in assignment, initialization, parameter passing or return
3321statements should have a corresponding @code{format} attribute in the
3322resulting type.  I.e.@: the left-hand side of the assignment or
3323initialization, the type of the parameter variable, or the return type
3324of the containing function respectively should also have a @code{format}
3325attribute to avoid the warning.
3326
3327GCC will also warn about function definitions which might be
3328candidates for @code{format} attributes.  Again, these are only
3329possible candidates.  GCC will guess that @code{format} attributes
3330might be appropriate for any function that calls a function like
3331@code{vprintf} or @code{vscanf}, but this might not always be the
3332case, and some functions for which @code{format} attributes are
3333appropriate may not be detected.
3334
3335@item -Wno-multichar
3336@opindex Wno-multichar
3337@opindex Wmultichar
3338Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3339Usually they indicate a typo in the user's code, as they have
3340implementation-defined values, and should not be used in portable code.
3341
3342@item -Wnormalized=<none|id|nfc|nfkc>
3343@opindex Wnormalized
3344@cindex NFC
3345@cindex NFKC
3346@cindex character set, input normalization
3347In ISO C and ISO C++, two identifiers are different if they are
3348different sequences of characters.  However, sometimes when characters
3349outside the basic ASCII character set are used, you can have two
3350different character sequences that look the same.  To avoid confusion,
3351the ISO 10646 standard sets out some @dfn{normalization rules} which
3352when applied ensure that two sequences that look the same are turned into
3353the same sequence.  GCC can warn you if you are using identifiers which
3354have not been normalized; this option controls that warning.
3355
3356There are four levels of warning that GCC supports.  The default is
3357@option{-Wnormalized=nfc}, which warns about any identifier which is
3358not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3359recommended form for most uses.
3360
3361Unfortunately, there are some characters which ISO C and ISO C++ allow
3362in identifiers that when turned into NFC aren't allowable as
3363identifiers.  That is, there's no way to use these symbols in portable
3364ISO C or C++ and have all your identifiers in NFC.
3365@option{-Wnormalized=id} suppresses the warning for these characters.
3366It is hoped that future versions of the standards involved will correct
3367this, which is why this option is not the default.
3368
3369You can switch the warning off for all characters by writing
3370@option{-Wnormalized=none}.  You would only want to do this if you
3371were using some other normalization scheme (like ``D''), because
3372otherwise you can easily create bugs that are literally impossible to see.
3373
3374Some characters in ISO 10646 have distinct meanings but look identical
3375in some fonts or display methodologies, especially once formatting has
3376been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3377LETTER N'', will display just like a regular @code{n} which has been
3378placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3379normalization scheme to convert all these into a standard form as
3380well, and GCC will warn if your code is not in NFKC if you use
3381@option{-Wnormalized=nfkc}.  This warning is comparable to warning
3382about every identifier that contains the letter O because it might be
3383confused with the digit 0, and so is not the default, but may be
3384useful as a local coding convention if the programming environment is
3385unable to be fixed to display these characters distinctly.
3386
3387@item -Wno-deprecated-declarations
3388@opindex Wno-deprecated-declarations
3389Do not warn about uses of functions (@pxref{Function Attributes}),
3390variables (@pxref{Variable Attributes}), and types (@pxref{Type
3391Attributes}) marked as deprecated by using the @code{deprecated}
3392attribute.
3393
3394@item -Wno-overflow
3395@opindex Wno-overflow
3396Do not warn about compile-time overflow in constant expressions.
3397
3398@item -Woverride-init
3399@opindex Woverride-init
3400@opindex W
3401@opindex Wextra
3402Warn if an initialized field without side effects is overridden when
3403using designated initializers (@pxref{Designated Inits, , Designated
3404Initializers}).
3405
3406This warning is included in @option{-Wextra}.  To get other
3407@option{-Wextra} warnings without this one, use @samp{-Wextra
3408-Wno-override-init}.
3409
3410@item -Wpacked
3411@opindex Wpacked
3412Warn if a structure is given the packed attribute, but the packed
3413attribute has no effect on the layout or size of the structure.
3414Such structures may be mis-aligned for little benefit.  For
3415instance, in this code, the variable @code{f.x} in @code{struct bar}
3416will be misaligned even though @code{struct bar} does not itself
3417have the packed attribute:
3418
3419@smallexample
3420@group
3421struct foo @{
3422  int x;
3423  char a, b, c, d;
3424@} __attribute__((packed));
3425struct bar @{
3426  char z;
3427  struct foo f;
3428@};
3429@end group
3430@end smallexample
3431
3432@item -Wpadded
3433@opindex Wpadded
3434Warn if padding is included in a structure, either to align an element
3435of the structure or to align the whole structure.  Sometimes when this
3436happens it is possible to rearrange the fields of the structure to
3437reduce the padding and so make the structure smaller.
3438
3439@item -Wredundant-decls
3440@opindex Wredundant-decls
3441Warn if anything is declared more than once in the same scope, even in
3442cases where multiple declaration is valid and changes nothing.
3443
3444@item -Wnested-externs @r{(C only)}
3445@opindex Wnested-externs
3446Warn if an @code{extern} declaration is encountered within a function.
3447
3448@item -Wunreachable-code
3449@opindex Wunreachable-code
3450Warn if the compiler detects that code will never be executed.
3451
3452This option is intended to warn when the compiler detects that at
3453least a whole line of source code will never be executed, because
3454some condition is never satisfied or because it is after a
3455procedure that never returns.
3456
3457It is possible for this option to produce a warning even though there
3458are circumstances under which part of the affected line can be executed,
3459so care should be taken when removing apparently-unreachable code.
3460
3461For instance, when a function is inlined, a warning may mean that the
3462line is unreachable in only one inlined copy of the function.
3463
3464This option is not made part of @option{-Wall} because in a debugging
3465version of a program there is often substantial code which checks
3466correct functioning of the program and is, hopefully, unreachable
3467because the program does work.  Another common use of unreachable
3468code is to provide behavior which is selectable at compile-time.
3469
3470@item -Winline
3471@opindex Winline
3472Warn if a function can not be inlined and it was declared as inline.
3473Even with this option, the compiler will not warn about failures to
3474inline functions declared in system headers.
3475
3476The compiler uses a variety of heuristics to determine whether or not
3477to inline a function.  For example, the compiler takes into account
3478the size of the function being inlined and the amount of inlining
3479that has already been done in the current function.  Therefore,
3480seemingly insignificant changes in the source program can cause the
3481warnings produced by @option{-Winline} to appear or disappear.
3482
3483@item -Wno-invalid-offsetof @r{(C++ only)}
3484@opindex Wno-invalid-offsetof
3485Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3486type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3487to a non-POD type is undefined.  In existing C++ implementations,
3488however, @samp{offsetof} typically gives meaningful results even when
3489applied to certain kinds of non-POD types. (Such as a simple
3490@samp{struct} that fails to be a POD type only by virtue of having a
3491constructor.)  This flag is for users who are aware that they are
3492writing nonportable code and who have deliberately chosen to ignore the
3493warning about it.
3494
3495The restrictions on @samp{offsetof} may be relaxed in a future version
3496of the C++ standard.
3497
3498@item -Wno-int-to-pointer-cast @r{(C only)}
3499@opindex Wno-int-to-pointer-cast
3500Suppress warnings from casts to pointer type of an integer of a
3501different size.
3502
3503@item -Wno-pointer-to-int-cast @r{(C only)}
3504@opindex Wno-pointer-to-int-cast
3505Suppress warnings from casts from a pointer to an integer type of a
3506different size.
3507
3508@item -Winvalid-pch
3509@opindex Winvalid-pch
3510Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3511the search path but can't be used.
3512
3513@item -Wlong-long
3514@opindex Wlong-long
3515@opindex Wno-long-long
3516Warn if @samp{long long} type is used.  This is default.  To inhibit
3517the warning messages, use @option{-Wno-long-long}.  Flags
3518@option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3519only when @option{-pedantic} flag is used.
3520
3521@item -Wvariadic-macros
3522@opindex Wvariadic-macros
3523@opindex Wno-variadic-macros
3524Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3525alternate syntax when in pedantic ISO C99 mode.  This is default.
3526To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3527
3528@item -Wvolatile-register-var
3529@opindex Wvolatile-register-var
3530@opindex Wno-volatile-register-var
3531Warn if a register variable is declared volatile.  The volatile
3532modifier does not inhibit all optimizations that may eliminate reads
3533and/or writes to register variables.
3534
3535@item -Wdisabled-optimization
3536@opindex Wdisabled-optimization
3537Warn if a requested optimization pass is disabled.  This warning does
3538not generally indicate that there is anything wrong with your code; it
3539merely indicates that GCC's optimizers were unable to handle the code
3540effectively.  Often, the problem is that your code is too big or too
3541complex; GCC will refuse to optimize programs when the optimization
3542itself is likely to take inordinate amounts of time.
3543
3544@item -Wpointer-sign
3545@opindex Wpointer-sign
3546@opindex Wno-pointer-sign
3547Warn for pointer argument passing or assignment with different signedness.
3548This option is only supported for C and Objective-C@.  It is implied by
3549@option{-Wall} and by @option{-pedantic}, which can be disabled with
3550@option{-Wno-pointer-sign}.
3551
3552@item -Werror
3553@opindex Werror
3554Make all warnings into errors.
3555
3556@item -Werror=
3557@opindex Werror=
3558Make the specified warning into an errors.  The specifier for a
3559warning is appended, for example @option{-Werror=switch} turns the
3560warnings controlled by @option{-Wswitch} into errors.  This switch
3561takes a negative form, to be used to negate @option{-Werror} for
3562specific warnings, for example @option{-Wno-error=switch} makes
3563@option{-Wswitch} warnings not be errors, even when @option{-Werror}
3564is in effect.  You can use the @option{-fdiagnostics-show-option}
3565option to have each controllable warning amended with the option which
3566controls it, to determine what to use with this option.
3567
3568Note that specifying @option{-Werror=}@var{foo} automatically implies
3569@option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3570imply anything.
3571
3572@item -Wstack-protector
3573@opindex Wstack-protector
3574This option is only active when @option{-fstack-protector} is active.  It
3575warns about functions that will not be protected against stack smashing.
3576
3577@item -Woverlength-strings
3578@opindex Woverlength-strings
3579Warn about string constants which are longer than the ``minimum
3580maximum'' length specified in the C standard.  Modern compilers
3581generally allow string constants which are much longer than the
3582standard's minimum limit, but very portable programs should avoid
3583using longer strings.
3584
3585The limit applies @emph{after} string constant concatenation, and does
3586not count the trailing NUL@.  In C89, the limit was 509 characters; in
3587C99, it was raised to 4095.  C++98 does not specify a normative
3588minimum maximum, so we do not diagnose overlength strings in C++@.
3589
3590This option is implied by @option{-pedantic}, and can be disabled with
3591@option{-Wno-overlength-strings}.
3592@end table
3593
3594@node Debugging Options
3595@section Options for Debugging Your Program or GCC
3596@cindex options, debugging
3597@cindex debugging information options
3598
3599GCC has various special options that are used for debugging
3600either your program or GCC:
3601
3602@table @gcctabopt
3603@item -g
3604@opindex g
3605Produce debugging information in the operating system's native format
3606(stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3607information.
3608
3609On most systems that use stabs format, @option{-g} enables use of extra
3610debugging information that only GDB can use; this extra information
3611makes debugging work better in GDB but will probably make other debuggers
3612crash or
3613refuse to read the program.  If you want to control for certain whether
3614to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3615@option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3616
3617GCC allows you to use @option{-g} with
3618@option{-O}.  The shortcuts taken by optimized code may occasionally
3619produce surprising results: some variables you declared may not exist
3620at all; flow of control may briefly move where you did not expect it;
3621some statements may not be executed because they compute constant
3622results or their values were already at hand; some statements may
3623execute in different places because they were moved out of loops.
3624
3625Nevertheless it proves possible to debug optimized output.  This makes
3626it reasonable to use the optimizer for programs that might have bugs.
3627
3628The following options are useful when GCC is generated with the
3629capability for more than one debugging format.
3630
3631@item -ggdb
3632@opindex ggdb
3633Produce debugging information for use by GDB@.  This means to use the
3634most expressive format available (DWARF 2, stabs, or the native format
3635if neither of those are supported), including GDB extensions if at all
3636possible.
3637
3638@item -gstabs
3639@opindex gstabs
3640Produce debugging information in stabs format (if that is supported),
3641without GDB extensions.  This is the format used by DBX on most BSD
3642systems.  On MIPS, Alpha and System V Release 4 systems this option
3643produces stabs debugging output which is not understood by DBX or SDB@.
3644On System V Release 4 systems this option requires the GNU assembler.
3645
3646@item -feliminate-unused-debug-symbols
3647@opindex feliminate-unused-debug-symbols
3648Produce debugging information in stabs format (if that is supported),
3649for only symbols that are actually used.
3650
3651@item -femit-class-debug-always
3652Instead of emitting debugging information for a C++ class in only one
3653object file, emit it in all object files using the class.  This option
3654should be used only with debuggers that are unable to handle the way GCC
3655normally emits debugging information for classes because using this
3656option will increase the size of debugging information by as much as a
3657factor of two.
3658
3659@item -gstabs+
3660@opindex gstabs+
3661Produce debugging information in stabs format (if that is supported),
3662using GNU extensions understood only by the GNU debugger (GDB)@.  The
3663use of these extensions is likely to make other debuggers crash or
3664refuse to read the program.
3665
3666@item -gcoff
3667@opindex gcoff
3668Produce debugging information in COFF format (if that is supported).
3669This is the format used by SDB on most System V systems prior to
3670System V Release 4.
3671
3672@item -gxcoff
3673@opindex gxcoff
3674Produce debugging information in XCOFF format (if that is supported).
3675This is the format used by the DBX debugger on IBM RS/6000 systems.
3676
3677@item -gxcoff+
3678@opindex gxcoff+
3679Produce debugging information in XCOFF format (if that is supported),
3680using GNU extensions understood only by the GNU debugger (GDB)@.  The
3681use of these extensions is likely to make other debuggers crash or
3682refuse to read the program, and may cause assemblers other than the GNU
3683assembler (GAS) to fail with an error.
3684
3685@item -gdwarf-2
3686@opindex gdwarf-2
3687Produce debugging information in DWARF version 2 format (if that is
3688supported).  This is the format used by DBX on IRIX 6.  With this
3689option, GCC uses features of DWARF version 3 when they are useful;
3690version 3 is upward compatible with version 2, but may still cause
3691problems for older debuggers.
3692
3693@item -gvms
3694@opindex gvms
3695Produce debugging information in VMS debug format (if that is
3696supported).  This is the format used by DEBUG on VMS systems.
3697
3698@item -g@var{level}
3699@itemx -ggdb@var{level}
3700@itemx -gstabs@var{level}
3701@itemx -gcoff@var{level}
3702@itemx -gxcoff@var{level}
3703@itemx -gvms@var{level}
3704Request debugging information and also use @var{level} to specify how
3705much information.  The default level is 2.
3706
3707Level 1 produces minimal information, enough for making backtraces in
3708parts of the program that you don't plan to debug.  This includes
3709descriptions of functions and external variables, but no information
3710about local variables and no line numbers.
3711
3712Level 3 includes extra information, such as all the macro definitions
3713present in the program.  Some debuggers support macro expansion when
3714you use @option{-g3}.
3715
3716@option{-gdwarf-2} does not accept a concatenated debug level, because
3717GCC used to support an option @option{-gdwarf} that meant to generate
3718debug information in version 1 of the DWARF format (which is very
3719different from version 2), and it would have been too confusing.  That
3720debug format is long obsolete, but the option cannot be changed now.
3721Instead use an additional @option{-g@var{level}} option to change the
3722debug level for DWARF2.
3723
3724@item -feliminate-dwarf2-dups
3725@opindex feliminate-dwarf2-dups
3726Compress DWARF2 debugging information by eliminating duplicated
3727information about each symbol.  This option only makes sense when
3728generating DWARF2 debugging information with @option{-gdwarf-2}.
3729
3730@cindex @command{prof}
3731@item -p
3732@opindex p
3733Generate extra code to write profile information suitable for the
3734analysis program @command{prof}.  You must use this option when compiling
3735the source files you want data about, and you must also use it when
3736linking.
3737
3738@cindex @command{gprof}
3739@item -pg
3740@opindex pg
3741Generate extra code to write profile information suitable for the
3742analysis program @command{gprof}.  You must use this option when compiling
3743the source files you want data about, and you must also use it when
3744linking.
3745
3746@item -Q
3747@opindex Q
3748Makes the compiler print out each function name as it is compiled, and
3749print some statistics about each pass when it finishes.
3750
3751@item -ftime-report
3752@opindex ftime-report
3753Makes the compiler print some statistics about the time consumed by each
3754pass when it finishes.
3755
3756@item -fmem-report
3757@opindex fmem-report
3758Makes the compiler print some statistics about permanent memory
3759allocation when it finishes.
3760
3761@item -fprofile-arcs
3762@opindex fprofile-arcs
3763Add code so that program flow @dfn{arcs} are instrumented.  During
3764execution the program records how many times each branch and call is
3765executed and how many times it is taken or returns.  When the compiled
3766program exits it saves this data to a file called
3767@file{@var{auxname}.gcda} for each source file.  The data may be used for
3768profile-directed optimizations (@option{-fbranch-probabilities}), or for
3769test coverage analysis (@option{-ftest-coverage}).  Each object file's
3770@var{auxname} is generated from the name of the output file, if
3771explicitly specified and it is not the final executable, otherwise it is
3772the basename of the source file.  In both cases any suffix is removed
3773(e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3774@file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3775@xref{Cross-profiling}.
3776
3777@cindex @command{gcov}
3778@item --coverage
3779@opindex coverage
3780
3781This option is used to compile and link code instrumented for coverage
3782analysis.  The option is a synonym for @option{-fprofile-arcs}
3783@option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3784linking).  See the documentation for those options for more details.
3785
3786@itemize
3787
3788@item
3789Compile the source files with @option{-fprofile-arcs} plus optimization
3790and code generation options.  For test coverage analysis, use the
3791additional @option{-ftest-coverage} option.  You do not need to profile
3792every source file in a program.
3793
3794@item
3795Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3796(the latter implies the former).
3797
3798@item
3799Run the program on a representative workload to generate the arc profile
3800information.  This may be repeated any number of times.  You can run
3801concurrent instances of your program, and provided that the file system
3802supports locking, the data files will be correctly updated.  Also
3803@code{fork} calls are detected and correctly handled (double counting
3804will not happen).
3805
3806@item
3807For profile-directed optimizations, compile the source files again with
3808the same optimization and code generation options plus
3809@option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3810Control Optimization}).
3811
3812@item
3813For test coverage analysis, use @command{gcov} to produce human readable
3814information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3815@command{gcov} documentation for further information.
3816
3817@end itemize
3818
3819With @option{-fprofile-arcs}, for each function of your program GCC
3820creates a program flow graph, then finds a spanning tree for the graph.
3821Only arcs that are not on the spanning tree have to be instrumented: the
3822compiler adds code to count the number of times that these arcs are
3823executed.  When an arc is the only exit or only entrance to a block, the
3824instrumentation code can be added to the block; otherwise, a new basic
3825block must be created to hold the instrumentation code.
3826
3827@need 2000
3828@item -ftest-coverage
3829@opindex ftest-coverage
3830Produce a notes file that the @command{gcov} code-coverage utility
3831(@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3832show program coverage.  Each source file's note file is called
3833@file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3834above for a description of @var{auxname} and instructions on how to
3835generate test coverage data.  Coverage data will match the source files
3836more closely, if you do not optimize.
3837
3838@item -d@var{letters}
3839@item -fdump-rtl-@var{pass}
3840@opindex d
3841Says to make debugging dumps during compilation at times specified by
3842@var{letters}.    This is used for debugging the RTL-based passes of the
3843compiler.  The file names for most of the dumps are made by appending a
3844pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3845from the name of the output file, if explicitly specified and it is not
3846an executable, otherwise it is the basename of the source file.
3847
3848Most debug dumps can be enabled either passing a letter to the @option{-d}
3849option, or with a long @option{-fdump-rtl} switch; here are the possible
3850letters for use in @var{letters} and @var{pass}, and their meanings:
3851
3852@table @gcctabopt
3853@item -dA
3854@opindex dA
3855Annotate the assembler output with miscellaneous debugging information.
3856
3857@item -dB
3858@itemx -fdump-rtl-bbro
3859@opindex dB
3860@opindex fdump-rtl-bbro
3861Dump after block reordering, to @file{@var{file}.148r.bbro}.
3862
3863@item -dc
3864@itemx -fdump-rtl-combine
3865@opindex dc
3866@opindex fdump-rtl-combine
3867Dump after instruction combination, to the file @file{@var{file}.129r.combine}.
3868
3869@item -dC
3870@itemx -fdump-rtl-ce1
3871@itemx -fdump-rtl-ce2
3872@opindex dC
3873@opindex fdump-rtl-ce1
3874@opindex fdump-rtl-ce2
3875@option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3876first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
3877and @option{-fdump-rtl-ce2} enable dumping after the second if
3878conversion, to the file @file{@var{file}.130r.ce2}.
3879
3880@item -dd
3881@itemx -fdump-rtl-btl
3882@itemx -fdump-rtl-dbr
3883@opindex dd
3884@opindex fdump-rtl-btl
3885@opindex fdump-rtl-dbr
3886@option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3887target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3888and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3889scheduling, to @file{@var{file}.36.dbr}.
3890
3891@item -dD
3892@opindex dD
3893Dump all macro definitions, at the end of preprocessing, in addition to
3894normal output.
3895
3896@item -dE
3897@itemx -fdump-rtl-ce3
3898@opindex dE
3899@opindex fdump-rtl-ce3
3900Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
3901
3902@item -df
3903@itemx -fdump-rtl-cfg
3904@itemx -fdump-rtl-life
3905@opindex df
3906@opindex fdump-rtl-cfg
3907@opindex fdump-rtl-life
3908@option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3909and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
3910and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3911to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
3912
3913@item -dg
3914@itemx -fdump-rtl-greg
3915@opindex dg
3916@opindex fdump-rtl-greg
3917Dump after global register allocation, to @file{@var{file}.139r.greg}.
3918
3919@item -dG
3920@itemx -fdump-rtl-gcse
3921@itemx -fdump-rtl-bypass
3922@opindex dG
3923@opindex fdump-rtl-gcse
3924@opindex fdump-rtl-bypass
3925@option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3926@file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3927enable dumping after jump bypassing and control flow optimizations, to
3928@file{@var{file}.115r.bypass}.
3929
3930@item -dh
3931@itemx -fdump-rtl-eh
3932@opindex dh
3933@opindex fdump-rtl-eh
3934Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3935
3936@item -di
3937@itemx -fdump-rtl-sibling
3938@opindex di
3939@opindex fdump-rtl-sibling
3940Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
3941
3942@item -dj
3943@itemx -fdump-rtl-jump
3944@opindex dj
3945@opindex fdump-rtl-jump
3946Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
3947
3948@item -dk
3949@itemx -fdump-rtl-stack
3950@opindex dk
3951@opindex fdump-rtl-stack
3952Dump after conversion from registers to stack, to @file{@var{file}.152r.stack}.
3953
3954@item -dl
3955@itemx -fdump-rtl-lreg
3956@opindex dl
3957@opindex fdump-rtl-lreg
3958Dump after local register allocation, to @file{@var{file}.138r.lreg}.
3959
3960@item -dL
3961@itemx -fdump-rtl-loop2
3962@opindex dL
3963@opindex fdump-rtl-loop2
3964@option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
3965loop optimization pass, to @file{@var{file}.119r.loop2},
3966@file{@var{file}.120r.loop2_init},
3967@file{@var{file}.121r.loop2_invariant}, and
3968@file{@var{file}.125r.loop2_done}.
3969
3970@item -dm
3971@itemx -fdump-rtl-sms
3972@opindex dm
3973@opindex fdump-rtl-sms
3974Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
3975
3976@item -dM
3977@itemx -fdump-rtl-mach
3978@opindex dM
3979@opindex fdump-rtl-mach
3980Dump after performing the machine dependent reorganization pass, to
3981@file{@var{file}.155r.mach}.
3982
3983@item -dn
3984@itemx -fdump-rtl-rnreg
3985@opindex dn
3986@opindex fdump-rtl-rnreg
3987Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
3988
3989@item -dN
3990@itemx -fdump-rtl-regmove
3991@opindex dN
3992@opindex fdump-rtl-regmove
3993Dump after the register move pass, to @file{@var{file}.132r.regmove}.
3994
3995@item -do
3996@itemx -fdump-rtl-postreload
3997@opindex do
3998@opindex fdump-rtl-postreload
3999Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4000
4001@item -dr
4002@itemx -fdump-rtl-expand
4003@opindex dr
4004@opindex fdump-rtl-expand
4005Dump after RTL generation, to @file{@var{file}.104r.expand}.
4006
4007@item -dR
4008@itemx -fdump-rtl-sched2
4009@opindex dR
4010@opindex fdump-rtl-sched2
4011Dump after the second scheduling pass, to @file{@var{file}.150r.sched2}.
4012
4013@item -ds
4014@itemx -fdump-rtl-cse
4015@opindex ds
4016@opindex fdump-rtl-cse
4017Dump after CSE (including the jump optimization that sometimes follows
4018CSE), to @file{@var{file}.113r.cse}.
4019
4020@item -dS
4021@itemx -fdump-rtl-sched
4022@opindex dS
4023@opindex fdump-rtl-sched
4024Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
4025
4026@item -dt
4027@itemx -fdump-rtl-cse2
4028@opindex dt
4029@opindex fdump-rtl-cse2
4030Dump after the second CSE pass (including the jump optimization that
4031sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4032
4033@item -dT
4034@itemx -fdump-rtl-tracer
4035@opindex dT
4036@opindex fdump-rtl-tracer
4037Dump after running tracer, to @file{@var{file}.118r.tracer}.
4038
4039@item -dV
4040@itemx -fdump-rtl-vpt
4041@itemx -fdump-rtl-vartrack
4042@opindex dV
4043@opindex fdump-rtl-vpt
4044@opindex fdump-rtl-vartrack
4045@option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
4046profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
4047and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4048to @file{@var{file}.154r.vartrack}.
4049
4050@item -dw
4051@itemx -fdump-rtl-flow2
4052@opindex dw
4053@opindex fdump-rtl-flow2
4054Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4055
4056@item -dz
4057@itemx -fdump-rtl-peephole2
4058@opindex dz
4059@opindex fdump-rtl-peephole2
4060Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4061
4062@item -dZ
4063@itemx -fdump-rtl-web
4064@opindex dZ
4065@opindex fdump-rtl-web
4066Dump after live range splitting, to @file{@var{file}.126r.web}.
4067
4068@item -da
4069@itemx -fdump-rtl-all
4070@opindex da
4071@opindex fdump-rtl-all
4072Produce all the dumps listed above.
4073
4074@item -dH
4075@opindex dH
4076Produce a core dump whenever an error occurs.
4077
4078@item -dm
4079@opindex dm
4080Print statistics on memory usage, at the end of the run, to
4081standard error.
4082
4083@item -dp
4084@opindex dp
4085Annotate the assembler output with a comment indicating which
4086pattern and alternative was used.  The length of each instruction is
4087also printed.
4088
4089@item -dP
4090@opindex dP
4091Dump the RTL in the assembler output as a comment before each instruction.
4092Also turns on @option{-dp} annotation.
4093
4094@item -dv
4095@opindex dv
4096For each of the other indicated dump files (either with @option{-d} or
4097@option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4098graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4099
4100@item -dx
4101@opindex dx
4102Just generate RTL for a function instead of compiling it.  Usually used
4103with @samp{r} (@option{-fdump-rtl-expand}).
4104
4105@item -dy
4106@opindex dy
4107Dump debugging information during parsing, to standard error.
4108@end table
4109
4110@item -fdump-noaddr
4111@opindex fdump-noaddr
4112When doing debugging dumps (see @option{-d} option above), suppress
4113address output.  This makes it more feasible to use diff on debugging
4114dumps for compiler invocations with different compiler binaries and/or
4115different text / bss / data / heap / stack / dso start locations.
4116
4117@item -fdump-unnumbered
4118@opindex fdump-unnumbered
4119When doing debugging dumps (see @option{-d} option above), suppress instruction
4120numbers, line number note and address output.  This makes it more feasible to
4121use diff on debugging dumps for compiler invocations with different
4122options, in particular with and without @option{-g}.
4123
4124@item -fdump-translation-unit @r{(C++ only)}
4125@itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4126@opindex fdump-translation-unit
4127Dump a representation of the tree structure for the entire translation
4128unit to a file.  The file name is made by appending @file{.tu} to the
4129source file name.  If the @samp{-@var{options}} form is used, @var{options}
4130controls the details of the dump as described for the
4131@option{-fdump-tree} options.
4132
4133@item -fdump-class-hierarchy @r{(C++ only)}
4134@itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4135@opindex fdump-class-hierarchy
4136Dump a representation of each class's hierarchy and virtual function
4137table layout to a file.  The file name is made by appending @file{.class}
4138to the source file name.  If the @samp{-@var{options}} form is used,
4139@var{options} controls the details of the dump as described for the
4140@option{-fdump-tree} options.
4141
4142@item -fdump-ipa-@var{switch}
4143@opindex fdump-ipa
4144Control the dumping at various stages of inter-procedural analysis
4145language tree to a file.  The file name is generated by appending a switch
4146specific suffix to the source file name.  The following dumps are possible:
4147
4148@table @samp
4149@item all
4150Enables all inter-procedural analysis dumps; currently the only produced
4151dump is the @samp{cgraph} dump.
4152
4153@item cgraph
4154Dumps information about call-graph optimization, unused function removal,
4155and inlining decisions.
4156@end table
4157
4158@item -fdump-tree-@var{switch}
4159@itemx -fdump-tree-@var{switch}-@var{options}
4160@opindex fdump-tree
4161Control the dumping at various stages of processing the intermediate
4162language tree to a file.  The file name is generated by appending a switch
4163specific suffix to the source file name.  If the @samp{-@var{options}}
4164form is used, @var{options} is a list of @samp{-} separated options that
4165control the details of the dump.  Not all options are applicable to all
4166dumps, those which are not meaningful will be ignored.  The following
4167options are available
4168
4169@table @samp
4170@item address
4171Print the address of each node.  Usually this is not meaningful as it
4172changes according to the environment and source file.  Its primary use
4173is for tying up a dump file with a debug environment.
4174@item slim
4175Inhibit dumping of members of a scope or body of a function merely
4176because that scope has been reached.  Only dump such items when they
4177are directly reachable by some other path.  When dumping pretty-printed
4178trees, this option inhibits dumping the bodies of control structures.
4179@item raw
4180Print a raw representation of the tree.  By default, trees are
4181pretty-printed into a C-like representation.
4182@item details
4183Enable more detailed dumps (not honored by every dump option).
4184@item stats
4185Enable dumping various statistics about the pass (not honored by every dump
4186option).
4187@item blocks
4188Enable showing basic block boundaries (disabled in raw dumps).
4189@item vops
4190Enable showing virtual operands for every statement.
4191@item lineno
4192Enable showing line numbers for statements.
4193@item uid
4194Enable showing the unique ID (@code{DECL_UID}) for each variable.
4195@item all
4196Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4197@end table
4198
4199The following tree dumps are possible:
4200@table @samp
4201
4202@item original
4203Dump before any tree based optimization, to @file{@var{file}.original}.
4204
4205@item optimized
4206Dump after all tree based optimization, to @file{@var{file}.optimized}.
4207
4208@item inlined
4209Dump after function inlining, to @file{@var{file}.inlined}.
4210
4211@item gimple
4212@opindex fdump-tree-gimple
4213Dump each function before and after the gimplification pass to a file.  The
4214file name is made by appending @file{.gimple} to the source file name.
4215
4216@item cfg
4217@opindex fdump-tree-cfg
4218Dump the control flow graph of each function to a file.  The file name is
4219made by appending @file{.cfg} to the source file name.
4220
4221@item vcg
4222@opindex fdump-tree-vcg
4223Dump the control flow graph of each function to a file in VCG format.  The
4224file name is made by appending @file{.vcg} to the source file name.  Note
4225that if the file contains more than one function, the generated file cannot
4226be used directly by VCG@.  You will need to cut and paste each function's
4227graph into its own separate file first.
4228
4229@item ch
4230@opindex fdump-tree-ch
4231Dump each function after copying loop headers.  The file name is made by
4232appending @file{.ch} to the source file name.
4233
4234@item ssa
4235@opindex fdump-tree-ssa
4236Dump SSA related information to a file.  The file name is made by appending
4237@file{.ssa} to the source file name.
4238
4239@item salias
4240@opindex fdump-tree-salias
4241Dump structure aliasing variable information to a file.  This file name
4242is made by appending @file{.salias} to the source file name.
4243
4244@item alias
4245@opindex fdump-tree-alias
4246Dump aliasing information for each function.  The file name is made by
4247appending @file{.alias} to the source file name.
4248
4249@item ccp
4250@opindex fdump-tree-ccp
4251Dump each function after CCP@.  The file name is made by appending
4252@file{.ccp} to the source file name.
4253
4254@item storeccp
4255@opindex fdump-tree-storeccp
4256Dump each function after STORE-CCP.  The file name is made by appending
4257@file{.storeccp} to the source file name.
4258
4259@item pre
4260@opindex fdump-tree-pre
4261Dump trees after partial redundancy elimination.  The file name is made
4262by appending @file{.pre} to the source file name.
4263
4264@item fre
4265@opindex fdump-tree-fre
4266Dump trees after full redundancy elimination.  The file name is made
4267by appending @file{.fre} to the source file name.
4268
4269@item copyprop
4270@opindex fdump-tree-copyprop
4271Dump trees after copy propagation.  The file name is made
4272by appending @file{.copyprop} to the source file name.
4273
4274@item store_copyprop
4275@opindex fdump-tree-store_copyprop
4276Dump trees after store copy-propagation.  The file name is made
4277by appending @file{.store_copyprop} to the source file name.
4278
4279@item dce
4280@opindex fdump-tree-dce
4281Dump each function after dead code elimination.  The file name is made by
4282appending @file{.dce} to the source file name.
4283
4284@item mudflap
4285@opindex fdump-tree-mudflap
4286Dump each function after adding mudflap instrumentation.  The file name is
4287made by appending @file{.mudflap} to the source file name.
4288
4289@item sra
4290@opindex fdump-tree-sra
4291Dump each function after performing scalar replacement of aggregates.  The
4292file name is made by appending @file{.sra} to the source file name.
4293
4294@item sink
4295@opindex fdump-tree-sink
4296Dump each function after performing code sinking.  The file name is made
4297by appending @file{.sink} to the source file name.
4298
4299@item dom
4300@opindex fdump-tree-dom
4301Dump each function after applying dominator tree optimizations.  The file
4302name is made by appending @file{.dom} to the source file name.
4303
4304@item dse
4305@opindex fdump-tree-dse
4306Dump each function after applying dead store elimination.  The file
4307name is made by appending @file{.dse} to the source file name.
4308
4309@item phiopt
4310@opindex fdump-tree-phiopt
4311Dump each function after optimizing PHI nodes into straightline code.  The file
4312name is made by appending @file{.phiopt} to the source file name.
4313
4314@item forwprop
4315@opindex fdump-tree-forwprop
4316Dump each function after forward propagating single use variables.  The file
4317name is made by appending @file{.forwprop} to the source file name.
4318
4319@item copyrename
4320@opindex fdump-tree-copyrename
4321Dump each function after applying the copy rename optimization.  The file
4322name is made by appending @file{.copyrename} to the source file name.
4323
4324@item nrv
4325@opindex fdump-tree-nrv
4326Dump each function after applying the named return value optimization on
4327generic trees.  The file name is made by appending @file{.nrv} to the source
4328file name.
4329
4330@item vect
4331@opindex fdump-tree-vect
4332Dump each function after applying vectorization of loops.  The file name is
4333made by appending @file{.vect} to the source file name.
4334
4335@item vrp
4336@opindex fdump-tree-vrp
4337Dump each function after Value Range Propagation (VRP).  The file name
4338is made by appending @file{.vrp} to the source file name.
4339
4340@item all
4341@opindex fdump-tree-all
4342Enable all the available tree dumps with the flags provided in this option.
4343@end table
4344
4345@item -ftree-vectorizer-verbose=@var{n}
4346@opindex ftree-vectorizer-verbose
4347This option controls the amount of debugging output the vectorizer prints.
4348This information is written to standard error, unless
4349@option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4350in which case it is output to the usual dump listing file, @file{.vect}.
4351For @var{n}=0 no diagnostic information is reported.
4352If @var{n}=1 the vectorizer reports each loop that got vectorized,
4353and the total number of loops that got vectorized.
4354If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4355the first analysis phase (vect_analyze_loop_form) - i.e. countable,
4356inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4357level that @option{-fdump-tree-vect-stats} uses.
4358Higher verbosity levels mean either more information dumped for each
4359reported loop, or same amount of information reported for more loops:
4360If @var{n}=3, alignment related information is added to the reports.
4361If @var{n}=4, data-references related information (e.g. memory dependences,
4362memory access-patterns) is added to the reports.
4363If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4364that did not pass the first analysis phase (i.e. may not be countable, or
4365may have complicated control-flow).
4366If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4367For @var{n}=7, all the information the vectorizer generates during its
4368analysis and transformation is reported.  This is the same verbosity level
4369that @option{-fdump-tree-vect-details} uses.
4370
4371@item -frandom-seed=@var{string}
4372@opindex frandom-string
4373This option provides a seed that GCC uses when it would otherwise use
4374random numbers.  It is used to generate certain symbol names
4375that have to be different in every compiled file.  It is also used to
4376place unique stamps in coverage data files and the object files that
4377produce them.  You can use the @option{-frandom-seed} option to produce
4378reproducibly identical object files.
4379
4380The @var{string} should be different for every file you compile.
4381
4382@item -fsched-verbose=@var{n}
4383@opindex fsched-verbose
4384On targets that use instruction scheduling, this option controls the
4385amount of debugging output the scheduler prints.  This information is
4386written to standard error, unless @option{-dS} or @option{-dR} is
4387specified, in which case it is output to the usual dump
4388listing file, @file{.sched} or @file{.sched2} respectively.  However
4389for @var{n} greater than nine, the output is always printed to standard
4390error.
4391
4392For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4393same information as @option{-dRS}.  For @var{n} greater than one, it
4394also output basic block probabilities, detailed ready list information
4395and unit/insn info.  For @var{n} greater than two, it includes RTL
4396at abort point, control-flow and regions info.  And for @var{n} over
4397four, @option{-fsched-verbose} also includes dependence info.
4398
4399@item -save-temps
4400@opindex save-temps
4401Store the usual ``temporary'' intermediate files permanently; place them
4402in the current directory and name them based on the source file.  Thus,
4403compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4404@file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4405preprocessed @file{foo.i} output file even though the compiler now
4406normally uses an integrated preprocessor.
4407
4408When used in combination with the @option{-x} command line option,
4409@option{-save-temps} is sensible enough to avoid over writing an
4410input source file with the same extension as an intermediate file.
4411The corresponding intermediate file may be obtained by renaming the
4412source file before using @option{-save-temps}.
4413
4414@item -time
4415@opindex time
4416Report the CPU time taken by each subprocess in the compilation
4417sequence.  For C source files, this is the compiler proper and assembler
4418(plus the linker if linking is done).  The output looks like this:
4419
4420@smallexample
4421# cc1 0.12 0.01
4422# as 0.00 0.01
4423@end smallexample
4424
4425The first number on each line is the ``user time'', that is time spent
4426executing the program itself.  The second number is ``system time'',
4427time spent executing operating system routines on behalf of the program.
4428Both numbers are in seconds.
4429
4430@item -fvar-tracking
4431@opindex fvar-tracking
4432Run variable tracking pass.  It computes where variables are stored at each
4433position in code.  Better debugging information is then generated
4434(if the debugging information format supports this information).
4435
4436It is enabled by default when compiling with optimization (@option{-Os},
4437@option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4438the debug info format supports it.
4439
4440@item -print-file-name=@var{library}
4441@opindex print-file-name
4442Print the full absolute name of the library file @var{library} that
4443would be used when linking---and don't do anything else.  With this
4444option, GCC does not compile or link anything; it just prints the
4445file name.
4446
4447@item -print-multi-directory
4448@opindex print-multi-directory
4449Print the directory name corresponding to the multilib selected by any
4450other switches present in the command line.  This directory is supposed
4451to exist in @env{GCC_EXEC_PREFIX}.
4452
4453@item -print-multi-lib
4454@opindex print-multi-lib
4455Print the mapping from multilib directory names to compiler switches
4456that enable them.  The directory name is separated from the switches by
4457@samp{;}, and each switch starts with an @samp{@@} instead of the
4458@samp{-}, without spaces between multiple switches.  This is supposed to
4459ease shell-processing.
4460
4461@item -print-prog-name=@var{program}
4462@opindex print-prog-name
4463Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4464
4465@item -print-libgcc-file-name
4466@opindex print-libgcc-file-name
4467Same as @option{-print-file-name=libgcc.a}.
4468
4469This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4470but you do want to link with @file{libgcc.a}.  You can do
4471
4472@smallexample
4473gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4474@end smallexample
4475
4476@item -print-search-dirs
4477@opindex print-search-dirs
4478Print the name of the configured installation directory and a list of
4479program and library directories @command{gcc} will search---and don't do anything else.
4480
4481This is useful when @command{gcc} prints the error message
4482@samp{installation problem, cannot exec cpp0: No such file or directory}.
4483To resolve this you either need to put @file{cpp0} and the other compiler
4484components where @command{gcc} expects to find them, or you can set the environment
4485variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4486Don't forget the trailing @samp{/}.
4487@xref{Environment Variables}.
4488
4489@item -dumpmachine
4490@opindex dumpmachine
4491Print the compiler's target machine (for example,
4492@samp{i686-pc-linux-gnu})---and don't do anything else.
4493
4494@item -dumpversion
4495@opindex dumpversion
4496Print the compiler version (for example, @samp{3.0})---and don't do
4497anything else.
4498
4499@item -dumpspecs
4500@opindex dumpspecs
4501Print the compiler's built-in specs---and don't do anything else.  (This
4502is used when GCC itself is being built.)  @xref{Spec Files}.
4503
4504@item -feliminate-unused-debug-types
4505@opindex feliminate-unused-debug-types
4506Normally, when producing DWARF2 output, GCC will emit debugging
4507information for all types declared in a compilation
4508unit, regardless of whether or not they are actually used
4509in that compilation unit.  Sometimes this is useful, such as
4510if, in the debugger, you want to cast a value to a type that is
4511not actually used in your program (but is declared).  More often,
4512however, this results in a significant amount of wasted space.
4513With this option, GCC will avoid producing debug symbol output
4514for types that are nowhere used in the source file being compiled.
4515@end table
4516
4517@node Optimize Options
4518@section Options That Control Optimization
4519@cindex optimize options
4520@cindex options, optimization
4521
4522These options control various sorts of optimizations.
4523
4524Without any optimization option, the compiler's goal is to reduce the
4525cost of compilation and to make debugging produce the expected
4526results.  Statements are independent: if you stop the program with a
4527breakpoint between statements, you can then assign a new value to any
4528variable or change the program counter to any other statement in the
4529function and get exactly the results you would expect from the source
4530code.
4531
4532Turning on optimization flags makes the compiler attempt to improve
4533the performance and/or code size at the expense of compilation time
4534and possibly the ability to debug the program.
4535
4536The compiler performs optimization based on the knowledge it has of
4537the program.  Optimization levels @option{-O} and above, in
4538particular, enable @emph{unit-at-a-time} mode, which allows the
4539compiler to consider information gained from later functions in
4540the file when compiling a function.  Compiling multiple files at
4541once to a single output file in @emph{unit-at-a-time} mode allows
4542the compiler to use information gained from all of the files when
4543compiling each of them.
4544
4545Not all optimizations are controlled directly by a flag.  Only
4546optimizations that have a flag are listed.
4547
4548@table @gcctabopt
4549@item -O
4550@itemx -O1
4551@opindex O
4552@opindex O1
4553Optimize.  Optimizing compilation takes somewhat more time, and a lot
4554more memory for a large function.
4555
4556With @option{-O}, the compiler tries to reduce code size and execution
4557time, without performing any optimizations that take a great deal of
4558compilation time.
4559
4560@option{-O} turns on the following optimization flags:
4561@gccoptlist{-fdefer-pop @gol
4562-fdelayed-branch @gol
4563-fguess-branch-probability @gol
4564-fcprop-registers @gol
4565-fif-conversion @gol
4566-fif-conversion2 @gol
4567-ftree-ccp @gol
4568-ftree-dce @gol
4569-ftree-dominator-opts @gol
4570-ftree-dse @gol
4571-ftree-ter @gol
4572-ftree-lrs @gol
4573-ftree-sra @gol
4574-ftree-copyrename @gol
4575-ftree-fre @gol
4576-ftree-ch @gol
4577-funit-at-a-time @gol
4578-fmerge-constants}
4579
4580@option{-O} also turns on @option{-fomit-frame-pointer} on machines
4581where doing so does not interfere with debugging.
4582
4583@item -O2
4584@opindex O2
4585Optimize even more.  GCC performs nearly all supported optimizations
4586that do not involve a space-speed tradeoff.  The compiler does not
4587perform loop unrolling or function inlining when you specify @option{-O2}.
4588As compared to @option{-O}, this option increases both compilation time
4589and the performance of the generated code.
4590
4591@option{-O2} turns on all optimization flags specified by @option{-O}.  It
4592also turns on the following optimization flags:
4593@gccoptlist{-fthread-jumps @gol
4594-fcrossjumping @gol
4595-foptimize-sibling-calls @gol
4596-fcse-follow-jumps  -fcse-skip-blocks @gol
4597-fgcse  -fgcse-lm  @gol
4598-fexpensive-optimizations @gol
4599-frerun-cse-after-loop  @gol
4600-fcaller-saves @gol
4601-fpeephole2 @gol
4602-fschedule-insns  -fschedule-insns2 @gol
4603-fsched-interblock  -fsched-spec @gol
4604-fregmove @gol
4605-fstrict-aliasing -fstrict-overflow @gol
4606-fdelete-null-pointer-checks @gol
4607-freorder-blocks  -freorder-functions @gol
4608-falign-functions  -falign-jumps @gol
4609-falign-loops  -falign-labels @gol
4610-ftree-vrp @gol
4611-ftree-pre}
4612
4613Please note the warning under @option{-fgcse} about
4614invoking @option{-O2} on programs that use computed gotos.
4615
4616@option{-O2} doesn't turn on @option{-ftree-vrp} for the Ada compiler.
4617This option must be explicitly specified on the command line to be
4618enabled for the Ada compiler.
4619
4620@item -O3
4621@opindex O3
4622Optimize yet more.  @option{-O3} turns on all optimizations specified by
4623@option{-O2} and also turns on the @option{-finline-functions},
4624@option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4625
4626@item -O0
4627@opindex O0
4628Do not optimize.  This is the default.
4629
4630@item -Os
4631@opindex Os
4632Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4633do not typically increase code size.  It also performs further
4634optimizations designed to reduce code size.
4635
4636@option{-Os} disables the following optimization flags:
4637@gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4638-falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4639-fprefetch-loop-arrays  -ftree-vect-loop-version}
4640
4641If you use multiple @option{-O} options, with or without level numbers,
4642the last such option is the one that is effective.
4643@end table
4644
4645Options of the form @option{-f@var{flag}} specify machine-independent
4646flags.  Most flags have both positive and negative forms; the negative
4647form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4648below, only one of the forms is listed---the one you typically will
4649use.  You can figure out the other form by either removing @samp{no-}
4650or adding it.
4651
4652The following options control specific optimizations.  They are either
4653activated by @option{-O} options or are related to ones that are.  You
4654can use the following flags in the rare cases when ``fine-tuning'' of
4655optimizations to be performed is desired.
4656
4657@table @gcctabopt
4658@item -fno-default-inline
4659@opindex fno-default-inline
4660Do not make member functions inline by default merely because they are
4661defined inside the class scope (C++ only).  Otherwise, when you specify
4662@w{@option{-O}}, member functions defined inside class scope are compiled
4663inline by default; i.e., you don't need to add @samp{inline} in front of
4664the member function name.
4665
4666@item -fno-defer-pop
4667@opindex fno-defer-pop
4668Always pop the arguments to each function call as soon as that function
4669returns.  For machines which must pop arguments after a function call,
4670the compiler normally lets arguments accumulate on the stack for several
4671function calls and pops them all at once.
4672
4673Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4674
4675@item -fforce-mem
4676@opindex fforce-mem
4677Force memory operands to be copied into registers before doing
4678arithmetic on them.  This produces better code by making all memory
4679references potential common subexpressions.  When they are not common
4680subexpressions, instruction combination should eliminate the separate
4681register-load. This option is now a nop and will be removed in 4.3.
4682
4683@item -fforce-addr
4684@opindex fforce-addr
4685Force memory address constants to be copied into registers before
4686doing arithmetic on them.
4687
4688@item -fomit-frame-pointer
4689@opindex fomit-frame-pointer
4690Don't keep the frame pointer in a register for functions that
4691don't need one.  This avoids the instructions to save, set up and
4692restore frame pointers; it also makes an extra register available
4693in many functions.  @strong{It also makes debugging impossible on
4694some machines.}
4695
4696On some machines, such as the VAX, this flag has no effect, because
4697the standard calling sequence automatically handles the frame pointer
4698and nothing is saved by pretending it doesn't exist.  The
4699machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4700whether a target machine supports this flag.  @xref{Registers,,Register
4701Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4702
4703Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4704
4705@item -foptimize-sibling-calls
4706@opindex foptimize-sibling-calls
4707Optimize sibling and tail recursive calls.
4708
4709Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4710
4711@item -fno-inline
4712@opindex fno-inline
4713Don't pay attention to the @code{inline} keyword.  Normally this option
4714is used to keep the compiler from expanding any functions inline.
4715Note that if you are not optimizing, no functions can be expanded inline.
4716
4717@item -finline-functions
4718@opindex finline-functions
4719Integrate all simple functions into their callers.  The compiler
4720heuristically decides which functions are simple enough to be worth
4721integrating in this way.
4722
4723If all calls to a given function are integrated, and the function is
4724declared @code{static}, then the function is normally not output as
4725assembler code in its own right.
4726
4727Enabled at level @option{-O3}.
4728
4729@item -finline-functions-called-once
4730@opindex finline-functions-called-once
4731Consider all @code{static} functions called once for inlining into their
4732caller even if they are not marked @code{inline}.  If a call to a given
4733function is integrated, then the function is not output as assembler code
4734in its own right.
4735
4736Enabled if @option{-funit-at-a-time} is enabled.
4737
4738@item -fearly-inlining
4739@opindex fearly-inlining
4740Inline functions marked by @code{always_inline} and functions whose body seems
4741smaller than the function call overhead early before doing
4742@option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4743makes profiling significantly cheaper and usually inlining faster on programs
4744having large chains of nested wrapper functions.
4745
4746Enabled by default.
4747
4748@item -finline-limit=@var{n}
4749@opindex finline-limit
4750By default, GCC limits the size of functions that can be inlined.  This flag
4751allows the control of this limit for functions that are explicitly marked as
4752inline (i.e., marked with the inline keyword or defined within the class
4753definition in c++).  @var{n} is the size of functions that can be inlined in
4754number of pseudo instructions (not counting parameter handling).  The default
4755value of @var{n} is 600.
4756Increasing this value can result in more inlined code at
4757the cost of compilation time and memory consumption.  Decreasing usually makes
4758the compilation faster and less code will be inlined (which presumably
4759means slower programs).  This option is particularly useful for programs that
4760use inlining heavily such as those based on recursive templates with C++.
4761
4762Inlining is actually controlled by a number of parameters, which may be
4763specified individually by using @option{--param @var{name}=@var{value}}.
4764The @option{-finline-limit=@var{n}} option sets some of these parameters
4765as follows:
4766
4767@table @gcctabopt
4768@item max-inline-insns-single
4769 is set to @var{n}/2.
4770@item max-inline-insns-auto
4771 is set to @var{n}/2.
4772@item min-inline-insns
4773 is set to 130 or @var{n}/4, whichever is smaller.
4774@item max-inline-insns-rtl
4775 is set to @var{n}.
4776@end table
4777
4778See below for a documentation of the individual
4779parameters controlling inlining.
4780
4781@emph{Note:} pseudo instruction represents, in this particular context, an
4782abstract measurement of function's size.  In no way does it represent a count
4783of assembly instructions and as such its exact meaning might change from one
4784release to an another.
4785
4786@item -fkeep-inline-functions
4787@opindex fkeep-inline-functions
4788In C, emit @code{static} functions that are declared @code{inline}
4789into the object file, even if the function has been inlined into all
4790of its callers.  This switch does not affect functions using the
4791@code{extern inline} extension in GNU C@.  In C++, emit any and all
4792inline functions into the object file.
4793
4794@item -fkeep-static-consts
4795@opindex fkeep-static-consts
4796Emit variables declared @code{static const} when optimization isn't turned
4797on, even if the variables aren't referenced.
4798
4799GCC enables this option by default.  If you want to force the compiler to
4800check if the variable was referenced, regardless of whether or not
4801optimization is turned on, use the @option{-fno-keep-static-consts} option.
4802
4803@item -fmerge-constants
4804Attempt to merge identical constants (string constants and floating point
4805constants) across compilation units.
4806
4807This option is the default for optimized compilation if the assembler and
4808linker support it.  Use @option{-fno-merge-constants} to inhibit this
4809behavior.
4810
4811Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4812
4813@item -fmerge-all-constants
4814Attempt to merge identical constants and identical variables.
4815
4816This option implies @option{-fmerge-constants}.  In addition to
4817@option{-fmerge-constants} this considers e.g.@: even constant initialized
4818arrays or initialized constant variables with integral or floating point
4819types.  Languages like C or C++ require each non-automatic variable to
4820have distinct location, so using this option will result in non-conforming
4821behavior.
4822
4823@item -fmodulo-sched
4824@opindex fmodulo-sched
4825Perform swing modulo scheduling immediately before the first scheduling
4826pass.  This pass looks at innermost loops and reorders their
4827instructions by overlapping different iterations.
4828
4829@item -fno-branch-count-reg
4830@opindex fno-branch-count-reg
4831Do not use ``decrement and branch'' instructions on a count register,
4832but instead generate a sequence of instructions that decrement a
4833register, compare it against zero, then branch based upon the result.
4834This option is only meaningful on architectures that support such
4835instructions, which include x86, PowerPC, IA-64 and S/390.
4836
4837The default is @option{-fbranch-count-reg}.
4838
4839@item -fno-function-cse
4840@opindex fno-function-cse
4841Do not put function addresses in registers; make each instruction that
4842calls a constant function contain the function's address explicitly.
4843
4844This option results in less efficient code, but some strange hacks
4845that alter the assembler output may be confused by the optimizations
4846performed when this option is not used.
4847
4848The default is @option{-ffunction-cse}
4849
4850@item -fno-zero-initialized-in-bss
4851@opindex fno-zero-initialized-in-bss
4852If the target supports a BSS section, GCC by default puts variables that
4853are initialized to zero into BSS@.  This can save space in the resulting
4854code.
4855
4856This option turns off this behavior because some programs explicitly
4857rely on variables going to the data section.  E.g., so that the
4858resulting executable can find the beginning of that section and/or make
4859assumptions based on that.
4860
4861The default is @option{-fzero-initialized-in-bss}.
4862
4863@item -fbounds-check
4864@opindex fbounds-check
4865For front-ends that support it, generate additional code to check that
4866indices used to access arrays are within the declared range.  This is
4867currently only supported by the Java and Fortran front-ends, where
4868this option defaults to true and false respectively.
4869
4870@item -fmudflap -fmudflapth -fmudflapir
4871@opindex fmudflap
4872@opindex fmudflapth
4873@opindex fmudflapir
4874@cindex bounds checking
4875@cindex mudflap
4876For front-ends that support it (C and C++), instrument all risky
4877pointer/array dereferencing operations, some standard library
4878string/heap functions, and some other associated constructs with
4879range/validity tests.  Modules so instrumented should be immune to
4880buffer overflows, invalid heap use, and some other classes of C/C++
4881programming errors.  The instrumentation relies on a separate runtime
4882library (@file{libmudflap}), which will be linked into a program if
4883@option{-fmudflap} is given at link time.  Run-time behavior of the
4884instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4885environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4886for its options.
4887
4888Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4889link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4890addition to @option{-fmudflap} or @option{-fmudflapth}, if
4891instrumentation should ignore pointer reads.  This produces less
4892instrumentation (and therefore faster execution) and still provides
4893some protection against outright memory corrupting writes, but allows
4894erroneously read data to propagate within a program.
4895
4896@item -fthread-jumps
4897@opindex fthread-jumps
4898Perform optimizations where we check to see if a jump branches to a
4899location where another comparison subsumed by the first is found.  If
4900so, the first branch is redirected to either the destination of the
4901second branch or a point immediately following it, depending on whether
4902the condition is known to be true or false.
4903
4904Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4905
4906@item -fcse-follow-jumps
4907@opindex fcse-follow-jumps
4908In common subexpression elimination, scan through jump instructions
4909when the target of the jump is not reached by any other path.  For
4910example, when CSE encounters an @code{if} statement with an
4911@code{else} clause, CSE will follow the jump when the condition
4912tested is false.
4913
4914Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4915
4916@item -fcse-skip-blocks
4917@opindex fcse-skip-blocks
4918This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4919follow jumps which conditionally skip over blocks.  When CSE
4920encounters a simple @code{if} statement with no else clause,
4921@option{-fcse-skip-blocks} causes CSE to follow the jump around the
4922body of the @code{if}.
4923
4924Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4925
4926@item -frerun-cse-after-loop
4927@opindex frerun-cse-after-loop
4928Re-run common subexpression elimination after loop optimizations has been
4929performed.
4930
4931Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4932
4933@item -fgcse
4934@opindex fgcse
4935Perform a global common subexpression elimination pass.
4936This pass also performs global constant and copy propagation.
4937
4938@emph{Note:} When compiling a program using computed gotos, a GCC
4939extension, you may get better runtime performance if you disable
4940the global common subexpression elimination pass by adding
4941@option{-fno-gcse} to the command line.
4942
4943Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4944
4945@item -fgcse-lm
4946@opindex fgcse-lm
4947When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4948attempt to move loads which are only killed by stores into themselves.  This
4949allows a loop containing a load/store sequence to be changed to a load outside
4950the loop, and a copy/store within the loop.
4951
4952Enabled by default when gcse is enabled.
4953
4954@item -fgcse-sm
4955@opindex fgcse-sm
4956When @option{-fgcse-sm} is enabled, a store motion pass is run after
4957global common subexpression elimination.  This pass will attempt to move
4958stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4959loops containing a load/store sequence can be changed to a load before
4960the loop and a store after the loop.
4961
4962Not enabled at any optimization level.
4963
4964@item -fgcse-las
4965@opindex fgcse-las
4966When @option{-fgcse-las} is enabled, the global common subexpression
4967elimination pass eliminates redundant loads that come after stores to the
4968same memory location (both partial and full redundancies).
4969
4970Not enabled at any optimization level.
4971
4972@item -fgcse-after-reload
4973@opindex fgcse-after-reload
4974When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4975pass is performed after reload.  The purpose of this pass is to cleanup
4976redundant spilling.
4977
4978@item -funsafe-loop-optimizations
4979@opindex funsafe-loop-optimizations
4980If given, the loop optimizer will assume that loop indices do not
4981overflow, and that the loops with nontrivial exit condition are not
4982infinite.  This enables a wider range of loop optimizations even if
4983the loop optimizer itself cannot prove that these assumptions are valid.
4984Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4985if it finds this kind of loop.
4986
4987@item -fcrossjumping
4988@opindex crossjumping
4989Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4990resulting code may or may not perform better than without cross-jumping.
4991
4992Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4993
4994@item -fif-conversion
4995@opindex if-conversion
4996Attempt to transform conditional jumps into branch-less equivalents.  This
4997include use of conditional moves, min, max, set flags and abs instructions, and
4998some tricks doable by standard arithmetics.  The use of conditional execution
4999on chips where it is available is controlled by @code{if-conversion2}.
5000
5001Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5002
5003@item -fif-conversion2
5004@opindex if-conversion2
5005Use conditional execution (where available) to transform conditional jumps into
5006branch-less equivalents.
5007
5008Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5009
5010@item -fdelete-null-pointer-checks
5011@opindex fdelete-null-pointer-checks
5012Use global dataflow analysis to identify and eliminate useless checks
5013for null pointers.  The compiler assumes that dereferencing a null
5014pointer would have halted the program.  If a pointer is checked after
5015it has already been dereferenced, it cannot be null.
5016
5017In some environments, this assumption is not true, and programs can
5018safely dereference null pointers.  Use
5019@option{-fno-delete-null-pointer-checks} to disable this optimization
5020for programs which depend on that behavior.
5021
5022Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5023
5024@item -fexpensive-optimizations
5025@opindex fexpensive-optimizations
5026Perform a number of minor optimizations that are relatively expensive.
5027
5028Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5029
5030@item -foptimize-register-move
5031@itemx -fregmove
5032@opindex foptimize-register-move
5033@opindex fregmove
5034Attempt to reassign register numbers in move instructions and as
5035operands of other simple instructions in order to maximize the amount of
5036register tying.  This is especially helpful on machines with two-operand
5037instructions.
5038
5039Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5040optimization.
5041
5042Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5043
5044@item -fdelayed-branch
5045@opindex fdelayed-branch
5046If supported for the target machine, attempt to reorder instructions
5047to exploit instruction slots available after delayed branch
5048instructions.
5049
5050Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5051
5052@item -fschedule-insns
5053@opindex fschedule-insns
5054If supported for the target machine, attempt to reorder instructions to
5055eliminate execution stalls due to required data being unavailable.  This
5056helps machines that have slow floating point or memory load instructions
5057by allowing other instructions to be issued until the result of the load
5058or floating point instruction is required.
5059
5060Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5061
5062@item -fschedule-insns2
5063@opindex fschedule-insns2
5064Similar to @option{-fschedule-insns}, but requests an additional pass of
5065instruction scheduling after register allocation has been done.  This is
5066especially useful on machines with a relatively small number of
5067registers and where memory load instructions take more than one cycle.
5068
5069Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5070
5071@item -fno-sched-interblock
5072@opindex fno-sched-interblock
5073Don't schedule instructions across basic blocks.  This is normally
5074enabled by default when scheduling before register allocation, i.e.@:
5075with @option{-fschedule-insns} or at @option{-O2} or higher.
5076
5077@item -fno-sched-spec
5078@opindex fno-sched-spec
5079Don't allow speculative motion of non-load instructions.  This is normally
5080enabled by default when scheduling before register allocation, i.e.@:
5081with @option{-fschedule-insns} or at @option{-O2} or higher.
5082
5083@item -fsched-spec-load
5084@opindex fsched-spec-load
5085Allow speculative motion of some load instructions.  This only makes
5086sense when scheduling before register allocation, i.e.@: with
5087@option{-fschedule-insns} or at @option{-O2} or higher.
5088
5089@item -fsched-spec-load-dangerous
5090@opindex fsched-spec-load-dangerous
5091Allow speculative motion of more load instructions.  This only makes
5092sense when scheduling before register allocation, i.e.@: with
5093@option{-fschedule-insns} or at @option{-O2} or higher.
5094
5095@item -fsched-stalled-insns=@var{n}
5096@opindex fsched-stalled-insns
5097Define how many insns (if any) can be moved prematurely from the queue
5098of stalled insns into the ready list, during the second scheduling pass.
5099
5100@item -fsched-stalled-insns-dep=@var{n}
5101@opindex fsched-stalled-insns-dep
5102Define how many insn groups (cycles) will be examined for a dependency
5103on a stalled insn that is candidate for premature removal from the queue
5104of stalled insns.  Has an effect only during the second scheduling pass,
5105and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5106
5107@item -fsched2-use-superblocks
5108@opindex fsched2-use-superblocks
5109When scheduling after register allocation, do use superblock scheduling
5110algorithm.  Superblock scheduling allows motion across basic block boundaries
5111resulting on faster schedules.  This option is experimental, as not all machine
5112descriptions used by GCC model the CPU closely enough to avoid unreliable
5113results from the algorithm.
5114
5115This only makes sense when scheduling after register allocation, i.e.@: with
5116@option{-fschedule-insns2} or at @option{-O2} or higher.
5117
5118@item -fsched2-use-traces
5119@opindex fsched2-use-traces
5120Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5121allocation and additionally perform code duplication in order to increase the
5122size of superblocks using tracer pass.  See @option{-ftracer} for details on
5123trace formation.
5124
5125This mode should produce faster but significantly longer programs.  Also
5126without @option{-fbranch-probabilities} the traces constructed may not
5127match the reality and hurt the performance.  This only makes
5128sense when scheduling after register allocation, i.e.@: with
5129@option{-fschedule-insns2} or at @option{-O2} or higher.
5130
5131@item -fsee
5132@opindex fsee
5133Eliminates redundant extension instructions and move the non redundant
5134ones to optimal placement using LCM.
5135
5136@item -freschedule-modulo-scheduled-loops
5137@opindex fscheduling-in-modulo-scheduled-loops
5138The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
5139we may want to prevent the later scheduling passes from changing its schedule, we use this
5140option to control that.
5141
5142@item -fcaller-saves
5143@opindex fcaller-saves
5144Enable values to be allocated in registers that will be clobbered by
5145function calls, by emitting extra instructions to save and restore the
5146registers around such calls.  Such allocation is done only when it
5147seems to result in better code than would otherwise be produced.
5148
5149This option is always enabled by default on certain machines, usually
5150those which have no call-preserved registers to use instead.
5151
5152Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5153
5154@item -ftree-pre
5155Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5156enabled by default at @option{-O2} and @option{-O3}.
5157
5158@item -ftree-fre
5159Perform Full Redundancy Elimination (FRE) on trees.  The difference
5160between FRE and PRE is that FRE only considers expressions
5161that are computed on all paths leading to the redundant computation.
5162This analysis faster than PRE, though it exposes fewer redundancies.
5163This flag is enabled by default at @option{-O} and higher.
5164
5165@item -ftree-copy-prop
5166Perform copy propagation on trees.  This pass eliminates unnecessary
5167copy operations.  This flag is enabled by default at @option{-O} and
5168higher.
5169
5170@item -ftree-store-copy-prop
5171Perform copy propagation of memory loads and stores.  This pass
5172eliminates unnecessary copy operations in memory references
5173(structures, global variables, arrays, etc).  This flag is enabled by
5174default at @option{-O2} and higher.
5175
5176@item -ftree-salias
5177Perform structural alias analysis on trees.  This flag
5178is enabled by default at @option{-O} and higher.
5179
5180@item -fipa-pta
5181Perform interprocedural pointer analysis.
5182
5183@item -ftree-sink
5184Perform forward store motion  on trees.  This flag is
5185enabled by default at @option{-O} and higher.
5186
5187@item -ftree-ccp
5188Perform sparse conditional constant propagation (CCP) on trees.  This
5189pass only operates on local scalar variables and is enabled by default
5190at @option{-O} and higher.
5191
5192@item -ftree-store-ccp
5193Perform sparse conditional constant propagation (CCP) on trees.  This
5194pass operates on both local scalar variables and memory stores and
5195loads (global variables, structures, arrays, etc).  This flag is
5196enabled by default at @option{-O2} and higher.
5197
5198@item -ftree-dce
5199Perform dead code elimination (DCE) on trees.  This flag is enabled by
5200default at @option{-O} and higher.
5201
5202@item -ftree-dominator-opts
5203Perform a variety of simple scalar cleanups (constant/copy
5204propagation, redundancy elimination, range propagation and expression
5205simplification) based on a dominator tree traversal.  This also
5206performs jump threading (to reduce jumps to jumps). This flag is
5207enabled by default at @option{-O} and higher.
5208
5209@item -ftree-ch
5210Perform loop header copying on trees.  This is beneficial since it increases
5211effectiveness of code motion optimizations.  It also saves one jump.  This flag
5212is enabled by default at @option{-O} and higher.  It is not enabled
5213for @option{-Os}, since it usually increases code size.
5214
5215@item -ftree-loop-optimize
5216Perform loop optimizations on trees.  This flag is enabled by default
5217at @option{-O} and higher.
5218
5219@item -ftree-loop-linear
5220Perform linear loop transformations on tree.  This flag can improve cache
5221performance and allow further loop optimizations to take place.
5222
5223@item -ftree-loop-im
5224Perform loop invariant motion on trees.  This pass moves only invariants that
5225would be hard to handle at RTL level (function calls, operations that expand to
5226nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5227operands of conditions that are invariant out of the loop, so that we can use
5228just trivial invariantness analysis in loop unswitching.  The pass also includes
5229store motion.
5230
5231@item -ftree-loop-ivcanon
5232Create a canonical counter for number of iterations in the loop for that
5233determining number of iterations requires complicated analysis.  Later
5234optimizations then may determine the number easily.  Useful especially
5235in connection with unrolling.
5236
5237@item -fivopts
5238Perform induction variable optimizations (strength reduction, induction
5239variable merging and induction variable elimination) on trees.
5240
5241@item -ftree-sra
5242Perform scalar replacement of aggregates.  This pass replaces structure
5243references with scalars to prevent committing structures to memory too
5244early.  This flag is enabled by default at @option{-O} and higher.
5245
5246@item -ftree-copyrename
5247Perform copy renaming on trees.  This pass attempts to rename compiler
5248temporaries to other variables at copy locations, usually resulting in
5249variable names which more closely resemble the original variables.  This flag
5250is enabled by default at @option{-O} and higher.
5251
5252@item -ftree-ter
5253Perform temporary expression replacement during the SSA->normal phase.  Single
5254use/single def temporaries are replaced at their use location with their
5255defining expression.  This results in non-GIMPLE code, but gives the expanders
5256much more complex trees to work on resulting in better RTL generation.  This is
5257enabled by default at @option{-O} and higher.
5258
5259@item -ftree-lrs
5260Perform live range splitting during the SSA->normal phase.  Distinct live
5261ranges of a variable are split into unique variables, allowing for better
5262optimization later.  This is enabled by default at @option{-O} and higher.
5263
5264@item -ftree-vectorize
5265Perform loop vectorization on trees.
5266
5267@item -ftree-vect-loop-version
5268@opindex ftree-vect-loop-version
5269Perform loop versioning when doing loop vectorization on trees.  When a loop
5270appears to be vectorizable except that data alignment or data dependence cannot
5271be determined at compile time then vectorized and non-vectorized versions of
5272the loop are generated along with runtime checks for alignment or dependence
5273to control which version is executed.  This option is enabled by default
5274except at level @option{-Os} where it is disabled.
5275
5276@item -ftree-vrp
5277Perform Value Range Propagation on trees.  This is similar to the
5278constant propagation pass, but instead of values, ranges of values are
5279propagated.  This allows the optimizers to remove unnecessary range
5280checks like array bound checks and null pointer checks.  This is
5281enabled by default at @option{-O2} and higher.  Null pointer check
5282elimination is only done if @option{-fdelete-null-pointer-checks} is
5283enabled.
5284
5285@item -ftracer
5286@opindex ftracer
5287Perform tail duplication to enlarge superblock size.  This transformation
5288simplifies the control flow of the function allowing other optimizations to do
5289better job.
5290
5291@item -funroll-loops
5292@opindex funroll-loops
5293Unroll loops whose number of iterations can be determined at compile
5294time or upon entry to the loop.  @option{-funroll-loops} implies
5295@option{-frerun-cse-after-loop}.  This option makes code larger,
5296and may or may not make it run faster.
5297
5298@item -funroll-all-loops
5299@opindex funroll-all-loops
5300Unroll all loops, even if their number of iterations is uncertain when
5301the loop is entered.  This usually makes programs run more slowly.
5302@option{-funroll-all-loops} implies the same options as
5303@option{-funroll-loops},
5304
5305@item -fsplit-ivs-in-unroller
5306@opindex fsplit-ivs-in-unroller
5307Enables expressing of values of induction variables in later iterations
5308of the unrolled loop using the value in the first iteration.  This breaks
5309long dependency chains, thus improving efficiency of the scheduling passes.
5310
5311Combination of @option{-fweb} and CSE is often sufficient to obtain the
5312same effect.  However in cases the loop body is more complicated than
5313a single basic block, this is not reliable.  It also does not work at all
5314on some of the architectures due to restrictions in the CSE pass.
5315
5316This optimization is enabled by default.
5317
5318@item -fvariable-expansion-in-unroller
5319@opindex fvariable-expansion-in-unroller
5320With this option, the compiler will create multiple copies of some
5321local variables when unrolling a loop which can result in superior code.
5322
5323@item -fprefetch-loop-arrays
5324@opindex fprefetch-loop-arrays
5325If supported by the target machine, generate instructions to prefetch
5326memory to improve the performance of loops that access large arrays.
5327
5328This option may generate better or worse code; results are highly
5329dependent on the structure of loops within the source code.
5330
5331Disabled at level @option{-Os}.
5332
5333@item -fno-peephole
5334@itemx -fno-peephole2
5335@opindex fno-peephole
5336@opindex fno-peephole2
5337Disable any machine-specific peephole optimizations.  The difference
5338between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5339are implemented in the compiler; some targets use one, some use the
5340other, a few use both.
5341
5342@option{-fpeephole} is enabled by default.
5343@option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5344
5345@item -fno-guess-branch-probability
5346@opindex fno-guess-branch-probability
5347Do not guess branch probabilities using heuristics.
5348
5349GCC will use heuristics to guess branch probabilities if they are
5350not provided by profiling feedback (@option{-fprofile-arcs}).  These
5351heuristics are based on the control flow graph.  If some branch probabilities
5352are specified by @samp{__builtin_expect}, then the heuristics will be
5353used to guess branch probabilities for the rest of the control flow graph,
5354taking the @samp{__builtin_expect} info into account.  The interactions
5355between the heuristics and @samp{__builtin_expect} can be complex, and in
5356some cases, it may be useful to disable the heuristics so that the effects
5357of @samp{__builtin_expect} are easier to understand.
5358
5359The default is @option{-fguess-branch-probability} at levels
5360@option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5361
5362@item -freorder-blocks
5363@opindex freorder-blocks
5364Reorder basic blocks in the compiled function in order to reduce number of
5365taken branches and improve code locality.
5366
5367Enabled at levels @option{-O2}, @option{-O3}.
5368
5369@item -freorder-blocks-and-partition
5370@opindex freorder-blocks-and-partition
5371In addition to reordering basic blocks in the compiled function, in order
5372to reduce number of taken branches, partitions hot and cold basic blocks
5373into separate sections of the assembly and .o files, to improve
5374paging and cache locality performance.
5375
5376This optimization is automatically turned off in the presence of
5377exception handling, for linkonce sections, for functions with a user-defined
5378section attribute and on any architecture that does not support named
5379sections.
5380
5381@item -freorder-functions
5382@opindex freorder-functions
5383Reorder functions in the object file in order to
5384improve code locality.  This is implemented by using special
5385subsections @code{.text.hot} for most frequently executed functions and
5386@code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5387the linker so object file format must support named sections and linker must
5388place them in a reasonable way.
5389
5390Also profile feedback must be available in to make this option effective.  See
5391@option{-fprofile-arcs} for details.
5392
5393Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5394
5395@item -fstrict-aliasing
5396@opindex fstrict-aliasing
5397Allows the compiler to assume the strictest aliasing rules applicable to
5398the language being compiled.  For C (and C++), this activates
5399optimizations based on the type of expressions.  In particular, an
5400object of one type is assumed never to reside at the same address as an
5401object of a different type, unless the types are almost the same.  For
5402example, an @code{unsigned int} can alias an @code{int}, but not a
5403@code{void*} or a @code{double}.  A character type may alias any other
5404type.
5405
5406Pay special attention to code like this:
5407@smallexample
5408union a_union @{
5409  int i;
5410  double d;
5411@};
5412
5413int f() @{
5414  a_union t;
5415  t.d = 3.0;
5416  return t.i;
5417@}
5418@end smallexample
5419The practice of reading from a different union member than the one most
5420recently written to (called ``type-punning'') is common.  Even with
5421@option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5422is accessed through the union type.  So, the code above will work as
5423expected.  However, this code might not:
5424@smallexample
5425int f() @{
5426  a_union t;
5427  int* ip;
5428  t.d = 3.0;
5429  ip = &t.i;
5430  return *ip;
5431@}
5432@end smallexample
5433
5434Every language that wishes to perform language-specific alias analysis
5435should define a function that computes, given an @code{tree}
5436node, an alias set for the node.  Nodes in different alias sets are not
5437allowed to alias.  For an example, see the C front-end function
5438@code{c_get_alias_set}.
5439
5440Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5441
5442@item -fstrict-overflow
5443@opindex fstrict-overflow
5444Allow the compiler to assume strict signed overflow rules, depending
5445on the language being compiled.  For C (and C++) this means that
5446overflow when doing arithmetic with signed numbers is undefined, which
5447means that the compiler may assume that it will not happen.  This
5448permits various optimizations.  For example, the compiler will assume
5449that an expression like @code{i + 10 > i} will always be true for
5450signed @code{i}.  This assumption is only valid if signed overflow is
5451undefined, as the expression is false if @code{i + 10} overflows when
5452using twos complement arithmetic.  When this option is in effect any
5453attempt to determine whether an operation on signed numbers will
5454overflow must be written carefully to not actually involve overflow.
5455
5456See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
5457that signed overflow is fully defined: it wraps.  When
5458@option{-fwrapv} is used, there is no difference between
5459@option{-fstrict-overflow} and @option{-fno-strict-overflow}.  With
5460@option{-fwrapv} certain types of overflow are permitted.  For
5461example, if the compiler gets an overflow when doing arithmetic on
5462constants, the overflowed value can still be used with
5463@option{-fwrapv}, but not otherwise.
5464
5465The @option{-fstrict-overflow} option is enabled at levels
5466@option{-O2}, @option{-O3}, @option{-Os}.
5467
5468@item -falign-functions
5469@itemx -falign-functions=@var{n}
5470@opindex falign-functions
5471Align the start of functions to the next power-of-two greater than
5472@var{n}, skipping up to @var{n} bytes.  For instance,
5473@option{-falign-functions=32} aligns functions to the next 32-byte
5474boundary, but @option{-falign-functions=24} would align to the next
547532-byte boundary only if this can be done by skipping 23 bytes or less.
5476
5477@option{-fno-align-functions} and @option{-falign-functions=1} are
5478equivalent and mean that functions will not be aligned.
5479
5480Some assemblers only support this flag when @var{n} is a power of two;
5481in that case, it is rounded up.
5482
5483If @var{n} is not specified or is zero, use a machine-dependent default.
5484
5485Enabled at levels @option{-O2}, @option{-O3}.
5486
5487@item -falign-labels
5488@itemx -falign-labels=@var{n}
5489@opindex falign-labels
5490Align all branch targets to a power-of-two boundary, skipping up to
5491@var{n} bytes like @option{-falign-functions}.  This option can easily
5492make code slower, because it must insert dummy operations for when the
5493branch target is reached in the usual flow of the code.
5494
5495@option{-fno-align-labels} and @option{-falign-labels=1} are
5496equivalent and mean that labels will not be aligned.
5497
5498If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5499are greater than this value, then their values are used instead.
5500
5501If @var{n} is not specified or is zero, use a machine-dependent default
5502which is very likely to be @samp{1}, meaning no alignment.
5503
5504Enabled at levels @option{-O2}, @option{-O3}.
5505
5506@item -falign-loops
5507@itemx -falign-loops=@var{n}
5508@opindex falign-loops
5509Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5510like @option{-falign-functions}.  The hope is that the loop will be
5511executed many times, which will make up for any execution of the dummy
5512operations.
5513
5514@option{-fno-align-loops} and @option{-falign-loops=1} are
5515equivalent and mean that loops will not be aligned.
5516
5517If @var{n} is not specified or is zero, use a machine-dependent default.
5518
5519Enabled at levels @option{-O2}, @option{-O3}.
5520
5521@item -falign-jumps
5522@itemx -falign-jumps=@var{n}
5523@opindex falign-jumps
5524Align branch targets to a power-of-two boundary, for branch targets
5525where the targets can only be reached by jumping, skipping up to @var{n}
5526bytes like @option{-falign-functions}.  In this case, no dummy operations
5527need be executed.
5528
5529@option{-fno-align-jumps} and @option{-falign-jumps=1} are
5530equivalent and mean that loops will not be aligned.
5531
5532If @var{n} is not specified or is zero, use a machine-dependent default.
5533
5534Enabled at levels @option{-O2}, @option{-O3}.
5535
5536@item -funit-at-a-time
5537@opindex funit-at-a-time
5538Parse the whole compilation unit before starting to produce code.
5539This allows some extra optimizations to take place but consumes
5540more memory (in general).  There are some compatibility issues
5541with @emph{unit-at-a-time} mode:
5542@itemize @bullet
5543@item
5544enabling @emph{unit-at-a-time} mode may change the order
5545in which functions, variables, and top-level @code{asm} statements
5546are emitted, and will likely break code relying on some particular
5547ordering.  The majority of such top-level @code{asm} statements,
5548though, can be replaced by @code{section} attributes.  The
5549@option{fno-toplevel-reorder} option may be used to keep the ordering
5550used in the input file, at the cost of some optimizations.
5551
5552@item
5553@emph{unit-at-a-time} mode removes unreferenced static variables
5554and functions.  This may result in undefined references
5555when an @code{asm} statement refers directly to variables or functions
5556that are otherwise unused.  In that case either the variable/function
5557shall be listed as an operand of the @code{asm} statement operand or,
5558in the case of top-level @code{asm} statements the attribute @code{used}
5559shall be used on the declaration.
5560
5561@item
5562Static functions now can use non-standard passing conventions that
5563may break @code{asm} statements calling functions directly.  Again,
5564attribute @code{used} will prevent this behavior.
5565@end itemize
5566
5567As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5568but this scheme may not be supported by future releases of GCC@.
5569
5570Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5571
5572@item -fno-toplevel-reorder
5573Do not reorder top-level functions, variables, and @code{asm}
5574statements.  Output them in the same order that they appear in the
5575input file.  When this option is used, unreferenced static variables
5576will not be removed.  This option is intended to support existing code
5577which relies on a particular ordering.  For new code, it is better to
5578use attributes.
5579
5580@item -fweb
5581@opindex fweb
5582Constructs webs as commonly used for register allocation purposes and assign
5583each web individual pseudo register.  This allows the register allocation pass
5584to operate on pseudos directly, but also strengthens several other optimization
5585passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5586however, make debugging impossible, since variables will no longer stay in a
5587``home register''.
5588
5589Enabled by default with @option{-funroll-loops}.
5590
5591@item -fwhole-program
5592@opindex fwhole-program
5593Assume that the current compilation unit represents whole program being
5594compiled.  All public functions and variables with the exception of @code{main}
5595and those merged by attribute @code{externally_visible} become static functions
5596and in a affect gets more aggressively optimized by interprocedural optimizers.
5597While this option is equivalent to proper use of @code{static} keyword for
5598programs consisting of single file, in combination with option
5599@option{--combine} this flag can be used to compile most of smaller scale C
5600programs since the functions and variables become local for the whole combined
5601compilation unit, not for the single source file itself.
5602
5603
5604@item -fno-cprop-registers
5605@opindex fno-cprop-registers
5606After register allocation and post-register allocation instruction splitting,
5607we perform a copy-propagation pass to try to reduce scheduling dependencies
5608and occasionally eliminate the copy.
5609
5610Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5611
5612@item -fprofile-generate
5613@opindex fprofile-generate
5614
5615Enable options usually used for instrumenting application to produce
5616profile useful for later recompilation with profile feedback based
5617optimization.  You must use @option{-fprofile-generate} both when
5618compiling and when linking your program.
5619
5620The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5621
5622@item -fprofile-use
5623@opindex fprofile-use
5624Enable profile feedback directed optimizations, and optimizations
5625generally profitable only with profile feedback available.
5626
5627The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5628@code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
5629
5630@end table
5631
5632The following options control compiler behavior regarding floating
5633point arithmetic.  These options trade off between speed and
5634correctness.  All must be specifically enabled.
5635
5636@table @gcctabopt
5637@item -ffloat-store
5638@opindex ffloat-store
5639Do not store floating point variables in registers, and inhibit other
5640options that might change whether a floating point value is taken from a
5641register or memory.
5642
5643@cindex floating point precision
5644This option prevents undesirable excess precision on machines such as
5645the 68000 where the floating registers (of the 68881) keep more
5646precision than a @code{double} is supposed to have.  Similarly for the
5647x86 architecture.  For most programs, the excess precision does only
5648good, but a few programs rely on the precise definition of IEEE floating
5649point.  Use @option{-ffloat-store} for such programs, after modifying
5650them to store all pertinent intermediate computations into variables.
5651
5652@item -ffast-math
5653@opindex ffast-math
5654Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5655@option{-fno-trapping-math}, @option{-ffinite-math-only},
5656@option{-fno-rounding-math}, @option{-fno-signaling-nans}
5657and @option{fcx-limited-range}.
5658
5659This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5660
5661This option should never be turned on by any @option{-O} option since
5662it can result in incorrect output for programs which depend on
5663an exact implementation of IEEE or ISO rules/specifications for
5664math functions.
5665
5666@item -fno-math-errno
5667@opindex fno-math-errno
5668Do not set ERRNO after calling math functions that are executed
5669with a single instruction, e.g., sqrt.  A program that relies on
5670IEEE exceptions for math error handling may want to use this flag
5671for speed while maintaining IEEE arithmetic compatibility.
5672
5673This option should never be turned on by any @option{-O} option since
5674it can result in incorrect output for programs which depend on
5675an exact implementation of IEEE or ISO rules/specifications for
5676math functions.
5677
5678The default is @option{-fmath-errno}.
5679
5680On Darwin systems, the math library never sets @code{errno}.  There is therefore
5681no reason for the compiler to consider the possibility that it might,
5682and @option{-fno-math-errno} is the default.
5683
5684@item -funsafe-math-optimizations
5685@opindex funsafe-math-optimizations
5686Allow optimizations for floating-point arithmetic that (a) assume
5687that arguments and results are valid and (b) may violate IEEE or
5688ANSI standards.  When used at link-time, it may include libraries
5689or startup files that change the default FPU control word or other
5690similar optimizations.
5691
5692This option should never be turned on by any @option{-O} option since
5693it can result in incorrect output for programs which depend on
5694an exact implementation of IEEE or ISO rules/specifications for
5695math functions.
5696
5697The default is @option{-fno-unsafe-math-optimizations}.
5698
5699@item -ffinite-math-only
5700@opindex ffinite-math-only
5701Allow optimizations for floating-point arithmetic that assume
5702that arguments and results are not NaNs or +-Infs.
5703
5704This option should never be turned on by any @option{-O} option since
5705it can result in incorrect output for programs which depend on
5706an exact implementation of IEEE or ISO rules/specifications.
5707
5708The default is @option{-fno-finite-math-only}.
5709
5710@item -fno-trapping-math
5711@opindex fno-trapping-math
5712Compile code assuming that floating-point operations cannot generate
5713user-visible traps.  These traps include division by zero, overflow,
5714underflow, inexact result and invalid operation.  This option implies
5715@option{-fno-signaling-nans}.  Setting this option may allow faster
5716code if one relies on ``non-stop'' IEEE arithmetic, for example.
5717
5718This option should never be turned on by any @option{-O} option since
5719it can result in incorrect output for programs which depend on
5720an exact implementation of IEEE or ISO rules/specifications for
5721math functions.
5722
5723The default is @option{-ftrapping-math}.
5724
5725@item -frounding-math
5726@opindex frounding-math
5727Disable transformations and optimizations that assume default floating
5728point rounding behavior.  This is round-to-zero for all floating point
5729to integer conversions, and round-to-nearest for all other arithmetic
5730truncations.  This option should be specified for programs that change
5731the FP rounding mode dynamically, or that may be executed with a
5732non-default rounding mode.  This option disables constant folding of
5733floating point expressions at compile-time (which may be affected by
5734rounding mode) and arithmetic transformations that are unsafe in the
5735presence of sign-dependent rounding modes.
5736
5737The default is @option{-fno-rounding-math}.
5738
5739This option is experimental and does not currently guarantee to
5740disable all GCC optimizations that are affected by rounding mode.
5741Future versions of GCC may provide finer control of this setting
5742using C99's @code{FENV_ACCESS} pragma.  This command line option
5743will be used to specify the default state for @code{FENV_ACCESS}.
5744
5745@item -frtl-abstract-sequences
5746@opindex frtl-abstract-sequences
5747It is a size optimization method. This option is to find identical
5748sequences of code, which can be turned into pseudo-procedures  and
5749then  replace  all  occurrences with  calls to  the  newly created
5750subroutine. It is kind of an opposite of @option{-finline-functions}.
5751This optimization runs at RTL level.
5752
5753@item -fsignaling-nans
5754@opindex fsignaling-nans
5755Compile code assuming that IEEE signaling NaNs may generate user-visible
5756traps during floating-point operations.  Setting this option disables
5757optimizations that may change the number of exceptions visible with
5758signaling NaNs.  This option implies @option{-ftrapping-math}.
5759
5760This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5761be defined.
5762
5763The default is @option{-fno-signaling-nans}.
5764
5765This option is experimental and does not currently guarantee to
5766disable all GCC optimizations that affect signaling NaN behavior.
5767
5768@item -fsingle-precision-constant
5769@opindex fsingle-precision-constant
5770Treat floating point constant as single precision constant instead of
5771implicitly converting it to double precision constant.
5772
5773@item -fcx-limited-range
5774@itemx -fno-cx-limited-range
5775@opindex fcx-limited-range
5776@opindex fno-cx-limited-range
5777When enabled, this option states that a range reduction step is not
5778needed when performing complex division.  The default is
5779@option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5780
5781This option controls the default setting of the ISO C99
5782@code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5783all languages.
5784
5785@end table
5786
5787The following options control optimizations that may improve
5788performance, but are not enabled by any @option{-O} options.  This
5789section includes experimental options that may produce broken code.
5790
5791@table @gcctabopt
5792@item -fbranch-probabilities
5793@opindex fbranch-probabilities
5794After running a program compiled with @option{-fprofile-arcs}
5795(@pxref{Debugging Options,, Options for Debugging Your Program or
5796@command{gcc}}), you can compile it a second time using
5797@option{-fbranch-probabilities}, to improve optimizations based on
5798the number of times each branch was taken.  When the program
5799compiled with @option{-fprofile-arcs} exits it saves arc execution
5800counts to a file called @file{@var{sourcename}.gcda} for each source
5801file  The information in this data file is very dependent on the
5802structure of the generated code, so you must use the same source code
5803and the same optimization options for both compilations.
5804
5805With @option{-fbranch-probabilities}, GCC puts a
5806@samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5807These can be used to improve optimization.  Currently, they are only
5808used in one place: in @file{reorg.c}, instead of guessing which path a
5809branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5810exactly determine which path is taken more often.
5811
5812@item -fprofile-values
5813@opindex fprofile-values
5814If combined with @option{-fprofile-arcs}, it adds code so that some
5815data about values of expressions in the program is gathered.
5816
5817With @option{-fbranch-probabilities}, it reads back the data gathered
5818from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5819notes to instructions for their later usage in optimizations.
5820
5821Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5822
5823@item -fvpt
5824@opindex fvpt
5825If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5826a code to gather information about values of expressions.
5827
5828With @option{-fbranch-probabilities}, it reads back the data gathered
5829and actually performs the optimizations based on them.
5830Currently the optimizations include specialization of division operation
5831using the knowledge about the value of the denominator.
5832
5833@item -frename-registers
5834@opindex frename-registers
5835Attempt to avoid false dependencies in scheduled code by making use
5836of registers left over after register allocation.  This optimization
5837will most benefit processors with lots of registers.  Depending on the
5838debug information format adopted by the target, however, it can
5839make debugging impossible, since variables will no longer stay in
5840a ``home register''.
5841
5842Enabled by default with @option{-funroll-loops}.
5843
5844@item -ftracer
5845@opindex ftracer
5846Perform tail duplication to enlarge superblock size.  This transformation
5847simplifies the control flow of the function allowing other optimizations to do
5848better job.
5849
5850Enabled with @option{-fprofile-use}.
5851
5852@item -funroll-loops
5853@opindex funroll-loops
5854Unroll loops whose number of iterations can be determined at compile time or
5855upon entry to the loop.  @option{-funroll-loops} implies
5856@option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
5857It also turns on complete loop peeling (i.e.@: complete removal of loops with
5858small constant number of iterations).  This option makes code larger, and may
5859or may not make it run faster.
5860
5861Enabled with @option{-fprofile-use}.
5862
5863@item -funroll-all-loops
5864@opindex funroll-all-loops
5865Unroll all loops, even if their number of iterations is uncertain when
5866the loop is entered.  This usually makes programs run more slowly.
5867@option{-funroll-all-loops} implies the same options as
5868@option{-funroll-loops}.
5869
5870@item -fpeel-loops
5871@opindex fpeel-loops
5872Peels the loops for that there is enough information that they do not
5873roll much (from profile feedback).  It also turns on complete loop peeling
5874(i.e.@: complete removal of loops with small constant number of iterations).
5875
5876Enabled with @option{-fprofile-use}.
5877
5878@item -fmove-loop-invariants
5879@opindex fmove-loop-invariants
5880Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
5881at level @option{-O1}
5882
5883@item -funswitch-loops
5884@opindex funswitch-loops
5885Move branches with loop invariant conditions out of the loop, with duplicates
5886of the loop on both branches (modified according to result of the condition).
5887
5888@item -ffunction-sections
5889@itemx -fdata-sections
5890@opindex ffunction-sections
5891@opindex fdata-sections
5892Place each function or data item into its own section in the output
5893file if the target supports arbitrary sections.  The name of the
5894function or the name of the data item determines the section's name
5895in the output file.
5896
5897Use these options on systems where the linker can perform optimizations
5898to improve locality of reference in the instruction space.  Most systems
5899using the ELF object format and SPARC processors running Solaris 2 have
5900linkers with such optimizations.  AIX may have these optimizations in
5901the future.
5902
5903Only use these options when there are significant benefits from doing
5904so.  When you specify these options, the assembler and linker will
5905create larger object and executable files and will also be slower.
5906You will not be able to use @code{gprof} on all systems if you
5907specify this option and you may have problems with debugging if
5908you specify both this option and @option{-g}.
5909
5910@item -fbranch-target-load-optimize
5911@opindex fbranch-target-load-optimize
5912Perform branch target register load optimization before prologue / epilogue
5913threading.
5914The use of target registers can typically be exposed only during reload,
5915thus hoisting loads out of loops and doing inter-block scheduling needs
5916a separate optimization pass.
5917
5918@item -fbranch-target-load-optimize2
5919@opindex fbranch-target-load-optimize2
5920Perform branch target register load optimization after prologue / epilogue
5921threading.
5922
5923@item -fbtr-bb-exclusive
5924@opindex fbtr-bb-exclusive
5925When performing branch target register load optimization, don't reuse
5926branch target registers in within any basic block.
5927
5928@item -fstack-protector
5929Emit extra code to check for buffer overflows, such as stack smashing
5930attacks.  This is done by adding a guard variable to functions with
5931vulnerable objects.  This includes functions that call alloca, and
5932functions with buffers larger than 8 bytes.  The guards are initialized
5933when a function is entered and then checked when the function exits.
5934If a guard check fails, an error message is printed and the program exits.
5935
5936@item -fstack-protector-all
5937Like @option{-fstack-protector} except that all functions are protected.
5938
5939@item -fstack-protector-strong
5940Like @option{-fstack-protector} but includes additional functions to
5941be protected --- those that have local array definitions, or have
5942references to local frame addresses.
5943
5944@item -fsection-anchors
5945@opindex fsection-anchors
5946Try to reduce the number of symbolic address calculations by using
5947shared ``anchor'' symbols to address nearby objects.  This transformation
5948can help to reduce the number of GOT entries and GOT accesses on some
5949targets.
5950
5951For example, the implementation of the following function @code{foo}:
5952
5953@smallexample
5954static int a, b, c;
5955int foo (void) @{ return a + b + c; @}
5956@end smallexample
5957
5958would usually calculate the addresses of all three variables, but if you
5959compile it with @option{-fsection-anchors}, it will access the variables
5960from a common anchor point instead.  The effect is similar to the
5961following pseudocode (which isn't valid C):
5962
5963@smallexample
5964int foo (void)
5965@{
5966  register int *xr = &x;
5967  return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
5968@}
5969@end smallexample
5970
5971Not all targets support this option.
5972
5973@item --param @var{name}=@var{value}
5974@opindex param
5975In some places, GCC uses various constants to control the amount of
5976optimization that is done.  For example, GCC will not inline functions
5977that contain more that a certain number of instructions.  You can
5978control some of these constants on the command-line using the
5979@option{--param} option.
5980
5981The names of specific parameters, and the meaning of the values, are
5982tied to the internals of the compiler, and are subject to change
5983without notice in future releases.
5984
5985In each case, the @var{value} is an integer.  The allowable choices for
5986@var{name} are given in the following table:
5987
5988@table @gcctabopt
5989@item salias-max-implicit-fields
5990The maximum number of fields in a variable without direct
5991structure accesses for which structure aliasing will consider trying
5992to track each field.  The default is 5
5993
5994@item salias-max-array-elements
5995The maximum number of elements an array can have and its elements
5996still be tracked individually by structure aliasing. The default is 4
5997
5998@item sra-max-structure-size
5999The maximum structure size, in bytes, at which the scalar replacement
6000of aggregates (SRA) optimization will perform block copies.  The
6001default value, 0, implies that GCC will select the most appropriate
6002size itself.
6003
6004@item sra-field-structure-ratio
6005The threshold ratio (as a percentage) between instantiated fields and
6006the complete structure size.  We say that if the ratio of the number
6007of bytes in instantiated fields to the number of bytes in the complete
6008structure exceeds this parameter, then block copies are not used.  The
6009default is 75.
6010
6011@item max-crossjump-edges
6012The maximum number of incoming edges to consider for crossjumping.
6013The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6014the number of edges incoming to each block.  Increasing values mean
6015more aggressive optimization, making the compile time increase with
6016probably small improvement in executable size.
6017
6018@item min-crossjump-insns
6019The minimum number of instructions which must be matched at the end
6020of two blocks before crossjumping will be performed on them.  This
6021value is ignored in the case where all instructions in the block being
6022crossjumped from are matched.  The default value is 5.
6023
6024@item max-grow-copy-bb-insns
6025The maximum code size expansion factor when copying basic blocks
6026instead of jumping.  The expansion is relative to a jump instruction.
6027The default value is 8.
6028
6029@item max-goto-duplication-insns
6030The maximum number of instructions to duplicate to a block that jumps
6031to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6032passes, GCC factors computed gotos early in the compilation process,
6033and unfactors them as late as possible.  Only computed jumps at the
6034end of a basic blocks with no more than max-goto-duplication-insns are
6035unfactored.  The default value is 8.
6036
6037@item max-delay-slot-insn-search
6038The maximum number of instructions to consider when looking for an
6039instruction to fill a delay slot.  If more than this arbitrary number of
6040instructions is searched, the time savings from filling the delay slot
6041will be minimal so stop searching.  Increasing values mean more
6042aggressive optimization, making the compile time increase with probably
6043small improvement in executable run time.
6044
6045@item max-delay-slot-live-search
6046When trying to fill delay slots, the maximum number of instructions to
6047consider when searching for a block with valid live register
6048information.  Increasing this arbitrarily chosen value means more
6049aggressive optimization, increasing the compile time.  This parameter
6050should be removed when the delay slot code is rewritten to maintain the
6051control-flow graph.
6052
6053@item max-gcse-memory
6054The approximate maximum amount of memory that will be allocated in
6055order to perform the global common subexpression elimination
6056optimization.  If more memory than specified is required, the
6057optimization will not be done.
6058
6059@item max-gcse-passes
6060The maximum number of passes of GCSE to run.  The default is 1.
6061
6062@item max-pending-list-length
6063The maximum number of pending dependencies scheduling will allow
6064before flushing the current state and starting over.  Large functions
6065with few branches or calls can create excessively large lists which
6066needlessly consume memory and resources.
6067
6068@item max-inline-insns-single
6069Several parameters control the tree inliner used in gcc.
6070This number sets the maximum number of instructions (counted in GCC's
6071internal representation) in a single function that the tree inliner
6072will consider for inlining.  This only affects functions declared
6073inline and methods implemented in a class declaration (C++).
6074The default value is 450.
6075
6076@item max-inline-insns-auto
6077When you use @option{-finline-functions} (included in @option{-O3}),
6078a lot of functions that would otherwise not be considered for inlining
6079by the compiler will be investigated.  To those functions, a different
6080(more restrictive) limit compared to functions declared inline can
6081be applied.
6082The default value is 90.
6083
6084@item large-function-insns
6085The limit specifying really large functions.  For functions larger than this
6086limit after inlining inlining is constrained by
6087@option{--param large-function-growth}.  This parameter is useful primarily
6088to avoid extreme compilation time caused by non-linear algorithms used by the
6089backend.
6090This parameter is ignored when @option{-funit-at-a-time} is not used.
6091The default value is 2700.
6092
6093@item large-function-growth
6094Specifies maximal growth of large function caused by inlining in percents.
6095This parameter is ignored when @option{-funit-at-a-time} is not used.
6096The default value is 100 which limits large function growth to 2.0 times
6097the original size.
6098
6099@item large-unit-insns
6100The limit specifying large translation unit.  Growth caused by inlining of
6101units larger than this limit is limited by @option{--param inline-unit-growth}.
6102For small units this might be too tight (consider unit consisting of function A
6103that is inline and B that just calls A three time.  If B is small relative to
6104A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6105large units consisting of small inlininable functions however the overall unit
6106growth limit is needed to avoid exponential explosion of code size.  Thus for
6107smaller units, the size is increased to @option{--param large-unit-insns}
6108before applying @option{--param inline-unit-growth}.  The default is 10000
6109
6110@item inline-unit-growth
6111Specifies maximal overall growth of the compilation unit caused by inlining.
6112This parameter is ignored when @option{-funit-at-a-time} is not used.
6113The default value is 50 which limits unit growth to 1.5 times the original
6114size.
6115
6116@item max-inline-insns-recursive
6117@itemx max-inline-insns-recursive-auto
6118Specifies maximum number of instructions out-of-line copy of self recursive inline
6119function can grow into by performing recursive inlining.
6120
6121For functions declared inline @option{--param max-inline-insns-recursive} is
6122taken into account.  For function not declared inline, recursive inlining
6123happens only when @option{-finline-functions} (included in @option{-O3}) is
6124enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6125default value is 450.
6126
6127@item max-inline-recursive-depth
6128@itemx max-inline-recursive-depth-auto
6129Specifies maximum recursion depth used by the recursive inlining.
6130
6131For functions declared inline @option{--param max-inline-recursive-depth} is
6132taken into account.  For function not declared inline, recursive inlining
6133happens only when @option{-finline-functions} (included in @option{-O3}) is
6134enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6135default value is 450.
6136
6137@item min-inline-recursive-probability
6138Recursive inlining is profitable only for function having deep recursion
6139in average and can hurt for function having little recursion depth by
6140increasing the prologue size or complexity of function body to other
6141optimizers.
6142
6143When profile feedback is available (see @option{-fprofile-generate}) the actual
6144recursion depth can be guessed from probability that function will recurse via
6145given call expression.  This parameter limits inlining only to call expression
6146whose probability exceeds given threshold (in percents).  The default value is
614710.
6148
6149@item inline-call-cost
6150Specify cost of call instruction relative to simple arithmetics operations
6151(having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6152functions and at the same time increases size of leaf function that is believed to
6153reduce function size by being inlined.  In effect it increases amount of
6154inlining for code having large abstraction penalty (many functions that just
6155pass the arguments to other functions) and decrease inlining for code with low
6156abstraction penalty.  The default value is 16.
6157
6158@item max-unrolled-insns
6159The maximum number of instructions that a loop should have if that loop
6160is unrolled, and if the loop is unrolled, it determines how many times
6161the loop code is unrolled.
6162
6163@item max-average-unrolled-insns
6164The maximum number of instructions biased by probabilities of their execution
6165that a loop should have if that loop is unrolled, and if the loop is unrolled,
6166it determines how many times the loop code is unrolled.
6167
6168@item max-unroll-times
6169The maximum number of unrollings of a single loop.
6170
6171@item max-peeled-insns
6172The maximum number of instructions that a loop should have if that loop
6173is peeled, and if the loop is peeled, it determines how many times
6174the loop code is peeled.
6175
6176@item max-peel-times
6177The maximum number of peelings of a single loop.
6178
6179@item max-completely-peeled-insns
6180The maximum number of insns of a completely peeled loop.
6181
6182@item max-completely-peel-times
6183The maximum number of iterations of a loop to be suitable for complete peeling.
6184
6185@item max-unswitch-insns
6186The maximum number of insns of an unswitched loop.
6187
6188@item max-unswitch-level
6189The maximum number of branches unswitched in a single loop.
6190
6191@item lim-expensive
6192The minimum cost of an expensive expression in the loop invariant motion.
6193
6194@item iv-consider-all-candidates-bound
6195Bound on number of candidates for induction variables below that
6196all candidates are considered for each use in induction variable
6197optimizations.  Only the most relevant candidates are considered
6198if there are more candidates, to avoid quadratic time complexity.
6199
6200@item iv-max-considered-uses
6201The induction variable optimizations give up on loops that contain more
6202induction variable uses.
6203
6204@item iv-always-prune-cand-set-bound
6205If number of candidates in the set is smaller than this value,
6206we always try to remove unnecessary ivs from the set during its
6207optimization when a new iv is added to the set.
6208
6209@item scev-max-expr-size
6210Bound on size of expressions used in the scalar evolutions analyzer.
6211Large expressions slow the analyzer.
6212
6213@item vect-max-version-checks
6214The maximum number of runtime checks that can be performed when doing
6215loop versioning in the vectorizer.  See option ftree-vect-loop-version
6216for more information.
6217
6218@item max-iterations-to-track
6219
6220The maximum number of iterations of a loop the brute force algorithm
6221for analysis of # of iterations of the loop tries to evaluate.
6222
6223@item hot-bb-count-fraction
6224Select fraction of the maximal count of repetitions of basic block in program
6225given basic block needs to have to be considered hot.
6226
6227@item hot-bb-frequency-fraction
6228Select fraction of the maximal frequency of executions of basic block in
6229function given basic block needs to have to be considered hot
6230
6231@item max-predicted-iterations
6232The maximum number of loop iterations we predict statically.  This is useful
6233in cases where function contain single loop with known bound and other loop
6234with unknown.  We predict the known number of iterations correctly, while
6235the unknown number of iterations average to roughly 10.  This means that the
6236loop without bounds would appear artificially cold relative to the other one.
6237
6238@item tracer-dynamic-coverage
6239@itemx tracer-dynamic-coverage-feedback
6240
6241This value is used to limit superblock formation once the given percentage of
6242executed instructions is covered.  This limits unnecessary code size
6243expansion.
6244
6245The @option{tracer-dynamic-coverage-feedback} is used only when profile
6246feedback is available.  The real profiles (as opposed to statically estimated
6247ones) are much less balanced allowing the threshold to be larger value.
6248
6249@item tracer-max-code-growth
6250Stop tail duplication once code growth has reached given percentage.  This is
6251rather hokey argument, as most of the duplicates will be eliminated later in
6252cross jumping, so it may be set to much higher values than is the desired code
6253growth.
6254
6255@item tracer-min-branch-ratio
6256
6257Stop reverse growth when the reverse probability of best edge is less than this
6258threshold (in percent).
6259
6260@item tracer-min-branch-ratio
6261@itemx tracer-min-branch-ratio-feedback
6262
6263Stop forward growth if the best edge do have probability lower than this
6264threshold.
6265
6266Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6267compilation for profile feedback and one for compilation without.  The value
6268for compilation with profile feedback needs to be more conservative (higher) in
6269order to make tracer effective.
6270
6271@item max-cse-path-length
6272
6273Maximum number of basic blocks on path that cse considers.  The default is 10.
6274
6275@item max-cse-insns
6276The maximum instructions CSE process before flushing. The default is 1000.
6277
6278@item global-var-threshold
6279
6280Counts the number of function calls (@var{n}) and the number of
6281call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6282single artificial variable will be created to represent all the
6283call-clobbered variables at function call sites.  This artificial
6284variable will then be made to alias every call-clobbered variable.
6285(done as @code{int * size_t} on the host machine; beware overflow).
6286
6287@item max-aliased-vops
6288
6289Maximum number of virtual operands allowed to represent aliases
6290before triggering the alias grouping heuristic.  Alias grouping
6291reduces compile times and memory consumption needed for aliasing at
6292the expense of precision loss in alias information.
6293
6294@item ggc-min-expand
6295
6296GCC uses a garbage collector to manage its own memory allocation.  This
6297parameter specifies the minimum percentage by which the garbage
6298collector's heap should be allowed to expand between collections.
6299Tuning this may improve compilation speed; it has no effect on code
6300generation.
6301
6302The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6303RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6304the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6305GCC is not able to calculate RAM on a particular platform, the lower
6306bound of 30% is used.  Setting this parameter and
6307@option{ggc-min-heapsize} to zero causes a full collection to occur at
6308every opportunity.  This is extremely slow, but can be useful for
6309debugging.
6310
6311@item ggc-min-heapsize
6312
6313Minimum size of the garbage collector's heap before it begins bothering
6314to collect garbage.  The first collection occurs after the heap expands
6315by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6316tuning this may improve compilation speed, and has no effect on code
6317generation.
6318
6319The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6320tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6321with a lower bound of 4096 (four megabytes) and an upper bound of
6322131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6323particular platform, the lower bound is used.  Setting this parameter
6324very large effectively disables garbage collection.  Setting this
6325parameter and @option{ggc-min-expand} to zero causes a full collection
6326to occur at every opportunity.
6327
6328@item max-reload-search-insns
6329The maximum number of instruction reload should look backward for equivalent
6330register.  Increasing values mean more aggressive optimization, making the
6331compile time increase with probably slightly better performance.  The default
6332value is 100.
6333
6334@item max-cselib-memory-locations
6335The maximum number of memory locations cselib should take into account.
6336Increasing values mean more aggressive optimization, making the compile time
6337increase with probably slightly better performance.  The default value is 500.
6338
6339@item max-flow-memory-locations
6340Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6341The default value is 100.
6342
6343@item reorder-blocks-duplicate
6344@itemx reorder-blocks-duplicate-feedback
6345
6346Used by basic block reordering pass to decide whether to use unconditional
6347branch or duplicate the code on its destination.  Code is duplicated when its
6348estimated size is smaller than this value multiplied by the estimated size of
6349unconditional jump in the hot spots of the program.
6350
6351The @option{reorder-block-duplicate-feedback} is used only when profile
6352feedback is available and may be set to higher values than
6353@option{reorder-block-duplicate} since information about the hot spots is more
6354accurate.
6355
6356@item max-sched-ready-insns
6357The maximum number of instructions ready to be issued the scheduler should
6358consider at any given time during the first scheduling pass.  Increasing
6359values mean more thorough searches, making the compilation time increase
6360with probably little benefit.  The default value is 100.
6361
6362@item max-sched-region-blocks
6363The maximum number of blocks in a region to be considered for
6364interblock scheduling.  The default value is 10.
6365
6366@item max-sched-region-insns
6367The maximum number of insns in a region to be considered for
6368interblock scheduling.  The default value is 100.
6369
6370@item min-spec-prob
6371The minimum probability (in percents) of reaching a source block
6372for interblock speculative scheduling.  The default value is 40.
6373
6374@item max-sched-extend-regions-iters
6375The maximum number of iterations through CFG to extend regions.
63760 - disable region extension,
6377N - do at most N iterations.
6378The default value is 0.
6379
6380@item max-sched-insn-conflict-delay
6381The maximum conflict delay for an insn to be considered for speculative motion.
6382The default value is 3.
6383
6384@item sched-spec-prob-cutoff
6385The minimal probability of speculation success (in percents), so that
6386speculative insn will be scheduled.
6387The default value is 40.
6388
6389@item max-last-value-rtl
6390
6391The maximum size measured as number of RTLs that can be recorded in an expression
6392in combiner for a pseudo register as last known value of that register.  The default
6393is 10000.
6394
6395@item integer-share-limit
6396Small integer constants can use a shared data structure, reducing the
6397compiler's memory usage and increasing its speed.  This sets the maximum
6398value of a shared integer constant's.  The default value is 256.
6399
6400@item min-virtual-mappings
6401Specifies the minimum number of virtual mappings in the incremental
6402SSA updater that should be registered to trigger the virtual mappings
6403heuristic defined by virtual-mappings-ratio.  The default value is
6404100.
6405
6406@item virtual-mappings-ratio
6407If the number of virtual mappings is virtual-mappings-ratio bigger
6408than the number of virtual symbols to be updated, then the incremental
6409SSA updater switches to a full update for those symbols.  The default
6410ratio is 3.
6411
6412@item ssp-buffer-size
6413The minimum size of buffers (i.e. arrays) that will receive stack smashing
6414protection when @option{-fstack-protection} is used.
6415
6416@item max-jump-thread-duplication-stmts
6417Maximum number of statements allowed in a block that needs to be
6418duplicated when threading jumps.
6419
6420@item max-fields-for-field-sensitive
6421Maximum number of fields in a structure we will treat in
6422a field sensitive manner during pointer analysis.
6423
6424@end table
6425@end table
6426
6427@node Preprocessor Options
6428@section Options Controlling the Preprocessor
6429@cindex preprocessor options
6430@cindex options, preprocessor
6431
6432These options control the C preprocessor, which is run on each C source
6433file before actual compilation.
6434
6435If you use the @option{-E} option, nothing is done except preprocessing.
6436Some of these options make sense only together with @option{-E} because
6437they cause the preprocessor output to be unsuitable for actual
6438compilation.
6439
6440@table @gcctabopt
6441@opindex Wp
6442You can use @option{-Wp,@var{option}} to bypass the compiler driver
6443and pass @var{option} directly through to the preprocessor.  If
6444@var{option} contains commas, it is split into multiple options at the
6445commas.  However, many options are modified, translated or interpreted
6446by the compiler driver before being passed to the preprocessor, and
6447@option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6448interface is undocumented and subject to change, so whenever possible
6449you should avoid using @option{-Wp} and let the driver handle the
6450options instead.
6451
6452@item -Xpreprocessor @var{option}
6453@opindex preprocessor
6454Pass @var{option} as an option to the preprocessor.  You can use this to
6455supply system-specific preprocessor options which GCC does not know how to
6456recognize.
6457
6458If you want to pass an option that takes an argument, you must use
6459@option{-Xpreprocessor} twice, once for the option and once for the argument.
6460@end table
6461
6462@include cppopts.texi
6463
6464@node Assembler Options
6465@section Passing Options to the Assembler
6466
6467@c prevent bad page break with this line
6468You can pass options to the assembler.
6469
6470@table @gcctabopt
6471@item -Wa,@var{option}
6472@opindex Wa
6473Pass @var{option} as an option to the assembler.  If @var{option}
6474contains commas, it is split into multiple options at the commas.
6475
6476@item -Xassembler @var{option}
6477@opindex Xassembler
6478Pass @var{option} as an option to the assembler.  You can use this to
6479supply system-specific assembler options which GCC does not know how to
6480recognize.
6481
6482If you want to pass an option that takes an argument, you must use
6483@option{-Xassembler} twice, once for the option and once for the argument.
6484
6485@end table
6486
6487@node Link Options
6488@section Options for Linking
6489@cindex link options
6490@cindex options, linking
6491
6492These options come into play when the compiler links object files into
6493an executable output file.  They are meaningless if the compiler is
6494not doing a link step.
6495
6496@table @gcctabopt
6497@cindex file names
6498@item @var{object-file-name}
6499A file name that does not end in a special recognized suffix is
6500considered to name an object file or library.  (Object files are
6501distinguished from libraries by the linker according to the file
6502contents.)  If linking is done, these object files are used as input
6503to the linker.
6504
6505@item -c
6506@itemx -S
6507@itemx -E
6508@opindex c
6509@opindex S
6510@opindex E
6511If any of these options is used, then the linker is not run, and
6512object file names should not be used as arguments.  @xref{Overall
6513Options}.
6514
6515@cindex Libraries
6516@item -l@var{library}
6517@itemx -l @var{library}
6518@opindex l
6519Search the library named @var{library} when linking.  (The second
6520alternative with the library as a separate argument is only for
6521POSIX compliance and is not recommended.)
6522
6523It makes a difference where in the command you write this option; the
6524linker searches and processes libraries and object files in the order they
6525are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6526after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6527to functions in @samp{z}, those functions may not be loaded.
6528
6529The linker searches a standard list of directories for the library,
6530which is actually a file named @file{lib@var{library}.a}.  The linker
6531then uses this file as if it had been specified precisely by name.
6532
6533The directories searched include several standard system directories
6534plus any that you specify with @option{-L}.
6535
6536Normally the files found this way are library files---archive files
6537whose members are object files.  The linker handles an archive file by
6538scanning through it for members which define symbols that have so far
6539been referenced but not defined.  But if the file that is found is an
6540ordinary object file, it is linked in the usual fashion.  The only
6541difference between using an @option{-l} option and specifying a file name
6542is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6543and searches several directories.
6544
6545@item -lobjc
6546@opindex lobjc
6547You need this special case of the @option{-l} option in order to
6548link an Objective-C or Objective-C++ program.
6549
6550@item -nostartfiles
6551@opindex nostartfiles
6552Do not use the standard system startup files when linking.
6553The standard system libraries are used normally, unless @option{-nostdlib}
6554or @option{-nodefaultlibs} is used.
6555
6556@item -nodefaultlibs
6557@opindex nodefaultlibs
6558Do not use the standard system libraries when linking.
6559Only the libraries you specify will be passed to the linker.
6560The standard startup files are used normally, unless @option{-nostartfiles}
6561is used.  The compiler may generate calls to @code{memcmp},
6562@code{memset}, @code{memcpy} and @code{memmove}.
6563These entries are usually resolved by entries in
6564libc.  These entry points should be supplied through some other
6565mechanism when this option is specified.
6566
6567@item -nostdlib
6568@opindex nostdlib
6569Do not use the standard system startup files or libraries when linking.
6570No startup files and only the libraries you specify will be passed to
6571the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6572@code{memcpy} and @code{memmove}.
6573These entries are usually resolved by entries in
6574libc.  These entry points should be supplied through some other
6575mechanism when this option is specified.
6576
6577@cindex @option{-lgcc}, use with @option{-nostdlib}
6578@cindex @option{-nostdlib} and unresolved references
6579@cindex unresolved references and @option{-nostdlib}
6580@cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6581@cindex @option{-nodefaultlibs} and unresolved references
6582@cindex unresolved references and @option{-nodefaultlibs}
6583One of the standard libraries bypassed by @option{-nostdlib} and
6584@option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6585that GCC uses to overcome shortcomings of particular machines, or special
6586needs for some languages.
6587(@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6588Collection (GCC) Internals},
6589for more discussion of @file{libgcc.a}.)
6590In most cases, you need @file{libgcc.a} even when you want to avoid
6591other standard libraries.  In other words, when you specify @option{-nostdlib}
6592or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6593This ensures that you have no unresolved references to internal GCC
6594library subroutines.  (For example, @samp{__main}, used to ensure C++
6595constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6596GNU Compiler Collection (GCC) Internals}.)
6597
6598@item -pie
6599@opindex pie
6600Produce a position independent executable on targets which support it.
6601For predictable results, you must also specify the same set of options
6602that were used to generate code (@option{-fpie}, @option{-fPIE},
6603or model suboptions) when you specify this option.
6604
6605@item -rdynamic
6606@opindex rdynamic
6607Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6608that support it. This instructs the linker to add all symbols, not
6609only used ones, to the dynamic symbol table. This option is needed
6610for some uses of @code{dlopen} or to allow obtaining backtraces
6611from within a program.
6612
6613@item -s
6614@opindex s
6615Remove all symbol table and relocation information from the executable.
6616
6617@item -static
6618@opindex static
6619On systems that support dynamic linking, this prevents linking with the shared
6620libraries.  On other systems, this option has no effect.
6621
6622@item -shared
6623@opindex shared
6624Produce a shared object which can then be linked with other objects to
6625form an executable.  Not all systems support this option.  For predictable
6626results, you must also specify the same set of options that were used to
6627generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6628when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6629needs to build supplementary stub code for constructors to work.  On
6630multi-libbed systems, @samp{gcc -shared} must select the correct support
6631libraries to link against.  Failing to supply the correct flags may lead
6632to subtle defects.  Supplying them in cases where they are not necessary
6633is innocuous.}
6634
6635@item -shared-libgcc
6636@itemx -static-libgcc
6637@opindex shared-libgcc
6638@opindex static-libgcc
6639On systems that provide @file{libgcc} as a shared library, these options
6640force the use of either the shared or static version respectively.
6641If no shared version of @file{libgcc} was built when the compiler was
6642configured, these options have no effect.
6643
6644There are several situations in which an application should use the
6645shared @file{libgcc} instead of the static version.  The most common
6646of these is when the application wishes to throw and catch exceptions
6647across different shared libraries.  In that case, each of the libraries
6648as well as the application itself should use the shared @file{libgcc}.
6649
6650Therefore, the G++ and GCJ drivers automatically add
6651@option{-shared-libgcc} whenever you build a shared library or a main
6652executable, because C++ and Java programs typically use exceptions, so
6653this is the right thing to do.
6654
6655If, instead, you use the GCC driver to create shared libraries, you may
6656find that they will not always be linked with the shared @file{libgcc}.
6657If GCC finds, at its configuration time, that you have a non-GNU linker
6658or a GNU linker that does not support option @option{--eh-frame-hdr},
6659it will link the shared version of @file{libgcc} into shared libraries
6660by default.  Otherwise, it will take advantage of the linker and optimize
6661away the linking with the shared version of @file{libgcc}, linking with
6662the static version of libgcc by default.  This allows exceptions to
6663propagate through such shared libraries, without incurring relocation
6664costs at library load time.
6665
6666However, if a library or main executable is supposed to throw or catch
6667exceptions, you must link it using the G++ or GCJ driver, as appropriate
6668for the languages used in the program, or using the option
6669@option{-shared-libgcc}, such that it is linked with the shared
6670@file{libgcc}.
6671
6672@item -symbolic
6673@opindex symbolic
6674Bind references to global symbols when building a shared object.  Warn
6675about any unresolved references (unless overridden by the link editor
6676option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6677this option.
6678
6679@item -Xlinker @var{option}
6680@opindex Xlinker
6681Pass @var{option} as an option to the linker.  You can use this to
6682supply system-specific linker options which GCC does not know how to
6683recognize.
6684
6685If you want to pass an option that takes an argument, you must use
6686@option{-Xlinker} twice, once for the option and once for the argument.
6687For example, to pass @option{-assert definitions}, you must write
6688@samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6689@option{-Xlinker "-assert definitions"}, because this passes the entire
6690string as a single argument, which is not what the linker expects.
6691
6692@item -Wl,@var{option}
6693@opindex Wl
6694Pass @var{option} as an option to the linker.  If @var{option} contains
6695commas, it is split into multiple options at the commas.
6696
6697@item -u @var{symbol}
6698@opindex u
6699Pretend the symbol @var{symbol} is undefined, to force linking of
6700library modules to define it.  You can use @option{-u} multiple times with
6701different symbols to force loading of additional library modules.
6702@end table
6703
6704@node Directory Options
6705@section Options for Directory Search
6706@cindex directory options
6707@cindex options, directory search
6708@cindex search path
6709
6710These options specify directories to search for header files, for
6711libraries and for parts of the compiler:
6712
6713@table @gcctabopt
6714@item -I@var{dir}
6715@opindex I
6716Add the directory @var{dir} to the head of the list of directories to be
6717searched for header files.  This can be used to override a system header
6718file, substituting your own version, since these directories are
6719searched before the system header file directories.  However, you should
6720not use this option to add directories that contain vendor-supplied
6721system header files (use @option{-isystem} for that).  If you use more than
6722one @option{-I} option, the directories are scanned in left-to-right
6723order; the standard system directories come after.
6724
6725If a standard system include directory, or a directory specified with
6726@option{-isystem}, is also specified with @option{-I}, the @option{-I}
6727option will be ignored.  The directory will still be searched but as a
6728system directory at its normal position in the system include chain.
6729This is to ensure that GCC's procedure to fix buggy system headers and
6730the ordering for the include_next directive are not inadvertently changed.
6731If you really need to change the search order for system directories,
6732use the @option{-nostdinc} and/or @option{-isystem} options.
6733
6734@item -iquote@var{dir}
6735@opindex iquote
6736Add the directory @var{dir} to the head of the list of directories to
6737be searched for header files only for the case of @samp{#include
6738"@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6739otherwise just like @option{-I}.
6740
6741@item -L@var{dir}
6742@opindex L
6743Add directory @var{dir} to the list of directories to be searched
6744for @option{-l}.
6745
6746@item -B@var{prefix}
6747@opindex B
6748This option specifies where to find the executables, libraries,
6749include files, and data files of the compiler itself.
6750
6751The compiler driver program runs one or more of the subprograms
6752@file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6753@var{prefix} as a prefix for each program it tries to run, both with and
6754without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6755
6756For each subprogram to be run, the compiler driver first tries the
6757@option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6758was not specified, the driver tries two standard prefixes, which are
6759@file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6760those results in a file name that is found, the unmodified program
6761name is searched for using the directories specified in your
6762@env{PATH} environment variable.
6763
6764The compiler will check to see if the path provided by the @option{-B}
6765refers to a directory, and if necessary it will add a directory
6766separator character at the end of the path.
6767
6768@option{-B} prefixes that effectively specify directory names also apply
6769to libraries in the linker, because the compiler translates these
6770options into @option{-L} options for the linker.  They also apply to
6771includes files in the preprocessor, because the compiler translates these
6772options into @option{-isystem} options for the preprocessor.  In this case,
6773the compiler appends @samp{include} to the prefix.
6774
6775The run-time support file @file{libgcc.a} can also be searched for using
6776the @option{-B} prefix, if needed.  If it is not found there, the two
6777standard prefixes above are tried, and that is all.  The file is left
6778out of the link if it is not found by those means.
6779
6780Another way to specify a prefix much like the @option{-B} prefix is to use
6781the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6782Variables}.
6783
6784As a special kludge, if the path provided by @option{-B} is
6785@file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
67869, then it will be replaced by @file{[dir/]include}.  This is to help
6787with boot-strapping the compiler.
6788
6789@item -specs=@var{file}
6790@opindex specs
6791Process @var{file} after the compiler reads in the standard @file{specs}
6792file, in order to override the defaults that the @file{gcc} driver
6793program uses when determining what switches to pass to @file{cc1},
6794@file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6795@option{-specs=@var{file}} can be specified on the command line, and they
6796are processed in order, from left to right.
6797
6798@item --sysroot=@var{dir}
6799@opindex sysroot
6800Use @var{dir} as the logical root directory for headers and libraries.
6801For example, if the compiler would normally search for headers in
6802@file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6803search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
6804
6805If you use both this option and the @option{-isysroot} option, then
6806the @option{--sysroot} option will apply to libraries, but the
6807@option{-isysroot} option will apply to header files.
6808
6809The GNU linker (beginning with version 2.16) has the necessary support
6810for this option.  If your linker does not support this option, the
6811header file aspect of @option{--sysroot} will still work, but the
6812library aspect will not.
6813
6814@item -I-
6815@opindex I-
6816This option has been deprecated.  Please use @option{-iquote} instead for
6817@option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6818Any directories you specify with @option{-I} options before the @option{-I-}
6819option are searched only for the case of @samp{#include "@var{file}"};
6820they are not searched for @samp{#include <@var{file}>}.
6821
6822If additional directories are specified with @option{-I} options after
6823the @option{-I-}, these directories are searched for all @samp{#include}
6824directives.  (Ordinarily @emph{all} @option{-I} directories are used
6825this way.)
6826
6827In addition, the @option{-I-} option inhibits the use of the current
6828directory (where the current input file came from) as the first search
6829directory for @samp{#include "@var{file}"}.  There is no way to
6830override this effect of @option{-I-}.  With @option{-I.} you can specify
6831searching the directory which was current when the compiler was
6832invoked.  That is not exactly the same as what the preprocessor does
6833by default, but it is often satisfactory.
6834
6835@option{-I-} does not inhibit the use of the standard system directories
6836for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6837independent.
6838@end table
6839
6840@c man end
6841
6842@node Spec Files
6843@section Specifying subprocesses and the switches to pass to them
6844@cindex Spec Files
6845
6846@command{gcc} is a driver program.  It performs its job by invoking a
6847sequence of other programs to do the work of compiling, assembling and
6848linking.  GCC interprets its command-line parameters and uses these to
6849deduce which programs it should invoke, and which command-line options
6850it ought to place on their command lines.  This behavior is controlled
6851by @dfn{spec strings}.  In most cases there is one spec string for each
6852program that GCC can invoke, but a few programs have multiple spec
6853strings to control their behavior.  The spec strings built into GCC can
6854be overridden by using the @option{-specs=} command-line switch to specify
6855a spec file.
6856
6857@dfn{Spec files} are plaintext files that are used to construct spec
6858strings.  They consist of a sequence of directives separated by blank
6859lines.  The type of directive is determined by the first non-whitespace
6860character on the line and it can be one of the following:
6861
6862@table @code
6863@item %@var{command}
6864Issues a @var{command} to the spec file processor.  The commands that can
6865appear here are:
6866
6867@table @code
6868@item %include <@var{file}>
6869@cindex %include
6870Search for @var{file} and insert its text at the current point in the
6871specs file.
6872
6873@item %include_noerr <@var{file}>
6874@cindex %include_noerr
6875Just like @samp{%include}, but do not generate an error message if the include
6876file cannot be found.
6877
6878@item %rename @var{old_name} @var{new_name}
6879@cindex %rename
6880Rename the spec string @var{old_name} to @var{new_name}.
6881
6882@end table
6883
6884@item *[@var{spec_name}]:
6885This tells the compiler to create, override or delete the named spec
6886string.  All lines after this directive up to the next directive or
6887blank line are considered to be the text for the spec string.  If this
6888results in an empty string then the spec will be deleted.  (Or, if the
6889spec did not exist, then nothing will happened.)  Otherwise, if the spec
6890does not currently exist a new spec will be created.  If the spec does
6891exist then its contents will be overridden by the text of this
6892directive, unless the first character of that text is the @samp{+}
6893character, in which case the text will be appended to the spec.
6894
6895@item [@var{suffix}]:
6896Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6897and up to the next directive or blank line are considered to make up the
6898spec string for the indicated suffix.  When the compiler encounters an
6899input file with the named suffix, it will processes the spec string in
6900order to work out how to compile that file.  For example:
6901
6902@smallexample
6903.ZZ:
6904z-compile -input %i
6905@end smallexample
6906
6907This says that any input file whose name ends in @samp{.ZZ} should be
6908passed to the program @samp{z-compile}, which should be invoked with the
6909command-line switch @option{-input} and with the result of performing the
6910@samp{%i} substitution.  (See below.)
6911
6912As an alternative to providing a spec string, the text that follows a
6913suffix directive can be one of the following:
6914
6915@table @code
6916@item @@@var{language}
6917This says that the suffix is an alias for a known @var{language}.  This is
6918similar to using the @option{-x} command-line switch to GCC to specify a
6919language explicitly.  For example:
6920
6921@smallexample
6922.ZZ:
6923@@c++
6924@end smallexample
6925
6926Says that .ZZ files are, in fact, C++ source files.
6927
6928@item #@var{name}
6929This causes an error messages saying:
6930
6931@smallexample
6932@var{name} compiler not installed on this system.
6933@end smallexample
6934@end table
6935
6936GCC already has an extensive list of suffixes built into it.
6937This directive will add an entry to the end of the list of suffixes, but
6938since the list is searched from the end backwards, it is effectively
6939possible to override earlier entries using this technique.
6940
6941@end table
6942
6943GCC has the following spec strings built into it.  Spec files can
6944override these strings or create their own.  Note that individual
6945targets can also add their own spec strings to this list.
6946
6947@smallexample
6948asm          Options to pass to the assembler
6949asm_final    Options to pass to the assembler post-processor
6950cpp          Options to pass to the C preprocessor
6951cc1          Options to pass to the C compiler
6952cc1plus      Options to pass to the C++ compiler
6953endfile      Object files to include at the end of the link
6954link         Options to pass to the linker
6955lib          Libraries to include on the command line to the linker
6956libgcc       Decides which GCC support library to pass to the linker
6957linker       Sets the name of the linker
6958predefines   Defines to be passed to the C preprocessor
6959signed_char  Defines to pass to CPP to say whether @code{char} is signed
6960             by default
6961startfile    Object files to include at the start of the link
6962@end smallexample
6963
6964Here is a small example of a spec file:
6965
6966@smallexample
6967%rename lib                 old_lib
6968
6969*lib:
6970--start-group -lgcc -lc -leval1 --end-group %(old_lib)
6971@end smallexample
6972
6973This example renames the spec called @samp{lib} to @samp{old_lib} and
6974then overrides the previous definition of @samp{lib} with a new one.
6975The new definition adds in some extra command-line options before
6976including the text of the old definition.
6977
6978@dfn{Spec strings} are a list of command-line options to be passed to their
6979corresponding program.  In addition, the spec strings can contain
6980@samp{%}-prefixed sequences to substitute variable text or to
6981conditionally insert text into the command line.  Using these constructs
6982it is possible to generate quite complex command lines.
6983
6984Here is a table of all defined @samp{%}-sequences for spec
6985strings.  Note that spaces are not generated automatically around the
6986results of expanding these sequences.  Therefore you can concatenate them
6987together or combine them with constant text in a single argument.
6988
6989@table @code
6990@item %%
6991Substitute one @samp{%} into the program name or argument.
6992
6993@item %i
6994Substitute the name of the input file being processed.
6995
6996@item %b
6997Substitute the basename of the input file being processed.
6998This is the substring up to (and not including) the last period
6999and not including the directory.
7000
7001@item %B
7002This is the same as @samp{%b}, but include the file suffix (text after
7003the last period).
7004
7005@item %d
7006Marks the argument containing or following the @samp{%d} as a
7007temporary file name, so that that file will be deleted if GCC exits
7008successfully.  Unlike @samp{%g}, this contributes no text to the
7009argument.
7010
7011@item %g@var{suffix}
7012Substitute a file name that has suffix @var{suffix} and is chosen
7013once per compilation, and mark the argument in the same way as
7014@samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7015name is now chosen in a way that is hard to predict even when previously
7016chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7017might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7018the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7019treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7020was simply substituted with a file name chosen once per compilation,
7021without regard to any appended suffix (which was therefore treated
7022just like ordinary text), making such attacks more likely to succeed.
7023
7024@item %u@var{suffix}
7025Like @samp{%g}, but generates a new temporary file name even if
7026@samp{%u@var{suffix}} was already seen.
7027
7028@item %U@var{suffix}
7029Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7030new one if there is no such last file name.  In the absence of any
7031@samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7032the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7033would involve the generation of two distinct file names, one
7034for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7035simply substituted with a file name chosen for the previous @samp{%u},
7036without regard to any appended suffix.
7037
7038@item %j@var{suffix}
7039Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7040writable, and if save-temps is off; otherwise, substitute the name
7041of a temporary file, just like @samp{%u}.  This temporary file is not
7042meant for communication between processes, but rather as a junk
7043disposal mechanism.
7044
7045@item %|@var{suffix}
7046@itemx %m@var{suffix}
7047Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7048@samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7049all.  These are the two most common ways to instruct a program that it
7050should read from standard input or write to standard output.  If you
7051need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7052construct: see for example @file{f/lang-specs.h}.
7053
7054@item %.@var{SUFFIX}
7055Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7056when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7057terminated by the next space or %.
7058
7059@item %w
7060Marks the argument containing or following the @samp{%w} as the
7061designated output file of this compilation.  This puts the argument
7062into the sequence of arguments that @samp{%o} will substitute later.
7063
7064@item %o
7065Substitutes the names of all the output files, with spaces
7066automatically placed around them.  You should write spaces
7067around the @samp{%o} as well or the results are undefined.
7068@samp{%o} is for use in the specs for running the linker.
7069Input files whose names have no recognized suffix are not compiled
7070at all, but they are included among the output files, so they will
7071be linked.
7072
7073@item %O
7074Substitutes the suffix for object files.  Note that this is
7075handled specially when it immediately follows @samp{%g, %u, or %U},
7076because of the need for those to form complete file names.  The
7077handling is such that @samp{%O} is treated exactly as if it had already
7078been substituted, except that @samp{%g, %u, and %U} do not currently
7079support additional @var{suffix} characters following @samp{%O} as they would
7080following, for example, @samp{.o}.
7081
7082@item %p
7083Substitutes the standard macro predefinitions for the
7084current target machine.  Use this when running @code{cpp}.
7085
7086@item %P
7087Like @samp{%p}, but puts @samp{__} before and after the name of each
7088predefined macro, except for macros that start with @samp{__} or with
7089@samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
7090C@.
7091
7092@item %I
7093Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
7094@option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
7095@option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
7096and @option{-imultilib} as necessary.
7097
7098@item %s
7099Current argument is the name of a library or startup file of some sort.
7100Search for that file in a standard list of directories and substitute
7101the full name found.
7102
7103@item %e@var{str}
7104Print @var{str} as an error message.  @var{str} is terminated by a newline.
7105Use this when inconsistent options are detected.
7106
7107@item %(@var{name})
7108Substitute the contents of spec string @var{name} at this point.
7109
7110@item %[@var{name}]
7111Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7112
7113@item %x@{@var{option}@}
7114Accumulate an option for @samp{%X}.
7115
7116@item %X
7117Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7118spec string.
7119
7120@item %Y
7121Output the accumulated assembler options specified by @option{-Wa}.
7122
7123@item %Z
7124Output the accumulated preprocessor options specified by @option{-Wp}.
7125
7126@item %a
7127Process the @code{asm} spec.  This is used to compute the
7128switches to be passed to the assembler.
7129
7130@item %A
7131Process the @code{asm_final} spec.  This is a spec string for
7132passing switches to an assembler post-processor, if such a program is
7133needed.
7134
7135@item %l
7136Process the @code{link} spec.  This is the spec for computing the
7137command line passed to the linker.  Typically it will make use of the
7138@samp{%L %G %S %D and %E} sequences.
7139
7140@item %D
7141Dump out a @option{-L} option for each directory that GCC believes might
7142contain startup files.  If the target supports multilibs then the
7143current multilib directory will be prepended to each of these paths.
7144
7145@item %L
7146Process the @code{lib} spec.  This is a spec string for deciding which
7147libraries should be included on the command line to the linker.
7148
7149@item %G
7150Process the @code{libgcc} spec.  This is a spec string for deciding
7151which GCC support library should be included on the command line to the linker.
7152
7153@item %S
7154Process the @code{startfile} spec.  This is a spec for deciding which
7155object files should be the first ones passed to the linker.  Typically
7156this might be a file named @file{crt0.o}.
7157
7158@item %E
7159Process the @code{endfile} spec.  This is a spec string that specifies
7160the last object files that will be passed to the linker.
7161
7162@item %C
7163Process the @code{cpp} spec.  This is used to construct the arguments
7164to be passed to the C preprocessor.
7165
7166@item %1
7167Process the @code{cc1} spec.  This is used to construct the options to be
7168passed to the actual C compiler (@samp{cc1}).
7169
7170@item %2
7171Process the @code{cc1plus} spec.  This is used to construct the options to be
7172passed to the actual C++ compiler (@samp{cc1plus}).
7173
7174@item %*
7175Substitute the variable part of a matched option.  See below.
7176Note that each comma in the substituted string is replaced by
7177a single space.
7178
7179@item %<@code{S}
7180Remove all occurrences of @code{-S} from the command line.  Note---this
7181command is position dependent.  @samp{%} commands in the spec string
7182before this one will see @code{-S}, @samp{%} commands in the spec string
7183after this one will not.
7184
7185@item %:@var{function}(@var{args})
7186Call the named function @var{function}, passing it @var{args}.
7187@var{args} is first processed as a nested spec string, then split
7188into an argument vector in the usual fashion.  The function returns
7189a string which is processed as if it had appeared literally as part
7190of the current spec.
7191
7192The following built-in spec functions are provided:
7193
7194@table @code
7195@item @code{if-exists}
7196The @code{if-exists} spec function takes one argument, an absolute
7197pathname to a file.  If the file exists, @code{if-exists} returns the
7198pathname.  Here is a small example of its usage:
7199
7200@smallexample
7201*startfile:
7202crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7203@end smallexample
7204
7205@item @code{if-exists-else}
7206The @code{if-exists-else} spec function is similar to the @code{if-exists}
7207spec function, except that it takes two arguments.  The first argument is
7208an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7209returns the pathname.  If it does not exist, it returns the second argument.
7210This way, @code{if-exists-else} can be used to select one file or another,
7211based on the existence of the first.  Here is a small example of its usage:
7212
7213@smallexample
7214*startfile:
7215crt0%O%s %:if-exists(crti%O%s) \
7216%:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7217@end smallexample
7218
7219@item @code{replace-outfile}
7220The @code{replace-outfile} spec function takes two arguments.  It looks for the
7221first argument in the outfiles array and replaces it with the second argument.  Here
7222is a small example of its usage:
7223
7224@smallexample
7225%@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7226@end smallexample
7227
7228@end table
7229
7230@item %@{@code{S}@}
7231Substitutes the @code{-S} switch, if that switch was given to GCC@.
7232If that switch was not specified, this substitutes nothing.  Note that
7233the leading dash is omitted when specifying this option, and it is
7234automatically inserted if the substitution is performed.  Thus the spec
7235string @samp{%@{foo@}} would match the command-line option @option{-foo}
7236and would output the command line option @option{-foo}.
7237
7238@item %W@{@code{S}@}
7239Like %@{@code{S}@} but mark last argument supplied within as a file to be
7240deleted on failure.
7241
7242@item %@{@code{S}*@}
7243Substitutes all the switches specified to GCC whose names start
7244with @code{-S}, but which also take an argument.  This is used for
7245switches like @option{-o}, @option{-D}, @option{-I}, etc.
7246GCC considers @option{-o foo} as being
7247one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7248text, including the space.  Thus two arguments would be generated.
7249
7250@item %@{@code{S}*&@code{T}*@}
7251Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7252(the order of @code{S} and @code{T} in the spec is not significant).
7253There can be any number of ampersand-separated variables; for each the
7254wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7255
7256@item %@{@code{S}:@code{X}@}
7257Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7258
7259@item %@{!@code{S}:@code{X}@}
7260Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7261
7262@item %@{@code{S}*:@code{X}@}
7263Substitutes @code{X} if one or more switches whose names start with
7264@code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7265once, no matter how many such switches appeared.  However, if @code{%*}
7266appears somewhere in @code{X}, then @code{X} will be substituted once
7267for each matching switch, with the @code{%*} replaced by the part of
7268that switch that matched the @code{*}.
7269
7270@item %@{.@code{S}:@code{X}@}
7271Substitutes @code{X}, if processing a file with suffix @code{S}.
7272
7273@item %@{!.@code{S}:@code{X}@}
7274Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7275
7276@item %@{@code{S}|@code{P}:@code{X}@}
7277Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7278This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7279although they have a stronger binding than the @samp{|}.  If @code{%*}
7280appears in @code{X}, all of the alternatives must be starred, and only
7281the first matching alternative is substituted.
7282
7283For example, a spec string like this:
7284
7285@smallexample
7286%@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7287@end smallexample
7288
7289will output the following command-line options from the following input
7290command-line options:
7291
7292@smallexample
7293fred.c        -foo -baz
7294jim.d         -bar -boggle
7295-d fred.c     -foo -baz -boggle
7296-d jim.d      -bar -baz -boggle
7297@end smallexample
7298
7299@item %@{S:X; T:Y; :D@}
7300
7301If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7302given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7303be as many clauses as you need.  This may be combined with @code{.},
7304@code{!}, @code{|}, and @code{*} as needed.
7305
7306
7307@end table
7308
7309The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7310construct may contain other nested @samp{%} constructs or spaces, or
7311even newlines.  They are processed as usual, as described above.
7312Trailing white space in @code{X} is ignored.  White space may also
7313appear anywhere on the left side of the colon in these constructs,
7314except between @code{.} or @code{*} and the corresponding word.
7315
7316The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7317handled specifically in these constructs.  If another value of
7318@option{-O} or the negated form of a @option{-f}, @option{-m}, or
7319@option{-W} switch is found later in the command line, the earlier
7320switch value is ignored, except with @{@code{S}*@} where @code{S} is
7321just one letter, which passes all matching options.
7322
7323The character @samp{|} at the beginning of the predicate text is used to
7324indicate that a command should be piped to the following command, but
7325only if @option{-pipe} is specified.
7326
7327It is built into GCC which switches take arguments and which do not.
7328(You might think it would be useful to generalize this to allow each
7329compiler's spec to say which switches take arguments.  But this cannot
7330be done in a consistent fashion.  GCC cannot even decide which input
7331files have been specified without knowing which switches take arguments,
7332and it must know which input files to compile in order to tell which
7333compilers to run).
7334
7335GCC also knows implicitly that arguments starting in @option{-l} are to be
7336treated as compiler output files, and passed to the linker in their
7337proper position among the other output files.
7338
7339@c man begin OPTIONS
7340
7341@node Target Options
7342@section Specifying Target Machine and Compiler Version
7343@cindex target options
7344@cindex cross compiling
7345@cindex specifying machine version
7346@cindex specifying compiler version and target machine
7347@cindex compiler version, specifying
7348@cindex target machine, specifying
7349
7350The usual way to run GCC is to run the executable called @file{gcc}, or
7351@file{<machine>-gcc} when cross-compiling, or
7352@file{<machine>-gcc-<version>} to run a version other than the one that
7353was installed last.  Sometimes this is inconvenient, so GCC provides
7354options that will switch to another cross-compiler or version.
7355
7356@table @gcctabopt
7357@item -b @var{machine}
7358@opindex b
7359The argument @var{machine} specifies the target machine for compilation.
7360
7361The value to use for @var{machine} is the same as was specified as the
7362machine type when configuring GCC as a cross-compiler.  For
7363example, if a cross-compiler was configured with @samp{configure
7364arm-elf}, meaning to compile for an arm processor with elf binaries,
7365then you would specify @option{-b arm-elf} to run that cross compiler.
7366Because there are other options beginning with @option{-b}, the
7367configuration must contain a hyphen.
7368
7369@item -V @var{version}
7370@opindex V
7371The argument @var{version} specifies which version of GCC to run.
7372This is useful when multiple versions are installed.  For example,
7373@var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7374@end table
7375
7376The @option{-V} and @option{-b} options work by running the
7377@file{<machine>-gcc-<version>} executable, so there's no real reason to
7378use them if you can just run that directly.
7379
7380@node Submodel Options
7381@section Hardware Models and Configurations
7382@cindex submodel options
7383@cindex specifying hardware config
7384@cindex hardware models and configurations, specifying
7385@cindex machine dependent options
7386
7387Earlier we discussed the standard option @option{-b} which chooses among
7388different installed compilers for completely different target
7389machines, such as VAX vs.@: 68000 vs.@: 80386.
7390
7391In addition, each of these target machine types can have its own
7392special options, starting with @samp{-m}, to choose among various
7393hardware models or configurations---for example, 68010 vs 68020,
7394floating coprocessor or none.  A single installed version of the
7395compiler can compile for any model or configuration, according to the
7396options specified.
7397
7398Some configurations of the compiler also support additional special
7399options, usually for compatibility with other compilers on the same
7400platform.
7401
7402@c This list is ordered alphanumerically by subsection name.
7403@c It should be the same order and spelling as these options are listed
7404@c in Machine Dependent Options
7405
7406@menu
7407* ARC Options::
7408* ARM Options::
7409* AVR Options::
7410* Blackfin Options::
7411* CRIS Options::
7412* CRX Options::
7413* Darwin Options::
7414* DEC Alpha Options::
7415* DEC Alpha/VMS Options::
7416* FRV Options::
7417* GNU/Linux Options::
7418* H8/300 Options::
7419* HPPA Options::
7420* i386 and x86-64 Options::
7421* IA-64 Options::
7422* M32C Options::
7423* M32R/D Options::
7424* M680x0 Options::
7425* M68hc1x Options::
7426* MCore Options::
7427* MIPS Options::
7428* MMIX Options::
7429* MN10300 Options::
7430* MT Options::
7431* PDP-11 Options::
7432* PowerPC Options::
7433* RS/6000 and PowerPC Options::
7434* S/390 and zSeries Options::
7435* Score Options::
7436* SH Options::
7437* SPARC Options::
7438* System V Options::
7439* TMS320C3x/C4x Options::
7440* V850 Options::
7441* VAX Options::
7442* x86-64 Options::
7443* Xstormy16 Options::
7444* Xtensa Options::
7445* zSeries Options::
7446@end menu
7447
7448@node ARC Options
7449@subsection ARC Options
7450@cindex ARC Options
7451
7452These options are defined for ARC implementations:
7453
7454@table @gcctabopt
7455@item -EL
7456@opindex EL
7457Compile code for little endian mode.  This is the default.
7458
7459@item -EB
7460@opindex EB
7461Compile code for big endian mode.
7462
7463@item -mmangle-cpu
7464@opindex mmangle-cpu
7465Prepend the name of the cpu to all public symbol names.
7466In multiple-processor systems, there are many ARC variants with different
7467instruction and register set characteristics.  This flag prevents code
7468compiled for one cpu to be linked with code compiled for another.
7469No facility exists for handling variants that are ``almost identical''.
7470This is an all or nothing option.
7471
7472@item -mcpu=@var{cpu}
7473@opindex mcpu
7474Compile code for ARC variant @var{cpu}.
7475Which variants are supported depend on the configuration.
7476All variants support @option{-mcpu=base}, this is the default.
7477
7478@item -mtext=@var{text-section}
7479@itemx -mdata=@var{data-section}
7480@itemx -mrodata=@var{readonly-data-section}
7481@opindex mtext
7482@opindex mdata
7483@opindex mrodata
7484Put functions, data, and readonly data in @var{text-section},
7485@var{data-section}, and @var{readonly-data-section} respectively
7486by default.  This can be overridden with the @code{section} attribute.
7487@xref{Variable Attributes}.
7488
7489@end table
7490
7491@node ARM Options
7492@subsection ARM Options
7493@cindex ARM options
7494
7495These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7496architectures:
7497
7498@table @gcctabopt
7499@item -mabi=@var{name}
7500@opindex mabi
7501Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7502@samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7503
7504@item -mapcs-frame
7505@opindex mapcs-frame
7506Generate a stack frame that is compliant with the ARM Procedure Call
7507Standard for all functions, even if this is not strictly necessary for
7508correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7509with this option will cause the stack frames not to be generated for
7510leaf functions.  The default is @option{-mno-apcs-frame}.
7511
7512@item -mapcs
7513@opindex mapcs
7514This is a synonym for @option{-mapcs-frame}.
7515
7516@ignore
7517@c not currently implemented
7518@item -mapcs-stack-check
7519@opindex mapcs-stack-check
7520Generate code to check the amount of stack space available upon entry to
7521every function (that actually uses some stack space).  If there is
7522insufficient space available then either the function
7523@samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7524called, depending upon the amount of stack space required.  The run time
7525system is required to provide these functions.  The default is
7526@option{-mno-apcs-stack-check}, since this produces smaller code.
7527
7528@c not currently implemented
7529@item -mapcs-float
7530@opindex mapcs-float
7531Pass floating point arguments using the float point registers.  This is
7532one of the variants of the APCS@.  This option is recommended if the
7533target hardware has a floating point unit or if a lot of floating point
7534arithmetic is going to be performed by the code.  The default is
7535@option{-mno-apcs-float}, since integer only code is slightly increased in
7536size if @option{-mapcs-float} is used.
7537
7538@c not currently implemented
7539@item -mapcs-reentrant
7540@opindex mapcs-reentrant
7541Generate reentrant, position independent code.  The default is
7542@option{-mno-apcs-reentrant}.
7543@end ignore
7544
7545@item -mthumb-interwork
7546@opindex mthumb-interwork
7547Generate code which supports calling between the ARM and Thumb
7548instruction sets.  Without this option the two instruction sets cannot
7549be reliably used inside one program.  The default is
7550@option{-mno-thumb-interwork}, since slightly larger code is generated
7551when @option{-mthumb-interwork} is specified.
7552
7553@item -mno-sched-prolog
7554@opindex mno-sched-prolog
7555Prevent the reordering of instructions in the function prolog, or the
7556merging of those instruction with the instructions in the function's
7557body.  This means that all functions will start with a recognizable set
7558of instructions (or in fact one of a choice from a small set of
7559different function prologues), and this information can be used to
7560locate the start if functions inside an executable piece of code.  The
7561default is @option{-msched-prolog}.
7562
7563@item -mhard-float
7564@opindex mhard-float
7565Generate output containing floating point instructions.  This is the
7566default.
7567
7568@item -msoft-float
7569@opindex msoft-float
7570Generate output containing library calls for floating point.
7571@strong{Warning:} the requisite libraries are not available for all ARM
7572targets.  Normally the facilities of the machine's usual C compiler are
7573used, but this cannot be done directly in cross-compilation.  You must make
7574your own arrangements to provide suitable library functions for
7575cross-compilation.
7576
7577@option{-msoft-float} changes the calling convention in the output file;
7578therefore, it is only useful if you compile @emph{all} of a program with
7579this option.  In particular, you need to compile @file{libgcc.a}, the
7580library that comes with GCC, with @option{-msoft-float} in order for
7581this to work.
7582
7583@item -mfloat-abi=@var{name}
7584@opindex mfloat-abi
7585Specifies which ABI to use for floating point values.  Permissible values
7586are: @samp{soft}, @samp{softfp} and @samp{hard}.
7587
7588@samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7589and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7590of floating point instructions, but still uses the soft-float calling
7591conventions.
7592
7593@item -mlittle-endian
7594@opindex mlittle-endian
7595Generate code for a processor running in little-endian mode.  This is
7596the default for all standard configurations.
7597
7598@item -mbig-endian
7599@opindex mbig-endian
7600Generate code for a processor running in big-endian mode; the default is
7601to compile code for a little-endian processor.
7602
7603@item -mwords-little-endian
7604@opindex mwords-little-endian
7605This option only applies when generating code for big-endian processors.
7606Generate code for a little-endian word order but a big-endian byte
7607order.  That is, a byte order of the form @samp{32107654}.  Note: this
7608option should only be used if you require compatibility with code for
7609big-endian ARM processors generated by versions of the compiler prior to
76102.8.
7611
7612@item -mcpu=@var{name}
7613@opindex mcpu
7614This specifies the name of the target ARM processor.  GCC uses this name
7615to determine what kind of instructions it can emit when generating
7616assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7617@samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7618@samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7619@samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7620@samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7621@samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7622@samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7623@samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7624@samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7625@samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7626@samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7627@samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7628@samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7629@samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7630@samp{ep9312}.
7631
7632@itemx -mtune=@var{name}
7633@opindex mtune
7634This option is very similar to the @option{-mcpu=} option, except that
7635instead of specifying the actual target processor type, and hence
7636restricting which instructions can be used, it specifies that GCC should
7637tune the performance of the code as if the target were of the type
7638specified in this option, but still choosing the instructions that it
7639will generate based on the cpu specified by a @option{-mcpu=} option.
7640For some ARM implementations better performance can be obtained by using
7641this option.
7642
7643@item -march=@var{name}
7644@opindex march
7645This specifies the name of the target ARM architecture.  GCC uses this
7646name to determine what kind of instructions it can emit when generating
7647assembly code.  This option can be used in conjunction with or instead
7648of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7649@samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7650@samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7651@samp{iwmmxt}, @samp{ep9312}.
7652
7653@item -mfpu=@var{name}
7654@itemx -mfpe=@var{number}
7655@itemx -mfp=@var{number}
7656@opindex mfpu
7657@opindex mfpe
7658@opindex mfp
7659This specifies what floating point hardware (or hardware emulation) is
7660available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7661@samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7662are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7663with older versions of GCC@.
7664
7665If @option{-msoft-float} is specified this specifies the format of
7666floating point values.
7667
7668@item -mstructure-size-boundary=@var{n}
7669@opindex mstructure-size-boundary
7670The size of all structures and unions will be rounded up to a multiple
7671of the number of bits set by this option.  Permissible values are 8, 32
7672and 64.  The default value varies for different toolchains.  For the COFF
7673targeted toolchain the default value is 8.  A value of 64 is only allowed
7674if the underlying ABI supports it.
7675
7676Specifying the larger number can produce faster, more efficient code, but
7677can also increase the size of the program.  Different values are potentially
7678incompatible.  Code compiled with one value cannot necessarily expect to
7679work with code or libraries compiled with another value, if they exchange
7680information using structures or unions.
7681
7682@item -mabort-on-noreturn
7683@opindex mabort-on-noreturn
7684Generate a call to the function @code{abort} at the end of a
7685@code{noreturn} function.  It will be executed if the function tries to
7686return.
7687
7688@item -mlong-calls
7689@itemx -mno-long-calls
7690@opindex mlong-calls
7691@opindex mno-long-calls
7692Tells the compiler to perform function calls by first loading the
7693address of the function into a register and then performing a subroutine
7694call on this register.  This switch is needed if the target function
7695will lie outside of the 64 megabyte addressing range of the offset based
7696version of subroutine call instruction.
7697
7698Even if this switch is enabled, not all function calls will be turned
7699into long calls.  The heuristic is that static functions, functions
7700which have the @samp{short-call} attribute, functions that are inside
7701the scope of a @samp{#pragma no_long_calls} directive and functions whose
7702definitions have already been compiled within the current compilation
7703unit, will not be turned into long calls.  The exception to this rule is
7704that weak function definitions, functions with the @samp{long-call}
7705attribute or the @samp{section} attribute, and functions that are within
7706the scope of a @samp{#pragma long_calls} directive, will always be
7707turned into long calls.
7708
7709This feature is not enabled by default.  Specifying
7710@option{-mno-long-calls} will restore the default behavior, as will
7711placing the function calls within the scope of a @samp{#pragma
7712long_calls_off} directive.  Note these switches have no effect on how
7713the compiler generates code to handle function calls via function
7714pointers.
7715
7716@item -mnop-fun-dllimport
7717@opindex mnop-fun-dllimport
7718Disable support for the @code{dllimport} attribute.
7719
7720@item -msingle-pic-base
7721@opindex msingle-pic-base
7722Treat the register used for PIC addressing as read-only, rather than
7723loading it in the prologue for each function.  The run-time system is
7724responsible for initializing this register with an appropriate value
7725before execution begins.
7726
7727@item -mpic-register=@var{reg}
7728@opindex mpic-register
7729Specify the register to be used for PIC addressing.  The default is R10
7730unless stack-checking is enabled, when R9 is used.
7731
7732@item -mcirrus-fix-invalid-insns
7733@opindex mcirrus-fix-invalid-insns
7734@opindex mno-cirrus-fix-invalid-insns
7735Insert NOPs into the instruction stream to in order to work around
7736problems with invalid Maverick instruction combinations.  This option
7737is only valid if the @option{-mcpu=ep9312} option has been used to
7738enable generation of instructions for the Cirrus Maverick floating
7739point co-processor.  This option is not enabled by default, since the
7740problem is only present in older Maverick implementations.  The default
7741can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7742switch.
7743
7744@item -mpoke-function-name
7745@opindex mpoke-function-name
7746Write the name of each function into the text section, directly
7747preceding the function prologue.  The generated code is similar to this:
7748
7749@smallexample
7750     t0
7751         .ascii "arm_poke_function_name", 0
7752         .align
7753     t1
7754         .word 0xff000000 + (t1 - t0)
7755     arm_poke_function_name
7756         mov     ip, sp
7757         stmfd   sp!, @{fp, ip, lr, pc@}
7758         sub     fp, ip, #4
7759@end smallexample
7760
7761When performing a stack backtrace, code can inspect the value of
7762@code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7763location @code{pc - 12} and the top 8 bits are set, then we know that
7764there is a function name embedded immediately preceding this location
7765and has length @code{((pc[-3]) & 0xff000000)}.
7766
7767@item -mthumb
7768@opindex mthumb
7769Generate code for the 16-bit Thumb instruction set.  The default is to
7770use the 32-bit ARM instruction set.
7771
7772@item -mtpcs-frame
7773@opindex mtpcs-frame
7774Generate a stack frame that is compliant with the Thumb Procedure Call
7775Standard for all non-leaf functions.  (A leaf function is one that does
7776not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7777
7778@item -mtpcs-leaf-frame
7779@opindex mtpcs-leaf-frame
7780Generate a stack frame that is compliant with the Thumb Procedure Call
7781Standard for all leaf functions.  (A leaf function is one that does
7782not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7783
7784@item -mcallee-super-interworking
7785@opindex mcallee-super-interworking
7786Gives all externally visible functions in the file being compiled an ARM
7787instruction set header which switches to Thumb mode before executing the
7788rest of the function.  This allows these functions to be called from
7789non-interworking code.
7790
7791@item -mcaller-super-interworking
7792@opindex mcaller-super-interworking
7793Allows calls via function pointers (including virtual functions) to
7794execute correctly regardless of whether the target code has been
7795compiled for interworking or not.  There is a small overhead in the cost
7796of executing a function pointer if this option is enabled.
7797
7798@item -mtp=@var{name}
7799@opindex mtp
7800Specify the access model for the thread local storage pointer.  The valid
7801models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7802@option{cp15}, which fetches the thread pointer from @code{cp15} directly
7803(supported in the arm6k architecture), and @option{auto}, which uses the
7804best available method for the selected processor.  The default setting is
7805@option{auto}.
7806
7807@end table
7808
7809@node AVR Options
7810@subsection AVR Options
7811@cindex AVR Options
7812
7813These options are defined for AVR implementations:
7814
7815@table @gcctabopt
7816@item -mmcu=@var{mcu}
7817@opindex mmcu
7818Specify ATMEL AVR instruction set or MCU type.
7819
7820Instruction set avr1 is for the minimal AVR core, not supported by the C
7821compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7822attiny11, attiny12, attiny15, attiny28).
7823
7824Instruction set avr2 (default) is for the classic AVR core with up to
78258K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7826at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7827at90c8534, at90s8535).
7828
7829Instruction set avr3 is for the classic AVR core with up to 128K program
7830memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7831
7832Instruction set avr4 is for the enhanced AVR core with up to 8K program
7833memory space (MCU types: atmega8, atmega83, atmega85).
7834
7835Instruction set avr5 is for the enhanced AVR core with up to 128K program
7836memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7837atmega64, atmega128, at43usb355, at94k).
7838
7839@item -msize
7840@opindex msize
7841Output instruction sizes to the asm file.
7842
7843@item -minit-stack=@var{N}
7844@opindex minit-stack
7845Specify the initial stack address, which may be a symbol or numeric value,
7846@samp{__stack} is the default.
7847
7848@item -mno-interrupts
7849@opindex mno-interrupts
7850Generated code is not compatible with hardware interrupts.
7851Code size will be smaller.
7852
7853@item -mcall-prologues
7854@opindex mcall-prologues
7855Functions prologues/epilogues expanded as call to appropriate
7856subroutines.  Code size will be smaller.
7857
7858@item -mno-tablejump
7859@opindex mno-tablejump
7860Do not generate tablejump insns which sometimes increase code size.
7861
7862@item -mtiny-stack
7863@opindex mtiny-stack
7864Change only the low 8 bits of the stack pointer.
7865
7866@item -mint8
7867@opindex mint8
7868Assume int to be 8 bit integer.  This affects the sizes of all types: A
7869char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7870and long long will be 4 bytes.  Please note that this option does not
7871comply to the C standards, but it will provide you with smaller code
7872size.
7873@end table
7874
7875@node Blackfin Options
7876@subsection Blackfin Options
7877@cindex Blackfin Options
7878
7879@table @gcctabopt
7880@item -momit-leaf-frame-pointer
7881@opindex momit-leaf-frame-pointer
7882Don't keep the frame pointer in a register for leaf functions.  This
7883avoids the instructions to save, set up and restore frame pointers and
7884makes an extra register available in leaf functions.  The option
7885@option{-fomit-frame-pointer} removes the frame pointer for all functions
7886which might make debugging harder.
7887
7888@item -mspecld-anomaly
7889@opindex mspecld-anomaly
7890When enabled, the compiler will ensure that the generated code does not
7891contain speculative loads after jump instructions.  This option is enabled
7892by default.
7893
7894@item -mno-specld-anomaly
7895@opindex mno-specld-anomaly
7896Don't generate extra code to prevent speculative loads from occurring.
7897
7898@item -mcsync-anomaly
7899@opindex mcsync-anomaly
7900When enabled, the compiler will ensure that the generated code does not
7901contain CSYNC or SSYNC instructions too soon after conditional branches.
7902This option is enabled by default.
7903
7904@item -mno-csync-anomaly
7905@opindex mno-csync-anomaly
7906Don't generate extra code to prevent CSYNC or SSYNC instructions from
7907occurring too soon after a conditional branch.
7908
7909@item -mlow-64k
7910@opindex mlow-64k
7911When enabled, the compiler is free to take advantage of the knowledge that
7912the entire program fits into the low 64k of memory.
7913
7914@item -mno-low-64k
7915@opindex mno-low-64k
7916Assume that the program is arbitrarily large.  This is the default.
7917
7918@item -mid-shared-library
7919@opindex mid-shared-library
7920Generate code that supports shared libraries via the library ID method.
7921This allows for execute in place and shared libraries in an environment
7922without virtual memory management.  This option implies @option{-fPIC}.
7923
7924@item -mno-id-shared-library
7925@opindex mno-id-shared-library
7926Generate code that doesn't assume ID based shared libraries are being used.
7927This is the default.
7928
7929@item -mshared-library-id=n
7930@opindex mshared-library-id
7931Specified the identification number of the ID based shared library being
7932compiled.  Specifying a value of 0 will generate more compact code, specifying
7933other values will force the allocation of that number to the current
7934library but is no more space or time efficient than omitting this option.
7935
7936@item -mlong-calls
7937@itemx -mno-long-calls
7938@opindex mlong-calls
7939@opindex mno-long-calls
7940Tells the compiler to perform function calls by first loading the
7941address of the function into a register and then performing a subroutine
7942call on this register.  This switch is needed if the target function
7943will lie outside of the 24 bit addressing range of the offset based
7944version of subroutine call instruction.
7945
7946This feature is not enabled by default.  Specifying
7947@option{-mno-long-calls} will restore the default behavior.  Note these
7948switches have no effect on how the compiler generates code to handle
7949function calls via function pointers.
7950@end table
7951
7952@node CRIS Options
7953@subsection CRIS Options
7954@cindex CRIS Options
7955
7956These options are defined specifically for the CRIS ports.
7957
7958@table @gcctabopt
7959@item -march=@var{architecture-type}
7960@itemx -mcpu=@var{architecture-type}
7961@opindex march
7962@opindex mcpu
7963Generate code for the specified architecture.  The choices for
7964@var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7965respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7966Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7967@samp{v10}.
7968
7969@item -mtune=@var{architecture-type}
7970@opindex mtune
7971Tune to @var{architecture-type} everything applicable about the generated
7972code, except for the ABI and the set of available instructions.  The
7973choices for @var{architecture-type} are the same as for
7974@option{-march=@var{architecture-type}}.
7975
7976@item -mmax-stack-frame=@var{n}
7977@opindex mmax-stack-frame
7978Warn when the stack frame of a function exceeds @var{n} bytes.
7979
7980@item -melinux-stacksize=@var{n}
7981@opindex melinux-stacksize
7982Only available with the @samp{cris-axis-aout} target.  Arranges for
7983indications in the program to the kernel loader that the stack of the
7984program should be set to @var{n} bytes.
7985
7986@item -metrax4
7987@itemx -metrax100
7988@opindex metrax4
7989@opindex metrax100
7990The options @option{-metrax4} and @option{-metrax100} are synonyms for
7991@option{-march=v3} and @option{-march=v8} respectively.
7992
7993@item -mmul-bug-workaround
7994@itemx -mno-mul-bug-workaround
7995@opindex mmul-bug-workaround
7996@opindex mno-mul-bug-workaround
7997Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7998models where it applies.  This option is active by default.
7999
8000@item -mpdebug
8001@opindex mpdebug
8002Enable CRIS-specific verbose debug-related information in the assembly
8003code.  This option also has the effect to turn off the @samp{#NO_APP}
8004formatted-code indicator to the assembler at the beginning of the
8005assembly file.
8006
8007@item -mcc-init
8008@opindex mcc-init
8009Do not use condition-code results from previous instruction; always emit
8010compare and test instructions before use of condition codes.
8011
8012@item -mno-side-effects
8013@opindex mno-side-effects
8014Do not emit instructions with side-effects in addressing modes other than
8015post-increment.
8016
8017@item -mstack-align
8018@itemx -mno-stack-align
8019@itemx -mdata-align
8020@itemx -mno-data-align
8021@itemx -mconst-align
8022@itemx -mno-const-align
8023@opindex mstack-align
8024@opindex mno-stack-align
8025@opindex mdata-align
8026@opindex mno-data-align
8027@opindex mconst-align
8028@opindex mno-const-align
8029These options (no-options) arranges (eliminate arrangements) for the
8030stack-frame, individual data and constants to be aligned for the maximum
8031single data access size for the chosen CPU model.  The default is to
8032arrange for 32-bit alignment.  ABI details such as structure layout are
8033not affected by these options.
8034
8035@item -m32-bit
8036@itemx -m16-bit
8037@itemx -m8-bit
8038@opindex m32-bit
8039@opindex m16-bit
8040@opindex m8-bit
8041Similar to the stack- data- and const-align options above, these options
8042arrange for stack-frame, writable data and constants to all be 32-bit,
804316-bit or 8-bit aligned.  The default is 32-bit alignment.
8044
8045@item -mno-prologue-epilogue
8046@itemx -mprologue-epilogue
8047@opindex mno-prologue-epilogue
8048@opindex mprologue-epilogue
8049With @option{-mno-prologue-epilogue}, the normal function prologue and
8050epilogue that sets up the stack-frame are omitted and no return
8051instructions or return sequences are generated in the code.  Use this
8052option only together with visual inspection of the compiled code: no
8053warnings or errors are generated when call-saved registers must be saved,
8054or storage for local variable needs to be allocated.
8055
8056@item -mno-gotplt
8057@itemx -mgotplt
8058@opindex mno-gotplt
8059@opindex mgotplt
8060With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
8061instruction sequences that load addresses for functions from the PLT part
8062of the GOT rather than (traditional on other architectures) calls to the
8063PLT@.  The default is @option{-mgotplt}.
8064
8065@item -maout
8066@opindex maout
8067Legacy no-op option only recognized with the cris-axis-aout target.
8068
8069@item -melf
8070@opindex melf
8071Legacy no-op option only recognized with the cris-axis-elf and
8072cris-axis-linux-gnu targets.
8073
8074@item -melinux
8075@opindex melinux
8076Only recognized with the cris-axis-aout target, where it selects a
8077GNU/linux-like multilib, include files and instruction set for
8078@option{-march=v8}.
8079
8080@item -mlinux
8081@opindex mlinux
8082Legacy no-op option only recognized with the cris-axis-linux-gnu target.
8083
8084@item -sim
8085@opindex sim
8086This option, recognized for the cris-axis-aout and cris-axis-elf arranges
8087to link with input-output functions from a simulator library.  Code,
8088initialized data and zero-initialized data are allocated consecutively.
8089
8090@item -sim2
8091@opindex sim2
8092Like @option{-sim}, but pass linker options to locate initialized data at
80930x40000000 and zero-initialized data at 0x80000000.
8094@end table
8095
8096@node CRX Options
8097@subsection CRX Options
8098@cindex CRX Options
8099
8100These options are defined specifically for the CRX ports.
8101
8102@table @gcctabopt
8103
8104@item -mmac
8105@opindex mmac
8106Enable the use of multiply-accumulate instructions. Disabled by default.
8107
8108@item -mpush-args
8109@opindex mpush-args
8110Push instructions will be used to pass outgoing arguments when functions
8111are called. Enabled by default.
8112@end table
8113
8114@node Darwin Options
8115@subsection Darwin Options
8116@cindex Darwin options
8117
8118These options are defined for all architectures running the Darwin operating
8119system.
8120
8121FSF GCC on Darwin does not create ``fat'' object files; it will create
8122an object file for the single architecture that it was built to
8123target.  Apple's GCC on Darwin does create ``fat'' files if multiple
8124@option{-arch} options are used; it does so by running the compiler or
8125linker multiple times and joining the results together with
8126@file{lipo}.
8127
8128The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8129@samp{i686}) is determined by the flags that specify the ISA
8130that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
8131@option{-force_cpusubtype_ALL} option can be used to override this.
8132
8133The Darwin tools vary in their behavior when presented with an ISA
8134mismatch.  The assembler, @file{as}, will only permit instructions to
8135be used that are valid for the subtype of the file it is generating,
8136so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8137The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8138and print an error if asked to create a shared library with a less
8139restrictive subtype than its input files (for instance, trying to put
8140a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
8141for executables, @file{ld}, will quietly give the executable the most
8142restrictive subtype of any of its input files.
8143
8144@table @gcctabopt
8145@item -F@var{dir}
8146@opindex F
8147Add the framework directory @var{dir} to the head of the list of
8148directories to be searched for header files.  These directories are
8149interleaved with those specified by @option{-I} options and are
8150scanned in a left-to-right order.
8151
8152A framework directory is a directory with frameworks in it.  A
8153framework is a directory with a @samp{"Headers"} and/or
8154@samp{"PrivateHeaders"} directory contained directly in it that ends
8155in @samp{".framework"}.  The name of a framework is the name of this
8156directory excluding the @samp{".framework"}.  Headers associated with
8157the framework are found in one of those two directories, with
8158@samp{"Headers"} being searched first.  A subframework is a framework
8159directory that is in a framework's @samp{"Frameworks"} directory.
8160Includes of subframework headers can only appear in a header of a
8161framework that contains the subframework, or in a sibling subframework
8162header.  Two subframeworks are siblings if they occur in the same
8163framework.  A subframework should not have the same name as a
8164framework, a warning will be issued if this is violated.  Currently a
8165subframework cannot have subframeworks, in the future, the mechanism
8166may be extended to support this.  The standard frameworks can be found
8167in @samp{"/System/Library/Frameworks"} and
8168@samp{"/Library/Frameworks"}.  An example include looks like
8169@code{#include <Framework/header.h>}, where @samp{Framework} denotes
8170the name of the framework and header.h is found in the
8171@samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8172
8173@item -gused
8174@opindex gused
8175Emit debugging information for symbols that are used.  For STABS
8176debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8177This is by default ON@.
8178
8179@item -gfull
8180@opindex gfull
8181Emit debugging information for all symbols and types.
8182
8183@item -mmacosx-version-min=@var{version}
8184The earliest version of MacOS X that this executable will run on
8185is @var{version}.  Typical values of @var{version} include @code{10.1},
8186@code{10.2}, and @code{10.3.9}.
8187
8188The default for this option is to make choices that seem to be most
8189useful.
8190
8191@item -mkernel
8192@opindex mkernel
8193Enable kernel development mode.  The @option{-mkernel} option sets
8194@option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8195@option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8196@option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8197applicable.  This mode also sets @option{-mno-altivec},
8198@option{-msoft-float}, @option{-fno-builtin} and
8199@option{-mlong-branch} for PowerPC targets.
8200
8201@item -mone-byte-bool
8202@opindex mone-byte-bool
8203Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8204By default @samp{sizeof(bool)} is @samp{4} when compiling for
8205Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8206option has no effect on x86.
8207
8208@strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8209to generate code that is not binary compatible with code generated
8210without that switch.  Using this switch may require recompiling all
8211other modules in a program, including system libraries.  Use this
8212switch to conform to a non-default data model.
8213
8214@item -mfix-and-continue
8215@itemx -ffix-and-continue
8216@itemx -findirect-data
8217@opindex mfix-and-continue
8218@opindex ffix-and-continue
8219@opindex findirect-data
8220Generate code suitable for fast turn around development.  Needed to
8221enable gdb to dynamically load @code{.o} files into already running
8222programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8223are provided for backwards compatibility.
8224
8225@item -all_load
8226@opindex all_load
8227Loads all members of static archive libraries.
8228See man ld(1) for more information.
8229
8230@item -arch_errors_fatal
8231@opindex arch_errors_fatal
8232Cause the errors having to do with files that have the wrong architecture
8233to be fatal.
8234
8235@item -bind_at_load
8236@opindex bind_at_load
8237Causes the output file to be marked such that the dynamic linker will
8238bind all undefined references when the file is loaded or launched.
8239
8240@item -bundle
8241@opindex bundle
8242Produce a Mach-o bundle format file.
8243See man ld(1) for more information.
8244
8245@item -bundle_loader @var{executable}
8246@opindex bundle_loader
8247This option specifies the @var{executable} that will be loading the build
8248output file being linked.  See man ld(1) for more information.
8249
8250@item -dynamiclib
8251@opindex dynamiclib
8252When passed this option, GCC will produce a dynamic library instead of
8253an executable when linking, using the Darwin @file{libtool} command.
8254
8255@item -force_cpusubtype_ALL
8256@opindex force_cpusubtype_ALL
8257This causes GCC's output file to have the @var{ALL} subtype, instead of
8258one controlled by the @option{-mcpu} or @option{-march} option.
8259
8260@item -allowable_client  @var{client_name}
8261@itemx -client_name
8262@itemx -compatibility_version
8263@itemx -current_version
8264@itemx -dead_strip
8265@itemx -dependency-file
8266@itemx -dylib_file
8267@itemx -dylinker_install_name
8268@itemx -dynamic
8269@itemx -exported_symbols_list
8270@itemx -filelist
8271@itemx -flat_namespace
8272@itemx -force_flat_namespace
8273@itemx -headerpad_max_install_names
8274@itemx -image_base
8275@itemx -init
8276@itemx -install_name
8277@itemx -keep_private_externs
8278@itemx -multi_module
8279@itemx -multiply_defined
8280@itemx -multiply_defined_unused
8281@itemx -noall_load
8282@itemx -no_dead_strip_inits_and_terms
8283@itemx -nofixprebinding
8284@itemx -nomultidefs
8285@itemx -noprebind
8286@itemx -noseglinkedit
8287@itemx -pagezero_size
8288@itemx -prebind
8289@itemx -prebind_all_twolevel_modules
8290@itemx -private_bundle
8291@itemx -read_only_relocs
8292@itemx -sectalign
8293@itemx -sectobjectsymbols
8294@itemx -whyload
8295@itemx -seg1addr
8296@itemx -sectcreate
8297@itemx -sectobjectsymbols
8298@itemx -sectorder
8299@itemx -segaddr
8300@itemx -segs_read_only_addr
8301@itemx -segs_read_write_addr
8302@itemx -seg_addr_table
8303@itemx -seg_addr_table_filename
8304@itemx -seglinkedit
8305@itemx -segprot
8306@itemx -segs_read_only_addr
8307@itemx -segs_read_write_addr
8308@itemx -single_module
8309@itemx -static
8310@itemx -sub_library
8311@itemx -sub_umbrella
8312@itemx -twolevel_namespace
8313@itemx -umbrella
8314@itemx -undefined
8315@itemx -unexported_symbols_list
8316@itemx -weak_reference_mismatches
8317@itemx -whatsloaded
8318
8319@opindex allowable_client
8320@opindex client_name
8321@opindex compatibility_version
8322@opindex current_version
8323@opindex dead_strip
8324@opindex dependency-file
8325@opindex dylib_file
8326@opindex dylinker_install_name
8327@opindex dynamic
8328@opindex exported_symbols_list
8329@opindex filelist
8330@opindex flat_namespace
8331@opindex force_flat_namespace
8332@opindex headerpad_max_install_names
8333@opindex image_base
8334@opindex init
8335@opindex install_name
8336@opindex keep_private_externs
8337@opindex multi_module
8338@opindex multiply_defined
8339@opindex multiply_defined_unused
8340@opindex noall_load
8341@opindex no_dead_strip_inits_and_terms
8342@opindex nofixprebinding
8343@opindex nomultidefs
8344@opindex noprebind
8345@opindex noseglinkedit
8346@opindex pagezero_size
8347@opindex prebind
8348@opindex prebind_all_twolevel_modules
8349@opindex private_bundle
8350@opindex read_only_relocs
8351@opindex sectalign
8352@opindex sectobjectsymbols
8353@opindex whyload
8354@opindex seg1addr
8355@opindex sectcreate
8356@opindex sectobjectsymbols
8357@opindex sectorder
8358@opindex segaddr
8359@opindex segs_read_only_addr
8360@opindex segs_read_write_addr
8361@opindex seg_addr_table
8362@opindex seg_addr_table_filename
8363@opindex seglinkedit
8364@opindex segprot
8365@opindex segs_read_only_addr
8366@opindex segs_read_write_addr
8367@opindex single_module
8368@opindex static
8369@opindex sub_library
8370@opindex sub_umbrella
8371@opindex twolevel_namespace
8372@opindex umbrella
8373@opindex undefined
8374@opindex unexported_symbols_list
8375@opindex weak_reference_mismatches
8376@opindex whatsloaded
8377
8378These options are passed to the Darwin linker.  The Darwin linker man page
8379describes them in detail.
8380@end table
8381
8382@node DEC Alpha Options
8383@subsection DEC Alpha Options
8384
8385These @samp{-m} options are defined for the DEC Alpha implementations:
8386
8387@table @gcctabopt
8388@item -mno-soft-float
8389@itemx -msoft-float
8390@opindex mno-soft-float
8391@opindex msoft-float
8392Use (do not use) the hardware floating-point instructions for
8393floating-point operations.  When @option{-msoft-float} is specified,
8394functions in @file{libgcc.a} will be used to perform floating-point
8395operations.  Unless they are replaced by routines that emulate the
8396floating-point operations, or compiled in such a way as to call such
8397emulations routines, these routines will issue floating-point
8398operations.   If you are compiling for an Alpha without floating-point
8399operations, you must ensure that the library is built so as not to call
8400them.
8401
8402Note that Alpha implementations without floating-point operations are
8403required to have floating-point registers.
8404
8405@item -mfp-reg
8406@itemx -mno-fp-regs
8407@opindex mfp-reg
8408@opindex mno-fp-regs
8409Generate code that uses (does not use) the floating-point register set.
8410@option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8411register set is not used, floating point operands are passed in integer
8412registers as if they were integers and floating-point results are passed
8413in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8414so any function with a floating-point argument or return value called by code
8415compiled with @option{-mno-fp-regs} must also be compiled with that
8416option.
8417
8418A typical use of this option is building a kernel that does not use,
8419and hence need not save and restore, any floating-point registers.
8420
8421@item -mieee
8422@opindex mieee
8423The Alpha architecture implements floating-point hardware optimized for
8424maximum performance.  It is mostly compliant with the IEEE floating
8425point standard.  However, for full compliance, software assistance is
8426required.  This option generates code fully IEEE compliant code
8427@emph{except} that the @var{inexact-flag} is not maintained (see below).
8428If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8429defined during compilation.  The resulting code is less efficient but is
8430able to correctly support denormalized numbers and exceptional IEEE
8431values such as not-a-number and plus/minus infinity.  Other Alpha
8432compilers call this option @option{-ieee_with_no_inexact}.
8433
8434@item -mieee-with-inexact
8435@opindex mieee-with-inexact
8436This is like @option{-mieee} except the generated code also maintains
8437the IEEE @var{inexact-flag}.  Turning on this option causes the
8438generated code to implement fully-compliant IEEE math.  In addition to
8439@code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8440macro.  On some Alpha implementations the resulting code may execute
8441significantly slower than the code generated by default.  Since there is
8442very little code that depends on the @var{inexact-flag}, you should
8443normally not specify this option.  Other Alpha compilers call this
8444option @option{-ieee_with_inexact}.
8445
8446@item -mfp-trap-mode=@var{trap-mode}
8447@opindex mfp-trap-mode
8448This option controls what floating-point related traps are enabled.
8449Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8450The trap mode can be set to one of four values:
8451
8452@table @samp
8453@item n
8454This is the default (normal) setting.  The only traps that are enabled
8455are the ones that cannot be disabled in software (e.g., division by zero
8456trap).
8457
8458@item u
8459In addition to the traps enabled by @samp{n}, underflow traps are enabled
8460as well.
8461
8462@item su
8463Like @samp{u}, but the instructions are marked to be safe for software
8464completion (see Alpha architecture manual for details).
8465
8466@item sui
8467Like @samp{su}, but inexact traps are enabled as well.
8468@end table
8469
8470@item -mfp-rounding-mode=@var{rounding-mode}
8471@opindex mfp-rounding-mode
8472Selects the IEEE rounding mode.  Other Alpha compilers call this option
8473@option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8474of:
8475
8476@table @samp
8477@item n
8478Normal IEEE rounding mode.  Floating point numbers are rounded towards
8479the nearest machine number or towards the even machine number in case
8480of a tie.
8481
8482@item m
8483Round towards minus infinity.
8484
8485@item c
8486Chopped rounding mode.  Floating point numbers are rounded towards zero.
8487
8488@item d
8489Dynamic rounding mode.  A field in the floating point control register
8490(@var{fpcr}, see Alpha architecture reference manual) controls the
8491rounding mode in effect.  The C library initializes this register for
8492rounding towards plus infinity.  Thus, unless your program modifies the
8493@var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8494@end table
8495
8496@item -mtrap-precision=@var{trap-precision}
8497@opindex mtrap-precision
8498In the Alpha architecture, floating point traps are imprecise.  This
8499means without software assistance it is impossible to recover from a
8500floating trap and program execution normally needs to be terminated.
8501GCC can generate code that can assist operating system trap handlers
8502in determining the exact location that caused a floating point trap.
8503Depending on the requirements of an application, different levels of
8504precisions can be selected:
8505
8506@table @samp
8507@item p
8508Program precision.  This option is the default and means a trap handler
8509can only identify which program caused a floating point exception.
8510
8511@item f
8512Function precision.  The trap handler can determine the function that
8513caused a floating point exception.
8514
8515@item i
8516Instruction precision.  The trap handler can determine the exact
8517instruction that caused a floating point exception.
8518@end table
8519
8520Other Alpha compilers provide the equivalent options called
8521@option{-scope_safe} and @option{-resumption_safe}.
8522
8523@item -mieee-conformant
8524@opindex mieee-conformant
8525This option marks the generated code as IEEE conformant.  You must not
8526use this option unless you also specify @option{-mtrap-precision=i} and either
8527@option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8528is to emit the line @samp{.eflag 48} in the function prologue of the
8529generated assembly file.  Under DEC Unix, this has the effect that
8530IEEE-conformant math library routines will be linked in.
8531
8532@item -mbuild-constants
8533@opindex mbuild-constants
8534Normally GCC examines a 32- or 64-bit integer constant to
8535see if it can construct it from smaller constants in two or three
8536instructions.  If it cannot, it will output the constant as a literal and
8537generate code to load it from the data segment at runtime.
8538
8539Use this option to require GCC to construct @emph{all} integer constants
8540using code, even if it takes more instructions (the maximum is six).
8541
8542You would typically use this option to build a shared library dynamic
8543loader.  Itself a shared library, it must relocate itself in memory
8544before it can find the variables and constants in its own data segment.
8545
8546@item -malpha-as
8547@itemx -mgas
8548@opindex malpha-as
8549@opindex mgas
8550Select whether to generate code to be assembled by the vendor-supplied
8551assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8552
8553@item -mbwx
8554@itemx -mno-bwx
8555@itemx -mcix
8556@itemx -mno-cix
8557@itemx -mfix
8558@itemx -mno-fix
8559@itemx -mmax
8560@itemx -mno-max
8561@opindex mbwx
8562@opindex mno-bwx
8563@opindex mcix
8564@opindex mno-cix
8565@opindex mfix
8566@opindex mno-fix
8567@opindex mmax
8568@opindex mno-max
8569Indicate whether GCC should generate code to use the optional BWX,
8570CIX, FIX and MAX instruction sets.  The default is to use the instruction
8571sets supported by the CPU type specified via @option{-mcpu=} option or that
8572of the CPU on which GCC was built if none was specified.
8573
8574@item -mfloat-vax
8575@itemx -mfloat-ieee
8576@opindex mfloat-vax
8577@opindex mfloat-ieee
8578Generate code that uses (does not use) VAX F and G floating point
8579arithmetic instead of IEEE single and double precision.
8580
8581@item -mexplicit-relocs
8582@itemx -mno-explicit-relocs
8583@opindex mexplicit-relocs
8584@opindex mno-explicit-relocs
8585Older Alpha assemblers provided no way to generate symbol relocations
8586except via assembler macros.  Use of these macros does not allow
8587optimal instruction scheduling.  GNU binutils as of version 2.12
8588supports a new syntax that allows the compiler to explicitly mark
8589which relocations should apply to which instructions.  This option
8590is mostly useful for debugging, as GCC detects the capabilities of
8591the assembler when it is built and sets the default accordingly.
8592
8593@item -msmall-data
8594@itemx -mlarge-data
8595@opindex msmall-data
8596@opindex mlarge-data
8597When @option{-mexplicit-relocs} is in effect, static data is
8598accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8599is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8600(the @code{.sdata} and @code{.sbss} sections) and are accessed via
860116-bit relocations off of the @code{$gp} register.  This limits the
8602size of the small data area to 64KB, but allows the variables to be
8603directly accessed via a single instruction.
8604
8605The default is @option{-mlarge-data}.  With this option the data area
8606is limited to just below 2GB@.  Programs that require more than 2GB of
8607data must use @code{malloc} or @code{mmap} to allocate the data in the
8608heap instead of in the program's data segment.
8609
8610When generating code for shared libraries, @option{-fpic} implies
8611@option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8612
8613@item -msmall-text
8614@itemx -mlarge-text
8615@opindex msmall-text
8616@opindex mlarge-text
8617When @option{-msmall-text} is used, the compiler assumes that the
8618code of the entire program (or shared library) fits in 4MB, and is
8619thus reachable with a branch instruction.  When @option{-msmall-data}
8620is used, the compiler can assume that all local symbols share the
8621same @code{$gp} value, and thus reduce the number of instructions
8622required for a function call from 4 to 1.
8623
8624The default is @option{-mlarge-text}.
8625
8626@item -mcpu=@var{cpu_type}
8627@opindex mcpu
8628Set the instruction set and instruction scheduling parameters for
8629machine type @var{cpu_type}.  You can specify either the @samp{EV}
8630style name or the corresponding chip number.  GCC supports scheduling
8631parameters for the EV4, EV5 and EV6 family of processors and will
8632choose the default values for the instruction set from the processor
8633you specify.  If you do not specify a processor type, GCC will default
8634to the processor on which the compiler was built.
8635
8636Supported values for @var{cpu_type} are
8637
8638@table @samp
8639@item ev4
8640@itemx ev45
8641@itemx 21064
8642Schedules as an EV4 and has no instruction set extensions.
8643
8644@item ev5
8645@itemx 21164
8646Schedules as an EV5 and has no instruction set extensions.
8647
8648@item ev56
8649@itemx 21164a
8650Schedules as an EV5 and supports the BWX extension.
8651
8652@item pca56
8653@itemx 21164pc
8654@itemx 21164PC
8655Schedules as an EV5 and supports the BWX and MAX extensions.
8656
8657@item ev6
8658@itemx 21264
8659Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8660
8661@item ev67
8662@itemx 21264a
8663Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8664@end table
8665
8666@item -mtune=@var{cpu_type}
8667@opindex mtune
8668Set only the instruction scheduling parameters for machine type
8669@var{cpu_type}.  The instruction set is not changed.
8670
8671@item -mmemory-latency=@var{time}
8672@opindex mmemory-latency
8673Sets the latency the scheduler should assume for typical memory
8674references as seen by the application.  This number is highly
8675dependent on the memory access patterns used by the application
8676and the size of the external cache on the machine.
8677
8678Valid options for @var{time} are
8679
8680@table @samp
8681@item @var{number}
8682A decimal number representing clock cycles.
8683
8684@item L1
8685@itemx L2
8686@itemx L3
8687@itemx main
8688The compiler contains estimates of the number of clock cycles for
8689``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8690(also called Dcache, Scache, and Bcache), as well as to main memory.
8691Note that L3 is only valid for EV5.
8692
8693@end table
8694@end table
8695
8696@node DEC Alpha/VMS Options
8697@subsection DEC Alpha/VMS Options
8698
8699These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8700
8701@table @gcctabopt
8702@item -mvms-return-codes
8703@opindex mvms-return-codes
8704Return VMS condition codes from main.  The default is to return POSIX
8705style condition (e.g.@ error) codes.
8706@end table
8707
8708@node FRV Options
8709@subsection FRV Options
8710@cindex FRV Options
8711
8712@table @gcctabopt
8713@item -mgpr-32
8714@opindex mgpr-32
8715
8716Only use the first 32 general purpose registers.
8717
8718@item -mgpr-64
8719@opindex mgpr-64
8720
8721Use all 64 general purpose registers.
8722
8723@item -mfpr-32
8724@opindex mfpr-32
8725
8726Use only the first 32 floating point registers.
8727
8728@item -mfpr-64
8729@opindex mfpr-64
8730
8731Use all 64 floating point registers
8732
8733@item -mhard-float
8734@opindex mhard-float
8735
8736Use hardware instructions for floating point operations.
8737
8738@item -msoft-float
8739@opindex msoft-float
8740
8741Use library routines for floating point operations.
8742
8743@item -malloc-cc
8744@opindex malloc-cc
8745
8746Dynamically allocate condition code registers.
8747
8748@item -mfixed-cc
8749@opindex mfixed-cc
8750
8751Do not try to dynamically allocate condition code registers, only
8752use @code{icc0} and @code{fcc0}.
8753
8754@item -mdword
8755@opindex mdword
8756
8757Change ABI to use double word insns.
8758
8759@item -mno-dword
8760@opindex mno-dword
8761
8762Do not use double word instructions.
8763
8764@item -mdouble
8765@opindex mdouble
8766
8767Use floating point double instructions.
8768
8769@item -mno-double
8770@opindex mno-double
8771
8772Do not use floating point double instructions.
8773
8774@item -mmedia
8775@opindex mmedia
8776
8777Use media instructions.
8778
8779@item -mno-media
8780@opindex mno-media
8781
8782Do not use media instructions.
8783
8784@item -mmuladd
8785@opindex mmuladd
8786
8787Use multiply and add/subtract instructions.
8788
8789@item -mno-muladd
8790@opindex mno-muladd
8791
8792Do not use multiply and add/subtract instructions.
8793
8794@item -mfdpic
8795@opindex mfdpic
8796
8797Select the FDPIC ABI, that uses function descriptors to represent
8798pointers to functions.  Without any PIC/PIE-related options, it
8799implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8800assumes GOT entries and small data are within a 12-bit range from the
8801GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8802are computed with 32 bits.
8803
8804@item -minline-plt
8805@opindex minline-plt
8806
8807Enable inlining of PLT entries in function calls to functions that are
8808not known to bind locally.  It has no effect without @option{-mfdpic}.
8809It's enabled by default if optimizing for speed and compiling for
8810shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8811optimization option such as @option{-O3} or above is present in the
8812command line.
8813
8814@item -mTLS
8815@opindex TLS
8816
8817Assume a large TLS segment when generating thread-local code.
8818
8819@item -mtls
8820@opindex tls
8821
8822Do not assume a large TLS segment when generating thread-local code.
8823
8824@item -mgprel-ro
8825@opindex mgprel-ro
8826
8827Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8828that is known to be in read-only sections.  It's enabled by default,
8829except for @option{-fpic} or @option{-fpie}: even though it may help
8830make the global offset table smaller, it trades 1 instruction for 4.
8831With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8832one of which may be shared by multiple symbols, and it avoids the need
8833for a GOT entry for the referenced symbol, so it's more likely to be a
8834win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8835
8836@item -multilib-library-pic
8837@opindex multilib-library-pic
8838
8839Link with the (library, not FD) pic libraries.  It's implied by
8840@option{-mlibrary-pic}, as well as by @option{-fPIC} and
8841@option{-fpic} without @option{-mfdpic}.  You should never have to use
8842it explicitly.
8843
8844@item -mlinked-fp
8845@opindex mlinked-fp
8846
8847Follow the EABI requirement of always creating a frame pointer whenever
8848a stack frame is allocated.  This option is enabled by default and can
8849be disabled with @option{-mno-linked-fp}.
8850
8851@item -mlong-calls
8852@opindex mlong-calls
8853
8854Use indirect addressing to call functions outside the current
8855compilation unit.  This allows the functions to be placed anywhere
8856within the 32-bit address space.
8857
8858@item -malign-labels
8859@opindex malign-labels
8860
8861Try to align labels to an 8-byte boundary by inserting nops into the
8862previous packet.  This option only has an effect when VLIW packing
8863is enabled.  It doesn't create new packets; it merely adds nops to
8864existing ones.
8865
8866@item -mlibrary-pic
8867@opindex mlibrary-pic
8868
8869Generate position-independent EABI code.
8870
8871@item -macc-4
8872@opindex macc-4
8873
8874Use only the first four media accumulator registers.
8875
8876@item -macc-8
8877@opindex macc-8
8878
8879Use all eight media accumulator registers.
8880
8881@item -mpack
8882@opindex mpack
8883
8884Pack VLIW instructions.
8885
8886@item -mno-pack
8887@opindex mno-pack
8888
8889Do not pack VLIW instructions.
8890
8891@item -mno-eflags
8892@opindex mno-eflags
8893
8894Do not mark ABI switches in e_flags.
8895
8896@item -mcond-move
8897@opindex mcond-move
8898
8899Enable the use of conditional-move instructions (default).
8900
8901This switch is mainly for debugging the compiler and will likely be removed
8902in a future version.
8903
8904@item -mno-cond-move
8905@opindex mno-cond-move
8906
8907Disable the use of conditional-move instructions.
8908
8909This switch is mainly for debugging the compiler and will likely be removed
8910in a future version.
8911
8912@item -mscc
8913@opindex mscc
8914
8915Enable the use of conditional set instructions (default).
8916
8917This switch is mainly for debugging the compiler and will likely be removed
8918in a future version.
8919
8920@item -mno-scc
8921@opindex mno-scc
8922
8923Disable the use of conditional set instructions.
8924
8925This switch is mainly for debugging the compiler and will likely be removed
8926in a future version.
8927
8928@item -mcond-exec
8929@opindex mcond-exec
8930
8931Enable the use of conditional execution (default).
8932
8933This switch is mainly for debugging the compiler and will likely be removed
8934in a future version.
8935
8936@item -mno-cond-exec
8937@opindex mno-cond-exec
8938
8939Disable the use of conditional execution.
8940
8941This switch is mainly for debugging the compiler and will likely be removed
8942in a future version.
8943
8944@item -mvliw-branch
8945@opindex mvliw-branch
8946
8947Run a pass to pack branches into VLIW instructions (default).
8948
8949This switch is mainly for debugging the compiler and will likely be removed
8950in a future version.
8951
8952@item -mno-vliw-branch
8953@opindex mno-vliw-branch
8954
8955Do not run a pass to pack branches into VLIW instructions.
8956
8957This switch is mainly for debugging the compiler and will likely be removed
8958in a future version.
8959
8960@item -mmulti-cond-exec
8961@opindex mmulti-cond-exec
8962
8963Enable optimization of @code{&&} and @code{||} in conditional execution
8964(default).
8965
8966This switch is mainly for debugging the compiler and will likely be removed
8967in a future version.
8968
8969@item -mno-multi-cond-exec
8970@opindex mno-multi-cond-exec
8971
8972Disable optimization of @code{&&} and @code{||} in conditional execution.
8973
8974This switch is mainly for debugging the compiler and will likely be removed
8975in a future version.
8976
8977@item -mnested-cond-exec
8978@opindex mnested-cond-exec
8979
8980Enable nested conditional execution optimizations (default).
8981
8982This switch is mainly for debugging the compiler and will likely be removed
8983in a future version.
8984
8985@item -mno-nested-cond-exec
8986@opindex mno-nested-cond-exec
8987
8988Disable nested conditional execution optimizations.
8989
8990This switch is mainly for debugging the compiler and will likely be removed
8991in a future version.
8992
8993@item -moptimize-membar
8994@opindex moptimize-membar
8995
8996This switch removes redundant @code{membar} instructions from the
8997compiler generated code.  It is enabled by default.
8998
8999@item -mno-optimize-membar
9000@opindex mno-optimize-membar
9001
9002This switch disables the automatic removal of redundant @code{membar}
9003instructions from the generated code.
9004
9005@item -mtomcat-stats
9006@opindex mtomcat-stats
9007
9008Cause gas to print out tomcat statistics.
9009
9010@item -mcpu=@var{cpu}
9011@opindex mcpu
9012
9013Select the processor type for which to generate code.  Possible values are
9014@samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
9015@samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
9016
9017@end table
9018
9019@node GNU/Linux Options
9020@subsection GNU/Linux Options
9021
9022These @samp{-m} options are defined for GNU/Linux targets:
9023
9024@table @gcctabopt
9025@item -mglibc
9026@opindex mglibc
9027Use the GNU C library instead of uClibc.  This is the default except
9028on @samp{*-*-linux-*uclibc*} targets.
9029
9030@item -muclibc
9031@opindex muclibc
9032Use uClibc instead of the GNU C library.  This is the default on
9033@samp{*-*-linux-*uclibc*} targets.
9034@end table
9035
9036@node H8/300 Options
9037@subsection H8/300 Options
9038
9039These @samp{-m} options are defined for the H8/300 implementations:
9040
9041@table @gcctabopt
9042@item -mrelax
9043@opindex mrelax
9044Shorten some address references at link time, when possible; uses the
9045linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9046ld, Using ld}, for a fuller description.
9047
9048@item -mh
9049@opindex mh
9050Generate code for the H8/300H@.
9051
9052@item -ms
9053@opindex ms
9054Generate code for the H8S@.
9055
9056@item -mn
9057@opindex mn
9058Generate code for the H8S and H8/300H in the normal mode.  This switch
9059must be used either with @option{-mh} or @option{-ms}.
9060
9061@item -ms2600
9062@opindex ms2600
9063Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9064
9065@item -mint32
9066@opindex mint32
9067Make @code{int} data 32 bits by default.
9068
9069@item -malign-300
9070@opindex malign-300
9071On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9072The default for the H8/300H and H8S is to align longs and floats on 4
9073byte boundaries.
9074@option{-malign-300} causes them to be aligned on 2 byte boundaries.
9075This option has no effect on the H8/300.
9076@end table
9077
9078@node HPPA Options
9079@subsection HPPA Options
9080@cindex HPPA Options
9081
9082These @samp{-m} options are defined for the HPPA family of computers:
9083
9084@table @gcctabopt
9085@item -march=@var{architecture-type}
9086@opindex march
9087Generate code for the specified architecture.  The choices for
9088@var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
90891.1, and @samp{2.0} for PA 2.0 processors.  Refer to
9090@file{/usr/lib/sched.models} on an HP-UX system to determine the proper
9091architecture option for your machine.  Code compiled for lower numbered
9092architectures will run on higher numbered architectures, but not the
9093other way around.
9094
9095@item -mpa-risc-1-0
9096@itemx -mpa-risc-1-1
9097@itemx -mpa-risc-2-0
9098@opindex mpa-risc-1-0
9099@opindex mpa-risc-1-1
9100@opindex mpa-risc-2-0
9101Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
9102
9103@item -mbig-switch
9104@opindex mbig-switch
9105Generate code suitable for big switch tables.  Use this option only if
9106the assembler/linker complain about out of range branches within a switch
9107table.
9108
9109@item -mjump-in-delay
9110@opindex mjump-in-delay
9111Fill delay slots of function calls with unconditional jump instructions
9112by modifying the return pointer for the function call to be the target
9113of the conditional jump.
9114
9115@item -mdisable-fpregs
9116@opindex mdisable-fpregs
9117Prevent floating point registers from being used in any manner.  This is
9118necessary for compiling kernels which perform lazy context switching of
9119floating point registers.  If you use this option and attempt to perform
9120floating point operations, the compiler will abort.
9121
9122@item -mdisable-indexing
9123@opindex mdisable-indexing
9124Prevent the compiler from using indexing address modes.  This avoids some
9125rather obscure problems when compiling MIG generated code under MACH@.
9126
9127@item -mno-space-regs
9128@opindex mno-space-regs
9129Generate code that assumes the target has no space registers.  This allows
9130GCC to generate faster indirect calls and use unscaled index address modes.
9131
9132Such code is suitable for level 0 PA systems and kernels.
9133
9134@item -mfast-indirect-calls
9135@opindex mfast-indirect-calls
9136Generate code that assumes calls never cross space boundaries.  This
9137allows GCC to emit code which performs faster indirect calls.
9138
9139This option will not work in the presence of shared libraries or nested
9140functions.
9141
9142@item -mfixed-range=@var{register-range}
9143@opindex mfixed-range
9144Generate code treating the given register range as fixed registers.
9145A fixed register is one that the register allocator can not use.  This is
9146useful when compiling kernel code.  A register range is specified as
9147two registers separated by a dash.  Multiple register ranges can be
9148specified separated by a comma.
9149
9150@item -mlong-load-store
9151@opindex mlong-load-store
9152Generate 3-instruction load and store sequences as sometimes required by
9153the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
9154the HP compilers.
9155
9156@item -mportable-runtime
9157@opindex mportable-runtime
9158Use the portable calling conventions proposed by HP for ELF systems.
9159
9160@item -mgas
9161@opindex mgas
9162Enable the use of assembler directives only GAS understands.
9163
9164@item -mschedule=@var{cpu-type}
9165@opindex mschedule
9166Schedule code according to the constraints for the machine type
9167@var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
9168@samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
9169to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9170proper scheduling option for your machine.  The default scheduling is
9171@samp{8000}.
9172
9173@item -mlinker-opt
9174@opindex mlinker-opt
9175Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
9176debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
9177linkers in which they give bogus error messages when linking some programs.
9178
9179@item -msoft-float
9180@opindex msoft-float
9181Generate output containing library calls for floating point.
9182@strong{Warning:} the requisite libraries are not available for all HPPA
9183targets.  Normally the facilities of the machine's usual C compiler are
9184used, but this cannot be done directly in cross-compilation.  You must make
9185your own arrangements to provide suitable library functions for
9186cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
9187does provide software floating point support.
9188
9189@option{-msoft-float} changes the calling convention in the output file;
9190therefore, it is only useful if you compile @emph{all} of a program with
9191this option.  In particular, you need to compile @file{libgcc.a}, the
9192library that comes with GCC, with @option{-msoft-float} in order for
9193this to work.
9194
9195@item -msio
9196@opindex msio
9197Generate the predefine, @code{_SIO}, for server IO@.  The default is
9198@option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
9199@code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
9200options are available under HP-UX and HI-UX@.
9201
9202@item -mgnu-ld
9203@opindex gnu-ld
9204Use GNU ld specific options.  This passes @option{-shared} to ld when
9205building a shared library.  It is the default when GCC is configured,
9206explicitly or implicitly, with the GNU linker.  This option does not
9207have any affect on which ld is called, it only changes what parameters
9208are passed to that ld.  The ld that is called is determined by the
9209@option{--with-ld} configure option, GCC's program search path, and
9210finally by the user's @env{PATH}.  The linker used by GCC can be printed
9211using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
9212on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9213
9214@item -mhp-ld
9215@opindex hp-ld
9216Use HP ld specific options.  This passes @option{-b} to ld when building
9217a shared library and passes @option{+Accept TypeMismatch} to ld on all
9218links.  It is the default when GCC is configured, explicitly or
9219implicitly, with the HP linker.  This option does not have any affect on
9220which ld is called, it only changes what parameters are passed to that
9221ld.  The ld that is called is determined by the @option{--with-ld}
9222configure option, GCC's program search path, and finally by the user's
9223@env{PATH}.  The linker used by GCC can be printed using @samp{which
9224`gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9225HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9226
9227@item -mlong-calls
9228@opindex mno-long-calls
9229Generate code that uses long call sequences.  This ensures that a call
9230is always able to reach linker generated stubs.  The default is to generate
9231long calls only when the distance from the call site to the beginning
9232of the function or translation unit, as the case may be, exceeds a
9233predefined limit set by the branch type being used.  The limits for
9234normal calls are 7,600,000 and 240,000 bytes, respectively for the
9235PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9236240,000 bytes.
9237
9238Distances are measured from the beginning of functions when using the
9239@option{-ffunction-sections} option, or when using the @option{-mgas}
9240and @option{-mno-portable-runtime} options together under HP-UX with
9241the SOM linker.
9242
9243It is normally not desirable to use this option as it will degrade
9244performance.  However, it may be useful in large applications,
9245particularly when partial linking is used to build the application.
9246
9247The types of long calls used depends on the capabilities of the
9248assembler and linker, and the type of code being generated.  The
9249impact on systems that support long absolute calls, and long pic
9250symbol-difference or pc-relative calls should be relatively small.
9251However, an indirect call is used on 32-bit ELF systems in pic code
9252and it is quite long.
9253
9254@item -munix=@var{unix-std}
9255@opindex march
9256Generate compiler predefines and select a startfile for the specified
9257UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9258and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9259is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
926011.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9261@samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9262and later.
9263
9264@option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9265@option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9266and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9267@option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9268@code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9269@code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9270
9271It is @emph{important} to note that this option changes the interfaces
9272for various library routines.  It also affects the operational behavior
9273of the C library.  Thus, @emph{extreme} care is needed in using this
9274option.
9275
9276Library code that is intended to operate with more than one UNIX
9277standard must test, set and restore the variable @var{__xpg4_extended_mask}
9278as appropriate.  Most GNU software doesn't provide this capability.
9279
9280@item -nolibdld
9281@opindex nolibdld
9282Suppress the generation of link options to search libdld.sl when the
9283@option{-static} option is specified on HP-UX 10 and later.
9284
9285@item -static
9286@opindex static
9287The HP-UX implementation of setlocale in libc has a dependency on
9288libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9289when the @option{-static} option is specified, special link options
9290are needed to resolve this dependency.
9291
9292On HP-UX 10 and later, the GCC driver adds the necessary options to
9293link with libdld.sl when the @option{-static} option is specified.
9294This causes the resulting binary to be dynamic.  On the 64-bit port,
9295the linkers generate dynamic binaries by default in any case.  The
9296@option{-nolibdld} option can be used to prevent the GCC driver from
9297adding these link options.
9298
9299@item -threads
9300@opindex threads
9301Add support for multithreading with the @dfn{dce thread} library
9302under HP-UX@.  This option sets flags for both the preprocessor and
9303linker.
9304@end table
9305
9306@node i386 and x86-64 Options
9307@subsection Intel 386 and AMD x86-64 Options
9308@cindex i386 Options
9309@cindex x86-64 Options
9310@cindex Intel 386 Options
9311@cindex AMD x86-64 Options
9312
9313These @samp{-m} options are defined for the i386 and x86-64 family of
9314computers:
9315
9316@table @gcctabopt
9317@item -mtune=@var{cpu-type}
9318@opindex mtune
9319Tune to @var{cpu-type} everything applicable about the generated code, except
9320for the ABI and the set of available instructions.  The choices for
9321@var{cpu-type} are:
9322@table @emph
9323@item generic
9324Produce code optimized for the most common IA32/AMD64/EM64T processors.
9325If you know the CPU on which your code will run, then you should use
9326the corresponding @option{-mtune} option instead of
9327@option{-mtune=generic}.  But, if you do not know exactly what CPU users
9328of your application will have, then you should use this option.
9329
9330As new processors are deployed in the marketplace, the behavior of this
9331option will change.  Therefore, if you upgrade to a newer version of
9332GCC, the code generated option will change to reflect the processors
9333that were most common when that version of GCC was released.
9334
9335There is no @option{-march=generic} option because @option{-march}
9336indicates the instruction set the compiler can use, and there is no
9337generic instruction set applicable to all processors.  In contrast,
9338@option{-mtune} indicates the processor (or, in this case, collection of
9339processors) for which the code is optimized.
9340@item native
9341This selects the CPU to tune for at compilation time by determining
9342the processor type of the compiling machine.  Using @option{-mtune=native}
9343will produce code optimized for the local machine under the constraints
9344of the selected instruction set.  Using @option{-march=native} will
9345enable all instruction subsets supported by the local machine (hence
9346the result might not run on different machines).
9347@item i386
9348Original Intel's i386 CPU@.
9349@item i486
9350Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9351@item i586, pentium
9352Intel Pentium CPU with no MMX support.
9353@item pentium-mmx
9354Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9355@item pentiumpro
9356Intel PentiumPro CPU@.
9357@item i686
9358Same as @code{generic}, but when used as @code{march} option, PentiumPro
9359instruction set will be used, so the code will run on all i686 family chips.
9360@item pentium2
9361Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9362@item pentium3, pentium3m
9363Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9364support.
9365@item pentium-m
9366Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9367support.  Used by Centrino notebooks.
9368@item pentium4, pentium4m
9369Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9370@item prescott
9371Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9372set support.
9373@item nocona
9374Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9375SSE2 and SSE3 instruction set support.
9376@item k6
9377AMD K6 CPU with MMX instruction set support.
9378@item k6-2, k6-3
9379Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9380@item athlon, athlon-tbird
9381AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9382support.
9383@item athlon-4, athlon-xp, athlon-mp
9384Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9385instruction set support.
9386@item k8, opteron, athlon64, athlon-fx
9387AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9388MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9389@item winchip-c6
9390IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9391set support.
9392@item winchip2
9393IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9394instruction set support.
9395@item c3
9396Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9397implemented for this chip.)
9398@item c3-2
9399Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9400implemented for this chip.)
9401@end table
9402
9403While picking a specific @var{cpu-type} will schedule things appropriately
9404for that particular chip, the compiler will not generate any code that
9405does not run on the i386 without the @option{-march=@var{cpu-type}} option
9406being used.
9407
9408@item -march=@var{cpu-type}
9409@opindex march
9410Generate instructions for the machine type @var{cpu-type}.  The choices
9411for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9412specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9413
9414@item -mcpu=@var{cpu-type}
9415@opindex mcpu
9416A deprecated synonym for @option{-mtune}.
9417
9418@item -m386
9419@itemx -m486
9420@itemx -mpentium
9421@itemx -mpentiumpro
9422@opindex m386
9423@opindex m486
9424@opindex mpentium
9425@opindex mpentiumpro
9426These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9427@option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9428These synonyms are deprecated.
9429
9430@item -mfpmath=@var{unit}
9431@opindex march
9432Generate floating point arithmetics for selected unit @var{unit}.  The choices
9433for @var{unit} are:
9434
9435@table @samp
9436@item 387
9437Use the standard 387 floating point coprocessor present majority of chips and
9438emulated otherwise.  Code compiled with this option will run almost everywhere.
9439The temporary results are computed in 80bit precision instead of precision
9440specified by the type resulting in slightly different results compared to most
9441of other chips.  See @option{-ffloat-store} for more detailed description.
9442
9443This is the default choice for i386 compiler.
9444
9445@item sse
9446Use scalar floating point instructions present in the SSE instruction set.
9447This instruction set is supported by Pentium3 and newer chips, in the AMD line
9448by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9449instruction set supports only single precision arithmetics, thus the double and
9450extended precision arithmetics is still done using 387.  Later version, present
9451only in Pentium4 and the future AMD x86-64 chips supports double precision
9452arithmetics too.
9453
9454For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9455or @option{-msse2} switches to enable SSE extensions and make this option
9456effective.  For the x86-64 compiler, these extensions are enabled by default.
9457
9458The resulting code should be considerably faster in the majority of cases and avoid
9459the numerical instability problems of 387 code, but may break some existing
9460code that expects temporaries to be 80bit.
9461
9462This is the default choice for the x86-64 compiler.
9463
9464@item sse,387
9465Attempt to utilize both instruction sets at once.  This effectively double the
9466amount of available registers and on chips with separate execution units for
9467387 and SSE the execution resources too.  Use this option with care, as it is
9468still experimental, because the GCC register allocator does not model separate
9469functional units well resulting in instable performance.
9470@end table
9471
9472@item -masm=@var{dialect}
9473@opindex masm=@var{dialect}
9474Output asm instructions using selected @var{dialect}.  Supported
9475choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9476not support @samp{intel}.
9477
9478@item -mieee-fp
9479@itemx -mno-ieee-fp
9480@opindex mieee-fp
9481@opindex mno-ieee-fp
9482Control whether or not the compiler uses IEEE floating point
9483comparisons.  These handle correctly the case where the result of a
9484comparison is unordered.
9485
9486@item -msoft-float
9487@opindex msoft-float
9488Generate output containing library calls for floating point.
9489@strong{Warning:} the requisite libraries are not part of GCC@.
9490Normally the facilities of the machine's usual C compiler are used, but
9491this can't be done directly in cross-compilation.  You must make your
9492own arrangements to provide suitable library functions for
9493cross-compilation.
9494
9495On machines where a function returns floating point results in the 80387
9496register stack, some floating point opcodes may be emitted even if
9497@option{-msoft-float} is used.
9498
9499@item -mno-fp-ret-in-387
9500@opindex mno-fp-ret-in-387
9501Do not use the FPU registers for return values of functions.
9502
9503The usual calling convention has functions return values of types
9504@code{float} and @code{double} in an FPU register, even if there
9505is no FPU@.  The idea is that the operating system should emulate
9506an FPU@.
9507
9508The option @option{-mno-fp-ret-in-387} causes such values to be returned
9509in ordinary CPU registers instead.
9510
9511@item -mno-fancy-math-387
9512@opindex mno-fancy-math-387
9513Some 387 emulators do not support the @code{sin}, @code{cos} and
9514@code{sqrt} instructions for the 387.  Specify this option to avoid
9515generating those instructions.  This option is the default on FreeBSD,
9516OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9517indicates that the target cpu will always have an FPU and so the
9518instruction will not need emulation.  As of revision 2.6.1, these
9519instructions are not generated unless you also use the
9520@option{-funsafe-math-optimizations} switch.
9521
9522@item -malign-double
9523@itemx -mno-align-double
9524@opindex malign-double
9525@opindex mno-align-double
9526Control whether GCC aligns @code{double}, @code{long double}, and
9527@code{long long} variables on a two word boundary or a one word
9528boundary.  Aligning @code{double} variables on a two word boundary will
9529produce code that runs somewhat faster on a @samp{Pentium} at the
9530expense of more memory.
9531
9532On x86-64, @option{-malign-double} is enabled by default.
9533
9534@strong{Warning:} if you use the @option{-malign-double} switch,
9535structures containing the above types will be aligned differently than
9536the published application binary interface specifications for the 386
9537and will not be binary compatible with structures in code compiled
9538without that switch.
9539
9540@item -m96bit-long-double
9541@itemx -m128bit-long-double
9542@opindex m96bit-long-double
9543@opindex m128bit-long-double
9544These switches control the size of @code{long double} type.  The i386
9545application binary interface specifies the size to be 96 bits,
9546so @option{-m96bit-long-double} is the default in 32 bit mode.
9547
9548Modern architectures (Pentium and newer) would prefer @code{long double}
9549to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9550conforming to the ABI, this would not be possible.  So specifying a
9551@option{-m128bit-long-double} will align @code{long double}
9552to a 16 byte boundary by padding the @code{long double} with an additional
955332 bit zero.
9554
9555In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9556its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9557
9558Notice that neither of these options enable any extra precision over the x87
9559standard of 80 bits for a @code{long double}.
9560
9561@strong{Warning:} if you override the default value for your target ABI, the
9562structures and arrays containing @code{long double} variables will change
9563their size as well as function calling convention for function taking
9564@code{long double} will be modified.  Hence they will not be binary
9565compatible with arrays or structures in code compiled without that switch.
9566
9567@item -mmlarge-data-threshold=@var{number}
9568@opindex mlarge-data-threshold=@var{number}
9569When @option{-mcmodel=medium} is specified, the data greater than
9570@var{threshold} are placed in large data section.  This value must be the
9571same across all object linked into the binary and defaults to 65535.
9572
9573@item -msvr3-shlib
9574@itemx -mno-svr3-shlib
9575@opindex msvr3-shlib
9576@opindex mno-svr3-shlib
9577Control whether GCC places uninitialized local variables into the
9578@code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9579into @code{bss}.  These options are meaningful only on System V Release 3.
9580
9581@item -mrtd
9582@opindex mrtd
9583Use a different function-calling convention, in which functions that
9584take a fixed number of arguments return with the @code{ret} @var{num}
9585instruction, which pops their arguments while returning.  This saves one
9586instruction in the caller since there is no need to pop the arguments
9587there.
9588
9589You can specify that an individual function is called with this calling
9590sequence with the function attribute @samp{stdcall}.  You can also
9591override the @option{-mrtd} option by using the function attribute
9592@samp{cdecl}.  @xref{Function Attributes}.
9593
9594@strong{Warning:} this calling convention is incompatible with the one
9595normally used on Unix, so you cannot use it if you need to call
9596libraries compiled with the Unix compiler.
9597
9598Also, you must provide function prototypes for all functions that
9599take variable numbers of arguments (including @code{printf});
9600otherwise incorrect code will be generated for calls to those
9601functions.
9602
9603In addition, seriously incorrect code will result if you call a
9604function with too many arguments.  (Normally, extra arguments are
9605harmlessly ignored.)
9606
9607@item -mregparm=@var{num}
9608@opindex mregparm
9609Control how many registers are used to pass integer arguments.  By
9610default, no registers are used to pass arguments, and at most 3
9611registers can be used.  You can control this behavior for a specific
9612function by using the function attribute @samp{regparm}.
9613@xref{Function Attributes}.
9614
9615@strong{Warning:} if you use this switch, and
9616@var{num} is nonzero, then you must build all modules with the same
9617value, including any libraries.  This includes the system libraries and
9618startup modules.
9619
9620@item -msseregparm
9621@opindex msseregparm
9622Use SSE register passing conventions for float and double arguments
9623and return values.  You can control this behavior for a specific
9624function by using the function attribute @samp{sseregparm}.
9625@xref{Function Attributes}.
9626
9627@strong{Warning:} if you use this switch then you must build all
9628modules with the same value, including any libraries.  This includes
9629the system libraries and startup modules.
9630
9631@item -mstackrealign
9632@opindex mstackrealign
9633Realign the stack at entry.  On the Intel x86, the
9634@option{-mstackrealign} option will generate an alternate prologue and
9635epilogue that realigns the runtime stack.  This supports mixing legacy
9636codes that keep a 4-byte aligned stack with modern codes that keep a
963716-byte stack for SSE compatibility.  The alternate prologue and
9638epilogue are slower and bigger than the regular ones, and the
9639alternate prologue requires an extra scratch register; this lowers the
9640number of registers available if used in conjunction with the
9641@code{regparm} attribute.  The @option{-mstackrealign} option is
9642incompatible with the nested function prologue; this is considered a
9643hard error.  See also the attribute @code{force_align_arg_pointer},
9644applicable to individual functions.
9645
9646@item -mpreferred-stack-boundary=@var{num}
9647@opindex mpreferred-stack-boundary
9648Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9649byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9650the default is 4 (16 bytes or 128 bits).
9651
9652On Pentium and PentiumPro, @code{double} and @code{long double} values
9653should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9654suffer significant run time performance penalties.  On Pentium III, the
9655Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9656properly if it is not 16 byte aligned.
9657
9658To ensure proper alignment of this values on the stack, the stack boundary
9659must be as aligned as that required by any value stored on the stack.
9660Further, every function must be generated such that it keeps the stack
9661aligned.  Thus calling a function compiled with a higher preferred
9662stack boundary from a function compiled with a lower preferred stack
9663boundary will most likely misalign the stack.  It is recommended that
9664libraries that use callbacks always use the default setting.
9665
9666This extra alignment does consume extra stack space, and generally
9667increases code size.  Code that is sensitive to stack space usage, such
9668as embedded systems and operating system kernels, may want to reduce the
9669preferred alignment to @option{-mpreferred-stack-boundary=2}.
9670
9671@item -mmmx
9672@itemx -mno-mmx
9673@item -msse
9674@itemx -mno-sse
9675@item -msse2
9676@itemx -mno-sse2
9677@item -msse3
9678@itemx -mno-sse3
9679@item -m3dnow
9680@itemx -mno-3dnow
9681@opindex mmmx
9682@opindex mno-mmx
9683@opindex msse
9684@opindex mno-sse
9685@opindex m3dnow
9686@opindex mno-3dnow
9687These switches enable or disable the use of instructions in the MMX,
9688SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9689also available as built-in functions: see @ref{X86 Built-in Functions},
9690for details of the functions enabled and disabled by these switches.
9691
9692To have SSE/SSE2 instructions generated automatically from floating-point
9693code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9694
9695These options will enable GCC to use these extended instructions in
9696generated code, even without @option{-mfpmath=sse}.  Applications which
9697perform runtime CPU detection must compile separate files for each
9698supported architecture, using the appropriate flags.  In particular,
9699the file containing the CPU detection code should be compiled without
9700these options.
9701
9702@item -mpush-args
9703@itemx -mno-push-args
9704@opindex mpush-args
9705@opindex mno-push-args
9706Use PUSH operations to store outgoing parameters.  This method is shorter
9707and usually equally fast as method using SUB/MOV operations and is enabled
9708by default.  In some cases disabling it may improve performance because of
9709improved scheduling and reduced dependencies.
9710
9711@item -maccumulate-outgoing-args
9712@opindex maccumulate-outgoing-args
9713If enabled, the maximum amount of space required for outgoing arguments will be
9714computed in the function prologue.  This is faster on most modern CPUs
9715because of reduced dependencies, improved scheduling and reduced stack usage
9716when preferred stack boundary is not equal to 2.  The drawback is a notable
9717increase in code size.  This switch implies @option{-mno-push-args}.
9718
9719@item -mthreads
9720@opindex mthreads
9721Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9722on thread-safe exception handling must compile and link all code with the
9723@option{-mthreads} option.  When compiling, @option{-mthreads} defines
9724@option{-D_MT}; when linking, it links in a special thread helper library
9725@option{-lmingwthrd} which cleans up per thread exception handling data.
9726
9727@item -mno-align-stringops
9728@opindex mno-align-stringops
9729Do not align destination of inlined string operations.  This switch reduces
9730code size and improves performance in case the destination is already aligned,
9731but GCC doesn't know about it.
9732
9733@item -minline-all-stringops
9734@opindex minline-all-stringops
9735By default GCC inlines string operations only when destination is known to be
9736aligned at least to 4 byte boundary.  This enables more inlining, increase code
9737size, but may improve performance of code that depends on fast memcpy, strlen
9738and memset for short lengths.
9739
9740@item -momit-leaf-frame-pointer
9741@opindex momit-leaf-frame-pointer
9742Don't keep the frame pointer in a register for leaf functions.  This
9743avoids the instructions to save, set up and restore frame pointers and
9744makes an extra register available in leaf functions.  The option
9745@option{-fomit-frame-pointer} removes the frame pointer for all functions
9746which might make debugging harder.
9747
9748@item -mtls-direct-seg-refs
9749@itemx -mno-tls-direct-seg-refs
9750@opindex mtls-direct-seg-refs
9751Controls whether TLS variables may be accessed with offsets from the
9752TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9753or whether the thread base pointer must be added.  Whether or not this
9754is legal depends on the operating system, and whether it maps the
9755segment to cover the entire TLS area.
9756
9757For systems that use GNU libc, the default is on.
9758@end table
9759
9760These @samp{-m} switches are supported in addition to the above
9761on AMD x86-64 processors in 64-bit environments.
9762
9763@table @gcctabopt
9764@item -m32
9765@itemx -m64
9766@opindex m32
9767@opindex m64
9768Generate code for a 32-bit or 64-bit environment.
9769The 32-bit environment sets int, long and pointer to 32 bits and
9770generates code that runs on any i386 system.
9771The 64-bit environment sets int to 32 bits and long and pointer
9772to 64 bits and generates code for AMD's x86-64 architecture. For
9773darwin only the -m64 option turns off the @option{-fno-pic} and
9774@option{-mdynamic-no-pic} options.
9775
9776@item -mno-red-zone
9777@opindex no-red-zone
9778Do not use a so called red zone for x86-64 code.  The red zone is mandated
9779by the x86-64 ABI, it is a 128-byte area beyond the location of the
9780stack pointer that will not be modified by signal or interrupt handlers
9781and therefore can be used for temporary data without adjusting the stack
9782pointer.  The flag @option{-mno-red-zone} disables this red zone.
9783
9784@item -mcmodel=small
9785@opindex mcmodel=small
9786Generate code for the small code model: the program and its symbols must
9787be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9788Programs can be statically or dynamically linked.  This is the default
9789code model.
9790
9791@item -mcmodel=kernel
9792@opindex mcmodel=kernel
9793Generate code for the kernel code model.  The kernel runs in the
9794negative 2 GB of the address space.
9795This model has to be used for Linux kernel code.
9796
9797@item -mcmodel=medium
9798@opindex mcmodel=medium
9799Generate code for the medium model: The program is linked in the lower 2
9800GB of the address space but symbols can be located anywhere in the
9801address space.  Programs can be statically or dynamically linked, but
9802building of shared libraries are not supported with the medium model.
9803
9804@item -mcmodel=large
9805@opindex mcmodel=large
9806Generate code for the large model: This model makes no assumptions
9807about addresses and sizes of sections.  Currently GCC does not implement
9808this model.
9809@end table
9810
9811@node IA-64 Options
9812@subsection IA-64 Options
9813@cindex IA-64 Options
9814
9815These are the @samp{-m} options defined for the Intel IA-64 architecture.
9816
9817@table @gcctabopt
9818@item -mbig-endian
9819@opindex mbig-endian
9820Generate code for a big endian target.  This is the default for HP-UX@.
9821
9822@item -mlittle-endian
9823@opindex mlittle-endian
9824Generate code for a little endian target.  This is the default for AIX5
9825and GNU/Linux.
9826
9827@item -mgnu-as
9828@itemx -mno-gnu-as
9829@opindex mgnu-as
9830@opindex mno-gnu-as
9831Generate (or don't) code for the GNU assembler.  This is the default.
9832@c Also, this is the default if the configure option @option{--with-gnu-as}
9833@c is used.
9834
9835@item -mgnu-ld
9836@itemx -mno-gnu-ld
9837@opindex mgnu-ld
9838@opindex mno-gnu-ld
9839Generate (or don't) code for the GNU linker.  This is the default.
9840@c Also, this is the default if the configure option @option{--with-gnu-ld}
9841@c is used.
9842
9843@item -mno-pic
9844@opindex mno-pic
9845Generate code that does not use a global pointer register.  The result
9846is not position independent code, and violates the IA-64 ABI@.
9847
9848@item -mvolatile-asm-stop
9849@itemx -mno-volatile-asm-stop
9850@opindex mvolatile-asm-stop
9851@opindex mno-volatile-asm-stop
9852Generate (or don't) a stop bit immediately before and after volatile asm
9853statements.
9854
9855@item -mregister-names
9856@itemx -mno-register-names
9857@opindex mregister-names
9858@opindex mno-register-names
9859Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9860the stacked registers.  This may make assembler output more readable.
9861
9862@item -mno-sdata
9863@itemx -msdata
9864@opindex mno-sdata
9865@opindex msdata
9866Disable (or enable) optimizations that use the small data section.  This may
9867be useful for working around optimizer bugs.
9868
9869@item -mconstant-gp
9870@opindex mconstant-gp
9871Generate code that uses a single constant global pointer value.  This is
9872useful when compiling kernel code.
9873
9874@item -mauto-pic
9875@opindex mauto-pic
9876Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9877This is useful when compiling firmware code.
9878
9879@item -minline-float-divide-min-latency
9880@opindex minline-float-divide-min-latency
9881Generate code for inline divides of floating point values
9882using the minimum latency algorithm.
9883
9884@item -minline-float-divide-max-throughput
9885@opindex minline-float-divide-max-throughput
9886Generate code for inline divides of floating point values
9887using the maximum throughput algorithm.
9888
9889@item -minline-int-divide-min-latency
9890@opindex minline-int-divide-min-latency
9891Generate code for inline divides of integer values
9892using the minimum latency algorithm.
9893
9894@item -minline-int-divide-max-throughput
9895@opindex minline-int-divide-max-throughput
9896Generate code for inline divides of integer values
9897using the maximum throughput algorithm.
9898
9899@item -minline-sqrt-min-latency
9900@opindex minline-sqrt-min-latency
9901Generate code for inline square roots
9902using the minimum latency algorithm.
9903
9904@item -minline-sqrt-max-throughput
9905@opindex minline-sqrt-max-throughput
9906Generate code for inline square roots
9907using the maximum throughput algorithm.
9908
9909@item -mno-dwarf2-asm
9910@itemx -mdwarf2-asm
9911@opindex mno-dwarf2-asm
9912@opindex mdwarf2-asm
9913Don't (or do) generate assembler code for the DWARF2 line number debugging
9914info.  This may be useful when not using the GNU assembler.
9915
9916@item -mearly-stop-bits
9917@itemx -mno-early-stop-bits
9918@opindex mearly-stop-bits
9919@opindex mno-early-stop-bits
9920Allow stop bits to be placed earlier than immediately preceding the
9921instruction that triggered the stop bit.  This can improve instruction
9922scheduling, but does not always do so.
9923
9924@item -mfixed-range=@var{register-range}
9925@opindex mfixed-range
9926Generate code treating the given register range as fixed registers.
9927A fixed register is one that the register allocator can not use.  This is
9928useful when compiling kernel code.  A register range is specified as
9929two registers separated by a dash.  Multiple register ranges can be
9930specified separated by a comma.
9931
9932@item -mtls-size=@var{tls-size}
9933@opindex mtls-size
9934Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
993564.
9936
9937@item -mtune=@var{cpu-type}
9938@opindex mtune
9939Tune the instruction scheduling for a particular CPU, Valid values are
9940itanium, itanium1, merced, itanium2, and mckinley.
9941
9942@item -mt
9943@itemx -pthread
9944@opindex mt
9945@opindex pthread
9946Add support for multithreading using the POSIX threads library.  This
9947option sets flags for both the preprocessor and linker.  It does
9948not affect the thread safety of object code produced by the compiler or
9949that of libraries supplied with it.  These are HP-UX specific flags.
9950
9951@item -milp32
9952@itemx -mlp64
9953@opindex milp32
9954@opindex mlp64
9955Generate code for a 32-bit or 64-bit environment.
9956The 32-bit environment sets int, long and pointer to 32 bits.
9957The 64-bit environment sets int to 32 bits and long and pointer
9958to 64 bits.  These are HP-UX specific flags.
9959
9960@item -mno-sched-br-data-spec
9961@itemx -msched-br-data-spec
9962@opindex mno-sched-br-data-spec
9963@opindex msched-br-data-spec
9964(Dis/En)able data speculative scheduling before reload.
9965This will result in generation of the ld.a instructions and
9966the corresponding check instructions (ld.c / chk.a).
9967The default is 'disable'.
9968
9969@item -msched-ar-data-spec
9970@itemx -mno-sched-ar-data-spec
9971@opindex msched-ar-data-spec
9972@opindex mno-sched-ar-data-spec
9973(En/Dis)able data speculative scheduling after reload.
9974This will result in generation of the ld.a instructions and
9975the corresponding check instructions (ld.c / chk.a).
9976The default is 'enable'.
9977
9978@item -mno-sched-control-spec
9979@itemx -msched-control-spec
9980@opindex mno-sched-control-spec
9981@opindex msched-control-spec
9982(Dis/En)able control speculative scheduling.  This feature is
9983available only during region scheduling (i.e. before reload).
9984This will result in generation of the ld.s instructions and
9985the corresponding check instructions chk.s .
9986The default is 'disable'.
9987
9988@item -msched-br-in-data-spec
9989@itemx -mno-sched-br-in-data-spec
9990@opindex msched-br-in-data-spec
9991@opindex mno-sched-br-in-data-spec
9992(En/Dis)able speculative scheduling of the instructions that
9993are dependent on the data speculative loads before reload.
9994This is effective only with @option{-msched-br-data-spec} enabled.
9995The default is 'enable'.
9996
9997@item -msched-ar-in-data-spec
9998@itemx -mno-sched-ar-in-data-spec
9999@opindex msched-ar-in-data-spec
10000@opindex mno-sched-ar-in-data-spec
10001(En/Dis)able speculative scheduling of the instructions that
10002are dependent on the data speculative loads after reload.
10003This is effective only with @option{-msched-ar-data-spec} enabled.
10004The default is 'enable'.
10005
10006@item -msched-in-control-spec
10007@itemx -mno-sched-in-control-spec
10008@opindex msched-in-control-spec
10009@opindex mno-sched-in-control-spec
10010(En/Dis)able speculative scheduling of the instructions that
10011are dependent on the control speculative loads.
10012This is effective only with @option{-msched-control-spec} enabled.
10013The default is 'enable'.
10014
10015@item -msched-ldc
10016@itemx -mno-sched-ldc
10017@opindex msched-ldc
10018@opindex mno-sched-ldc
10019(En/Dis)able use of simple data speculation checks ld.c .
10020If disabled, only chk.a instructions will be emitted to check
10021data speculative loads.
10022The default is 'enable'.
10023
10024@item -mno-sched-control-ldc
10025@itemx -msched-control-ldc
10026@opindex mno-sched-control-ldc
10027@opindex msched-control-ldc
10028(Dis/En)able use of ld.c instructions to check control speculative loads.
10029If enabled, in case of control speculative load with no speculatively
10030scheduled dependent instructions this load will be emitted as ld.sa and
10031ld.c will be used to check it.
10032The default is 'disable'.
10033
10034@item -mno-sched-spec-verbose
10035@itemx -msched-spec-verbose
10036@opindex mno-sched-spec-verbose
10037@opindex msched-spec-verbose
10038(Dis/En)able printing of the information about speculative motions.
10039
10040@item -mno-sched-prefer-non-data-spec-insns
10041@itemx -msched-prefer-non-data-spec-insns
10042@opindex mno-sched-prefer-non-data-spec-insns
10043@opindex msched-prefer-non-data-spec-insns
10044If enabled, data speculative instructions will be chosen for schedule
10045only if there are no other choices at the moment.  This will make
10046the use of the data speculation much more conservative.
10047The default is 'disable'.
10048
10049@item -mno-sched-prefer-non-control-spec-insns
10050@itemx -msched-prefer-non-control-spec-insns
10051@opindex mno-sched-prefer-non-control-spec-insns
10052@opindex msched-prefer-non-control-spec-insns
10053If enabled, control speculative instructions will be chosen for schedule
10054only if there are no other choices at the moment.  This will make
10055the use of the control speculation much more conservative.
10056The default is 'disable'.
10057
10058@item -mno-sched-count-spec-in-critical-path
10059@itemx -msched-count-spec-in-critical-path
10060@opindex mno-sched-count-spec-in-critical-path
10061@opindex msched-count-spec-in-critical-path
10062If enabled, speculative dependencies will be considered during
10063computation of the instructions priorities.  This will make the use of the
10064speculation a bit more conservative.
10065The default is 'disable'.
10066
10067@end table
10068
10069@node M32C Options
10070@subsection M32C Options
10071@cindex M32C options
10072
10073@table @gcctabopt
10074@item -mcpu=@var{name}
10075@opindex mcpu=
10076Select the CPU for which code is generated.  @var{name} may be one of
10077@samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
10078/60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
10079the M32C/80 series.
10080
10081@item -msim
10082@opindex msim
10083Specifies that the program will be run on the simulator.  This causes
10084an alternate runtime library to be linked in which supports, for
10085example, file I/O.  You must not use this option when generating
10086programs that will run on real hardware; you must provide your own
10087runtime library for whatever I/O functions are needed.
10088
10089@item -memregs=@var{number}
10090@opindex memregs=
10091Specifies the number of memory-based pseudo-registers GCC will use
10092during code generation.  These pseudo-registers will be used like real
10093registers, so there is a tradeoff between GCC's ability to fit the
10094code into available registers, and the performance penalty of using
10095memory instead of registers.  Note that all modules in a program must
10096be compiled with the same value for this option.  Because of that, you
10097must not use this option with the default runtime libraries gcc
10098builds.
10099
10100@end table
10101
10102@node M32R/D Options
10103@subsection M32R/D Options
10104@cindex M32R/D options
10105
10106These @option{-m} options are defined for Renesas M32R/D architectures:
10107
10108@table @gcctabopt
10109@item -m32r2
10110@opindex m32r2
10111Generate code for the M32R/2@.
10112
10113@item -m32rx
10114@opindex m32rx
10115Generate code for the M32R/X@.
10116
10117@item -m32r
10118@opindex m32r
10119Generate code for the M32R@.  This is the default.
10120
10121@item -mmodel=small
10122@opindex mmodel=small
10123Assume all objects live in the lower 16MB of memory (so that their addresses
10124can be loaded with the @code{ld24} instruction), and assume all subroutines
10125are reachable with the @code{bl} instruction.
10126This is the default.
10127
10128The addressability of a particular object can be set with the
10129@code{model} attribute.
10130
10131@item -mmodel=medium
10132@opindex mmodel=medium
10133Assume objects may be anywhere in the 32-bit address space (the compiler
10134will generate @code{seth/add3} instructions to load their addresses), and
10135assume all subroutines are reachable with the @code{bl} instruction.
10136
10137@item -mmodel=large
10138@opindex mmodel=large
10139Assume objects may be anywhere in the 32-bit address space (the compiler
10140will generate @code{seth/add3} instructions to load their addresses), and
10141assume subroutines may not be reachable with the @code{bl} instruction
10142(the compiler will generate the much slower @code{seth/add3/jl}
10143instruction sequence).
10144
10145@item -msdata=none
10146@opindex msdata=none
10147Disable use of the small data area.  Variables will be put into
10148one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10149@code{section} attribute has been specified).
10150This is the default.
10151
10152The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10153Objects may be explicitly put in the small data area with the
10154@code{section} attribute using one of these sections.
10155
10156@item -msdata=sdata
10157@opindex msdata=sdata
10158Put small global and static data in the small data area, but do not
10159generate special code to reference them.
10160
10161@item -msdata=use
10162@opindex msdata=use
10163Put small global and static data in the small data area, and generate
10164special instructions to reference them.
10165
10166@item -G @var{num}
10167@opindex G
10168@cindex smaller data references
10169Put global and static objects less than or equal to @var{num} bytes
10170into the small data or bss sections instead of the normal data or bss
10171sections.  The default value of @var{num} is 8.
10172The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
10173for this option to have any effect.
10174
10175All modules should be compiled with the same @option{-G @var{num}} value.
10176Compiling with different values of @var{num} may or may not work; if it
10177doesn't the linker will give an error message---incorrect code will not be
10178generated.
10179
10180@item -mdebug
10181@opindex mdebug
10182Makes the M32R specific code in the compiler display some statistics
10183that might help in debugging programs.
10184
10185@item -malign-loops
10186@opindex malign-loops
10187Align all loops to a 32-byte boundary.
10188
10189@item -mno-align-loops
10190@opindex mno-align-loops
10191Do not enforce a 32-byte alignment for loops.  This is the default.
10192
10193@item -missue-rate=@var{number}
10194@opindex missue-rate=@var{number}
10195Issue @var{number} instructions per cycle.  @var{number} can only be 1
10196or 2.
10197
10198@item -mbranch-cost=@var{number}
10199@opindex mbranch-cost=@var{number}
10200@var{number} can only be 1 or 2.  If it is 1 then branches will be
10201preferred over conditional code, if it is 2, then the opposite will
10202apply.
10203
10204@item -mflush-trap=@var{number}
10205@opindex mflush-trap=@var{number}
10206Specifies the trap number to use to flush the cache.  The default is
1020712.  Valid numbers are between 0 and 15 inclusive.
10208
10209@item -mno-flush-trap
10210@opindex mno-flush-trap
10211Specifies that the cache cannot be flushed by using a trap.
10212
10213@item -mflush-func=@var{name}
10214@opindex mflush-func=@var{name}
10215Specifies the name of the operating system function to call to flush
10216the cache.  The default is @emph{_flush_cache}, but a function call
10217will only be used if a trap is not available.
10218
10219@item -mno-flush-func
10220@opindex mno-flush-func
10221Indicates that there is no OS function for flushing the cache.
10222
10223@end table
10224
10225@node M680x0 Options
10226@subsection M680x0 Options
10227@cindex M680x0 options
10228
10229These are the @samp{-m} options defined for the 68000 series.  The default
10230values for these options depends on which style of 68000 was selected when
10231the compiler was configured; the defaults for the most common choices are
10232given below.
10233
10234@table @gcctabopt
10235@item -m68000
10236@itemx -mc68000
10237@opindex m68000
10238@opindex mc68000
10239Generate output for a 68000.  This is the default
10240when the compiler is configured for 68000-based systems.
10241
10242Use this option for microcontrollers with a 68000 or EC000 core,
10243including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
10244
10245@item -m68020
10246@itemx -mc68020
10247@opindex m68020
10248@opindex mc68020
10249Generate output for a 68020.  This is the default
10250when the compiler is configured for 68020-based systems.
10251
10252@item -m68881
10253@opindex m68881
10254Generate output containing 68881 instructions for floating point.
10255This is the default for most 68020 systems unless @option{--nfp} was
10256specified when the compiler was configured.
10257
10258@item -m68030
10259@opindex m68030
10260Generate output for a 68030.  This is the default when the compiler is
10261configured for 68030-based systems.
10262
10263@item -m68040
10264@opindex m68040
10265Generate output for a 68040.  This is the default when the compiler is
10266configured for 68040-based systems.
10267
10268This option inhibits the use of 68881/68882 instructions that have to be
10269emulated by software on the 68040.  Use this option if your 68040 does not
10270have code to emulate those instructions.
10271
10272@item -m68060
10273@opindex m68060
10274Generate output for a 68060.  This is the default when the compiler is
10275configured for 68060-based systems.
10276
10277This option inhibits the use of 68020 and 68881/68882 instructions that
10278have to be emulated by software on the 68060.  Use this option if your 68060
10279does not have code to emulate those instructions.
10280
10281@item -mcpu32
10282@opindex mcpu32
10283Generate output for a CPU32.  This is the default
10284when the compiler is configured for CPU32-based systems.
10285
10286Use this option for microcontrollers with a
10287CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
1028868336, 68340, 68341, 68349 and 68360.
10289
10290@item -m5200
10291@opindex m5200
10292Generate output for a 520X ``coldfire'' family cpu.  This is the default
10293when the compiler is configured for 520X-based systems.
10294
10295Use this option for microcontroller with a 5200 core, including
10296the MCF5202, MCF5203, MCF5204 and MCF5202.
10297
10298@item -mcfv4e
10299@opindex mcfv4e
10300Generate output for a ColdFire V4e family cpu (e.g.@: 547x/548x).
10301This includes use of hardware floating point instructions.
10302
10303@item -m68020-40
10304@opindex m68020-40
10305Generate output for a 68040, without using any of the new instructions.
10306This results in code which can run relatively efficiently on either a
1030768020/68881 or a 68030 or a 68040.  The generated code does use the
1030868881 instructions that are emulated on the 68040.
10309
10310@item -m68020-60
10311@opindex m68020-60
10312Generate output for a 68060, without using any of the new instructions.
10313This results in code which can run relatively efficiently on either a
1031468020/68881 or a 68030 or a 68040.  The generated code does use the
1031568881 instructions that are emulated on the 68060.
10316
10317@item -msoft-float
10318@opindex msoft-float
10319Generate output containing library calls for floating point.
10320@strong{Warning:} the requisite libraries are not available for all m68k
10321targets.  Normally the facilities of the machine's usual C compiler are
10322used, but this can't be done directly in cross-compilation.  You must
10323make your own arrangements to provide suitable library functions for
10324cross-compilation.  The embedded targets @samp{m68k-*-aout} and
10325@samp{m68k-*-coff} do provide software floating point support.
10326
10327@item -mshort
10328@opindex mshort
10329Consider type @code{int} to be 16 bits wide, like @code{short int}.
10330Additionally, parameters passed on the stack are also aligned to a
1033116-bit boundary even on targets whose API mandates promotion to 32-bit.
10332
10333@item -mnobitfield
10334@opindex mnobitfield
10335Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
10336and @option{-m5200} options imply @w{@option{-mnobitfield}}.
10337
10338@item -mbitfield
10339@opindex mbitfield
10340Do use the bit-field instructions.  The @option{-m68020} option implies
10341@option{-mbitfield}.  This is the default if you use a configuration
10342designed for a 68020.
10343
10344@item -mrtd
10345@opindex mrtd
10346Use a different function-calling convention, in which functions
10347that take a fixed number of arguments return with the @code{rtd}
10348instruction, which pops their arguments while returning.  This
10349saves one instruction in the caller since there is no need to pop
10350the arguments there.
10351
10352This calling convention is incompatible with the one normally
10353used on Unix, so you cannot use it if you need to call libraries
10354compiled with the Unix compiler.
10355
10356Also, you must provide function prototypes for all functions that
10357take variable numbers of arguments (including @code{printf});
10358otherwise incorrect code will be generated for calls to those
10359functions.
10360
10361In addition, seriously incorrect code will result if you call a
10362function with too many arguments.  (Normally, extra arguments are
10363harmlessly ignored.)
10364
10365The @code{rtd} instruction is supported by the 68010, 68020, 68030,
1036668040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10367
10368@item -malign-int
10369@itemx -mno-align-int
10370@opindex malign-int
10371@opindex mno-align-int
10372Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10373@code{float}, @code{double}, and @code{long double} variables on a 32-bit
10374boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10375Aligning variables on 32-bit boundaries produces code that runs somewhat
10376faster on processors with 32-bit busses at the expense of more memory.
10377
10378@strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10379align structures containing the above types  differently than
10380most published application binary interface specifications for the m68k.
10381
10382@item -mpcrel
10383@opindex mpcrel
10384Use the pc-relative addressing mode of the 68000 directly, instead of
10385using a global offset table.  At present, this option implies @option{-fpic},
10386allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
10387not presently supported with @option{-mpcrel}, though this could be supported for
1038868020 and higher processors.
10389
10390@item -mno-strict-align
10391@itemx -mstrict-align
10392@opindex mno-strict-align
10393@opindex mstrict-align
10394Do not (do) assume that unaligned memory references will be handled by
10395the system.
10396
10397@item -msep-data
10398Generate code that allows the data segment to be located in a different
10399area of memory from the text segment.  This allows for execute in place in
10400an environment without virtual memory management.  This option implies
10401@option{-fPIC}.
10402
10403@item -mno-sep-data
10404Generate code that assumes that the data segment follows the text segment.
10405This is the default.
10406
10407@item -mid-shared-library
10408Generate code that supports shared libraries via the library ID method.
10409This allows for execute in place and shared libraries in an environment
10410without virtual memory management.  This option implies @option{-fPIC}.
10411
10412@item -mno-id-shared-library
10413Generate code that doesn't assume ID based shared libraries are being used.
10414This is the default.
10415
10416@item -mshared-library-id=n
10417Specified the identification number of the ID based shared library being
10418compiled.  Specifying a value of 0 will generate more compact code, specifying
10419other values will force the allocation of that number to the current
10420library but is no more space or time efficient than omitting this option.
10421
10422@end table
10423
10424@node M68hc1x Options
10425@subsection M68hc1x Options
10426@cindex M68hc1x options
10427
10428These are the @samp{-m} options defined for the 68hc11 and 68hc12
10429microcontrollers.  The default values for these options depends on
10430which style of microcontroller was selected when the compiler was configured;
10431the defaults for the most common choices are given below.
10432
10433@table @gcctabopt
10434@item -m6811
10435@itemx -m68hc11
10436@opindex m6811
10437@opindex m68hc11
10438Generate output for a 68HC11.  This is the default
10439when the compiler is configured for 68HC11-based systems.
10440
10441@item -m6812
10442@itemx -m68hc12
10443@opindex m6812
10444@opindex m68hc12
10445Generate output for a 68HC12.  This is the default
10446when the compiler is configured for 68HC12-based systems.
10447
10448@item -m68S12
10449@itemx -m68hcs12
10450@opindex m68S12
10451@opindex m68hcs12
10452Generate output for a 68HCS12.
10453
10454@item -mauto-incdec
10455@opindex mauto-incdec
10456Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10457addressing modes.
10458
10459@item -minmax
10460@itemx -nominmax
10461@opindex minmax
10462@opindex mnominmax
10463Enable the use of 68HC12 min and max instructions.
10464
10465@item -mlong-calls
10466@itemx -mno-long-calls
10467@opindex mlong-calls
10468@opindex mno-long-calls
10469Treat all calls as being far away (near).  If calls are assumed to be
10470far away, the compiler will use the @code{call} instruction to
10471call a function and the @code{rtc} instruction for returning.
10472
10473@item -mshort
10474@opindex mshort
10475Consider type @code{int} to be 16 bits wide, like @code{short int}.
10476
10477@item -msoft-reg-count=@var{count}
10478@opindex msoft-reg-count
10479Specify the number of pseudo-soft registers which are used for the
10480code generation.  The maximum number is 32.  Using more pseudo-soft
10481register may or may not result in better code depending on the program.
10482The default is 4 for 68HC11 and 2 for 68HC12.
10483
10484@end table
10485
10486@node MCore Options
10487@subsection MCore Options
10488@cindex MCore options
10489
10490These are the @samp{-m} options defined for the Motorola M*Core
10491processors.
10492
10493@table @gcctabopt
10494
10495@item -mhardlit
10496@itemx -mno-hardlit
10497@opindex mhardlit
10498@opindex mno-hardlit
10499Inline constants into the code stream if it can be done in two
10500instructions or less.
10501
10502@item -mdiv
10503@itemx -mno-div
10504@opindex mdiv
10505@opindex mno-div
10506Use the divide instruction.  (Enabled by default).
10507
10508@item -mrelax-immediate
10509@itemx -mno-relax-immediate
10510@opindex mrelax-immediate
10511@opindex mno-relax-immediate
10512Allow arbitrary sized immediates in bit operations.
10513
10514@item -mwide-bitfields
10515@itemx -mno-wide-bitfields
10516@opindex mwide-bitfields
10517@opindex mno-wide-bitfields
10518Always treat bit-fields as int-sized.
10519
10520@item -m4byte-functions
10521@itemx -mno-4byte-functions
10522@opindex m4byte-functions
10523@opindex mno-4byte-functions
10524Force all functions to be aligned to a four byte boundary.
10525
10526@item -mcallgraph-data
10527@itemx -mno-callgraph-data
10528@opindex mcallgraph-data
10529@opindex mno-callgraph-data
10530Emit callgraph information.
10531
10532@item -mslow-bytes
10533@itemx -mno-slow-bytes
10534@opindex mslow-bytes
10535@opindex mno-slow-bytes
10536Prefer word access when reading byte quantities.
10537
10538@item -mlittle-endian
10539@itemx -mbig-endian
10540@opindex mlittle-endian
10541@opindex mbig-endian
10542Generate code for a little endian target.
10543
10544@item -m210
10545@itemx -m340
10546@opindex m210
10547@opindex m340
10548Generate code for the 210 processor.
10549@end table
10550
10551@node MIPS Options
10552@subsection MIPS Options
10553@cindex MIPS options
10554
10555@table @gcctabopt
10556
10557@item -EB
10558@opindex EB
10559Generate big-endian code.
10560
10561@item -EL
10562@opindex EL
10563Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10564configurations.
10565
10566@item -march=@var{arch}
10567@opindex march
10568Generate code that will run on @var{arch}, which can be the name of a
10569generic MIPS ISA, or the name of a particular processor.
10570The ISA names are:
10571@samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10572@samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10573The processor names are:
10574@samp{4kc}, @samp{4km}, @samp{4kp},
10575@samp{5kc}, @samp{5kf},
10576@samp{20kc},
10577@samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10578@samp{m4k},
10579@samp{orion},
10580@samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10581@samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10582@samp{rm7000}, @samp{rm9000},
10583@samp{sb1},
10584@samp{sr71000},
10585@samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10586@samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10587The special value @samp{from-abi} selects the
10588most compatible architecture for the selected ABI (that is,
10589@samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10590
10591In processor names, a final @samp{000} can be abbreviated as @samp{k}
10592(for example, @samp{-march=r2k}).  Prefixes are optional, and
10593@samp{vr} may be written @samp{r}.
10594
10595GCC defines two macros based on the value of this option.  The first
10596is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10597a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10598where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10599For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10600to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10601
10602Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10603above.  In other words, it will have the full prefix and will not
10604abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10605the macro names the resolved architecture (either @samp{"mips1"} or
10606@samp{"mips3"}).  It names the default architecture when no
10607@option{-march} option is given.
10608
10609@item -mtune=@var{arch}
10610@opindex mtune
10611Optimize for @var{arch}.  Among other things, this option controls
10612the way instructions are scheduled, and the perceived cost of arithmetic
10613operations.  The list of @var{arch} values is the same as for
10614@option{-march}.
10615
10616When this option is not used, GCC will optimize for the processor
10617specified by @option{-march}.  By using @option{-march} and
10618@option{-mtune} together, it is possible to generate code that will
10619run on a family of processors, but optimize the code for one
10620particular member of that family.
10621
10622@samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10623@samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10624@samp{-march} ones described above.
10625
10626@item -mips1
10627@opindex mips1
10628Equivalent to @samp{-march=mips1}.
10629
10630@item -mips2
10631@opindex mips2
10632Equivalent to @samp{-march=mips2}.
10633
10634@item -mips3
10635@opindex mips3
10636Equivalent to @samp{-march=mips3}.
10637
10638@item -mips4
10639@opindex mips4
10640Equivalent to @samp{-march=mips4}.
10641
10642@item -mips32
10643@opindex mips32
10644Equivalent to @samp{-march=mips32}.
10645
10646@item -mips32r2
10647@opindex mips32r2
10648Equivalent to @samp{-march=mips32r2}.
10649
10650@item -mips64
10651@opindex mips64
10652Equivalent to @samp{-march=mips64}.
10653
10654@item -mips16
10655@itemx -mno-mips16
10656@opindex mips16
10657@opindex mno-mips16
10658Generate (do not generate) MIPS16 code.  If GCC is targetting a
10659MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10660
10661@item -mabi=32
10662@itemx -mabi=o64
10663@itemx -mabi=n32
10664@itemx -mabi=64
10665@itemx -mabi=eabi
10666@opindex mabi=32
10667@opindex mabi=o64
10668@opindex mabi=n32
10669@opindex mabi=64
10670@opindex mabi=eabi
10671Generate code for the given ABI@.
10672
10673Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10674generates 64-bit code when you select a 64-bit architecture, but you
10675can use @option{-mgp32} to get 32-bit code instead.
10676
10677For information about the O64 ABI, see
10678@w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10679
10680@item -mabicalls
10681@itemx -mno-abicalls
10682@opindex mabicalls
10683@opindex mno-abicalls
10684Generate (do not generate) code that is suitable for SVR4-style
10685dynamic objects.  @option{-mabicalls} is the default for SVR4-based
10686systems.
10687
10688@item -mshared
10689@itemx -mno-shared
10690Generate (do not generate) code that is fully position-independent,
10691and that can therefore be linked into shared libraries.  This option
10692only affects @option{-mabicalls}.
10693
10694All @option{-mabicalls} code has traditionally been position-independent,
10695regardless of options like @option{-fPIC} and @option{-fpic}.  However,
10696as an extension, the GNU toolchain allows executables to use absolute
10697accesses for locally-binding symbols.  It can also use shorter GP
10698initialization sequences and generate direct calls to locally-defined
10699functions.  This mode is selected by @option{-mno-shared}.
10700
10701@option{-mno-shared} depends on binutils 2.16 or higher and generates
10702objects that can only be linked by the GNU linker.  However, the option
10703does not affect the ABI of the final executable; it only affects the ABI
10704of relocatable objects.  Using @option{-mno-shared} will generally make
10705executables both smaller and quicker.
10706
10707@option{-mshared} is the default.
10708
10709@item -mxgot
10710@itemx -mno-xgot
10711@opindex mxgot
10712@opindex mno-xgot
10713Lift (do not lift) the usual restrictions on the size of the global
10714offset table.
10715
10716GCC normally uses a single instruction to load values from the GOT@.
10717While this is relatively efficient, it will only work if the GOT
10718is smaller than about 64k.  Anything larger will cause the linker
10719to report an error such as:
10720
10721@cindex relocation truncated to fit (MIPS)
10722@smallexample
10723relocation truncated to fit: R_MIPS_GOT16 foobar
10724@end smallexample
10725
10726If this happens, you should recompile your code with @option{-mxgot}.
10727It should then work with very large GOTs, although it will also be
10728less efficient, since it will take three instructions to fetch the
10729value of a global symbol.
10730
10731Note that some linkers can create multiple GOTs.  If you have such a
10732linker, you should only need to use @option{-mxgot} when a single object
10733file accesses more than 64k's worth of GOT entries.  Very few do.
10734
10735These options have no effect unless GCC is generating position
10736independent code.
10737
10738@item -mgp32
10739@opindex mgp32
10740Assume that general-purpose registers are 32 bits wide.
10741
10742@item -mgp64
10743@opindex mgp64
10744Assume that general-purpose registers are 64 bits wide.
10745
10746@item -mfp32
10747@opindex mfp32
10748Assume that floating-point registers are 32 bits wide.
10749
10750@item -mfp64
10751@opindex mfp64
10752Assume that floating-point registers are 64 bits wide.
10753
10754@item -mhard-float
10755@opindex mhard-float
10756Use floating-point coprocessor instructions.
10757
10758@item -msoft-float
10759@opindex msoft-float
10760Do not use floating-point coprocessor instructions.  Implement
10761floating-point calculations using library calls instead.
10762
10763@item -msingle-float
10764@opindex msingle-float
10765Assume that the floating-point coprocessor only supports single-precision
10766operations.
10767
10768@itemx -mdouble-float
10769@opindex mdouble-float
10770Assume that the floating-point coprocessor supports double-precision
10771operations.  This is the default.
10772
10773@itemx -mdsp
10774@itemx -mno-dsp
10775@opindex mdsp
10776@opindex mno-dsp
10777Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10778
10779@itemx -mpaired-single
10780@itemx -mno-paired-single
10781@opindex mpaired-single
10782@opindex mno-paired-single
10783Use (do not use) paired-single floating-point instructions.
10784@xref{MIPS Paired-Single Support}.  This option can only be used
10785when generating 64-bit code and requires hardware floating-point
10786support to be enabled.
10787
10788@itemx -mips3d
10789@itemx -mno-mips3d
10790@opindex mips3d
10791@opindex mno-mips3d
10792Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10793The option @option{-mips3d} implies @option{-mpaired-single}.
10794
10795@item -mlong64
10796@opindex mlong64
10797Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10798an explanation of the default and the way that the pointer size is
10799determined.
10800
10801@item -mlong32
10802@opindex mlong32
10803Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10804
10805The default size of @code{int}s, @code{long}s and pointers depends on
10806the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10807uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
1080832-bit @code{long}s.  Pointers are the same size as @code{long}s,
10809or the same size as integer registers, whichever is smaller.
10810
10811@item -msym32
10812@itemx -mno-sym32
10813@opindex msym32
10814@opindex mno-sym32
10815Assume (do not assume) that all symbols have 32-bit values, regardless
10816of the selected ABI@.  This option is useful in combination with
10817@option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10818to generate shorter and faster references to symbolic addresses.
10819
10820@item -G @var{num}
10821@opindex G
10822@cindex smaller data references (MIPS)
10823@cindex gp-relative references (MIPS)
10824Put global and static items less than or equal to @var{num} bytes into
10825the small data or bss section instead of the normal data or bss section.
10826This allows the data to be accessed using a single instruction.
10827
10828All modules should be compiled with the same @option{-G @var{num}}
10829value.
10830
10831@item -membedded-data
10832@itemx -mno-embedded-data
10833@opindex membedded-data
10834@opindex mno-embedded-data
10835Allocate variables to the read-only data section first if possible, then
10836next in the small data section if possible, otherwise in data.  This gives
10837slightly slower code than the default, but reduces the amount of RAM required
10838when executing, and thus may be preferred for some embedded systems.
10839
10840@item -muninit-const-in-rodata
10841@itemx -mno-uninit-const-in-rodata
10842@opindex muninit-const-in-rodata
10843@opindex mno-uninit-const-in-rodata
10844Put uninitialized @code{const} variables in the read-only data section.
10845This option is only meaningful in conjunction with @option{-membedded-data}.
10846
10847@item -msplit-addresses
10848@itemx -mno-split-addresses
10849@opindex msplit-addresses
10850@opindex mno-split-addresses
10851Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10852relocation operators.  This option has been superseded by
10853@option{-mexplicit-relocs} but is retained for backwards compatibility.
10854
10855@item -mexplicit-relocs
10856@itemx -mno-explicit-relocs
10857@opindex mexplicit-relocs
10858@opindex mno-explicit-relocs
10859Use (do not use) assembler relocation operators when dealing with symbolic
10860addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10861is to use assembler macros instead.
10862
10863@option{-mexplicit-relocs} is the default if GCC was configured
10864to use an assembler that supports relocation operators.
10865
10866@item -mcheck-zero-division
10867@itemx -mno-check-zero-division
10868@opindex mcheck-zero-division
10869@opindex mno-check-zero-division
10870Trap (do not trap) on integer division by zero.  The default is
10871@option{-mcheck-zero-division}.
10872
10873@item -mdivide-traps
10874@itemx -mdivide-breaks
10875@opindex mdivide-traps
10876@opindex mdivide-breaks
10877MIPS systems check for division by zero by generating either a
10878conditional trap or a break instruction.  Using traps results in
10879smaller code, but is only supported on MIPS II and later.  Also, some
10880versions of the Linux kernel have a bug that prevents trap from
10881generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10882allow conditional traps on architectures that support them and
10883@option{-mdivide-breaks} to force the use of breaks.
10884
10885The default is usually @option{-mdivide-traps}, but this can be
10886overridden at configure time using @option{--with-divide=breaks}.
10887Divide-by-zero checks can be completely disabled using
10888@option{-mno-check-zero-division}.
10889
10890@item -mmemcpy
10891@itemx -mno-memcpy
10892@opindex mmemcpy
10893@opindex mno-memcpy
10894Force (do not force) the use of @code{memcpy()} for non-trivial block
10895moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10896most constant-sized copies.
10897
10898@item -mlong-calls
10899@itemx -mno-long-calls
10900@opindex mlong-calls
10901@opindex mno-long-calls
10902Disable (do not disable) use of the @code{jal} instruction.  Calling
10903functions using @code{jal} is more efficient but requires the caller
10904and callee to be in the same 256 megabyte segment.
10905
10906This option has no effect on abicalls code.  The default is
10907@option{-mno-long-calls}.
10908
10909@item -mmad
10910@itemx -mno-mad
10911@opindex mmad
10912@opindex mno-mad
10913Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10914instructions, as provided by the R4650 ISA@.
10915
10916@item -mfused-madd
10917@itemx -mno-fused-madd
10918@opindex mfused-madd
10919@opindex mno-fused-madd
10920Enable (disable) use of the floating point multiply-accumulate
10921instructions, when they are available.  The default is
10922@option{-mfused-madd}.
10923
10924When multiply-accumulate instructions are used, the intermediate
10925product is calculated to infinite precision and is not subject to
10926the FCSR Flush to Zero bit.  This may be undesirable in some
10927circumstances.
10928
10929@item -nocpp
10930@opindex nocpp
10931Tell the MIPS assembler to not run its preprocessor over user
10932assembler files (with a @samp{.s} suffix) when assembling them.
10933
10934@item -mfix-r4000
10935@itemx -mno-fix-r4000
10936@opindex mfix-r4000
10937@opindex mno-fix-r4000
10938Work around certain R4000 CPU errata:
10939@itemize @minus
10940@item
10941A double-word or a variable shift may give an incorrect result if executed
10942immediately after starting an integer division.
10943@item
10944A double-word or a variable shift may give an incorrect result if executed
10945while an integer multiplication is in progress.
10946@item
10947An integer division may give an incorrect result if started in a delay slot
10948of a taken branch or a jump.
10949@end itemize
10950
10951@item -mfix-r4400
10952@itemx -mno-fix-r4400
10953@opindex mfix-r4400
10954@opindex mno-fix-r4400
10955Work around certain R4400 CPU errata:
10956@itemize @minus
10957@item
10958A double-word or a variable shift may give an incorrect result if executed
10959immediately after starting an integer division.
10960@end itemize
10961
10962@item -mfix-vr4120
10963@itemx -mno-fix-vr4120
10964@opindex mfix-vr4120
10965Work around certain VR4120 errata:
10966@itemize @minus
10967@item
10968@code{dmultu} does not always produce the correct result.
10969@item
10970@code{div} and @code{ddiv} do not always produce the correct result if one
10971of the operands is negative.
10972@end itemize
10973The workarounds for the division errata rely on special functions in
10974@file{libgcc.a}.  At present, these functions are only provided by
10975the @code{mips64vr*-elf} configurations.
10976
10977Other VR4120 errata require a nop to be inserted between certain pairs of
10978instructions.  These errata are handled by the assembler, not by GCC itself.
10979
10980@item -mfix-vr4130
10981@opindex mfix-vr4130
10982Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10983workarounds are implemented by the assembler rather than by GCC,
10984although GCC will avoid using @code{mflo} and @code{mfhi} if the
10985VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10986instructions are available instead.
10987
10988@item -mfix-sb1
10989@itemx -mno-fix-sb1
10990@opindex mfix-sb1
10991Work around certain SB-1 CPU core errata.
10992(This flag currently works around the SB-1 revision 2
10993``F1'' and ``F2'' floating point errata.)
10994
10995@item -mflush-func=@var{func}
10996@itemx -mno-flush-func
10997@opindex mflush-func
10998Specifies the function to call to flush the I and D caches, or to not
10999call any such function.  If called, the function must take the same
11000arguments as the common @code{_flush_func()}, that is, the address of the
11001memory range for which the cache is being flushed, the size of the
11002memory range, and the number 3 (to flush both caches).  The default
11003depends on the target GCC was configured for, but commonly is either
11004@samp{_flush_func} or @samp{__cpu_flush}.
11005
11006@item -mbranch-likely
11007@itemx -mno-branch-likely
11008@opindex mbranch-likely
11009@opindex mno-branch-likely
11010Enable or disable use of Branch Likely instructions, regardless of the
11011default for the selected architecture.  By default, Branch Likely
11012instructions may be generated if they are supported by the selected
11013architecture.  An exception is for the MIPS32 and MIPS64 architectures
11014and processors which implement those architectures; for those, Branch
11015Likely instructions will not be generated by default because the MIPS32
11016and MIPS64 architectures specifically deprecate their use.
11017
11018@item -mfp-exceptions
11019@itemx -mno-fp-exceptions
11020@opindex mfp-exceptions
11021Specifies whether FP exceptions are enabled.  This affects how we schedule
11022FP instructions for some processors.  The default is that FP exceptions are
11023enabled.
11024
11025For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
1102664-bit code, then we can use both FP pipes.  Otherwise, we can only use one
11027FP pipe.
11028
11029@item -mvr4130-align
11030@itemx -mno-vr4130-align
11031@opindex mvr4130-align
11032The VR4130 pipeline is two-way superscalar, but can only issue two
11033instructions together if the first one is 8-byte aligned.  When this
11034option is enabled, GCC will align pairs of instructions that it
11035thinks should execute in parallel.
11036
11037This option only has an effect when optimizing for the VR4130.
11038It normally makes code faster, but at the expense of making it bigger.
11039It is enabled by default at optimization level @option{-O3}.
11040@end table
11041
11042@node MMIX Options
11043@subsection MMIX Options
11044@cindex MMIX Options
11045
11046These options are defined for the MMIX:
11047
11048@table @gcctabopt
11049@item -mlibfuncs
11050@itemx -mno-libfuncs
11051@opindex mlibfuncs
11052@opindex mno-libfuncs
11053Specify that intrinsic library functions are being compiled, passing all
11054values in registers, no matter the size.
11055
11056@item -mepsilon
11057@itemx -mno-epsilon
11058@opindex mepsilon
11059@opindex mno-epsilon
11060Generate floating-point comparison instructions that compare with respect
11061to the @code{rE} epsilon register.
11062
11063@item -mabi=mmixware
11064@itemx -mabi=gnu
11065@opindex mabi-mmixware
11066@opindex mabi=gnu
11067Generate code that passes function parameters and return values that (in
11068the called function) are seen as registers @code{$0} and up, as opposed to
11069the GNU ABI which uses global registers @code{$231} and up.
11070
11071@item -mzero-extend
11072@itemx -mno-zero-extend
11073@opindex mzero-extend
11074@opindex mno-zero-extend
11075When reading data from memory in sizes shorter than 64 bits, use (do not
11076use) zero-extending load instructions by default, rather than
11077sign-extending ones.
11078
11079@item -mknuthdiv
11080@itemx -mno-knuthdiv
11081@opindex mknuthdiv
11082@opindex mno-knuthdiv
11083Make the result of a division yielding a remainder have the same sign as
11084the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
11085remainder follows the sign of the dividend.  Both methods are
11086arithmetically valid, the latter being almost exclusively used.
11087
11088@item -mtoplevel-symbols
11089@itemx -mno-toplevel-symbols
11090@opindex mtoplevel-symbols
11091@opindex mno-toplevel-symbols
11092Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
11093code can be used with the @code{PREFIX} assembly directive.
11094
11095@item -melf
11096@opindex melf
11097Generate an executable in the ELF format, rather than the default
11098@samp{mmo} format used by the @command{mmix} simulator.
11099
11100@item -mbranch-predict
11101@itemx -mno-branch-predict
11102@opindex mbranch-predict
11103@opindex mno-branch-predict
11104Use (do not use) the probable-branch instructions, when static branch
11105prediction indicates a probable branch.
11106
11107@item -mbase-addresses
11108@itemx -mno-base-addresses
11109@opindex mbase-addresses
11110@opindex mno-base-addresses
11111Generate (do not generate) code that uses @emph{base addresses}.  Using a
11112base address automatically generates a request (handled by the assembler
11113and the linker) for a constant to be set up in a global register.  The
11114register is used for one or more base address requests within the range 0
11115to 255 from the value held in the register.  The generally leads to short
11116and fast code, but the number of different data items that can be
11117addressed is limited.  This means that a program that uses lots of static
11118data may require @option{-mno-base-addresses}.
11119
11120@item -msingle-exit
11121@itemx -mno-single-exit
11122@opindex msingle-exit
11123@opindex mno-single-exit
11124Force (do not force) generated code to have a single exit point in each
11125function.
11126@end table
11127
11128@node MN10300 Options
11129@subsection MN10300 Options
11130@cindex MN10300 options
11131
11132These @option{-m} options are defined for Matsushita MN10300 architectures:
11133
11134@table @gcctabopt
11135@item -mmult-bug
11136@opindex mmult-bug
11137Generate code to avoid bugs in the multiply instructions for the MN10300
11138processors.  This is the default.
11139
11140@item -mno-mult-bug
11141@opindex mno-mult-bug
11142Do not generate code to avoid bugs in the multiply instructions for the
11143MN10300 processors.
11144
11145@item -mam33
11146@opindex mam33
11147Generate code which uses features specific to the AM33 processor.
11148
11149@item -mno-am33
11150@opindex mno-am33
11151Do not generate code which uses features specific to the AM33 processor.  This
11152is the default.
11153
11154@item -mreturn-pointer-on-d0
11155@opindex mreturn-pointer-on-d0
11156When generating a function which returns a pointer, return the pointer
11157in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
11158only in a0, and attempts to call such functions without a prototype
11159would result in errors.  Note that this option is on by default; use
11160@option{-mno-return-pointer-on-d0} to disable it.
11161
11162@item -mno-crt0
11163@opindex mno-crt0
11164Do not link in the C run-time initialization object file.
11165
11166@item -mrelax
11167@opindex mrelax
11168Indicate to the linker that it should perform a relaxation optimization pass
11169to shorten branches, calls and absolute memory addresses.  This option only
11170has an effect when used on the command line for the final link step.
11171
11172This option makes symbolic debugging impossible.
11173@end table
11174
11175@node MT Options
11176@subsection MT Options
11177@cindex MT options
11178
11179These @option{-m} options are defined for Morpho MT architectures:
11180
11181@table @gcctabopt
11182
11183@item -march=@var{cpu-type}
11184@opindex march
11185Generate code that will run on @var{cpu-type}, which is the name of a system
11186representing a certain processor type.  Possible values for
11187@var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
11188@samp{ms1-16-003} and @samp{ms2}.
11189
11190When this option is not used, the default is @option{-march=ms1-16-002}.
11191
11192@item -mbacc
11193@opindex mbacc
11194Use byte loads and stores when generating code.
11195
11196@item -mno-bacc
11197@opindex mno-bacc
11198Do not use byte loads and stores when generating code.
11199
11200@item -msim
11201@opindex msim
11202Use simulator runtime
11203
11204@item -mno-crt0
11205@opindex mno-crt0
11206Do not link in the C run-time initialization object file
11207@file{crti.o}.  Other run-time initialization and termination files
11208such as @file{startup.o} and @file{exit.o} are still included on the
11209linker command line.
11210
11211@end table
11212
11213@node PDP-11 Options
11214@subsection PDP-11 Options
11215@cindex PDP-11 Options
11216
11217These options are defined for the PDP-11:
11218
11219@table @gcctabopt
11220@item -mfpu
11221@opindex mfpu
11222Use hardware FPP floating point.  This is the default.  (FIS floating
11223point on the PDP-11/40 is not supported.)
11224
11225@item -msoft-float
11226@opindex msoft-float
11227Do not use hardware floating point.
11228
11229@item -mac0
11230@opindex mac0
11231Return floating-point results in ac0 (fr0 in Unix assembler syntax).
11232
11233@item -mno-ac0
11234@opindex mno-ac0
11235Return floating-point results in memory.  This is the default.
11236
11237@item -m40
11238@opindex m40
11239Generate code for a PDP-11/40.
11240
11241@item -m45
11242@opindex m45
11243Generate code for a PDP-11/45.  This is the default.
11244
11245@item -m10
11246@opindex m10
11247Generate code for a PDP-11/10.
11248
11249@item -mbcopy-builtin
11250@opindex bcopy-builtin
11251Use inline @code{movmemhi} patterns for copying memory.  This is the
11252default.
11253
11254@item -mbcopy
11255@opindex mbcopy
11256Do not use inline @code{movmemhi} patterns for copying memory.
11257
11258@item -mint16
11259@itemx -mno-int32
11260@opindex mint16
11261@opindex mno-int32
11262Use 16-bit @code{int}.  This is the default.
11263
11264@item -mint32
11265@itemx -mno-int16
11266@opindex mint32
11267@opindex mno-int16
11268Use 32-bit @code{int}.
11269
11270@item -mfloat64
11271@itemx -mno-float32
11272@opindex mfloat64
11273@opindex mno-float32
11274Use 64-bit @code{float}.  This is the default.
11275
11276@item -mfloat32
11277@itemx -mno-float64
11278@opindex mfloat32
11279@opindex mno-float64
11280Use 32-bit @code{float}.
11281
11282@item -mabshi
11283@opindex mabshi
11284Use @code{abshi2} pattern.  This is the default.
11285
11286@item -mno-abshi
11287@opindex mno-abshi
11288Do not use @code{abshi2} pattern.
11289
11290@item -mbranch-expensive
11291@opindex mbranch-expensive
11292Pretend that branches are expensive.  This is for experimenting with
11293code generation only.
11294
11295@item -mbranch-cheap
11296@opindex mbranch-cheap
11297Do not pretend that branches are expensive.  This is the default.
11298
11299@item -msplit
11300@opindex msplit
11301Generate code for a system with split I&D@.
11302
11303@item -mno-split
11304@opindex mno-split
11305Generate code for a system without split I&D@.  This is the default.
11306
11307@item -munix-asm
11308@opindex munix-asm
11309Use Unix assembler syntax.  This is the default when configured for
11310@samp{pdp11-*-bsd}.
11311
11312@item -mdec-asm
11313@opindex mdec-asm
11314Use DEC assembler syntax.  This is the default when configured for any
11315PDP-11 target other than @samp{pdp11-*-bsd}.
11316@end table
11317
11318@node PowerPC Options
11319@subsection PowerPC Options
11320@cindex PowerPC options
11321
11322These are listed under @xref{RS/6000 and PowerPC Options}.
11323
11324@node RS/6000 and PowerPC Options
11325@subsection IBM RS/6000 and PowerPC Options
11326@cindex RS/6000 and PowerPC Options
11327@cindex IBM RS/6000 and PowerPC Options
11328
11329These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
11330@table @gcctabopt
11331@item -mpower
11332@itemx -mno-power
11333@itemx -mpower2
11334@itemx -mno-power2
11335@itemx -mpowerpc
11336@itemx -mno-powerpc
11337@itemx -mpowerpc-gpopt
11338@itemx -mno-powerpc-gpopt
11339@itemx -mpowerpc-gfxopt
11340@itemx -mno-powerpc-gfxopt
11341@itemx -mpowerpc64
11342@itemx -mno-powerpc64
11343@itemx -mmfcrf
11344@itemx -mno-mfcrf
11345@itemx -mpopcntb
11346@itemx -mno-popcntb
11347@itemx -mfprnd
11348@itemx -mno-fprnd
11349@opindex mpower
11350@opindex mno-power
11351@opindex mpower2
11352@opindex mno-power2
11353@opindex mpowerpc
11354@opindex mno-powerpc
11355@opindex mpowerpc-gpopt
11356@opindex mno-powerpc-gpopt
11357@opindex mpowerpc-gfxopt
11358@opindex mno-powerpc-gfxopt
11359@opindex mpowerpc64
11360@opindex mno-powerpc64
11361@opindex mmfcrf
11362@opindex mno-mfcrf
11363@opindex mpopcntb
11364@opindex mno-popcntb
11365@opindex mfprnd
11366@opindex mno-fprnd
11367GCC supports two related instruction set architectures for the
11368RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
11369instructions supported by the @samp{rios} chip set used in the original
11370RS/6000 systems and the @dfn{PowerPC} instruction set is the
11371architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
11372the IBM 4xx, 6xx, and follow-on microprocessors.
11373
11374Neither architecture is a subset of the other.  However there is a
11375large common subset of instructions supported by both.  An MQ
11376register is included in processors supporting the POWER architecture.
11377
11378You use these options to specify which instructions are available on the
11379processor you are using.  The default value of these options is
11380determined when configuring GCC@.  Specifying the
11381@option{-mcpu=@var{cpu_type}} overrides the specification of these
11382options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
11383rather than the options listed above.
11384
11385The @option{-mpower} option allows GCC to generate instructions that
11386are found only in the POWER architecture and to use the MQ register.
11387Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11388to generate instructions that are present in the POWER2 architecture but
11389not the original POWER architecture.
11390
11391The @option{-mpowerpc} option allows GCC to generate instructions that
11392are found only in the 32-bit subset of the PowerPC architecture.
11393Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11394GCC to use the optional PowerPC architecture instructions in the
11395General Purpose group, including floating-point square root.  Specifying
11396@option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11397use the optional PowerPC architecture instructions in the Graphics
11398group, including floating-point select.
11399
11400The @option{-mmfcrf} option allows GCC to generate the move from
11401condition register field instruction implemented on the POWER4
11402processor and other processors that support the PowerPC V2.01
11403architecture.
11404The @option{-mpopcntb} option allows GCC to generate the popcount and
11405double precision FP reciprocal estimate instruction implemented on the
11406POWER5 processor and other processors that support the PowerPC V2.02
11407architecture.
11408The @option{-mfprnd} option allows GCC to generate the FP round to
11409integer instructions implemented on the POWER5+ processor and other
11410processors that support the PowerPC V2.03 architecture.
11411
11412The @option{-mpowerpc64} option allows GCC to generate the additional
1141364-bit instructions that are found in the full PowerPC64 architecture
11414and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
11415@option{-mno-powerpc64}.
11416
11417If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11418will use only the instructions in the common subset of both
11419architectures plus some special AIX common-mode calls, and will not use
11420the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
11421permits GCC to use any instruction from either architecture and to
11422allow use of the MQ register; specify this for the Motorola MPC601.
11423
11424@item -mnew-mnemonics
11425@itemx -mold-mnemonics
11426@opindex mnew-mnemonics
11427@opindex mold-mnemonics
11428Select which mnemonics to use in the generated assembler code.  With
11429@option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11430the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11431assembler mnemonics defined for the POWER architecture.  Instructions
11432defined in only one architecture have only one mnemonic; GCC uses that
11433mnemonic irrespective of which of these options is specified.
11434
11435GCC defaults to the mnemonics appropriate for the architecture in
11436use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11437value of these option.  Unless you are building a cross-compiler, you
11438should normally not specify either @option{-mnew-mnemonics} or
11439@option{-mold-mnemonics}, but should instead accept the default.
11440
11441@item -mcpu=@var{cpu_type}
11442@opindex mcpu
11443Set architecture type, register usage, choice of mnemonics, and
11444instruction scheduling parameters for machine type @var{cpu_type}.
11445Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11446@samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11447@samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11448@samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11449@samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11450@samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11451@samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11452@samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11453@samp{common}, @samp{powerpc}, @samp{powerpc64},
11454@samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11455
11456@option{-mcpu=common} selects a completely generic processor.  Code
11457generated under this option will run on any POWER or PowerPC processor.
11458GCC will use only the instructions in the common subset of both
11459architectures, and will not use the MQ register.  GCC assumes a generic
11460processor model for scheduling purposes.
11461
11462@option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11463@option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11464PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11465types, with an appropriate, generic processor model assumed for
11466scheduling purposes.
11467
11468The other options specify a specific processor.  Code generated under
11469those options will run best on that processor, and may not run at all on
11470others.
11471
11472The @option{-mcpu} options automatically enable or disable the
11473following options: @option{-maltivec}, @option{-mfprnd},
11474@option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11475@option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11476@option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11477@option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}, @option{-mdlmzb}.
11478The particular options
11479set for any particular CPU will vary between compiler versions,
11480depending on what setting seems to produce optimal code for that CPU;
11481it doesn't necessarily reflect the actual hardware's capabilities.  If
11482you wish to set an individual option to a particular value, you may
11483specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11484-mno-altivec}.
11485
11486On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11487not enabled or disabled by the @option{-mcpu} option at present because
11488AIX does not have full support for these options.  You may still
11489enable or disable them individually if you're sure it'll work in your
11490environment.
11491
11492@item -mtune=@var{cpu_type}
11493@opindex mtune
11494Set the instruction scheduling parameters for machine type
11495@var{cpu_type}, but do not set the architecture type, register usage, or
11496choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11497values for @var{cpu_type} are used for @option{-mtune} as for
11498@option{-mcpu}.  If both are specified, the code generated will use the
11499architecture, registers, and mnemonics set by @option{-mcpu}, but the
11500scheduling parameters set by @option{-mtune}.
11501
11502@item -mswdiv
11503@itemx -mno-swdiv
11504@opindex mswdiv
11505@opindex mno-swdiv
11506Generate code to compute division as reciprocal estimate and iterative
11507refinement, creating opportunities for increased throughput.  This
11508feature requires: optional PowerPC Graphics instruction set for single
11509precision and FRE instruction for double precision, assuming divides
11510cannot generate user-visible traps, and the domain values not include
11511Infinities, denormals or zero denominator.
11512
11513@item -maltivec
11514@itemx -mno-altivec
11515@opindex maltivec
11516@opindex mno-altivec
11517Generate code that uses (does not use) AltiVec instructions, and also
11518enable the use of built-in functions that allow more direct access to
11519the AltiVec instruction set.  You may also need to set
11520@option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11521enhancements.
11522
11523@item -mvrsave
11524@item -mno-vrsave
11525@opindex mvrsave
11526@opindex mno-vrsave
11527Generate VRSAVE instructions when generating AltiVec code.
11528
11529@item -msecure-plt
11530@opindex msecure-plt
11531Generate code that allows ld and ld.so to build executables and shared
11532libraries with non-exec .plt and .got sections.  This is a PowerPC
1153332-bit SYSV ABI option.
11534
11535@item -mbss-plt
11536@opindex mbss-plt
11537Generate code that uses a BSS .plt section that ld.so fills in, and
11538requires .plt and .got sections that are both writable and executable.
11539This is a PowerPC 32-bit SYSV ABI option.
11540
11541@item -misel
11542@itemx -mno-isel
11543@opindex misel
11544@opindex mno-isel
11545This switch enables or disables the generation of ISEL instructions.
11546
11547@item -misel=@var{yes/no}
11548This switch has been deprecated.  Use @option{-misel} and
11549@option{-mno-isel} instead.
11550
11551@item -mspe
11552@itemx -mno-spe
11553@opindex mspe
11554@opindex mno-spe
11555This switch enables or disables the generation of SPE simd
11556instructions.
11557
11558@item -mspe=@var{yes/no}
11559This option has been deprecated.  Use @option{-mspe} and
11560@option{-mno-spe} instead.
11561
11562@item -mfloat-gprs=@var{yes/single/double/no}
11563@itemx -mfloat-gprs
11564@opindex mfloat-gprs
11565This switch enables or disables the generation of floating point
11566operations on the general purpose registers for architectures that
11567support it.
11568
11569The argument @var{yes} or @var{single} enables the use of
11570single-precision floating point operations.
11571
11572The argument @var{double} enables the use of single and
11573double-precision floating point operations.
11574
11575The argument @var{no} disables floating point operations on the
11576general purpose registers.
11577
11578This option is currently only available on the MPC854x.
11579
11580@item -m32
11581@itemx -m64
11582@opindex m32
11583@opindex m64
11584Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11585targets (including GNU/Linux).  The 32-bit environment sets int, long
11586and pointer to 32 bits and generates code that runs on any PowerPC
11587variant.  The 64-bit environment sets int to 32 bits and long and
11588pointer to 64 bits, and generates code for PowerPC64, as for
11589@option{-mpowerpc64}.
11590
11591@item -mfull-toc
11592@itemx -mno-fp-in-toc
11593@itemx -mno-sum-in-toc
11594@itemx -mminimal-toc
11595@opindex mfull-toc
11596@opindex mno-fp-in-toc
11597@opindex mno-sum-in-toc
11598@opindex mminimal-toc
11599Modify generation of the TOC (Table Of Contents), which is created for
11600every executable file.  The @option{-mfull-toc} option is selected by
11601default.  In that case, GCC will allocate at least one TOC entry for
11602each unique non-automatic variable reference in your program.  GCC
11603will also place floating-point constants in the TOC@.  However, only
1160416,384 entries are available in the TOC@.
11605
11606If you receive a linker error message that saying you have overflowed
11607the available TOC space, you can reduce the amount of TOC space used
11608with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11609@option{-mno-fp-in-toc} prevents GCC from putting floating-point
11610constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11611generate code to calculate the sum of an address and a constant at
11612run-time instead of putting that sum into the TOC@.  You may specify one
11613or both of these options.  Each causes GCC to produce very slightly
11614slower and larger code at the expense of conserving TOC space.
11615
11616If you still run out of space in the TOC even when you specify both of
11617these options, specify @option{-mminimal-toc} instead.  This option causes
11618GCC to make only one TOC entry for every file.  When you specify this
11619option, GCC will produce code that is slower and larger but which
11620uses extremely little TOC space.  You may wish to use this option
11621only on files that contain less frequently executed code.
11622
11623@item -maix64
11624@itemx -maix32
11625@opindex maix64
11626@opindex maix32
11627Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11628@code{long} type, and the infrastructure needed to support them.
11629Specifying @option{-maix64} implies @option{-mpowerpc64} and
11630@option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11631implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11632
11633@item -mxl-compat
11634@itemx -mno-xl-compat
11635@opindex mxl-compat
11636@opindex mno-xl-compat
11637Produce code that conforms more closely to IBM XL compiler semantics
11638when using AIX-compatible ABI.  Pass floating-point arguments to
11639prototyped functions beyond the register save area (RSA) on the stack
11640in addition to argument FPRs.  Do not assume that most significant
11641double in 128-bit long double value is properly rounded when comparing
11642values and converting to double.  Use XL symbol names for long double
11643support routines.
11644
11645The AIX calling convention was extended but not initially documented to
11646handle an obscure K&R C case of calling a function that takes the
11647address of its arguments with fewer arguments than declared.  IBM XL
11648compilers access floating point arguments which do not fit in the
11649RSA from the stack when a subroutine is compiled without
11650optimization.  Because always storing floating-point arguments on the
11651stack is inefficient and rarely needed, this option is not enabled by
11652default and only is necessary when calling subroutines compiled by IBM
11653XL compilers without optimization.
11654
11655@item -mpe
11656@opindex mpe
11657Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11658application written to use message passing with special startup code to
11659enable the application to run.  The system must have PE installed in the
11660standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11661must be overridden with the @option{-specs=} option to specify the
11662appropriate directory location.  The Parallel Environment does not
11663support threads, so the @option{-mpe} option and the @option{-pthread}
11664option are incompatible.
11665
11666@item -malign-natural
11667@itemx -malign-power
11668@opindex malign-natural
11669@opindex malign-power
11670On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11671@option{-malign-natural} overrides the ABI-defined alignment of larger
11672types, such as floating-point doubles, on their natural size-based boundary.
11673The option @option{-malign-power} instructs GCC to follow the ABI-specified
11674alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11675
11676On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11677is not supported.
11678
11679@item -msoft-float
11680@itemx -mhard-float
11681@opindex msoft-float
11682@opindex mhard-float
11683Generate code that does not use (uses) the floating-point register set.
11684Software floating point emulation is provided if you use the
11685@option{-msoft-float} option, and pass the option to GCC when linking.
11686
11687@item -mmultiple
11688@itemx -mno-multiple
11689@opindex mmultiple
11690@opindex mno-multiple
11691Generate code that uses (does not use) the load multiple word
11692instructions and the store multiple word instructions.  These
11693instructions are generated by default on POWER systems, and not
11694generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11695endian PowerPC systems, since those instructions do not work when the
11696processor is in little endian mode.  The exceptions are PPC740 and
11697PPC750 which permit the instructions usage in little endian mode.
11698
11699@item -mstring
11700@itemx -mno-string
11701@opindex mstring
11702@opindex mno-string
11703Generate code that uses (does not use) the load string instructions
11704and the store string word instructions to save multiple registers and
11705do small block moves.  These instructions are generated by default on
11706POWER systems, and not generated on PowerPC systems.  Do not use
11707@option{-mstring} on little endian PowerPC systems, since those
11708instructions do not work when the processor is in little endian mode.
11709The exceptions are PPC740 and PPC750 which permit the instructions
11710usage in little endian mode.
11711
11712@item -mupdate
11713@itemx -mno-update
11714@opindex mupdate
11715@opindex mno-update
11716Generate code that uses (does not use) the load or store instructions
11717that update the base register to the address of the calculated memory
11718location.  These instructions are generated by default.  If you use
11719@option{-mno-update}, there is a small window between the time that the
11720stack pointer is updated and the address of the previous frame is
11721stored, which means code that walks the stack frame across interrupts or
11722signals may get corrupted data.
11723
11724@item -mfused-madd
11725@itemx -mno-fused-madd
11726@opindex mfused-madd
11727@opindex mno-fused-madd
11728Generate code that uses (does not use) the floating point multiply and
11729accumulate instructions.  These instructions are generated by default if
11730hardware floating is used.
11731
11732@item -mmulhw
11733@itemx -mno-mulhw
11734@opindex mmulhw
11735@opindex mno-mulhw
11736Generate code that uses (does not use) the half-word multiply and
11737multiply-accumulate instructions on the IBM 405 and 440 processors.
11738These instructions are generated by default when targetting those
11739processors.
11740
11741@item -mdlmzb
11742@itemx -mno-dlmzb
11743@opindex mdlmzb
11744@opindex mno-dlmzb
11745Generate code that uses (does not use) the string-search @samp{dlmzb}
11746instruction on the IBM 405 and 440 processors.  This instruction is
11747generated by default when targetting those processors.
11748
11749@item -mno-bit-align
11750@itemx -mbit-align
11751@opindex mno-bit-align
11752@opindex mbit-align
11753On System V.4 and embedded PowerPC systems do not (do) force structures
11754and unions that contain bit-fields to be aligned to the base type of the
11755bit-field.
11756
11757For example, by default a structure containing nothing but 8
11758@code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11759boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11760the structure would be aligned to a 1 byte boundary and be one byte in
11761size.
11762
11763@item -mno-strict-align
11764@itemx -mstrict-align
11765@opindex mno-strict-align
11766@opindex mstrict-align
11767On System V.4 and embedded PowerPC systems do not (do) assume that
11768unaligned memory references will be handled by the system.
11769
11770@item -mrelocatable
11771@itemx -mno-relocatable
11772@opindex mrelocatable
11773@opindex mno-relocatable
11774On embedded PowerPC systems generate code that allows (does not allow)
11775the program to be relocated to a different address at runtime.  If you
11776use @option{-mrelocatable} on any module, all objects linked together must
11777be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11778
11779@item -mrelocatable-lib
11780@itemx -mno-relocatable-lib
11781@opindex mrelocatable-lib
11782@opindex mno-relocatable-lib
11783On embedded PowerPC systems generate code that allows (does not allow)
11784the program to be relocated to a different address at runtime.  Modules
11785compiled with @option{-mrelocatable-lib} can be linked with either modules
11786compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11787with modules compiled with the @option{-mrelocatable} options.
11788
11789@item -mno-toc
11790@itemx -mtoc
11791@opindex mno-toc
11792@opindex mtoc
11793On System V.4 and embedded PowerPC systems do not (do) assume that
11794register 2 contains a pointer to a global area pointing to the addresses
11795used in the program.
11796
11797@item -mlittle
11798@itemx -mlittle-endian
11799@opindex mlittle
11800@opindex mlittle-endian
11801On System V.4 and embedded PowerPC systems compile code for the
11802processor in little endian mode.  The @option{-mlittle-endian} option is
11803the same as @option{-mlittle}.
11804
11805@item -mbig
11806@itemx -mbig-endian
11807@opindex mbig
11808@opindex mbig-endian
11809On System V.4 and embedded PowerPC systems compile code for the
11810processor in big endian mode.  The @option{-mbig-endian} option is
11811the same as @option{-mbig}.
11812
11813@item -mdynamic-no-pic
11814@opindex mdynamic-no-pic
11815On Darwin and Mac OS X systems, compile code so that it is not
11816relocatable, but that its external references are relocatable.  The
11817resulting code is suitable for applications, but not shared
11818libraries.
11819
11820@item -mprioritize-restricted-insns=@var{priority}
11821@opindex mprioritize-restricted-insns
11822This option controls the priority that is assigned to
11823dispatch-slot restricted instructions during the second scheduling
11824pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11825@var{no/highest/second-highest} priority to dispatch slot restricted
11826instructions.
11827
11828@item -msched-costly-dep=@var{dependence_type}
11829@opindex msched-costly-dep
11830This option controls which dependences are considered costly
11831by the target during instruction scheduling.  The argument
11832@var{dependence_type} takes one of the following values:
11833@var{no}: no dependence is costly,
11834@var{all}: all dependences are costly,
11835@var{true_store_to_load}: a true dependence from store to load is costly,
11836@var{store_to_load}: any dependence from store to load is costly,
11837@var{number}: any dependence which latency >= @var{number} is costly.
11838
11839@item -minsert-sched-nops=@var{scheme}
11840@opindex minsert-sched-nops
11841This option controls which nop insertion scheme will be used during
11842the second scheduling pass.  The argument @var{scheme} takes one of the
11843following values:
11844@var{no}: Don't insert nops.
11845@var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11846according to the scheduler's grouping.
11847@var{regroup_exact}: Insert nops to force costly dependent insns into
11848separate groups.  Insert exactly as many nops as needed to force an insn
11849to a new group, according to the estimated processor grouping.
11850@var{number}: Insert nops to force costly dependent insns into
11851separate groups.  Insert @var{number} nops to force an insn to a new group.
11852
11853@item -mcall-sysv
11854@opindex mcall-sysv
11855On System V.4 and embedded PowerPC systems compile code using calling
11856conventions that adheres to the March 1995 draft of the System V
11857Application Binary Interface, PowerPC processor supplement.  This is the
11858default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11859
11860@item -mcall-sysv-eabi
11861@opindex mcall-sysv-eabi
11862Specify both @option{-mcall-sysv} and @option{-meabi} options.
11863
11864@item -mcall-sysv-noeabi
11865@opindex mcall-sysv-noeabi
11866Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11867
11868@item -mcall-solaris
11869@opindex mcall-solaris
11870On System V.4 and embedded PowerPC systems compile code for the Solaris
11871operating system.
11872
11873@item -mcall-linux
11874@opindex mcall-linux
11875On System V.4 and embedded PowerPC systems compile code for the
11876Linux-based GNU system.
11877
11878@item -mcall-gnu
11879@opindex mcall-gnu
11880On System V.4 and embedded PowerPC systems compile code for the
11881Hurd-based GNU system.
11882
11883@item -mcall-netbsd
11884@opindex mcall-netbsd
11885On System V.4 and embedded PowerPC systems compile code for the
11886NetBSD operating system.
11887
11888@item -maix-struct-return
11889@opindex maix-struct-return
11890Return all structures in memory (as specified by the AIX ABI)@.
11891
11892@item -msvr4-struct-return
11893@opindex msvr4-struct-return
11894Return structures smaller than 8 bytes in registers (as specified by the
11895SVR4 ABI)@.
11896
11897@item -mabi=@var{abi-type}
11898@opindex mabi
11899Extend the current ABI with a particular extension, or remove such extension.
11900Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11901@var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11902
11903@item -mabi=spe
11904@opindex mabi=spe
11905Extend the current ABI with SPE ABI extensions.  This does not change
11906the default ABI, instead it adds the SPE ABI extensions to the current
11907ABI@.
11908
11909@item -mabi=no-spe
11910@opindex mabi=no-spe
11911Disable Booke SPE ABI extensions for the current ABI@.
11912
11913@item -mabi=ibmlongdouble
11914@opindex mabi=ibmlongdouble
11915Change the current ABI to use IBM extended precision long double.
11916This is a PowerPC 32-bit SYSV ABI option.
11917
11918@item -mabi=ieeelongdouble
11919@opindex mabi=ieeelongdouble
11920Change the current ABI to use IEEE extended precision long double.
11921This is a PowerPC 32-bit Linux ABI option.
11922
11923@item -mprototype
11924@itemx -mno-prototype
11925@opindex mprototype
11926@opindex mno-prototype
11927On System V.4 and embedded PowerPC systems assume that all calls to
11928variable argument functions are properly prototyped.  Otherwise, the
11929compiler must insert an instruction before every non prototyped call to
11930set or clear bit 6 of the condition code register (@var{CR}) to
11931indicate whether floating point values were passed in the floating point
11932registers in case the function takes a variable arguments.  With
11933@option{-mprototype}, only calls to prototyped variable argument functions
11934will set or clear the bit.
11935
11936@item -msim
11937@opindex msim
11938On embedded PowerPC systems, assume that the startup module is called
11939@file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11940@file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11941configurations.
11942
11943@item -mmvme
11944@opindex mmvme
11945On embedded PowerPC systems, assume that the startup module is called
11946@file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11947@file{libc.a}.
11948
11949@item -mads
11950@opindex mads
11951On embedded PowerPC systems, assume that the startup module is called
11952@file{crt0.o} and the standard C libraries are @file{libads.a} and
11953@file{libc.a}.
11954
11955@item -myellowknife
11956@opindex myellowknife
11957On embedded PowerPC systems, assume that the startup module is called
11958@file{crt0.o} and the standard C libraries are @file{libyk.a} and
11959@file{libc.a}.
11960
11961@item -mvxworks
11962@opindex mvxworks
11963On System V.4 and embedded PowerPC systems, specify that you are
11964compiling for a VxWorks system.
11965
11966@item -mwindiss
11967@opindex mwindiss
11968Specify that you are compiling for the WindISS simulation environment.
11969
11970@item -memb
11971@opindex memb
11972On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11973header to indicate that @samp{eabi} extended relocations are used.
11974
11975@item -meabi
11976@itemx -mno-eabi
11977@opindex meabi
11978@opindex mno-eabi
11979On System V.4 and embedded PowerPC systems do (do not) adhere to the
11980Embedded Applications Binary Interface (eabi) which is a set of
11981modifications to the System V.4 specifications.  Selecting @option{-meabi}
11982means that the stack is aligned to an 8 byte boundary, a function
11983@code{__eabi} is called to from @code{main} to set up the eabi
11984environment, and the @option{-msdata} option can use both @code{r2} and
11985@code{r13} to point to two separate small data areas.  Selecting
11986@option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11987do not call an initialization function from @code{main}, and the
11988@option{-msdata} option will only use @code{r13} to point to a single
11989small data area.  The @option{-meabi} option is on by default if you
11990configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11991
11992@item -msdata=eabi
11993@opindex msdata=eabi
11994On System V.4 and embedded PowerPC systems, put small initialized
11995@code{const} global and static data in the @samp{.sdata2} section, which
11996is pointed to by register @code{r2}.  Put small initialized
11997non-@code{const} global and static data in the @samp{.sdata} section,
11998which is pointed to by register @code{r13}.  Put small uninitialized
11999global and static data in the @samp{.sbss} section, which is adjacent to
12000the @samp{.sdata} section.  The @option{-msdata=eabi} option is
12001incompatible with the @option{-mrelocatable} option.  The
12002@option{-msdata=eabi} option also sets the @option{-memb} option.
12003
12004@item -msdata=sysv
12005@opindex msdata=sysv
12006On System V.4 and embedded PowerPC systems, put small global and static
12007data in the @samp{.sdata} section, which is pointed to by register
12008@code{r13}.  Put small uninitialized global and static data in the
12009@samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
12010The @option{-msdata=sysv} option is incompatible with the
12011@option{-mrelocatable} option.
12012
12013@item -msdata=default
12014@itemx -msdata
12015@opindex msdata=default
12016@opindex msdata
12017On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
12018compile code the same as @option{-msdata=eabi}, otherwise compile code the
12019same as @option{-msdata=sysv}.
12020
12021@item -msdata-data
12022@opindex msdata-data
12023On System V.4 and embedded PowerPC systems, put small global
12024data in the @samp{.sdata} section.  Put small uninitialized global
12025data in the @samp{.sbss} section.  Do not use register @code{r13}
12026to address small data however.  This is the default behavior unless
12027other @option{-msdata} options are used.
12028
12029@item -msdata=none
12030@itemx -mno-sdata
12031@opindex msdata=none
12032@opindex mno-sdata
12033On embedded PowerPC systems, put all initialized global and static data
12034in the @samp{.data} section, and all uninitialized data in the
12035@samp{.bss} section.
12036
12037@item -G @var{num}
12038@opindex G
12039@cindex smaller data references (PowerPC)
12040@cindex .sdata/.sdata2 references (PowerPC)
12041On embedded PowerPC systems, put global and static items less than or
12042equal to @var{num} bytes into the small data or bss sections instead of
12043the normal data or bss section.  By default, @var{num} is 8.  The
12044@option{-G @var{num}} switch is also passed to the linker.
12045All modules should be compiled with the same @option{-G @var{num}} value.
12046
12047@item -mregnames
12048@itemx -mno-regnames
12049@opindex mregnames
12050@opindex mno-regnames
12051On System V.4 and embedded PowerPC systems do (do not) emit register
12052names in the assembly language output using symbolic forms.
12053
12054@item -mlongcall
12055@itemx -mno-longcall
12056@opindex mlongcall
12057@opindex mno-longcall
12058By default assume that all calls are far away so that a longer more
12059expensive calling sequence is required.  This is required for calls
12060further than 32 megabytes (33,554,432 bytes) from the current location.
12061A short call will be generated if the compiler knows
12062the call cannot be that far away.  This setting can be overridden by
12063the @code{shortcall} function attribute, or by @code{#pragma
12064longcall(0)}.
12065
12066Some linkers are capable of detecting out-of-range calls and generating
12067glue code on the fly.  On these systems, long calls are unnecessary and
12068generate slower code.  As of this writing, the AIX linker can do this,
12069as can the GNU linker for PowerPC/64.  It is planned to add this feature
12070to the GNU linker for 32-bit PowerPC systems as well.
12071
12072On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
12073callee, L42'', plus a ``branch island'' (glue code).  The two target
12074addresses represent the callee and the ``branch island''.  The
12075Darwin/PPC linker will prefer the first address and generate a ``bl
12076callee'' if the PPC ``bl'' instruction will reach the callee directly;
12077otherwise, the linker will generate ``bl L42'' to call the ``branch
12078island''.  The ``branch island'' is appended to the body of the
12079calling function; it computes the full 32-bit address of the callee
12080and jumps to it.
12081
12082On Mach-O (Darwin) systems, this option directs the compiler emit to
12083the glue for every direct call, and the Darwin linker decides whether
12084to use or discard it.
12085
12086In the future, we may cause GCC to ignore all longcall specifications
12087when the linker is known to generate glue.
12088
12089@item -pthread
12090@opindex pthread
12091Adds support for multithreading with the @dfn{pthreads} library.
12092This option sets flags for both the preprocessor and linker.
12093
12094@end table
12095
12096@node S/390 and zSeries Options
12097@subsection S/390 and zSeries Options
12098@cindex S/390 and zSeries Options
12099
12100These are the @samp{-m} options defined for the S/390 and zSeries architecture.
12101
12102@table @gcctabopt
12103@item -mhard-float
12104@itemx -msoft-float
12105@opindex mhard-float
12106@opindex msoft-float
12107Use (do not use) the hardware floating-point instructions and registers
12108for floating-point operations.  When @option{-msoft-float} is specified,
12109functions in @file{libgcc.a} will be used to perform floating-point
12110operations.  When @option{-mhard-float} is specified, the compiler
12111generates IEEE floating-point instructions.  This is the default.
12112
12113@item -mlong-double-64
12114@itemx -mlong-double-128
12115@opindex mlong-double-64
12116@opindex mlong-double-128
12117These switches control the size of @code{long double} type. A size
12118of 64bit makes the @code{long double} type equivalent to the @code{double}
12119type. This is the default.
12120
12121@item -mbackchain
12122@itemx -mno-backchain
12123@opindex mbackchain
12124@opindex mno-backchain
12125Store (do not store) the address of the caller's frame as backchain pointer
12126into the callee's stack frame.
12127A backchain may be needed to allow debugging using tools that do not understand
12128DWARF-2 call frame information.
12129When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
12130at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
12131the backchain is placed into the topmost word of the 96/160 byte register
12132save area.
12133
12134In general, code compiled with @option{-mbackchain} is call-compatible with
12135code compiled with @option{-mmo-backchain}; however, use of the backchain
12136for debugging purposes usually requires that the whole binary is built with
12137@option{-mbackchain}.  Note that the combination of @option{-mbackchain},
12138@option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12139to build a linux kernel use @option{-msoft-float}.
12140
12141The default is to not maintain the backchain.
12142
12143@item -mpacked-stack
12144@item -mno-packed-stack
12145@opindex mpacked-stack
12146@opindex mno-packed-stack
12147Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
12148specified, the compiler uses the all fields of the 96/160 byte register save
12149area only for their default purpose; unused fields still take up stack space.
12150When @option{-mpacked-stack} is specified, register save slots are densely
12151packed at the top of the register save area; unused space is reused for other
12152purposes, allowing for more efficient use of the available stack space.
12153However, when @option{-mbackchain} is also in effect, the topmost word of
12154the save area is always used to store the backchain, and the return address
12155register is always saved two words below the backchain.
12156
12157As long as the stack frame backchain is not used, code generated with
12158@option{-mpacked-stack} is call-compatible with code generated with
12159@option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
12160S/390 or zSeries generated code that uses the stack frame backchain at run
12161time, not just for debugging purposes.  Such code is not call-compatible
12162with code compiled with @option{-mpacked-stack}.  Also, note that the
12163combination of @option{-mbackchain},
12164@option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12165to build a linux kernel use @option{-msoft-float}.
12166
12167The default is to not use the packed stack layout.
12168
12169@item -msmall-exec
12170@itemx -mno-small-exec
12171@opindex msmall-exec
12172@opindex mno-small-exec
12173Generate (or do not generate) code using the @code{bras} instruction
12174to do subroutine calls.
12175This only works reliably if the total executable size does not
12176exceed 64k.  The default is to use the @code{basr} instruction instead,
12177which does not have this limitation.
12178
12179@item -m64
12180@itemx -m31
12181@opindex m64
12182@opindex m31
12183When @option{-m31} is specified, generate code compliant to the
12184GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
12185code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
12186particular to generate 64-bit instructions.  For the @samp{s390}
12187targets, the default is @option{-m31}, while the @samp{s390x}
12188targets default to @option{-m64}.
12189
12190@item -mzarch
12191@itemx -mesa
12192@opindex mzarch
12193@opindex mesa
12194When @option{-mzarch} is specified, generate code using the
12195instructions available on z/Architecture.
12196When @option{-mesa} is specified, generate code using the
12197instructions available on ESA/390.  Note that @option{-mesa} is
12198not possible with @option{-m64}.
12199When generating code compliant to the GNU/Linux for S/390 ABI,
12200the default is @option{-mesa}.  When generating code compliant
12201to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
12202
12203@item -mmvcle
12204@itemx -mno-mvcle
12205@opindex mmvcle
12206@opindex mno-mvcle
12207Generate (or do not generate) code using the @code{mvcle} instruction
12208to perform block moves.  When @option{-mno-mvcle} is specified,
12209use a @code{mvc} loop instead.  This is the default unless optimizing for
12210size.
12211
12212@item -mdebug
12213@itemx -mno-debug
12214@opindex mdebug
12215@opindex mno-debug
12216Print (or do not print) additional debug information when compiling.
12217The default is to not print debug information.
12218
12219@item -march=@var{cpu-type}
12220@opindex march
12221Generate code that will run on @var{cpu-type}, which is the name of a system
12222representing a certain processor type.  Possible values for
12223@var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
12224When generating code using the instructions available on z/Architecture,
12225the default is @option{-march=z900}.  Otherwise, the default is
12226@option{-march=g5}.
12227
12228@item -mtune=@var{cpu-type}
12229@opindex mtune
12230Tune to @var{cpu-type} everything applicable about the generated code,
12231except for the ABI and the set of available instructions.
12232The list of @var{cpu-type} values is the same as for @option{-march}.
12233The default is the value used for @option{-march}.
12234
12235@item -mtpf-trace
12236@itemx -mno-tpf-trace
12237@opindex mtpf-trace
12238@opindex mno-tpf-trace
12239Generate code that adds (does not add) in TPF OS specific branches to trace
12240routines in the operating system.  This option is off by default, even
12241when compiling for the TPF OS@.
12242
12243@item -mfused-madd
12244@itemx -mno-fused-madd
12245@opindex mfused-madd
12246@opindex mno-fused-madd
12247Generate code that uses (does not use) the floating point multiply and
12248accumulate instructions.  These instructions are generated by default if
12249hardware floating point is used.
12250
12251@item -mwarn-framesize=@var{framesize}
12252@opindex mwarn-framesize
12253Emit a warning if the current function exceeds the given frame size.  Because
12254this is a compile time check it doesn't need to be a real problem when the program
12255runs.  It is intended to identify functions which most probably cause
12256a stack overflow.  It is useful to be used in an environment with limited stack
12257size e.g.@: the linux kernel.
12258
12259@item -mwarn-dynamicstack
12260@opindex mwarn-dynamicstack
12261Emit a warning if the function calls alloca or uses dynamically
12262sized arrays.  This is generally a bad idea with a limited stack size.
12263
12264@item -mstack-guard=@var{stack-guard}
12265@item -mstack-size=@var{stack-size}
12266@opindex mstack-guard
12267@opindex mstack-size
12268These arguments always have to be used in conjunction.  If they are present the s390
12269back end emits additional instructions in the function prologue which trigger a trap
12270if the stack size is @var{stack-guard} bytes above the @var{stack-size}
12271(remember that the stack on s390 grows downward).  These options are intended to
12272be used to help debugging stack overflow problems.  The additionally emitted code
12273causes only little overhead and hence can also be used in production like systems
12274without greater performance degradation.  The given values have to be exact
12275powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
12276exceeding 64k.
12277In order to be efficient the extra code makes the assumption that the stack starts
12278at an address aligned to the value given by @var{stack-size}.
12279@end table
12280
12281@node Score Options
12282@subsection Score Options
12283@cindex Score Options
12284
12285These options are defined for Score implementations:
12286
12287@table @gcctabopt
12288@item -meb
12289@opindex meb
12290Compile code for big endian mode.  This is the default.
12291
12292@item -mel
12293@opindex mel
12294Compile code for little endian mode.
12295
12296@item -mnhwloop
12297@opindex mnhwloop
12298Disable generate bcnz instruction.
12299
12300@item -muls
12301@opindex muls
12302Enable generate unaligned load and store instruction.
12303
12304@item -mmac
12305@opindex mmac
12306Enable the use of multiply-accumulate instructions. Disabled by default.
12307
12308@item -mscore5
12309@opindex mscore5
12310Specify the SCORE5 as the target architecture.
12311
12312@item -mscore5u
12313@opindex mscore5u
12314Specify the SCORE5U of the target architecture.
12315
12316@item -mscore7
12317@opindex mscore7
12318Specify the SCORE7 as the target architecture. This is the default.
12319
12320@item -mscore7d
12321@opindex mscore7d
12322Specify the SCORE7D as the target architecture.
12323@end table
12324
12325@node SH Options
12326@subsection SH Options
12327
12328These @samp{-m} options are defined for the SH implementations:
12329
12330@table @gcctabopt
12331@item -m1
12332@opindex m1
12333Generate code for the SH1.
12334
12335@item -m2
12336@opindex m2
12337Generate code for the SH2.
12338
12339@item -m2e
12340Generate code for the SH2e.
12341
12342@item -m3
12343@opindex m3
12344Generate code for the SH3.
12345
12346@item -m3e
12347@opindex m3e
12348Generate code for the SH3e.
12349
12350@item -m4-nofpu
12351@opindex m4-nofpu
12352Generate code for the SH4 without a floating-point unit.
12353
12354@item -m4-single-only
12355@opindex m4-single-only
12356Generate code for the SH4 with a floating-point unit that only
12357supports single-precision arithmetic.
12358
12359@item -m4-single
12360@opindex m4-single
12361Generate code for the SH4 assuming the floating-point unit is in
12362single-precision mode by default.
12363
12364@item -m4
12365@opindex m4
12366Generate code for the SH4.
12367
12368@item -m4a-nofpu
12369@opindex m4a-nofpu
12370Generate code for the SH4al-dsp, or for a SH4a in such a way that the
12371floating-point unit is not used.
12372
12373@item -m4a-single-only
12374@opindex m4a-single-only
12375Generate code for the SH4a, in such a way that no double-precision
12376floating point operations are used.
12377
12378@item -m4a-single
12379@opindex m4a-single
12380Generate code for the SH4a assuming the floating-point unit is in
12381single-precision mode by default.
12382
12383@item -m4a
12384@opindex m4a
12385Generate code for the SH4a.
12386
12387@item -m4al
12388@opindex m4al
12389Same as @option{-m4a-nofpu}, except that it implicitly passes
12390@option{-dsp} to the assembler.  GCC doesn't generate any DSP
12391instructions at the moment.
12392
12393@item -mb
12394@opindex mb
12395Compile code for the processor in big endian mode.
12396
12397@item -ml
12398@opindex ml
12399Compile code for the processor in little endian mode.
12400
12401@item -mdalign
12402@opindex mdalign
12403Align doubles at 64-bit boundaries.  Note that this changes the calling
12404conventions, and thus some functions from the standard C library will
12405not work unless you recompile it first with @option{-mdalign}.
12406
12407@item -mrelax
12408@opindex mrelax
12409Shorten some address references at link time, when possible; uses the
12410linker option @option{-relax}.
12411
12412@item -mbigtable
12413@opindex mbigtable
12414Use 32-bit offsets in @code{switch} tables.  The default is to use
1241516-bit offsets.
12416
12417@item -mfmovd
12418@opindex mfmovd
12419Enable the use of the instruction @code{fmovd}.
12420
12421@item -mhitachi
12422@opindex mhitachi
12423Comply with the calling conventions defined by Renesas.
12424
12425@item -mrenesas
12426@opindex mhitachi
12427Comply with the calling conventions defined by Renesas.
12428
12429@item -mno-renesas
12430@opindex mhitachi
12431Comply with the calling conventions defined for GCC before the Renesas
12432conventions were available.  This option is the default for all
12433targets of the SH toolchain except for @samp{sh-symbianelf}.
12434
12435@item -mnomacsave
12436@opindex mnomacsave
12437Mark the @code{MAC} register as call-clobbered, even if
12438@option{-mhitachi} is given.
12439
12440@item -mieee
12441@opindex mieee
12442Increase IEEE-compliance of floating-point code.
12443At the moment, this is equivalent to @option{-fno-finite-math-only}.
12444When generating 16 bit SH opcodes, getting IEEE-conforming results for
12445comparisons of NANs / infinities incurs extra overhead in every
12446floating point comparison, therefore the default is set to
12447@option{-ffinite-math-only}.
12448
12449@item -misize
12450@opindex misize
12451Dump instruction size and location in the assembly code.
12452
12453@item -mpadstruct
12454@opindex mpadstruct
12455This option is deprecated.  It pads structures to multiple of 4 bytes,
12456which is incompatible with the SH ABI@.
12457
12458@item -mspace
12459@opindex mspace
12460Optimize for space instead of speed.  Implied by @option{-Os}.
12461
12462@item -mprefergot
12463@opindex mprefergot
12464When generating position-independent code, emit function calls using
12465the Global Offset Table instead of the Procedure Linkage Table.
12466
12467@item -musermode
12468@opindex musermode
12469Generate a library function call to invalidate instruction cache
12470entries, after fixing up a trampoline.  This library function call
12471doesn't assume it can write to the whole memory address space.  This
12472is the default when the target is @code{sh-*-linux*}.
12473
12474@item -multcost=@var{number}
12475@opindex multcost=@var{number}
12476Set the cost to assume for a multiply insn.
12477
12478@item -mdiv=@var{strategy}
12479@opindex mdiv=@var{strategy}
12480Set the division strategy to use for SHmedia code.  @var{strategy} must be
12481one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12482inv:call2, inv:fp .
12483"fp" performs the operation in floating point.  This has a very high latency,
12484but needs only a few instructions, so it might be a good choice if
12485your code has enough easily exploitable ILP to allow the compiler to
12486schedule the floating point instructions together with other instructions.
12487Division by zero causes a floating point exception.
12488"inv" uses integer operations to calculate the inverse of the divisor,
12489and then multiplies the dividend with the inverse.  This strategy allows
12490cse and hoisting of the inverse calculation.  Division by zero calculates
12491an unspecified result, but does not trap.
12492"inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12493have been found, or if the entire operation has been hoisted to the same
12494place, the last stages of the inverse calculation are intertwined with the
12495final multiply to reduce the overall latency, at the expense of using a few
12496more instructions, and thus offering fewer scheduling opportunities with
12497other code.
12498"call" calls a library function that usually implements the inv:minlat
12499strategy.
12500This gives high code density for m5-*media-nofpu compilations.
12501"call2" uses a different entry point of the same library function, where it
12502assumes that a pointer to a lookup table has already been set up, which
12503exposes the pointer load to cse / code hoisting optimizations.
12504"inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12505code generation, but if the code stays unoptimized, revert to the "call",
12506"call2", or "fp" strategies, respectively.  Note that the
12507potentially-trapping side effect of division by zero is carried by a
12508separate instruction, so it is possible that all the integer instructions
12509are hoisted out, but the marker for the side effect stays where it is.
12510A recombination to fp operations or a call is not possible in that case.
12511"inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12512that the inverse calculation was nor separated from the multiply, they speed
12513up division where the dividend fits into 20 bits (plus sign where applicable),
12514by inserting a test to skip a number of operations in this case; this test
12515slows down the case of larger dividends.  inv20u assumes the case of a such
12516a small dividend to be unlikely, and inv20l assumes it to be likely.
12517
12518@item -mdivsi3_libfunc=@var{name}
12519@opindex mdivsi3_libfunc=@var{name}
12520Set the name of the library function used for 32 bit signed division to
12521@var{name}.  This only affect the name used in the call and inv:call
12522division strategies, and the compiler will still expect the same
12523sets of input/output/clobbered registers as if this option was not present.
12524
12525@item -madjust-unroll
12526@opindex madjust-unroll
12527Throttle unrolling to avoid thrashing target registers.
12528This option only has an effect if the gcc code base supports the
12529TARGET_ADJUST_UNROLL_MAX target hook.
12530
12531@item -mindexed-addressing
12532@opindex mindexed-addressing
12533Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12534This is only safe if the hardware and/or OS implement 32 bit wrap-around
12535semantics for the indexed addressing mode.  The architecture allows the
12536implementation of processors with 64 bit MMU, which the OS could use to
12537get 32 bit addressing, but since no current hardware implementation supports
12538this or any other way to make the indexed addressing mode safe to use in
12539the 32 bit ABI, the default is -mno-indexed-addressing.
12540
12541@item -mgettrcost=@var{number}
12542@opindex mgettrcost=@var{number}
12543Set the cost assumed for the gettr instruction to @var{number}.
12544The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12545
12546@item -mpt-fixed
12547@opindex mpt-fixed
12548Assume pt* instructions won't trap.  This will generally generate better
12549scheduled code, but is unsafe on current hardware.  The current architecture
12550definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12551This has the unintentional effect of making it unsafe to schedule ptabs /
12552ptrel before a branch, or hoist it out of a loop.  For example,
12553__do_global_ctors, a part of libgcc that runs constructors at program
12554startup, calls functions in a list which is delimited by -1.  With the
12555-mpt-fixed option, the ptabs will be done before testing against -1.
12556That means that all the constructors will be run a bit quicker, but when
12557the loop comes to the end of the list, the program crashes because ptabs
12558loads -1 into a target register.  Since this option is unsafe for any
12559hardware implementing the current architecture specification, the default
12560is -mno-pt-fixed.  Unless the user specifies a specific cost with
12561@option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12562this deters register allocation using target registers for storing
12563ordinary integers.
12564
12565@item -minvalid-symbols
12566@opindex minvalid-symbols
12567Assume symbols might be invalid.  Ordinary function symbols generated by
12568the compiler will always be valid to load with movi/shori/ptabs or
12569movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12570to generate symbols that will cause ptabs / ptrel to trap.
12571This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12572It will then prevent cross-basic-block cse, hoisting and most scheduling
12573of symbol loads.  The default is @option{-mno-invalid-symbols}.
12574@end table
12575
12576@node SPARC Options
12577@subsection SPARC Options
12578@cindex SPARC options
12579
12580These @samp{-m} options are supported on the SPARC:
12581
12582@table @gcctabopt
12583@item -mno-app-regs
12584@itemx -mapp-regs
12585@opindex mno-app-regs
12586@opindex mapp-regs
12587Specify @option{-mapp-regs} to generate output using the global registers
125882 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12589is the default.
12590
12591To be fully SVR4 ABI compliant at the cost of some performance loss,
12592specify @option{-mno-app-regs}.  You should compile libraries and system
12593software with this option.
12594
12595@item -mfpu
12596@itemx -mhard-float
12597@opindex mfpu
12598@opindex mhard-float
12599Generate output containing floating point instructions.  This is the
12600default.
12601
12602@item -mno-fpu
12603@itemx -msoft-float
12604@opindex mno-fpu
12605@opindex msoft-float
12606Generate output containing library calls for floating point.
12607@strong{Warning:} the requisite libraries are not available for all SPARC
12608targets.  Normally the facilities of the machine's usual C compiler are
12609used, but this cannot be done directly in cross-compilation.  You must make
12610your own arrangements to provide suitable library functions for
12611cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12612@samp{sparclite-*-*} do provide software floating point support.
12613
12614@option{-msoft-float} changes the calling convention in the output file;
12615therefore, it is only useful if you compile @emph{all} of a program with
12616this option.  In particular, you need to compile @file{libgcc.a}, the
12617library that comes with GCC, with @option{-msoft-float} in order for
12618this to work.
12619
12620@item -mhard-quad-float
12621@opindex mhard-quad-float
12622Generate output containing quad-word (long double) floating point
12623instructions.
12624
12625@item -msoft-quad-float
12626@opindex msoft-quad-float
12627Generate output containing library calls for quad-word (long double)
12628floating point instructions.  The functions called are those specified
12629in the SPARC ABI@.  This is the default.
12630
12631As of this writing, there are no SPARC implementations that have hardware
12632support for the quad-word floating point instructions.  They all invoke
12633a trap handler for one of these instructions, and then the trap handler
12634emulates the effect of the instruction.  Because of the trap handler overhead,
12635this is much slower than calling the ABI library routines.  Thus the
12636@option{-msoft-quad-float} option is the default.
12637
12638@item -mno-unaligned-doubles
12639@itemx -munaligned-doubles
12640@opindex mno-unaligned-doubles
12641@opindex munaligned-doubles
12642Assume that doubles have 8 byte alignment.  This is the default.
12643
12644With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12645alignment only if they are contained in another type, or if they have an
12646absolute address.  Otherwise, it assumes they have 4 byte alignment.
12647Specifying this option avoids some rare compatibility problems with code
12648generated by other compilers.  It is not the default because it results
12649in a performance loss, especially for floating point code.
12650
12651@item -mno-faster-structs
12652@itemx -mfaster-structs
12653@opindex mno-faster-structs
12654@opindex mfaster-structs
12655With @option{-mfaster-structs}, the compiler assumes that structures
12656should have 8 byte alignment.  This enables the use of pairs of
12657@code{ldd} and @code{std} instructions for copies in structure
12658assignment, in place of twice as many @code{ld} and @code{st} pairs.
12659However, the use of this changed alignment directly violates the SPARC
12660ABI@.  Thus, it's intended only for use on targets where the developer
12661acknowledges that their resulting code will not be directly in line with
12662the rules of the ABI@.
12663
12664@item -mimpure-text
12665@opindex mimpure-text
12666@option{-mimpure-text}, used in addition to @option{-shared}, tells
12667the compiler to not pass @option{-z text} to the linker when linking a
12668shared object.  Using this option, you can link position-dependent
12669code into a shared object.
12670
12671@option{-mimpure-text} suppresses the ``relocations remain against
12672allocatable but non-writable sections'' linker error message.
12673However, the necessary relocations will trigger copy-on-write, and the
12674shared object is not actually shared across processes.  Instead of
12675using @option{-mimpure-text}, you should compile all source code with
12676@option{-fpic} or @option{-fPIC}.
12677
12678This option is only available on SunOS and Solaris.
12679
12680@item -mcpu=@var{cpu_type}
12681@opindex mcpu
12682Set the instruction set, register set, and instruction scheduling parameters
12683for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12684@samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12685@samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12686@samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
12687@samp{ultrasparc3}, and @samp{niagara}.
12688
12689Default instruction scheduling parameters are used for values that select
12690an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12691@samp{sparclite}, @samp{sparclet}, @samp{v9}.
12692
12693Here is a list of each supported architecture and their supported
12694implementations.
12695
12696@smallexample
12697    v7:             cypress
12698    v8:             supersparc, hypersparc
12699    sparclite:      f930, f934, sparclite86x
12700    sparclet:       tsc701
12701    v9:             ultrasparc, ultrasparc3, niagara
12702@end smallexample
12703
12704By default (unless configured otherwise), GCC generates code for the V7
12705variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12706additionally optimizes it for the Cypress CY7C602 chip, as used in the
12707SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12708SPARCStation 1, 2, IPX etc.
12709
12710With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12711architecture.  The only difference from V7 code is that the compiler emits
12712the integer multiply and integer divide instructions which exist in SPARC-V8
12713but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12714optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
127152000 series.
12716
12717With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12718the SPARC architecture.  This adds the integer multiply, integer divide step
12719and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12720With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12721Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12722@option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12723MB86934 chip, which is the more recent SPARClite with FPU@.
12724
12725With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12726the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12727integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12728but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12729optimizes it for the TEMIC SPARClet chip.
12730
12731With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12732architecture.  This adds 64-bit integer and floating-point move instructions,
127333 additional floating-point condition code registers and conditional move
12734instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12735optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
12736@option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12737Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
12738@option{-mcpu=niagara}, the compiler additionally optimizes it for
12739Sun UltraSPARC T1 chips.
12740
12741@item -mtune=@var{cpu_type}
12742@opindex mtune
12743Set the instruction scheduling parameters for machine type
12744@var{cpu_type}, but do not set the instruction set or register set that the
12745option @option{-mcpu=@var{cpu_type}} would.
12746
12747The same values for @option{-mcpu=@var{cpu_type}} can be used for
12748@option{-mtune=@var{cpu_type}}, but the only useful values are those
12749that select a particular cpu implementation.  Those are @samp{cypress},
12750@samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12751@samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
12752@samp{ultrasparc3}, and @samp{niagara}.
12753
12754@item -mv8plus
12755@itemx -mno-v8plus
12756@opindex mv8plus
12757@opindex mno-v8plus
12758With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12759difference from the V8 ABI is that the global and out registers are
12760considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12761mode for all SPARC-V9 processors.
12762
12763@item -mvis
12764@itemx -mno-vis
12765@opindex mvis
12766@opindex mno-vis
12767With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12768Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12769@end table
12770
12771These @samp{-m} options are supported in addition to the above
12772on SPARC-V9 processors in 64-bit environments:
12773
12774@table @gcctabopt
12775@item -mlittle-endian
12776@opindex mlittle-endian
12777Generate code for a processor running in little-endian mode.  It is only
12778available for a few configurations and most notably not on Solaris and Linux.
12779
12780@item -m32
12781@itemx -m64
12782@opindex m32
12783@opindex m64
12784Generate code for a 32-bit or 64-bit environment.
12785The 32-bit environment sets int, long and pointer to 32 bits.
12786The 64-bit environment sets int to 32 bits and long and pointer
12787to 64 bits.
12788
12789@item -mcmodel=medlow
12790@opindex mcmodel=medlow
12791Generate code for the Medium/Low code model: 64-bit addresses, programs
12792must be linked in the low 32 bits of memory.  Programs can be statically
12793or dynamically linked.
12794
12795@item -mcmodel=medmid
12796@opindex mcmodel=medmid
12797Generate code for the Medium/Middle code model: 64-bit addresses, programs
12798must be linked in the low 44 bits of memory, the text and data segments must
12799be less than 2GB in size and the data segment must be located within 2GB of
12800the text segment.
12801
12802@item -mcmodel=medany
12803@opindex mcmodel=medany
12804Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12805may be linked anywhere in memory, the text and data segments must be less
12806than 2GB in size and the data segment must be located within 2GB of the
12807text segment.
12808
12809@item -mcmodel=embmedany
12810@opindex mcmodel=embmedany
12811Generate code for the Medium/Anywhere code model for embedded systems:
1281264-bit addresses, the text and data segments must be less than 2GB in
12813size, both starting anywhere in memory (determined at link time).  The
12814global register %g4 points to the base of the data segment.  Programs
12815are statically linked and PIC is not supported.
12816
12817@item -mstack-bias
12818@itemx -mno-stack-bias
12819@opindex mstack-bias
12820@opindex mno-stack-bias
12821With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12822frame pointer if present, are offset by @minus{}2047 which must be added back
12823when making stack frame references.  This is the default in 64-bit mode.
12824Otherwise, assume no such offset is present.
12825@end table
12826
12827These switches are supported in addition to the above on Solaris:
12828
12829@table @gcctabopt
12830@item -threads
12831@opindex threads
12832Add support for multithreading using the Solaris threads library.  This
12833option sets flags for both the preprocessor and linker.  This option does
12834not affect the thread safety of object code produced by the compiler or
12835that of libraries supplied with it.
12836
12837@item -pthreads
12838@opindex pthreads
12839Add support for multithreading using the POSIX threads library.  This
12840option sets flags for both the preprocessor and linker.  This option does
12841not affect the thread safety of object code produced  by the compiler or
12842that of libraries supplied with it.
12843
12844@item -pthread
12845@opindex pthread
12846This is a synonym for @option{-pthreads}.
12847@end table
12848
12849@node System V Options
12850@subsection Options for System V
12851
12852These additional options are available on System V Release 4 for
12853compatibility with other compilers on those systems:
12854
12855@table @gcctabopt
12856@item -G
12857@opindex G
12858Create a shared object.
12859It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12860
12861@item -Qy
12862@opindex Qy
12863Identify the versions of each tool used by the compiler, in a
12864@code{.ident} assembler directive in the output.
12865
12866@item -Qn
12867@opindex Qn
12868Refrain from adding @code{.ident} directives to the output file (this is
12869the default).
12870
12871@item -YP,@var{dirs}
12872@opindex YP
12873Search the directories @var{dirs}, and no others, for libraries
12874specified with @option{-l}.
12875
12876@item -Ym,@var{dir}
12877@opindex Ym
12878Look in the directory @var{dir} to find the M4 preprocessor.
12879The assembler uses this option.
12880@c This is supposed to go with a -Yd for predefined M4 macro files, but
12881@c the generic assembler that comes with Solaris takes just -Ym.
12882@end table
12883
12884@node TMS320C3x/C4x Options
12885@subsection TMS320C3x/C4x Options
12886@cindex TMS320C3x/C4x Options
12887
12888These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12889
12890@table @gcctabopt
12891
12892@item -mcpu=@var{cpu_type}
12893@opindex mcpu
12894Set the instruction set, register set, and instruction scheduling
12895parameters for machine type @var{cpu_type}.  Supported values for
12896@var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12897@samp{c44}.  The default is @samp{c40} to generate code for the
12898TMS320C40.
12899
12900@item -mbig-memory
12901@itemx -mbig
12902@itemx -msmall-memory
12903@itemx -msmall
12904@opindex mbig-memory
12905@opindex mbig
12906@opindex msmall-memory
12907@opindex msmall
12908Generates code for the big or small memory model.  The small memory
12909model assumed that all data fits into one 64K word page.  At run-time
12910the data page (DP) register must be set to point to the 64K page
12911containing the .bss and .data program sections.  The big memory model is
12912the default and requires reloading of the DP register for every direct
12913memory access.
12914
12915@item -mbk
12916@itemx -mno-bk
12917@opindex mbk
12918@opindex mno-bk
12919Allow (disallow) allocation of general integer operands into the block
12920count register BK@.
12921
12922@item -mdb
12923@itemx -mno-db
12924@opindex mdb
12925@opindex mno-db
12926Enable (disable) generation of code using decrement and branch,
12927DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12928on the safe side, this is disabled for the C3x, since the maximum
12929iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12930@math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12931that it can utilize the decrement and branch instruction, but will give
12932up if there is more than one memory reference in the loop.  Thus a loop
12933where the loop counter is decremented can generate slightly more
12934efficient code, in cases where the RPTB instruction cannot be utilized.
12935
12936@item -mdp-isr-reload
12937@itemx -mparanoid
12938@opindex mdp-isr-reload
12939@opindex mparanoid
12940Force the DP register to be saved on entry to an interrupt service
12941routine (ISR), reloaded to point to the data section, and restored on
12942exit from the ISR@.  This should not be required unless someone has
12943violated the small memory model by modifying the DP register, say within
12944an object library.
12945
12946@item -mmpyi
12947@itemx -mno-mpyi
12948@opindex mmpyi
12949@opindex mno-mpyi
12950For the C3x use the 24-bit MPYI instruction for integer multiplies
12951instead of a library call to guarantee 32-bit results.  Note that if one
12952of the operands is a constant, then the multiplication will be performed
12953using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12954then squaring operations are performed inline instead of a library call.
12955
12956@item -mfast-fix
12957@itemx -mno-fast-fix
12958@opindex mfast-fix
12959@opindex mno-fast-fix
12960The C3x/C4x FIX instruction to convert a floating point value to an
12961integer value chooses the nearest integer less than or equal to the
12962floating point value rather than to the nearest integer.  Thus if the
12963floating point number is negative, the result will be incorrectly
12964truncated an additional code is necessary to detect and correct this
12965case.  This option can be used to disable generation of the additional
12966code required to correct the result.
12967
12968@item -mrptb
12969@itemx -mno-rptb
12970@opindex mrptb
12971@opindex mno-rptb
12972Enable (disable) generation of repeat block sequences using the RPTB
12973instruction for zero overhead looping.  The RPTB construct is only used
12974for innermost loops that do not call functions or jump across the loop
12975boundaries.  There is no advantage having nested RPTB loops due to the
12976overhead required to save and restore the RC, RS, and RE registers.
12977This is enabled by default with @option{-O2}.
12978
12979@item -mrpts=@var{count}
12980@itemx -mno-rpts
12981@opindex mrpts
12982@opindex mno-rpts
12983Enable (disable) the use of the single instruction repeat instruction
12984RPTS@.  If a repeat block contains a single instruction, and the loop
12985count can be guaranteed to be less than the value @var{count}, GCC will
12986emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12987then a RPTS will be emitted even if the loop count cannot be determined
12988at compile time.  Note that the repeated instruction following RPTS does
12989not have to be reloaded from memory each iteration, thus freeing up the
12990CPU buses for operands.  However, since interrupts are blocked by this
12991instruction, it is disabled by default.
12992
12993@item -mloop-unsigned
12994@itemx -mno-loop-unsigned
12995@opindex mloop-unsigned
12996@opindex mno-loop-unsigned
12997The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12998is @math{2^{31} + 1} since these instructions test if the iteration count is
12999negative to terminate the loop.  If the iteration count is unsigned
13000there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
13001exceeded.  This switch allows an unsigned iteration count.
13002
13003@item -mti
13004@opindex mti
13005Try to emit an assembler syntax that the TI assembler (asm30) is happy
13006with.  This also enforces compatibility with the API employed by the TI
13007C3x C compiler.  For example, long doubles are passed as structures
13008rather than in floating point registers.
13009
13010@item -mregparm
13011@itemx -mmemparm
13012@opindex mregparm
13013@opindex mmemparm
13014Generate code that uses registers (stack) for passing arguments to functions.
13015By default, arguments are passed in registers where possible rather
13016than by pushing arguments on to the stack.
13017
13018@item -mparallel-insns
13019@itemx -mno-parallel-insns
13020@opindex mparallel-insns
13021@opindex mno-parallel-insns
13022Allow the generation of parallel instructions.  This is enabled by
13023default with @option{-O2}.
13024
13025@item -mparallel-mpy
13026@itemx -mno-parallel-mpy
13027@opindex mparallel-mpy
13028@opindex mno-parallel-mpy
13029Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
13030provided @option{-mparallel-insns} is also specified.  These instructions have
13031tight register constraints which can pessimize the code generation
13032of large functions.
13033
13034@end table
13035
13036@node V850 Options
13037@subsection V850 Options
13038@cindex V850 Options
13039
13040These @samp{-m} options are defined for V850 implementations:
13041
13042@table @gcctabopt
13043@item -mlong-calls
13044@itemx -mno-long-calls
13045@opindex mlong-calls
13046@opindex mno-long-calls
13047Treat all calls as being far away (near).  If calls are assumed to be
13048far away, the compiler will always load the functions address up into a
13049register, and call indirect through the pointer.
13050
13051@item -mno-ep
13052@itemx -mep
13053@opindex mno-ep
13054@opindex mep
13055Do not optimize (do optimize) basic blocks that use the same index
13056pointer 4 or more times to copy pointer into the @code{ep} register, and
13057use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
13058option is on by default if you optimize.
13059
13060@item -mno-prolog-function
13061@itemx -mprolog-function
13062@opindex mno-prolog-function
13063@opindex mprolog-function
13064Do not use (do use) external functions to save and restore registers
13065at the prologue and epilogue of a function.  The external functions
13066are slower, but use less code space if more than one function saves
13067the same number of registers.  The @option{-mprolog-function} option
13068is on by default if you optimize.
13069
13070@item -mspace
13071@opindex mspace
13072Try to make the code as small as possible.  At present, this just turns
13073on the @option{-mep} and @option{-mprolog-function} options.
13074
13075@item -mtda=@var{n}
13076@opindex mtda
13077Put static or global variables whose size is @var{n} bytes or less into
13078the tiny data area that register @code{ep} points to.  The tiny data
13079area can hold up to 256 bytes in total (128 bytes for byte references).
13080
13081@item -msda=@var{n}
13082@opindex msda
13083Put static or global variables whose size is @var{n} bytes or less into
13084the small data area that register @code{gp} points to.  The small data
13085area can hold up to 64 kilobytes.
13086
13087@item -mzda=@var{n}
13088@opindex mzda
13089Put static or global variables whose size is @var{n} bytes or less into
13090the first 32 kilobytes of memory.
13091
13092@item -mv850
13093@opindex mv850
13094Specify that the target processor is the V850.
13095
13096@item -mbig-switch
13097@opindex mbig-switch
13098Generate code suitable for big switch tables.  Use this option only if
13099the assembler/linker complain about out of range branches within a switch
13100table.
13101
13102@item -mapp-regs
13103@opindex mapp-regs
13104This option will cause r2 and r5 to be used in the code generated by
13105the compiler.  This setting is the default.
13106
13107@item -mno-app-regs
13108@opindex mno-app-regs
13109This option will cause r2 and r5 to be treated as fixed registers.
13110
13111@item -mv850e1
13112@opindex mv850e1
13113Specify that the target processor is the V850E1.  The preprocessor
13114constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
13115this option is used.
13116
13117@item -mv850e
13118@opindex mv850e
13119Specify that the target processor is the V850E@.  The preprocessor
13120constant @samp{__v850e__} will be defined if this option is used.
13121
13122If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
13123are defined then a default target processor will be chosen and the
13124relevant @samp{__v850*__} preprocessor constant will be defined.
13125
13126The preprocessor constants @samp{__v850} and @samp{__v851__} are always
13127defined, regardless of which processor variant is the target.
13128
13129@item -mdisable-callt
13130@opindex mdisable-callt
13131This option will suppress generation of the CALLT instruction for the
13132v850e and v850e1 flavors of the v850 architecture.  The default is
13133@option{-mno-disable-callt} which allows the CALLT instruction to be used.
13134
13135@end table
13136
13137@node VAX Options
13138@subsection VAX Options
13139@cindex VAX options
13140
13141These @samp{-m} options are defined for the VAX:
13142
13143@table @gcctabopt
13144@item -munix
13145@opindex munix
13146Do not output certain jump instructions (@code{aobleq} and so on)
13147that the Unix assembler for the VAX cannot handle across long
13148ranges.
13149
13150@item -mgnu
13151@opindex mgnu
13152Do output those jump instructions, on the assumption that you
13153will assemble with the GNU assembler.
13154
13155@item -mg
13156@opindex mg
13157Output code for g-format floating point numbers instead of d-format.
13158@end table
13159
13160@node x86-64 Options
13161@subsection x86-64 Options
13162@cindex x86-64 options
13163
13164These are listed under @xref{i386 and x86-64 Options}.
13165
13166@node Xstormy16 Options
13167@subsection Xstormy16 Options
13168@cindex Xstormy16 Options
13169
13170These options are defined for Xstormy16:
13171
13172@table @gcctabopt
13173@item -msim
13174@opindex msim
13175Choose startup files and linker script suitable for the simulator.
13176@end table
13177
13178@node Xtensa Options
13179@subsection Xtensa Options
13180@cindex Xtensa Options
13181
13182These options are supported for Xtensa targets:
13183
13184@table @gcctabopt
13185@item -mconst16
13186@itemx -mno-const16
13187@opindex mconst16
13188@opindex mno-const16
13189Enable or disable use of @code{CONST16} instructions for loading
13190constant values.  The @code{CONST16} instruction is currently not a
13191standard option from Tensilica.  When enabled, @code{CONST16}
13192instructions are always used in place of the standard @code{L32R}
13193instructions.  The use of @code{CONST16} is enabled by default only if
13194the @code{L32R} instruction is not available.
13195
13196@item -mfused-madd
13197@itemx -mno-fused-madd
13198@opindex mfused-madd
13199@opindex mno-fused-madd
13200Enable or disable use of fused multiply/add and multiply/subtract
13201instructions in the floating-point option.  This has no effect if the
13202floating-point option is not also enabled.  Disabling fused multiply/add
13203and multiply/subtract instructions forces the compiler to use separate
13204instructions for the multiply and add/subtract operations.  This may be
13205desirable in some cases where strict IEEE 754-compliant results are
13206required: the fused multiply add/subtract instructions do not round the
13207intermediate result, thereby producing results with @emph{more} bits of
13208precision than specified by the IEEE standard.  Disabling fused multiply
13209add/subtract instructions also ensures that the program output is not
13210sensitive to the compiler's ability to combine multiply and add/subtract
13211operations.
13212
13213@item -mtext-section-literals
13214@itemx -mno-text-section-literals
13215@opindex mtext-section-literals
13216@opindex mno-text-section-literals
13217Control the treatment of literal pools.  The default is
13218@option{-mno-text-section-literals}, which places literals in a separate
13219section in the output file.  This allows the literal pool to be placed
13220in a data RAM/ROM, and it also allows the linker to combine literal
13221pools from separate object files to remove redundant literals and
13222improve code size.  With @option{-mtext-section-literals}, the literals
13223are interspersed in the text section in order to keep them as close as
13224possible to their references.  This may be necessary for large assembly
13225files.
13226
13227@item -mtarget-align
13228@itemx -mno-target-align
13229@opindex mtarget-align
13230@opindex mno-target-align
13231When this option is enabled, GCC instructs the assembler to
13232automatically align instructions to reduce branch penalties at the
13233expense of some code density.  The assembler attempts to widen density
13234instructions to align branch targets and the instructions following call
13235instructions.  If there are not enough preceding safe density
13236instructions to align a target, no widening will be performed.  The
13237default is @option{-mtarget-align}.  These options do not affect the
13238treatment of auto-aligned instructions like @code{LOOP}, which the
13239assembler will always align, either by widening density instructions or
13240by inserting no-op instructions.
13241
13242@item -mlongcalls
13243@itemx -mno-longcalls
13244@opindex mlongcalls
13245@opindex mno-longcalls
13246When this option is enabled, GCC instructs the assembler to translate
13247direct calls to indirect calls unless it can determine that the target
13248of a direct call is in the range allowed by the call instruction.  This
13249translation typically occurs for calls to functions in other source
13250files.  Specifically, the assembler translates a direct @code{CALL}
13251instruction into an @code{L32R} followed by a @code{CALLX} instruction.
13252The default is @option{-mno-longcalls}.  This option should be used in
13253programs where the call target can potentially be out of range.  This
13254option is implemented in the assembler, not the compiler, so the
13255assembly code generated by GCC will still show direct call
13256instructions---look at the disassembled object code to see the actual
13257instructions.  Note that the assembler will use an indirect call for
13258every cross-file call, not just those that really will be out of range.
13259@end table
13260
13261@node zSeries Options
13262@subsection zSeries Options
13263@cindex zSeries options
13264
13265These are listed under @xref{S/390 and zSeries Options}.
13266
13267@node Code Gen Options
13268@section Options for Code Generation Conventions
13269@cindex code generation conventions
13270@cindex options, code generation
13271@cindex run-time options
13272
13273These machine-independent options control the interface conventions
13274used in code generation.
13275
13276Most of them have both positive and negative forms; the negative form
13277of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
13278one of the forms is listed---the one which is not the default.  You
13279can figure out the other form by either removing @samp{no-} or adding
13280it.
13281
13282@table @gcctabopt
13283@item -fbounds-check
13284@opindex fbounds-check
13285For front-ends that support it, generate additional code to check that
13286indices used to access arrays are within the declared range.  This is
13287currently only supported by the Java and Fortran front-ends, where
13288this option defaults to true and false respectively.
13289
13290@item -ftrapv
13291@opindex ftrapv
13292This option generates traps for signed overflow on addition, subtraction,
13293multiplication operations.
13294
13295@item -fwrapv
13296@opindex fwrapv
13297This option instructs the compiler to assume that signed arithmetic
13298overflow of addition, subtraction and multiplication wraps around
13299using twos-complement representation.  This flag enables some optimizations
13300and disables others.  This option is enabled by default for the Java
13301front-end, as required by the Java language specification.
13302
13303@item -fexceptions
13304@opindex fexceptions
13305Enable exception handling.  Generates extra code needed to propagate
13306exceptions.  For some targets, this implies GCC will generate frame
13307unwind information for all functions, which can produce significant data
13308size overhead, although it does not affect execution.  If you do not
13309specify this option, GCC will enable it by default for languages like
13310C++ which normally require exception handling, and disable it for
13311languages like C that do not normally require it.  However, you may need
13312to enable this option when compiling C code that needs to interoperate
13313properly with exception handlers written in C++.  You may also wish to
13314disable this option if you are compiling older C++ programs that don't
13315use exception handling.
13316
13317@item -fnon-call-exceptions
13318@opindex fnon-call-exceptions
13319Generate code that allows trapping instructions to throw exceptions.
13320Note that this requires platform-specific runtime support that does
13321not exist everywhere.  Moreover, it only allows @emph{trapping}
13322instructions to throw exceptions, i.e.@: memory references or floating
13323point instructions.  It does not allow exceptions to be thrown from
13324arbitrary signal handlers such as @code{SIGALRM}.
13325
13326@item -funwind-tables
13327@opindex funwind-tables
13328Similar to @option{-fexceptions}, except that it will just generate any needed
13329static data, but will not affect the generated code in any other way.
13330You will normally not enable this option; instead, a language processor
13331that needs this handling would enable it on your behalf.
13332
13333@item -fasynchronous-unwind-tables
13334@opindex fasynchronous-unwind-tables
13335Generate unwind table in dwarf2 format, if supported by target machine.  The
13336table is exact at each instruction boundary, so it can be used for stack
13337unwinding from asynchronous events (such as debugger or garbage collector).
13338
13339@item -fpcc-struct-return
13340@opindex fpcc-struct-return
13341Return ``short'' @code{struct} and @code{union} values in memory like
13342longer ones, rather than in registers.  This convention is less
13343efficient, but it has the advantage of allowing intercallability between
13344GCC-compiled files and files compiled with other compilers, particularly
13345the Portable C Compiler (pcc).
13346
13347The precise convention for returning structures in memory depends
13348on the target configuration macros.
13349
13350Short structures and unions are those whose size and alignment match
13351that of some integer type.
13352
13353@strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13354switch is not binary compatible with code compiled with the
13355@option{-freg-struct-return} switch.
13356Use it to conform to a non-default application binary interface.
13357
13358@item -freg-struct-return
13359@opindex freg-struct-return
13360Return @code{struct} and @code{union} values in registers when possible.
13361This is more efficient for small structures than
13362@option{-fpcc-struct-return}.
13363
13364If you specify neither @option{-fpcc-struct-return} nor
13365@option{-freg-struct-return}, GCC defaults to whichever convention is
13366standard for the target.  If there is no standard convention, GCC
13367defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13368the principal compiler.  In those cases, we can choose the standard, and
13369we chose the more efficient register return alternative.
13370
13371@strong{Warning:} code compiled with the @option{-freg-struct-return}
13372switch is not binary compatible with code compiled with the
13373@option{-fpcc-struct-return} switch.
13374Use it to conform to a non-default application binary interface.
13375
13376@item -fshort-enums
13377@opindex fshort-enums
13378Allocate to an @code{enum} type only as many bytes as it needs for the
13379declared range of possible values.  Specifically, the @code{enum} type
13380will be equivalent to the smallest integer type which has enough room.
13381
13382@strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13383code that is not binary compatible with code generated without that switch.
13384Use it to conform to a non-default application binary interface.
13385
13386@item -fshort-double
13387@opindex fshort-double
13388Use the same size for @code{double} as for @code{float}.
13389
13390@strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
13391code that is not binary compatible with code generated without that switch.
13392Use it to conform to a non-default application binary interface.
13393
13394@item -fshort-wchar
13395@opindex fshort-wchar
13396Override the underlying type for @samp{wchar_t} to be @samp{short
13397unsigned int} instead of the default for the target.  This option is
13398useful for building programs to run under WINE@.
13399
13400@strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13401code that is not binary compatible with code generated without that switch.
13402Use it to conform to a non-default application binary interface.
13403
13404@item -fno-common
13405@opindex fno-common
13406In C, allocate even uninitialized global variables in the data section of the
13407object file, rather than generating them as common blocks.  This has the
13408effect that if the same variable is declared (without @code{extern}) in
13409two different compilations, you will get an error when you link them.
13410The only reason this might be useful is if you wish to verify that the
13411program will work on other systems which always work this way.
13412
13413@item -fno-ident
13414@opindex fno-ident
13415Ignore the @samp{#ident} directive.
13416
13417@item -finhibit-size-directive
13418@opindex finhibit-size-directive
13419Don't output a @code{.size} assembler directive, or anything else that
13420would cause trouble if the function is split in the middle, and the
13421two halves are placed at locations far apart in memory.  This option is
13422used when compiling @file{crtstuff.c}; you should not need to use it
13423for anything else.
13424
13425@item -fverbose-asm
13426@opindex fverbose-asm
13427Put extra commentary information in the generated assembly code to
13428make it more readable.  This option is generally only of use to those
13429who actually need to read the generated assembly code (perhaps while
13430debugging the compiler itself).
13431
13432@option{-fno-verbose-asm}, the default, causes the
13433extra information to be omitted and is useful when comparing two assembler
13434files.
13435
13436@item -fpic
13437@opindex fpic
13438@cindex global offset table
13439@cindex PIC
13440Generate position-independent code (PIC) suitable for use in a shared
13441library, if supported for the target machine.  Such code accesses all
13442constant addresses through a global offset table (GOT)@.  The dynamic
13443loader resolves the GOT entries when the program starts (the dynamic
13444loader is not part of GCC; it is part of the operating system).  If
13445the GOT size for the linked executable exceeds a machine-specific
13446maximum size, you get an error message from the linker indicating that
13447@option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13448instead.  (These maximums are 8k on the SPARC and 32k
13449on the m68k and RS/6000.  The 386 has no such limit.)
13450
13451Position-independent code requires special support, and therefore works
13452only on certain machines.  For the 386, GCC supports PIC for System V
13453but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13454position-independent.
13455
13456When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13457are defined to 1.
13458
13459@item -fPIC
13460@opindex fPIC
13461If supported for the target machine, emit position-independent code,
13462suitable for dynamic linking and avoiding any limit on the size of the
13463global offset table.  This option makes a difference on the m68k,
13464PowerPC and SPARC@.
13465
13466Position-independent code requires special support, and therefore works
13467only on certain machines.
13468
13469When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13470are defined to 2.
13471
13472@item -fpie
13473@itemx -fPIE
13474@opindex fpie
13475@opindex fPIE
13476These options are similar to @option{-fpic} and @option{-fPIC}, but
13477generated position independent code can be only linked into executables.
13478Usually these options are used when @option{-pie} GCC option will be
13479used during linking.
13480
13481@item -fno-jump-tables
13482@opindex fno-jump-tables
13483Do not use jump tables for switch statements even where it would be
13484more efficient than other code generation strategies.  This option is
13485of use in conjunction with @option{-fpic} or @option{-fPIC} for
13486building code which forms part of a dynamic linker and cannot
13487reference the address of a jump table.  On some targets, jump tables
13488do not require a GOT and this option is not needed.
13489
13490@item -ffixed-@var{reg}
13491@opindex ffixed
13492Treat the register named @var{reg} as a fixed register; generated code
13493should never refer to it (except perhaps as a stack pointer, frame
13494pointer or in some other fixed role).
13495
13496@var{reg} must be the name of a register.  The register names accepted
13497are machine-specific and are defined in the @code{REGISTER_NAMES}
13498macro in the machine description macro file.
13499
13500This flag does not have a negative form, because it specifies a
13501three-way choice.
13502
13503@item -fcall-used-@var{reg}
13504@opindex fcall-used
13505Treat the register named @var{reg} as an allocable register that is
13506clobbered by function calls.  It may be allocated for temporaries or
13507variables that do not live across a call.  Functions compiled this way
13508will not save and restore the register @var{reg}.
13509
13510It is an error to used this flag with the frame pointer or stack pointer.
13511Use of this flag for other registers that have fixed pervasive roles in
13512the machine's execution model will produce disastrous results.
13513
13514This flag does not have a negative form, because it specifies a
13515three-way choice.
13516
13517@item -fcall-saved-@var{reg}
13518@opindex fcall-saved
13519Treat the register named @var{reg} as an allocable register saved by
13520functions.  It may be allocated even for temporaries or variables that
13521live across a call.  Functions compiled this way will save and restore
13522the register @var{reg} if they use it.
13523
13524It is an error to used this flag with the frame pointer or stack pointer.
13525Use of this flag for other registers that have fixed pervasive roles in
13526the machine's execution model will produce disastrous results.
13527
13528A different sort of disaster will result from the use of this flag for
13529a register in which function values may be returned.
13530
13531This flag does not have a negative form, because it specifies a
13532three-way choice.
13533
13534@item -fpack-struct[=@var{n}]
13535@opindex fpack-struct
13536Without a value specified, pack all structure members together without
13537holes.  When a value is specified (which must be a small power of two), pack
13538structure members according to this value, representing the maximum
13539alignment (that is, objects with default alignment requirements larger than
13540this will be output potentially unaligned at the next fitting location.
13541
13542@strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13543code that is not binary compatible with code generated without that switch.
13544Additionally, it makes the code suboptimal.
13545Use it to conform to a non-default application binary interface.
13546
13547@item -finstrument-functions
13548@opindex finstrument-functions
13549Generate instrumentation calls for entry and exit to functions.  Just
13550after function entry and just before function exit, the following
13551profiling functions will be called with the address of the current
13552function and its call site.  (On some platforms,
13553@code{__builtin_return_address} does not work beyond the current
13554function, so the call site information may not be available to the
13555profiling functions otherwise.)
13556
13557@smallexample
13558void __cyg_profile_func_enter (void *this_fn,
13559                               void *call_site);
13560void __cyg_profile_func_exit  (void *this_fn,
13561                               void *call_site);
13562@end smallexample
13563
13564The first argument is the address of the start of the current function,
13565which may be looked up exactly in the symbol table.
13566
13567This instrumentation is also done for functions expanded inline in other
13568functions.  The profiling calls will indicate where, conceptually, the
13569inline function is entered and exited.  This means that addressable
13570versions of such functions must be available.  If all your uses of a
13571function are expanded inline, this may mean an additional expansion of
13572code size.  If you use @samp{extern inline} in your C code, an
13573addressable version of such functions must be provided.  (This is
13574normally the case anyways, but if you get lucky and the optimizer always
13575expands the functions inline, you might have gotten away without
13576providing static copies.)
13577
13578A function may be given the attribute @code{no_instrument_function}, in
13579which case this instrumentation will not be done.  This can be used, for
13580example, for the profiling functions listed above, high-priority
13581interrupt routines, and any functions from which the profiling functions
13582cannot safely be called (perhaps signal handlers, if the profiling
13583routines generate output or allocate memory).
13584
13585@item -fstack-check
13586@opindex fstack-check
13587Generate code to verify that you do not go beyond the boundary of the
13588stack.  You should specify this flag if you are running in an
13589environment with multiple threads, but only rarely need to specify it in
13590a single-threaded environment since stack overflow is automatically
13591detected on nearly all systems if there is only one stack.
13592
13593Note that this switch does not actually cause checking to be done; the
13594operating system must do that.  The switch causes generation of code
13595to ensure that the operating system sees the stack being extended.
13596
13597@item -fstack-limit-register=@var{reg}
13598@itemx -fstack-limit-symbol=@var{sym}
13599@itemx -fno-stack-limit
13600@opindex fstack-limit-register
13601@opindex fstack-limit-symbol
13602@opindex fno-stack-limit
13603Generate code to ensure that the stack does not grow beyond a certain value,
13604either the value of a register or the address of a symbol.  If the stack
13605would grow beyond the value, a signal is raised.  For most targets,
13606the signal is raised before the stack overruns the boundary, so
13607it is possible to catch the signal without taking special precautions.
13608
13609For instance, if the stack starts at absolute address @samp{0x80000000}
13610and grows downwards, you can use the flags
13611@option{-fstack-limit-symbol=__stack_limit} and
13612@option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13613of 128KB@.  Note that this may only work with the GNU linker.
13614
13615@cindex aliasing of parameters
13616@cindex parameters, aliased
13617@item -fargument-alias
13618@itemx -fargument-noalias
13619@itemx -fargument-noalias-global
13620@itemx -fargument-noalias-anything
13621@opindex fargument-alias
13622@opindex fargument-noalias
13623@opindex fargument-noalias-global
13624@opindex fargument-noalias-anything
13625Specify the possible relationships among parameters and between
13626parameters and global data.
13627
13628@option{-fargument-alias} specifies that arguments (parameters) may
13629alias each other and may alias global storage.@*
13630@option{-fargument-noalias} specifies that arguments do not alias
13631each other, but may alias global storage.@*
13632@option{-fargument-noalias-global} specifies that arguments do not
13633alias each other and do not alias global storage.
13634@option{-fargument-noalias-anything} specifies that arguments do not
13635alias any other storage.
13636
13637Each language will automatically use whatever option is required by
13638the language standard.  You should not need to use these options yourself.
13639
13640@item -fleading-underscore
13641@opindex fleading-underscore
13642This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13643change the way C symbols are represented in the object file.  One use
13644is to help link with legacy assembly code.
13645
13646@strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13647generate code that is not binary compatible with code generated without that
13648switch.  Use it to conform to a non-default application binary interface.
13649Not all targets provide complete support for this switch.
13650
13651@item -ftls-model=@var{model}
13652Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13653The @var{model} argument should be one of @code{global-dynamic},
13654@code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13655
13656The default without @option{-fpic} is @code{initial-exec}; with
13657@option{-fpic} the default is @code{global-dynamic}.
13658
13659@item -fvisibility=@var{default|internal|hidden|protected}
13660@opindex fvisibility
13661Set the default ELF image symbol visibility to the specified option---all
13662symbols will be marked with this unless overridden within the code.
13663Using this feature can very substantially improve linking and
13664load times of shared object libraries, produce more optimized
13665code, provide near-perfect API export and prevent symbol clashes.
13666It is @strong{strongly} recommended that you use this in any shared objects
13667you distribute.
13668
13669Despite the nomenclature, @code{default} always means public ie;
13670available to be linked against from outside the shared object.
13671@code{protected} and @code{internal} are pretty useless in real-world
13672usage so the only other commonly used option will be @code{hidden}.
13673The default if @option{-fvisibility} isn't specified is
13674@code{default}, i.e., make every
13675symbol public---this causes the same behavior as previous versions of
13676GCC@.
13677
13678A good explanation of the benefits offered by ensuring ELF
13679symbols have the correct visibility is given by ``How To Write
13680Shared Libraries'' by Ulrich Drepper (which can be found at
13681@w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13682solution made possible by this option to marking things hidden when
13683the default is public is to make the default hidden and mark things
13684public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13685and @code{__attribute__ ((visibility("default")))} instead of
13686@code{__declspec(dllexport)} you get almost identical semantics with
13687identical syntax.  This is a great boon to those working with
13688cross-platform projects.
13689
13690For those adding visibility support to existing code, you may find
13691@samp{#pragma GCC visibility} of use.  This works by you enclosing
13692the declarations you wish to set visibility for with (for example)
13693@samp{#pragma GCC visibility push(hidden)} and
13694@samp{#pragma GCC visibility pop}.
13695Bear in mind that symbol visibility should be viewed @strong{as
13696part of the API interface contract} and thus all new code should
13697always specify visibility when it is not the default ie; declarations
13698only for use within the local DSO should @strong{always} be marked explicitly
13699as hidden as so to avoid PLT indirection overheads---making this
13700abundantly clear also aids readability and self-documentation of the code.
13701Note that due to ISO C++ specification requirements, operator new and
13702operator delete must always be of default visibility.
13703
13704Be aware that headers from outside your project, in particular system
13705headers and headers from any other library you use, may not be
13706expecting to be compiled with visibility other than the default.  You
13707may need to explicitly say @samp{#pragma GCC visibility push(default)}
13708before including any such headers.
13709
13710@samp{extern} declarations are not affected by @samp{-fvisibility}, so
13711a lot of code can be recompiled with @samp{-fvisibility=hidden} with
13712no modifications.  However, this means that calls to @samp{extern}
13713functions with no explicit visibility will use the PLT, so it is more
13714effective to use @samp{__attribute ((visibility))} and/or
13715@samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
13716declarations should be treated as hidden.
13717
13718Note that @samp{-fvisibility} does affect C++ vague linkage
13719entities. This means that, for instance, an exception class that will
13720be thrown between DSOs must be explicitly marked with default
13721visibility so that the @samp{type_info} nodes will be unified between
13722the DSOs.
13723
13724An overview of these techniques, their benefits and how to use them
13725is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13726
13727@end table
13728
13729@c man end
13730
13731@node Environment Variables
13732@section Environment Variables Affecting GCC
13733@cindex environment variables
13734
13735@c man begin ENVIRONMENT
13736This section describes several environment variables that affect how GCC
13737operates.  Some of them work by specifying directories or prefixes to use
13738when searching for various kinds of files.  Some are used to specify other
13739aspects of the compilation environment.
13740
13741Note that you can also specify places to search using options such as
13742@option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13743take precedence over places specified using environment variables, which
13744in turn take precedence over those specified by the configuration of GCC@.
13745@xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13746GNU Compiler Collection (GCC) Internals}.
13747
13748@table @env
13749@item LANG
13750@itemx LC_CTYPE
13751@c @itemx LC_COLLATE
13752@itemx LC_MESSAGES
13753@c @itemx LC_MONETARY
13754@c @itemx LC_NUMERIC
13755@c @itemx LC_TIME
13756@itemx LC_ALL
13757@findex LANG
13758@findex LC_CTYPE
13759@c @findex LC_COLLATE
13760@findex LC_MESSAGES
13761@c @findex LC_MONETARY
13762@c @findex LC_NUMERIC
13763@c @findex LC_TIME
13764@findex LC_ALL
13765@cindex locale
13766These environment variables control the way that GCC uses
13767localization information that allow GCC to work with different
13768national conventions.  GCC inspects the locale categories
13769@env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13770so.  These locale categories can be set to any value supported by your
13771installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13772Kingdom encoded in UTF-8.
13773
13774The @env{LC_CTYPE} environment variable specifies character
13775classification.  GCC uses it to determine the character boundaries in
13776a string; this is needed for some multibyte encodings that contain quote
13777and escape characters that would otherwise be interpreted as a string
13778end or escape.
13779
13780The @env{LC_MESSAGES} environment variable specifies the language to
13781use in diagnostic messages.
13782
13783If the @env{LC_ALL} environment variable is set, it overrides the value
13784of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13785and @env{LC_MESSAGES} default to the value of the @env{LANG}
13786environment variable.  If none of these variables are set, GCC
13787defaults to traditional C English behavior.
13788
13789@item TMPDIR
13790@findex TMPDIR
13791If @env{TMPDIR} is set, it specifies the directory to use for temporary
13792files.  GCC uses temporary files to hold the output of one stage of
13793compilation which is to be used as input to the next stage: for example,
13794the output of the preprocessor, which is the input to the compiler
13795proper.
13796
13797@item GCC_EXEC_PREFIX
13798@findex GCC_EXEC_PREFIX
13799If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13800names of the subprograms executed by the compiler.  No slash is added
13801when this prefix is combined with the name of a subprogram, but you can
13802specify a prefix that ends with a slash if you wish.
13803
13804If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13805an appropriate prefix to use based on the pathname it was invoked with.
13806
13807If GCC cannot find the subprogram using the specified prefix, it
13808tries looking in the usual places for the subprogram.
13809
13810The default value of @env{GCC_EXEC_PREFIX} is
13811@file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13812of @code{prefix} when you ran the @file{configure} script.
13813
13814Other prefixes specified with @option{-B} take precedence over this prefix.
13815
13816This prefix is also used for finding files such as @file{crt0.o} that are
13817used for linking.
13818
13819In addition, the prefix is used in an unusual way in finding the
13820directories to search for header files.  For each of the standard
13821directories whose name normally begins with @samp{/usr/local/lib/gcc}
13822(more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13823replacing that beginning with the specified prefix to produce an
13824alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13825@file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13826These alternate directories are searched first; the standard directories
13827come next.
13828
13829@item COMPILER_PATH
13830@findex COMPILER_PATH
13831The value of @env{COMPILER_PATH} is a colon-separated list of
13832directories, much like @env{PATH}.  GCC tries the directories thus
13833specified when searching for subprograms, if it can't find the
13834subprograms using @env{GCC_EXEC_PREFIX}.
13835
13836@item LIBRARY_PATH
13837@findex LIBRARY_PATH
13838The value of @env{LIBRARY_PATH} is a colon-separated list of
13839directories, much like @env{PATH}.  When configured as a native compiler,
13840GCC tries the directories thus specified when searching for special
13841linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13842using GCC also uses these directories when searching for ordinary
13843libraries for the @option{-l} option (but directories specified with
13844@option{-L} come first).
13845
13846@item LANG
13847@findex LANG
13848@cindex locale definition
13849This variable is used to pass locale information to the compiler.  One way in
13850which this information is used is to determine the character set to be used
13851when character literals, string literals and comments are parsed in C and C++.
13852When the compiler is configured to allow multibyte characters,
13853the following values for @env{LANG} are recognized:
13854
13855@table @samp
13856@item C-JIS
13857Recognize JIS characters.
13858@item C-SJIS
13859Recognize SJIS characters.
13860@item C-EUCJP
13861Recognize EUCJP characters.
13862@end table
13863
13864If @env{LANG} is not defined, or if it has some other value, then the
13865compiler will use mblen and mbtowc as defined by the default locale to
13866recognize and translate multibyte characters.
13867@end table
13868
13869@noindent
13870Some additional environments variables affect the behavior of the
13871preprocessor.
13872
13873@include cppenv.texi
13874
13875@c man end
13876
13877@node Precompiled Headers
13878@section Using Precompiled Headers
13879@cindex precompiled headers
13880@cindex speed of compilation
13881
13882Often large projects have many header files that are included in every
13883source file.  The time the compiler takes to process these header files
13884over and over again can account for nearly all of the time required to
13885build the project.  To make builds faster, GCC allows users to
13886`precompile' a header file; then, if builds can use the precompiled
13887header file they will be much faster.
13888
13889To create a precompiled header file, simply compile it as you would any
13890other file, if necessary using the @option{-x} option to make the driver
13891treat it as a C or C++ header file.  You will probably want to use a
13892tool like @command{make} to keep the precompiled header up-to-date when
13893the headers it contains change.
13894
13895A precompiled header file will be searched for when @code{#include} is
13896seen in the compilation.  As it searches for the included file
13897(@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13898compiler looks for a precompiled header in each directory just before it
13899looks for the include file in that directory.  The name searched for is
13900the name specified in the @code{#include} with @samp{.gch} appended.  If
13901the precompiled header file can't be used, it is ignored.
13902
13903For instance, if you have @code{#include "all.h"}, and you have
13904@file{all.h.gch} in the same directory as @file{all.h}, then the
13905precompiled header file will be used if possible, and the original
13906header will be used otherwise.
13907
13908Alternatively, you might decide to put the precompiled header file in a
13909directory and use @option{-I} to ensure that directory is searched
13910before (or instead of) the directory containing the original header.
13911Then, if you want to check that the precompiled header file is always
13912used, you can put a file of the same name as the original header in this
13913directory containing an @code{#error} command.
13914
13915This also works with @option{-include}.  So yet another way to use
13916precompiled headers, good for projects not designed with precompiled
13917header files in mind, is to simply take most of the header files used by
13918a project, include them from another header file, precompile that header
13919file, and @option{-include} the precompiled header.  If the header files
13920have guards against multiple inclusion, they will be skipped because
13921they've already been included (in the precompiled header).
13922
13923If you need to precompile the same header file for different
13924languages, targets, or compiler options, you can instead make a
13925@emph{directory} named like @file{all.h.gch}, and put each precompiled
13926header in the directory, perhaps using @option{-o}.  It doesn't matter
13927what you call the files in the directory, every precompiled header in
13928the directory will be considered.  The first precompiled header
13929encountered in the directory that is valid for this compilation will
13930be used; they're searched in no particular order.
13931
13932There are many other possibilities, limited only by your imagination,
13933good sense, and the constraints of your build system.
13934
13935A precompiled header file can be used only when these conditions apply:
13936
13937@itemize
13938@item
13939Only one precompiled header can be used in a particular compilation.
13940
13941@item
13942A precompiled header can't be used once the first C token is seen.  You
13943can have preprocessor directives before a precompiled header; you can
13944even include a precompiled header from inside another header, so long as
13945there are no C tokens before the @code{#include}.
13946
13947@item
13948The precompiled header file must be produced for the same language as
13949the current compilation.  You can't use a C precompiled header for a C++
13950compilation.
13951
13952@item
13953The precompiled header file must have been produced by the same compiler
13954binary as the current compilation is using.
13955
13956@item
13957Any macros defined before the precompiled header is included must
13958either be defined in the same way as when the precompiled header was
13959generated, or must not affect the precompiled header, which usually
13960means that they don't appear in the precompiled header at all.
13961
13962The @option{-D} option is one way to define a macro before a
13963precompiled header is included; using a @code{#define} can also do it.
13964There are also some options that define macros implicitly, like
13965@option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13966defined this way.
13967
13968@item If debugging information is output when using the precompiled
13969header, using @option{-g} or similar, the same kind of debugging information
13970must have been output when building the precompiled header.  However,
13971a precompiled header built using @option{-g} can be used in a compilation
13972when no debugging information is being output.
13973
13974@item The same @option{-m} options must generally be used when building
13975and using the precompiled header.  @xref{Submodel Options},
13976for any cases where this rule is relaxed.
13977
13978@item Each of the following options must be the same when building and using
13979the precompiled header:
13980
13981@gccoptlist{-fexceptions -funit-at-a-time}
13982
13983@item
13984Some other command-line options starting with @option{-f},
13985@option{-p}, or @option{-O} must be defined in the same way as when
13986the precompiled header was generated.  At present, it's not clear
13987which options are safe to change and which are not; the safest choice
13988is to use exactly the same options when generating and using the
13989precompiled header.  The following are known to be safe:
13990
13991@gccoptlist{-fmessage-length= -fpreprocessed
13992-fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13993-fsched-verbose=<number> -fschedule-insns -fvisibility=
13994-pedantic-errors}
13995
13996@end itemize
13997
13998For all of these except the last, the compiler will automatically
13999ignore the precompiled header if the conditions aren't met.  If you
14000find an option combination that doesn't work and doesn't cause the
14001precompiled header to be ignored, please consider filing a bug report,
14002see @ref{Bugs}.
14003
14004If you do use differing options when generating and using the
14005precompiled header, the actual behavior will be a mixture of the
14006behavior for the options.  For instance, if you use @option{-g} to
14007generate the precompiled header but not when using it, you may or may
14008not get debugging information for routines in the precompiled header.
14009
14010@node Running Protoize
14011@section Running Protoize
14012
14013The program @code{protoize} is an optional part of GCC@.  You can use
14014it to add prototypes to a program, thus converting the program to ISO
14015C in one respect.  The companion program @code{unprotoize} does the
14016reverse: it removes argument types from any prototypes that are found.
14017
14018When you run these programs, you must specify a set of source files as
14019command line arguments.  The conversion programs start out by compiling
14020these files to see what functions they define.  The information gathered
14021about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
14022
14023After scanning comes actual conversion.  The specified files are all
14024eligible to be converted; any files they include (whether sources or
14025just headers) are eligible as well.
14026
14027But not all the eligible files are converted.  By default,
14028@code{protoize} and @code{unprotoize} convert only source and header
14029files in the current directory.  You can specify additional directories
14030whose files should be converted with the @option{-d @var{directory}}
14031option.  You can also specify particular files to exclude with the
14032@option{-x @var{file}} option.  A file is converted if it is eligible, its
14033directory name matches one of the specified directory names, and its
14034name within the directory has not been excluded.
14035
14036Basic conversion with @code{protoize} consists of rewriting most
14037function definitions and function declarations to specify the types of
14038the arguments.  The only ones not rewritten are those for varargs
14039functions.
14040
14041@code{protoize} optionally inserts prototype declarations at the
14042beginning of the source file, to make them available for any calls that
14043precede the function's definition.  Or it can insert prototype
14044declarations with block scope in the blocks where undeclared functions
14045are called.
14046
14047Basic conversion with @code{unprotoize} consists of rewriting most
14048function declarations to remove any argument types, and rewriting
14049function definitions to the old-style pre-ISO form.
14050
14051Both conversion programs print a warning for any function declaration or
14052definition that they can't convert.  You can suppress these warnings
14053with @option{-q}.
14054
14055The output from @code{protoize} or @code{unprotoize} replaces the
14056original source file.  The original file is renamed to a name ending
14057with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
14058without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
14059for DOS) file already exists, then the source file is simply discarded.
14060
14061@code{protoize} and @code{unprotoize} both depend on GCC itself to
14062scan the program and collect information about the functions it uses.
14063So neither of these programs will work until GCC is installed.
14064
14065Here is a table of the options you can use with @code{protoize} and
14066@code{unprotoize}.  Each option works with both programs unless
14067otherwise stated.
14068
14069@table @code
14070@item -B @var{directory}
14071Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
14072usual directory (normally @file{/usr/local/lib}).  This file contains
14073prototype information about standard system functions.  This option
14074applies only to @code{protoize}.
14075
14076@item -c @var{compilation-options}
14077Use @var{compilation-options} as the options when running @command{gcc} to
14078produce the @samp{.X} files.  The special option @option{-aux-info} is
14079always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
14080
14081Note that the compilation options must be given as a single argument to
14082@code{protoize} or @code{unprotoize}.  If you want to specify several
14083@command{gcc} options, you must quote the entire set of compilation options
14084to make them a single word in the shell.
14085
14086There are certain @command{gcc} arguments that you cannot use, because they
14087would produce the wrong kind of output.  These include @option{-g},
14088@option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
14089the @var{compilation-options}, they are ignored.
14090
14091@item -C
14092Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
14093systems) instead of @samp{.c}.  This is convenient if you are converting
14094a C program to C++.  This option applies only to @code{protoize}.
14095
14096@item -g
14097Add explicit global declarations.  This means inserting explicit
14098declarations at the beginning of each source file for each function
14099that is called in the file and was not declared.  These declarations
14100precede the first function definition that contains a call to an
14101undeclared function.  This option applies only to @code{protoize}.
14102
14103@item -i @var{string}
14104Indent old-style parameter declarations with the string @var{string}.
14105This option applies only to @code{protoize}.
14106
14107@code{unprotoize} converts prototyped function definitions to old-style
14108function definitions, where the arguments are declared between the
14109argument list and the initial @samp{@{}.  By default, @code{unprotoize}
14110uses five spaces as the indentation.  If you want to indent with just
14111one space instead, use @option{-i " "}.
14112
14113@item -k
14114Keep the @samp{.X} files.  Normally, they are deleted after conversion
14115is finished.
14116
14117@item -l
14118Add explicit local declarations.  @code{protoize} with @option{-l} inserts
14119a prototype declaration for each function in each block which calls the
14120function without any declaration.  This option applies only to
14121@code{protoize}.
14122
14123@item -n
14124Make no real changes.  This mode just prints information about the conversions
14125that would have been done without @option{-n}.
14126
14127@item -N
14128Make no @samp{.save} files.  The original files are simply deleted.
14129Use this option with caution.
14130
14131@item -p @var{program}
14132Use the program @var{program} as the compiler.  Normally, the name
14133@file{gcc} is used.
14134
14135@item -q
14136Work quietly.  Most warnings are suppressed.
14137
14138@item -v
14139Print the version number, just like @option{-v} for @command{gcc}.
14140@end table
14141
14142If you need special compiler options to compile one of your program's
14143source files, then you should generate that file's @samp{.X} file
14144specially, by running @command{gcc} on that source file with the
14145appropriate options and the option @option{-aux-info}.  Then run
14146@code{protoize} on the entire set of files.  @code{protoize} will use
14147the existing @samp{.X} file because it is newer than the source file.
14148For example:
14149
14150@smallexample
14151gcc -Dfoo=bar file1.c -aux-info file1.X
14152protoize *.c
14153@end smallexample
14154
14155@noindent
14156You need to include the special files along with the rest in the
14157@code{protoize} command, even though their @samp{.X} files already
14158exist, because otherwise they won't get converted.
14159
14160@xref{Protoize Caveats}, for more information on how to use
14161@code{protoize} successfully.
14162