OSDN Git Service

* c-common.c, c-parser.c, cfgbuild.c, cfghooks.c, cfghooks.h,
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
60
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
66
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
73
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
78
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
85
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
89
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
96
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
103
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, @option{-fforce-mem},
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
110
111 @c man end
112
113 @xref{Option Index}, for an index to GCC's options.
114
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
170
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
211
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
217
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
242 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
243 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
244 -Wunknown-pragmas  -Wunreachable-code @gol
245 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
246 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
247 -Wvariadic-macros}
248
249 @item C-only Warning Options
250 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
251 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
252 -Wstrict-prototypes  -Wtraditional @gol
253 -Wdeclaration-after-statement -Wno-pointer-sign}
254
255 @item Debugging Options
256 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
257 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
258 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
259 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
260 -fdump-ipa-all -fdump-ipa-cgraph @gol
261 -fdump-tree-all @gol
262 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
263 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
266 -fdump-tree-ch @gol
267 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-nrv -fdump-tree-vect @gol
276 -fdump-tree-sink @gol
277 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-salias @gol
279 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
280 -ftree-vectorizer-verbose=@var{n} @gol
281 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
282 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
283 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
284 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
285 -ftest-coverage  -ftime-report -fvar-tracking @gol
286 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
287 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
288 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
289 -print-multi-directory  -print-multi-lib @gol
290 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
291 -save-temps  -time}
292
293 @item Optimization Options
294 @xref{Optimize Options,,Options that Control Optimization}.
295 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
296 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
297 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
298 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
299 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
300 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
301 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
302 -fdelayed-branch  -fdelete-null-pointer-checks @gol
303 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
304 -fforce-addr  -fforce-mem  -ffunction-sections @gol
305 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
306 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
307 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
308 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
309 -fmodulo-sched -fno-branch-count-reg @gol
310 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
311 -fno-function-cse  -fno-guess-branch-probability @gol
312 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
313 -funsafe-math-optimizations  -ffinite-math-only @gol
314 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
315 -fomit-frame-pointer  -foptimize-register-move @gol
316 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
317 -fprofile-generate -fprofile-use @gol
318 -fregmove  -frename-registers @gol
319 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
320 -frerun-cse-after-loop  -frerun-loop-opt @gol
321 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
322 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
323 -fsched-spec-load-dangerous  @gol
324 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
325 -fsched2-use-superblocks @gol
326 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
327 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
328 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
329 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
330 -fsplit-ivs-in-unroller -funswitch-loops @gol
331 -fvariable-expansion-in-unroller @gol
332 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
333 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
334 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
335 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
336 -ftree-salias -fweb @gol
337 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop @gol
338 --param @var{name}=@var{value}
339 -O  -O0  -O1  -O2  -O3  -Os}
340
341 @item Preprocessor Options
342 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
343 @gccoptlist{-A@var{question}=@var{answer} @gol
344 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
345 -C  -dD  -dI  -dM  -dN @gol
346 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
347 -idirafter @var{dir} @gol
348 -include @var{file}  -imacros @var{file} @gol
349 -iprefix @var{file}  -iwithprefix @var{dir} @gol
350 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
351 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
352 -P  -fworking-directory  -remap @gol
353 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
354 -Xpreprocessor @var{option}}
355
356 @item Assembler Option
357 @xref{Assembler Options,,Passing Options to the Assembler}.
358 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
359
360 @item Linker Options
361 @xref{Link Options,,Options for Linking}.
362 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
363 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
364 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
365 -Wl,@var{option}  -Xlinker @var{option} @gol
366 -u @var{symbol}}
367
368 @item Directory Options
369 @xref{Directory Options,,Options for Directory Search}.
370 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
371
372 @item Target Options
373 @c I wrote this xref this way to avoid overfull hbox. -- rms
374 @xref{Target Options}.
375 @gccoptlist{-V @var{version}  -b @var{machine}}
376
377 @item Machine Dependent Options
378 @xref{Submodel Options,,Hardware Models and Configurations}.
379 @c This list is ordered alphanumerically by subsection name.
380 @c Try and put the significant identifier (CPU or system) first,
381 @c so users have a clue at guessing where the ones they want will be.
382
383 @emph{ARC Options}
384 @gccoptlist{-EB  -EL @gol
385 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
386 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
387
388 @emph{ARM Options}
389 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
390 -mabi=@var{name} @gol
391 -mapcs-stack-check  -mno-apcs-stack-check @gol
392 -mapcs-float  -mno-apcs-float @gol
393 -mapcs-reentrant  -mno-apcs-reentrant @gol
394 -msched-prolog  -mno-sched-prolog @gol
395 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
396 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
397 -mthumb-interwork  -mno-thumb-interwork @gol
398 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
399 -mstructure-size-boundary=@var{n} @gol
400 -mabort-on-noreturn @gol
401 -mlong-calls  -mno-long-calls @gol
402 -msingle-pic-base  -mno-single-pic-base @gol
403 -mpic-register=@var{reg} @gol
404 -mnop-fun-dllimport @gol
405 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
406 -mpoke-function-name @gol
407 -mthumb  -marm @gol
408 -mtpcs-frame  -mtpcs-leaf-frame @gol
409 -mcaller-super-interworking  -mcallee-super-interworking}
410
411 @emph{AVR Options}
412 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
413 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
414
415 @emph{Blackfin Options}
416 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer -mcsync @gol
417 -mno-csync -mlow-64k -mno-low64k -mid-shared-library @gol
418 -mno-id-shared-library -mshared-library-id=@var{n} @gol}
419
420 @emph{CRIS Options}
421 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
422 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
423 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
424 -mstack-align  -mdata-align  -mconst-align @gol
425 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
426 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
427 -mmul-bug-workaround  -mno-mul-bug-workaround}
428
429 @emph{Darwin Options}
430 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
431 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
432 -client_name  -compatibility_version  -current_version @gol
433 -dead_strip @gol
434 -dependency-file  -dylib_file  -dylinker_install_name @gol
435 -dynamic  -dynamiclib  -exported_symbols_list @gol
436 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
437 -force_flat_namespace  -headerpad_max_install_names @gol
438 -image_base  -init  -install_name  -keep_private_externs @gol
439 -multi_module  -multiply_defined  -multiply_defined_unused @gol
440 -noall_load   -no_dead_strip_inits_and_terms @gol
441 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
442 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
443 -private_bundle  -read_only_relocs  -sectalign @gol
444 -sectobjectsymbols  -whyload  -seg1addr @gol
445 -sectcreate  -sectobjectsymbols  -sectorder @gol
446 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
447 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
448 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
449 -single_module  -static  -sub_library  -sub_umbrella @gol
450 -twolevel_namespace  -umbrella  -undefined @gol
451 -unexported_symbols_list  -weak_reference_mismatches @gol
452 -whatsloaded -F -gused -gfull -mone-byte-bool}
453
454 @emph{DEC Alpha Options}
455 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
456 -mieee  -mieee-with-inexact  -mieee-conformant @gol
457 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
458 -mtrap-precision=@var{mode}  -mbuild-constants @gol
459 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
460 -mbwx  -mmax  -mfix  -mcix @gol
461 -mfloat-vax  -mfloat-ieee @gol
462 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
463 -msmall-text  -mlarge-text @gol
464 -mmemory-latency=@var{time}}
465
466 @emph{DEC Alpha/VMS Options}
467 @gccoptlist{-mvms-return-codes}
468
469 @emph{FRV Options}
470 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
471 -mhard-float  -msoft-float @gol
472 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
473 -mdouble  -mno-double @gol
474 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
475 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
476 -mlinked-fp  -mlong-calls  -malign-labels @gol
477 -mlibrary-pic  -macc-4  -macc-8 @gol
478 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
479 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
480 -mvliw-branch  -mno-vliw-branch @gol
481 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
482 -mno-nested-cond-exec  -mtomcat-stats @gol
483 -mTLS -mtls @gol
484 -mcpu=@var{cpu}}
485
486 @emph{H8/300 Options}
487 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
488
489 @emph{HPPA Options}
490 @gccoptlist{-march=@var{architecture-type} @gol
491 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
492 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
493 -mfixed-range=@var{register-range} @gol
494 -mjump-in-delay -mlinker-opt -mlong-calls @gol
495 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
496 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
497 -mno-jump-in-delay  -mno-long-load-store @gol
498 -mno-portable-runtime  -mno-soft-float @gol
499 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
500 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
501 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
502 -munix=@var{unix-std}  -nolibdld  -static  -threads}
503
504 @emph{i386 and x86-64 Options}
505 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
506 -mfpmath=@var{unit} @gol
507 -masm=@var{dialect}  -mno-fancy-math-387 @gol
508 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
509 -mno-wide-multiply  -mrtd  -malign-double @gol
510 -mpreferred-stack-boundary=@var{num} @gol
511 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
512 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
513 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
514 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
515 -mno-red-zone -mno-tls-direct-seg-refs @gol
516 -mcmodel=@var{code-model} @gol
517 -m32  -m64}
518
519 @emph{IA-64 Options}
520 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
521 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
522 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
523 -minline-float-divide-max-throughput @gol
524 -minline-int-divide-min-latency @gol
525 -minline-int-divide-max-throughput  @gol
526 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
527 -mno-dwarf2-asm -mearly-stop-bits @gol
528 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
529 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
530
531 @emph{M32R/D Options}
532 @gccoptlist{-m32r2 -m32rx -m32r @gol
533 -mdebug @gol
534 -malign-loops -mno-align-loops @gol
535 -missue-rate=@var{number} @gol
536 -mbranch-cost=@var{number} @gol
537 -mmodel=@var{code-size-model-type} @gol
538 -msdata=@var{sdata-type} @gol
539 -mno-flush-func -mflush-func=@var{name} @gol
540 -mno-flush-trap -mflush-trap=@var{number} @gol
541 -G @var{num}}
542
543 @emph{M680x0 Options}
544 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
545 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
546 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
547 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
548 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
549
550 @emph{M68hc1x Options}
551 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
552 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
553 -msoft-reg-count=@var{count}}
554
555 @emph{MCore Options}
556 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
557 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
558 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
559 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
560 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
561
562 @emph{MIPS Options}
563 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
564 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
565 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
566 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
567 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
568 -mpaired-single  -mips3d @gol
569 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
570 -G@var{num}  -membedded-data  -mno-embedded-data @gol
571 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
572 -msplit-addresses  -mno-split-addresses  @gol
573 -mexplicit-relocs  -mno-explicit-relocs  @gol
574 -mcheck-zero-division  -mno-check-zero-division @gol
575 -mdivide-traps  -mdivide-breaks @gol
576 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
577 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
578 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
579 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
580 -mfix-sb1  -mno-fix-sb1 @gol
581 -mflush-func=@var{func}  -mno-flush-func @gol
582 -mbranch-likely  -mno-branch-likely @gol
583 -mfp-exceptions -mno-fp-exceptions @gol
584 -mvr4130-align -mno-vr4130-align}
585
586 @emph{MMIX Options}
587 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
588 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
589 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
590 -mno-base-addresses  -msingle-exit  -mno-single-exit}
591
592 @emph{MN10300 Options}
593 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
594 -mam33  -mno-am33 @gol
595 -mam33-2  -mno-am33-2 @gol
596 -mno-crt0  -mrelax}
597
598 @emph{NS32K Options}
599 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
600 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
601 -mregparam  -mnoregparam  -msb  -mnosb @gol
602 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
603
604 @emph{PDP-11 Options}
605 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
606 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
607 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
608 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
609 -mbranch-expensive  -mbranch-cheap @gol
610 -msplit  -mno-split  -munix-asm  -mdec-asm}
611
612 @emph{PowerPC Options}
613 See RS/6000 and PowerPC Options.
614
615 @emph{RS/6000 and PowerPC Options}
616 @gccoptlist{-mcpu=@var{cpu-type} @gol
617 -mtune=@var{cpu-type} @gol
618 -mpower  -mno-power  -mpower2  -mno-power2 @gol
619 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
620 -maltivec  -mno-altivec @gol
621 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
622 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
623 -mnew-mnemonics  -mold-mnemonics @gol
624 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
625 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
626 -malign-power  -malign-natural @gol
627 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
628 -mstring  -mno-string  -mupdate  -mno-update @gol
629 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
630 -mstrict-align  -mno-strict-align  -mrelocatable @gol
631 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
632 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
633 -mdynamic-no-pic @gol
634 -mprioritize-restricted-insns=@var{priority} @gol
635 -msched-costly-dep=@var{dependence_type} @gol
636 -minsert-sched-nops=@var{scheme} @gol
637 -mcall-sysv  -mcall-netbsd @gol
638 -maix-struct-return  -msvr4-struct-return @gol
639 -mabi=@var{abi-type} @gol
640 -misel -mno-isel @gol
641 -misel=yes  -misel=no @gol
642 -mspe -mno-spe @gol
643 -mspe=yes  -mspe=no @gol
644 -mvrsave -mno-vrsave @gol
645 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
646 -mprototype  -mno-prototype @gol
647 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
648 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
649
650 @emph{S/390 and zSeries Options}
651 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
652 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
653 -mpacked-stack  -mno-packed-stack @gol
654 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
655 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
656 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
657 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
658
659 @emph{SH Options}
660 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
661 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
662 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
663 -m5-64media  -m5-64media-nofpu @gol
664 -m5-32media  -m5-32media-nofpu @gol
665 -m5-compact  -m5-compact-nofpu @gol
666 -mb  -ml  -mdalign  -mrelax @gol
667 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
668 -mieee  -misize  -mpadstruct  -mspace @gol
669 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
670 -mdivsi3_libfunc=@var{name}  @gol
671 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
672  -minvalid-symbols}
673
674 @emph{SPARC Options}
675 @gccoptlist{-mcpu=@var{cpu-type} @gol
676 -mtune=@var{cpu-type} @gol
677 -mcmodel=@var{code-model} @gol
678 -m32  -m64  -mapp-regs  -mno-app-regs @gol
679 -mfaster-structs  -mno-faster-structs @gol
680 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
681 -mhard-quad-float  -msoft-quad-float @gol
682 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
683 -mstack-bias  -mno-stack-bias @gol
684 -munaligned-doubles  -mno-unaligned-doubles @gol
685 -mv8plus  -mno-v8plus  -mvis  -mno-vis
686 -threads -pthreads}
687
688 @emph{System V Options}
689 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
690
691 @emph{TMS320C3x/C4x Options}
692 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
693 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
694 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
695 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
696
697 @emph{V850 Options}
698 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
699 -mprolog-function  -mno-prolog-function  -mspace @gol
700 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
701 -mapp-regs  -mno-app-regs @gol
702 -mdisable-callt  -mno-disable-callt @gol
703 -mv850e1 @gol
704 -mv850e @gol
705 -mv850  -mbig-switch}
706
707 @emph{VAX Options}
708 @gccoptlist{-mg  -mgnu  -munix}
709
710 @emph{x86-64 Options}
711 See i386 and x86-64 Options.
712
713 @emph{Xstormy16 Options}
714 @gccoptlist{-msim}
715
716 @emph{Xtensa Options}
717 @gccoptlist{-mconst16 -mno-const16 @gol
718 -mfused-madd  -mno-fused-madd @gol
719 -mtext-section-literals  -mno-text-section-literals @gol
720 -mtarget-align  -mno-target-align @gol
721 -mlongcalls  -mno-longcalls}
722
723 @emph{zSeries Options}
724 See S/390 and zSeries Options.
725
726 @item Code Generation Options
727 @xref{Code Gen Options,,Options for Code Generation Conventions}.
728 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
729 -ffixed-@var{reg}  -fexceptions @gol
730 -fnon-call-exceptions  -funwind-tables @gol
731 -fasynchronous-unwind-tables @gol
732 -finhibit-size-directive  -finstrument-functions @gol
733 -fno-common  -fno-ident @gol
734 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
735 -freg-struct-return  -fshared-data  -fshort-enums @gol
736 -fshort-double  -fshort-wchar @gol
737 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
738 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
739 -fargument-alias  -fargument-noalias @gol
740 -fargument-noalias-global  -fleading-underscore @gol
741 -ftls-model=@var{model} @gol
742 -ftrapv  -fwrapv  -fbounds-check @gol
743 -fvisibility}
744 @end table
745
746 @menu
747 * Overall Options::     Controlling the kind of output:
748                         an executable, object files, assembler files,
749                         or preprocessed source.
750 * C Dialect Options::   Controlling the variant of C language compiled.
751 * C++ Dialect Options:: Variations on C++.
752 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
753                         and Objective-C++.
754 * Language Independent Options:: Controlling how diagnostics should be
755                         formatted.
756 * Warning Options::     How picky should the compiler be?
757 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
758 * Optimize Options::    How much optimization?
759 * Preprocessor Options:: Controlling header files and macro definitions.
760                          Also, getting dependency information for Make.
761 * Assembler Options::   Passing options to the assembler.
762 * Link Options::        Specifying libraries and so on.
763 * Directory Options::   Where to find header files and libraries.
764                         Where to find the compiler executable files.
765 * Spec Files::          How to pass switches to sub-processes.
766 * Target Options::      Running a cross-compiler, or an old version of GCC.
767 @end menu
768
769 @node Overall Options
770 @section Options Controlling the Kind of Output
771
772 Compilation can involve up to four stages: preprocessing, compilation
773 proper, assembly and linking, always in that order.  GCC is capable of
774 preprocessing and compiling several files either into several
775 assembler input files, or into one assembler input file; then each
776 assembler input file produces an object file, and linking combines all
777 the object files (those newly compiled, and those specified as input)
778 into an executable file.
779
780 @cindex file name suffix
781 For any given input file, the file name suffix determines what kind of
782 compilation is done:
783
784 @table @gcctabopt
785 @item @var{file}.c
786 C source code which must be preprocessed.
787
788 @item @var{file}.i
789 C source code which should not be preprocessed.
790
791 @item @var{file}.ii
792 C++ source code which should not be preprocessed.
793
794 @item @var{file}.m
795 Objective-C source code.  Note that you must link with the @file{libobjc}
796 library to make an Objective-C program work.
797
798 @item @var{file}.mi
799 Objective-C source code which should not be preprocessed.
800
801 @item @var{file}.mm
802 @itemx @var{file}.M
803 Objective-C++ source code.  Note that you must link with the @file{libobjc}
804 library to make an Objective-C++ program work.  Note that @samp{.M} refers
805 to a literal capital M@.
806
807 @item @var{file}.mii
808 Objective-C++ source code which should not be preprocessed.
809
810 @item @var{file}.h
811 C, C++, Objective-C or Objective-C++ header file to be turned into a
812 precompiled header.
813
814 @item @var{file}.cc
815 @itemx @var{file}.cp
816 @itemx @var{file}.cxx
817 @itemx @var{file}.cpp
818 @itemx @var{file}.CPP
819 @itemx @var{file}.c++
820 @itemx @var{file}.C
821 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
822 the last two letters must both be literally @samp{x}.  Likewise,
823 @samp{.C} refers to a literal capital C@.
824
825 @item @var{file}.mm
826 @itemx @var{file}.M
827 Objective-C++ source code which must be preprocessed.
828
829 @item @var{file}.mii
830 Objective-C++ source code which should not be preprocessed.
831
832 @item @var{file}.hh
833 @itemx @var{file}.H
834 C++ header file to be turned into a precompiled header.
835
836 @item @var{file}.f
837 @itemx @var{file}.for
838 @itemx @var{file}.FOR
839 Fortran source code which should not be preprocessed.
840
841 @item @var{file}.F
842 @itemx @var{file}.fpp
843 @itemx @var{file}.FPP
844 Fortran source code which must be preprocessed (with the traditional
845 preprocessor).
846
847 @item @var{file}.r
848 Fortran source code which must be preprocessed with a RATFOR
849 preprocessor (not included with GCC)@.
850
851 @item @var{file}.f90
852 @itemx @var{file}.f95
853 Fortran 90/95 source code which should not be preprocessed.
854
855 @c FIXME: Descriptions of Java file types.
856 @c @var{file}.java
857 @c @var{file}.class
858 @c @var{file}.zip
859 @c @var{file}.jar
860
861 @item @var{file}.ads
862 Ada source code file which contains a library unit declaration (a
863 declaration of a package, subprogram, or generic, or a generic
864 instantiation), or a library unit renaming declaration (a package,
865 generic, or subprogram renaming declaration).  Such files are also
866 called @dfn{specs}.
867
868 @itemx @var{file}.adb
869 Ada source code file containing a library unit body (a subprogram or
870 package body).  Such files are also called @dfn{bodies}.
871
872 @c GCC also knows about some suffixes for languages not yet included:
873 @c Pascal:
874 @c @var{file}.p
875 @c @var{file}.pas
876
877 @item @var{file}.s
878 Assembler code.
879
880 @item @var{file}.S
881 Assembler code which must be preprocessed.
882
883 @item @var{other}
884 An object file to be fed straight into linking.
885 Any file name with no recognized suffix is treated this way.
886 @end table
887
888 @opindex x
889 You can specify the input language explicitly with the @option{-x} option:
890
891 @table @gcctabopt
892 @item -x @var{language}
893 Specify explicitly the @var{language} for the following input files
894 (rather than letting the compiler choose a default based on the file
895 name suffix).  This option applies to all following input files until
896 the next @option{-x} option.  Possible values for @var{language} are:
897 @smallexample
898 c  c-header  c-cpp-output
899 c++  c++-header  c++-cpp-output
900 objective-c  objective-c-header  objective-c-cpp-output
901 objective-c++ objective-c++-header objective-c++-cpp-output
902 assembler  assembler-with-cpp
903 ada
904 f77  f77-cpp-input  ratfor
905 f95
906 java
907 treelang
908 @end smallexample
909
910 @item -x none
911 Turn off any specification of a language, so that subsequent files are
912 handled according to their file name suffixes (as they are if @option{-x}
913 has not been used at all).
914
915 @item -pass-exit-codes
916 @opindex pass-exit-codes
917 Normally the @command{gcc} program will exit with the code of 1 if any
918 phase of the compiler returns a non-success return code.  If you specify
919 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
920 numerically highest error produced by any phase that returned an error
921 indication.
922 @end table
923
924 If you only want some of the stages of compilation, you can use
925 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
926 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
927 @command{gcc} is to stop.  Note that some combinations (for example,
928 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
929
930 @table @gcctabopt
931 @item -c
932 @opindex c
933 Compile or assemble the source files, but do not link.  The linking
934 stage simply is not done.  The ultimate output is in the form of an
935 object file for each source file.
936
937 By default, the object file name for a source file is made by replacing
938 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
939
940 Unrecognized input files, not requiring compilation or assembly, are
941 ignored.
942
943 @item -S
944 @opindex S
945 Stop after the stage of compilation proper; do not assemble.  The output
946 is in the form of an assembler code file for each non-assembler input
947 file specified.
948
949 By default, the assembler file name for a source file is made by
950 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
951
952 Input files that don't require compilation are ignored.
953
954 @item -E
955 @opindex E
956 Stop after the preprocessing stage; do not run the compiler proper.  The
957 output is in the form of preprocessed source code, which is sent to the
958 standard output.
959
960 Input files which don't require preprocessing are ignored.
961
962 @cindex output file option
963 @item -o @var{file}
964 @opindex o
965 Place output in file @var{file}.  This applies regardless to whatever
966 sort of output is being produced, whether it be an executable file,
967 an object file, an assembler file or preprocessed C code.
968
969 If @option{-o} is not specified, the default is to put an executable
970 file in @file{a.out}, the object file for
971 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
972 assembler file in @file{@var{source}.s}, a precompiled header file in
973 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
974 standard output.
975
976 @item -v
977 @opindex v
978 Print (on standard error output) the commands executed to run the stages
979 of compilation.  Also print the version number of the compiler driver
980 program and of the preprocessor and the compiler proper.
981
982 @item -###
983 @opindex ###
984 Like @option{-v} except the commands are not executed and all command
985 arguments are quoted.  This is useful for shell scripts to capture the
986 driver-generated command lines.
987
988 @item -pipe
989 @opindex pipe
990 Use pipes rather than temporary files for communication between the
991 various stages of compilation.  This fails to work on some systems where
992 the assembler is unable to read from a pipe; but the GNU assembler has
993 no trouble.
994
995 @item -combine
996 @opindex combine
997 If you are compiling multiple source files, this option tells the driver
998 to pass all the source files to the compiler at once (for those
999 languages for which the compiler can handle this).  This will allow
1000 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1001 language for which this is supported is C@.  If you pass source files for
1002 multiple languages to the driver, using this option, the driver will invoke
1003 the compiler(s) that support IMA once each, passing each compiler all the
1004 source files appropriate for it.  For those languages that do not support
1005 IMA this option will be ignored, and the compiler will be invoked once for
1006 each source file in that language.  If you use this option in conjunction
1007 with @option{-save-temps}, the compiler will generate multiple
1008 pre-processed files
1009 (one for each source file), but only one (combined) @file{.o} or
1010 @file{.s} file.
1011
1012 @item --help
1013 @opindex help
1014 Print (on the standard output) a description of the command line options
1015 understood by @command{gcc}.  If the @option{-v} option is also specified
1016 then @option{--help} will also be passed on to the various processes
1017 invoked by @command{gcc}, so that they can display the command line options
1018 they accept.  If the @option{-Wextra} option is also specified then command
1019 line options which have no documentation associated with them will also
1020 be displayed.
1021
1022 @item --target-help
1023 @opindex target-help
1024 Print (on the standard output) a description of target specific command
1025 line options for each tool.
1026
1027 @item --version
1028 @opindex version
1029 Display the version number and copyrights of the invoked GCC@.
1030 @end table
1031
1032 @node Invoking G++
1033 @section Compiling C++ Programs
1034
1035 @cindex suffixes for C++ source
1036 @cindex C++ source file suffixes
1037 C++ source files conventionally use one of the suffixes @samp{.C},
1038 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1039 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1040 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1041 files with these names and compiles them as C++ programs even if you
1042 call the compiler the same way as for compiling C programs (usually
1043 with the name @command{gcc}).
1044
1045 @findex g++
1046 @findex c++
1047 However, C++ programs often require class libraries as well as a
1048 compiler that understands the C++ language---and under some
1049 circumstances, you might want to compile programs or header files from
1050 standard input, or otherwise without a suffix that flags them as C++
1051 programs.  You might also like to precompile a C header file with a
1052 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1053 program that calls GCC with the default language set to C++, and
1054 automatically specifies linking against the C++ library.  On many
1055 systems, @command{g++} is also installed with the name @command{c++}.
1056
1057 @cindex invoking @command{g++}
1058 When you compile C++ programs, you may specify many of the same
1059 command-line options that you use for compiling programs in any
1060 language; or command-line options meaningful for C and related
1061 languages; or options that are meaningful only for C++ programs.
1062 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1063 explanations of options for languages related to C@.
1064 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1065 explanations of options that are meaningful only for C++ programs.
1066
1067 @node C Dialect Options
1068 @section Options Controlling C Dialect
1069 @cindex dialect options
1070 @cindex language dialect options
1071 @cindex options, dialect
1072
1073 The following options control the dialect of C (or languages derived
1074 from C, such as C++, Objective-C and Objective-C++) that the compiler
1075 accepts:
1076
1077 @table @gcctabopt
1078 @cindex ANSI support
1079 @cindex ISO support
1080 @item -ansi
1081 @opindex ansi
1082 In C mode, support all ISO C90 programs.  In C++ mode,
1083 remove GNU extensions that conflict with ISO C++.
1084
1085 This turns off certain features of GCC that are incompatible with ISO
1086 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1087 such as the @code{asm} and @code{typeof} keywords, and
1088 predefined macros such as @code{unix} and @code{vax} that identify the
1089 type of system you are using.  It also enables the undesirable and
1090 rarely used ISO trigraph feature.  For the C compiler,
1091 it disables recognition of C++ style @samp{//} comments as well as
1092 the @code{inline} keyword.
1093
1094 The alternate keywords @code{__asm__}, @code{__extension__},
1095 @code{__inline__} and @code{__typeof__} continue to work despite
1096 @option{-ansi}.  You would not want to use them in an ISO C program, of
1097 course, but it is useful to put them in header files that might be included
1098 in compilations done with @option{-ansi}.  Alternate predefined macros
1099 such as @code{__unix__} and @code{__vax__} are also available, with or
1100 without @option{-ansi}.
1101
1102 The @option{-ansi} option does not cause non-ISO programs to be
1103 rejected gratuitously.  For that, @option{-pedantic} is required in
1104 addition to @option{-ansi}.  @xref{Warning Options}.
1105
1106 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1107 option is used.  Some header files may notice this macro and refrain
1108 from declaring certain functions or defining certain macros that the
1109 ISO standard doesn't call for; this is to avoid interfering with any
1110 programs that might use these names for other things.
1111
1112 Functions which would normally be built in but do not have semantics
1113 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1114 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1115 built-in functions provided by GCC}, for details of the functions
1116 affected.
1117
1118 @item -std=
1119 @opindex std
1120 Determine the language standard.  This option is currently only
1121 supported when compiling C or C++.  A value for this option must be
1122 provided; possible values are
1123
1124 @table @samp
1125 @item c89
1126 @itemx iso9899:1990
1127 ISO C90 (same as @option{-ansi}).
1128
1129 @item iso9899:199409
1130 ISO C90 as modified in amendment 1.
1131
1132 @item c99
1133 @itemx c9x
1134 @itemx iso9899:1999
1135 @itemx iso9899:199x
1136 ISO C99.  Note that this standard is not yet fully supported; see
1137 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1138 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1139
1140 @item gnu89
1141 Default, ISO C90 plus GNU extensions (including some C99 features).
1142
1143 @item gnu99
1144 @itemx gnu9x
1145 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1146 this will become the default.  The name @samp{gnu9x} is deprecated.
1147
1148 @item c++98
1149 The 1998 ISO C++ standard plus amendments.
1150
1151 @item gnu++98
1152 The same as @option{-std=c++98} plus GNU extensions.  This is the
1153 default for C++ code.
1154 @end table
1155
1156 Even when this option is not specified, you can still use some of the
1157 features of newer standards in so far as they do not conflict with
1158 previous C standards.  For example, you may use @code{__restrict__} even
1159 when @option{-std=c99} is not specified.
1160
1161 The @option{-std} options specifying some version of ISO C have the same
1162 effects as @option{-ansi}, except that features that were not in ISO C90
1163 but are in the specified version (for example, @samp{//} comments and
1164 the @code{inline} keyword in ISO C99) are not disabled.
1165
1166 @xref{Standards,,Language Standards Supported by GCC}, for details of
1167 these standard versions.
1168
1169 @item -aux-info @var{filename}
1170 @opindex aux-info
1171 Output to the given filename prototyped declarations for all functions
1172 declared and/or defined in a translation unit, including those in header
1173 files.  This option is silently ignored in any language other than C@.
1174
1175 Besides declarations, the file indicates, in comments, the origin of
1176 each declaration (source file and line), whether the declaration was
1177 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1178 @samp{O} for old, respectively, in the first character after the line
1179 number and the colon), and whether it came from a declaration or a
1180 definition (@samp{C} or @samp{F}, respectively, in the following
1181 character).  In the case of function definitions, a K&R-style list of
1182 arguments followed by their declarations is also provided, inside
1183 comments, after the declaration.
1184
1185 @item -fno-asm
1186 @opindex fno-asm
1187 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1188 keyword, so that code can use these words as identifiers.  You can use
1189 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1190 instead.  @option{-ansi} implies @option{-fno-asm}.
1191
1192 In C++, this switch only affects the @code{typeof} keyword, since
1193 @code{asm} and @code{inline} are standard keywords.  You may want to
1194 use the @option{-fno-gnu-keywords} flag instead, which has the same
1195 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1196 switch only affects the @code{asm} and @code{typeof} keywords, since
1197 @code{inline} is a standard keyword in ISO C99.
1198
1199 @item -fno-builtin
1200 @itemx -fno-builtin-@var{function}
1201 @opindex fno-builtin
1202 @cindex built-in functions
1203 Don't recognize built-in functions that do not begin with
1204 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1205 functions provided by GCC}, for details of the functions affected,
1206 including those which are not built-in functions when @option{-ansi} or
1207 @option{-std} options for strict ISO C conformance are used because they
1208 do not have an ISO standard meaning.
1209
1210 GCC normally generates special code to handle certain built-in functions
1211 more efficiently; for instance, calls to @code{alloca} may become single
1212 instructions that adjust the stack directly, and calls to @code{memcpy}
1213 may become inline copy loops.  The resulting code is often both smaller
1214 and faster, but since the function calls no longer appear as such, you
1215 cannot set a breakpoint on those calls, nor can you change the behavior
1216 of the functions by linking with a different library.  In addition,
1217 when a function is recognized as a built-in function, GCC may use
1218 information about that function to warn about problems with calls to
1219 that function, or to generate more efficient code, even if the
1220 resulting code still contains calls to that function.  For example,
1221 warnings are given with @option{-Wformat} for bad calls to
1222 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1223 known not to modify global memory.
1224
1225 With the @option{-fno-builtin-@var{function}} option
1226 only the built-in function @var{function} is
1227 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1228 function is named this is not built-in in this version of GCC, this
1229 option is ignored.  There is no corresponding
1230 @option{-fbuiltin-@var{function}} option; if you wish to enable
1231 built-in functions selectively when using @option{-fno-builtin} or
1232 @option{-ffreestanding}, you may define macros such as:
1233
1234 @smallexample
1235 #define abs(n)          __builtin_abs ((n))
1236 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1237 @end smallexample
1238
1239 @item -fhosted
1240 @opindex fhosted
1241 @cindex hosted environment
1242
1243 Assert that compilation takes place in a hosted environment.  This implies
1244 @option{-fbuiltin}.  A hosted environment is one in which the
1245 entire standard library is available, and in which @code{main} has a return
1246 type of @code{int}.  Examples are nearly everything except a kernel.
1247 This is equivalent to @option{-fno-freestanding}.
1248
1249 @item -ffreestanding
1250 @opindex ffreestanding
1251 @cindex hosted environment
1252
1253 Assert that compilation takes place in a freestanding environment.  This
1254 implies @option{-fno-builtin}.  A freestanding environment
1255 is one in which the standard library may not exist, and program startup may
1256 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1257 This is equivalent to @option{-fno-hosted}.
1258
1259 @xref{Standards,,Language Standards Supported by GCC}, for details of
1260 freestanding and hosted environments.
1261
1262 @item -fms-extensions
1263 @opindex fms-extensions
1264 Accept some non-standard constructs used in Microsoft header files.
1265
1266 Some cases of unnamed fields in structures and unions are only
1267 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1268 fields within structs/unions}, for details.
1269
1270 @item -trigraphs
1271 @opindex trigraphs
1272 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1273 options for strict ISO C conformance) implies @option{-trigraphs}.
1274
1275 @item -no-integrated-cpp
1276 @opindex no-integrated-cpp
1277 Performs a compilation in two passes: preprocessing and compiling.  This
1278 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1279 @option{-B} option.  The user supplied compilation step can then add in
1280 an additional preprocessing step after normal preprocessing but before
1281 compiling.  The default is to use the integrated cpp (internal cpp)
1282
1283 The semantics of this option will change if "cc1", "cc1plus", and
1284 "cc1obj" are merged.
1285
1286 @cindex traditional C language
1287 @cindex C language, traditional
1288 @item -traditional
1289 @itemx -traditional-cpp
1290 @opindex traditional-cpp
1291 @opindex traditional
1292 Formerly, these options caused GCC to attempt to emulate a pre-standard
1293 C compiler.  They are now only supported with the @option{-E} switch.
1294 The preprocessor continues to support a pre-standard mode.  See the GNU
1295 CPP manual for details.
1296
1297 @item -fcond-mismatch
1298 @opindex fcond-mismatch
1299 Allow conditional expressions with mismatched types in the second and
1300 third arguments.  The value of such an expression is void.  This option
1301 is not supported for C++.
1302
1303 @item -funsigned-char
1304 @opindex funsigned-char
1305 Let the type @code{char} be unsigned, like @code{unsigned char}.
1306
1307 Each kind of machine has a default for what @code{char} should
1308 be.  It is either like @code{unsigned char} by default or like
1309 @code{signed char} by default.
1310
1311 Ideally, a portable program should always use @code{signed char} or
1312 @code{unsigned char} when it depends on the signedness of an object.
1313 But many programs have been written to use plain @code{char} and
1314 expect it to be signed, or expect it to be unsigned, depending on the
1315 machines they were written for.  This option, and its inverse, let you
1316 make such a program work with the opposite default.
1317
1318 The type @code{char} is always a distinct type from each of
1319 @code{signed char} or @code{unsigned char}, even though its behavior
1320 is always just like one of those two.
1321
1322 @item -fsigned-char
1323 @opindex fsigned-char
1324 Let the type @code{char} be signed, like @code{signed char}.
1325
1326 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1327 the negative form of @option{-funsigned-char}.  Likewise, the option
1328 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1329
1330 @item -fsigned-bitfields
1331 @itemx -funsigned-bitfields
1332 @itemx -fno-signed-bitfields
1333 @itemx -fno-unsigned-bitfields
1334 @opindex fsigned-bitfields
1335 @opindex funsigned-bitfields
1336 @opindex fno-signed-bitfields
1337 @opindex fno-unsigned-bitfields
1338 These options control whether a bit-field is signed or unsigned, when the
1339 declaration does not use either @code{signed} or @code{unsigned}.  By
1340 default, such a bit-field is signed, because this is consistent: the
1341 basic integer types such as @code{int} are signed types.
1342 @end table
1343
1344 @node C++ Dialect Options
1345 @section Options Controlling C++ Dialect
1346
1347 @cindex compiler options, C++
1348 @cindex C++ options, command line
1349 @cindex options, C++
1350 This section describes the command-line options that are only meaningful
1351 for C++ programs; but you can also use most of the GNU compiler options
1352 regardless of what language your program is in.  For example, you
1353 might compile a file @code{firstClass.C} like this:
1354
1355 @smallexample
1356 g++ -g -frepo -O -c firstClass.C
1357 @end smallexample
1358
1359 @noindent
1360 In this example, only @option{-frepo} is an option meant
1361 only for C++ programs; you can use the other options with any
1362 language supported by GCC@.
1363
1364 Here is a list of options that are @emph{only} for compiling C++ programs:
1365
1366 @table @gcctabopt
1367
1368 @item -fabi-version=@var{n}
1369 @opindex fabi-version
1370 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1371 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1372 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1373 the version that conforms most closely to the C++ ABI specification.
1374 Therefore, the ABI obtained using version 0 will change as ABI bugs
1375 are fixed.
1376
1377 The default is version 2.
1378
1379 @item -fno-access-control
1380 @opindex fno-access-control
1381 Turn off all access checking.  This switch is mainly useful for working
1382 around bugs in the access control code.
1383
1384 @item -fcheck-new
1385 @opindex fcheck-new
1386 Check that the pointer returned by @code{operator new} is non-null
1387 before attempting to modify the storage allocated.  This check is
1388 normally unnecessary because the C++ standard specifies that
1389 @code{operator new} will only return @code{0} if it is declared
1390 @samp{throw()}, in which case the compiler will always check the
1391 return value even without this option.  In all other cases, when
1392 @code{operator new} has a non-empty exception specification, memory
1393 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1394 @samp{new (nothrow)}.
1395
1396 @item -fconserve-space
1397 @opindex fconserve-space
1398 Put uninitialized or runtime-initialized global variables into the
1399 common segment, as C does.  This saves space in the executable at the
1400 cost of not diagnosing duplicate definitions.  If you compile with this
1401 flag and your program mysteriously crashes after @code{main()} has
1402 completed, you may have an object that is being destroyed twice because
1403 two definitions were merged.
1404
1405 This option is no longer useful on most targets, now that support has
1406 been added for putting variables into BSS without making them common.
1407
1408 @item -fno-const-strings
1409 @opindex fno-const-strings
1410 Give string constants type @code{char *} instead of type @code{const
1411 char *}.  By default, G++ uses type @code{const char *} as required by
1412 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1413 actually modify the value of a string constant.
1414
1415 This option might be removed in a future release of G++.  For maximum
1416 portability, you should structure your code so that it works with
1417 string constants that have type @code{const char *}.
1418
1419 @item -fno-elide-constructors
1420 @opindex fno-elide-constructors
1421 The C++ standard allows an implementation to omit creating a temporary
1422 which is only used to initialize another object of the same type.
1423 Specifying this option disables that optimization, and forces G++ to
1424 call the copy constructor in all cases.
1425
1426 @item -fno-enforce-eh-specs
1427 @opindex fno-enforce-eh-specs
1428 Don't check for violation of exception specifications at runtime.  This
1429 option violates the C++ standard, but may be useful for reducing code
1430 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1431 will still optimize based on the exception specifications.
1432
1433 @item -ffor-scope
1434 @itemx -fno-for-scope
1435 @opindex ffor-scope
1436 @opindex fno-for-scope
1437 If @option{-ffor-scope} is specified, the scope of variables declared in
1438 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1439 as specified by the C++ standard.
1440 If @option{-fno-for-scope} is specified, the scope of variables declared in
1441 a @i{for-init-statement} extends to the end of the enclosing scope,
1442 as was the case in old versions of G++, and other (traditional)
1443 implementations of C++.
1444
1445 The default if neither flag is given to follow the standard,
1446 but to allow and give a warning for old-style code that would
1447 otherwise be invalid, or have different behavior.
1448
1449 @item -fno-gnu-keywords
1450 @opindex fno-gnu-keywords
1451 Do not recognize @code{typeof} as a keyword, so that code can use this
1452 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1453 @option{-ansi} implies @option{-fno-gnu-keywords}.
1454
1455 @item -fno-implicit-templates
1456 @opindex fno-implicit-templates
1457 Never emit code for non-inline templates which are instantiated
1458 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1459 @xref{Template Instantiation}, for more information.
1460
1461 @item -fno-implicit-inline-templates
1462 @opindex fno-implicit-inline-templates
1463 Don't emit code for implicit instantiations of inline templates, either.
1464 The default is to handle inlines differently so that compiles with and
1465 without optimization will need the same set of explicit instantiations.
1466
1467 @item -fno-implement-inlines
1468 @opindex fno-implement-inlines
1469 To save space, do not emit out-of-line copies of inline functions
1470 controlled by @samp{#pragma implementation}.  This will cause linker
1471 errors if these functions are not inlined everywhere they are called.
1472
1473 @item -fms-extensions
1474 @opindex fms-extensions
1475 Disable pedantic warnings about constructs used in MFC, such as implicit
1476 int and getting a pointer to member function via non-standard syntax.
1477
1478 @item -fno-nonansi-builtins
1479 @opindex fno-nonansi-builtins
1480 Disable built-in declarations of functions that are not mandated by
1481 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1482 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1483
1484 @item -fno-operator-names
1485 @opindex fno-operator-names
1486 Do not treat the operator name keywords @code{and}, @code{bitand},
1487 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1488 synonyms as keywords.
1489
1490 @item -fno-optional-diags
1491 @opindex fno-optional-diags
1492 Disable diagnostics that the standard says a compiler does not need to
1493 issue.  Currently, the only such diagnostic issued by G++ is the one for
1494 a name having multiple meanings within a class.
1495
1496 @item -fpermissive
1497 @opindex fpermissive
1498 Downgrade some diagnostics about nonconformant code from errors to
1499 warnings.  Thus, using @option{-fpermissive} will allow some
1500 nonconforming code to compile.
1501
1502 @item -frepo
1503 @opindex frepo
1504 Enable automatic template instantiation at link time.  This option also
1505 implies @option{-fno-implicit-templates}.  @xref{Template
1506 Instantiation}, for more information.
1507
1508 @item -fno-rtti
1509 @opindex fno-rtti
1510 Disable generation of information about every class with virtual
1511 functions for use by the C++ runtime type identification features
1512 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1513 of the language, you can save some space by using this flag.  Note that
1514 exception handling uses the same information, but it will generate it as
1515 needed.
1516
1517 @item -fstats
1518 @opindex fstats
1519 Emit statistics about front-end processing at the end of the compilation.
1520 This information is generally only useful to the G++ development team.
1521
1522 @item -ftemplate-depth-@var{n}
1523 @opindex ftemplate-depth
1524 Set the maximum instantiation depth for template classes to @var{n}.
1525 A limit on the template instantiation depth is needed to detect
1526 endless recursions during template class instantiation.  ANSI/ISO C++
1527 conforming programs must not rely on a maximum depth greater than 17.
1528
1529 @item -fno-threadsafe-statics
1530 @opindex fno-threadsafe-statics
1531 Do not emit the extra code to use the routines specified in the C++
1532 ABI for thread-safe initialization of local statics.  You can use this
1533 option to reduce code size slightly in code that doesn't need to be
1534 thread-safe.
1535
1536 @item -fuse-cxa-atexit
1537 @opindex fuse-cxa-atexit
1538 Register destructors for objects with static storage duration with the
1539 @code{__cxa_atexit} function rather than the @code{atexit} function.
1540 This option is required for fully standards-compliant handling of static
1541 destructors, but will only work if your C library supports
1542 @code{__cxa_atexit}.
1543
1544 @item -fvisibility-inlines-hidden
1545 @opindex fvisibility-inlines-hidden
1546 Causes all inlined methods to be marked with
1547 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1548 appear in the export table of a DSO and do not require a PLT indirection
1549 when used within the DSO@.  Enabling this option can have a dramatic effect
1550 on load and link times of a DSO as it massively reduces the size of the
1551 dynamic export table when the library makes heavy use of templates.  While
1552 it can cause bloating through duplication of code within each DSO where
1553 it is used, often the wastage is less than the considerable space occupied
1554 by a long symbol name in the export table which is typical when using
1555 templates and namespaces.  For even more savings, combine with the
1556 @option{-fvisibility=hidden} switch.
1557
1558 @item -fno-weak
1559 @opindex fno-weak
1560 Do not use weak symbol support, even if it is provided by the linker.
1561 By default, G++ will use weak symbols if they are available.  This
1562 option exists only for testing, and should not be used by end-users;
1563 it will result in inferior code and has no benefits.  This option may
1564 be removed in a future release of G++.
1565
1566 @item -nostdinc++
1567 @opindex nostdinc++
1568 Do not search for header files in the standard directories specific to
1569 C++, but do still search the other standard directories.  (This option
1570 is used when building the C++ library.)
1571 @end table
1572
1573 In addition, these optimization, warning, and code generation options
1574 have meanings only for C++ programs:
1575
1576 @table @gcctabopt
1577 @item -fno-default-inline
1578 @opindex fno-default-inline
1579 Do not assume @samp{inline} for functions defined inside a class scope.
1580 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1581 functions will have linkage like inline functions; they just won't be
1582 inlined by default.
1583
1584 @item -Wabi @r{(C++ only)}
1585 @opindex Wabi
1586 Warn when G++ generates code that is probably not compatible with the
1587 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1588 all such cases, there are probably some cases that are not warned about,
1589 even though G++ is generating incompatible code.  There may also be
1590 cases where warnings are emitted even though the code that is generated
1591 will be compatible.
1592
1593 You should rewrite your code to avoid these warnings if you are
1594 concerned about the fact that code generated by G++ may not be binary
1595 compatible with code generated by other compilers.
1596
1597 The known incompatibilities at this point include:
1598
1599 @itemize @bullet
1600
1601 @item
1602 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1603 pack data into the same byte as a base class.  For example:
1604
1605 @smallexample
1606 struct A @{ virtual void f(); int f1 : 1; @};
1607 struct B : public A @{ int f2 : 1; @};
1608 @end smallexample
1609
1610 @noindent
1611 In this case, G++ will place @code{B::f2} into the same byte
1612 as@code{A::f1}; other compilers will not.  You can avoid this problem
1613 by explicitly padding @code{A} so that its size is a multiple of the
1614 byte size on your platform; that will cause G++ and other compilers to
1615 layout @code{B} identically.
1616
1617 @item
1618 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1619 tail padding when laying out virtual bases.  For example:
1620
1621 @smallexample
1622 struct A @{ virtual void f(); char c1; @};
1623 struct B @{ B(); char c2; @};
1624 struct C : public A, public virtual B @{@};
1625 @end smallexample
1626
1627 @noindent
1628 In this case, G++ will not place @code{B} into the tail-padding for
1629 @code{A}; other compilers will.  You can avoid this problem by
1630 explicitly padding @code{A} so that its size is a multiple of its
1631 alignment (ignoring virtual base classes); that will cause G++ and other
1632 compilers to layout @code{C} identically.
1633
1634 @item
1635 Incorrect handling of bit-fields with declared widths greater than that
1636 of their underlying types, when the bit-fields appear in a union.  For
1637 example:
1638
1639 @smallexample
1640 union U @{ int i : 4096; @};
1641 @end smallexample
1642
1643 @noindent
1644 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1645 union too small by the number of bits in an @code{int}.
1646
1647 @item
1648 Empty classes can be placed at incorrect offsets.  For example:
1649
1650 @smallexample
1651 struct A @{@};
1652
1653 struct B @{
1654   A a;
1655   virtual void f ();
1656 @};
1657
1658 struct C : public B, public A @{@};
1659 @end smallexample
1660
1661 @noindent
1662 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1663 it should be placed at offset zero.  G++ mistakenly believes that the
1664 @code{A} data member of @code{B} is already at offset zero.
1665
1666 @item
1667 Names of template functions whose types involve @code{typename} or
1668 template template parameters can be mangled incorrectly.
1669
1670 @smallexample
1671 template <typename Q>
1672 void f(typename Q::X) @{@}
1673
1674 template <template <typename> class Q>
1675 void f(typename Q<int>::X) @{@}
1676 @end smallexample
1677
1678 @noindent
1679 Instantiations of these templates may be mangled incorrectly.
1680
1681 @end itemize
1682
1683 @item -Wctor-dtor-privacy @r{(C++ only)}
1684 @opindex Wctor-dtor-privacy
1685 Warn when a class seems unusable because all the constructors or
1686 destructors in that class are private, and it has neither friends nor
1687 public static member functions.
1688
1689 @item -Wnon-virtual-dtor @r{(C++ only)}
1690 @opindex Wnon-virtual-dtor
1691 Warn when a class appears to be polymorphic, thereby requiring a virtual
1692 destructor, yet it declares a non-virtual one.
1693 This warning is enabled by @option{-Wall}.
1694
1695 @item -Wreorder @r{(C++ only)}
1696 @opindex Wreorder
1697 @cindex reordering, warning
1698 @cindex warning for reordering of member initializers
1699 Warn when the order of member initializers given in the code does not
1700 match the order in which they must be executed.  For instance:
1701
1702 @smallexample
1703 struct A @{
1704   int i;
1705   int j;
1706   A(): j (0), i (1) @{ @}
1707 @};
1708 @end smallexample
1709
1710 The compiler will rearrange the member initializers for @samp{i}
1711 and @samp{j} to match the declaration order of the members, emitting
1712 a warning to that effect.  This warning is enabled by @option{-Wall}.
1713 @end table
1714
1715 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1716
1717 @table @gcctabopt
1718 @item -Weffc++ @r{(C++ only)}
1719 @opindex Weffc++
1720 Warn about violations of the following style guidelines from Scott Meyers'
1721 @cite{Effective C++} book:
1722
1723 @itemize @bullet
1724 @item
1725 Item 11:  Define a copy constructor and an assignment operator for classes
1726 with dynamically allocated memory.
1727
1728 @item
1729 Item 12:  Prefer initialization to assignment in constructors.
1730
1731 @item
1732 Item 14:  Make destructors virtual in base classes.
1733
1734 @item
1735 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1736
1737 @item
1738 Item 23:  Don't try to return a reference when you must return an object.
1739
1740 @end itemize
1741
1742 Also warn about violations of the following style guidelines from
1743 Scott Meyers' @cite{More Effective C++} book:
1744
1745 @itemize @bullet
1746 @item
1747 Item 6:  Distinguish between prefix and postfix forms of increment and
1748 decrement operators.
1749
1750 @item
1751 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1752
1753 @end itemize
1754
1755 When selecting this option, be aware that the standard library
1756 headers do not obey all of these guidelines; use @samp{grep -v}
1757 to filter out those warnings.
1758
1759 @item -Wno-deprecated @r{(C++ only)}
1760 @opindex Wno-deprecated
1761 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1762
1763 @item -Wstrict-null-sentinel @r{(C++ only)}
1764 @opindex Wstrict-null-sentinel
1765 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1766 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1767 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1768 it is guaranteed to of the same size as a pointer.  But this use is
1769 not portable across different compilers.
1770
1771 @item -Wno-non-template-friend @r{(C++ only)}
1772 @opindex Wno-non-template-friend
1773 Disable warnings when non-templatized friend functions are declared
1774 within a template.  Since the advent of explicit template specification
1775 support in G++, if the name of the friend is an unqualified-id (i.e.,
1776 @samp{friend foo(int)}), the C++ language specification demands that the
1777 friend declare or define an ordinary, nontemplate function.  (Section
1778 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1779 could be interpreted as a particular specialization of a templatized
1780 function.  Because this non-conforming behavior is no longer the default
1781 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1782 check existing code for potential trouble spots and is on by default.
1783 This new compiler behavior can be turned off with
1784 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1785 but disables the helpful warning.
1786
1787 @item -Wold-style-cast @r{(C++ only)}
1788 @opindex Wold-style-cast
1789 Warn if an old-style (C-style) cast to a non-void type is used within
1790 a C++ program.  The new-style casts (@samp{static_cast},
1791 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1792 unintended effects and much easier to search for.
1793
1794 @item -Woverloaded-virtual @r{(C++ only)}
1795 @opindex Woverloaded-virtual
1796 @cindex overloaded virtual fn, warning
1797 @cindex warning for overloaded virtual fn
1798 Warn when a function declaration hides virtual functions from a
1799 base class.  For example, in:
1800
1801 @smallexample
1802 struct A @{
1803   virtual void f();
1804 @};
1805
1806 struct B: public A @{
1807   void f(int);
1808 @};
1809 @end smallexample
1810
1811 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1812 like:
1813
1814 @smallexample
1815 B* b;
1816 b->f();
1817 @end smallexample
1818
1819 will fail to compile.
1820
1821 @item -Wno-pmf-conversions @r{(C++ only)}
1822 @opindex Wno-pmf-conversions
1823 Disable the diagnostic for converting a bound pointer to member function
1824 to a plain pointer.
1825
1826 @item -Wsign-promo @r{(C++ only)}
1827 @opindex Wsign-promo
1828 Warn when overload resolution chooses a promotion from unsigned or
1829 enumerated type to a signed type, over a conversion to an unsigned type of
1830 the same size.  Previous versions of G++ would try to preserve
1831 unsignedness, but the standard mandates the current behavior.
1832
1833 @smallexample
1834 struct A @{
1835   operator int ();
1836   A& operator = (int);
1837 @};
1838
1839 main ()
1840 @{
1841   A a,b;
1842   a = b;
1843 @}
1844 @end smallexample
1845
1846 In this example, G++ will synthesize a default @samp{A& operator =
1847 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1848 @end table
1849
1850 @node Objective-C and Objective-C++ Dialect Options
1851 @section Options Controlling Objective-C and Objective-C++ Dialects
1852
1853 @cindex compiler options, Objective-C and Objective-C++
1854 @cindex Objective-C and Objective-C++ options, command line
1855 @cindex options, Objective-C and Objective-C++
1856 (NOTE: This manual does not describe the Objective-C and Objective-C++
1857 languages themselves.  See @xref{Standards,,Language Standards
1858 Supported by GCC}, for references.)
1859
1860 This section describes the command-line options that are only meaningful
1861 for Objective-C and Objective-C++ programs, but you can also use most of
1862 the language-independent GNU compiler options.
1863 For example, you might compile a file @code{some_class.m} like this:
1864
1865 @smallexample
1866 gcc -g -fgnu-runtime -O -c some_class.m
1867 @end smallexample
1868
1869 @noindent
1870 In this example, @option{-fgnu-runtime} is an option meant only for
1871 Objective-C and Objective-C++ programs; you can use the other options with
1872 any language supported by GCC@.
1873
1874 Note that since Objective-C is an extension of the C language, Objective-C
1875 compilations may also use options specific to the C front-end (e.g.,
1876 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1877 C++-specific options (e.g., @option{-Wabi}).
1878
1879 Here is a list of options that are @emph{only} for compiling Objective-C
1880 and Objective-C++ programs:
1881
1882 @table @gcctabopt
1883 @item -fconstant-string-class=@var{class-name}
1884 @opindex fconstant-string-class
1885 Use @var{class-name} as the name of the class to instantiate for each
1886 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1887 class name is @code{NXConstantString} if the GNU runtime is being used, and
1888 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1889 @option{-fconstant-cfstrings} option, if also present, will override the
1890 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1891 to be laid out as constant CoreFoundation strings.
1892
1893 @item -fgnu-runtime
1894 @opindex fgnu-runtime
1895 Generate object code compatible with the standard GNU Objective-C
1896 runtime.  This is the default for most types of systems.
1897
1898 @item -fnext-runtime
1899 @opindex fnext-runtime
1900 Generate output compatible with the NeXT runtime.  This is the default
1901 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1902 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1903 used.
1904
1905 @item -fno-nil-receivers
1906 @opindex fno-nil-receivers
1907 Assume that all Objective-C message dispatches (e.g.,
1908 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1909 is not @code{nil}.  This allows for more efficient entry points in the runtime
1910 to be used.  Currently, this option is only available in conjunction with
1911 the NeXT runtime on Mac OS X 10.3 and later.
1912
1913 @item -fobjc-call-cxx-cdtors
1914 @opindex fobjc-call-cxx-cdtors
1915 For each Objective-C class, check if any of its instance variables is a
1916 C++ object with a non-trivial default constructor.  If so, synthesize a
1917 special @code{- (id) .cxx_construct} instance method that will run
1918 non-trivial default constructors on any such instance variables, in order,
1919 and then return @code{self}.  Similarly, check if any instance variable
1920 is a C++ object with a non-trivial destructor, and if so, synthesize a
1921 special @code{- (void) .cxx_destruct} method that will run
1922 all such default destructors, in reverse order.
1923
1924 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1925 thusly generated will only operate on instance variables declared in the
1926 current Objective-C class, and not those inherited from superclasses.  It
1927 is the responsibility of the Objective-C runtime to invoke all such methods
1928 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1929 will be invoked by the runtime immediately after a new object
1930 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1931 be invoked immediately before the runtime deallocates an object instance.
1932
1933 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1934 support for invoking the @code{- (id) .cxx_construct} and
1935 @code{- (void) .cxx_destruct} methods.
1936
1937 @item -fobjc-direct-dispatch
1938 @opindex fobjc-direct-dispatch
1939 Allow fast jumps to the message dispatcher.  On Darwin this is
1940 accomplished via the comm page.
1941
1942 @item -fobjc-exceptions
1943 @opindex fobjc-exceptions
1944 Enable syntactic support for structured exception handling in Objective-C,
1945 similar to what is offered by C++ and Java.  Currently, this option is only
1946 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1947
1948 @smallexample
1949   @@try @{
1950     @dots{}
1951        @@throw expr;
1952     @dots{}
1953   @}
1954   @@catch (AnObjCClass *exc) @{
1955     @dots{}
1956       @@throw expr;
1957     @dots{}
1958       @@throw;
1959     @dots{}
1960   @}
1961   @@catch (AnotherClass *exc) @{
1962     @dots{}
1963   @}
1964   @@catch (id allOthers) @{
1965     @dots{}
1966   @}
1967   @@finally @{
1968     @dots{}
1969       @@throw expr;
1970     @dots{}
1971   @}
1972 @end smallexample
1973
1974 The @code{@@throw} statement may appear anywhere in an Objective-C or
1975 Objective-C++ program; when used inside of a @code{@@catch} block, the
1976 @code{@@throw} may appear without an argument (as shown above), in which case
1977 the object caught by the @code{@@catch} will be rethrown.
1978
1979 Note that only (pointers to) Objective-C objects may be thrown and
1980 caught using this scheme.  When an object is thrown, it will be caught
1981 by the nearest @code{@@catch} clause capable of handling objects of that type,
1982 analogously to how @code{catch} blocks work in C++ and Java.  A
1983 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1984 any and all Objective-C exceptions not caught by previous @code{@@catch}
1985 clauses (if any).
1986
1987 The @code{@@finally} clause, if present, will be executed upon exit from the
1988 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1989 regardless of whether any exceptions are thrown, caught or rethrown
1990 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1991 of the @code{finally} clause in Java.
1992
1993 There are several caveats to using the new exception mechanism:
1994
1995 @itemize @bullet
1996 @item
1997 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1998 idioms provided by the @code{NSException} class, the new
1999 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2000 systems, due to additional functionality needed in the (NeXT) Objective-C
2001 runtime.
2002
2003 @item
2004 As mentioned above, the new exceptions do not support handling
2005 types other than Objective-C objects.   Furthermore, when used from
2006 Objective-C++, the Objective-C exception model does not interoperate with C++
2007 exceptions at this time.  This means you cannot @code{@@throw} an exception
2008 from Objective-C and @code{catch} it in C++, or vice versa
2009 (i.e., @code{throw @dots{} @@catch}).
2010 @end itemize
2011
2012 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2013 blocks for thread-safe execution:
2014
2015 @smallexample
2016   @@synchronized (ObjCClass *guard) @{
2017     @dots{}
2018   @}
2019 @end smallexample
2020
2021 Upon entering the @code{@@synchronized} block, a thread of execution shall
2022 first check whether a lock has been placed on the corresponding @code{guard}
2023 object by another thread.  If it has, the current thread shall wait until
2024 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2025 the current thread will place its own lock on it, execute the code contained in
2026 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2027 making @code{guard} available to other threads).
2028
2029 Unlike Java, Objective-C does not allow for entire methods to be marked
2030 @code{@@synchronized}.  Note that throwing exceptions out of
2031 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2032 to be unlocked properly.
2033
2034 @item -fobjc-gc
2035 @opindex fobjc-gc
2036 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2037
2038 @item -freplace-objc-classes
2039 @opindex freplace-objc-classes
2040 Emit a special marker instructing @command{ld(1)} not to statically link in
2041 the resulting object file, and allow @command{dyld(1)} to load it in at
2042 run time instead.  This is used in conjunction with the Fix-and-Continue
2043 debugging mode, where the object file in question may be recompiled and
2044 dynamically reloaded in the course of program execution, without the need
2045 to restart the program itself.  Currently, Fix-and-Continue functionality
2046 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2047 and later.
2048
2049 @item -fzero-link
2050 @opindex fzero-link
2051 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2052 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2053 compile time) with static class references that get initialized at load time,
2054 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2055 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2056 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2057 for individual class implementations to be modified during program execution.
2058
2059 @item -gen-decls
2060 @opindex gen-decls
2061 Dump interface declarations for all classes seen in the source file to a
2062 file named @file{@var{sourcename}.decl}.
2063
2064 @item -Wassign-intercept
2065 @opindex Wassign-intercept
2066 Warn whenever an Objective-C assignment is being intercepted by the
2067 garbage collector.
2068
2069 @item -Wno-protocol
2070 @opindex Wno-protocol
2071 If a class is declared to implement a protocol, a warning is issued for
2072 every method in the protocol that is not implemented by the class.  The
2073 default behavior is to issue a warning for every method not explicitly
2074 implemented in the class, even if a method implementation is inherited
2075 from the superclass.  If you use the @option{-Wno-protocol} option, then
2076 methods inherited from the superclass are considered to be implemented,
2077 and no warning is issued for them.
2078
2079 @item -Wselector
2080 @opindex Wselector
2081 Warn if multiple methods of different types for the same selector are
2082 found during compilation.  The check is performed on the list of methods
2083 in the final stage of compilation.  Additionally, a check is performed
2084 for each selector appearing in a @code{@@selector(@dots{})}
2085 expression, and a corresponding method for that selector has been found
2086 during compilation.  Because these checks scan the method table only at
2087 the end of compilation, these warnings are not produced if the final
2088 stage of compilation is not reached, for example because an error is
2089 found during compilation, or because the @option{-fsyntax-only} option is
2090 being used.
2091
2092 @item -Wstrict-selector-match
2093 @opindex Wstrict-selector-match
2094 Warn if multiple methods with differing argument and/or return types are
2095 found for a given selector when attempting to send a message using this
2096 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2097 is off (which is the default behavior), the compiler will omit such warnings
2098 if any differences found are confined to types which share the same size
2099 and alignment.
2100
2101 @item -Wundeclared-selector
2102 @opindex Wundeclared-selector
2103 Warn if a @code{@@selector(@dots{})} expression referring to an
2104 undeclared selector is found.  A selector is considered undeclared if no
2105 method with that name has been declared before the
2106 @code{@@selector(@dots{})} expression, either explicitly in an
2107 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2108 an @code{@@implementation} section.  This option always performs its
2109 checks as soon as a @code{@@selector(@dots{})} expression is found,
2110 while @option{-Wselector} only performs its checks in the final stage of
2111 compilation.  This also enforces the coding style convention
2112 that methods and selectors must be declared before being used.
2113
2114 @item -print-objc-runtime-info
2115 @opindex print-objc-runtime-info
2116 Generate C header describing the largest structure that is passed by
2117 value, if any.
2118
2119 @end table
2120
2121 @node Language Independent Options
2122 @section Options to Control Diagnostic Messages Formatting
2123 @cindex options to control diagnostics formatting
2124 @cindex diagnostic messages
2125 @cindex message formatting
2126
2127 Traditionally, diagnostic messages have been formatted irrespective of
2128 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2129 below can be used to control the diagnostic messages formatting
2130 algorithm, e.g.@: how many characters per line, how often source location
2131 information should be reported.  Right now, only the C++ front end can
2132 honor these options.  However it is expected, in the near future, that
2133 the remaining front ends would be able to digest them correctly.
2134
2135 @table @gcctabopt
2136 @item -fmessage-length=@var{n}
2137 @opindex fmessage-length
2138 Try to format error messages so that they fit on lines of about @var{n}
2139 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2140 the front ends supported by GCC@.  If @var{n} is zero, then no
2141 line-wrapping will be done; each error message will appear on a single
2142 line.
2143
2144 @opindex fdiagnostics-show-location
2145 @item -fdiagnostics-show-location=once
2146 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2147 reporter to emit @emph{once} source location information; that is, in
2148 case the message is too long to fit on a single physical line and has to
2149 be wrapped, the source location won't be emitted (as prefix) again,
2150 over and over, in subsequent continuation lines.  This is the default
2151 behavior.
2152
2153 @item -fdiagnostics-show-location=every-line
2154 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2155 messages reporter to emit the same source location information (as
2156 prefix) for physical lines that result from the process of breaking
2157 a message which is too long to fit on a single line.
2158
2159 @item -fdiagnostics-show-options
2160 @opindex fdiagnostics-show-options
2161 This option instructs the diagnostic machinery to add text to each
2162 diagnostic emitted, which indicates which command line option directly
2163 controls that diagnostic, when such an option is known to the
2164 diagnostic machinery.
2165
2166 @end table
2167
2168 @node Warning Options
2169 @section Options to Request or Suppress Warnings
2170 @cindex options to control warnings
2171 @cindex warning messages
2172 @cindex messages, warning
2173 @cindex suppressing warnings
2174
2175 Warnings are diagnostic messages that report constructions which
2176 are not inherently erroneous but which are risky or suggest there
2177 may have been an error.
2178
2179 You can request many specific warnings with options beginning @samp{-W},
2180 for example @option{-Wimplicit} to request warnings on implicit
2181 declarations.  Each of these specific warning options also has a
2182 negative form beginning @samp{-Wno-} to turn off warnings;
2183 for example, @option{-Wno-implicit}.  This manual lists only one of the
2184 two forms, whichever is not the default.
2185
2186 The following options control the amount and kinds of warnings produced
2187 by GCC; for further, language-specific options also refer to
2188 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2189 Options}.
2190
2191 @table @gcctabopt
2192 @cindex syntax checking
2193 @item -fsyntax-only
2194 @opindex fsyntax-only
2195 Check the code for syntax errors, but don't do anything beyond that.
2196
2197 @item -pedantic
2198 @opindex pedantic
2199 Issue all the warnings demanded by strict ISO C and ISO C++;
2200 reject all programs that use forbidden extensions, and some other
2201 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2202 version of the ISO C standard specified by any @option{-std} option used.
2203
2204 Valid ISO C and ISO C++ programs should compile properly with or without
2205 this option (though a rare few will require @option{-ansi} or a
2206 @option{-std} option specifying the required version of ISO C)@.  However,
2207 without this option, certain GNU extensions and traditional C and C++
2208 features are supported as well.  With this option, they are rejected.
2209
2210 @option{-pedantic} does not cause warning messages for use of the
2211 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2212 warnings are also disabled in the expression that follows
2213 @code{__extension__}.  However, only system header files should use
2214 these escape routes; application programs should avoid them.
2215 @xref{Alternate Keywords}.
2216
2217 Some users try to use @option{-pedantic} to check programs for strict ISO
2218 C conformance.  They soon find that it does not do quite what they want:
2219 it finds some non-ISO practices, but not all---only those for which
2220 ISO C @emph{requires} a diagnostic, and some others for which
2221 diagnostics have been added.
2222
2223 A feature to report any failure to conform to ISO C might be useful in
2224 some instances, but would require considerable additional work and would
2225 be quite different from @option{-pedantic}.  We don't have plans to
2226 support such a feature in the near future.
2227
2228 Where the standard specified with @option{-std} represents a GNU
2229 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2230 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2231 extended dialect is based.  Warnings from @option{-pedantic} are given
2232 where they are required by the base standard.  (It would not make sense
2233 for such warnings to be given only for features not in the specified GNU
2234 C dialect, since by definition the GNU dialects of C include all
2235 features the compiler supports with the given option, and there would be
2236 nothing to warn about.)
2237
2238 @item -pedantic-errors
2239 @opindex pedantic-errors
2240 Like @option{-pedantic}, except that errors are produced rather than
2241 warnings.
2242
2243 @item -w
2244 @opindex w
2245 Inhibit all warning messages.
2246
2247 @item -Wno-import
2248 @opindex Wno-import
2249 Inhibit warning messages about the use of @samp{#import}.
2250
2251 @item -Wchar-subscripts
2252 @opindex Wchar-subscripts
2253 Warn if an array subscript has type @code{char}.  This is a common cause
2254 of error, as programmers often forget that this type is signed on some
2255 machines.
2256 This warning is enabled by @option{-Wall}.
2257
2258 @item -Wcomment
2259 @opindex Wcomment
2260 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2261 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2262 This warning is enabled by @option{-Wall}.
2263
2264 @item -Wfatal-errors
2265 @opindex Wfatal-errors
2266 This option causes the compiler to abort compilation on the first error
2267 occurred rather than trying to keep going and printing further error
2268 messages.
2269
2270 @item -Wformat
2271 @opindex Wformat
2272 @opindex ffreestanding
2273 @opindex fno-builtin
2274 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2275 the arguments supplied have types appropriate to the format string
2276 specified, and that the conversions specified in the format string make
2277 sense.  This includes standard functions, and others specified by format
2278 attributes (@pxref{Function Attributes}), in the @code{printf},
2279 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2280 not in the C standard) families (or other target-specific families).
2281 Which functions are checked without format attributes having been
2282 specified depends on the standard version selected, and such checks of
2283 functions without the attribute specified are disabled by
2284 @option{-ffreestanding} or @option{-fno-builtin}.
2285
2286 The formats are checked against the format features supported by GNU
2287 libc version 2.2.  These include all ISO C90 and C99 features, as well
2288 as features from the Single Unix Specification and some BSD and GNU
2289 extensions.  Other library implementations may not support all these
2290 features; GCC does not support warning about features that go beyond a
2291 particular library's limitations.  However, if @option{-pedantic} is used
2292 with @option{-Wformat}, warnings will be given about format features not
2293 in the selected standard version (but not for @code{strfmon} formats,
2294 since those are not in any version of the C standard).  @xref{C Dialect
2295 Options,,Options Controlling C Dialect}.
2296
2297 Since @option{-Wformat} also checks for null format arguments for
2298 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2299
2300 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2301 aspects of format checking, the options @option{-Wformat-y2k},
2302 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2303 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2304 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2305
2306 @item -Wformat-y2k
2307 @opindex Wformat-y2k
2308 If @option{-Wformat} is specified, also warn about @code{strftime}
2309 formats which may yield only a two-digit year.
2310
2311 @item -Wno-format-extra-args
2312 @opindex Wno-format-extra-args
2313 If @option{-Wformat} is specified, do not warn about excess arguments to a
2314 @code{printf} or @code{scanf} format function.  The C standard specifies
2315 that such arguments are ignored.
2316
2317 Where the unused arguments lie between used arguments that are
2318 specified with @samp{$} operand number specifications, normally
2319 warnings are still given, since the implementation could not know what
2320 type to pass to @code{va_arg} to skip the unused arguments.  However,
2321 in the case of @code{scanf} formats, this option will suppress the
2322 warning if the unused arguments are all pointers, since the Single
2323 Unix Specification says that such unused arguments are allowed.
2324
2325 @item -Wno-format-zero-length
2326 @opindex Wno-format-zero-length
2327 If @option{-Wformat} is specified, do not warn about zero-length formats.
2328 The C standard specifies that zero-length formats are allowed.
2329
2330 @item -Wformat-nonliteral
2331 @opindex Wformat-nonliteral
2332 If @option{-Wformat} is specified, also warn if the format string is not a
2333 string literal and so cannot be checked, unless the format function
2334 takes its format arguments as a @code{va_list}.
2335
2336 @item -Wformat-security
2337 @opindex Wformat-security
2338 If @option{-Wformat} is specified, also warn about uses of format
2339 functions that represent possible security problems.  At present, this
2340 warns about calls to @code{printf} and @code{scanf} functions where the
2341 format string is not a string literal and there are no format arguments,
2342 as in @code{printf (foo);}.  This may be a security hole if the format
2343 string came from untrusted input and contains @samp{%n}.  (This is
2344 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2345 in future warnings may be added to @option{-Wformat-security} that are not
2346 included in @option{-Wformat-nonliteral}.)
2347
2348 @item -Wformat=2
2349 @opindex Wformat=2
2350 Enable @option{-Wformat} plus format checks not included in
2351 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2352 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2353
2354 @item -Wnonnull
2355 @opindex Wnonnull
2356 Warn about passing a null pointer for arguments marked as
2357 requiring a non-null value by the @code{nonnull} function attribute.
2358
2359 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2360 can be disabled with the @option{-Wno-nonnull} option.
2361
2362 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2363 @opindex Winit-self
2364 Warn about uninitialized variables which are initialized with themselves.
2365 Note this option can only be used with the @option{-Wuninitialized} option,
2366 which in turn only works with @option{-O1} and above.
2367
2368 For example, GCC will warn about @code{i} being uninitialized in the
2369 following snippet only when @option{-Winit-self} has been specified:
2370 @smallexample
2371 @group
2372 int f()
2373 @{
2374   int i = i;
2375   return i;
2376 @}
2377 @end group
2378 @end smallexample
2379
2380 @item -Wimplicit-int
2381 @opindex Wimplicit-int
2382 Warn when a declaration does not specify a type.
2383 This warning is enabled by @option{-Wall}.
2384
2385 @item -Wimplicit-function-declaration
2386 @itemx -Werror-implicit-function-declaration
2387 @opindex Wimplicit-function-declaration
2388 @opindex Werror-implicit-function-declaration
2389 Give a warning (or error) whenever a function is used before being
2390 declared.  The form @option{-Wno-error-implicit-function-declaration}
2391 is not supported.
2392 This warning is enabled by @option{-Wall} (as a warning, not an error).
2393
2394 @item -Wimplicit
2395 @opindex Wimplicit
2396 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2397 This warning is enabled by @option{-Wall}.
2398
2399 @item -Wmain
2400 @opindex Wmain
2401 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2402 function with external linkage, returning int, taking either zero
2403 arguments, two, or three arguments of appropriate types.
2404 This warning is enabled by @option{-Wall}.
2405
2406 @item -Wmissing-braces
2407 @opindex Wmissing-braces
2408 Warn if an aggregate or union initializer is not fully bracketed.  In
2409 the following example, the initializer for @samp{a} is not fully
2410 bracketed, but that for @samp{b} is fully bracketed.
2411
2412 @smallexample
2413 int a[2][2] = @{ 0, 1, 2, 3 @};
2414 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2415 @end smallexample
2416
2417 This warning is enabled by @option{-Wall}.
2418
2419 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2420 @opindex Wmissing-include-dirs
2421 Warn if a user-supplied include directory does not exist.
2422
2423 @item -Wparentheses
2424 @opindex Wparentheses
2425 Warn if parentheses are omitted in certain contexts, such
2426 as when there is an assignment in a context where a truth value
2427 is expected, or when operators are nested whose precedence people
2428 often get confused about.  Only the warning for an assignment used as
2429 a truth value is supported when compiling C++; the other warnings are
2430 only supported when compiling C@.
2431
2432 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2433 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2434 interpretation from that of ordinary mathematical notation.
2435
2436 Also warn about constructions where there may be confusion to which
2437 @code{if} statement an @code{else} branch belongs.  Here is an example of
2438 such a case:
2439
2440 @smallexample
2441 @group
2442 @{
2443   if (a)
2444     if (b)
2445       foo ();
2446   else
2447     bar ();
2448 @}
2449 @end group
2450 @end smallexample
2451
2452 In C, every @code{else} branch belongs to the innermost possible @code{if}
2453 statement, which in this example is @code{if (b)}.  This is often not
2454 what the programmer expected, as illustrated in the above example by
2455 indentation the programmer chose.  When there is the potential for this
2456 confusion, GCC will issue a warning when this flag is specified.
2457 To eliminate the warning, add explicit braces around the innermost
2458 @code{if} statement so there is no way the @code{else} could belong to
2459 the enclosing @code{if}.  The resulting code would look like this:
2460
2461 @smallexample
2462 @group
2463 @{
2464   if (a)
2465     @{
2466       if (b)
2467         foo ();
2468       else
2469         bar ();
2470     @}
2471 @}
2472 @end group
2473 @end smallexample
2474
2475 This warning is enabled by @option{-Wall}.
2476
2477 @item -Wsequence-point
2478 @opindex Wsequence-point
2479 Warn about code that may have undefined semantics because of violations
2480 of sequence point rules in the C standard.
2481
2482 The C standard defines the order in which expressions in a C program are
2483 evaluated in terms of @dfn{sequence points}, which represent a partial
2484 ordering between the execution of parts of the program: those executed
2485 before the sequence point, and those executed after it.  These occur
2486 after the evaluation of a full expression (one which is not part of a
2487 larger expression), after the evaluation of the first operand of a
2488 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2489 function is called (but after the evaluation of its arguments and the
2490 expression denoting the called function), and in certain other places.
2491 Other than as expressed by the sequence point rules, the order of
2492 evaluation of subexpressions of an expression is not specified.  All
2493 these rules describe only a partial order rather than a total order,
2494 since, for example, if two functions are called within one expression
2495 with no sequence point between them, the order in which the functions
2496 are called is not specified.  However, the standards committee have
2497 ruled that function calls do not overlap.
2498
2499 It is not specified when between sequence points modifications to the
2500 values of objects take effect.  Programs whose behavior depends on this
2501 have undefined behavior; the C standard specifies that ``Between the
2502 previous and next sequence point an object shall have its stored value
2503 modified at most once by the evaluation of an expression.  Furthermore,
2504 the prior value shall be read only to determine the value to be
2505 stored.''.  If a program breaks these rules, the results on any
2506 particular implementation are entirely unpredictable.
2507
2508 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2509 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2510 diagnosed by this option, and it may give an occasional false positive
2511 result, but in general it has been found fairly effective at detecting
2512 this sort of problem in programs.
2513
2514 The present implementation of this option only works for C programs.  A
2515 future implementation may also work for C++ programs.
2516
2517 The C standard is worded confusingly, therefore there is some debate
2518 over the precise meaning of the sequence point rules in subtle cases.
2519 Links to discussions of the problem, including proposed formal
2520 definitions, may be found on the GCC readings page, at
2521 @w{@uref{http://gcc.gnu.org/readings.html}}.
2522
2523 This warning is enabled by @option{-Wall}.
2524
2525 @item -Wreturn-type
2526 @opindex Wreturn-type
2527 Warn whenever a function is defined with a return-type that defaults to
2528 @code{int}.  Also warn about any @code{return} statement with no
2529 return-value in a function whose return-type is not @code{void}.
2530
2531 For C, also warn if the return type of a function has a type qualifier
2532 such as @code{const}.  Such a type qualifier has no effect, since the
2533 value returned by a function is not an lvalue.  ISO C prohibits
2534 qualified @code{void} return types on function definitions, so such
2535 return types always receive a warning even without this option.
2536
2537 For C++, a function without return type always produces a diagnostic
2538 message, even when @option{-Wno-return-type} is specified.  The only
2539 exceptions are @samp{main} and functions defined in system headers.
2540
2541 This warning is enabled by @option{-Wall}.
2542
2543 @item -Wswitch
2544 @opindex Wswitch
2545 Warn whenever a @code{switch} statement has an index of enumerated type
2546 and lacks a @code{case} for one or more of the named codes of that
2547 enumeration.  (The presence of a @code{default} label prevents this
2548 warning.)  @code{case} labels outside the enumeration range also
2549 provoke warnings when this option is used.
2550 This warning is enabled by @option{-Wall}.
2551
2552 @item -Wswitch-default
2553 @opindex Wswitch-switch
2554 Warn whenever a @code{switch} statement does not have a @code{default}
2555 case.
2556
2557 @item -Wswitch-enum
2558 @opindex Wswitch-enum
2559 Warn whenever a @code{switch} statement has an index of enumerated type
2560 and lacks a @code{case} for one or more of the named codes of that
2561 enumeration.  @code{case} labels outside the enumeration range also
2562 provoke warnings when this option is used.
2563
2564 @item -Wtrigraphs
2565 @opindex Wtrigraphs
2566 Warn if any trigraphs are encountered that might change the meaning of
2567 the program (trigraphs within comments are not warned about).
2568 This warning is enabled by @option{-Wall}.
2569
2570 @item -Wunused-function
2571 @opindex Wunused-function
2572 Warn whenever a static function is declared but not defined or a
2573 non\-inline static function is unused.
2574 This warning is enabled by @option{-Wall}.
2575
2576 @item -Wunused-label
2577 @opindex Wunused-label
2578 Warn whenever a label is declared but not used.
2579 This warning is enabled by @option{-Wall}.
2580
2581 To suppress this warning use the @samp{unused} attribute
2582 (@pxref{Variable Attributes}).
2583
2584 @item -Wunused-parameter
2585 @opindex Wunused-parameter
2586 Warn whenever a function parameter is unused aside from its declaration.
2587
2588 To suppress this warning use the @samp{unused} attribute
2589 (@pxref{Variable Attributes}).
2590
2591 @item -Wunused-variable
2592 @opindex Wunused-variable
2593 Warn whenever a local variable or non-constant static variable is unused
2594 aside from its declaration
2595 This warning is enabled by @option{-Wall}.
2596
2597 To suppress this warning use the @samp{unused} attribute
2598 (@pxref{Variable Attributes}).
2599
2600 @item -Wunused-value
2601 @opindex Wunused-value
2602 Warn whenever a statement computes a result that is explicitly not used.
2603 This warning is enabled by @option{-Wall}.
2604
2605 To suppress this warning cast the expression to @samp{void}.
2606
2607 @item -Wunused
2608 @opindex Wunused
2609 All the above @option{-Wunused} options combined.
2610
2611 In order to get a warning about an unused function parameter, you must
2612 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2613 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2614
2615 @item -Wuninitialized
2616 @opindex Wuninitialized
2617 Warn if an automatic variable is used without first being initialized or
2618 if a variable may be clobbered by a @code{setjmp} call.
2619
2620 These warnings are possible only in optimizing compilation,
2621 because they require data flow information that is computed only
2622 when optimizing.  If you don't specify @option{-O}, you simply won't
2623 get these warnings.
2624
2625 If you want to warn about code which uses the uninitialized value of the
2626 variable in its own initializer, use the @option{-Winit-self} option.
2627
2628 These warnings occur for individual uninitialized or clobbered
2629 elements of structure, union or array variables as well as for
2630 variables which are uninitialized or clobbered as a whole.  They do
2631 not occur for variables or elements declared @code{volatile}.  Because
2632 these warnings depend on optimization, the exact variables or elements
2633 for which there are warnings will depend on the precise optimization
2634 options and version of GCC used.
2635
2636 Note that there may be no warning about a variable that is used only
2637 to compute a value that itself is never used, because such
2638 computations may be deleted by data flow analysis before the warnings
2639 are printed.
2640
2641 These warnings are made optional because GCC is not smart
2642 enough to see all the reasons why the code might be correct
2643 despite appearing to have an error.  Here is one example of how
2644 this can happen:
2645
2646 @smallexample
2647 @group
2648 @{
2649   int x;
2650   switch (y)
2651     @{
2652     case 1: x = 1;
2653       break;
2654     case 2: x = 4;
2655       break;
2656     case 3: x = 5;
2657     @}
2658   foo (x);
2659 @}
2660 @end group
2661 @end smallexample
2662
2663 @noindent
2664 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2665 always initialized, but GCC doesn't know this.  Here is
2666 another common case:
2667
2668 @smallexample
2669 @{
2670   int save_y;
2671   if (change_y) save_y = y, y = new_y;
2672   @dots{}
2673   if (change_y) y = save_y;
2674 @}
2675 @end smallexample
2676
2677 @noindent
2678 This has no bug because @code{save_y} is used only if it is set.
2679
2680 @cindex @code{longjmp} warnings
2681 This option also warns when a non-volatile automatic variable might be
2682 changed by a call to @code{longjmp}.  These warnings as well are possible
2683 only in optimizing compilation.
2684
2685 The compiler sees only the calls to @code{setjmp}.  It cannot know
2686 where @code{longjmp} will be called; in fact, a signal handler could
2687 call it at any point in the code.  As a result, you may get a warning
2688 even when there is in fact no problem because @code{longjmp} cannot
2689 in fact be called at the place which would cause a problem.
2690
2691 Some spurious warnings can be avoided if you declare all the functions
2692 you use that never return as @code{noreturn}.  @xref{Function
2693 Attributes}.
2694
2695 This warning is enabled by @option{-Wall}.
2696
2697 @item -Wunknown-pragmas
2698 @opindex Wunknown-pragmas
2699 @cindex warning for unknown pragmas
2700 @cindex unknown pragmas, warning
2701 @cindex pragmas, warning of unknown
2702 Warn when a #pragma directive is encountered which is not understood by
2703 GCC@.  If this command line option is used, warnings will even be issued
2704 for unknown pragmas in system header files.  This is not the case if
2705 the warnings were only enabled by the @option{-Wall} command line option.
2706
2707 @item -Wstrict-aliasing
2708 @opindex Wstrict-aliasing
2709 This option is only active when @option{-fstrict-aliasing} is active.
2710 It warns about code which might break the strict aliasing rules that the
2711 compiler is using for optimization.  The warning does not catch all
2712 cases, but does attempt to catch the more common pitfalls.  It is
2713 included in @option{-Wall}.
2714
2715 @item -Wstrict-aliasing=2
2716 @opindex Wstrict-aliasing=2
2717 This option is only active when @option{-fstrict-aliasing} is active.
2718 It warns about all code which might break the strict aliasing rules that the
2719 compiler is using for optimization.  This warning catches all cases, but
2720 it will also give a warning for some ambiguous cases that are safe.
2721
2722 @item -Wall
2723 @opindex Wall
2724 All of the above @samp{-W} options combined.  This enables all the
2725 warnings about constructions that some users consider questionable, and
2726 that are easy to avoid (or modify to prevent the warning), even in
2727 conjunction with macros.  This also enables some language-specific
2728 warnings described in @ref{C++ Dialect Options} and
2729 @ref{Objective-C and Objective-C++ Dialect Options}.
2730 @end table
2731
2732 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2733 Some of them warn about constructions that users generally do not
2734 consider questionable, but which occasionally you might wish to check
2735 for; others warn about constructions that are necessary or hard to avoid
2736 in some cases, and there is no simple way to modify the code to suppress
2737 the warning.
2738
2739 @table @gcctabopt
2740 @item -Wextra
2741 @opindex W
2742 @opindex Wextra
2743 (This option used to be called @option{-W}.  The older name is still
2744 supported, but the newer name is more descriptive.)  Print extra warning
2745 messages for these events:
2746
2747 @itemize @bullet
2748 @item
2749 A function can return either with or without a value.  (Falling
2750 off the end of the function body is considered returning without
2751 a value.)  For example, this function would evoke such a
2752 warning:
2753
2754 @smallexample
2755 @group
2756 foo (a)
2757 @{
2758   if (a > 0)
2759     return a;
2760 @}
2761 @end group
2762 @end smallexample
2763
2764 @item
2765 An expression-statement or the left-hand side of a comma expression
2766 contains no side effects.
2767 To suppress the warning, cast the unused expression to void.
2768 For example, an expression such as @samp{x[i,j]} will cause a warning,
2769 but @samp{x[(void)i,j]} will not.
2770
2771 @item
2772 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2773
2774 @item
2775 Storage-class specifiers like @code{static} are not the first things in
2776 a declaration.  According to the C Standard, this usage is obsolescent.
2777
2778 @item
2779 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2780 arguments.
2781
2782 @item
2783 A comparison between signed and unsigned values could produce an
2784 incorrect result when the signed value is converted to unsigned.
2785 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2786
2787 @item
2788 An aggregate has an initializer which does not initialize all members.
2789 This warning can be independently controlled by
2790 @option{-Wmissing-field-initializers}.
2791
2792 @item
2793 A function parameter is declared without a type specifier in K&R-style
2794 functions:
2795
2796 @smallexample
2797 void foo(bar) @{ @}
2798 @end smallexample
2799
2800 @item
2801 An empty body occurs in an @samp{if} or @samp{else} statement.
2802
2803 @item
2804 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2805 @samp{>}, or @samp{>=}.
2806
2807 @item
2808 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2809
2810 @item
2811 Any of several floating-point events that often indicate errors, such as
2812 overflow, underflow, loss of precision, etc.
2813
2814 @item @r{(C++ only)}
2815 An enumerator and a non-enumerator both appear in a conditional expression.
2816
2817 @item @r{(C++ only)}
2818 A non-static reference or non-static @samp{const} member appears in a
2819 class without constructors.
2820
2821 @item @r{(C++ only)}
2822 Ambiguous virtual bases.
2823
2824 @item @r{(C++ only)}
2825 Subscripting an array which has been declared @samp{register}.
2826
2827 @item @r{(C++ only)}
2828 Taking the address of a variable which has been declared @samp{register}.
2829
2830 @item @r{(C++ only)}
2831 A base class is not initialized in a derived class' copy constructor.
2832 @end itemize
2833
2834 @item -Wno-div-by-zero
2835 @opindex Wno-div-by-zero
2836 @opindex Wdiv-by-zero
2837 Do not warn about compile-time integer division by zero.  Floating point
2838 division by zero is not warned about, as it can be a legitimate way of
2839 obtaining infinities and NaNs.
2840
2841 @item -Wsystem-headers
2842 @opindex Wsystem-headers
2843 @cindex warnings from system headers
2844 @cindex system headers, warnings from
2845 Print warning messages for constructs found in system header files.
2846 Warnings from system headers are normally suppressed, on the assumption
2847 that they usually do not indicate real problems and would only make the
2848 compiler output harder to read.  Using this command line option tells
2849 GCC to emit warnings from system headers as if they occurred in user
2850 code.  However, note that using @option{-Wall} in conjunction with this
2851 option will @emph{not} warn about unknown pragmas in system
2852 headers---for that, @option{-Wunknown-pragmas} must also be used.
2853
2854 @item -Wfloat-equal
2855 @opindex Wfloat-equal
2856 Warn if floating point values are used in equality comparisons.
2857
2858 The idea behind this is that sometimes it is convenient (for the
2859 programmer) to consider floating-point values as approximations to
2860 infinitely precise real numbers.  If you are doing this, then you need
2861 to compute (by analyzing the code, or in some other way) the maximum or
2862 likely maximum error that the computation introduces, and allow for it
2863 when performing comparisons (and when producing output, but that's a
2864 different problem).  In particular, instead of testing for equality, you
2865 would check to see whether the two values have ranges that overlap; and
2866 this is done with the relational operators, so equality comparisons are
2867 probably mistaken.
2868
2869 @item -Wtraditional @r{(C only)}
2870 @opindex Wtraditional
2871 Warn about certain constructs that behave differently in traditional and
2872 ISO C@.  Also warn about ISO C constructs that have no traditional C
2873 equivalent, and/or problematic constructs which should be avoided.
2874
2875 @itemize @bullet
2876 @item
2877 Macro parameters that appear within string literals in the macro body.
2878 In traditional C macro replacement takes place within string literals,
2879 but does not in ISO C@.
2880
2881 @item
2882 In traditional C, some preprocessor directives did not exist.
2883 Traditional preprocessors would only consider a line to be a directive
2884 if the @samp{#} appeared in column 1 on the line.  Therefore
2885 @option{-Wtraditional} warns about directives that traditional C
2886 understands but would ignore because the @samp{#} does not appear as the
2887 first character on the line.  It also suggests you hide directives like
2888 @samp{#pragma} not understood by traditional C by indenting them.  Some
2889 traditional implementations would not recognize @samp{#elif}, so it
2890 suggests avoiding it altogether.
2891
2892 @item
2893 A function-like macro that appears without arguments.
2894
2895 @item
2896 The unary plus operator.
2897
2898 @item
2899 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2900 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2901 constants.)  Note, these suffixes appear in macros defined in the system
2902 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2903 Use of these macros in user code might normally lead to spurious
2904 warnings, however GCC's integrated preprocessor has enough context to
2905 avoid warning in these cases.
2906
2907 @item
2908 A function declared external in one block and then used after the end of
2909 the block.
2910
2911 @item
2912 A @code{switch} statement has an operand of type @code{long}.
2913
2914 @item
2915 A non-@code{static} function declaration follows a @code{static} one.
2916 This construct is not accepted by some traditional C compilers.
2917
2918 @item
2919 The ISO type of an integer constant has a different width or
2920 signedness from its traditional type.  This warning is only issued if
2921 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2922 typically represent bit patterns, are not warned about.
2923
2924 @item
2925 Usage of ISO string concatenation is detected.
2926
2927 @item
2928 Initialization of automatic aggregates.
2929
2930 @item
2931 Identifier conflicts with labels.  Traditional C lacks a separate
2932 namespace for labels.
2933
2934 @item
2935 Initialization of unions.  If the initializer is zero, the warning is
2936 omitted.  This is done under the assumption that the zero initializer in
2937 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2938 initializer warnings and relies on default initialization to zero in the
2939 traditional C case.
2940
2941 @item
2942 Conversions by prototypes between fixed/floating point values and vice
2943 versa.  The absence of these prototypes when compiling with traditional
2944 C would cause serious problems.  This is a subset of the possible
2945 conversion warnings, for the full set use @option{-Wconversion}.
2946
2947 @item
2948 Use of ISO C style function definitions.  This warning intentionally is
2949 @emph{not} issued for prototype declarations or variadic functions
2950 because these ISO C features will appear in your code when using
2951 libiberty's traditional C compatibility macros, @code{PARAMS} and
2952 @code{VPARAMS}.  This warning is also bypassed for nested functions
2953 because that feature is already a GCC extension and thus not relevant to
2954 traditional C compatibility.
2955 @end itemize
2956
2957 @item -Wdeclaration-after-statement @r{(C only)}
2958 @opindex Wdeclaration-after-statement
2959 Warn when a declaration is found after a statement in a block.  This
2960 construct, known from C++, was introduced with ISO C99 and is by default
2961 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2962 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2963
2964 @item -Wundef
2965 @opindex Wundef
2966 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2967
2968 @item -Wno-endif-labels
2969 @opindex Wno-endif-labels
2970 @opindex Wendif-labels
2971 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2972
2973 @item -Wshadow
2974 @opindex Wshadow
2975 Warn whenever a local variable shadows another local variable, parameter or
2976 global variable or whenever a built-in function is shadowed.
2977
2978 @item -Wlarger-than-@var{len}
2979 @opindex Wlarger-than
2980 Warn whenever an object of larger than @var{len} bytes is defined.
2981
2982 @item -Wpointer-arith
2983 @opindex Wpointer-arith
2984 Warn about anything that depends on the ``size of'' a function type or
2985 of @code{void}.  GNU C assigns these types a size of 1, for
2986 convenience in calculations with @code{void *} pointers and pointers
2987 to functions.
2988
2989 @item -Wbad-function-cast @r{(C only)}
2990 @opindex Wbad-function-cast
2991 Warn whenever a function call is cast to a non-matching type.
2992 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2993
2994 @item -Wcast-qual
2995 @opindex Wcast-qual
2996 Warn whenever a pointer is cast so as to remove a type qualifier from
2997 the target type.  For example, warn if a @code{const char *} is cast
2998 to an ordinary @code{char *}.
2999
3000 @item -Wcast-align
3001 @opindex Wcast-align
3002 Warn whenever a pointer is cast such that the required alignment of the
3003 target is increased.  For example, warn if a @code{char *} is cast to
3004 an @code{int *} on machines where integers can only be accessed at
3005 two- or four-byte boundaries.
3006
3007 @item -Wwrite-strings
3008 @opindex Wwrite-strings
3009 When compiling C, give string constants the type @code{const
3010 char[@var{length}]} so that
3011 copying the address of one into a non-@code{const} @code{char *}
3012 pointer will get a warning; when compiling C++, warn about the
3013 deprecated conversion from string constants to @code{char *}.
3014 These warnings will help you find at
3015 compile time code that can try to write into a string constant, but
3016 only if you have been very careful about using @code{const} in
3017 declarations and prototypes.  Otherwise, it will just be a nuisance;
3018 this is why we did not make @option{-Wall} request these warnings.
3019
3020 @item -Wconversion
3021 @opindex Wconversion
3022 Warn if a prototype causes a type conversion that is different from what
3023 would happen to the same argument in the absence of a prototype.  This
3024 includes conversions of fixed point to floating and vice versa, and
3025 conversions changing the width or signedness of a fixed point argument
3026 except when the same as the default promotion.
3027
3028 Also, warn if a negative integer constant expression is implicitly
3029 converted to an unsigned type.  For example, warn about the assignment
3030 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3031 casts like @code{(unsigned) -1}.
3032
3033 @item -Wsign-compare
3034 @opindex Wsign-compare
3035 @cindex warning for comparison of signed and unsigned values
3036 @cindex comparison of signed and unsigned values, warning
3037 @cindex signed and unsigned values, comparison warning
3038 Warn when a comparison between signed and unsigned values could produce
3039 an incorrect result when the signed value is converted to unsigned.
3040 This warning is also enabled by @option{-Wextra}; to get the other warnings
3041 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3042
3043 @item -Waggregate-return
3044 @opindex Waggregate-return
3045 Warn if any functions that return structures or unions are defined or
3046 called.  (In languages where you can return an array, this also elicits
3047 a warning.)
3048
3049 @item -Wno-attributes
3050 @opindex Wno-attributes
3051 @opindex Wattributes
3052 Do not warn if an unexpected @code{__attribute__} is used, such as
3053 unrecognized attributes, function attributes applied to variables,
3054 etc.  This will not stop errors for incorrect use of supported
3055 attributes.
3056
3057 @item -Wstrict-prototypes @r{(C only)}
3058 @opindex Wstrict-prototypes
3059 Warn if a function is declared or defined without specifying the
3060 argument types.  (An old-style function definition is permitted without
3061 a warning if preceded by a declaration which specifies the argument
3062 types.)
3063
3064 @item -Wold-style-definition @r{(C only)}
3065 @opindex Wold-style-definition
3066 Warn if an old-style function definition is used.  A warning is given
3067 even if there is a previous prototype.
3068
3069 @item -Wmissing-prototypes @r{(C only)}
3070 @opindex Wmissing-prototypes
3071 Warn if a global function is defined without a previous prototype
3072 declaration.  This warning is issued even if the definition itself
3073 provides a prototype.  The aim is to detect global functions that fail
3074 to be declared in header files.
3075
3076 @item -Wmissing-declarations @r{(C only)}
3077 @opindex Wmissing-declarations
3078 Warn if a global function is defined without a previous declaration.
3079 Do so even if the definition itself provides a prototype.
3080 Use this option to detect global functions that are not declared in
3081 header files.
3082
3083 @item -Wmissing-field-initializers
3084 @opindex Wmissing-field-initializers
3085 @opindex W
3086 @opindex Wextra
3087 Warn if a structure's initializer has some fields missing.  For
3088 example, the following code would cause such a warning, because
3089 @code{x.h} is implicitly zero:
3090
3091 @smallexample
3092 struct s @{ int f, g, h; @};
3093 struct s x = @{ 3, 4 @};
3094 @end smallexample
3095
3096 This option does not warn about designated initializers, so the following
3097 modification would not trigger a warning:
3098
3099 @smallexample
3100 struct s @{ int f, g, h; @};
3101 struct s x = @{ .f = 3, .g = 4 @};
3102 @end smallexample
3103
3104 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3105 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3106
3107 @item -Wmissing-noreturn
3108 @opindex Wmissing-noreturn
3109 Warn about functions which might be candidates for attribute @code{noreturn}.
3110 Note these are only possible candidates, not absolute ones.  Care should
3111 be taken to manually verify functions actually do not ever return before
3112 adding the @code{noreturn} attribute, otherwise subtle code generation
3113 bugs could be introduced.  You will not get a warning for @code{main} in
3114 hosted C environments.
3115
3116 @item -Wmissing-format-attribute
3117 @opindex Wmissing-format-attribute
3118 @opindex Wformat
3119 If @option{-Wformat} is enabled, also warn about functions which might be
3120 candidates for @code{format} attributes.  Note these are only possible
3121 candidates, not absolute ones.  GCC will guess that @code{format}
3122 attributes might be appropriate for any function that calls a function
3123 like @code{vprintf} or @code{vscanf}, but this might not always be the
3124 case, and some functions for which @code{format} attributes are
3125 appropriate may not be detected.  This option has no effect unless
3126 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3127
3128 @item -Wno-multichar
3129 @opindex Wno-multichar
3130 @opindex Wmultichar
3131 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3132 Usually they indicate a typo in the user's code, as they have
3133 implementation-defined values, and should not be used in portable code.
3134
3135 @item -Wnormalized=<none|id|nfc|nfkc>
3136 @opindex Wnormalized
3137 @cindex NFC
3138 @cindex NFKC
3139 @cindex character set, input normalization
3140 In ISO C and ISO C++, two identifiers are different if they are
3141 different sequences of characters.  However, sometimes when characters
3142 outside the basic ASCII character set are used, you can have two
3143 different character sequences that look the same.  To avoid confusion,
3144 the ISO 10646 standard sets out some @dfn{normalization rules} which
3145 when applied ensure that two sequences that look the same are turned into
3146 the same sequence.  GCC can warn you if you are using identifiers which
3147 have not been normalized; this option controls that warning.
3148
3149 There are four levels of warning that GCC supports.  The default is
3150 @option{-Wnormalized=nfc}, which warns about any identifier which is
3151 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3152 recommended form for most uses.
3153
3154 Unfortunately, there are some characters which ISO C and ISO C++ allow
3155 in identifiers that when turned into NFC aren't allowable as
3156 identifiers.  That is, there's no way to use these symbols in portable
3157 ISO C or C++ and have all your identifiers in NFC.
3158 @option{-Wnormalized=id} suppresses the warning for these characters.
3159 It is hoped that future versions of the standards involved will correct
3160 this, which is why this option is not the default.
3161
3162 You can switch the warning off for all characters by writing
3163 @option{-Wnormalized=none}.  You would only want to do this if you
3164 were using some other normalization scheme (like ``D''), because
3165 otherwise you can easily create bugs that are literally impossible to see.
3166
3167 Some characters in ISO 10646 have distinct meanings but look identical
3168 in some fonts or display methodologies, especially once formatting has
3169 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3170 LETTER N'', will display just like a regular @code{n} which has been
3171 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3172 normalisation scheme to convert all these into a standard form as
3173 well, and GCC will warn if your code is not in NFKC if you use
3174 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3175 about every identifier that contains the letter O because it might be
3176 confused with the digit 0, and so is not the default, but may be
3177 useful as a local coding convention if the programming environment is
3178 unable to be fixed to display these characters distinctly.
3179
3180 @item -Wno-deprecated-declarations
3181 @opindex Wno-deprecated-declarations
3182 Do not warn about uses of functions, variables, and types marked as
3183 deprecated by using the @code{deprecated} attribute.
3184 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3185 @pxref{Type Attributes}.)
3186
3187 @item -Wpacked
3188 @opindex Wpacked
3189 Warn if a structure is given the packed attribute, but the packed
3190 attribute has no effect on the layout or size of the structure.
3191 Such structures may be mis-aligned for little benefit.  For
3192 instance, in this code, the variable @code{f.x} in @code{struct bar}
3193 will be misaligned even though @code{struct bar} does not itself
3194 have the packed attribute:
3195
3196 @smallexample
3197 @group
3198 struct foo @{
3199   int x;
3200   char a, b, c, d;
3201 @} __attribute__((packed));
3202 struct bar @{
3203   char z;
3204   struct foo f;
3205 @};
3206 @end group
3207 @end smallexample
3208
3209 @item -Wpadded
3210 @opindex Wpadded
3211 Warn if padding is included in a structure, either to align an element
3212 of the structure or to align the whole structure.  Sometimes when this
3213 happens it is possible to rearrange the fields of the structure to
3214 reduce the padding and so make the structure smaller.
3215
3216 @item -Wredundant-decls
3217 @opindex Wredundant-decls
3218 Warn if anything is declared more than once in the same scope, even in
3219 cases where multiple declaration is valid and changes nothing.
3220
3221 @item -Wnested-externs @r{(C only)}
3222 @opindex Wnested-externs
3223 Warn if an @code{extern} declaration is encountered within a function.
3224
3225 @item -Wunreachable-code
3226 @opindex Wunreachable-code
3227 Warn if the compiler detects that code will never be executed.
3228
3229 This option is intended to warn when the compiler detects that at
3230 least a whole line of source code will never be executed, because
3231 some condition is never satisfied or because it is after a
3232 procedure that never returns.
3233
3234 It is possible for this option to produce a warning even though there
3235 are circumstances under which part of the affected line can be executed,
3236 so care should be taken when removing apparently-unreachable code.
3237
3238 For instance, when a function is inlined, a warning may mean that the
3239 line is unreachable in only one inlined copy of the function.
3240
3241 This option is not made part of @option{-Wall} because in a debugging
3242 version of a program there is often substantial code which checks
3243 correct functioning of the program and is, hopefully, unreachable
3244 because the program does work.  Another common use of unreachable
3245 code is to provide behavior which is selectable at compile-time.
3246
3247 @item -Winline
3248 @opindex Winline
3249 Warn if a function can not be inlined and it was declared as inline.
3250 Even with this option, the compiler will not warn about failures to
3251 inline functions declared in system headers.
3252
3253 The compiler uses a variety of heuristics to determine whether or not
3254 to inline a function.  For example, the compiler takes into account
3255 the size of the function being inlined and the amount of inlining
3256 that has already been done in the current function.  Therefore,
3257 seemingly insignificant changes in the source program can cause the
3258 warnings produced by @option{-Winline} to appear or disappear.
3259
3260 @item -Wno-invalid-offsetof @r{(C++ only)}
3261 @opindex Wno-invalid-offsetof
3262 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3263 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3264 to a non-POD type is undefined.  In existing C++ implementations,
3265 however, @samp{offsetof} typically gives meaningful results even when
3266 applied to certain kinds of non-POD types. (Such as a simple
3267 @samp{struct} that fails to be a POD type only by virtue of having a
3268 constructor.)  This flag is for users who are aware that they are
3269 writing nonportable code and who have deliberately chosen to ignore the
3270 warning about it.
3271
3272 The restrictions on @samp{offsetof} may be relaxed in a future version
3273 of the C++ standard.
3274
3275 @item -Wno-int-to-pointer-cast @r{(C only)}
3276 @opindex Wno-int-to-pointer-cast
3277 Suppress warnings from casts to pointer type of an integer of a
3278 different size.
3279
3280 @item -Wno-pointer-to-int-cast @r{(C only)}
3281 @opindex Wno-pointer-to-int-cast
3282 Suppress warnings from casts from a pointer to an integer type of a
3283 different size.
3284
3285 @item -Winvalid-pch
3286 @opindex Winvalid-pch
3287 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3288 the search path but can't be used.
3289
3290 @item -Wlong-long
3291 @opindex Wlong-long
3292 @opindex Wno-long-long
3293 Warn if @samp{long long} type is used.  This is default.  To inhibit
3294 the warning messages, use @option{-Wno-long-long}.  Flags
3295 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3296 only when @option{-pedantic} flag is used.
3297
3298 @item -Wvariadic-macros
3299 @opindex Wvariadic-macros
3300 @opindex Wno-variadic-macros
3301 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3302 alternate syntax when in pedantic ISO C99 mode.  This is default.
3303 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3304
3305 @item -Wdisabled-optimization
3306 @opindex Wdisabled-optimization
3307 Warn if a requested optimization pass is disabled.  This warning does
3308 not generally indicate that there is anything wrong with your code; it
3309 merely indicates that GCC's optimizers were unable to handle the code
3310 effectively.  Often, the problem is that your code is too big or too
3311 complex; GCC will refuse to optimize programs when the optimization
3312 itself is likely to take inordinate amounts of time.
3313
3314 @item -Wno-pointer-sign
3315 @opindex Wno-pointer-sign
3316 Don't warn for pointer argument passing or assignment with different signedness.
3317 Only useful in the negative form since this warning is enabled by default.
3318 This option is only supported for C and Objective-C@.
3319
3320 @item -Werror
3321 @opindex Werror
3322 Make all warnings into errors.
3323 @end table
3324
3325 @node Debugging Options
3326 @section Options for Debugging Your Program or GCC
3327 @cindex options, debugging
3328 @cindex debugging information options
3329
3330 GCC has various special options that are used for debugging
3331 either your program or GCC:
3332
3333 @table @gcctabopt
3334 @item -g
3335 @opindex g
3336 Produce debugging information in the operating system's native format
3337 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3338 information.
3339
3340 On most systems that use stabs format, @option{-g} enables use of extra
3341 debugging information that only GDB can use; this extra information
3342 makes debugging work better in GDB but will probably make other debuggers
3343 crash or
3344 refuse to read the program.  If you want to control for certain whether
3345 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3346 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3347
3348 GCC allows you to use @option{-g} with
3349 @option{-O}.  The shortcuts taken by optimized code may occasionally
3350 produce surprising results: some variables you declared may not exist
3351 at all; flow of control may briefly move where you did not expect it;
3352 some statements may not be executed because they compute constant
3353 results or their values were already at hand; some statements may
3354 execute in different places because they were moved out of loops.
3355
3356 Nevertheless it proves possible to debug optimized output.  This makes
3357 it reasonable to use the optimizer for programs that might have bugs.
3358
3359 The following options are useful when GCC is generated with the
3360 capability for more than one debugging format.
3361
3362 @item -ggdb
3363 @opindex ggdb
3364 Produce debugging information for use by GDB@.  This means to use the
3365 most expressive format available (DWARF 2, stabs, or the native format
3366 if neither of those are supported), including GDB extensions if at all
3367 possible.
3368
3369 @item -gstabs
3370 @opindex gstabs
3371 Produce debugging information in stabs format (if that is supported),
3372 without GDB extensions.  This is the format used by DBX on most BSD
3373 systems.  On MIPS, Alpha and System V Release 4 systems this option
3374 produces stabs debugging output which is not understood by DBX or SDB@.
3375 On System V Release 4 systems this option requires the GNU assembler.
3376
3377 @item -feliminate-unused-debug-symbols
3378 @opindex feliminate-unused-debug-symbols
3379 Produce debugging information in stabs format (if that is supported),
3380 for only symbols that are actually used.
3381
3382 @item -gstabs+
3383 @opindex gstabs+
3384 Produce debugging information in stabs format (if that is supported),
3385 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3386 use of these extensions is likely to make other debuggers crash or
3387 refuse to read the program.
3388
3389 @item -gcoff
3390 @opindex gcoff
3391 Produce debugging information in COFF format (if that is supported).
3392 This is the format used by SDB on most System V systems prior to
3393 System V Release 4.
3394
3395 @item -gxcoff
3396 @opindex gxcoff
3397 Produce debugging information in XCOFF format (if that is supported).
3398 This is the format used by the DBX debugger on IBM RS/6000 systems.
3399
3400 @item -gxcoff+
3401 @opindex gxcoff+
3402 Produce debugging information in XCOFF format (if that is supported),
3403 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3404 use of these extensions is likely to make other debuggers crash or
3405 refuse to read the program, and may cause assemblers other than the GNU
3406 assembler (GAS) to fail with an error.
3407
3408 @item -gdwarf-2
3409 @opindex gdwarf-2
3410 Produce debugging information in DWARF version 2 format (if that is
3411 supported).  This is the format used by DBX on IRIX 6.  With this
3412 option, GCC uses features of DWARF version 3 when they are useful;
3413 version 3 is upward compatible with version 2, but may still cause
3414 problems for older debuggers.
3415
3416 @item -gvms
3417 @opindex gvms
3418 Produce debugging information in VMS debug format (if that is
3419 supported).  This is the format used by DEBUG on VMS systems.
3420
3421 @item -g@var{level}
3422 @itemx -ggdb@var{level}
3423 @itemx -gstabs@var{level}
3424 @itemx -gcoff@var{level}
3425 @itemx -gxcoff@var{level}
3426 @itemx -gvms@var{level}
3427 Request debugging information and also use @var{level} to specify how
3428 much information.  The default level is 2.
3429
3430 Level 1 produces minimal information, enough for making backtraces in
3431 parts of the program that you don't plan to debug.  This includes
3432 descriptions of functions and external variables, but no information
3433 about local variables and no line numbers.
3434
3435 Level 3 includes extra information, such as all the macro definitions
3436 present in the program.  Some debuggers support macro expansion when
3437 you use @option{-g3}.
3438
3439 @option{-gdwarf-2} does not accept a concatenated debug level, because
3440 GCC used to support an option @option{-gdwarf} that meant to generate
3441 debug information in version 1 of the DWARF format (which is very
3442 different from version 2), and it would have been too confusing.  That
3443 debug format is long obsolete, but the option cannot be changed now.
3444 Instead use an additional @option{-g@var{level}} option to change the
3445 debug level for DWARF2.
3446
3447 @item -feliminate-dwarf2-dups
3448 @opindex feliminate-dwarf2-dups
3449 Compress DWARF2 debugging information by eliminating duplicated
3450 information about each symbol.  This option only makes sense when
3451 generating DWARF2 debugging information with @option{-gdwarf-2}.
3452
3453 @cindex @command{prof}
3454 @item -p
3455 @opindex p
3456 Generate extra code to write profile information suitable for the
3457 analysis program @command{prof}.  You must use this option when compiling
3458 the source files you want data about, and you must also use it when
3459 linking.
3460
3461 @cindex @command{gprof}
3462 @item -pg
3463 @opindex pg
3464 Generate extra code to write profile information suitable for the
3465 analysis program @command{gprof}.  You must use this option when compiling
3466 the source files you want data about, and you must also use it when
3467 linking.
3468
3469 @item -Q
3470 @opindex Q
3471 Makes the compiler print out each function name as it is compiled, and
3472 print some statistics about each pass when it finishes.
3473
3474 @item -ftime-report
3475 @opindex ftime-report
3476 Makes the compiler print some statistics about the time consumed by each
3477 pass when it finishes.
3478
3479 @item -fmem-report
3480 @opindex fmem-report
3481 Makes the compiler print some statistics about permanent memory
3482 allocation when it finishes.
3483
3484 @item -fprofile-arcs
3485 @opindex fprofile-arcs
3486 Add code so that program flow @dfn{arcs} are instrumented.  During
3487 execution the program records how many times each branch and call is
3488 executed and how many times it is taken or returns.  When the compiled
3489 program exits it saves this data to a file called
3490 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3491 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3492 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3493 @var{auxname} is generated from the name of the output file, if
3494 explicitly specified and it is not the final executable, otherwise it is
3495 the basename of the source file.  In both cases any suffix is removed
3496 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3497 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3498 @xref{Cross-profiling}.
3499
3500 @cindex @command{gcov}
3501 @item --coverage
3502 @opindex coverage
3503
3504 This option is used to compile and link code instrumented for coverage
3505 analysis.  The option is a synonym for @option{-fprofile-arcs}
3506 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3507 linking).  See the documentation for those options for more details.
3508
3509 @itemize
3510
3511 @item
3512 Compile the source files with @option{-fprofile-arcs} plus optimization
3513 and code generation options.  For test coverage analysis, use the
3514 additional @option{-ftest-coverage} option.  You do not need to profile
3515 every source file in a program.
3516
3517 @item
3518 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3519 (the latter implies the former).
3520
3521 @item
3522 Run the program on a representative workload to generate the arc profile
3523 information.  This may be repeated any number of times.  You can run
3524 concurrent instances of your program, and provided that the file system
3525 supports locking, the data files will be correctly updated.  Also
3526 @code{fork} calls are detected and correctly handled (double counting
3527 will not happen).
3528
3529 @item
3530 For profile-directed optimizations, compile the source files again with
3531 the same optimization and code generation options plus
3532 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3533 Control Optimization}).
3534
3535 @item
3536 For test coverage analysis, use @command{gcov} to produce human readable
3537 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3538 @command{gcov} documentation for further information.
3539
3540 @end itemize
3541
3542 With @option{-fprofile-arcs}, for each function of your program GCC
3543 creates a program flow graph, then finds a spanning tree for the graph.
3544 Only arcs that are not on the spanning tree have to be instrumented: the
3545 compiler adds code to count the number of times that these arcs are
3546 executed.  When an arc is the only exit or only entrance to a block, the
3547 instrumentation code can be added to the block; otherwise, a new basic
3548 block must be created to hold the instrumentation code.
3549
3550 @item -ftree-based-profiling
3551 @opindex ftree-based-profiling
3552 This option is used in addition to @option{-fprofile-arcs} or
3553 @option{-fbranch-probabilities} to control whether those optimizations
3554 are performed on a tree-based or rtl-based internal representation.
3555 If you use this option when compiling with @option{-fprofile-arcs},
3556 you must also use it when compiling later with @option{-fbranch-probabilities}.
3557 Currently the tree-based optimization is in an early stage of
3558 development, and this option is recommended only for those people
3559 working on improving it.
3560
3561 @need 2000
3562 @item -ftest-coverage
3563 @opindex ftest-coverage
3564 Produce a notes file that the @command{gcov} code-coverage utility
3565 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3566 show program coverage.  Each source file's note file is called
3567 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3568 above for a description of @var{auxname} and instructions on how to
3569 generate test coverage data.  Coverage data will match the source files
3570 more closely, if you do not optimize.
3571
3572 @item -d@var{letters}
3573 @item -fdump-rtl-@var{pass}
3574 @opindex d
3575 Says to make debugging dumps during compilation at times specified by
3576 @var{letters}.    This is used for debugging the RTL-based passes of the
3577 compiler.  The file names for most of the dumps are made by appending a
3578 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3579 from the name of the output file, if explicitly specified and it is not
3580 an executable, otherwise it is the basename of the source file.
3581
3582 Most debug dumps can be enabled either passing a letter to the @option{-d}
3583 option, or with a long @option{-fdump-rtl} switch; here are the possible
3584 letters for use in @var{letters} and @var{pass}, and their meanings:
3585
3586 @table @gcctabopt
3587 @item -dA
3588 @opindex dA
3589 Annotate the assembler output with miscellaneous debugging information.
3590
3591 @item -db
3592 @itemx -fdump-rtl-bp
3593 @opindex db
3594 @opindex fdump-rtl-bp
3595 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3596
3597 @item -dB
3598 @itemx -fdump-rtl-bbro
3599 @opindex dB
3600 @opindex fdump-rtl-bbro
3601 Dump after block reordering, to @file{@var{file}.30.bbro}.
3602
3603 @item -dc
3604 @itemx -fdump-rtl-combine
3605 @opindex dc
3606 @opindex fdump-rtl-combine
3607 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3608
3609 @item -dC
3610 @itemx -fdump-rtl-ce1
3611 @itemx -fdump-rtl-ce2
3612 @opindex dC
3613 @opindex fdump-rtl-ce1
3614 @opindex fdump-rtl-ce2
3615 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3616 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3617 and @option{-fdump-rtl-ce2} enable dumping after the second if
3618 conversion, to the file @file{@var{file}.18.ce2}.
3619
3620 @item -dd
3621 @itemx -fdump-rtl-btl
3622 @itemx -fdump-rtl-dbr
3623 @opindex dd
3624 @opindex fdump-rtl-btl
3625 @opindex fdump-rtl-dbr
3626 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3627 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3628 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3629 scheduling, to @file{@var{file}.36.dbr}.
3630
3631 @item -dD
3632 @opindex dD
3633 Dump all macro definitions, at the end of preprocessing, in addition to
3634 normal output.
3635
3636 @item -dE
3637 @itemx -fdump-rtl-ce3
3638 @opindex dE
3639 @opindex fdump-rtl-ce3
3640 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3641
3642 @item -df
3643 @itemx -fdump-rtl-cfg
3644 @itemx -fdump-rtl-life
3645 @opindex df
3646 @opindex fdump-rtl-cfg
3647 @opindex fdump-rtl-life
3648 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3649 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3650 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3651 to @file{@var{file}.16.life}.
3652
3653 @item -dg
3654 @itemx -fdump-rtl-greg
3655 @opindex dg
3656 @opindex fdump-rtl-greg
3657 Dump after global register allocation, to @file{@var{file}.23.greg}.
3658
3659 @item -dG
3660 @itemx -fdump-rtl-gcse
3661 @itemx -fdump-rtl-bypass
3662 @opindex dG
3663 @opindex fdump-rtl-gcse
3664 @opindex fdump-rtl-bypass
3665 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3666 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3667 enable dumping after jump bypassing and control flow optimizations, to
3668 @file{@var{file}.07.bypass}.
3669
3670 @item -dh
3671 @itemx -fdump-rtl-eh
3672 @opindex dh
3673 @opindex fdump-rtl-eh
3674 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3675
3676 @item -di
3677 @itemx -fdump-rtl-sibling
3678 @opindex di
3679 @opindex fdump-rtl-sibling
3680 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3681
3682 @item -dj
3683 @itemx -fdump-rtl-jump
3684 @opindex dj
3685 @opindex fdump-rtl-jump
3686 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3687
3688 @item -dk
3689 @itemx -fdump-rtl-stack
3690 @opindex dk
3691 @opindex fdump-rtl-stack
3692 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3693
3694 @item -dl
3695 @itemx -fdump-rtl-lreg
3696 @opindex dl
3697 @opindex fdump-rtl-lreg
3698 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3699
3700 @item -dL
3701 @itemx -fdump-rtl-loop
3702 @itemx -fdump-rtl-loop2
3703 @opindex dL
3704 @opindex fdump-rtl-loop
3705 @opindex fdump-rtl-loop2
3706 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3707 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3708 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3709 @file{@var{file}.13.loop2}.
3710
3711 @item -dm
3712 @itemx -fdump-rtl-sms
3713 @opindex dm
3714 @opindex fdump-rtl-sms
3715 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3716
3717 @item -dM
3718 @itemx -fdump-rtl-mach
3719 @opindex dM
3720 @opindex fdump-rtl-mach
3721 Dump after performing the machine dependent reorganization pass, to
3722 @file{@var{file}.35.mach}.
3723
3724 @item -dn
3725 @itemx -fdump-rtl-rnreg
3726 @opindex dn
3727 @opindex fdump-rtl-rnreg
3728 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3729
3730 @item -dN
3731 @itemx -fdump-rtl-regmove
3732 @opindex dN
3733 @opindex fdump-rtl-regmove
3734 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3735
3736 @item -do
3737 @itemx -fdump-rtl-postreload
3738 @opindex do
3739 @opindex fdump-rtl-postreload
3740 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3741
3742 @item -dr
3743 @itemx -fdump-rtl-expand
3744 @opindex dr
3745 @opindex fdump-rtl-expand
3746 Dump after RTL generation, to @file{@var{file}.00.expand}.
3747
3748 @item -dR
3749 @itemx -fdump-rtl-sched2
3750 @opindex dR
3751 @opindex fdump-rtl-sched2
3752 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3753
3754 @item -ds
3755 @itemx -fdump-rtl-cse
3756 @opindex ds
3757 @opindex fdump-rtl-cse
3758 Dump after CSE (including the jump optimization that sometimes follows
3759 CSE), to @file{@var{file}.04.cse}.
3760
3761 @item -dS
3762 @itemx -fdump-rtl-sched
3763 @opindex dS
3764 @opindex fdump-rtl-sched
3765 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3766
3767 @item -dt
3768 @itemx -fdump-rtl-cse2
3769 @opindex dt
3770 @opindex fdump-rtl-cse2
3771 Dump after the second CSE pass (including the jump optimization that
3772 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3773
3774 @item -dT
3775 @itemx -fdump-rtl-tracer
3776 @opindex dT
3777 @opindex fdump-rtl-tracer
3778 Dump after running tracer, to @file{@var{file}.12.tracer}.
3779
3780 @item -dV
3781 @itemx -fdump-rtl-vpt
3782 @itemx -fdump-rtl-vartrack
3783 @opindex dV
3784 @opindex fdump-rtl-vpt
3785 @opindex fdump-rtl-vartrack
3786 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3787 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3788 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3789 to @file{@var{file}.34.vartrack}.
3790
3791 @item -dw
3792 @itemx -fdump-rtl-flow2
3793 @opindex dw
3794 @opindex fdump-rtl-flow2
3795 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3796
3797 @item -dz
3798 @itemx -fdump-rtl-peephole2
3799 @opindex dz
3800 @opindex fdump-rtl-peephole2
3801 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3802
3803 @item -dZ
3804 @itemx -fdump-rtl-web
3805 @opindex dZ
3806 @opindex fdump-rtl-web
3807 Dump after live range splitting, to @file{@var{file}.14.web}.
3808
3809 @item -da
3810 @itemx -fdump-rtl-all
3811 @opindex da
3812 @opindex fdump-rtl-all
3813 Produce all the dumps listed above.
3814
3815 @item -dH
3816 @opindex dH
3817 Produce a core dump whenever an error occurs.
3818
3819 @item -dm
3820 @opindex dm
3821 Print statistics on memory usage, at the end of the run, to
3822 standard error.
3823
3824 @item -dp
3825 @opindex dp
3826 Annotate the assembler output with a comment indicating which
3827 pattern and alternative was used.  The length of each instruction is
3828 also printed.
3829
3830 @item -dP
3831 @opindex dP
3832 Dump the RTL in the assembler output as a comment before each instruction.
3833 Also turns on @option{-dp} annotation.
3834
3835 @item -dv
3836 @opindex dv
3837 For each of the other indicated dump files (either with @option{-d} or
3838 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3839 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3840
3841 @item -dx
3842 @opindex dx
3843 Just generate RTL for a function instead of compiling it.  Usually used
3844 with @samp{r} (@option{-fdump-rtl-expand}).
3845
3846 @item -dy
3847 @opindex dy
3848 Dump debugging information during parsing, to standard error.
3849 @end table
3850
3851 @item -fdump-unnumbered
3852 @opindex fdump-unnumbered
3853 When doing debugging dumps (see @option{-d} option above), suppress instruction
3854 numbers and line number note output.  This makes it more feasible to
3855 use diff on debugging dumps for compiler invocations with different
3856 options, in particular with and without @option{-g}.
3857
3858 @item -fdump-translation-unit @r{(C++ only)}
3859 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3860 @opindex fdump-translation-unit
3861 Dump a representation of the tree structure for the entire translation
3862 unit to a file.  The file name is made by appending @file{.tu} to the
3863 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3864 controls the details of the dump as described for the
3865 @option{-fdump-tree} options.
3866
3867 @item -fdump-class-hierarchy @r{(C++ only)}
3868 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3869 @opindex fdump-class-hierarchy
3870 Dump a representation of each class's hierarchy and virtual function
3871 table layout to a file.  The file name is made by appending @file{.class}
3872 to the source file name.  If the @samp{-@var{options}} form is used,
3873 @var{options} controls the details of the dump as described for the
3874 @option{-fdump-tree} options.
3875
3876 @item -fdump-ipa-@var{switch}
3877 @opindex fdump-ipa
3878 Control the dumping at various stages of inter-procedural analysis
3879 language tree to a file.  The file name is generated by appending a switch
3880 specific suffix to the source file name.  The following dumps are possible:
3881
3882 @table @samp
3883 @item all
3884 Enables all inter-procedural analysis dumps; currently the only produced
3885 dump is the @samp{cgraph} dump.
3886
3887 @item cgraph
3888 Dumps information about call-graph optimization, unused function removal,
3889 and inlining decisions.
3890 @end table
3891
3892 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3893 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3894 @opindex fdump-tree
3895 Control the dumping at various stages of processing the intermediate
3896 language tree to a file.  The file name is generated by appending a switch
3897 specific suffix to the source file name.  If the @samp{-@var{options}}
3898 form is used, @var{options} is a list of @samp{-} separated options that
3899 control the details of the dump.  Not all options are applicable to all
3900 dumps, those which are not meaningful will be ignored.  The following
3901 options are available
3902
3903 @table @samp
3904 @item address
3905 Print the address of each node.  Usually this is not meaningful as it
3906 changes according to the environment and source file.  Its primary use
3907 is for tying up a dump file with a debug environment.
3908 @item slim
3909 Inhibit dumping of members of a scope or body of a function merely
3910 because that scope has been reached.  Only dump such items when they
3911 are directly reachable by some other path.  When dumping pretty-printed
3912 trees, this option inhibits dumping the bodies of control structures.
3913 @item raw
3914 Print a raw representation of the tree.  By default, trees are
3915 pretty-printed into a C-like representation.
3916 @item details
3917 Enable more detailed dumps (not honored by every dump option).
3918 @item stats
3919 Enable dumping various statistics about the pass (not honored by every dump
3920 option).
3921 @item blocks
3922 Enable showing basic block boundaries (disabled in raw dumps).
3923 @item vops
3924 Enable showing virtual operands for every statement.
3925 @item lineno
3926 Enable showing line numbers for statements.
3927 @item uid
3928 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3929 @item all
3930 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3931 @end table
3932
3933 The following tree dumps are possible:
3934 @table @samp
3935
3936 @item original
3937 Dump before any tree based optimization, to @file{@var{file}.original}.
3938
3939 @item optimized
3940 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3941
3942 @item inlined
3943 Dump after function inlining, to @file{@var{file}.inlined}.
3944
3945 @item gimple
3946 @opindex fdump-tree-gimple
3947 Dump each function before and after the gimplification pass to a file.  The
3948 file name is made by appending @file{.gimple} to the source file name.
3949
3950 @item cfg
3951 @opindex fdump-tree-cfg
3952 Dump the control flow graph of each function to a file.  The file name is
3953 made by appending @file{.cfg} to the source file name.
3954
3955 @item vcg
3956 @opindex fdump-tree-vcg
3957 Dump the control flow graph of each function to a file in VCG format.  The
3958 file name is made by appending @file{.vcg} to the source file name.  Note
3959 that if the file contains more than one function, the generated file cannot
3960 be used directly by VCG@.  You will need to cut and paste each function's
3961 graph into its own separate file first.
3962
3963 @item ch
3964 @opindex fdump-tree-ch
3965 Dump each function after copying loop headers.  The file name is made by
3966 appending @file{.ch} to the source file name.
3967
3968 @item ssa
3969 @opindex fdump-tree-ssa
3970 Dump SSA related information to a file.  The file name is made by appending
3971 @file{.ssa} to the source file name.
3972
3973 @item salias
3974 @opindex fdump-tree-salias
3975 Dump structure aliasing variable information to a file.  This file name
3976 is made by appending @file{.salias} to the source file name.
3977
3978 @item alias
3979 @opindex fdump-tree-alias
3980 Dump aliasing information for each function.  The file name is made by
3981 appending @file{.alias} to the source file name.
3982
3983 @item ccp
3984 @opindex fdump-tree-ccp
3985 Dump each function after CCP@.  The file name is made by appending
3986 @file{.ccp} to the source file name.
3987
3988 @item storeccp
3989 @opindex fdump-tree-storeccp
3990 Dump each function after STORE-CCP.  The file name is made by appending
3991 @file{.storeccp} to the source file name.
3992
3993 @item pre
3994 @opindex fdump-tree-pre
3995 Dump trees after partial redundancy elimination.  The file name is made
3996 by appending @file{.pre} to the source file name.
3997
3998 @item fre
3999 @opindex fdump-tree-fre
4000 Dump trees after full redundancy elimination.  The file name is made
4001 by appending @file{.fre} to the source file name.
4002
4003 @item copyprop
4004 @opindex fdump-tree-copyprop
4005 Dump trees after copy propagation.  The file name is made
4006 by appending @file{.copyprop} to the source file name.
4007
4008 @item store_copyprop
4009 @opindex fdump-tree-store_copyprop
4010 Dump trees after store copy-propagation.  The file name is made
4011 by appending @file{.store_copyprop} to the source file name.
4012
4013 @item dce
4014 @opindex fdump-tree-dce
4015 Dump each function after dead code elimination.  The file name is made by
4016 appending @file{.dce} to the source file name.
4017
4018 @item mudflap
4019 @opindex fdump-tree-mudflap
4020 Dump each function after adding mudflap instrumentation.  The file name is
4021 made by appending @file{.mudflap} to the source file name.
4022
4023 @item sra
4024 @opindex fdump-tree-sra
4025 Dump each function after performing scalar replacement of aggregates.  The
4026 file name is made by appending @file{.sra} to the source file name.
4027
4028 @item sink
4029 @opindex fdump-tree-sink
4030 Dump each function after performing code sinking.  The file name is made
4031 by appending @file{.sink} to the source file name. 
4032
4033 @item dom
4034 @opindex fdump-tree-dom
4035 Dump each function after applying dominator tree optimizations.  The file
4036 name is made by appending @file{.dom} to the source file name.
4037
4038 @item dse
4039 @opindex fdump-tree-dse
4040 Dump each function after applying dead store elimination.  The file
4041 name is made by appending @file{.dse} to the source file name.
4042
4043 @item phiopt
4044 @opindex fdump-tree-phiopt
4045 Dump each function after optimizing PHI nodes into straightline code.  The file
4046 name is made by appending @file{.phiopt} to the source file name.
4047
4048 @item forwprop
4049 @opindex fdump-tree-forwprop
4050 Dump each function after forward propagating single use variables.  The file
4051 name is made by appending @file{.forwprop} to the source file name.
4052
4053 @item copyrename
4054 @opindex fdump-tree-copyrename
4055 Dump each function after applying the copy rename optimization.  The file
4056 name is made by appending @file{.copyrename} to the source file name.
4057
4058 @item nrv
4059 @opindex fdump-tree-nrv
4060 Dump each function after applying the named return value optimization on
4061 generic trees.  The file name is made by appending @file{.nrv} to the source
4062 file name.
4063
4064 @item vect
4065 @opindex fdump-tree-vect
4066 Dump each function after applying vectorization of loops.  The file name is
4067 made by appending @file{.vect} to the source file name.
4068
4069 @item all
4070 @opindex fdump-tree-all
4071 Enable all the available tree dumps with the flags provided in this option.
4072 @end table
4073
4074 @item -ftree-vectorizer-verbose=@var{n}
4075 @opindex ftree-vectorizer-verbose
4076 This option controls the amount of debugging output the vectorizer prints.
4077 This information is written to standard error, unless @option{-fdump-tree-all}
4078 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4079 usual dump listing file, @file{.vect}.
4080
4081 @item -frandom-seed=@var{string}
4082 @opindex frandom-string
4083 This option provides a seed that GCC uses when it would otherwise use
4084 random numbers.  It is used to generate certain symbol names
4085 that have to be different in every compiled file.  It is also used to
4086 place unique stamps in coverage data files and the object files that
4087 produce them.  You can use the @option{-frandom-seed} option to produce
4088 reproducibly identical object files.
4089
4090 The @var{string} should be different for every file you compile.
4091
4092 @item -fsched-verbose=@var{n}
4093 @opindex fsched-verbose
4094 On targets that use instruction scheduling, this option controls the
4095 amount of debugging output the scheduler prints.  This information is
4096 written to standard error, unless @option{-dS} or @option{-dR} is
4097 specified, in which case it is output to the usual dump
4098 listing file, @file{.sched} or @file{.sched2} respectively.  However
4099 for @var{n} greater than nine, the output is always printed to standard
4100 error.
4101
4102 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4103 same information as @option{-dRS}.  For @var{n} greater than one, it
4104 also output basic block probabilities, detailed ready list information
4105 and unit/insn info.  For @var{n} greater than two, it includes RTL
4106 at abort point, control-flow and regions info.  And for @var{n} over
4107 four, @option{-fsched-verbose} also includes dependence info.
4108
4109 @item -save-temps
4110 @opindex save-temps
4111 Store the usual ``temporary'' intermediate files permanently; place them
4112 in the current directory and name them based on the source file.  Thus,
4113 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4114 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4115 preprocessed @file{foo.i} output file even though the compiler now
4116 normally uses an integrated preprocessor.
4117
4118 When used in combination with the @option{-x} command line option,
4119 @option{-save-temps} is sensible enough to avoid over writing an
4120 input source file with the same extension as an intermediate file.
4121 The corresponding intermediate file may be obtained by renaming the
4122 source file before using @option{-save-temps}.
4123
4124 @item -time
4125 @opindex time
4126 Report the CPU time taken by each subprocess in the compilation
4127 sequence.  For C source files, this is the compiler proper and assembler
4128 (plus the linker if linking is done).  The output looks like this:
4129
4130 @smallexample
4131 # cc1 0.12 0.01
4132 # as 0.00 0.01
4133 @end smallexample
4134
4135 The first number on each line is the ``user time'', that is time spent
4136 executing the program itself.  The second number is ``system time'',
4137 time spent executing operating system routines on behalf of the program.
4138 Both numbers are in seconds.
4139
4140 @item -fvar-tracking
4141 @opindex fvar-tracking
4142 Run variable tracking pass.  It computes where variables are stored at each
4143 position in code.  Better debugging information is then generated
4144 (if the debugging information format supports this information).
4145
4146 It is enabled by default when compiling with optimization (@option{-Os},
4147 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4148 the debug info format supports it.
4149
4150 @item -print-file-name=@var{library}
4151 @opindex print-file-name
4152 Print the full absolute name of the library file @var{library} that
4153 would be used when linking---and don't do anything else.  With this
4154 option, GCC does not compile or link anything; it just prints the
4155 file name.
4156
4157 @item -print-multi-directory
4158 @opindex print-multi-directory
4159 Print the directory name corresponding to the multilib selected by any
4160 other switches present in the command line.  This directory is supposed
4161 to exist in @env{GCC_EXEC_PREFIX}.
4162
4163 @item -print-multi-lib
4164 @opindex print-multi-lib
4165 Print the mapping from multilib directory names to compiler switches
4166 that enable them.  The directory name is separated from the switches by
4167 @samp{;}, and each switch starts with an @samp{@@} instead of the
4168 @samp{-}, without spaces between multiple switches.  This is supposed to
4169 ease shell-processing.
4170
4171 @item -print-prog-name=@var{program}
4172 @opindex print-prog-name
4173 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4174
4175 @item -print-libgcc-file-name
4176 @opindex print-libgcc-file-name
4177 Same as @option{-print-file-name=libgcc.a}.
4178
4179 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4180 but you do want to link with @file{libgcc.a}.  You can do
4181
4182 @smallexample
4183 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4184 @end smallexample
4185
4186 @item -print-search-dirs
4187 @opindex print-search-dirs
4188 Print the name of the configured installation directory and a list of
4189 program and library directories @command{gcc} will search---and don't do anything else.
4190
4191 This is useful when @command{gcc} prints the error message
4192 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4193 To resolve this you either need to put @file{cpp0} and the other compiler
4194 components where @command{gcc} expects to find them, or you can set the environment
4195 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4196 Don't forget the trailing @samp{/}.
4197 @xref{Environment Variables}.
4198
4199 @item -dumpmachine
4200 @opindex dumpmachine
4201 Print the compiler's target machine (for example,
4202 @samp{i686-pc-linux-gnu})---and don't do anything else.
4203
4204 @item -dumpversion
4205 @opindex dumpversion
4206 Print the compiler version (for example, @samp{3.0})---and don't do
4207 anything else.
4208
4209 @item -dumpspecs
4210 @opindex dumpspecs
4211 Print the compiler's built-in specs---and don't do anything else.  (This
4212 is used when GCC itself is being built.)  @xref{Spec Files}.
4213
4214 @item -feliminate-unused-debug-types
4215 @opindex feliminate-unused-debug-types
4216 Normally, when producing DWARF2 output, GCC will emit debugging
4217 information for all types declared in a compilation
4218 unit, regardless of whether or not they are actually used
4219 in that compilation unit.  Sometimes this is useful, such as
4220 if, in the debugger, you want to cast a value to a type that is
4221 not actually used in your program (but is declared).  More often,
4222 however, this results in a significant amount of wasted space.
4223 With this option, GCC will avoid producing debug symbol output
4224 for types that are nowhere used in the source file being compiled.
4225 @end table
4226
4227 @node Optimize Options
4228 @section Options That Control Optimization
4229 @cindex optimize options
4230 @cindex options, optimization
4231
4232 These options control various sorts of optimizations.
4233
4234 Without any optimization option, the compiler's goal is to reduce the
4235 cost of compilation and to make debugging produce the expected
4236 results.  Statements are independent: if you stop the program with a
4237 breakpoint between statements, you can then assign a new value to any
4238 variable or change the program counter to any other statement in the
4239 function and get exactly the results you would expect from the source
4240 code.
4241
4242 Turning on optimization flags makes the compiler attempt to improve
4243 the performance and/or code size at the expense of compilation time
4244 and possibly the ability to debug the program.
4245
4246 The compiler performs optimization based on the knowledge it has of
4247 the program.  Optimization levels @option{-O2} and above, in
4248 particular, enable @emph{unit-at-a-time} mode, which allows the
4249 compiler to consider information gained from later functions in
4250 the file when compiling a function.  Compiling multiple files at
4251 once to a single output file in @emph{unit-at-a-time} mode allows
4252 the compiler to use information gained from all of the files when
4253 compiling each of them.
4254
4255 Not all optimizations are controlled directly by a flag.  Only
4256 optimizations that have a flag are listed.
4257
4258 @table @gcctabopt
4259 @item -O
4260 @itemx -O1
4261 @opindex O
4262 @opindex O1
4263 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4264 more memory for a large function.
4265
4266 With @option{-O}, the compiler tries to reduce code size and execution
4267 time, without performing any optimizations that take a great deal of
4268 compilation time.
4269
4270 @option{-O} turns on the following optimization flags:
4271 @gccoptlist{-fdefer-pop @gol
4272 -fdelayed-branch @gol
4273 -fguess-branch-probability @gol
4274 -fcprop-registers @gol
4275 -floop-optimize @gol
4276 -fif-conversion @gol
4277 -fif-conversion2 @gol
4278 -ftree-ccp @gol
4279 -ftree-dce @gol
4280 -ftree-dominator-opts @gol
4281 -ftree-dse @gol
4282 -ftree-ter @gol
4283 -ftree-lrs @gol
4284 -ftree-sra @gol
4285 -ftree-copyrename @gol
4286 -ftree-fre @gol
4287 -ftree-ch @gol
4288 -fmerge-constants}
4289
4290 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4291 where doing so does not interfere with debugging.
4292
4293 @item -O2
4294 @opindex O2
4295 Optimize even more.  GCC performs nearly all supported optimizations
4296 that do not involve a space-speed tradeoff.  The compiler does not
4297 perform loop unrolling or function inlining when you specify @option{-O2}.
4298 As compared to @option{-O}, this option increases both compilation time
4299 and the performance of the generated code.
4300
4301 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4302 also turns on the following optimization flags:
4303 @gccoptlist{-fthread-jumps @gol
4304 -fcrossjumping @gol
4305 -foptimize-sibling-calls @gol
4306 -fcse-follow-jumps  -fcse-skip-blocks @gol
4307 -fgcse  -fgcse-lm  @gol
4308 -fexpensive-optimizations @gol
4309 -fstrength-reduce @gol
4310 -frerun-cse-after-loop  -frerun-loop-opt @gol
4311 -fcaller-saves @gol
4312 -fforce-mem @gol
4313 -fpeephole2 @gol
4314 -fschedule-insns  -fschedule-insns2 @gol
4315 -fsched-interblock  -fsched-spec @gol
4316 -fregmove @gol
4317 -fstrict-aliasing @gol
4318 -fdelete-null-pointer-checks @gol
4319 -freorder-blocks  -freorder-functions @gol
4320 -funit-at-a-time @gol
4321 -falign-functions  -falign-jumps @gol
4322 -falign-loops  -falign-labels @gol
4323 -ftree-pre}
4324
4325 Please note the warning under @option{-fgcse} about
4326 invoking @option{-O2} on programs that use computed gotos.
4327
4328 @item -O3
4329 @opindex O3
4330 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4331 @option{-O2} and also turns on the @option{-finline-functions},
4332 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4333
4334 @item -O0
4335 @opindex O0
4336 Do not optimize.  This is the default.
4337
4338 @item -Os
4339 @opindex Os
4340 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4341 do not typically increase code size.  It also performs further
4342 optimizations designed to reduce code size.
4343
4344 @option{-Os} disables the following optimization flags:
4345 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4346 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4347
4348 If you use multiple @option{-O} options, with or without level numbers,
4349 the last such option is the one that is effective.
4350 @end table
4351
4352 Options of the form @option{-f@var{flag}} specify machine-independent
4353 flags.  Most flags have both positive and negative forms; the negative
4354 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4355 below, only one of the forms is listed---the one you typically will
4356 use.  You can figure out the other form by either removing @samp{no-}
4357 or adding it.
4358
4359 The following options control specific optimizations.  They are either
4360 activated by @option{-O} options or are related to ones that are.  You
4361 can use the following flags in the rare cases when ``fine-tuning'' of
4362 optimizations to be performed is desired.
4363
4364 @table @gcctabopt
4365 @item -fno-default-inline
4366 @opindex fno-default-inline
4367 Do not make member functions inline by default merely because they are
4368 defined inside the class scope (C++ only).  Otherwise, when you specify
4369 @w{@option{-O}}, member functions defined inside class scope are compiled
4370 inline by default; i.e., you don't need to add @samp{inline} in front of
4371 the member function name.
4372
4373 @item -fno-defer-pop
4374 @opindex fno-defer-pop
4375 Always pop the arguments to each function call as soon as that function
4376 returns.  For machines which must pop arguments after a function call,
4377 the compiler normally lets arguments accumulate on the stack for several
4378 function calls and pops them all at once.
4379
4380 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4381
4382 @item -fforce-mem
4383 @opindex fforce-mem
4384 Force memory operands to be copied into registers before doing
4385 arithmetic on them.  This produces better code by making all memory
4386 references potential common subexpressions.  When they are not common
4387 subexpressions, instruction combination should eliminate the separate
4388 register-load.
4389
4390 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4391
4392 @item -fforce-addr
4393 @opindex fforce-addr
4394 Force memory address constants to be copied into registers before
4395 doing arithmetic on them.  This may produce better code just as
4396 @option{-fforce-mem} may.
4397
4398 @item -fomit-frame-pointer
4399 @opindex fomit-frame-pointer
4400 Don't keep the frame pointer in a register for functions that
4401 don't need one.  This avoids the instructions to save, set up and
4402 restore frame pointers; it also makes an extra register available
4403 in many functions.  @strong{It also makes debugging impossible on
4404 some machines.}
4405
4406 On some machines, such as the VAX, this flag has no effect, because
4407 the standard calling sequence automatically handles the frame pointer
4408 and nothing is saved by pretending it doesn't exist.  The
4409 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4410 whether a target machine supports this flag.  @xref{Registers,,Register
4411 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4412
4413 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4414
4415 @item -foptimize-sibling-calls
4416 @opindex foptimize-sibling-calls
4417 Optimize sibling and tail recursive calls.
4418
4419 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4420
4421 @item -fno-inline
4422 @opindex fno-inline
4423 Don't pay attention to the @code{inline} keyword.  Normally this option
4424 is used to keep the compiler from expanding any functions inline.
4425 Note that if you are not optimizing, no functions can be expanded inline.
4426
4427 @item -finline-functions
4428 @opindex finline-functions
4429 Integrate all simple functions into their callers.  The compiler
4430 heuristically decides which functions are simple enough to be worth
4431 integrating in this way.
4432
4433 If all calls to a given function are integrated, and the function is
4434 declared @code{static}, then the function is normally not output as
4435 assembler code in its own right.
4436
4437 Enabled at level @option{-O3}.
4438
4439 @item -finline-limit=@var{n}
4440 @opindex finline-limit
4441 By default, GCC limits the size of functions that can be inlined.  This flag
4442 allows the control of this limit for functions that are explicitly marked as
4443 inline (i.e., marked with the inline keyword or defined within the class
4444 definition in c++).  @var{n} is the size of functions that can be inlined in
4445 number of pseudo instructions (not counting parameter handling).  The default
4446 value of @var{n} is 600.
4447 Increasing this value can result in more inlined code at
4448 the cost of compilation time and memory consumption.  Decreasing usually makes
4449 the compilation faster and less code will be inlined (which presumably
4450 means slower programs).  This option is particularly useful for programs that
4451 use inlining heavily such as those based on recursive templates with C++.
4452
4453 Inlining is actually controlled by a number of parameters, which may be
4454 specified individually by using @option{--param @var{name}=@var{value}}.
4455 The @option{-finline-limit=@var{n}} option sets some of these parameters
4456 as follows:
4457
4458 @table @gcctabopt
4459  @item max-inline-insns-single
4460   is set to @var{n}/2.
4461  @item max-inline-insns-auto
4462   is set to @var{n}/2.
4463  @item min-inline-insns
4464   is set to 130 or @var{n}/4, whichever is smaller.
4465  @item max-inline-insns-rtl
4466   is set to @var{n}.
4467 @end table
4468
4469 See below for a documentation of the individual
4470 parameters controlling inlining.
4471
4472 @emph{Note:} pseudo instruction represents, in this particular context, an
4473 abstract measurement of function's size.  In no way does it represent a count
4474 of assembly instructions and as such its exact meaning might change from one
4475 release to an another.
4476
4477 @item -fkeep-inline-functions
4478 @opindex fkeep-inline-functions
4479 In C, emit @code{static} functions that are declared @code{inline}
4480 into the object file, even if the function has been inlined into all
4481 of its callers.  This switch does not affect functions using the
4482 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4483 inline functions into the object file.
4484
4485 @item -fkeep-static-consts
4486 @opindex fkeep-static-consts
4487 Emit variables declared @code{static const} when optimization isn't turned
4488 on, even if the variables aren't referenced.
4489
4490 GCC enables this option by default.  If you want to force the compiler to
4491 check if the variable was referenced, regardless of whether or not
4492 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4493
4494 @item -fmerge-constants
4495 Attempt to merge identical constants (string constants and floating point
4496 constants) across compilation units.
4497
4498 This option is the default for optimized compilation if the assembler and
4499 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4500 behavior.
4501
4502 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4503
4504 @item -fmerge-all-constants
4505 Attempt to merge identical constants and identical variables.
4506
4507 This option implies @option{-fmerge-constants}.  In addition to
4508 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4509 arrays or initialized constant variables with integral or floating point
4510 types.  Languages like C or C++ require each non-automatic variable to
4511 have distinct location, so using this option will result in non-conforming
4512 behavior.
4513
4514 @item -fmodulo-sched
4515 @opindex fmodulo-sched
4516 Perform swing modulo scheduling immediately before the first scheduling
4517 pass.  This pass looks at innermost loops and reorders their
4518 instructions by overlapping different iterations.
4519
4520 @item -fno-branch-count-reg
4521 @opindex fno-branch-count-reg
4522 Do not use ``decrement and branch'' instructions on a count register,
4523 but instead generate a sequence of instructions that decrement a
4524 register, compare it against zero, then branch based upon the result.
4525 This option is only meaningful on architectures that support such
4526 instructions, which include x86, PowerPC, IA-64 and S/390.
4527
4528 The default is @option{-fbranch-count-reg}, enabled when
4529 @option{-fstrength-reduce} is enabled.
4530
4531 @item -fno-function-cse
4532 @opindex fno-function-cse
4533 Do not put function addresses in registers; make each instruction that
4534 calls a constant function contain the function's address explicitly.
4535
4536 This option results in less efficient code, but some strange hacks
4537 that alter the assembler output may be confused by the optimizations
4538 performed when this option is not used.
4539
4540 The default is @option{-ffunction-cse}
4541
4542 @item -fno-zero-initialized-in-bss
4543 @opindex fno-zero-initialized-in-bss
4544 If the target supports a BSS section, GCC by default puts variables that
4545 are initialized to zero into BSS@.  This can save space in the resulting
4546 code.
4547
4548 This option turns off this behavior because some programs explicitly
4549 rely on variables going to the data section.  E.g., so that the
4550 resulting executable can find the beginning of that section and/or make
4551 assumptions based on that.
4552
4553 The default is @option{-fzero-initialized-in-bss}.
4554
4555 @item -fbounds-check
4556 @opindex fbounds-check
4557 For front-ends that support it, generate additional code to check that
4558 indices used to access arrays are within the declared range.  This is
4559 currently only supported by the Java and Fortran front-ends, where
4560 this option defaults to true and false respectively.
4561
4562 @item -fmudflap -fmudflapth -fmudflapir
4563 @opindex fmudflap
4564 @opindex fmudflapth
4565 @opindex fmudflapir
4566 @cindex bounds checking
4567 @cindex mudflap
4568 For front-ends that support it (C and C++), instrument all risky
4569 pointer/array dereferencing operations, some standard library
4570 string/heap functions, and some other associated constructs with
4571 range/validity tests.  Modules so instrumented should be immune to
4572 buffer overflows, invalid heap use, and some other classes of C/C++
4573 programming errors.  The instrumentation relies on a separate runtime
4574 library (@file{libmudflap}), which will be linked into a program if
4575 @option{-fmudflap} is given at link time.  Run-time behavior of the
4576 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4577 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4578 for its options.
4579
4580 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4581 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4582 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4583 instrumentation should ignore pointer reads.  This produces less
4584 instrumentation (and therefore faster execution) and still provides
4585 some protection against outright memory corrupting writes, but allows
4586 erroneously read data to propagate within a program.
4587
4588 @item -fstrength-reduce
4589 @opindex fstrength-reduce
4590 Perform the optimizations of loop strength reduction and
4591 elimination of iteration variables.
4592
4593 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4594
4595 @item -fthread-jumps
4596 @opindex fthread-jumps
4597 Perform optimizations where we check to see if a jump branches to a
4598 location where another comparison subsumed by the first is found.  If
4599 so, the first branch is redirected to either the destination of the
4600 second branch or a point immediately following it, depending on whether
4601 the condition is known to be true or false.
4602
4603 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4604
4605 @item -fcse-follow-jumps
4606 @opindex fcse-follow-jumps
4607 In common subexpression elimination, scan through jump instructions
4608 when the target of the jump is not reached by any other path.  For
4609 example, when CSE encounters an @code{if} statement with an
4610 @code{else} clause, CSE will follow the jump when the condition
4611 tested is false.
4612
4613 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4614
4615 @item -fcse-skip-blocks
4616 @opindex fcse-skip-blocks
4617 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4618 follow jumps which conditionally skip over blocks.  When CSE
4619 encounters a simple @code{if} statement with no else clause,
4620 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4621 body of the @code{if}.
4622
4623 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4624
4625 @item -frerun-cse-after-loop
4626 @opindex frerun-cse-after-loop
4627 Re-run common subexpression elimination after loop optimizations has been
4628 performed.
4629
4630 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4631
4632 @item -frerun-loop-opt
4633 @opindex frerun-loop-opt
4634 Run the loop optimizer twice.
4635
4636 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4637
4638 @item -fgcse
4639 @opindex fgcse
4640 Perform a global common subexpression elimination pass.
4641 This pass also performs global constant and copy propagation.
4642
4643 @emph{Note:} When compiling a program using computed gotos, a GCC
4644 extension, you may get better runtime performance if you disable
4645 the global common subexpression elimination pass by adding
4646 @option{-fno-gcse} to the command line.
4647
4648 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4649
4650 @item -fgcse-lm
4651 @opindex fgcse-lm
4652 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4653 attempt to move loads which are only killed by stores into themselves.  This
4654 allows a loop containing a load/store sequence to be changed to a load outside
4655 the loop, and a copy/store within the loop.
4656
4657 Enabled by default when gcse is enabled.
4658
4659 @item -fgcse-sm
4660 @opindex fgcse-sm
4661 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4662 global common subexpression elimination.  This pass will attempt to move
4663 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4664 loops containing a load/store sequence can be changed to a load before
4665 the loop and a store after the loop.
4666
4667 Not enabled at any optimization level.
4668
4669 @item -fgcse-las
4670 @opindex fgcse-las
4671 When @option{-fgcse-las} is enabled, the global common subexpression
4672 elimination pass eliminates redundant loads that come after stores to the
4673 same memory location (both partial and full redundancies).
4674
4675 Not enabled at any optimization level.
4676
4677 @item -fgcse-after-reload
4678 @opindex fgcse-after-reload
4679 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4680 pass is performed after reload.  The purpose of this pass is to cleanup
4681 redundant spilling.
4682
4683 @item -floop-optimize
4684 @opindex floop-optimize
4685 Perform loop optimizations: move constant expressions out of loops, simplify
4686 exit test conditions and optionally do strength-reduction as well.
4687
4688 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4689
4690 @item -floop-optimize2
4691 @opindex floop-optimize2
4692 Perform loop optimizations using the new loop optimizer.  The optimizations
4693 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4694 by separate flags.
4695
4696 @item -fcrossjumping
4697 @opindex crossjumping
4698 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4699 resulting code may or may not perform better than without cross-jumping.
4700
4701 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4702
4703 @item -fif-conversion
4704 @opindex if-conversion
4705 Attempt to transform conditional jumps into branch-less equivalents.  This
4706 include use of conditional moves, min, max, set flags and abs instructions, and
4707 some tricks doable by standard arithmetics.  The use of conditional execution
4708 on chips where it is available is controlled by @code{if-conversion2}.
4709
4710 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4711
4712 @item -fif-conversion2
4713 @opindex if-conversion2
4714 Use conditional execution (where available) to transform conditional jumps into
4715 branch-less equivalents.
4716
4717 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4718
4719 @item -fdelete-null-pointer-checks
4720 @opindex fdelete-null-pointer-checks
4721 Use global dataflow analysis to identify and eliminate useless checks
4722 for null pointers.  The compiler assumes that dereferencing a null
4723 pointer would have halted the program.  If a pointer is checked after
4724 it has already been dereferenced, it cannot be null.
4725
4726 In some environments, this assumption is not true, and programs can
4727 safely dereference null pointers.  Use
4728 @option{-fno-delete-null-pointer-checks} to disable this optimization
4729 for programs which depend on that behavior.
4730
4731 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4732
4733 @item -fexpensive-optimizations
4734 @opindex fexpensive-optimizations
4735 Perform a number of minor optimizations that are relatively expensive.
4736
4737 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4738
4739 @item -foptimize-register-move
4740 @itemx -fregmove
4741 @opindex foptimize-register-move
4742 @opindex fregmove
4743 Attempt to reassign register numbers in move instructions and as
4744 operands of other simple instructions in order to maximize the amount of
4745 register tying.  This is especially helpful on machines with two-operand
4746 instructions.
4747
4748 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4749 optimization.
4750
4751 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4752
4753 @item -fdelayed-branch
4754 @opindex fdelayed-branch
4755 If supported for the target machine, attempt to reorder instructions
4756 to exploit instruction slots available after delayed branch
4757 instructions.
4758
4759 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4760
4761 @item -fschedule-insns
4762 @opindex fschedule-insns
4763 If supported for the target machine, attempt to reorder instructions to
4764 eliminate execution stalls due to required data being unavailable.  This
4765 helps machines that have slow floating point or memory load instructions
4766 by allowing other instructions to be issued until the result of the load
4767 or floating point instruction is required.
4768
4769 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4770
4771 @item -fschedule-insns2
4772 @opindex fschedule-insns2
4773 Similar to @option{-fschedule-insns}, but requests an additional pass of
4774 instruction scheduling after register allocation has been done.  This is
4775 especially useful on machines with a relatively small number of
4776 registers and where memory load instructions take more than one cycle.
4777
4778 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4779
4780 @item -fno-sched-interblock
4781 @opindex fno-sched-interblock
4782 Don't schedule instructions across basic blocks.  This is normally
4783 enabled by default when scheduling before register allocation, i.e.@:
4784 with @option{-fschedule-insns} or at @option{-O2} or higher.
4785
4786 @item -fno-sched-spec
4787 @opindex fno-sched-spec
4788 Don't allow speculative motion of non-load instructions.  This is normally
4789 enabled by default when scheduling before register allocation, i.e.@:
4790 with @option{-fschedule-insns} or at @option{-O2} or higher.
4791
4792 @item -fsched-spec-load
4793 @opindex fsched-spec-load
4794 Allow speculative motion of some load instructions.  This only makes
4795 sense when scheduling before register allocation, i.e.@: with
4796 @option{-fschedule-insns} or at @option{-O2} or higher.
4797
4798 @item -fsched-spec-load-dangerous
4799 @opindex fsched-spec-load-dangerous
4800 Allow speculative motion of more load instructions.  This only makes
4801 sense when scheduling before register allocation, i.e.@: with
4802 @option{-fschedule-insns} or at @option{-O2} or higher.
4803
4804 @item -fsched-stalled-insns=@var{n}
4805 @opindex fsched-stalled-insns
4806 Define how many insns (if any) can be moved prematurely from the queue
4807 of stalled insns into the ready list, during the second scheduling pass.
4808
4809 @item -fsched-stalled-insns-dep=@var{n}
4810 @opindex fsched-stalled-insns-dep
4811 Define how many insn groups (cycles) will be examined for a dependency
4812 on a stalled insn that is candidate for premature removal from the queue
4813 of stalled insns.  Has an effect only during the second scheduling pass,
4814 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4815
4816 @item -fsched2-use-superblocks
4817 @opindex fsched2-use-superblocks
4818 When scheduling after register allocation, do use superblock scheduling
4819 algorithm.  Superblock scheduling allows motion across basic block boundaries
4820 resulting on faster schedules.  This option is experimental, as not all machine
4821 descriptions used by GCC model the CPU closely enough to avoid unreliable
4822 results from the algorithm.
4823
4824 This only makes sense when scheduling after register allocation, i.e.@: with
4825 @option{-fschedule-insns2} or at @option{-O2} or higher.
4826
4827 @item -fsched2-use-traces
4828 @opindex fsched2-use-traces
4829 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4830 allocation and additionally perform code duplication in order to increase the
4831 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4832 trace formation.
4833
4834 This mode should produce faster but significantly longer programs.  Also
4835 without @option{-fbranch-probabilities} the traces constructed may not
4836 match the reality and hurt the performance.  This only makes
4837 sense when scheduling after register allocation, i.e.@: with
4838 @option{-fschedule-insns2} or at @option{-O2} or higher.
4839
4840 @item -freschedule-modulo-scheduled-loops
4841 @opindex fscheduling-in-modulo-scheduled-loops
4842 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4843 we may want to prevent the later scheduling passes from changing its schedule, we use this
4844 option to control that.
4845
4846 @item -fcaller-saves
4847 @opindex fcaller-saves
4848 Enable values to be allocated in registers that will be clobbered by
4849 function calls, by emitting extra instructions to save and restore the
4850 registers around such calls.  Such allocation is done only when it
4851 seems to result in better code than would otherwise be produced.
4852
4853 This option is always enabled by default on certain machines, usually
4854 those which have no call-preserved registers to use instead.
4855
4856 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4857
4858 @item -ftree-pre
4859 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4860 enabled by default at @option{-O2} and @option{-O3}.
4861
4862 @item -ftree-fre
4863 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4864 between FRE and PRE is that FRE only considers expressions
4865 that are computed on all paths leading to the redundant computation.
4866 This analysis faster than PRE, though it exposes fewer redundancies.
4867 This flag is enabled by default at @option{-O} and higher.
4868
4869 @item -ftree-copy-prop
4870 Perform copy propagation on trees.  This pass eliminates unnecessary
4871 copy operations.  This flag is enabled by default at @option{-O} and
4872 higher.
4873
4874 @item -ftree-store-copy-prop
4875 Perform copy propagation of memory loads and stores.  This pass
4876 eliminates unnecessary copy operations in memory references
4877 (structures, global variables, arrays, etc).  This flag is enabled by
4878 default at @option{-O2} and higher.
4879
4880 @item -ftree-salias
4881 Perform structural alias analysis on trees.  This flag
4882 is enabled by default at @option{-O} and higher.
4883
4884 @item -ftree-sink
4885 Perform forward store motion  on trees.  This flag is
4886 enabled by default at @option{-O} and higher.
4887
4888 @item -ftree-ccp
4889 Perform sparse conditional constant propagation (CCP) on trees.  This
4890 pass only operates on local scalar variables and is enabled by default
4891 at @option{-O} and higher.
4892
4893 @item -ftree-store-ccp
4894 Perform sparse conditional constant propagation (CCP) on trees.  This
4895 pass operates on both local scalar variables and memory stores and
4896 loads (global variables, structures, arrays, etc).  This flag is
4897 enabled by default at @option{-O2} and higher.
4898
4899 @item -ftree-dce
4900 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4901 default at @option{-O} and higher.
4902
4903 @item -ftree-dominator-opts
4904 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4905 default at @option{-O} and higher.
4906
4907 @item -ftree-ch
4908 Perform loop header copying on trees.  This is beneficial since it increases
4909 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4910 is enabled by default at @option{-O} and higher.  It is not enabled
4911 for @option{-Os}, since it usually increases code size.
4912
4913 @item -ftree-loop-optimize
4914 Perform loop optimizations on trees.  This flag is enabled by default
4915 at @option{-O} and higher.
4916
4917 @item -ftree-loop-linear
4918 Perform linear loop transformations on tree.  This flag can improve cache
4919 performance and allow further loop optimizations to take place.
4920
4921 @item -ftree-loop-im
4922 Perform loop invariant motion on trees.  This pass moves only invariants that
4923 would be hard to handle at RTL level (function calls, operations that expand to
4924 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4925 operands of conditions that are invariant out of the loop, so that we can use
4926 just trivial invariantness analysis in loop unswitching.  The pass also includes
4927 store motion.
4928
4929 @item -ftree-loop-ivcanon
4930 Create a canonical counter for number of iterations in the loop for that
4931 determining number of iterations requires complicated analysis.  Later
4932 optimizations then may determine the number easily.  Useful especially
4933 in connection with unrolling.
4934
4935 @item -fivopts
4936 Perform induction variable optimizations (strength reduction, induction
4937 variable merging and induction variable elimination) on trees.
4938
4939 @item -ftree-sra
4940 Perform scalar replacement of aggregates.  This pass replaces structure
4941 references with scalars to prevent committing structures to memory too
4942 early.  This flag is enabled by default at @option{-O} and higher.
4943
4944 @item -ftree-copyrename
4945 Perform copy renaming on trees.  This pass attempts to rename compiler
4946 temporaries to other variables at copy locations, usually resulting in
4947 variable names which more closely resemble the original variables.  This flag
4948 is enabled by default at @option{-O} and higher.
4949
4950 @item -ftree-ter
4951 Perform temporary expression replacement during the SSA->normal phase.  Single
4952 use/single def temporaries are replaced at their use location with their
4953 defining expression.  This results in non-GIMPLE code, but gives the expanders
4954 much more complex trees to work on resulting in better RTL generation.  This is
4955 enabled by default at @option{-O} and higher.
4956
4957 @item -ftree-lrs
4958 Perform live range splitting during the SSA->normal phase.  Distinct live
4959 ranges of a variable are split into unique variables, allowing for better
4960 optimization later.  This is enabled by default at @option{-O} and higher.
4961
4962 @item -ftree-vectorize
4963 Perform loop vectorization on trees.
4964
4965 @item -ftracer
4966 @opindex ftracer
4967 Perform tail duplication to enlarge superblock size.  This transformation
4968 simplifies the control flow of the function allowing other optimizations to do
4969 better job.
4970
4971 @item -funroll-loops
4972 @opindex funroll-loops
4973 Unroll loops whose number of iterations can be determined at compile
4974 time or upon entry to the loop.  @option{-funroll-loops} implies both
4975 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4976 option makes code larger, and may or may not make it run faster.
4977
4978 @item -funroll-all-loops
4979 @opindex funroll-all-loops
4980 Unroll all loops, even if their number of iterations is uncertain when
4981 the loop is entered.  This usually makes programs run more slowly.
4982 @option{-funroll-all-loops} implies the same options as
4983 @option{-funroll-loops},
4984
4985 @item -fsplit-ivs-in-unroller
4986 @opindex -fsplit-ivs-in-unroller
4987 Enables expressing of values of induction variables in later iterations
4988 of the unrolled loop using the value in the first iteration.  This breaks
4989 long dependency chains, thus improving efficiency of the scheduling passes
4990 (for best results, @option{-fweb} should be used as well).
4991
4992 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4993 same effect.  However in cases the loop body is more complicated than
4994 a single basic block, this is not reliable.  It also does not work at all
4995 on some of the architectures due to restrictions in the CSE pass.
4996
4997 This optimization is enabled by default.
4998
4999 @item -fvariable-expansion-in-unroller
5000 @opindex -fvariable-expansion-in-unroller
5001 With this option, the compiler will create multiple copies of some
5002 local variables when unrolling a loop which can result in superior code.
5003
5004 @item -fprefetch-loop-arrays
5005 @opindex fprefetch-loop-arrays
5006 If supported by the target machine, generate instructions to prefetch
5007 memory to improve the performance of loops that access large arrays.
5008
5009 These options may generate better or worse code; results are highly
5010 dependent on the structure of loops within the source code.
5011
5012 @item -fno-peephole
5013 @itemx -fno-peephole2
5014 @opindex fno-peephole
5015 @opindex fno-peephole2
5016 Disable any machine-specific peephole optimizations.  The difference
5017 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5018 are implemented in the compiler; some targets use one, some use the
5019 other, a few use both.
5020
5021 @option{-fpeephole} is enabled by default.
5022 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5023
5024 @item -fno-guess-branch-probability
5025 @opindex fno-guess-branch-probability
5026 Do not guess branch probabilities using heuristics.
5027
5028 GCC will use heuristics to guess branch probabilities if they are
5029 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5030 heuristics are based on the control flow graph.  If some branch probabilities
5031 are specified by @samp{__builtin_expect}, then the heuristics will be
5032 used to guess branch probabilities for the rest of the control flow graph,
5033 taking the @samp{__builtin_expect} info into account.  The interactions
5034 between the heuristics and @samp{__builtin_expect} can be complex, and in
5035 some cases, it may be useful to disable the heuristics so that the effects
5036 of @samp{__builtin_expect} are easier to understand.
5037
5038 The default is @option{-fguess-branch-probability} at levels
5039 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5040
5041 @item -freorder-blocks
5042 @opindex freorder-blocks
5043 Reorder basic blocks in the compiled function in order to reduce number of
5044 taken branches and improve code locality.
5045
5046 Enabled at levels @option{-O2}, @option{-O3}.
5047
5048 @item -freorder-blocks-and-partition
5049 @opindex freorder-blocks-and-partition
5050 In addition to reordering basic blocks in the compiled function, in order
5051 to reduce number of taken branches, partitions hot and cold basic blocks
5052 into separate sections of the assembly and .o files, to improve
5053 paging and cache locality performance.
5054
5055 This optimization is automatically turned off in the presence of
5056 exception handling, for linkonce sections, for functions with a user-defined
5057 section attribute and on any architecture that does not support named
5058 sections.
5059
5060 @item -freorder-functions
5061 @opindex freorder-functions
5062 Reorder functions in the object file in order to
5063 improve code locality.  This is implemented by using special
5064 subsections @code{.text.hot} for most frequently executed functions and
5065 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5066 the linker so object file format must support named sections and linker must
5067 place them in a reasonable way.
5068
5069 Also profile feedback must be available in to make this option effective.  See
5070 @option{-fprofile-arcs} for details.
5071
5072 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5073
5074 @item -fstrict-aliasing
5075 @opindex fstrict-aliasing
5076 Allows the compiler to assume the strictest aliasing rules applicable to
5077 the language being compiled.  For C (and C++), this activates
5078 optimizations based on the type of expressions.  In particular, an
5079 object of one type is assumed never to reside at the same address as an
5080 object of a different type, unless the types are almost the same.  For
5081 example, an @code{unsigned int} can alias an @code{int}, but not a
5082 @code{void*} or a @code{double}.  A character type may alias any other
5083 type.
5084
5085 Pay special attention to code like this:
5086 @smallexample
5087 union a_union @{
5088   int i;
5089   double d;
5090 @};
5091
5092 int f() @{
5093   a_union t;
5094   t.d = 3.0;
5095   return t.i;
5096 @}
5097 @end smallexample
5098 The practice of reading from a different union member than the one most
5099 recently written to (called ``type-punning'') is common.  Even with
5100 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5101 is accessed through the union type.  So, the code above will work as
5102 expected.  However, this code might not:
5103 @smallexample
5104 int f() @{
5105   a_union t;
5106   int* ip;
5107   t.d = 3.0;
5108   ip = &t.i;
5109   return *ip;
5110 @}
5111 @end smallexample
5112
5113 Every language that wishes to perform language-specific alias analysis
5114 should define a function that computes, given an @code{tree}
5115 node, an alias set for the node.  Nodes in different alias sets are not
5116 allowed to alias.  For an example, see the C front-end function
5117 @code{c_get_alias_set}.
5118
5119 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5120
5121 @item -falign-functions
5122 @itemx -falign-functions=@var{n}
5123 @opindex falign-functions
5124 Align the start of functions to the next power-of-two greater than
5125 @var{n}, skipping up to @var{n} bytes.  For instance,
5126 @option{-falign-functions=32} aligns functions to the next 32-byte
5127 boundary, but @option{-falign-functions=24} would align to the next
5128 32-byte boundary only if this can be done by skipping 23 bytes or less.
5129
5130 @option{-fno-align-functions} and @option{-falign-functions=1} are
5131 equivalent and mean that functions will not be aligned.
5132
5133 Some assemblers only support this flag when @var{n} is a power of two;
5134 in that case, it is rounded up.
5135
5136 If @var{n} is not specified or is zero, use a machine-dependent default.
5137
5138 Enabled at levels @option{-O2}, @option{-O3}.
5139
5140 @item -falign-labels
5141 @itemx -falign-labels=@var{n}
5142 @opindex falign-labels
5143 Align all branch targets to a power-of-two boundary, skipping up to
5144 @var{n} bytes like @option{-falign-functions}.  This option can easily
5145 make code slower, because it must insert dummy operations for when the
5146 branch target is reached in the usual flow of the code.
5147
5148 @option{-fno-align-labels} and @option{-falign-labels=1} are
5149 equivalent and mean that labels will not be aligned.
5150
5151 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5152 are greater than this value, then their values are used instead.
5153
5154 If @var{n} is not specified or is zero, use a machine-dependent default
5155 which is very likely to be @samp{1}, meaning no alignment.
5156
5157 Enabled at levels @option{-O2}, @option{-O3}.
5158
5159 @item -falign-loops
5160 @itemx -falign-loops=@var{n}
5161 @opindex falign-loops
5162 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5163 like @option{-falign-functions}.  The hope is that the loop will be
5164 executed many times, which will make up for any execution of the dummy
5165 operations.
5166
5167 @option{-fno-align-loops} and @option{-falign-loops=1} are
5168 equivalent and mean that loops will not be aligned.
5169
5170 If @var{n} is not specified or is zero, use a machine-dependent default.
5171
5172 Enabled at levels @option{-O2}, @option{-O3}.
5173
5174 @item -falign-jumps
5175 @itemx -falign-jumps=@var{n}
5176 @opindex falign-jumps
5177 Align branch targets to a power-of-two boundary, for branch targets
5178 where the targets can only be reached by jumping, skipping up to @var{n}
5179 bytes like @option{-falign-functions}.  In this case, no dummy operations
5180 need be executed.
5181
5182 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5183 equivalent and mean that loops will not be aligned.
5184
5185 If @var{n} is not specified or is zero, use a machine-dependent default.
5186
5187 Enabled at levels @option{-O2}, @option{-O3}.
5188
5189 @item -funit-at-a-time
5190 @opindex funit-at-a-time
5191 Parse the whole compilation unit before starting to produce code.
5192 This allows some extra optimizations to take place but consumes
5193 more memory (in general).  There are some compatibility issues
5194 with @emph{unit-at-at-time} mode:
5195 @itemize @bullet
5196 @item
5197 enabling @emph{unit-at-a-time} mode may change the order
5198 in which functions, variables, and top-level @code{asm} statements
5199 are emitted, and will likely break code relying on some particular
5200 ordering.  The majority of such top-level @code{asm} statements,
5201 though, can be replaced by @code{section} attributes.
5202
5203 @item
5204 @emph{unit-at-a-time} mode removes unreferenced static variables
5205 and functions are removed.  This may result in undefined references
5206 when an @code{asm} statement refers directly to variables or functions
5207 that are otherwise unused.  In that case either the variable/function
5208 shall be listed as an operand of the @code{asm} statement operand or,
5209 in the case of top-level @code{asm} statements the attribute @code{used}
5210 shall be used on the declaration.
5211
5212 @item
5213 Static functions now can use non-standard passing conventions that
5214 may break @code{asm} statements calling functions directly.  Again,
5215 attribute @code{used} will prevent this behavior.
5216 @end itemize
5217
5218 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5219 but this scheme may not be supported by future releases of GCC@.
5220
5221 Enabled at levels @option{-O2}, @option{-O3}.
5222
5223 @item -fweb
5224 @opindex fweb
5225 Constructs webs as commonly used for register allocation purposes and assign
5226 each web individual pseudo register.  This allows the register allocation pass
5227 to operate on pseudos directly, but also strengthens several other optimization
5228 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5229 however, make debugging impossible, since variables will no longer stay in a
5230 ``home register''.
5231
5232 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5233 on targets where the default format for debugging information supports
5234 variable tracking.
5235
5236 @item -fno-cprop-registers
5237 @opindex fno-cprop-registers
5238 After register allocation and post-register allocation instruction splitting,
5239 we perform a copy-propagation pass to try to reduce scheduling dependencies
5240 and occasionally eliminate the copy.
5241
5242 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5243
5244 @item -fprofile-generate
5245 @opindex fprofile-generate
5246
5247 Enable options usually used for instrumenting application to produce
5248 profile useful for later recompilation with profile feedback based
5249 optimization.  You must use @option{-fprofile-generate} both when
5250 compiling and when linking your program.
5251
5252 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5253
5254 @item -fprofile-use
5255 @opindex fprofile-use
5256 Enable profile feedback directed optimizations, and optimizations
5257 generally profitable only with profile feedback available.
5258
5259 The following options are enabled: @code{-fbranch-probabilities},
5260 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5261
5262 @end table
5263
5264 The following options control compiler behavior regarding floating
5265 point arithmetic.  These options trade off between speed and
5266 correctness.  All must be specifically enabled.
5267
5268 @table @gcctabopt
5269 @item -ffloat-store
5270 @opindex ffloat-store
5271 Do not store floating point variables in registers, and inhibit other
5272 options that might change whether a floating point value is taken from a
5273 register or memory.
5274
5275 @cindex floating point precision
5276 This option prevents undesirable excess precision on machines such as
5277 the 68000 where the floating registers (of the 68881) keep more
5278 precision than a @code{double} is supposed to have.  Similarly for the
5279 x86 architecture.  For most programs, the excess precision does only
5280 good, but a few programs rely on the precise definition of IEEE floating
5281 point.  Use @option{-ffloat-store} for such programs, after modifying
5282 them to store all pertinent intermediate computations into variables.
5283
5284 @item -ffast-math
5285 @opindex ffast-math
5286 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5287 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5288 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5289 and @option{fcx-limited-range}.
5290
5291 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5292
5293 This option should never be turned on by any @option{-O} option since
5294 it can result in incorrect output for programs which depend on
5295 an exact implementation of IEEE or ISO rules/specifications for
5296 math functions.
5297
5298 @item -fno-math-errno
5299 @opindex fno-math-errno
5300 Do not set ERRNO after calling math functions that are executed
5301 with a single instruction, e.g., sqrt.  A program that relies on
5302 IEEE exceptions for math error handling may want to use this flag
5303 for speed while maintaining IEEE arithmetic compatibility.
5304
5305 This option should never be turned on by any @option{-O} option since
5306 it can result in incorrect output for programs which depend on
5307 an exact implementation of IEEE or ISO rules/specifications for
5308 math functions.
5309
5310 The default is @option{-fmath-errno}.
5311
5312 @item -funsafe-math-optimizations
5313 @opindex funsafe-math-optimizations
5314 Allow optimizations for floating-point arithmetic that (a) assume
5315 that arguments and results are valid and (b) may violate IEEE or
5316 ANSI standards.  When used at link-time, it may include libraries
5317 or startup files that change the default FPU control word or other
5318 similar optimizations.
5319
5320 This option should never be turned on by any @option{-O} option since
5321 it can result in incorrect output for programs which depend on
5322 an exact implementation of IEEE or ISO rules/specifications for
5323 math functions.
5324
5325 The default is @option{-fno-unsafe-math-optimizations}.
5326
5327 @item -ffinite-math-only
5328 @opindex ffinite-math-only
5329 Allow optimizations for floating-point arithmetic that assume
5330 that arguments and results are not NaNs or +-Infs.
5331
5332 This option should never be turned on by any @option{-O} option since
5333 it can result in incorrect output for programs which depend on
5334 an exact implementation of IEEE or ISO rules/specifications.
5335
5336 The default is @option{-fno-finite-math-only}.
5337
5338 @item -fno-trapping-math
5339 @opindex fno-trapping-math
5340 Compile code assuming that floating-point operations cannot generate
5341 user-visible traps.  These traps include division by zero, overflow,
5342 underflow, inexact result and invalid operation.  This option implies
5343 @option{-fno-signaling-nans}.  Setting this option may allow faster
5344 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5345
5346 This option should never be turned on by any @option{-O} option since
5347 it can result in incorrect output for programs which depend on
5348 an exact implementation of IEEE or ISO rules/specifications for
5349 math functions.
5350
5351 The default is @option{-ftrapping-math}.
5352
5353 @item -frounding-math
5354 @opindex frounding-math
5355 Disable transformations and optimizations that assume default floating
5356 point rounding behavior.  This is round-to-zero for all floating point
5357 to integer conversions, and round-to-nearest for all other arithmetic
5358 truncations.  This option should be specified for programs that change
5359 the FP rounding mode dynamically, or that may be executed with a
5360 non-default rounding mode.  This option disables constant folding of
5361 floating point expressions at compile-time (which may be affected by
5362 rounding mode) and arithmetic transformations that are unsafe in the
5363 presence of sign-dependent rounding modes.
5364
5365 The default is @option{-fno-rounding-math}.
5366
5367 This option is experimental and does not currently guarantee to
5368 disable all GCC optimizations that are affected by rounding mode.
5369 Future versions of GCC may provide finer control of this setting
5370 using C99's @code{FENV_ACCESS} pragma.  This command line option
5371 will be used to specify the default state for @code{FENV_ACCESS}.
5372
5373 @item -fsignaling-nans
5374 @opindex fsignaling-nans
5375 Compile code assuming that IEEE signaling NaNs may generate user-visible
5376 traps during floating-point operations.  Setting this option disables
5377 optimizations that may change the number of exceptions visible with
5378 signaling NaNs.  This option implies @option{-ftrapping-math}.
5379
5380 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5381 be defined.
5382
5383 The default is @option{-fno-signaling-nans}.
5384
5385 This option is experimental and does not currently guarantee to
5386 disable all GCC optimizations that affect signaling NaN behavior.
5387
5388 @item -fsingle-precision-constant
5389 @opindex fsingle-precision-constant
5390 Treat floating point constant as single precision constant instead of
5391 implicitly converting it to double precision constant.
5392
5393 @item -fcx-limited-range
5394 @itemx -fno-cx-limited-range
5395 @opindex fcx-limited-range
5396 @opindex fno-cx-limited-range
5397 When enabled, this option states that a range reduction step is not
5398 needed when performing complex division.  The default is
5399 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5400
5401 This option controls the default setting of the ISO C99 
5402 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5403 all languages.
5404
5405 @end table
5406
5407 The following options control optimizations that may improve
5408 performance, but are not enabled by any @option{-O} options.  This
5409 section includes experimental options that may produce broken code.
5410
5411 @table @gcctabopt
5412 @item -fbranch-probabilities
5413 @opindex fbranch-probabilities
5414 After running a program compiled with @option{-fprofile-arcs}
5415 (@pxref{Debugging Options,, Options for Debugging Your Program or
5416 @command{gcc}}), you can compile it a second time using
5417 @option{-fbranch-probabilities}, to improve optimizations based on
5418 the number of times each branch was taken.  When the program
5419 compiled with @option{-fprofile-arcs} exits it saves arc execution
5420 counts to a file called @file{@var{sourcename}.gcda} for each source
5421 file  The information in this data file is very dependent on the
5422 structure of the generated code, so you must use the same source code
5423 and the same optimization options for both compilations.
5424
5425 With @option{-fbranch-probabilities}, GCC puts a
5426 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5427 These can be used to improve optimization.  Currently, they are only
5428 used in one place: in @file{reorg.c}, instead of guessing which path a
5429 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5430 exactly determine which path is taken more often.
5431
5432 @item -fprofile-values
5433 @opindex fprofile-values
5434 If combined with @option{-fprofile-arcs}, it adds code so that some
5435 data about values of expressions in the program is gathered.
5436
5437 With @option{-fbranch-probabilities}, it reads back the data gathered
5438 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5439 notes to instructions for their later usage in optimizations.
5440
5441 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5442
5443 @item -fvpt
5444 @opindex fvpt
5445 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5446 a code to gather information about values of expressions.
5447
5448 With @option{-fbranch-probabilities}, it reads back the data gathered
5449 and actually performs the optimizations based on them.
5450 Currently the optimizations include specialization of division operation
5451 using the knowledge about the value of the denominator.
5452
5453 @item -fspeculative-prefetching
5454 @opindex fspeculative-prefetching
5455 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5456 a code to gather information about addresses of memory references in the
5457 program.
5458
5459 With @option{-fbranch-probabilities}, it reads back the data gathered
5460 and issues prefetch instructions according to them.  In addition to the opportunities
5461 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5462 memory access patterns---for example accesses to the data stored in linked
5463 list whose elements are usually allocated sequentially.
5464
5465 In order to prevent issuing double prefetches, usage of
5466 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5467
5468 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5469
5470 @item -frename-registers
5471 @opindex frename-registers
5472 Attempt to avoid false dependencies in scheduled code by making use
5473 of registers left over after register allocation.  This optimization
5474 will most benefit processors with lots of registers.  Depending on the
5475 debug information format adopted by the target, however, it can
5476 make debugging impossible, since variables will no longer stay in
5477 a ``home register''.
5478
5479 Not enabled by default at any level because it has known bugs.
5480
5481 @item -ftracer
5482 @opindex ftracer
5483 Perform tail duplication to enlarge superblock size.  This transformation
5484 simplifies the control flow of the function allowing other optimizations to do
5485 better job.
5486
5487 Enabled with @option{-fprofile-use}.
5488
5489 @item -funroll-loops
5490 @opindex funroll-loops
5491 Unroll loops whose number of iterations can be determined at compile time or
5492 upon entry to the loop.  @option{-funroll-loops} implies
5493 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5494 (i.e.@: complete removal of loops with small constant number of iterations).
5495 This option makes code larger, and may or may not make it run faster.
5496
5497 Enabled with @option{-fprofile-use}.
5498
5499 @item -funroll-all-loops
5500 @opindex funroll-all-loops
5501 Unroll all loops, even if their number of iterations is uncertain when
5502 the loop is entered.  This usually makes programs run more slowly.
5503 @option{-funroll-all-loops} implies the same options as
5504 @option{-funroll-loops}.
5505
5506 @item -fpeel-loops
5507 @opindex fpeel-loops
5508 Peels the loops for that there is enough information that they do not
5509 roll much (from profile feedback).  It also turns on complete loop peeling
5510 (i.e.@: complete removal of loops with small constant number of iterations).
5511
5512 Enabled with @option{-fprofile-use}.
5513
5514 @item -fmove-loop-invariants
5515 @opindex fmove-loop-invariants
5516 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5517 at level @option{-O1}
5518
5519 @item -funswitch-loops
5520 @opindex funswitch-loops
5521 Move branches with loop invariant conditions out of the loop, with duplicates
5522 of the loop on both branches (modified according to result of the condition).
5523
5524 @item -fprefetch-loop-arrays
5525 @opindex fprefetch-loop-arrays
5526 If supported by the target machine, generate instructions to prefetch
5527 memory to improve the performance of loops that access large arrays.
5528
5529 Disabled at level @option{-Os}.
5530
5531 @item -ffunction-sections
5532 @itemx -fdata-sections
5533 @opindex ffunction-sections
5534 @opindex fdata-sections
5535 Place each function or data item into its own section in the output
5536 file if the target supports arbitrary sections.  The name of the
5537 function or the name of the data item determines the section's name
5538 in the output file.
5539
5540 Use these options on systems where the linker can perform optimizations
5541 to improve locality of reference in the instruction space.  Most systems
5542 using the ELF object format and SPARC processors running Solaris 2 have
5543 linkers with such optimizations.  AIX may have these optimizations in
5544 the future.
5545
5546 Only use these options when there are significant benefits from doing
5547 so.  When you specify these options, the assembler and linker will
5548 create larger object and executable files and will also be slower.
5549 You will not be able to use @code{gprof} on all systems if you
5550 specify this option and you may have problems with debugging if
5551 you specify both this option and @option{-g}.
5552
5553 @item -fbranch-target-load-optimize
5554 @opindex fbranch-target-load-optimize
5555 Perform branch target register load optimization before prologue / epilogue
5556 threading.
5557 The use of target registers can typically be exposed only during reload,
5558 thus hoisting loads out of loops and doing inter-block scheduling needs
5559 a separate optimization pass.
5560
5561 @item -fbranch-target-load-optimize2
5562 @opindex fbranch-target-load-optimize2
5563 Perform branch target register load optimization after prologue / epilogue
5564 threading.
5565
5566 @item -fbtr-bb-exclusive
5567 @opindex fbtr-bb-exclusive
5568 When performing branch target register load optimization, don't reuse
5569 branch target registers in within any basic block.
5570
5571 @item --param @var{name}=@var{value}
5572 @opindex param
5573 In some places, GCC uses various constants to control the amount of
5574 optimization that is done.  For example, GCC will not inline functions
5575 that contain more that a certain number of instructions.  You can
5576 control some of these constants on the command-line using the
5577 @option{--param} option.
5578
5579 The names of specific parameters, and the meaning of the values, are
5580 tied to the internals of the compiler, and are subject to change
5581 without notice in future releases.
5582
5583 In each case, the @var{value} is an integer.  The allowable choices for
5584 @var{name} are given in the following table:
5585
5586 @table @gcctabopt
5587 @item salias-max-implicit-fields
5588 The maximum number of fields in a variable without direct
5589 structure accesses for which structure aliasing will consider trying 
5590 to track each field.  The default is 5
5591
5592 @item sra-max-structure-size
5593 The maximum structure size, in bytes, at which the scalar replacement
5594 of aggregates (SRA) optimization will perform block copies.  The
5595 default value, 0, implies that GCC will select the most appropriate
5596 size itself.
5597
5598 @item sra-field-structure-ratio
5599 The threshold ratio (as a percentage) between instantiated fields and
5600 the complete structure size.  We say that if the ratio of the number
5601 of bytes in instantiated fields to the number of bytes in the complete
5602 structure exceeds this parameter, then block copies are not used.  The
5603 default is 75.
5604
5605 @item max-crossjump-edges
5606 The maximum number of incoming edges to consider for crossjumping.
5607 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5608 the number of edges incoming to each block.  Increasing values mean
5609 more aggressive optimization, making the compile time increase with
5610 probably small improvement in executable size.
5611
5612 @item min-crossjump-insns
5613 The minimum number of instructions which must be matched at the end
5614 of two blocks before crossjumping will be performed on them.  This
5615 value is ignored in the case where all instructions in the block being
5616 crossjumped from are matched.  The default value is 5.
5617
5618 @item max-goto-duplication-insns
5619 The maximum number of instructions to duplicate to a block that jumps
5620 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5621 passes, GCC factors computed gotos early in the compilation process,
5622 and unfactors them as late as possible.  Only computed jumps at the
5623 end of a basic blocks with no more than max-goto-duplication-insns are
5624 unfactored.  The default value is 8.
5625
5626 @item max-delay-slot-insn-search
5627 The maximum number of instructions to consider when looking for an
5628 instruction to fill a delay slot.  If more than this arbitrary number of
5629 instructions is searched, the time savings from filling the delay slot
5630 will be minimal so stop searching.  Increasing values mean more
5631 aggressive optimization, making the compile time increase with probably
5632 small improvement in executable run time.
5633
5634 @item max-delay-slot-live-search
5635 When trying to fill delay slots, the maximum number of instructions to
5636 consider when searching for a block with valid live register
5637 information.  Increasing this arbitrarily chosen value means more
5638 aggressive optimization, increasing the compile time.  This parameter
5639 should be removed when the delay slot code is rewritten to maintain the
5640 control-flow graph.
5641
5642 @item max-gcse-memory
5643 The approximate maximum amount of memory that will be allocated in
5644 order to perform the global common subexpression elimination
5645 optimization.  If more memory than specified is required, the
5646 optimization will not be done.
5647
5648 @item max-gcse-passes
5649 The maximum number of passes of GCSE to run.  The default is 1.
5650
5651 @item max-pending-list-length
5652 The maximum number of pending dependencies scheduling will allow
5653 before flushing the current state and starting over.  Large functions
5654 with few branches or calls can create excessively large lists which
5655 needlessly consume memory and resources.
5656
5657 @item max-inline-insns-single
5658 Several parameters control the tree inliner used in gcc.
5659 This number sets the maximum number of instructions (counted in GCC's
5660 internal representation) in a single function that the tree inliner
5661 will consider for inlining.  This only affects functions declared
5662 inline and methods implemented in a class declaration (C++).
5663 The default value is 450.
5664
5665 @item max-inline-insns-auto
5666 When you use @option{-finline-functions} (included in @option{-O3}),
5667 a lot of functions that would otherwise not be considered for inlining
5668 by the compiler will be investigated.  To those functions, a different
5669 (more restrictive) limit compared to functions declared inline can
5670 be applied.
5671 The default value is 90.
5672
5673 @item large-function-insns
5674 The limit specifying really large functions.  For functions larger than this
5675 limit after inlining inlining is constrained by
5676 @option{--param large-function-growth}.  This parameter is useful primarily
5677 to avoid extreme compilation time caused by non-linear algorithms used by the
5678 backend.
5679 This parameter is ignored when @option{-funit-at-a-time} is not used.
5680 The default value is 2700.
5681
5682 @item large-function-growth
5683 Specifies maximal growth of large function caused by inlining in percents.
5684 This parameter is ignored when @option{-funit-at-a-time} is not used.
5685 The default value is 100 which limits large function growth to 2.0 times
5686 the original size.
5687
5688 @item inline-unit-growth
5689 Specifies maximal overall growth of the compilation unit caused by inlining.
5690 This parameter is ignored when @option{-funit-at-a-time} is not used.
5691 The default value is 50 which limits unit growth to 1.5 times the original
5692 size.
5693
5694 @item max-inline-insns-recursive
5695 @itemx max-inline-insns-recursive-auto
5696 Specifies maximum number of instructions out-of-line copy of self recursive inline
5697 function can grow into by performing recursive inlining.
5698
5699 For functions declared inline @option{--param max-inline-insns-recursive} is
5700 taken into acount.  For function not declared inline, recursive inlining
5701 happens only when @option{-finline-functions} (included in @option{-O3}) is
5702 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5703 default value is 450.
5704
5705 @item max-inline-recursive-depth
5706 @itemx max-inline-recursive-depth-auto
5707 Specifies maximum recursion depth used by the recursive inlining.
5708
5709 For functions declared inline @option{--param max-inline-recursive-depth} is
5710 taken into acount.  For function not declared inline, recursive inlining
5711 happens only when @option{-finline-functions} (included in @option{-O3}) is
5712 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5713 default value is 450.
5714
5715 @item inline-call-cost
5716 Specify cost of call instruction relative to simple arithmetics operations
5717 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5718 functions and at the same time increases size of leaf function that is believed to
5719 reduce function size by being inlined.  In effect it increases amount of
5720 inlining for code having large abstraction penalty (many functions that just
5721 pass the arguments to other functions) and decrease inlining for code with low
5722 abstraction penalty.  The default value is 16.
5723
5724 @item max-unrolled-insns
5725 The maximum number of instructions that a loop should have if that loop
5726 is unrolled, and if the loop is unrolled, it determines how many times
5727 the loop code is unrolled.
5728
5729 @item max-average-unrolled-insns
5730 The maximum number of instructions biased by probabilities of their execution
5731 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5732 it determines how many times the loop code is unrolled.
5733
5734 @item max-unroll-times
5735 The maximum number of unrollings of a single loop.
5736
5737 @item max-peeled-insns
5738 The maximum number of instructions that a loop should have if that loop
5739 is peeled, and if the loop is peeled, it determines how many times
5740 the loop code is peeled.
5741
5742 @item max-peel-times
5743 The maximum number of peelings of a single loop.
5744
5745 @item max-completely-peeled-insns
5746 The maximum number of insns of a completely peeled loop.
5747
5748 @item max-completely-peel-times
5749 The maximum number of iterations of a loop to be suitable for complete peeling.
5750
5751 @item max-unswitch-insns
5752 The maximum number of insns of an unswitched loop.
5753
5754 @item max-unswitch-level
5755 The maximum number of branches unswitched in a single loop.
5756
5757 @item lim-expensive
5758 The minimum cost of an expensive expression in the loop invariant motion.
5759
5760 @item iv-consider-all-candidates-bound
5761 Bound on number of candidates for induction variables below that
5762 all candidates are considered for each use in induction variable
5763 optimizations.  Only the most relevant candidates are considered
5764 if there are more candidates, to avoid quadratic time complexity.
5765
5766 @item iv-max-considered-uses
5767 The induction variable optimizations give up on loops that contain more
5768 induction variable uses.
5769
5770 @item iv-always-prune-cand-set-bound
5771 If number of candidates in the set is smaller than this value,
5772 we always try to remove unnecessary ivs from the set during its
5773 optimization when a new iv is added to the set.
5774
5775 @item scev-max-expr-size
5776 Bound on size of expressions used in the scalar evolutions analyzer.
5777 Large expressions slow the analyzer.
5778
5779 @item max-iterations-to-track
5780
5781 The maximum number of iterations of a loop the brute force algorithm
5782 for analysis of # of iterations of the loop tries to evaluate.
5783
5784 @item hot-bb-count-fraction
5785 Select fraction of the maximal count of repetitions of basic block in program
5786 given basic block needs to have to be considered hot.
5787
5788 @item hot-bb-frequency-fraction
5789 Select fraction of the maximal frequency of executions of basic block in
5790 function given basic block needs to have to be considered hot
5791
5792 @item tracer-dynamic-coverage
5793 @itemx tracer-dynamic-coverage-feedback
5794
5795 This value is used to limit superblock formation once the given percentage of
5796 executed instructions is covered.  This limits unnecessary code size
5797 expansion.
5798
5799 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5800 feedback is available.  The real profiles (as opposed to statically estimated
5801 ones) are much less balanced allowing the threshold to be larger value.
5802
5803 @item tracer-max-code-growth
5804 Stop tail duplication once code growth has reached given percentage.  This is
5805 rather hokey argument, as most of the duplicates will be eliminated later in
5806 cross jumping, so it may be set to much higher values than is the desired code
5807 growth.
5808
5809 @item tracer-min-branch-ratio
5810
5811 Stop reverse growth when the reverse probability of best edge is less than this
5812 threshold (in percent).
5813
5814 @item tracer-min-branch-ratio
5815 @itemx tracer-min-branch-ratio-feedback
5816
5817 Stop forward growth if the best edge do have probability lower than this
5818 threshold.
5819
5820 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5821 compilation for profile feedback and one for compilation without.  The value
5822 for compilation with profile feedback needs to be more conservative (higher) in
5823 order to make tracer effective.
5824
5825 @item max-cse-path-length
5826
5827 Maximum number of basic blocks on path that cse considers.  The default is 10.
5828
5829 @item global-var-threshold
5830
5831 Counts the number of function calls (@var{n}) and the number of
5832 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5833 single artificial variable will be created to represent all the
5834 call-clobbered variables at function call sites.  This artificial
5835 variable will then be made to alias every call-clobbered variable.
5836 (done as @code{int * size_t} on the host machine; beware overflow).
5837
5838 @item max-aliased-vops
5839
5840 Maximum number of virtual operands allowed to represent aliases
5841 before triggering the alias grouping heuristic.  Alias grouping
5842 reduces compile times and memory consumption needed for aliasing at
5843 the expense of precision loss in alias information.
5844
5845 @item ggc-min-expand
5846
5847 GCC uses a garbage collector to manage its own memory allocation.  This
5848 parameter specifies the minimum percentage by which the garbage
5849 collector's heap should be allowed to expand between collections.
5850 Tuning this may improve compilation speed; it has no effect on code
5851 generation.
5852
5853 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5854 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5855 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5856 GCC is not able to calculate RAM on a particular platform, the lower
5857 bound of 30% is used.  Setting this parameter and
5858 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5859 every opportunity.  This is extremely slow, but can be useful for
5860 debugging.
5861
5862 @item ggc-min-heapsize
5863
5864 Minimum size of the garbage collector's heap before it begins bothering
5865 to collect garbage.  The first collection occurs after the heap expands
5866 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5867 tuning this may improve compilation speed, and has no effect on code
5868 generation.
5869
5870 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5871 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5872 with a lower bound of 4096 (four megabytes) and an upper bound of
5873 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5874 particular platform, the lower bound is used.  Setting this parameter
5875 very large effectively disables garbage collection.  Setting this
5876 parameter and @option{ggc-min-expand} to zero causes a full collection
5877 to occur at every opportunity.
5878
5879 @item max-reload-search-insns
5880 The maximum number of instruction reload should look backward for equivalent
5881 register.  Increasing values mean more aggressive optimization, making the
5882 compile time increase with probably slightly better performance.  The default
5883 value is 100.
5884
5885 @item max-cselib-memory-location
5886 The maximum number of memory locations cselib should take into acount.
5887 Increasing values mean more aggressive optimization, making the compile time
5888 increase with probably slightly better performance.  The default value is 500.
5889
5890 @item reorder-blocks-duplicate
5891 @itemx reorder-blocks-duplicate-feedback
5892
5893 Used by basic block reordering pass to decide whether to use unconditional
5894 branch or duplicate the code on its destination.  Code is duplicated when its
5895 estimated size is smaller than this value multiplied by the estimated size of
5896 unconditional jump in the hot spots of the program.
5897
5898 The @option{reorder-block-duplicate-feedback} is used only when profile
5899 feedback is available and may be set to higher values than
5900 @option{reorder-block-duplicate} since information about the hot spots is more
5901 accurate.
5902
5903 @item max-sched-region-blocks
5904 The maximum number of blocks in a region to be considered for
5905 interblock scheduling.  The default value is 10.
5906
5907 @item max-sched-region-insns
5908 The maximum number of insns in a region to be considered for
5909 interblock scheduling.  The default value is 100.
5910
5911 @item max-last-value-rtl
5912
5913 The maximum size measured as number of RTLs that can be recorded in an expression
5914 in combiner for a pseudo register as last known value of that register.  The default
5915 is 10000.
5916
5917 @item integer-share-limit
5918 Small integer constants can use a shared data structure, reducing the
5919 compiler's memory usage and increasing its speed.  This sets the maximum
5920 value of a shared integer constant's.  The default value is 256.
5921
5922 @item min-virtual-mappings
5923 Specifies the minimum number of virtual mappings in the incremental
5924 SSA updater that should be registered to trigger the virtual mappings
5925 heuristic defined by virtual-mappings-ratio.  The default value is
5926 100.
5927
5928 @item virtual-mappings-ratio
5929 If the number of virtual mappings is virtual-mappings-ratio bigger
5930 than the number of virtual symbols to be updated, then the incremental
5931 SSA updater switches to a full update for those symbols.  The default
5932 ratio is 3.
5933
5934 @end table
5935 @end table
5936
5937 @node Preprocessor Options
5938 @section Options Controlling the Preprocessor
5939 @cindex preprocessor options
5940 @cindex options, preprocessor
5941
5942 These options control the C preprocessor, which is run on each C source
5943 file before actual compilation.
5944
5945 If you use the @option{-E} option, nothing is done except preprocessing.
5946 Some of these options make sense only together with @option{-E} because
5947 they cause the preprocessor output to be unsuitable for actual
5948 compilation.
5949
5950 @table @gcctabopt
5951 @opindex Wp
5952 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5953 and pass @var{option} directly through to the preprocessor.  If
5954 @var{option} contains commas, it is split into multiple options at the
5955 commas.  However, many options are modified, translated or interpreted
5956 by the compiler driver before being passed to the preprocessor, and
5957 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5958 interface is undocumented and subject to change, so whenever possible
5959 you should avoid using @option{-Wp} and let the driver handle the
5960 options instead.
5961
5962 @item -Xpreprocessor @var{option}
5963 @opindex preprocessor
5964 Pass @var{option} as an option to the preprocessor.  You can use this to
5965 supply system-specific preprocessor options which GCC does not know how to
5966 recognize.
5967
5968 If you want to pass an option that takes an argument, you must use
5969 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5970 @end table
5971
5972 @include cppopts.texi
5973
5974 @node Assembler Options
5975 @section Passing Options to the Assembler
5976
5977 @c prevent bad page break with this line
5978 You can pass options to the assembler.
5979
5980 @table @gcctabopt
5981 @item -Wa,@var{option}
5982 @opindex Wa
5983 Pass @var{option} as an option to the assembler.  If @var{option}
5984 contains commas, it is split into multiple options at the commas.
5985
5986 @item -Xassembler @var{option}
5987 @opindex Xassembler
5988 Pass @var{option} as an option to the assembler.  You can use this to
5989 supply system-specific assembler options which GCC does not know how to
5990 recognize.
5991
5992 If you want to pass an option that takes an argument, you must use
5993 @option{-Xassembler} twice, once for the option and once for the argument.
5994
5995 @end table
5996
5997 @node Link Options
5998 @section Options for Linking
5999 @cindex link options
6000 @cindex options, linking
6001
6002 These options come into play when the compiler links object files into
6003 an executable output file.  They are meaningless if the compiler is
6004 not doing a link step.
6005
6006 @table @gcctabopt
6007 @cindex file names
6008 @item @var{object-file-name}
6009 A file name that does not end in a special recognized suffix is
6010 considered to name an object file or library.  (Object files are
6011 distinguished from libraries by the linker according to the file
6012 contents.)  If linking is done, these object files are used as input
6013 to the linker.
6014
6015 @item -c
6016 @itemx -S
6017 @itemx -E
6018 @opindex c
6019 @opindex S
6020 @opindex E
6021 If any of these options is used, then the linker is not run, and
6022 object file names should not be used as arguments.  @xref{Overall
6023 Options}.
6024
6025 @cindex Libraries
6026 @item -l@var{library}
6027 @itemx -l @var{library}
6028 @opindex l
6029 Search the library named @var{library} when linking.  (The second
6030 alternative with the library as a separate argument is only for
6031 POSIX compliance and is not recommended.)
6032
6033 It makes a difference where in the command you write this option; the
6034 linker searches and processes libraries and object files in the order they
6035 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6036 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6037 to functions in @samp{z}, those functions may not be loaded.
6038
6039 The linker searches a standard list of directories for the library,
6040 which is actually a file named @file{lib@var{library}.a}.  The linker
6041 then uses this file as if it had been specified precisely by name.
6042
6043 The directories searched include several standard system directories
6044 plus any that you specify with @option{-L}.
6045
6046 Normally the files found this way are library files---archive files
6047 whose members are object files.  The linker handles an archive file by
6048 scanning through it for members which define symbols that have so far
6049 been referenced but not defined.  But if the file that is found is an
6050 ordinary object file, it is linked in the usual fashion.  The only
6051 difference between using an @option{-l} option and specifying a file name
6052 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6053 and searches several directories.
6054
6055 @item -lobjc
6056 @opindex lobjc
6057 You need this special case of the @option{-l} option in order to
6058 link an Objective-C or Objective-C++ program.
6059
6060 @item -nostartfiles
6061 @opindex nostartfiles
6062 Do not use the standard system startup files when linking.
6063 The standard system libraries are used normally, unless @option{-nostdlib}
6064 or @option{-nodefaultlibs} is used.
6065
6066 @item -nodefaultlibs
6067 @opindex nodefaultlibs
6068 Do not use the standard system libraries when linking.
6069 Only the libraries you specify will be passed to the linker.
6070 The standard startup files are used normally, unless @option{-nostartfiles}
6071 is used.  The compiler may generate calls to @code{memcmp},
6072 @code{memset}, @code{memcpy} and @code{memmove}.
6073 These entries are usually resolved by entries in
6074 libc.  These entry points should be supplied through some other
6075 mechanism when this option is specified.
6076
6077 @item -nostdlib
6078 @opindex nostdlib
6079 Do not use the standard system startup files or libraries when linking.
6080 No startup files and only the libraries you specify will be passed to
6081 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6082 @code{memcpy} and @code{memmove}.
6083 These entries are usually resolved by entries in
6084 libc.  These entry points should be supplied through some other
6085 mechanism when this option is specified.
6086
6087 @cindex @option{-lgcc}, use with @option{-nostdlib}
6088 @cindex @option{-nostdlib} and unresolved references
6089 @cindex unresolved references and @option{-nostdlib}
6090 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6091 @cindex @option{-nodefaultlibs} and unresolved references
6092 @cindex unresolved references and @option{-nodefaultlibs}
6093 One of the standard libraries bypassed by @option{-nostdlib} and
6094 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6095 that GCC uses to overcome shortcomings of particular machines, or special
6096 needs for some languages.
6097 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6098 Collection (GCC) Internals},
6099 for more discussion of @file{libgcc.a}.)
6100 In most cases, you need @file{libgcc.a} even when you want to avoid
6101 other standard libraries.  In other words, when you specify @option{-nostdlib}
6102 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6103 This ensures that you have no unresolved references to internal GCC
6104 library subroutines.  (For example, @samp{__main}, used to ensure C++
6105 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6106 GNU Compiler Collection (GCC) Internals}.)
6107
6108 @item -pie
6109 @opindex pie
6110 Produce a position independent executable on targets which support it.
6111 For predictable results, you must also specify the same set of options
6112 that were used to generate code (@option{-fpie}, @option{-fPIE},
6113 or model suboptions) when you specify this option.
6114
6115 @item -s
6116 @opindex s
6117 Remove all symbol table and relocation information from the executable.
6118
6119 @item -static
6120 @opindex static
6121 On systems that support dynamic linking, this prevents linking with the shared
6122 libraries.  On other systems, this option has no effect.
6123
6124 @item -shared
6125 @opindex shared
6126 Produce a shared object which can then be linked with other objects to
6127 form an executable.  Not all systems support this option.  For predictable
6128 results, you must also specify the same set of options that were used to
6129 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6130 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6131 needs to build supplementary stub code for constructors to work.  On
6132 multi-libbed systems, @samp{gcc -shared} must select the correct support
6133 libraries to link against.  Failing to supply the correct flags may lead
6134 to subtle defects.  Supplying them in cases where they are not necessary
6135 is innocuous.}
6136
6137 @item -shared-libgcc
6138 @itemx -static-libgcc
6139 @opindex shared-libgcc
6140 @opindex static-libgcc
6141 On systems that provide @file{libgcc} as a shared library, these options
6142 force the use of either the shared or static version respectively.
6143 If no shared version of @file{libgcc} was built when the compiler was
6144 configured, these options have no effect.
6145
6146 There are several situations in which an application should use the
6147 shared @file{libgcc} instead of the static version.  The most common
6148 of these is when the application wishes to throw and catch exceptions
6149 across different shared libraries.  In that case, each of the libraries
6150 as well as the application itself should use the shared @file{libgcc}.
6151
6152 Therefore, the G++ and GCJ drivers automatically add
6153 @option{-shared-libgcc} whenever you build a shared library or a main
6154 executable, because C++ and Java programs typically use exceptions, so
6155 this is the right thing to do.
6156
6157 If, instead, you use the GCC driver to create shared libraries, you may
6158 find that they will not always be linked with the shared @file{libgcc}.
6159 If GCC finds, at its configuration time, that you have a non-GNU linker
6160 or a GNU linker that does not support option @option{--eh-frame-hdr},
6161 it will link the shared version of @file{libgcc} into shared libraries
6162 by default.  Otherwise, it will take advantage of the linker and optimize
6163 away the linking with the shared version of @file{libgcc}, linking with
6164 the static version of libgcc by default.  This allows exceptions to
6165 propagate through such shared libraries, without incurring relocation
6166 costs at library load time.
6167
6168 However, if a library or main executable is supposed to throw or catch
6169 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6170 for the languages used in the program, or using the option
6171 @option{-shared-libgcc}, such that it is linked with the shared
6172 @file{libgcc}.
6173
6174 @item -symbolic
6175 @opindex symbolic
6176 Bind references to global symbols when building a shared object.  Warn
6177 about any unresolved references (unless overridden by the link editor
6178 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6179 this option.
6180
6181 @item -Xlinker @var{option}
6182 @opindex Xlinker
6183 Pass @var{option} as an option to the linker.  You can use this to
6184 supply system-specific linker options which GCC does not know how to
6185 recognize.
6186
6187 If you want to pass an option that takes an argument, you must use
6188 @option{-Xlinker} twice, once for the option and once for the argument.
6189 For example, to pass @option{-assert definitions}, you must write
6190 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6191 @option{-Xlinker "-assert definitions"}, because this passes the entire
6192 string as a single argument, which is not what the linker expects.
6193
6194 @item -Wl,@var{option}
6195 @opindex Wl
6196 Pass @var{option} as an option to the linker.  If @var{option} contains
6197 commas, it is split into multiple options at the commas.
6198
6199 @item -u @var{symbol}
6200 @opindex u
6201 Pretend the symbol @var{symbol} is undefined, to force linking of
6202 library modules to define it.  You can use @option{-u} multiple times with
6203 different symbols to force loading of additional library modules.
6204 @end table
6205
6206 @node Directory Options
6207 @section Options for Directory Search
6208 @cindex directory options
6209 @cindex options, directory search
6210 @cindex search path
6211
6212 These options specify directories to search for header files, for
6213 libraries and for parts of the compiler:
6214
6215 @table @gcctabopt
6216 @item -I@var{dir}
6217 @opindex I
6218 Add the directory @var{dir} to the head of the list of directories to be
6219 searched for header files.  This can be used to override a system header
6220 file, substituting your own version, since these directories are
6221 searched before the system header file directories.  However, you should
6222 not use this option to add directories that contain vendor-supplied
6223 system header files (use @option{-isystem} for that).  If you use more than
6224 one @option{-I} option, the directories are scanned in left-to-right
6225 order; the standard system directories come after.
6226
6227 If a standard system include directory, or a directory specified with
6228 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6229 option will be ignored.  The directory will still be searched but as a
6230 system directory at its normal position in the system include chain.
6231 This is to ensure that GCC's procedure to fix buggy system headers and
6232 the ordering for the include_next directive are not inadvertently changed.
6233 If you really need to change the search order for system directories,
6234 use the @option{-nostdinc} and/or @option{-isystem} options.
6235
6236 @item -iquote@var{dir}
6237 @opindex iquote
6238 Add the directory @var{dir} to the head of the list of directories to
6239 be searched for header files only for the case of @samp{#include
6240 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6241 otherwise just like @option{-I}.
6242
6243 @item -L@var{dir}
6244 @opindex L
6245 Add directory @var{dir} to the list of directories to be searched
6246 for @option{-l}.
6247
6248 @item -B@var{prefix}
6249 @opindex B
6250 This option specifies where to find the executables, libraries,
6251 include files, and data files of the compiler itself.
6252
6253 The compiler driver program runs one or more of the subprograms
6254 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6255 @var{prefix} as a prefix for each program it tries to run, both with and
6256 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6257
6258 For each subprogram to be run, the compiler driver first tries the
6259 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6260 was not specified, the driver tries two standard prefixes, which are
6261 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6262 those results in a file name that is found, the unmodified program
6263 name is searched for using the directories specified in your
6264 @env{PATH} environment variable.
6265
6266 The compiler will check to see if the path provided by the @option{-B}
6267 refers to a directory, and if necessary it will add a directory
6268 separator character at the end of the path.
6269
6270 @option{-B} prefixes that effectively specify directory names also apply
6271 to libraries in the linker, because the compiler translates these
6272 options into @option{-L} options for the linker.  They also apply to
6273 includes files in the preprocessor, because the compiler translates these
6274 options into @option{-isystem} options for the preprocessor.  In this case,
6275 the compiler appends @samp{include} to the prefix.
6276
6277 The run-time support file @file{libgcc.a} can also be searched for using
6278 the @option{-B} prefix, if needed.  If it is not found there, the two
6279 standard prefixes above are tried, and that is all.  The file is left
6280 out of the link if it is not found by those means.
6281
6282 Another way to specify a prefix much like the @option{-B} prefix is to use
6283 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6284 Variables}.
6285
6286 As a special kludge, if the path provided by @option{-B} is
6287 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6288 9, then it will be replaced by @file{[dir/]include}.  This is to help
6289 with boot-strapping the compiler.
6290
6291 @item -specs=@var{file}
6292 @opindex specs
6293 Process @var{file} after the compiler reads in the standard @file{specs}
6294 file, in order to override the defaults that the @file{gcc} driver
6295 program uses when determining what switches to pass to @file{cc1},
6296 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6297 @option{-specs=@var{file}} can be specified on the command line, and they
6298 are processed in order, from left to right.
6299
6300 @item -I-
6301 @opindex I-
6302 This option has been deprecated.  Please use @option{-iquote} instead for
6303 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6304 Any directories you specify with @option{-I} options before the @option{-I-}
6305 option are searched only for the case of @samp{#include "@var{file}"};
6306 they are not searched for @samp{#include <@var{file}>}.
6307
6308 If additional directories are specified with @option{-I} options after
6309 the @option{-I-}, these directories are searched for all @samp{#include}
6310 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6311 this way.)
6312
6313 In addition, the @option{-I-} option inhibits the use of the current
6314 directory (where the current input file came from) as the first search
6315 directory for @samp{#include "@var{file}"}.  There is no way to
6316 override this effect of @option{-I-}.  With @option{-I.} you can specify
6317 searching the directory which was current when the compiler was
6318 invoked.  That is not exactly the same as what the preprocessor does
6319 by default, but it is often satisfactory.
6320
6321 @option{-I-} does not inhibit the use of the standard system directories
6322 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6323 independent.
6324 @end table
6325
6326 @c man end
6327
6328 @node Spec Files
6329 @section Specifying subprocesses and the switches to pass to them
6330 @cindex Spec Files
6331
6332 @command{gcc} is a driver program.  It performs its job by invoking a
6333 sequence of other programs to do the work of compiling, assembling and
6334 linking.  GCC interprets its command-line parameters and uses these to
6335 deduce which programs it should invoke, and which command-line options
6336 it ought to place on their command lines.  This behavior is controlled
6337 by @dfn{spec strings}.  In most cases there is one spec string for each
6338 program that GCC can invoke, but a few programs have multiple spec
6339 strings to control their behavior.  The spec strings built into GCC can
6340 be overridden by using the @option{-specs=} command-line switch to specify
6341 a spec file.
6342
6343 @dfn{Spec files} are plaintext files that are used to construct spec
6344 strings.  They consist of a sequence of directives separated by blank
6345 lines.  The type of directive is determined by the first non-whitespace
6346 character on the line and it can be one of the following:
6347
6348 @table @code
6349 @item %@var{command}
6350 Issues a @var{command} to the spec file processor.  The commands that can
6351 appear here are:
6352
6353 @table @code
6354 @item %include <@var{file}>
6355 @cindex %include
6356 Search for @var{file} and insert its text at the current point in the
6357 specs file.
6358
6359 @item %include_noerr <@var{file}>
6360 @cindex %include_noerr
6361 Just like @samp{%include}, but do not generate an error message if the include
6362 file cannot be found.
6363
6364 @item %rename @var{old_name} @var{new_name}
6365 @cindex %rename
6366 Rename the spec string @var{old_name} to @var{new_name}.
6367
6368 @end table
6369
6370 @item *[@var{spec_name}]:
6371 This tells the compiler to create, override or delete the named spec
6372 string.  All lines after this directive up to the next directive or
6373 blank line are considered to be the text for the spec string.  If this
6374 results in an empty string then the spec will be deleted.  (Or, if the
6375 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6376 does not currently exist a new spec will be created.  If the spec does
6377 exist then its contents will be overridden by the text of this
6378 directive, unless the first character of that text is the @samp{+}
6379 character, in which case the text will be appended to the spec.
6380
6381 @item [@var{suffix}]:
6382 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6383 and up to the next directive or blank line are considered to make up the
6384 spec string for the indicated suffix.  When the compiler encounters an
6385 input file with the named suffix, it will processes the spec string in
6386 order to work out how to compile that file.  For example:
6387
6388 @smallexample
6389 .ZZ:
6390 z-compile -input %i
6391 @end smallexample
6392
6393 This says that any input file whose name ends in @samp{.ZZ} should be
6394 passed to the program @samp{z-compile}, which should be invoked with the
6395 command-line switch @option{-input} and with the result of performing the
6396 @samp{%i} substitution.  (See below.)
6397
6398 As an alternative to providing a spec string, the text that follows a
6399 suffix directive can be one of the following:
6400
6401 @table @code
6402 @item @@@var{language}
6403 This says that the suffix is an alias for a known @var{language}.  This is
6404 similar to using the @option{-x} command-line switch to GCC to specify a
6405 language explicitly.  For example:
6406
6407 @smallexample
6408 .ZZ:
6409 @@c++
6410 @end smallexample
6411
6412 Says that .ZZ files are, in fact, C++ source files.
6413
6414 @item #@var{name}
6415 This causes an error messages saying:
6416
6417 @smallexample
6418 @var{name} compiler not installed on this system.
6419 @end smallexample
6420 @end table
6421
6422 GCC already has an extensive list of suffixes built into it.
6423 This directive will add an entry to the end of the list of suffixes, but
6424 since the list is searched from the end backwards, it is effectively
6425 possible to override earlier entries using this technique.
6426
6427 @end table
6428
6429 GCC has the following spec strings built into it.  Spec files can
6430 override these strings or create their own.  Note that individual
6431 targets can also add their own spec strings to this list.
6432
6433 @smallexample
6434 asm          Options to pass to the assembler
6435 asm_final    Options to pass to the assembler post-processor
6436 cpp          Options to pass to the C preprocessor
6437 cc1          Options to pass to the C compiler
6438 cc1plus      Options to pass to the C++ compiler
6439 endfile      Object files to include at the end of the link
6440 link         Options to pass to the linker
6441 lib          Libraries to include on the command line to the linker
6442 libgcc       Decides which GCC support library to pass to the linker
6443 linker       Sets the name of the linker
6444 predefines   Defines to be passed to the C preprocessor
6445 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6446              by default
6447 startfile    Object files to include at the start of the link
6448 @end smallexample
6449
6450 Here is a small example of a spec file:
6451
6452 @smallexample
6453 %rename lib                 old_lib
6454
6455 *lib:
6456 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6457 @end smallexample
6458
6459 This example renames the spec called @samp{lib} to @samp{old_lib} and
6460 then overrides the previous definition of @samp{lib} with a new one.
6461 The new definition adds in some extra command-line options before
6462 including the text of the old definition.
6463
6464 @dfn{Spec strings} are a list of command-line options to be passed to their
6465 corresponding program.  In addition, the spec strings can contain
6466 @samp{%}-prefixed sequences to substitute variable text or to
6467 conditionally insert text into the command line.  Using these constructs
6468 it is possible to generate quite complex command lines.
6469
6470 Here is a table of all defined @samp{%}-sequences for spec
6471 strings.  Note that spaces are not generated automatically around the
6472 results of expanding these sequences.  Therefore you can concatenate them
6473 together or combine them with constant text in a single argument.
6474
6475 @table @code
6476 @item %%
6477 Substitute one @samp{%} into the program name or argument.
6478
6479 @item %i
6480 Substitute the name of the input file being processed.
6481
6482 @item %b
6483 Substitute the basename of the input file being processed.
6484 This is the substring up to (and not including) the last period
6485 and not including the directory.
6486
6487 @item %B
6488 This is the same as @samp{%b}, but include the file suffix (text after
6489 the last period).
6490
6491 @item %d
6492 Marks the argument containing or following the @samp{%d} as a
6493 temporary file name, so that that file will be deleted if GCC exits
6494 successfully.  Unlike @samp{%g}, this contributes no text to the
6495 argument.
6496
6497 @item %g@var{suffix}
6498 Substitute a file name that has suffix @var{suffix} and is chosen
6499 once per compilation, and mark the argument in the same way as
6500 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6501 name is now chosen in a way that is hard to predict even when previously
6502 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6503 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6504 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6505 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6506 was simply substituted with a file name chosen once per compilation,
6507 without regard to any appended suffix (which was therefore treated
6508 just like ordinary text), making such attacks more likely to succeed.
6509
6510 @item %u@var{suffix}
6511 Like @samp{%g}, but generates a new temporary file name even if
6512 @samp{%u@var{suffix}} was already seen.
6513
6514 @item %U@var{suffix}
6515 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6516 new one if there is no such last file name.  In the absence of any
6517 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6518 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6519 would involve the generation of two distinct file names, one
6520 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6521 simply substituted with a file name chosen for the previous @samp{%u},
6522 without regard to any appended suffix.
6523
6524 @item %j@var{suffix}
6525 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6526 writable, and if save-temps is off; otherwise, substitute the name
6527 of a temporary file, just like @samp{%u}.  This temporary file is not
6528 meant for communication between processes, but rather as a junk
6529 disposal mechanism.
6530
6531 @item %|@var{suffix}
6532 @itemx %m@var{suffix}
6533 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6534 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6535 all.  These are the two most common ways to instruct a program that it
6536 should read from standard input or write to standard output.  If you
6537 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6538 construct: see for example @file{f/lang-specs.h}.
6539
6540 @item %.@var{SUFFIX}
6541 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6542 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6543 terminated by the next space or %.
6544
6545 @item %w
6546 Marks the argument containing or following the @samp{%w} as the
6547 designated output file of this compilation.  This puts the argument
6548 into the sequence of arguments that @samp{%o} will substitute later.
6549
6550 @item %o
6551 Substitutes the names of all the output files, with spaces
6552 automatically placed around them.  You should write spaces
6553 around the @samp{%o} as well or the results are undefined.
6554 @samp{%o} is for use in the specs for running the linker.
6555 Input files whose names have no recognized suffix are not compiled
6556 at all, but they are included among the output files, so they will
6557 be linked.
6558
6559 @item %O
6560 Substitutes the suffix for object files.  Note that this is
6561 handled specially when it immediately follows @samp{%g, %u, or %U},
6562 because of the need for those to form complete file names.  The
6563 handling is such that @samp{%O} is treated exactly as if it had already
6564 been substituted, except that @samp{%g, %u, and %U} do not currently
6565 support additional @var{suffix} characters following @samp{%O} as they would
6566 following, for example, @samp{.o}.
6567
6568 @item %p
6569 Substitutes the standard macro predefinitions for the
6570 current target machine.  Use this when running @code{cpp}.
6571
6572 @item %P
6573 Like @samp{%p}, but puts @samp{__} before and after the name of each
6574 predefined macro, except for macros that start with @samp{__} or with
6575 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6576 C@.
6577
6578 @item %I
6579 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6580 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6581 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6582 as necessary.
6583
6584 @item %s
6585 Current argument is the name of a library or startup file of some sort.
6586 Search for that file in a standard list of directories and substitute
6587 the full name found.
6588
6589 @item %e@var{str}
6590 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6591 Use this when inconsistent options are detected.
6592
6593 @item %(@var{name})
6594 Substitute the contents of spec string @var{name} at this point.
6595
6596 @item %[@var{name}]
6597 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6598
6599 @item %x@{@var{option}@}
6600 Accumulate an option for @samp{%X}.
6601
6602 @item %X
6603 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6604 spec string.
6605
6606 @item %Y
6607 Output the accumulated assembler options specified by @option{-Wa}.
6608
6609 @item %Z
6610 Output the accumulated preprocessor options specified by @option{-Wp}.
6611
6612 @item %a
6613 Process the @code{asm} spec.  This is used to compute the
6614 switches to be passed to the assembler.
6615
6616 @item %A
6617 Process the @code{asm_final} spec.  This is a spec string for
6618 passing switches to an assembler post-processor, if such a program is
6619 needed.
6620
6621 @item %l
6622 Process the @code{link} spec.  This is the spec for computing the
6623 command line passed to the linker.  Typically it will make use of the
6624 @samp{%L %G %S %D and %E} sequences.
6625
6626 @item %D
6627 Dump out a @option{-L} option for each directory that GCC believes might
6628 contain startup files.  If the target supports multilibs then the
6629 current multilib directory will be prepended to each of these paths.
6630
6631 @item %L
6632 Process the @code{lib} spec.  This is a spec string for deciding which
6633 libraries should be included on the command line to the linker.
6634
6635 @item %G
6636 Process the @code{libgcc} spec.  This is a spec string for deciding
6637 which GCC support library should be included on the command line to the linker.
6638
6639 @item %S
6640 Process the @code{startfile} spec.  This is a spec for deciding which
6641 object files should be the first ones passed to the linker.  Typically
6642 this might be a file named @file{crt0.o}.
6643
6644 @item %E
6645 Process the @code{endfile} spec.  This is a spec string that specifies
6646 the last object files that will be passed to the linker.
6647
6648 @item %C
6649 Process the @code{cpp} spec.  This is used to construct the arguments
6650 to be passed to the C preprocessor.
6651
6652 @item %1
6653 Process the @code{cc1} spec.  This is used to construct the options to be
6654 passed to the actual C compiler (@samp{cc1}).
6655
6656 @item %2
6657 Process the @code{cc1plus} spec.  This is used to construct the options to be
6658 passed to the actual C++ compiler (@samp{cc1plus}).
6659
6660 @item %*
6661 Substitute the variable part of a matched option.  See below.
6662 Note that each comma in the substituted string is replaced by
6663 a single space.
6664
6665 @item %<@code{S}
6666 Remove all occurrences of @code{-S} from the command line.  Note---this
6667 command is position dependent.  @samp{%} commands in the spec string
6668 before this one will see @code{-S}, @samp{%} commands in the spec string
6669 after this one will not.
6670
6671 @item %:@var{function}(@var{args})
6672 Call the named function @var{function}, passing it @var{args}.
6673 @var{args} is first processed as a nested spec string, then split
6674 into an argument vector in the usual fashion.  The function returns
6675 a string which is processed as if it had appeared literally as part
6676 of the current spec.
6677
6678 The following built-in spec functions are provided:
6679
6680 @table @code
6681 @item @code{if-exists}
6682 The @code{if-exists} spec function takes one argument, an absolute
6683 pathname to a file.  If the file exists, @code{if-exists} returns the
6684 pathname.  Here is a small example of its usage:
6685
6686 @smallexample
6687 *startfile:
6688 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6689 @end smallexample
6690
6691 @item @code{if-exists-else}
6692 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6693 spec function, except that it takes two arguments.  The first argument is
6694 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6695 returns the pathname.  If it does not exist, it returns the second argument.
6696 This way, @code{if-exists-else} can be used to select one file or another,
6697 based on the existence of the first.  Here is a small example of its usage:
6698
6699 @smallexample
6700 *startfile:
6701 crt0%O%s %:if-exists(crti%O%s) \
6702 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6703 @end smallexample
6704
6705 @item @code{replace-outfile}
6706 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6707 first argument in the outfiles array and replaces it with the second argument.  Here
6708 is a small example of its usage:
6709
6710 @smallexample
6711 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6712 @end smallexample
6713
6714 @end table
6715
6716 @item %@{@code{S}@}
6717 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6718 If that switch was not specified, this substitutes nothing.  Note that
6719 the leading dash is omitted when specifying this option, and it is
6720 automatically inserted if the substitution is performed.  Thus the spec
6721 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6722 and would output the command line option @option{-foo}.
6723
6724 @item %W@{@code{S}@}
6725 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6726 deleted on failure.
6727
6728 @item %@{@code{S}*@}
6729 Substitutes all the switches specified to GCC whose names start
6730 with @code{-S}, but which also take an argument.  This is used for
6731 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6732 GCC considers @option{-o foo} as being
6733 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6734 text, including the space.  Thus two arguments would be generated.
6735
6736 @item %@{@code{S}*&@code{T}*@}
6737 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6738 (the order of @code{S} and @code{T} in the spec is not significant).
6739 There can be any number of ampersand-separated variables; for each the
6740 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6741
6742 @item %@{@code{S}:@code{X}@}
6743 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6744
6745 @item %@{!@code{S}:@code{X}@}
6746 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6747
6748 @item %@{@code{S}*:@code{X}@}
6749 Substitutes @code{X} if one or more switches whose names start with
6750 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6751 once, no matter how many such switches appeared.  However, if @code{%*}
6752 appears somewhere in @code{X}, then @code{X} will be substituted once
6753 for each matching switch, with the @code{%*} replaced by the part of
6754 that switch that matched the @code{*}.
6755
6756 @item %@{.@code{S}:@code{X}@}
6757 Substitutes @code{X}, if processing a file with suffix @code{S}.
6758
6759 @item %@{!.@code{S}:@code{X}@}
6760 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6761
6762 @item %@{@code{S}|@code{P}:@code{X}@}
6763 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6764 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6765 although they have a stronger binding than the @samp{|}.  If @code{%*}
6766 appears in @code{X}, all of the alternatives must be starred, and only
6767 the first matching alternative is substituted.
6768
6769 For example, a spec string like this:
6770
6771 @smallexample
6772 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6773 @end smallexample
6774
6775 will output the following command-line options from the following input
6776 command-line options:
6777
6778 @smallexample
6779 fred.c        -foo -baz
6780 jim.d         -bar -boggle
6781 -d fred.c     -foo -baz -boggle
6782 -d jim.d      -bar -baz -boggle
6783 @end smallexample
6784
6785 @item %@{S:X; T:Y; :D@}
6786
6787 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6788 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6789 be as many clauses as you need.  This may be combined with @code{.},
6790 @code{!}, @code{|}, and @code{*} as needed.
6791
6792
6793 @end table
6794
6795 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6796 construct may contain other nested @samp{%} constructs or spaces, or
6797 even newlines.  They are processed as usual, as described above.
6798 Trailing white space in @code{X} is ignored.  White space may also
6799 appear anywhere on the left side of the colon in these constructs,
6800 except between @code{.} or @code{*} and the corresponding word.
6801
6802 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6803 handled specifically in these constructs.  If another value of
6804 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6805 @option{-W} switch is found later in the command line, the earlier
6806 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6807 just one letter, which passes all matching options.
6808
6809 The character @samp{|} at the beginning of the predicate text is used to
6810 indicate that a command should be piped to the following command, but
6811 only if @option{-pipe} is specified.
6812
6813 It is built into GCC which switches take arguments and which do not.
6814 (You might think it would be useful to generalize this to allow each
6815 compiler's spec to say which switches take arguments.  But this cannot
6816 be done in a consistent fashion.  GCC cannot even decide which input
6817 files have been specified without knowing which switches take arguments,
6818 and it must know which input files to compile in order to tell which
6819 compilers to run).
6820
6821 GCC also knows implicitly that arguments starting in @option{-l} are to be
6822 treated as compiler output files, and passed to the linker in their
6823 proper position among the other output files.
6824
6825 @c man begin OPTIONS
6826
6827 @node Target Options
6828 @section Specifying Target Machine and Compiler Version
6829 @cindex target options
6830 @cindex cross compiling
6831 @cindex specifying machine version
6832 @cindex specifying compiler version and target machine
6833 @cindex compiler version, specifying
6834 @cindex target machine, specifying
6835
6836 The usual way to run GCC is to run the executable called @file{gcc}, or
6837 @file{<machine>-gcc} when cross-compiling, or
6838 @file{<machine>-gcc-<version>} to run a version other than the one that
6839 was installed last.  Sometimes this is inconvenient, so GCC provides
6840 options that will switch to another cross-compiler or version.
6841
6842 @table @gcctabopt
6843 @item -b @var{machine}
6844 @opindex b
6845 The argument @var{machine} specifies the target machine for compilation.
6846
6847 The value to use for @var{machine} is the same as was specified as the
6848 machine type when configuring GCC as a cross-compiler.  For
6849 example, if a cross-compiler was configured with @samp{configure
6850 i386v}, meaning to compile for an 80386 running System V, then you
6851 would specify @option{-b i386v} to run that cross compiler.
6852
6853 @item -V @var{version}
6854 @opindex V
6855 The argument @var{version} specifies which version of GCC to run.
6856 This is useful when multiple versions are installed.  For example,
6857 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6858 @end table
6859
6860 The @option{-V} and @option{-b} options work by running the
6861 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6862 use them if you can just run that directly.
6863
6864 @node Submodel Options
6865 @section Hardware Models and Configurations
6866 @cindex submodel options
6867 @cindex specifying hardware config
6868 @cindex hardware models and configurations, specifying
6869 @cindex machine dependent options
6870
6871 Earlier we discussed the standard option @option{-b} which chooses among
6872 different installed compilers for completely different target
6873 machines, such as VAX vs.@: 68000 vs.@: 80386.
6874
6875 In addition, each of these target machine types can have its own
6876 special options, starting with @samp{-m}, to choose among various
6877 hardware models or configurations---for example, 68010 vs 68020,
6878 floating coprocessor or none.  A single installed version of the
6879 compiler can compile for any model or configuration, according to the
6880 options specified.
6881
6882 Some configurations of the compiler also support additional special
6883 options, usually for compatibility with other compilers on the same
6884 platform.
6885
6886 These options are defined by the macro @code{TARGET_SWITCHES} in the
6887 machine description.  The default for the options is also defined by
6888 that macro, which enables you to change the defaults.
6889
6890 @c This list is ordered alphanumerically by subsection name.
6891 @c It should be the same order and spelling as these options are listed
6892 @c in Machine Dependent Options
6893
6894 @menu
6895 * ARC Options::
6896 * ARM Options::
6897 * AVR Options::
6898 * Blackfin Options::
6899 * CRIS Options::
6900 * Darwin Options::
6901 * DEC Alpha Options::
6902 * DEC Alpha/VMS Options::
6903 * FRV Options::
6904 * H8/300 Options::
6905 * HPPA Options::
6906 * i386 and x86-64 Options::
6907 * IA-64 Options::
6908 * M32R/D Options::
6909 * M680x0 Options::
6910 * M68hc1x Options::
6911 * MCore Options::
6912 * MIPS Options::
6913 * MMIX Options::
6914 * MN10300 Options::
6915 * NS32K Options::
6916 * PDP-11 Options::
6917 * PowerPC Options::
6918 * RS/6000 and PowerPC Options::
6919 * S/390 and zSeries Options::
6920 * SH Options::
6921 * SPARC Options::
6922 * System V Options::
6923 * TMS320C3x/C4x Options::
6924 * V850 Options::
6925 * VAX Options::
6926 * x86-64 Options::
6927 * Xstormy16 Options::
6928 * Xtensa Options::
6929 * zSeries Options::
6930 @end menu
6931
6932 @node ARC Options
6933 @subsection ARC Options
6934 @cindex ARC Options
6935
6936 These options are defined for ARC implementations:
6937
6938 @table @gcctabopt
6939 @item -EL
6940 @opindex EL
6941 Compile code for little endian mode.  This is the default.
6942
6943 @item -EB
6944 @opindex EB
6945 Compile code for big endian mode.
6946
6947 @item -mmangle-cpu
6948 @opindex mmangle-cpu
6949 Prepend the name of the cpu to all public symbol names.
6950 In multiple-processor systems, there are many ARC variants with different
6951 instruction and register set characteristics.  This flag prevents code
6952 compiled for one cpu to be linked with code compiled for another.
6953 No facility exists for handling variants that are ``almost identical''.
6954 This is an all or nothing option.
6955
6956 @item -mcpu=@var{cpu}
6957 @opindex mcpu
6958 Compile code for ARC variant @var{cpu}.
6959 Which variants are supported depend on the configuration.
6960 All variants support @option{-mcpu=base}, this is the default.
6961
6962 @item -mtext=@var{text-section}
6963 @itemx -mdata=@var{data-section}
6964 @itemx -mrodata=@var{readonly-data-section}
6965 @opindex mtext
6966 @opindex mdata
6967 @opindex mrodata
6968 Put functions, data, and readonly data in @var{text-section},
6969 @var{data-section}, and @var{readonly-data-section} respectively
6970 by default.  This can be overridden with the @code{section} attribute.
6971 @xref{Variable Attributes}.
6972
6973 @end table
6974
6975 @node ARM Options
6976 @subsection ARM Options
6977 @cindex ARM options
6978
6979 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6980 architectures:
6981
6982 @table @gcctabopt
6983 @item -mabi=@var{name}
6984 @opindex mabi
6985 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6986 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6987
6988 @item -mapcs-frame
6989 @opindex mapcs-frame
6990 Generate a stack frame that is compliant with the ARM Procedure Call
6991 Standard for all functions, even if this is not strictly necessary for
6992 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6993 with this option will cause the stack frames not to be generated for
6994 leaf functions.  The default is @option{-mno-apcs-frame}.
6995
6996 @item -mapcs
6997 @opindex mapcs
6998 This is a synonym for @option{-mapcs-frame}.
6999
7000 @ignore
7001 @c not currently implemented
7002 @item -mapcs-stack-check
7003 @opindex mapcs-stack-check
7004 Generate code to check the amount of stack space available upon entry to
7005 every function (that actually uses some stack space).  If there is
7006 insufficient space available then either the function
7007 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7008 called, depending upon the amount of stack space required.  The run time
7009 system is required to provide these functions.  The default is
7010 @option{-mno-apcs-stack-check}, since this produces smaller code.
7011
7012 @c not currently implemented
7013 @item -mapcs-float
7014 @opindex mapcs-float
7015 Pass floating point arguments using the float point registers.  This is
7016 one of the variants of the APCS@.  This option is recommended if the
7017 target hardware has a floating point unit or if a lot of floating point
7018 arithmetic is going to be performed by the code.  The default is
7019 @option{-mno-apcs-float}, since integer only code is slightly increased in
7020 size if @option{-mapcs-float} is used.
7021
7022 @c not currently implemented
7023 @item -mapcs-reentrant
7024 @opindex mapcs-reentrant
7025 Generate reentrant, position independent code.  The default is
7026 @option{-mno-apcs-reentrant}.
7027 @end ignore
7028
7029 @item -mthumb-interwork
7030 @opindex mthumb-interwork
7031 Generate code which supports calling between the ARM and Thumb
7032 instruction sets.  Without this option the two instruction sets cannot
7033 be reliably used inside one program.  The default is
7034 @option{-mno-thumb-interwork}, since slightly larger code is generated
7035 when @option{-mthumb-interwork} is specified.
7036
7037 @item -mno-sched-prolog
7038 @opindex mno-sched-prolog
7039 Prevent the reordering of instructions in the function prolog, or the
7040 merging of those instruction with the instructions in the function's
7041 body.  This means that all functions will start with a recognizable set
7042 of instructions (or in fact one of a choice from a small set of
7043 different function prologues), and this information can be used to
7044 locate the start if functions inside an executable piece of code.  The
7045 default is @option{-msched-prolog}.
7046
7047 @item -mhard-float
7048 @opindex mhard-float
7049 Generate output containing floating point instructions.  This is the
7050 default.
7051
7052 @item -msoft-float
7053 @opindex msoft-float
7054 Generate output containing library calls for floating point.
7055 @strong{Warning:} the requisite libraries are not available for all ARM
7056 targets.  Normally the facilities of the machine's usual C compiler are
7057 used, but this cannot be done directly in cross-compilation.  You must make
7058 your own arrangements to provide suitable library functions for
7059 cross-compilation.
7060
7061 @option{-msoft-float} changes the calling convention in the output file;
7062 therefore, it is only useful if you compile @emph{all} of a program with
7063 this option.  In particular, you need to compile @file{libgcc.a}, the
7064 library that comes with GCC, with @option{-msoft-float} in order for
7065 this to work.
7066
7067 @item -mfloat-abi=@var{name}
7068 @opindex mfloat-abi
7069 Specifies which ABI to use for floating point values.  Permissible values
7070 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7071
7072 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7073 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7074 of floating point instructions, but still uses the soft-float calling
7075 conventions.
7076
7077 @item -mlittle-endian
7078 @opindex mlittle-endian
7079 Generate code for a processor running in little-endian mode.  This is
7080 the default for all standard configurations.
7081
7082 @item -mbig-endian
7083 @opindex mbig-endian
7084 Generate code for a processor running in big-endian mode; the default is
7085 to compile code for a little-endian processor.
7086
7087 @item -mwords-little-endian
7088 @opindex mwords-little-endian
7089 This option only applies when generating code for big-endian processors.
7090 Generate code for a little-endian word order but a big-endian byte
7091 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7092 option should only be used if you require compatibility with code for
7093 big-endian ARM processors generated by versions of the compiler prior to
7094 2.8.
7095
7096 @item -mcpu=@var{name}
7097 @opindex mcpu
7098 This specifies the name of the target ARM processor.  GCC uses this name
7099 to determine what kind of instructions it can emit when generating
7100 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7101 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7102 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7103 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7104 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7105 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7106 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7107 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7108 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7109 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7110 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7111 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7112 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7113 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7114 @samp{ep9312}.
7115
7116 @itemx -mtune=@var{name}
7117 @opindex mtune
7118 This option is very similar to the @option{-mcpu=} option, except that
7119 instead of specifying the actual target processor type, and hence
7120 restricting which instructions can be used, it specifies that GCC should
7121 tune the performance of the code as if the target were of the type
7122 specified in this option, but still choosing the instructions that it
7123 will generate based on the cpu specified by a @option{-mcpu=} option.
7124 For some ARM implementations better performance can be obtained by using
7125 this option.
7126
7127 @item -march=@var{name}
7128 @opindex march
7129 This specifies the name of the target ARM architecture.  GCC uses this
7130 name to determine what kind of instructions it can emit when generating
7131 assembly code.  This option can be used in conjunction with or instead
7132 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7133 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7134 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7135 @samp{iwmmxt}, @samp{ep9312}.
7136
7137 @item -mfpu=@var{name}
7138 @itemx -mfpe=@var{number}
7139 @itemx -mfp=@var{number}
7140 @opindex mfpu
7141 @opindex mfpe
7142 @opindex mfp
7143 This specifies what floating point hardware (or hardware emulation) is
7144 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7145 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7146 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7147 with older versions of GCC@.
7148
7149 If @option{-msoft-float} is specified this specifies the format of
7150 floating point values.
7151
7152 @item -mstructure-size-boundary=@var{n}
7153 @opindex mstructure-size-boundary
7154 The size of all structures and unions will be rounded up to a multiple
7155 of the number of bits set by this option.  Permissible values are 8, 32
7156 and 64.  The default value varies for different toolchains.  For the COFF
7157 targeted toolchain the default value is 8.  A value of 64 is only allowed
7158 if the underlying ABI supports it.
7159
7160 Specifying the larger number can produce faster, more efficient code, but
7161 can also increase the size of the program.  Different values are potentially
7162 incompatible.  Code compiled with one value cannot necessarily expect to
7163 work with code or libraries compiled with another value, if they exchange
7164 information using structures or unions.
7165
7166 @item -mabort-on-noreturn
7167 @opindex mabort-on-noreturn
7168 Generate a call to the function @code{abort} at the end of a
7169 @code{noreturn} function.  It will be executed if the function tries to
7170 return.
7171
7172 @item -mlong-calls
7173 @itemx -mno-long-calls
7174 @opindex mlong-calls
7175 @opindex mno-long-calls
7176 Tells the compiler to perform function calls by first loading the
7177 address of the function into a register and then performing a subroutine
7178 call on this register.  This switch is needed if the target function
7179 will lie outside of the 64 megabyte addressing range of the offset based
7180 version of subroutine call instruction.
7181
7182 Even if this switch is enabled, not all function calls will be turned
7183 into long calls.  The heuristic is that static functions, functions
7184 which have the @samp{short-call} attribute, functions that are inside
7185 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7186 definitions have already been compiled within the current compilation
7187 unit, will not be turned into long calls.  The exception to this rule is
7188 that weak function definitions, functions with the @samp{long-call}
7189 attribute or the @samp{section} attribute, and functions that are within
7190 the scope of a @samp{#pragma long_calls} directive, will always be
7191 turned into long calls.
7192
7193 This feature is not enabled by default.  Specifying
7194 @option{-mno-long-calls} will restore the default behavior, as will
7195 placing the function calls within the scope of a @samp{#pragma
7196 long_calls_off} directive.  Note these switches have no effect on how
7197 the compiler generates code to handle function calls via function
7198 pointers.
7199
7200 @item -mnop-fun-dllimport
7201 @opindex mnop-fun-dllimport
7202 Disable support for the @code{dllimport} attribute.
7203
7204 @item -msingle-pic-base
7205 @opindex msingle-pic-base
7206 Treat the register used for PIC addressing as read-only, rather than
7207 loading it in the prologue for each function.  The run-time system is
7208 responsible for initializing this register with an appropriate value
7209 before execution begins.
7210
7211 @item -mpic-register=@var{reg}
7212 @opindex mpic-register
7213 Specify the register to be used for PIC addressing.  The default is R10
7214 unless stack-checking is enabled, when R9 is used.
7215
7216 @item -mcirrus-fix-invalid-insns
7217 @opindex mcirrus-fix-invalid-insns
7218 @opindex mno-cirrus-fix-invalid-insns
7219 Insert NOPs into the instruction stream to in order to work around
7220 problems with invalid Maverick instruction combinations.  This option
7221 is only valid if the @option{-mcpu=ep9312} option has been used to
7222 enable generation of instructions for the Cirrus Maverick floating
7223 point co-processor.  This option is not enabled by default, since the
7224 problem is only present in older Maverick implementations.  The default
7225 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7226 switch.
7227
7228 @item -mpoke-function-name
7229 @opindex mpoke-function-name
7230 Write the name of each function into the text section, directly
7231 preceding the function prologue.  The generated code is similar to this:
7232
7233 @smallexample
7234      t0
7235          .ascii "arm_poke_function_name", 0
7236          .align
7237      t1
7238          .word 0xff000000 + (t1 - t0)
7239      arm_poke_function_name
7240          mov     ip, sp
7241          stmfd   sp!, @{fp, ip, lr, pc@}
7242          sub     fp, ip, #4
7243 @end smallexample
7244
7245 When performing a stack backtrace, code can inspect the value of
7246 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7247 location @code{pc - 12} and the top 8 bits are set, then we know that
7248 there is a function name embedded immediately preceding this location
7249 and has length @code{((pc[-3]) & 0xff000000)}.
7250
7251 @item -mthumb
7252 @opindex mthumb
7253 Generate code for the 16-bit Thumb instruction set.  The default is to
7254 use the 32-bit ARM instruction set.
7255
7256 @item -mtpcs-frame
7257 @opindex mtpcs-frame
7258 Generate a stack frame that is compliant with the Thumb Procedure Call
7259 Standard for all non-leaf functions.  (A leaf function is one that does
7260 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7261
7262 @item -mtpcs-leaf-frame
7263 @opindex mtpcs-leaf-frame
7264 Generate a stack frame that is compliant with the Thumb Procedure Call
7265 Standard for all leaf functions.  (A leaf function is one that does
7266 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7267
7268 @item -mcallee-super-interworking
7269 @opindex mcallee-super-interworking
7270 Gives all externally visible functions in the file being compiled an ARM
7271 instruction set header which switches to Thumb mode before executing the
7272 rest of the function.  This allows these functions to be called from
7273 non-interworking code.
7274
7275 @item -mcaller-super-interworking
7276 @opindex mcaller-super-interworking
7277 Allows calls via function pointers (including virtual functions) to
7278 execute correctly regardless of whether the target code has been
7279 compiled for interworking or not.  There is a small overhead in the cost
7280 of executing a function pointer if this option is enabled.
7281
7282 @end table
7283
7284 @node AVR Options
7285 @subsection AVR Options
7286 @cindex AVR Options
7287
7288 These options are defined for AVR implementations:
7289
7290 @table @gcctabopt
7291 @item -mmcu=@var{mcu}
7292 @opindex mmcu
7293 Specify ATMEL AVR instruction set or MCU type.
7294
7295 Instruction set avr1 is for the minimal AVR core, not supported by the C
7296 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7297 attiny11, attiny12, attiny15, attiny28).
7298
7299 Instruction set avr2 (default) is for the classic AVR core with up to
7300 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7301 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7302 at90c8534, at90s8535).
7303
7304 Instruction set avr3 is for the classic AVR core with up to 128K program
7305 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7306
7307 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7308 memory space (MCU types: atmega8, atmega83, atmega85).
7309
7310 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7311 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7312 atmega64, atmega128, at43usb355, at94k).
7313
7314 @item -msize
7315 @opindex msize
7316 Output instruction sizes to the asm file.
7317
7318 @item -minit-stack=@var{N}
7319 @opindex minit-stack
7320 Specify the initial stack address, which may be a symbol or numeric value,
7321 @samp{__stack} is the default.
7322
7323 @item -mno-interrupts
7324 @opindex mno-interrupts
7325 Generated code is not compatible with hardware interrupts.
7326 Code size will be smaller.
7327
7328 @item -mcall-prologues
7329 @opindex mcall-prologues
7330 Functions prologues/epilogues expanded as call to appropriate
7331 subroutines.  Code size will be smaller.
7332
7333 @item -mno-tablejump
7334 @opindex mno-tablejump
7335 Do not generate tablejump insns which sometimes increase code size.
7336
7337 @item -mtiny-stack
7338 @opindex mtiny-stack
7339 Change only the low 8 bits of the stack pointer.
7340
7341 @item -mint8
7342 @opindex mint8
7343 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7344 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7345 and long long will be 4 bytes.  Please note that this option does not
7346 comply to the C standards, but it will provide you with smaller code
7347 size.
7348 @end table
7349
7350 @node Blackfin Options
7351 @subsection Blackfin Options
7352 @cindex Blackfin Options
7353
7354 @table @gcctabopt
7355 @item -momit-leaf-frame-pointer
7356 @opindex momit-leaf-frame-pointer
7357 Don't keep the frame pointer in a register for leaf functions.  This
7358 avoids the instructions to save, set up and restore frame pointers and
7359 makes an extra register available in leaf functions.  The option
7360 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7361 which might make debugging harder.
7362
7363 @item -mcsync
7364 @opindex mcsync
7365 When enabled, the compiler will ensure that the generated code does not
7366 contain speculative loads after jump instructions.  This option is enabled
7367 by default.
7368
7369 @item -mno-csync
7370 @opindex mno-csync
7371 Don't generate extra code to prevent speculative loads from occurring.
7372
7373 @item -mlow-64k
7374 @opindex mlow-64k
7375 When enabled, the compiler is free to take advantage of the knowledge that
7376 the entire program fits into the low 64k of memory.
7377
7378 @item -mno-low-64k
7379 @opindex mno-low-64k
7380 Assume that the program is arbitrarily large.  This is the default.
7381
7382 @item -mid-shared-library
7383 @opindex mid-shared-library
7384 Generate code that supports shared libraries via the library ID method.
7385 This allows for execute in place and shared libraries in an environment
7386 without virtual memory management.  This option implies @option{-fPIC}.
7387
7388 @item -mno-id-shared-library
7389 @opindex mno-id-shared-library
7390 Generate code that doesn't assume ID based shared libraries are being used.
7391 This is the default.
7392
7393 @item -mshared-library-id=n
7394 @opindex mshared-library-id
7395 Specified the identification number of the ID based shared library being
7396 compiled.  Specifying a value of 0 will generate more compact code, specifying
7397 other values will force the allocation of that number to the current
7398 library but is no more space or time efficient than omitting this option.
7399 @end table
7400
7401 @node CRIS Options
7402 @subsection CRIS Options
7403 @cindex CRIS Options
7404
7405 These options are defined specifically for the CRIS ports.
7406
7407 @table @gcctabopt
7408 @item -march=@var{architecture-type}
7409 @itemx -mcpu=@var{architecture-type}
7410 @opindex march
7411 @opindex mcpu
7412 Generate code for the specified architecture.  The choices for
7413 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7414 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7415 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7416 @samp{v10}.
7417
7418 @item -mtune=@var{architecture-type}
7419 @opindex mtune
7420 Tune to @var{architecture-type} everything applicable about the generated
7421 code, except for the ABI and the set of available instructions.  The
7422 choices for @var{architecture-type} are the same as for
7423 @option{-march=@var{architecture-type}}.
7424
7425 @item -mmax-stack-frame=@var{n}
7426 @opindex mmax-stack-frame
7427 Warn when the stack frame of a function exceeds @var{n} bytes.
7428
7429 @item -melinux-stacksize=@var{n}
7430 @opindex melinux-stacksize
7431 Only available with the @samp{cris-axis-aout} target.  Arranges for
7432 indications in the program to the kernel loader that the stack of the
7433 program should be set to @var{n} bytes.
7434
7435 @item -metrax4
7436 @itemx -metrax100
7437 @opindex metrax4
7438 @opindex metrax100
7439 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7440 @option{-march=v3} and @option{-march=v8} respectively.
7441
7442 @item -mmul-bug-workaround
7443 @itemx -mno-mul-bug-workaround
7444 @opindex mmul-bug-workaround
7445 @opindex mno-mul-bug-workaround
7446 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7447 models where it applies.  This option is active by default.
7448
7449 @item -mpdebug
7450 @opindex mpdebug
7451 Enable CRIS-specific verbose debug-related information in the assembly
7452 code.  This option also has the effect to turn off the @samp{#NO_APP}
7453 formatted-code indicator to the assembler at the beginning of the
7454 assembly file.
7455
7456 @item -mcc-init
7457 @opindex mcc-init
7458 Do not use condition-code results from previous instruction; always emit
7459 compare and test instructions before use of condition codes.
7460
7461 @item -mno-side-effects
7462 @opindex mno-side-effects
7463 Do not emit instructions with side-effects in addressing modes other than
7464 post-increment.
7465
7466 @item -mstack-align
7467 @itemx -mno-stack-align
7468 @itemx -mdata-align
7469 @itemx -mno-data-align
7470 @itemx -mconst-align
7471 @itemx -mno-const-align
7472 @opindex mstack-align
7473 @opindex mno-stack-align
7474 @opindex mdata-align
7475 @opindex mno-data-align
7476 @opindex mconst-align
7477 @opindex mno-const-align
7478 These options (no-options) arranges (eliminate arrangements) for the
7479 stack-frame, individual data and constants to be aligned for the maximum
7480 single data access size for the chosen CPU model.  The default is to
7481 arrange for 32-bit alignment.  ABI details such as structure layout are
7482 not affected by these options.
7483
7484 @item -m32-bit
7485 @itemx -m16-bit
7486 @itemx -m8-bit
7487 @opindex m32-bit
7488 @opindex m16-bit
7489 @opindex m8-bit
7490 Similar to the stack- data- and const-align options above, these options
7491 arrange for stack-frame, writable data and constants to all be 32-bit,
7492 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7493
7494 @item -mno-prologue-epilogue
7495 @itemx -mprologue-epilogue
7496 @opindex mno-prologue-epilogue
7497 @opindex mprologue-epilogue
7498 With @option{-mno-prologue-epilogue}, the normal function prologue and
7499 epilogue that sets up the stack-frame are omitted and no return
7500 instructions or return sequences are generated in the code.  Use this
7501 option only together with visual inspection of the compiled code: no
7502 warnings or errors are generated when call-saved registers must be saved,
7503 or storage for local variable needs to be allocated.
7504
7505 @item -mno-gotplt
7506 @itemx -mgotplt
7507 @opindex mno-gotplt
7508 @opindex mgotplt
7509 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7510 instruction sequences that load addresses for functions from the PLT part
7511 of the GOT rather than (traditional on other architectures) calls to the
7512 PLT@.  The default is @option{-mgotplt}.
7513
7514 @item -maout
7515 @opindex maout
7516 Legacy no-op option only recognized with the cris-axis-aout target.
7517
7518 @item -melf
7519 @opindex melf
7520 Legacy no-op option only recognized with the cris-axis-elf and
7521 cris-axis-linux-gnu targets.
7522
7523 @item -melinux
7524 @opindex melinux
7525 Only recognized with the cris-axis-aout target, where it selects a
7526 GNU/linux-like multilib, include files and instruction set for
7527 @option{-march=v8}.
7528
7529 @item -mlinux
7530 @opindex mlinux
7531 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7532
7533 @item -sim
7534 @opindex sim
7535 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7536 to link with input-output functions from a simulator library.  Code,
7537 initialized data and zero-initialized data are allocated consecutively.
7538
7539 @item -sim2
7540 @opindex sim2
7541 Like @option{-sim}, but pass linker options to locate initialized data at
7542 0x40000000 and zero-initialized data at 0x80000000.
7543 @end table
7544
7545 @node Darwin Options
7546 @subsection Darwin Options
7547 @cindex Darwin options
7548
7549 These options are defined for all architectures running the Darwin operating
7550 system.
7551
7552 FSF GCC on Darwin does not create ``fat'' object files; it will create
7553 an object file for the single architecture that it was built to
7554 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7555 @option{-arch} options are used; it does so by running the compiler or
7556 linker multiple times and joining the results together with
7557 @file{lipo}.
7558
7559 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7560 @samp{i686}) is determined by the flags that specify the ISA
7561 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7562 @option{-force_cpusubtype_ALL} option can be used to override this.
7563
7564 The Darwin tools vary in their behavior when presented with an ISA
7565 mismatch.  The assembler, @file{as}, will only permit instructions to
7566 be used that are valid for the subtype of the file it is generating,
7567 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7568 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7569 and print an error if asked to create a shared library with a less
7570 restrictive subtype than its input files (for instance, trying to put
7571 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7572 for executables, @file{ld}, will quietly give the executable the most
7573 restrictive subtype of any of its input files.
7574
7575 @table @gcctabopt
7576 @item -F@var{dir}
7577 @opindex F
7578 Add the framework directory @var{dir} to the head of the list of
7579 directories to be searched for header files.  These directories are
7580 interleaved with those specified by @option{-I} options and are
7581 scanned in a left-to-right order.
7582
7583 A framework directory is a directory with frameworks in it.  A
7584 framework is a directory with a @samp{"Headers"} and/or
7585 @samp{"PrivateHeaders"} directory contained directly in it that ends
7586 in @samp{".framework"}.  The name of a framework is the name of this
7587 directory excluding the @samp{".framework"}.  Headers associated with
7588 the framework are found in one of those two directories, with
7589 @samp{"Headers"} being searched first.  A subframework is a framework
7590 directory that is in a framework's @samp{"Frameworks"} directory.
7591 Includes of subframework headers can only appear in a header of a
7592 framework that contains the subframework, or in a sibling subframework
7593 header.  Two subframeworks are siblings if they occur in the same
7594 framework.  A subframework should not have the same name as a
7595 framework, a warning will be issued if this is violated.  Currently a
7596 subframework cannot have subframeworks, in the future, the mechanism
7597 may be extended to support this.  The standard frameworks can be found
7598 in @samp{"/System/Library/Frameworks"} and
7599 @samp{"/Library/Frameworks"}.  An example include looks like
7600 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7601 the name of the framework and header.h is found in the
7602 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7603
7604 @item -gused
7605 @opindex -gused
7606 Emit debugging information for symbols that are used.  For STABS
7607 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7608 This is by default ON@.
7609
7610 @item -gfull
7611 @opindex -gfull
7612 Emit debugging information for all symbols and types.
7613
7614 @item -mone-byte-bool
7615 @opindex -mone-byte-bool
7616 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7617 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7618 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7619 option has no effect on x86.
7620
7621 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7622 to generate code that is not binary compatible with code generated
7623 without that switch.  Using this switch may require recompiling all
7624 other modules in a program, including system libraries.  Use this
7625 switch to conform to a non-default data model.
7626
7627 @item -mfix-and-continue
7628 @itemx -ffix-and-continue
7629 @itemx -findirect-data
7630 @opindex mfix-and-continue
7631 @opindex ffix-and-continue
7632 @opindex findirect-data
7633 Generate code suitable for fast turn around development.  Needed to
7634 enable gdb to dynamically load @code{.o} files into already running
7635 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7636 are provided for backwards compatibility.
7637
7638 @item -all_load
7639 @opindex all_load
7640 Loads all members of static archive libraries.
7641 See man ld(1) for more information.
7642
7643 @item -arch_errors_fatal
7644 @opindex arch_errors_fatal
7645 Cause the errors having to do with files that have the wrong architecture
7646 to be fatal.
7647
7648 @item -bind_at_load
7649 @opindex bind_at_load
7650 Causes the output file to be marked such that the dynamic linker will
7651 bind all undefined references when the file is loaded or launched.
7652
7653 @item -bundle
7654 @opindex bundle
7655 Produce a Mach-o bundle format file.
7656 See man ld(1) for more information.
7657
7658 @item -bundle_loader @var{executable}
7659 @opindex bundle_loader
7660 This option specifies the @var{executable} that will be loading the build
7661 output file being linked.  See man ld(1) for more information.
7662
7663 @item -dynamiclib
7664 @opindex -dynamiclib
7665 When passed this option, GCC will produce a dynamic library instead of
7666 an executable when linking, using the Darwin @file{libtool} command.
7667
7668 @item -force_cpusubtype_ALL
7669 @opindex -force_cpusubtype_ALL
7670 This causes GCC's output file to have the @var{ALL} subtype, instead of
7671 one controlled by the @option{-mcpu} or @option{-march} option.
7672
7673 @item -allowable_client  @var{client_name}
7674 @itemx -client_name
7675 @itemx -compatibility_version
7676 @itemx -current_version
7677 @itemx -dead_strip
7678 @itemx -dependency-file
7679 @itemx -dylib_file
7680 @itemx -dylinker_install_name
7681 @itemx -dynamic
7682 @itemx -exported_symbols_list
7683 @itemx -filelist
7684 @itemx -flat_namespace
7685 @itemx -force_flat_namespace
7686 @itemx -headerpad_max_install_names
7687 @itemx -image_base
7688 @itemx -init
7689 @itemx -install_name
7690 @itemx -keep_private_externs
7691 @itemx -multi_module
7692 @itemx -multiply_defined
7693 @itemx -multiply_defined_unused
7694 @itemx -noall_load
7695 @itemx -no_dead_strip_inits_and_terms
7696 @itemx -nofixprebinding
7697 @itemx -nomultidefs
7698 @itemx -noprebind
7699 @itemx -noseglinkedit
7700 @itemx -pagezero_size
7701 @itemx -prebind
7702 @itemx -prebind_all_twolevel_modules
7703 @itemx -private_bundle
7704 @itemx -read_only_relocs
7705 @itemx -sectalign
7706 @itemx -sectobjectsymbols
7707 @itemx -whyload
7708 @itemx -seg1addr
7709 @itemx -sectcreate
7710 @itemx -sectobjectsymbols
7711 @itemx -sectorder
7712 @itemx -segaddr
7713 @itemx -segs_read_only_addr
7714 @itemx -segs_read_write_addr
7715 @itemx -seg_addr_table
7716 @itemx -seg_addr_table_filename
7717 @itemx -seglinkedit
7718 @itemx -segprot
7719 @itemx -segs_read_only_addr
7720 @itemx -segs_read_write_addr
7721 @itemx -single_module
7722 @itemx -static
7723 @itemx -sub_library
7724 @itemx -sub_umbrella
7725 @itemx -twolevel_namespace
7726 @itemx -umbrella
7727 @itemx -undefined
7728 @itemx -unexported_symbols_list
7729 @itemx -weak_reference_mismatches
7730 @itemx -whatsloaded
7731
7732 @opindex allowable_client
7733 @opindex client_name
7734 @opindex compatibility_version
7735 @opindex current_version
7736 @opindex dead_strip
7737 @opindex dependency-file
7738 @opindex dylib_file
7739 @opindex dylinker_install_name
7740 @opindex dynamic
7741 @opindex exported_symbols_list
7742 @opindex filelist
7743 @opindex flat_namespace
7744 @opindex force_flat_namespace
7745 @opindex headerpad_max_install_names
7746 @opindex image_base
7747 @opindex init
7748 @opindex install_name
7749 @opindex keep_private_externs
7750 @opindex multi_module
7751 @opindex multiply_defined
7752 @opindex multiply_defined_unused
7753 @opindex noall_load
7754 @opindex no_dead_strip_inits_and_terms
7755 @opindex nofixprebinding
7756 @opindex nomultidefs
7757 @opindex noprebind
7758 @opindex noseglinkedit
7759 @opindex pagezero_size
7760 @opindex prebind
7761 @opindex prebind_all_twolevel_modules
7762 @opindex private_bundle
7763 @opindex read_only_relocs
7764 @opindex sectalign
7765 @opindex sectobjectsymbols
7766 @opindex whyload
7767 @opindex seg1addr
7768 @opindex sectcreate
7769 @opindex sectobjectsymbols
7770 @opindex sectorder
7771 @opindex segaddr
7772 @opindex segs_read_only_addr
7773 @opindex segs_read_write_addr
7774 @opindex seg_addr_table
7775 @opindex seg_addr_table_filename
7776 @opindex seglinkedit
7777 @opindex segprot
7778 @opindex segs_read_only_addr
7779 @opindex segs_read_write_addr
7780 @opindex single_module
7781 @opindex static
7782 @opindex sub_library
7783 @opindex sub_umbrella
7784 @opindex twolevel_namespace
7785 @opindex umbrella
7786 @opindex undefined
7787 @opindex unexported_symbols_list
7788 @opindex weak_reference_mismatches
7789 @opindex whatsloaded
7790
7791 These options are passed to the Darwin linker.  The Darwin linker man page
7792 describes them in detail.
7793 @end table
7794
7795 @node DEC Alpha Options
7796 @subsection DEC Alpha Options
7797
7798 These @samp{-m} options are defined for the DEC Alpha implementations:
7799
7800 @table @gcctabopt
7801 @item -mno-soft-float
7802 @itemx -msoft-float
7803 @opindex mno-soft-float
7804 @opindex msoft-float
7805 Use (do not use) the hardware floating-point instructions for
7806 floating-point operations.  When @option{-msoft-float} is specified,
7807 functions in @file{libgcc.a} will be used to perform floating-point
7808 operations.  Unless they are replaced by routines that emulate the
7809 floating-point operations, or compiled in such a way as to call such
7810 emulations routines, these routines will issue floating-point
7811 operations.   If you are compiling for an Alpha without floating-point
7812 operations, you must ensure that the library is built so as not to call
7813 them.
7814
7815 Note that Alpha implementations without floating-point operations are
7816 required to have floating-point registers.
7817
7818 @item -mfp-reg
7819 @itemx -mno-fp-regs
7820 @opindex mfp-reg
7821 @opindex mno-fp-regs
7822 Generate code that uses (does not use) the floating-point register set.
7823 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7824 register set is not used, floating point operands are passed in integer
7825 registers as if they were integers and floating-point results are passed
7826 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7827 so any function with a floating-point argument or return value called by code
7828 compiled with @option{-mno-fp-regs} must also be compiled with that
7829 option.
7830
7831 A typical use of this option is building a kernel that does not use,
7832 and hence need not save and restore, any floating-point registers.
7833
7834 @item -mieee
7835 @opindex mieee
7836 The Alpha architecture implements floating-point hardware optimized for
7837 maximum performance.  It is mostly compliant with the IEEE floating
7838 point standard.  However, for full compliance, software assistance is
7839 required.  This option generates code fully IEEE compliant code
7840 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7841 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7842 defined during compilation.  The resulting code is less efficient but is
7843 able to correctly support denormalized numbers and exceptional IEEE
7844 values such as not-a-number and plus/minus infinity.  Other Alpha
7845 compilers call this option @option{-ieee_with_no_inexact}.
7846
7847 @item -mieee-with-inexact
7848 @opindex mieee-with-inexact
7849 This is like @option{-mieee} except the generated code also maintains
7850 the IEEE @var{inexact-flag}.  Turning on this option causes the
7851 generated code to implement fully-compliant IEEE math.  In addition to
7852 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7853 macro.  On some Alpha implementations the resulting code may execute
7854 significantly slower than the code generated by default.  Since there is
7855 very little code that depends on the @var{inexact-flag}, you should
7856 normally not specify this option.  Other Alpha compilers call this
7857 option @option{-ieee_with_inexact}.
7858
7859 @item -mfp-trap-mode=@var{trap-mode}
7860 @opindex mfp-trap-mode
7861 This option controls what floating-point related traps are enabled.
7862 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7863 The trap mode can be set to one of four values:
7864
7865 @table @samp
7866 @item n
7867 This is the default (normal) setting.  The only traps that are enabled
7868 are the ones that cannot be disabled in software (e.g., division by zero
7869 trap).
7870
7871 @item u
7872 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7873 as well.
7874
7875 @item su
7876 Like @samp{su}, but the instructions are marked to be safe for software
7877 completion (see Alpha architecture manual for details).
7878
7879 @item sui
7880 Like @samp{su}, but inexact traps are enabled as well.
7881 @end table
7882
7883 @item -mfp-rounding-mode=@var{rounding-mode}
7884 @opindex mfp-rounding-mode
7885 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7886 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7887 of:
7888
7889 @table @samp
7890 @item n
7891 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7892 the nearest machine number or towards the even machine number in case
7893 of a tie.
7894
7895 @item m
7896 Round towards minus infinity.
7897
7898 @item c
7899 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7900
7901 @item d
7902 Dynamic rounding mode.  A field in the floating point control register
7903 (@var{fpcr}, see Alpha architecture reference manual) controls the
7904 rounding mode in effect.  The C library initializes this register for
7905 rounding towards plus infinity.  Thus, unless your program modifies the
7906 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7907 @end table
7908
7909 @item -mtrap-precision=@var{trap-precision}
7910 @opindex mtrap-precision
7911 In the Alpha architecture, floating point traps are imprecise.  This
7912 means without software assistance it is impossible to recover from a
7913 floating trap and program execution normally needs to be terminated.
7914 GCC can generate code that can assist operating system trap handlers
7915 in determining the exact location that caused a floating point trap.
7916 Depending on the requirements of an application, different levels of
7917 precisions can be selected:
7918
7919 @table @samp
7920 @item p
7921 Program precision.  This option is the default and means a trap handler
7922 can only identify which program caused a floating point exception.
7923
7924 @item f
7925 Function precision.  The trap handler can determine the function that
7926 caused a floating point exception.
7927
7928 @item i
7929 Instruction precision.  The trap handler can determine the exact
7930 instruction that caused a floating point exception.
7931 @end table
7932
7933 Other Alpha compilers provide the equivalent options called
7934 @option{-scope_safe} and @option{-resumption_safe}.
7935
7936 @item -mieee-conformant
7937 @opindex mieee-conformant
7938 This option marks the generated code as IEEE conformant.  You must not
7939 use this option unless you also specify @option{-mtrap-precision=i} and either
7940 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7941 is to emit the line @samp{.eflag 48} in the function prologue of the
7942 generated assembly file.  Under DEC Unix, this has the effect that
7943 IEEE-conformant math library routines will be linked in.
7944
7945 @item -mbuild-constants
7946 @opindex mbuild-constants
7947 Normally GCC examines a 32- or 64-bit integer constant to
7948 see if it can construct it from smaller constants in two or three
7949 instructions.  If it cannot, it will output the constant as a literal and
7950 generate code to load it from the data segment at runtime.
7951
7952 Use this option to require GCC to construct @emph{all} integer constants
7953 using code, even if it takes more instructions (the maximum is six).
7954
7955 You would typically use this option to build a shared library dynamic
7956 loader.  Itself a shared library, it must relocate itself in memory
7957 before it can find the variables and constants in its own data segment.
7958
7959 @item -malpha-as
7960 @itemx -mgas
7961 @opindex malpha-as
7962 @opindex mgas
7963 Select whether to generate code to be assembled by the vendor-supplied
7964 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7965
7966 @item -mbwx
7967 @itemx -mno-bwx
7968 @itemx -mcix
7969 @itemx -mno-cix
7970 @itemx -mfix
7971 @itemx -mno-fix
7972 @itemx -mmax
7973 @itemx -mno-max
7974 @opindex mbwx
7975 @opindex mno-bwx
7976 @opindex mcix
7977 @opindex mno-cix
7978 @opindex mfix
7979 @opindex mno-fix
7980 @opindex mmax
7981 @opindex mno-max
7982 Indicate whether GCC should generate code to use the optional BWX,
7983 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7984 sets supported by the CPU type specified via @option{-mcpu=} option or that
7985 of the CPU on which GCC was built if none was specified.
7986
7987 @item -mfloat-vax
7988 @itemx -mfloat-ieee
7989 @opindex mfloat-vax
7990 @opindex mfloat-ieee
7991 Generate code that uses (does not use) VAX F and G floating point
7992 arithmetic instead of IEEE single and double precision.
7993
7994 @item -mexplicit-relocs
7995 @itemx -mno-explicit-relocs
7996 @opindex mexplicit-relocs
7997 @opindex mno-explicit-relocs
7998 Older Alpha assemblers provided no way to generate symbol relocations
7999 except via assembler macros.  Use of these macros does not allow
8000 optimal instruction scheduling.  GNU binutils as of version 2.12
8001 supports a new syntax that allows the compiler to explicitly mark
8002 which relocations should apply to which instructions.  This option
8003 is mostly useful for debugging, as GCC detects the capabilities of
8004 the assembler when it is built and sets the default accordingly.
8005
8006 @item -msmall-data
8007 @itemx -mlarge-data
8008 @opindex msmall-data
8009 @opindex mlarge-data
8010 When @option{-mexplicit-relocs} is in effect, static data is
8011 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8012 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8013 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8014 16-bit relocations off of the @code{$gp} register.  This limits the
8015 size of the small data area to 64KB, but allows the variables to be
8016 directly accessed via a single instruction.
8017
8018 The default is @option{-mlarge-data}.  With this option the data area
8019 is limited to just below 2GB@.  Programs that require more than 2GB of
8020 data must use @code{malloc} or @code{mmap} to allocate the data in the
8021 heap instead of in the program's data segment.
8022
8023 When generating code for shared libraries, @option{-fpic} implies
8024 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8025
8026 @item -msmall-text
8027 @itemx -mlarge-text
8028 @opindex msmall-text
8029 @opindex mlarge-text
8030 When @option{-msmall-text} is used, the compiler assumes that the
8031 code of the entire program (or shared library) fits in 4MB, and is
8032 thus reachable with a branch instruction.  When @option{-msmall-data}
8033 is used, the compiler can assume that all local symbols share the
8034 same @code{$gp} value, and thus reduce the number of instructions
8035 required for a function call from 4 to 1.
8036
8037 The default is @option{-mlarge-text}.
8038
8039 @item -mcpu=@var{cpu_type}
8040 @opindex mcpu
8041 Set the instruction set and instruction scheduling parameters for
8042 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8043 style name or the corresponding chip number.  GCC supports scheduling
8044 parameters for the EV4, EV5 and EV6 family of processors and will
8045 choose the default values for the instruction set from the processor
8046 you specify.  If you do not specify a processor type, GCC will default
8047 to the processor on which the compiler was built.
8048
8049 Supported values for @var{cpu_type} are
8050
8051 @table @samp
8052 @item ev4
8053 @itemx ev45
8054 @itemx 21064
8055 Schedules as an EV4 and has no instruction set extensions.
8056
8057 @item ev5
8058 @itemx 21164
8059 Schedules as an EV5 and has no instruction set extensions.
8060
8061 @item ev56
8062 @itemx 21164a
8063 Schedules as an EV5 and supports the BWX extension.
8064
8065 @item pca56
8066 @itemx 21164pc
8067 @itemx 21164PC
8068 Schedules as an EV5 and supports the BWX and MAX extensions.
8069
8070 @item ev6
8071 @itemx 21264
8072 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8073
8074 @item ev67
8075 @itemx 21264a
8076 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8077 @end table
8078
8079 @item -mtune=@var{cpu_type}
8080 @opindex mtune
8081 Set only the instruction scheduling parameters for machine type
8082 @var{cpu_type}.  The instruction set is not changed.
8083
8084 @item -mmemory-latency=@var{time}
8085 @opindex mmemory-latency
8086 Sets the latency the scheduler should assume for typical memory
8087 references as seen by the application.  This number is highly
8088 dependent on the memory access patterns used by the application
8089 and the size of the external cache on the machine.
8090
8091 Valid options for @var{time} are
8092
8093 @table @samp
8094 @item @var{number}
8095 A decimal number representing clock cycles.
8096
8097 @item L1
8098 @itemx L2
8099 @itemx L3
8100 @itemx main
8101 The compiler contains estimates of the number of clock cycles for
8102 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8103 (also called Dcache, Scache, and Bcache), as well as to main memory.
8104 Note that L3 is only valid for EV5.
8105
8106 @end table
8107 @end table
8108
8109 @node DEC Alpha/VMS Options
8110 @subsection DEC Alpha/VMS Options
8111
8112 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8113
8114 @table @gcctabopt
8115 @item -mvms-return-codes
8116 @opindex mvms-return-codes
8117 Return VMS condition codes from main.  The default is to return POSIX
8118 style condition (e.g.@ error) codes.
8119 @end table
8120
8121 @node FRV Options
8122 @subsection FRV Options
8123 @cindex FRV Options
8124
8125 @table @gcctabopt
8126 @item -mgpr-32
8127 @opindex mgpr-32
8128
8129 Only use the first 32 general purpose registers.
8130
8131 @item -mgpr-64
8132 @opindex mgpr-64
8133
8134 Use all 64 general purpose registers.
8135
8136 @item -mfpr-32
8137 @opindex mfpr-32
8138
8139 Use only the first 32 floating point registers.
8140
8141 @item -mfpr-64
8142 @opindex mfpr-64
8143
8144 Use all 64 floating point registers
8145
8146 @item -mhard-float
8147 @opindex mhard-float
8148
8149 Use hardware instructions for floating point operations.
8150
8151 @item -msoft-float
8152 @opindex msoft-float
8153
8154 Use library routines for floating point operations.
8155
8156 @item -malloc-cc
8157 @opindex malloc-cc
8158
8159 Dynamically allocate condition code registers.
8160
8161 @item -mfixed-cc
8162 @opindex mfixed-cc
8163
8164 Do not try to dynamically allocate condition code registers, only
8165 use @code{icc0} and @code{fcc0}.
8166
8167 @item -mdword
8168 @opindex mdword
8169
8170 Change ABI to use double word insns.
8171
8172 @item -mno-dword
8173 @opindex mno-dword
8174
8175 Do not use double word instructions.
8176
8177 @item -mdouble
8178 @opindex mdouble
8179
8180 Use floating point double instructions.
8181
8182 @item -mno-double
8183 @opindex mno-double
8184
8185 Do not use floating point double instructions.
8186
8187 @item -mmedia
8188 @opindex mmedia
8189
8190 Use media instructions.
8191
8192 @item -mno-media
8193 @opindex mno-media
8194
8195 Do not use media instructions.
8196
8197 @item -mmuladd
8198 @opindex mmuladd
8199
8200 Use multiply and add/subtract instructions.
8201
8202 @item -mno-muladd
8203 @opindex mno-muladd
8204
8205 Do not use multiply and add/subtract instructions.
8206
8207 @item -mfdpic
8208 @opindex mfdpic
8209
8210 Select the FDPIC ABI, that uses function descriptors to represent
8211 pointers to functions.  Without any PIC/PIE-related options, it
8212 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8213 assumes GOT entries and small data are within a 12-bit range from the
8214 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8215 are computed with 32 bits.
8216
8217 @item -minline-plt
8218 @opindex minline-plt
8219
8220 Enable inlining of PLT entries in function calls to functions that are
8221 not known to bind locally.  It has no effect without @option{-mfdpic}.
8222 It's enabled by default if optimizing for speed and compiling for
8223 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8224 optimization option such as @option{-O3} or above is present in the
8225 command line.
8226
8227 @item -mTLS
8228 @opindex TLS
8229
8230 Assume a large TLS segment when generating thread-local code.
8231
8232 @item -mtls
8233 @opindex tls
8234
8235 Do not assume a large TLS segment when generating thread-local code.
8236
8237 @item -mgprel-ro
8238 @opindex mgprel-ro
8239
8240 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8241 that is known to be in read-only sections.  It's enabled by default,
8242 except for @option{-fpic} or @option{-fpie}: even though it may help
8243 make the global offset table smaller, it trades 1 instruction for 4.
8244 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8245 one of which may be shared by multiple symbols, and it avoids the need
8246 for a GOT entry for the referenced symbol, so it's more likely to be a
8247 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8248
8249 @item -multilib-library-pic
8250 @opindex multilib-library-pic
8251
8252 Link with the (library, not FD) pic libraries.  It's implied by
8253 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8254 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8255 it explicitly.
8256
8257 @item -mlinked-fp
8258 @opindex mlinked-fp
8259
8260 Follow the EABI requirement of always creating a frame pointer whenever
8261 a stack frame is allocated.  This option is enabled by default and can
8262 be disabled with @option{-mno-linked-fp}.
8263
8264 @item -mlong-calls
8265 @opindex mlong-calls
8266
8267 Use indirect addressing to call functions outside the current
8268 compilation unit.  This allows the functions to be placed anywhere
8269 within the 32-bit address space.
8270
8271 @item -malign-labels
8272 @opindex malign-labels
8273
8274 Try to align labels to an 8-byte boundary by inserting nops into the
8275 previous packet.  This option only has an effect when VLIW packing
8276 is enabled.  It doesn't create new packets; it merely adds nops to
8277 existing ones.
8278
8279 @item -mlibrary-pic
8280 @opindex mlibrary-pic
8281
8282 Generate position-independent EABI code.
8283
8284 @item -macc-4
8285 @opindex macc-4
8286
8287 Use only the first four media accumulator registers.
8288
8289 @item -macc-8
8290 @opindex macc-8
8291
8292 Use all eight media accumulator registers.
8293
8294 @item -mpack
8295 @opindex mpack
8296
8297 Pack VLIW instructions.
8298
8299 @item -mno-pack
8300 @opindex mno-pack
8301
8302 Do not pack VLIW instructions.
8303
8304 @item -mno-eflags
8305 @opindex mno-eflags
8306
8307 Do not mark ABI switches in e_flags.
8308
8309 @item -mcond-move
8310 @opindex mcond-move
8311
8312 Enable the use of conditional-move instructions (default).
8313
8314 This switch is mainly for debugging the compiler and will likely be removed
8315 in a future version.
8316
8317 @item -mno-cond-move
8318 @opindex mno-cond-move
8319
8320 Disable the use of conditional-move instructions.
8321
8322 This switch is mainly for debugging the compiler and will likely be removed
8323 in a future version.
8324
8325 @item -mscc
8326 @opindex mscc
8327
8328 Enable the use of conditional set instructions (default).
8329
8330 This switch is mainly for debugging the compiler and will likely be removed
8331 in a future version.
8332
8333 @item -mno-scc
8334 @opindex mno-scc
8335
8336 Disable the use of conditional set instructions.
8337
8338 This switch is mainly for debugging the compiler and will likely be removed
8339 in a future version.
8340
8341 @item -mcond-exec
8342 @opindex mcond-exec
8343
8344 Enable the use of conditional execution (default).
8345
8346 This switch is mainly for debugging the compiler and will likely be removed
8347 in a future version.
8348
8349 @item -mno-cond-exec
8350 @opindex mno-cond-exec
8351
8352 Disable the use of conditional execution.
8353
8354 This switch is mainly for debugging the compiler and will likely be removed
8355 in a future version.
8356
8357 @item -mvliw-branch
8358 @opindex mvliw-branch
8359
8360 Run a pass to pack branches into VLIW instructions (default).
8361
8362 This switch is mainly for debugging the compiler and will likely be removed
8363 in a future version.
8364
8365 @item -mno-vliw-branch
8366 @opindex mno-vliw-branch
8367
8368 Do not run a pass to pack branches into VLIW instructions.
8369
8370 This switch is mainly for debugging the compiler and will likely be removed
8371 in a future version.
8372
8373 @item -mmulti-cond-exec
8374 @opindex mmulti-cond-exec
8375
8376 Enable optimization of @code{&&} and @code{||} in conditional execution
8377 (default).
8378
8379 This switch is mainly for debugging the compiler and will likely be removed
8380 in a future version.
8381
8382 @item -mno-multi-cond-exec
8383 @opindex mno-multi-cond-exec
8384
8385 Disable optimization of @code{&&} and @code{||} in conditional execution.
8386
8387 This switch is mainly for debugging the compiler and will likely be removed
8388 in a future version.
8389
8390 @item -mnested-cond-exec
8391 @opindex mnested-cond-exec
8392
8393 Enable nested conditional execution optimizations (default).
8394
8395 This switch is mainly for debugging the compiler and will likely be removed
8396 in a future version.
8397
8398 @item -mno-nested-cond-exec
8399 @opindex mno-nested-cond-exec
8400
8401 Disable nested conditional execution optimizations.
8402
8403 This switch is mainly for debugging the compiler and will likely be removed
8404 in a future version.
8405
8406 @item -mtomcat-stats
8407 @opindex mtomcat-stats
8408
8409 Cause gas to print out tomcat statistics.
8410
8411 @item -mcpu=@var{cpu}
8412 @opindex mcpu
8413
8414 Select the processor type for which to generate code.  Possible values are
8415 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8416 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8417
8418 @end table
8419
8420 @node H8/300 Options
8421 @subsection H8/300 Options
8422
8423 These @samp{-m} options are defined for the H8/300 implementations:
8424
8425 @table @gcctabopt
8426 @item -mrelax
8427 @opindex mrelax
8428 Shorten some address references at link time, when possible; uses the
8429 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8430 ld, Using ld}, for a fuller description.
8431
8432 @item -mh
8433 @opindex mh
8434 Generate code for the H8/300H@.
8435
8436 @item -ms
8437 @opindex ms
8438 Generate code for the H8S@.
8439
8440 @item -mn
8441 @opindex mn
8442 Generate code for the H8S and H8/300H in the normal mode.  This switch
8443 must be used either with @option{-mh} or @option{-ms}.
8444
8445 @item -ms2600
8446 @opindex ms2600
8447 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8448
8449 @item -mint32
8450 @opindex mint32
8451 Make @code{int} data 32 bits by default.
8452
8453 @item -malign-300
8454 @opindex malign-300
8455 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8456 The default for the H8/300H and H8S is to align longs and floats on 4
8457 byte boundaries.
8458 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8459 This option has no effect on the H8/300.
8460 @end table
8461
8462 @node HPPA Options
8463 @subsection HPPA Options
8464 @cindex HPPA Options
8465
8466 These @samp{-m} options are defined for the HPPA family of computers:
8467
8468 @table @gcctabopt
8469 @item -march=@var{architecture-type}
8470 @opindex march
8471 Generate code for the specified architecture.  The choices for
8472 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8473 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8474 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8475 architecture option for your machine.  Code compiled for lower numbered
8476 architectures will run on higher numbered architectures, but not the
8477 other way around.
8478
8479 @item -mpa-risc-1-0
8480 @itemx -mpa-risc-1-1
8481 @itemx -mpa-risc-2-0
8482 @opindex mpa-risc-1-0
8483 @opindex mpa-risc-1-1
8484 @opindex mpa-risc-2-0
8485 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8486
8487 @item -mbig-switch
8488 @opindex mbig-switch
8489 Generate code suitable for big switch tables.  Use this option only if
8490 the assembler/linker complain about out of range branches within a switch
8491 table.
8492
8493 @item -mjump-in-delay
8494 @opindex mjump-in-delay
8495 Fill delay slots of function calls with unconditional jump instructions
8496 by modifying the return pointer for the function call to be the target
8497 of the conditional jump.
8498
8499 @item -mdisable-fpregs
8500 @opindex mdisable-fpregs
8501 Prevent floating point registers from being used in any manner.  This is
8502 necessary for compiling kernels which perform lazy context switching of
8503 floating point registers.  If you use this option and attempt to perform
8504 floating point operations, the compiler will abort.
8505
8506 @item -mdisable-indexing
8507 @opindex mdisable-indexing
8508 Prevent the compiler from using indexing address modes.  This avoids some
8509 rather obscure problems when compiling MIG generated code under MACH@.
8510
8511 @item -mno-space-regs
8512 @opindex mno-space-regs
8513 Generate code that assumes the target has no space registers.  This allows
8514 GCC to generate faster indirect calls and use unscaled index address modes.
8515
8516 Such code is suitable for level 0 PA systems and kernels.
8517
8518 @item -mfast-indirect-calls
8519 @opindex mfast-indirect-calls
8520 Generate code that assumes calls never cross space boundaries.  This
8521 allows GCC to emit code which performs faster indirect calls.
8522
8523 This option will not work in the presence of shared libraries or nested
8524 functions.
8525
8526 @item -mfixed-range=@var{register-range}
8527 @opindex mfixed-range
8528 Generate code treating the given register range as fixed registers.
8529 A fixed register is one that the register allocator can not use.  This is
8530 useful when compiling kernel code.  A register range is specified as
8531 two registers separated by a dash.  Multiple register ranges can be
8532 specified separated by a comma.
8533
8534 @item -mlong-load-store
8535 @opindex mlong-load-store
8536 Generate 3-instruction load and store sequences as sometimes required by
8537 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8538 the HP compilers.
8539
8540 @item -mportable-runtime
8541 @opindex mportable-runtime
8542 Use the portable calling conventions proposed by HP for ELF systems.
8543
8544 @item -mgas
8545 @opindex mgas
8546 Enable the use of assembler directives only GAS understands.
8547
8548 @item -mschedule=@var{cpu-type}
8549 @opindex mschedule
8550 Schedule code according to the constraints for the machine type
8551 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8552 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8553 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8554 proper scheduling option for your machine.  The default scheduling is
8555 @samp{8000}.
8556
8557 @item -mlinker-opt
8558 @opindex mlinker-opt
8559 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8560 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8561 linkers in which they give bogus error messages when linking some programs.
8562
8563 @item -msoft-float
8564 @opindex msoft-float
8565 Generate output containing library calls for floating point.
8566 @strong{Warning:} the requisite libraries are not available for all HPPA
8567 targets.  Normally the facilities of the machine's usual C compiler are
8568 used, but this cannot be done directly in cross-compilation.  You must make
8569 your own arrangements to provide suitable library functions for
8570 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8571 does provide software floating point support.
8572
8573 @option{-msoft-float} changes the calling convention in the output file;
8574 therefore, it is only useful if you compile @emph{all} of a program with
8575 this option.  In particular, you need to compile @file{libgcc.a}, the
8576 library that comes with GCC, with @option{-msoft-float} in order for
8577 this to work.
8578
8579 @item -msio
8580 @opindex msio
8581 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8582 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8583 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8584 options are available under HP-UX and HI-UX@.
8585
8586 @item -mgnu-ld
8587 @opindex gnu-ld
8588 Use GNU ld specific options.  This passes @option{-shared} to ld when
8589 building a shared library.  It is the default when GCC is configured,
8590 explicitly or implicitly, with the GNU linker.  This option does not
8591 have any affect on which ld is called, it only changes what parameters
8592 are passed to that ld.  The ld that is called is determined by the
8593 @option{--with-ld} configure option, GCC's program search path, and
8594 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8595 using @samp{which `gcc -print-prog-name=ld`}.
8596
8597 @item -mhp-ld
8598 @opindex hp-ld
8599 Use HP ld specific options.  This passes @option{-b} to ld when building
8600 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8601 links.  It is the default when GCC is configured, explicitly or
8602 implicitly, with the HP linker.  This option does not have any affect on
8603 which ld is called, it only changes what parameters are passed to that
8604 ld.  The ld that is called is determined by the @option{--with-ld}
8605 configure option, GCC's program search path, and finally by the user's
8606 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8607 `gcc -print-prog-name=ld`}.
8608
8609 @item -mlong-calls
8610 @opindex mno-long-calls
8611 Generate code that uses long call sequences.  This ensures that a call
8612 is always able to reach linker generated stubs.  The default is to generate
8613 long calls only when the distance from the call site to the beginning
8614 of the function or translation unit, as the case may be, exceeds a
8615 predefined limit set by the branch type being used.  The limits for
8616 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8617 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8618 240,000 bytes.
8619
8620 Distances are measured from the beginning of functions when using the
8621 @option{-ffunction-sections} option, or when using the @option{-mgas}
8622 and @option{-mno-portable-runtime} options together under HP-UX with
8623 the SOM linker.
8624
8625 It is normally not desirable to use this option as it will degrade
8626 performance.  However, it may be useful in large applications,
8627 particularly when partial linking is used to build the application.
8628
8629 The types of long calls used depends on the capabilities of the
8630 assembler and linker, and the type of code being generated.  The
8631 impact on systems that support long absolute calls, and long pic
8632 symbol-difference or pc-relative calls should be relatively small.
8633 However, an indirect call is used on 32-bit ELF systems in pic code
8634 and it is quite long.
8635
8636 @item -munix=@var{unix-std}
8637 @opindex march
8638 Generate compiler predefines and select a startfile for the specified
8639 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8640 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8641 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8642 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8643 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8644 and later.
8645
8646 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8647 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8648 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8649 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8650 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8651 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8652
8653 It is @emph{important} to note that this option changes the interfaces
8654 for various library routines.  It also affects the operational behavior
8655 of the C library.  Thus, @emph{extreme} care is needed in using this
8656 option.
8657
8658 Library code that is intended to operate with more than one UNIX
8659 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8660 as appropriate.  Most GNU software doesn't provide this capability.
8661
8662 @item -nolibdld
8663 @opindex nolibdld
8664 Suppress the generation of link options to search libdld.sl when the
8665 @option{-static} option is specified on HP-UX 10 and later.
8666
8667 @item -static
8668 @opindex static
8669 The HP-UX implementation of setlocale in libc has a dependency on
8670 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8671 when the @option{-static} option is specified, special link options
8672 are needed to resolve this dependency.
8673
8674 On HP-UX 10 and later, the GCC driver adds the necessary options to
8675 link with libdld.sl when the @option{-static} option is specified.
8676 This causes the resulting binary to be dynamic.  On the 64-bit port,
8677 the linkers generate dynamic binaries by default in any case.  The
8678 @option{-nolibdld} option can be used to prevent the GCC driver from
8679 adding these link options.
8680
8681 @item -threads
8682 @opindex threads
8683 Add support for multithreading with the @dfn{dce thread} library
8684 under HP-UX@.  This option sets flags for both the preprocessor and
8685 linker.
8686 @end table
8687
8688 @node i386 and x86-64 Options
8689 @subsection Intel 386 and AMD x86-64 Options
8690 @cindex i386 Options
8691 @cindex x86-64 Options
8692 @cindex Intel 386 Options
8693 @cindex AMD x86-64 Options
8694
8695 These @samp{-m} options are defined for the i386 and x86-64 family of
8696 computers:
8697
8698 @table @gcctabopt
8699 @item -mtune=@var{cpu-type}
8700 @opindex mtune
8701 Tune to @var{cpu-type} everything applicable about the generated code, except
8702 for the ABI and the set of available instructions.  The choices for
8703 @var{cpu-type} are:
8704 @table @emph
8705 @item i386
8706 Original Intel's i386 CPU@.
8707 @item i486
8708 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8709 @item i586, pentium
8710 Intel Pentium CPU with no MMX support.
8711 @item pentium-mmx
8712 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8713 @item i686, pentiumpro
8714 Intel PentiumPro CPU@.
8715 @item pentium2
8716 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8717 @item pentium3, pentium3m
8718 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8719 support.
8720 @item pentium-m
8721 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8722 support.  Used by Centrino notebooks.
8723 @item pentium4, pentium4m
8724 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8725 @item prescott
8726 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8727 set support.
8728 @item nocona
8729 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8730 SSE2 and SSE3 instruction set support.
8731 @item k6
8732 AMD K6 CPU with MMX instruction set support.
8733 @item k6-2, k6-3
8734 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8735 @item athlon, athlon-tbird
8736 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8737 support.
8738 @item athlon-4, athlon-xp, athlon-mp
8739 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8740 instruction set support.
8741 @item k8, opteron, athlon64, athlon-fx
8742 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8743 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8744 @item winchip-c6
8745 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8746 set support.
8747 @item winchip2
8748 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8749 instruction set support.
8750 @item c3
8751 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8752 implemented for this chip.)
8753 @item c3-2
8754 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8755 implemented for this chip.)
8756 @end table
8757
8758 While picking a specific @var{cpu-type} will schedule things appropriately
8759 for that particular chip, the compiler will not generate any code that
8760 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8761 being used.
8762
8763 @item -march=@var{cpu-type}
8764 @opindex march
8765 Generate instructions for the machine type @var{cpu-type}.  The choices
8766 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8767 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8768
8769 @item -mcpu=@var{cpu-type}
8770 @opindex mcpu
8771 A deprecated synonym for @option{-mtune}.
8772
8773 @item -m386
8774 @itemx -m486
8775 @itemx -mpentium
8776 @itemx -mpentiumpro
8777 @opindex m386
8778 @opindex m486
8779 @opindex mpentium
8780 @opindex mpentiumpro
8781 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8782 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8783 These synonyms are deprecated.
8784
8785 @item -mfpmath=@var{unit}
8786 @opindex march
8787 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8788 for @var{unit} are:
8789
8790 @table @samp
8791 @item 387
8792 Use the standard 387 floating point coprocessor present majority of chips and
8793 emulated otherwise.  Code compiled with this option will run almost everywhere.
8794 The temporary results are computed in 80bit precision instead of precision
8795 specified by the type resulting in slightly different results compared to most
8796 of other chips.  See @option{-ffloat-store} for more detailed description.
8797
8798 This is the default choice for i386 compiler.
8799
8800 @item sse
8801 Use scalar floating point instructions present in the SSE instruction set.
8802 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8803 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8804 instruction set supports only single precision arithmetics, thus the double and
8805 extended precision arithmetics is still done using 387.  Later version, present
8806 only in Pentium4 and the future AMD x86-64 chips supports double precision
8807 arithmetics too.
8808
8809 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8810 or @option{-msse2} switches to enable SSE extensions and make this option
8811 effective.  For the x86-64 compiler, these extensions are enabled by default.
8812
8813 The resulting code should be considerably faster in the majority of cases and avoid
8814 the numerical instability problems of 387 code, but may break some existing
8815 code that expects temporaries to be 80bit.
8816
8817 This is the default choice for the x86-64 compiler.
8818
8819 @item sse,387
8820 Attempt to utilize both instruction sets at once.  This effectively double the
8821 amount of available registers and on chips with separate execution units for
8822 387 and SSE the execution resources too.  Use this option with care, as it is
8823 still experimental, because the GCC register allocator does not model separate
8824 functional units well resulting in instable performance.
8825 @end table
8826
8827 @item -masm=@var{dialect}
8828 @opindex masm=@var{dialect}
8829 Output asm instructions using selected @var{dialect}.  Supported choices are
8830 @samp{intel} or @samp{att} (the default one).
8831
8832 @item -mieee-fp
8833 @itemx -mno-ieee-fp
8834 @opindex mieee-fp
8835 @opindex mno-ieee-fp
8836 Control whether or not the compiler uses IEEE floating point
8837 comparisons.  These handle correctly the case where the result of a
8838 comparison is unordered.
8839
8840 @item -msoft-float
8841 @opindex msoft-float
8842 Generate output containing library calls for floating point.
8843 @strong{Warning:} the requisite libraries are not part of GCC@.
8844 Normally the facilities of the machine's usual C compiler are used, but
8845 this can't be done directly in cross-compilation.  You must make your
8846 own arrangements to provide suitable library functions for
8847 cross-compilation.
8848
8849 On machines where a function returns floating point results in the 80387
8850 register stack, some floating point opcodes may be emitted even if
8851 @option{-msoft-float} is used.
8852
8853 @item -mno-fp-ret-in-387
8854 @opindex mno-fp-ret-in-387
8855 Do not use the FPU registers for return values of functions.
8856
8857 The usual calling convention has functions return values of types
8858 @code{float} and @code{double} in an FPU register, even if there
8859 is no FPU@.  The idea is that the operating system should emulate
8860 an FPU@.
8861
8862 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8863 in ordinary CPU registers instead.
8864
8865 @item -mno-fancy-math-387
8866 @opindex mno-fancy-math-387
8867 Some 387 emulators do not support the @code{sin}, @code{cos} and
8868 @code{sqrt} instructions for the 387.  Specify this option to avoid
8869 generating those instructions.  This option is the default on FreeBSD,
8870 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8871 indicates that the target cpu will always have an FPU and so the
8872 instruction will not need emulation.  As of revision 2.6.1, these
8873 instructions are not generated unless you also use the
8874 @option{-funsafe-math-optimizations} switch.
8875
8876 @item -malign-double
8877 @itemx -mno-align-double
8878 @opindex malign-double
8879 @opindex mno-align-double
8880 Control whether GCC aligns @code{double}, @code{long double}, and
8881 @code{long long} variables on a two word boundary or a one word
8882 boundary.  Aligning @code{double} variables on a two word boundary will
8883 produce code that runs somewhat faster on a @samp{Pentium} at the
8884 expense of more memory.
8885
8886 @strong{Warning:} if you use the @option{-malign-double} switch,
8887 structures containing the above types will be aligned differently than
8888 the published application binary interface specifications for the 386
8889 and will not be binary compatible with structures in code compiled
8890 without that switch.
8891
8892 @item -m96bit-long-double
8893 @itemx -m128bit-long-double
8894 @opindex m96bit-long-double
8895 @opindex m128bit-long-double
8896 These switches control the size of @code{long double} type.  The i386
8897 application binary interface specifies the size to be 96 bits,
8898 so @option{-m96bit-long-double} is the default in 32 bit mode.
8899
8900 Modern architectures (Pentium and newer) would prefer @code{long double}
8901 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8902 conforming to the ABI, this would not be possible.  So specifying a
8903 @option{-m128bit-long-double} will align @code{long double}
8904 to a 16 byte boundary by padding the @code{long double} with an additional
8905 32 bit zero.
8906
8907 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8908 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8909
8910 Notice that neither of these options enable any extra precision over the x87
8911 standard of 80 bits for a @code{long double}.
8912
8913 @strong{Warning:} if you override the default value for your target ABI, the
8914 structures and arrays containing @code{long double} variables will change
8915 their size as well as function calling convention for function taking
8916 @code{long double} will be modified.  Hence they will not be binary
8917 compatible with arrays or structures in code compiled without that switch.
8918
8919
8920 @item -msvr3-shlib
8921 @itemx -mno-svr3-shlib
8922 @opindex msvr3-shlib
8923 @opindex mno-svr3-shlib
8924 Control whether GCC places uninitialized local variables into the
8925 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8926 into @code{bss}.  These options are meaningful only on System V Release 3.
8927
8928 @item -mrtd
8929 @opindex mrtd
8930 Use a different function-calling convention, in which functions that
8931 take a fixed number of arguments return with the @code{ret} @var{num}
8932 instruction, which pops their arguments while returning.  This saves one
8933 instruction in the caller since there is no need to pop the arguments
8934 there.
8935
8936 You can specify that an individual function is called with this calling
8937 sequence with the function attribute @samp{stdcall}.  You can also
8938 override the @option{-mrtd} option by using the function attribute
8939 @samp{cdecl}.  @xref{Function Attributes}.
8940
8941 @strong{Warning:} this calling convention is incompatible with the one
8942 normally used on Unix, so you cannot use it if you need to call
8943 libraries compiled with the Unix compiler.
8944
8945 Also, you must provide function prototypes for all functions that
8946 take variable numbers of arguments (including @code{printf});
8947 otherwise incorrect code will be generated for calls to those
8948 functions.
8949
8950 In addition, seriously incorrect code will result if you call a
8951 function with too many arguments.  (Normally, extra arguments are
8952 harmlessly ignored.)
8953
8954 @item -mregparm=@var{num}
8955 @opindex mregparm
8956 Control how many registers are used to pass integer arguments.  By
8957 default, no registers are used to pass arguments, and at most 3
8958 registers can be used.  You can control this behavior for a specific
8959 function by using the function attribute @samp{regparm}.
8960 @xref{Function Attributes}.
8961
8962 @strong{Warning:} if you use this switch, and
8963 @var{num} is nonzero, then you must build all modules with the same
8964 value, including any libraries.  This includes the system libraries and
8965 startup modules.
8966
8967 @item -mpreferred-stack-boundary=@var{num}
8968 @opindex mpreferred-stack-boundary
8969 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8970 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8971 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8972 size (@option{-Os}), in which case the default is the minimum correct
8973 alignment (4 bytes for x86, and 8 bytes for x86-64).
8974
8975 On Pentium and PentiumPro, @code{double} and @code{long double} values
8976 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8977 suffer significant run time performance penalties.  On Pentium III, the
8978 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8979 penalties if it is not 16 byte aligned.
8980
8981 To ensure proper alignment of this values on the stack, the stack boundary
8982 must be as aligned as that required by any value stored on the stack.
8983 Further, every function must be generated such that it keeps the stack
8984 aligned.  Thus calling a function compiled with a higher preferred
8985 stack boundary from a function compiled with a lower preferred stack
8986 boundary will most likely misalign the stack.  It is recommended that
8987 libraries that use callbacks always use the default setting.
8988
8989 This extra alignment does consume extra stack space, and generally
8990 increases code size.  Code that is sensitive to stack space usage, such
8991 as embedded systems and operating system kernels, may want to reduce the
8992 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8993
8994 @item -mmmx
8995 @itemx -mno-mmx
8996 @item -msse
8997 @itemx -mno-sse
8998 @item -msse2
8999 @itemx -mno-sse2
9000 @item -msse3
9001 @itemx -mno-sse3
9002 @item -m3dnow
9003 @itemx -mno-3dnow
9004 @opindex mmmx
9005 @opindex mno-mmx
9006 @opindex msse
9007 @opindex mno-sse
9008 @opindex m3dnow
9009 @opindex mno-3dnow
9010 These switches enable or disable the use of built-in functions that allow
9011 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
9012 instruction set.
9013
9014 @xref{X86 Built-in Functions}, for details of the functions enabled
9015 and disabled by these switches.
9016
9017 To have SSE/SSE2 instructions generated automatically from floating-point
9018 code, see @option{-mfpmath=sse}.
9019
9020 @item -mpush-args
9021 @itemx -mno-push-args
9022 @opindex mpush-args
9023 @opindex mno-push-args
9024 Use PUSH operations to store outgoing parameters.  This method is shorter
9025 and usually equally fast as method using SUB/MOV operations and is enabled
9026 by default.  In some cases disabling it may improve performance because of
9027 improved scheduling and reduced dependencies.
9028
9029 @item -maccumulate-outgoing-args
9030 @opindex maccumulate-outgoing-args
9031 If enabled, the maximum amount of space required for outgoing arguments will be
9032 computed in the function prologue.  This is faster on most modern CPUs
9033 because of reduced dependencies, improved scheduling and reduced stack usage
9034 when preferred stack boundary is not equal to 2.  The drawback is a notable
9035 increase in code size.  This switch implies @option{-mno-push-args}.
9036
9037 @item -mthreads
9038 @opindex mthreads
9039 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9040 on thread-safe exception handling must compile and link all code with the
9041 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9042 @option{-D_MT}; when linking, it links in a special thread helper library
9043 @option{-lmingwthrd} which cleans up per thread exception handling data.
9044
9045 @item -mno-align-stringops
9046 @opindex mno-align-stringops
9047 Do not align destination of inlined string operations.  This switch reduces
9048 code size and improves performance in case the destination is already aligned,
9049 but GCC doesn't know about it.
9050
9051 @item -minline-all-stringops
9052 @opindex minline-all-stringops
9053 By default GCC inlines string operations only when destination is known to be
9054 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9055 size, but may improve performance of code that depends on fast memcpy, strlen
9056 and memset for short lengths.
9057
9058 @item -momit-leaf-frame-pointer
9059 @opindex momit-leaf-frame-pointer
9060 Don't keep the frame pointer in a register for leaf functions.  This
9061 avoids the instructions to save, set up and restore frame pointers and
9062 makes an extra register available in leaf functions.  The option
9063 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9064 which might make debugging harder.
9065
9066 @item -mtls-direct-seg-refs
9067 @itemx -mno-tls-direct-seg-refs
9068 @opindex mtls-direct-seg-refs
9069 Controls whether TLS variables may be accessed with offsets from the
9070 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9071 or whether the thread base pointer must be added.  Whether or not this
9072 is legal depends on the operating system, and whether it maps the
9073 segment to cover the entire TLS area.
9074
9075 For systems that use GNU libc, the default is on.
9076 @end table
9077
9078 These @samp{-m} switches are supported in addition to the above
9079 on AMD x86-64 processors in 64-bit environments.
9080
9081 @table @gcctabopt
9082 @item -m32
9083 @itemx -m64
9084 @opindex m32
9085 @opindex m64
9086 Generate code for a 32-bit or 64-bit environment.
9087 The 32-bit environment sets int, long and pointer to 32 bits and
9088 generates code that runs on any i386 system.
9089 The 64-bit environment sets int to 32 bits and long and pointer
9090 to 64 bits and generates code for AMD's x86-64 architecture.
9091
9092 @item -mno-red-zone
9093 @opindex no-red-zone
9094 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9095 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9096 stack pointer that will not be modified by signal or interrupt handlers
9097 and therefore can be used for temporary data without adjusting the stack
9098 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9099
9100 @item -mcmodel=small
9101 @opindex mcmodel=small
9102 Generate code for the small code model: the program and its symbols must
9103 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9104 Programs can be statically or dynamically linked.  This is the default
9105 code model.
9106
9107 @item -mcmodel=kernel
9108 @opindex mcmodel=kernel
9109 Generate code for the kernel code model.  The kernel runs in the
9110 negative 2 GB of the address space.
9111 This model has to be used for Linux kernel code.
9112
9113 @item -mcmodel=medium
9114 @opindex mcmodel=medium
9115 Generate code for the medium model: The program is linked in the lower 2
9116 GB of the address space but symbols can be located anywhere in the
9117 address space.  Programs can be statically or dynamically linked, but
9118 building of shared libraries are not supported with the medium model.
9119
9120 @item -mcmodel=large
9121 @opindex mcmodel=large
9122 Generate code for the large model: This model makes no assumptions
9123 about addresses and sizes of sections.  Currently GCC does not implement
9124 this model.
9125 @end table
9126
9127 @node IA-64 Options
9128 @subsection IA-64 Options
9129 @cindex IA-64 Options
9130
9131 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9132
9133 @table @gcctabopt
9134 @item -mbig-endian
9135 @opindex mbig-endian
9136 Generate code for a big endian target.  This is the default for HP-UX@.
9137
9138 @item -mlittle-endian
9139 @opindex mlittle-endian
9140 Generate code for a little endian target.  This is the default for AIX5
9141 and GNU/Linux.
9142
9143 @item -mgnu-as
9144 @itemx -mno-gnu-as
9145 @opindex mgnu-as
9146 @opindex mno-gnu-as
9147 Generate (or don't) code for the GNU assembler.  This is the default.
9148 @c Also, this is the default if the configure option @option{--with-gnu-as}
9149 @c is used.
9150
9151 @item -mgnu-ld
9152 @itemx -mno-gnu-ld
9153 @opindex mgnu-ld
9154 @opindex mno-gnu-ld
9155 Generate (or don't) code for the GNU linker.  This is the default.
9156 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9157 @c is used.
9158
9159 @item -mno-pic
9160 @opindex mno-pic
9161 Generate code that does not use a global pointer register.  The result
9162 is not position independent code, and violates the IA-64 ABI@.
9163
9164 @item -mvolatile-asm-stop
9165 @itemx -mno-volatile-asm-stop
9166 @opindex mvolatile-asm-stop
9167 @opindex mno-volatile-asm-stop
9168 Generate (or don't) a stop bit immediately before and after volatile asm
9169 statements.
9170
9171 @item -mregister-names
9172 @itemx -mno-register-names
9173 @opindex mregister-names
9174 @opindex mno-register-names
9175 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9176 the stacked registers.  This may make assembler output more readable.
9177
9178 @item -mno-sdata
9179 @itemx -msdata
9180 @opindex mno-sdata
9181 @opindex msdata
9182 Disable (or enable) optimizations that use the small data section.  This may
9183 be useful for working around optimizer bugs.
9184
9185 @item -mconstant-gp
9186 @opindex mconstant-gp
9187 Generate code that uses a single constant global pointer value.  This is
9188 useful when compiling kernel code.
9189
9190 @item -mauto-pic
9191 @opindex mauto-pic
9192 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9193 This is useful when compiling firmware code.
9194
9195 @item -minline-float-divide-min-latency
9196 @opindex minline-float-divide-min-latency
9197 Generate code for inline divides of floating point values
9198 using the minimum latency algorithm.
9199
9200 @item -minline-float-divide-max-throughput
9201 @opindex minline-float-divide-max-throughput
9202 Generate code for inline divides of floating point values
9203 using the maximum throughput algorithm.
9204
9205 @item -minline-int-divide-min-latency
9206 @opindex minline-int-divide-min-latency
9207 Generate code for inline divides of integer values
9208 using the minimum latency algorithm.
9209
9210 @item -minline-int-divide-max-throughput
9211 @opindex minline-int-divide-max-throughput
9212 Generate code for inline divides of integer values
9213 using the maximum throughput algorithm.
9214
9215 @item -minline-sqrt-min-latency
9216 @opindex minline-sqrt-min-latency
9217 Generate code for inline square roots
9218 using the minimum latency algorithm.
9219
9220 @item -minline-sqrt-max-throughput
9221 @opindex minline-sqrt-max-throughput
9222 Generate code for inline square roots
9223 using the maximum throughput algorithm.
9224
9225 @item -mno-dwarf2-asm
9226 @itemx -mdwarf2-asm
9227 @opindex mno-dwarf2-asm
9228 @opindex mdwarf2-asm
9229 Don't (or do) generate assembler code for the DWARF2 line number debugging
9230 info.  This may be useful when not using the GNU assembler.
9231
9232 @item -mearly-stop-bits
9233 @itemx -mno-early-stop-bits
9234 @opindex mearly-stop-bits
9235 @opindex mno-early-stop-bits
9236 Allow stop bits to be placed earlier than immediately preceding the
9237 instruction that triggered the stop bit.  This can improve instruction
9238 scheduling, but does not always do so.
9239
9240 @item -mfixed-range=@var{register-range}
9241 @opindex mfixed-range
9242 Generate code treating the given register range as fixed registers.
9243 A fixed register is one that the register allocator can not use.  This is
9244 useful when compiling kernel code.  A register range is specified as
9245 two registers separated by a dash.  Multiple register ranges can be
9246 specified separated by a comma.
9247
9248 @item -mtls-size=@var{tls-size}
9249 @opindex mtls-size
9250 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9251 64.
9252
9253 @item -mtune-arch=@var{cpu-type}
9254 @opindex mtune-arch
9255 Tune the instruction scheduling for a particular CPU, Valid values are
9256 itanium, itanium1, merced, itanium2, and mckinley.
9257
9258 @item -mt
9259 @itemx -pthread
9260 @opindex mt
9261 @opindex pthread
9262 Add support for multithreading using the POSIX threads library.  This
9263 option sets flags for both the preprocessor and linker.  It does
9264 not affect the thread safety of object code produced by the compiler or
9265 that of libraries supplied with it.  These are HP-UX specific flags.
9266
9267 @item -milp32
9268 @itemx -mlp64
9269 @opindex milp32
9270 @opindex mlp64
9271 Generate code for a 32-bit or 64-bit environment.
9272 The 32-bit environment sets int, long and pointer to 32 bits.
9273 The 64-bit environment sets int to 32 bits and long and pointer
9274 to 64 bits.  These are HP-UX specific flags.
9275
9276 @end table
9277
9278 @node M32R/D Options
9279 @subsection M32R/D Options
9280 @cindex M32R/D options
9281
9282 These @option{-m} options are defined for Renesas M32R/D architectures:
9283
9284 @table @gcctabopt
9285 @item -m32r2
9286 @opindex m32r2
9287 Generate code for the M32R/2@.
9288
9289 @item -m32rx
9290 @opindex m32rx
9291 Generate code for the M32R/X@.
9292
9293 @item -m32r
9294 @opindex m32r
9295 Generate code for the M32R@.  This is the default.
9296
9297 @item -mmodel=small
9298 @opindex mmodel=small
9299 Assume all objects live in the lower 16MB of memory (so that their addresses
9300 can be loaded with the @code{ld24} instruction), and assume all subroutines
9301 are reachable with the @code{bl} instruction.
9302 This is the default.
9303
9304 The addressability of a particular object can be set with the
9305 @code{model} attribute.
9306
9307 @item -mmodel=medium
9308 @opindex mmodel=medium
9309 Assume objects may be anywhere in the 32-bit address space (the compiler
9310 will generate @code{seth/add3} instructions to load their addresses), and
9311 assume all subroutines are reachable with the @code{bl} instruction.
9312
9313 @item -mmodel=large
9314 @opindex mmodel=large
9315 Assume objects may be anywhere in the 32-bit address space (the compiler
9316 will generate @code{seth/add3} instructions to load their addresses), and
9317 assume subroutines may not be reachable with the @code{bl} instruction
9318 (the compiler will generate the much slower @code{seth/add3/jl}
9319 instruction sequence).
9320
9321 @item -msdata=none
9322 @opindex msdata=none
9323 Disable use of the small data area.  Variables will be put into
9324 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9325 @code{section} attribute has been specified).
9326 This is the default.
9327
9328 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9329 Objects may be explicitly put in the small data area with the
9330 @code{section} attribute using one of these sections.
9331
9332 @item -msdata=sdata
9333 @opindex msdata=sdata
9334 Put small global and static data in the small data area, but do not
9335 generate special code to reference them.
9336
9337 @item -msdata=use
9338 @opindex msdata=use
9339 Put small global and static data in the small data area, and generate
9340 special instructions to reference them.
9341
9342 @item -G @var{num}
9343 @opindex G
9344 @cindex smaller data references
9345 Put global and static objects less than or equal to @var{num} bytes
9346 into the small data or bss sections instead of the normal data or bss
9347 sections.  The default value of @var{num} is 8.
9348 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9349 for this option to have any effect.
9350
9351 All modules should be compiled with the same @option{-G @var{num}} value.
9352 Compiling with different values of @var{num} may or may not work; if it
9353 doesn't the linker will give an error message---incorrect code will not be
9354 generated.
9355
9356 @item -mdebug
9357 @opindex mdebug
9358 Makes the M32R specific code in the compiler display some statistics
9359 that might help in debugging programs.
9360
9361 @item -malign-loops
9362 @opindex malign-loops
9363 Align all loops to a 32-byte boundary.
9364
9365 @item -mno-align-loops
9366 @opindex mno-align-loops
9367 Do not enforce a 32-byte alignment for loops.  This is the default.
9368
9369 @item -missue-rate=@var{number}
9370 @opindex missue-rate=@var{number}
9371 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9372 or 2.
9373
9374 @item -mbranch-cost=@var{number}
9375 @opindex mbranch-cost=@var{number}
9376 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9377 preferred over conditional code, if it is 2, then the opposite will
9378 apply.
9379
9380 @item -mflush-trap=@var{number}
9381 @opindex mflush-trap=@var{number}
9382 Specifies the trap number to use to flush the cache.  The default is
9383 12.  Valid numbers are between 0 and 15 inclusive.
9384
9385 @item -mno-flush-trap
9386 @opindex mno-flush-trap
9387 Specifies that the cache cannot be flushed by using a trap.
9388
9389 @item -mflush-func=@var{name}
9390 @opindex mflush-func=@var{name}
9391 Specifies the name of the operating system function to call to flush
9392 the cache.  The default is @emph{_flush_cache}, but a function call
9393 will only be used if a trap is not available.
9394
9395 @item -mno-flush-func
9396 @opindex mno-flush-func
9397 Indicates that there is no OS function for flushing the cache.
9398
9399 @end table
9400
9401 @node M680x0 Options
9402 @subsection M680x0 Options
9403 @cindex M680x0 options
9404
9405 These are the @samp{-m} options defined for the 68000 series.  The default
9406 values for these options depends on which style of 68000 was selected when
9407 the compiler was configured; the defaults for the most common choices are
9408 given below.
9409
9410 @table @gcctabopt
9411 @item -m68000
9412 @itemx -mc68000
9413 @opindex m68000
9414 @opindex mc68000
9415 Generate output for a 68000.  This is the default
9416 when the compiler is configured for 68000-based systems.
9417
9418 Use this option for microcontrollers with a 68000 or EC000 core,
9419 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9420
9421 @item -m68020
9422 @itemx -mc68020
9423 @opindex m68020
9424 @opindex mc68020
9425 Generate output for a 68020.  This is the default
9426 when the compiler is configured for 68020-based systems.
9427
9428 @item -m68881
9429 @opindex m68881
9430 Generate output containing 68881 instructions for floating point.
9431 This is the default for most 68020 systems unless @option{--nfp} was
9432 specified when the compiler was configured.
9433
9434 @item -m68030
9435 @opindex m68030
9436 Generate output for a 68030.  This is the default when the compiler is
9437 configured for 68030-based systems.
9438
9439 @item -m68040
9440 @opindex m68040
9441 Generate output for a 68040.  This is the default when the compiler is
9442 configured for 68040-based systems.
9443
9444 This option inhibits the use of 68881/68882 instructions that have to be
9445 emulated by software on the 68040.  Use this option if your 68040 does not
9446 have code to emulate those instructions.
9447
9448 @item -m68060
9449 @opindex m68060
9450 Generate output for a 68060.  This is the default when the compiler is
9451 configured for 68060-based systems.
9452
9453 This option inhibits the use of 68020 and 68881/68882 instructions that
9454 have to be emulated by software on the 68060.  Use this option if your 68060
9455 does not have code to emulate those instructions.
9456
9457 @item -mcpu32
9458 @opindex mcpu32
9459 Generate output for a CPU32.  This is the default
9460 when the compiler is configured for CPU32-based systems.
9461
9462 Use this option for microcontrollers with a
9463 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9464 68336, 68340, 68341, 68349 and 68360.
9465
9466 @item -m5200
9467 @opindex m5200
9468 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9469 when the compiler is configured for 520X-based systems.
9470
9471 Use this option for microcontroller with a 5200 core, including
9472 the MCF5202, MCF5203, MCF5204 and MCF5202.
9473
9474
9475 @item -m68020-40
9476 @opindex m68020-40
9477 Generate output for a 68040, without using any of the new instructions.
9478 This results in code which can run relatively efficiently on either a
9479 68020/68881 or a 68030 or a 68040.  The generated code does use the
9480 68881 instructions that are emulated on the 68040.
9481
9482 @item -m68020-60
9483 @opindex m68020-60
9484 Generate output for a 68060, without using any of the new instructions.
9485 This results in code which can run relatively efficiently on either a
9486 68020/68881 or a 68030 or a 68040.  The generated code does use the
9487 68881 instructions that are emulated on the 68060.
9488
9489 @item -msoft-float
9490 @opindex msoft-float
9491 Generate output containing library calls for floating point.
9492 @strong{Warning:} the requisite libraries are not available for all m68k
9493 targets.  Normally the facilities of the machine's usual C compiler are
9494 used, but this can't be done directly in cross-compilation.  You must
9495 make your own arrangements to provide suitable library functions for
9496 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9497 @samp{m68k-*-coff} do provide software floating point support.
9498
9499 @item -mshort
9500 @opindex mshort
9501 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9502 Additionally, parameters passed on the stack are also aligned to a
9503 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9504
9505 @item -mnobitfield
9506 @opindex mnobitfield
9507 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9508 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9509
9510 @item -mbitfield
9511 @opindex mbitfield
9512 Do use the bit-field instructions.  The @option{-m68020} option implies
9513 @option{-mbitfield}.  This is the default if you use a configuration
9514 designed for a 68020.
9515
9516 @item -mrtd
9517 @opindex mrtd
9518 Use a different function-calling convention, in which functions
9519 that take a fixed number of arguments return with the @code{rtd}
9520 instruction, which pops their arguments while returning.  This
9521 saves one instruction in the caller since there is no need to pop
9522 the arguments there.
9523
9524 This calling convention is incompatible with the one normally
9525 used on Unix, so you cannot use it if you need to call libraries
9526 compiled with the Unix compiler.
9527
9528 Also, you must provide function prototypes for all functions that
9529 take variable numbers of arguments (including @code{printf});
9530 otherwise incorrect code will be generated for calls to those
9531 functions.
9532
9533 In addition, seriously incorrect code will result if you call a
9534 function with too many arguments.  (Normally, extra arguments are
9535 harmlessly ignored.)
9536
9537 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9538 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9539
9540 @item -malign-int
9541 @itemx -mno-align-int
9542 @opindex malign-int
9543 @opindex mno-align-int
9544 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9545 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9546 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9547 Aligning variables on 32-bit boundaries produces code that runs somewhat
9548 faster on processors with 32-bit busses at the expense of more memory.
9549
9550 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9551 align structures containing the above types  differently than
9552 most published application binary interface specifications for the m68k.
9553
9554 @item -mpcrel
9555 @opindex mpcrel
9556 Use the pc-relative addressing mode of the 68000 directly, instead of
9557 using a global offset table.  At present, this option implies @option{-fpic},
9558 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9559 not presently supported with @option{-mpcrel}, though this could be supported for
9560 68020 and higher processors.
9561
9562 @item -mno-strict-align
9563 @itemx -mstrict-align
9564 @opindex mno-strict-align
9565 @opindex mstrict-align
9566 Do not (do) assume that unaligned memory references will be handled by
9567 the system.
9568
9569 @item -msep-data
9570 Generate code that allows the data segment to be located in a different
9571 area of memory from the text segment.  This allows for execute in place in
9572 an environment without virtual memory management.  This option implies
9573 @option{-fPIC}.
9574
9575 @item -mno-sep-data
9576 Generate code that assumes that the data segment follows the text segment.
9577 This is the default.
9578
9579 @item -mid-shared-library
9580 Generate code that supports shared libraries via the library ID method.
9581 This allows for execute in place and shared libraries in an environment
9582 without virtual memory management.  This option implies @option{-fPIC}.
9583
9584 @item -mno-id-shared-library
9585 Generate code that doesn't assume ID based shared libraries are being used.
9586 This is the default.
9587
9588 @item -mshared-library-id=n
9589 Specified the identification number of the ID based shared library being
9590 compiled.  Specifying a value of 0 will generate more compact code, specifying
9591 other values will force the allocation of that number to the current
9592 library but is no more space or time efficient than omitting this option.
9593
9594 @end table
9595
9596 @node M68hc1x Options
9597 @subsection M68hc1x Options
9598 @cindex M68hc1x options
9599
9600 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9601 microcontrollers.  The default values for these options depends on
9602 which style of microcontroller was selected when the compiler was configured;
9603 the defaults for the most common choices are given below.
9604
9605 @table @gcctabopt
9606 @item -m6811
9607 @itemx -m68hc11
9608 @opindex m6811
9609 @opindex m68hc11
9610 Generate output for a 68HC11.  This is the default
9611 when the compiler is configured for 68HC11-based systems.
9612
9613 @item -m6812
9614 @itemx -m68hc12
9615 @opindex m6812
9616 @opindex m68hc12
9617 Generate output for a 68HC12.  This is the default
9618 when the compiler is configured for 68HC12-based systems.
9619
9620 @item -m68S12
9621 @itemx -m68hcs12
9622 @opindex m68S12
9623 @opindex m68hcs12
9624 Generate output for a 68HCS12.
9625
9626 @item -mauto-incdec
9627 @opindex mauto-incdec
9628 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9629 addressing modes.
9630
9631 @item -minmax
9632 @itemx -nominmax
9633 @opindex minmax
9634 @opindex mnominmax
9635 Enable the use of 68HC12 min and max instructions.
9636
9637 @item -mlong-calls
9638 @itemx -mno-long-calls
9639 @opindex mlong-calls
9640 @opindex mno-long-calls
9641 Treat all calls as being far away (near).  If calls are assumed to be
9642 far away, the compiler will use the @code{call} instruction to
9643 call a function and the @code{rtc} instruction for returning.
9644
9645 @item -mshort
9646 @opindex mshort
9647 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9648
9649 @item -msoft-reg-count=@var{count}
9650 @opindex msoft-reg-count
9651 Specify the number of pseudo-soft registers which are used for the
9652 code generation.  The maximum number is 32.  Using more pseudo-soft
9653 register may or may not result in better code depending on the program.
9654 The default is 4 for 68HC11 and 2 for 68HC12.
9655
9656 @end table
9657
9658 @node MCore Options
9659 @subsection MCore Options
9660 @cindex MCore options
9661
9662 These are the @samp{-m} options defined for the Motorola M*Core
9663 processors.
9664
9665 @table @gcctabopt
9666
9667 @item -mhardlit
9668 @itemx -mno-hardlit
9669 @opindex mhardlit
9670 @opindex mno-hardlit
9671 Inline constants into the code stream if it can be done in two
9672 instructions or less.
9673
9674 @item -mdiv
9675 @itemx -mno-div
9676 @opindex mdiv
9677 @opindex mno-div
9678 Use the divide instruction.  (Enabled by default).
9679
9680 @item -mrelax-immediate
9681 @itemx -mno-relax-immediate
9682 @opindex mrelax-immediate
9683 @opindex mno-relax-immediate
9684 Allow arbitrary sized immediates in bit operations.
9685
9686 @item -mwide-bitfields
9687 @itemx -mno-wide-bitfields
9688 @opindex mwide-bitfields
9689 @opindex mno-wide-bitfields
9690 Always treat bit-fields as int-sized.
9691
9692 @item -m4byte-functions
9693 @itemx -mno-4byte-functions
9694 @opindex m4byte-functions
9695 @opindex mno-4byte-functions
9696 Force all functions to be aligned to a four byte boundary.
9697
9698 @item -mcallgraph-data
9699 @itemx -mno-callgraph-data
9700 @opindex mcallgraph-data
9701 @opindex mno-callgraph-data
9702 Emit callgraph information.
9703
9704 @item -mslow-bytes
9705 @itemx -mno-slow-bytes
9706 @opindex mslow-bytes
9707 @opindex mno-slow-bytes
9708 Prefer word access when reading byte quantities.
9709
9710 @item -mlittle-endian
9711 @itemx -mbig-endian
9712 @opindex mlittle-endian
9713 @opindex mbig-endian
9714 Generate code for a little endian target.
9715
9716 @item -m210
9717 @itemx -m340
9718 @opindex m210
9719 @opindex m340
9720 Generate code for the 210 processor.
9721 @end table
9722
9723 @node MIPS Options
9724 @subsection MIPS Options
9725 @cindex MIPS options
9726
9727 @table @gcctabopt
9728
9729 @item -EB
9730 @opindex EB
9731 Generate big-endian code.
9732
9733 @item -EL
9734 @opindex EL
9735 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9736 configurations.
9737
9738 @item -march=@var{arch}
9739 @opindex march
9740 Generate code that will run on @var{arch}, which can be the name of a
9741 generic MIPS ISA, or the name of a particular processor.
9742 The ISA names are:
9743 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9744 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9745 The processor names are:
9746 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9747 @samp{m4k},
9748 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9749 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9750 @samp{rm9000},
9751 @samp{orion},
9752 @samp{sb1},
9753 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9754 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9755 The special value @samp{from-abi} selects the
9756 most compatible architecture for the selected ABI (that is,
9757 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9758
9759 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9760 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9761 @samp{vr} may be written @samp{r}.
9762
9763 GCC defines two macros based on the value of this option.  The first
9764 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9765 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9766 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9767 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9768 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9769
9770 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9771 above.  In other words, it will have the full prefix and will not
9772 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9773 the macro names the resolved architecture (either @samp{"mips1"} or
9774 @samp{"mips3"}).  It names the default architecture when no
9775 @option{-march} option is given.
9776
9777 @item -mtune=@var{arch}
9778 @opindex mtune
9779 Optimize for @var{arch}.  Among other things, this option controls
9780 the way instructions are scheduled, and the perceived cost of arithmetic
9781 operations.  The list of @var{arch} values is the same as for
9782 @option{-march}.
9783
9784 When this option is not used, GCC will optimize for the processor
9785 specified by @option{-march}.  By using @option{-march} and
9786 @option{-mtune} together, it is possible to generate code that will
9787 run on a family of processors, but optimize the code for one
9788 particular member of that family.
9789
9790 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9791 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9792 @samp{-march} ones described above.
9793
9794 @item -mips1
9795 @opindex mips1
9796 Equivalent to @samp{-march=mips1}.
9797
9798 @item -mips2
9799 @opindex mips2
9800 Equivalent to @samp{-march=mips2}.
9801
9802 @item -mips3
9803 @opindex mips3
9804 Equivalent to @samp{-march=mips3}.
9805
9806 @item -mips4
9807 @opindex mips4
9808 Equivalent to @samp{-march=mips4}.
9809
9810 @item -mips32
9811 @opindex mips32
9812 Equivalent to @samp{-march=mips32}.
9813
9814 @item -mips32r2
9815 @opindex mips32r2
9816 Equivalent to @samp{-march=mips32r2}.
9817
9818 @item -mips64
9819 @opindex mips64
9820 Equivalent to @samp{-march=mips64}.
9821
9822 @item -mips16
9823 @itemx -mno-mips16
9824 @opindex mips16
9825 @opindex mno-mips16
9826 Use (do not use) the MIPS16 ISA@.
9827
9828 @item -mabi=32
9829 @itemx -mabi=o64
9830 @itemx -mabi=n32
9831 @itemx -mabi=64
9832 @itemx -mabi=eabi
9833 @opindex mabi=32
9834 @opindex mabi=o64
9835 @opindex mabi=n32
9836 @opindex mabi=64
9837 @opindex mabi=eabi
9838 Generate code for the given ABI@.
9839
9840 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9841 generates 64-bit code when you select a 64-bit architecture, but you
9842 can use @option{-mgp32} to get 32-bit code instead.
9843
9844 For information about the O64 ABI, see
9845 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9846
9847 @item -mabicalls
9848 @itemx -mno-abicalls
9849 @opindex mabicalls
9850 @opindex mno-abicalls
9851 Generate (do not generate) SVR4-style position-independent code.
9852 @option{-mabicalls} is the default for SVR4-based systems.
9853
9854 @item -mxgot
9855 @itemx -mno-xgot
9856 @opindex mxgot
9857 @opindex mno-xgot
9858 Lift (do not lift) the usual restrictions on the size of the global
9859 offset table.
9860
9861 GCC normally uses a single instruction to load values from the GOT@.
9862 While this is relatively efficient, it will only work if the GOT
9863 is smaller than about 64k.  Anything larger will cause the linker
9864 to report an error such as:
9865
9866 @cindex relocation truncated to fit (MIPS)
9867 @smallexample
9868 relocation truncated to fit: R_MIPS_GOT16 foobar
9869 @end smallexample
9870
9871 If this happens, you should recompile your code with @option{-mxgot}.
9872 It should then work with very large GOTs, although it will also be
9873 less efficient, since it will take three instructions to fetch the
9874 value of a global symbol.
9875
9876 Note that some linkers can create multiple GOTs.  If you have such a
9877 linker, you should only need to use @option{-mxgot} when a single object
9878 file accesses more than 64k's worth of GOT entries.  Very few do.
9879
9880 These options have no effect unless GCC is generating position
9881 independent code.
9882
9883 @item -mgp32
9884 @opindex mgp32
9885 Assume that general-purpose registers are 32 bits wide.
9886
9887 @item -mgp64
9888 @opindex mgp64
9889 Assume that general-purpose registers are 64 bits wide.
9890
9891 @item -mfp32
9892 @opindex mfp32
9893 Assume that floating-point registers are 32 bits wide.
9894
9895 @item -mfp64
9896 @opindex mfp64
9897 Assume that floating-point registers are 64 bits wide.
9898
9899 @item -mhard-float
9900 @opindex mhard-float
9901 Use floating-point coprocessor instructions.
9902
9903 @item -msoft-float
9904 @opindex msoft-float
9905 Do not use floating-point coprocessor instructions.  Implement
9906 floating-point calculations using library calls instead.
9907
9908 @item -msingle-float
9909 @opindex msingle-float
9910 Assume that the floating-point coprocessor only supports single-precision
9911 operations.
9912
9913 @itemx -mdouble-float
9914 @opindex mdouble-float
9915 Assume that the floating-point coprocessor supports double-precision
9916 operations.  This is the default.
9917
9918 @itemx -mpaired-single
9919 @itemx -mno-paired-single
9920 @opindex mpaired-single
9921 @opindex mno-paired-single
9922 Use (do not use) paired-single floating-point instructions.
9923 @xref{MIPS Paired-Single Support}.  This option can only be used
9924 when generating 64-bit code and requires hardware floating-point
9925 support to be enabled.
9926
9927 @itemx -mips3d
9928 @itemx -mno-mips3d
9929 @opindex mips3d
9930 @opindex mno-mips3d
9931 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9932 The option @option{-mips3d} implies @option{-mpaired-single}.
9933
9934 @item -mlong64
9935 @opindex mlong64
9936 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9937 an explanation of the default and the way that the pointer size is
9938 determined.
9939
9940 @item -mlong32
9941 @opindex mlong32
9942 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9943
9944 The default size of @code{int}s, @code{long}s and pointers depends on
9945 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9946 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9947 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9948 or the same size as integer registers, whichever is smaller.
9949
9950 @item -msym32
9951 @itemx -mno-sym32
9952 @opindex msym32
9953 @opindex mno-sym32
9954 Assume (do not assume) that all symbols have 32-bit values, regardless
9955 of the selected ABI@.  This option is useful in combination with
9956 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
9957 to generate shorter and faster references to symbolic addresses.
9958
9959 @item -G @var{num}
9960 @opindex G
9961 @cindex smaller data references (MIPS)
9962 @cindex gp-relative references (MIPS)
9963 Put global and static items less than or equal to @var{num} bytes into
9964 the small data or bss section instead of the normal data or bss section.
9965 This allows the data to be accessed using a single instruction.
9966
9967 All modules should be compiled with the same @option{-G @var{num}}
9968 value.
9969
9970 @item -membedded-data
9971 @itemx -mno-embedded-data
9972 @opindex membedded-data
9973 @opindex mno-embedded-data
9974 Allocate variables to the read-only data section first if possible, then
9975 next in the small data section if possible, otherwise in data.  This gives
9976 slightly slower code than the default, but reduces the amount of RAM required
9977 when executing, and thus may be preferred for some embedded systems.
9978
9979 @item -muninit-const-in-rodata
9980 @itemx -mno-uninit-const-in-rodata
9981 @opindex muninit-const-in-rodata
9982 @opindex mno-uninit-const-in-rodata
9983 Put uninitialized @code{const} variables in the read-only data section.
9984 This option is only meaningful in conjunction with @option{-membedded-data}.
9985
9986 @item -msplit-addresses
9987 @itemx -mno-split-addresses
9988 @opindex msplit-addresses
9989 @opindex mno-split-addresses
9990 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9991 relocation operators.  This option has been superseded by
9992 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9993
9994 @item -mexplicit-relocs
9995 @itemx -mno-explicit-relocs
9996 @opindex mexplicit-relocs
9997 @opindex mno-explicit-relocs
9998 Use (do not use) assembler relocation operators when dealing with symbolic
9999 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10000 is to use assembler macros instead.
10001
10002 @option{-mexplicit-relocs} is the default if GCC was configured
10003 to use an assembler that supports relocation operators.
10004
10005 @item -mcheck-zero-division
10006 @itemx -mno-check-zero-division
10007 @opindex mcheck-zero-division
10008 @opindex mno-check-zero-division
10009 Trap (do not trap) on integer division by zero.  The default is
10010 @option{-mcheck-zero-division}.
10011
10012 @item -mdivide-traps
10013 @itemx -mdivide-breaks
10014 @opindex mdivide-traps
10015 @opindex mdivide-breaks
10016 MIPS systems check for division by zero by generating either a
10017 conditional trap or a break instruction.  Using traps results in
10018 smaller code, but is only supported on MIPS II and later.  Also, some
10019 versions of the Linux kernel have a bug that prevents trap from
10020 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10021 allow conditional traps on architectures that support them and
10022 @option{-mdivide-breaks} to force the use of breaks.
10023
10024 The default is usually @option{-mdivide-traps}, but this can be
10025 overridden at configure time using @option{--with-divide=breaks}.
10026 Divide-by-zero checks can be completely disabled using
10027 @option{-mno-check-zero-division}.
10028
10029 @item -mmemcpy
10030 @itemx -mno-memcpy
10031 @opindex mmemcpy
10032 @opindex mno-memcpy
10033 Force (do not force) the use of @code{memcpy()} for non-trivial block
10034 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10035 most constant-sized copies.
10036
10037 @item -mlong-calls
10038 @itemx -mno-long-calls
10039 @opindex mlong-calls
10040 @opindex mno-long-calls
10041 Disable (do not disable) use of the @code{jal} instruction.  Calling
10042 functions using @code{jal} is more efficient but requires the caller
10043 and callee to be in the same 256 megabyte segment.
10044
10045 This option has no effect on abicalls code.  The default is
10046 @option{-mno-long-calls}.
10047
10048 @item -mmad
10049 @itemx -mno-mad
10050 @opindex mmad
10051 @opindex mno-mad
10052 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10053 instructions, as provided by the R4650 ISA@.
10054
10055 @item -mfused-madd
10056 @itemx -mno-fused-madd
10057 @opindex mfused-madd
10058 @opindex mno-fused-madd
10059 Enable (disable) use of the floating point multiply-accumulate
10060 instructions, when they are available.  The default is
10061 @option{-mfused-madd}.
10062
10063 When multiply-accumulate instructions are used, the intermediate
10064 product is calculated to infinite precision and is not subject to
10065 the FCSR Flush to Zero bit.  This may be undesirable in some
10066 circumstances.
10067
10068 @item -nocpp
10069 @opindex nocpp
10070 Tell the MIPS assembler to not run its preprocessor over user
10071 assembler files (with a @samp{.s} suffix) when assembling them.
10072
10073 @item -mfix-r4000
10074 @itemx -mno-fix-r4000
10075 @opindex mfix-r4000
10076 @opindex mno-fix-r4000
10077 Work around certain R4000 CPU errata:
10078 @itemize @minus
10079 @item
10080 A double-word or a variable shift may give an incorrect result if executed
10081 immediately after starting an integer division.
10082 @item
10083 A double-word or a variable shift may give an incorrect result if executed
10084 while an integer multiplication is in progress.
10085 @item
10086 An integer division may give an incorrect result if started in a delay slot
10087 of a taken branch or a jump.
10088 @end itemize
10089
10090 @item -mfix-r4400
10091 @itemx -mno-fix-r4400
10092 @opindex mfix-r4400
10093 @opindex mno-fix-r4400
10094 Work around certain R4400 CPU errata:
10095 @itemize @minus
10096 @item
10097 A double-word or a variable shift may give an incorrect result if executed
10098 immediately after starting an integer division.
10099 @end itemize
10100
10101 @item -mfix-vr4120
10102 @itemx -mno-fix-vr4120
10103 @opindex mfix-vr4120
10104 Work around certain VR4120 errata:
10105 @itemize @minus
10106 @item
10107 @code{dmultu} does not always produce the correct result.
10108 @item
10109 @code{div} and @code{ddiv} do not always produce the correct result if one
10110 of the operands is negative.
10111 @end itemize
10112 The workarounds for the division errata rely on special functions in
10113 @file{libgcc.a}.  At present, these functions are only provided by
10114 the @code{mips64vr*-elf} configurations.
10115
10116 Other VR4120 errata require a nop to be inserted between certain pairs of
10117 instructions.  These errata are handled by the assembler, not by GCC itself.
10118
10119 @item -mfix-vr4130
10120 @opindex mfix-vr4130
10121 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10122 workarounds are implemented by the assembler rather than by GCC,
10123 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10124 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10125 instructions are available instead.
10126
10127 @item -mfix-sb1
10128 @itemx -mno-fix-sb1
10129 @opindex mfix-sb1
10130 Work around certain SB-1 CPU core errata.
10131 (This flag currently works around the SB-1 revision 2
10132 ``F1'' and ``F2'' floating point errata.)
10133
10134 @item -mflush-func=@var{func}
10135 @itemx -mno-flush-func
10136 @opindex mflush-func
10137 Specifies the function to call to flush the I and D caches, or to not
10138 call any such function.  If called, the function must take the same
10139 arguments as the common @code{_flush_func()}, that is, the address of the
10140 memory range for which the cache is being flushed, the size of the
10141 memory range, and the number 3 (to flush both caches).  The default
10142 depends on the target GCC was configured for, but commonly is either
10143 @samp{_flush_func} or @samp{__cpu_flush}.
10144
10145 @item -mbranch-likely
10146 @itemx -mno-branch-likely
10147 @opindex mbranch-likely
10148 @opindex mno-branch-likely
10149 Enable or disable use of Branch Likely instructions, regardless of the
10150 default for the selected architecture.  By default, Branch Likely
10151 instructions may be generated if they are supported by the selected
10152 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10153 and processors which implement those architectures; for those, Branch
10154 Likely instructions will not be generated by default because the MIPS32
10155 and MIPS64 architectures specifically deprecate their use.
10156
10157 @item -mfp-exceptions
10158 @itemx -mno-fp-exceptions
10159 @opindex mfp-exceptions
10160 Specifies whether FP exceptions are enabled.  This affects how we schedule
10161 FP instructions for some processors.  The default is that FP exceptions are
10162 enabled.
10163
10164 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10165 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10166 FP pipe.
10167
10168 @item -mvr4130-align
10169 @itemx -mno-vr4130-align
10170 @opindex mvr4130-align
10171 The VR4130 pipeline is two-way superscalar, but can only issue two
10172 instructions together if the first one is 8-byte aligned.  When this
10173 option is enabled, GCC will align pairs of instructions that it
10174 thinks should execute in parallel.
10175
10176 This option only has an effect when optimizing for the VR4130.
10177 It normally makes code faster, but at the expense of making it bigger.
10178 It is enabled by default at optimization level @option{-O3}.
10179 @end table
10180
10181 @node MMIX Options
10182 @subsection MMIX Options
10183 @cindex MMIX Options
10184
10185 These options are defined for the MMIX:
10186
10187 @table @gcctabopt
10188 @item -mlibfuncs
10189 @itemx -mno-libfuncs
10190 @opindex mlibfuncs
10191 @opindex mno-libfuncs
10192 Specify that intrinsic library functions are being compiled, passing all
10193 values in registers, no matter the size.
10194
10195 @item -mepsilon
10196 @itemx -mno-epsilon
10197 @opindex mepsilon
10198 @opindex mno-epsilon
10199 Generate floating-point comparison instructions that compare with respect
10200 to the @code{rE} epsilon register.
10201
10202 @item -mabi=mmixware
10203 @itemx -mabi=gnu
10204 @opindex mabi-mmixware
10205 @opindex mabi=gnu
10206 Generate code that passes function parameters and return values that (in
10207 the called function) are seen as registers @code{$0} and up, as opposed to
10208 the GNU ABI which uses global registers @code{$231} and up.
10209
10210 @item -mzero-extend
10211 @itemx -mno-zero-extend
10212 @opindex mzero-extend
10213 @opindex mno-zero-extend
10214 When reading data from memory in sizes shorter than 64 bits, use (do not
10215 use) zero-extending load instructions by default, rather than
10216 sign-extending ones.
10217
10218 @item -mknuthdiv
10219 @itemx -mno-knuthdiv
10220 @opindex mknuthdiv
10221 @opindex mno-knuthdiv
10222 Make the result of a division yielding a remainder have the same sign as
10223 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10224 remainder follows the sign of the dividend.  Both methods are
10225 arithmetically valid, the latter being almost exclusively used.
10226
10227 @item -mtoplevel-symbols
10228 @itemx -mno-toplevel-symbols
10229 @opindex mtoplevel-symbols
10230 @opindex mno-toplevel-symbols
10231 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10232 code can be used with the @code{PREFIX} assembly directive.
10233
10234 @item -melf
10235 @opindex melf
10236 Generate an executable in the ELF format, rather than the default
10237 @samp{mmo} format used by the @command{mmix} simulator.
10238
10239 @item -mbranch-predict
10240 @itemx -mno-branch-predict
10241 @opindex mbranch-predict
10242 @opindex mno-branch-predict
10243 Use (do not use) the probable-branch instructions, when static branch
10244 prediction indicates a probable branch.
10245
10246 @item -mbase-addresses
10247 @itemx -mno-base-addresses
10248 @opindex mbase-addresses
10249 @opindex mno-base-addresses
10250 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10251 base address automatically generates a request (handled by the assembler
10252 and the linker) for a constant to be set up in a global register.  The
10253 register is used for one or more base address requests within the range 0
10254 to 255 from the value held in the register.  The generally leads to short
10255 and fast code, but the number of different data items that can be
10256 addressed is limited.  This means that a program that uses lots of static
10257 data may require @option{-mno-base-addresses}.
10258
10259 @item -msingle-exit
10260 @itemx -mno-single-exit
10261 @opindex msingle-exit
10262 @opindex mno-single-exit
10263 Force (do not force) generated code to have a single exit point in each
10264 function.
10265 @end table
10266
10267 @node MN10300 Options
10268 @subsection MN10300 Options
10269 @cindex MN10300 options
10270
10271 These @option{-m} options are defined for Matsushita MN10300 architectures:
10272
10273 @table @gcctabopt
10274 @item -mmult-bug
10275 @opindex mmult-bug
10276 Generate code to avoid bugs in the multiply instructions for the MN10300
10277 processors.  This is the default.
10278
10279 @item -mno-mult-bug
10280 @opindex mno-mult-bug
10281 Do not generate code to avoid bugs in the multiply instructions for the
10282 MN10300 processors.
10283
10284 @item -mam33
10285 @opindex mam33
10286 Generate code which uses features specific to the AM33 processor.
10287
10288 @item -mno-am33
10289 @opindex mno-am33
10290 Do not generate code which uses features specific to the AM33 processor.  This
10291 is the default.
10292
10293 @item -mno-crt0
10294 @opindex mno-crt0
10295 Do not link in the C run-time initialization object file.
10296
10297 @item -mrelax
10298 @opindex mrelax
10299 Indicate to the linker that it should perform a relaxation optimization pass
10300 to shorten branches, calls and absolute memory addresses.  This option only
10301 has an effect when used on the command line for the final link step.
10302
10303 This option makes symbolic debugging impossible.
10304 @end table
10305
10306 @node NS32K Options
10307 @subsection NS32K Options
10308 @cindex NS32K options
10309
10310 These are the @samp{-m} options defined for the 32000 series.  The default
10311 values for these options depends on which style of 32000 was selected when
10312 the compiler was configured; the defaults for the most common choices are
10313 given below.
10314
10315 @table @gcctabopt
10316 @item -m32032
10317 @itemx -m32032
10318 @opindex m32032
10319 @opindex m32032
10320 Generate output for a 32032.  This is the default
10321 when the compiler is configured for 32032 and 32016 based systems.
10322
10323 @item -m32332
10324 @itemx -m32332
10325 @opindex m32332
10326 @opindex m32332
10327 Generate output for a 32332.  This is the default
10328 when the compiler is configured for 32332-based systems.
10329
10330 @item -m32532
10331 @itemx -m32532
10332 @opindex m32532
10333 @opindex m32532
10334 Generate output for a 32532.  This is the default
10335 when the compiler is configured for 32532-based systems.
10336
10337 @item -m32081
10338 @opindex m32081
10339 Generate output containing 32081 instructions for floating point.
10340 This is the default for all systems.
10341
10342 @item -m32381
10343 @opindex m32381
10344 Generate output containing 32381 instructions for floating point.  This
10345 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10346 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10347
10348 @item -mmulti-add
10349 @opindex mmulti-add
10350 Try and generate multiply-add floating point instructions @code{polyF}
10351 and @code{dotF}.  This option is only available if the @option{-m32381}
10352 option is in effect.  Using these instructions requires changes to
10353 register allocation which generally has a negative impact on
10354 performance.  This option should only be enabled when compiling code
10355 particularly likely to make heavy use of multiply-add instructions.
10356
10357 @item -mnomulti-add
10358 @opindex mnomulti-add
10359 Do not try and generate multiply-add floating point instructions
10360 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10361
10362 @item -msoft-float
10363 @opindex msoft-float
10364 Generate output containing library calls for floating point.
10365 @strong{Warning:} the requisite libraries may not be available.
10366
10367 @item -mieee-compare
10368 @itemx -mno-ieee-compare
10369 @opindex mieee-compare
10370 @opindex mno-ieee-compare
10371 Control whether or not the compiler uses IEEE floating point
10372 comparisons.  These handle correctly the case where the result of a
10373 comparison is unordered.
10374 @strong{Warning:} the requisite kernel support may not be available.
10375
10376 @item -mnobitfield
10377 @opindex mnobitfield
10378 Do not use the bit-field instructions.  On some machines it is faster to
10379 use shifting and masking operations.  This is the default for the pc532.
10380
10381 @item -mbitfield
10382 @opindex mbitfield
10383 Do use the bit-field instructions.  This is the default for all platforms
10384 except the pc532.
10385
10386 @item -mrtd
10387 @opindex mrtd
10388 Use a different function-calling convention, in which functions
10389 that take a fixed number of arguments return pop their
10390 arguments on return with the @code{ret} instruction.
10391
10392 This calling convention is incompatible with the one normally
10393 used on Unix, so you cannot use it if you need to call libraries
10394 compiled with the Unix compiler.
10395
10396 Also, you must provide function prototypes for all functions that
10397 take variable numbers of arguments (including @code{printf});
10398 otherwise incorrect code will be generated for calls to those
10399 functions.
10400
10401 In addition, seriously incorrect code will result if you call a
10402 function with too many arguments.  (Normally, extra arguments are
10403 harmlessly ignored.)
10404
10405 This option takes its name from the 680x0 @code{rtd} instruction.
10406
10407
10408 @item -mregparam
10409 @opindex mregparam
10410 Use a different function-calling convention where the first two arguments
10411 are passed in registers.
10412
10413 This calling convention is incompatible with the one normally
10414 used on Unix, so you cannot use it if you need to call libraries
10415 compiled with the Unix compiler.
10416
10417 @item -mnoregparam
10418 @opindex mnoregparam
10419 Do not pass any arguments in registers.  This is the default for all
10420 targets.
10421
10422 @item -msb
10423 @opindex msb
10424 It is OK to use the sb as an index register which is always loaded with
10425 zero.  This is the default for the pc532-netbsd target.
10426
10427 @item -mnosb
10428 @opindex mnosb
10429 The sb register is not available for use or has not been initialized to
10430 zero by the run time system.  This is the default for all targets except
10431 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10432 @option{-fpic} is set.
10433
10434 @item -mhimem
10435 @opindex mhimem
10436 Many ns32000 series addressing modes use displacements of up to 512MB@.
10437 If an address is above 512MB then displacements from zero can not be used.
10438 This option causes code to be generated which can be loaded above 512MB@.
10439 This may be useful for operating systems or ROM code.
10440
10441 @item -mnohimem
10442 @opindex mnohimem
10443 Assume code will be loaded in the first 512MB of virtual address space.
10444 This is the default for all platforms.
10445
10446 @end table
10447
10448 @node PDP-11 Options
10449 @subsection PDP-11 Options
10450 @cindex PDP-11 Options
10451
10452 These options are defined for the PDP-11:
10453
10454 @table @gcctabopt
10455 @item -mfpu
10456 @opindex mfpu
10457 Use hardware FPP floating point.  This is the default.  (FIS floating
10458 point on the PDP-11/40 is not supported.)
10459
10460 @item -msoft-float
10461 @opindex msoft-float
10462 Do not use hardware floating point.
10463
10464 @item -mac0
10465 @opindex mac0
10466 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10467
10468 @item -mno-ac0
10469 @opindex mno-ac0
10470 Return floating-point results in memory.  This is the default.
10471
10472 @item -m40
10473 @opindex m40
10474 Generate code for a PDP-11/40.
10475
10476 @item -m45
10477 @opindex m45
10478 Generate code for a PDP-11/45.  This is the default.
10479
10480 @item -m10
10481 @opindex m10
10482 Generate code for a PDP-11/10.
10483
10484 @item -mbcopy-builtin
10485 @opindex bcopy-builtin
10486 Use inline @code{movmemhi} patterns for copying memory.  This is the
10487 default.
10488
10489 @item -mbcopy
10490 @opindex mbcopy
10491 Do not use inline @code{movmemhi} patterns for copying memory.
10492
10493 @item -mint16
10494 @itemx -mno-int32
10495 @opindex mint16
10496 @opindex mno-int32
10497 Use 16-bit @code{int}.  This is the default.
10498
10499 @item -mint32
10500 @itemx -mno-int16
10501 @opindex mint32
10502 @opindex mno-int16
10503 Use 32-bit @code{int}.
10504
10505 @item -mfloat64
10506 @itemx -mno-float32
10507 @opindex mfloat64
10508 @opindex mno-float32
10509 Use 64-bit @code{float}.  This is the default.
10510
10511 @item -mfloat32
10512 @itemx -mno-float64
10513 @opindex mfloat32
10514 @opindex mno-float64
10515 Use 32-bit @code{float}.
10516
10517 @item -mabshi
10518 @opindex mabshi
10519 Use @code{abshi2} pattern.  This is the default.
10520
10521 @item -mno-abshi
10522 @opindex mno-abshi
10523 Do not use @code{abshi2} pattern.
10524
10525 @item -mbranch-expensive
10526 @opindex mbranch-expensive
10527 Pretend that branches are expensive.  This is for experimenting with
10528 code generation only.
10529
10530 @item -mbranch-cheap
10531 @opindex mbranch-cheap
10532 Do not pretend that branches are expensive.  This is the default.
10533
10534 @item -msplit
10535 @opindex msplit
10536 Generate code for a system with split I&D@.
10537
10538 @item -mno-split
10539 @opindex mno-split
10540 Generate code for a system without split I&D@.  This is the default.
10541
10542 @item -munix-asm
10543 @opindex munix-asm
10544 Use Unix assembler syntax.  This is the default when configured for
10545 @samp{pdp11-*-bsd}.
10546
10547 @item -mdec-asm
10548 @opindex mdec-asm
10549 Use DEC assembler syntax.  This is the default when configured for any
10550 PDP-11 target other than @samp{pdp11-*-bsd}.
10551 @end table
10552
10553 @node PowerPC Options
10554 @subsection PowerPC Options
10555 @cindex PowerPC options
10556
10557 These are listed under @xref{RS/6000 and PowerPC Options}.
10558
10559 @node RS/6000 and PowerPC Options
10560 @subsection IBM RS/6000 and PowerPC Options
10561 @cindex RS/6000 and PowerPC Options
10562 @cindex IBM RS/6000 and PowerPC Options
10563
10564 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10565 @table @gcctabopt
10566 @item -mpower
10567 @itemx -mno-power
10568 @itemx -mpower2
10569 @itemx -mno-power2
10570 @itemx -mpowerpc
10571 @itemx -mno-powerpc
10572 @itemx -mpowerpc-gpopt
10573 @itemx -mno-powerpc-gpopt
10574 @itemx -mpowerpc-gfxopt
10575 @itemx -mno-powerpc-gfxopt
10576 @itemx -mpowerpc64
10577 @itemx -mno-powerpc64
10578 @opindex mpower
10579 @opindex mno-power
10580 @opindex mpower2
10581 @opindex mno-power2
10582 @opindex mpowerpc
10583 @opindex mno-powerpc
10584 @opindex mpowerpc-gpopt
10585 @opindex mno-powerpc-gpopt
10586 @opindex mpowerpc-gfxopt
10587 @opindex mno-powerpc-gfxopt
10588 @opindex mpowerpc64
10589 @opindex mno-powerpc64
10590 GCC supports two related instruction set architectures for the
10591 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10592 instructions supported by the @samp{rios} chip set used in the original
10593 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10594 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10595 the IBM 4xx microprocessors.
10596
10597 Neither architecture is a subset of the other.  However there is a
10598 large common subset of instructions supported by both.  An MQ
10599 register is included in processors supporting the POWER architecture.
10600
10601 You use these options to specify which instructions are available on the
10602 processor you are using.  The default value of these options is
10603 determined when configuring GCC@.  Specifying the
10604 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10605 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10606 rather than the options listed above.
10607
10608 The @option{-mpower} option allows GCC to generate instructions that
10609 are found only in the POWER architecture and to use the MQ register.
10610 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10611 to generate instructions that are present in the POWER2 architecture but
10612 not the original POWER architecture.
10613
10614 The @option{-mpowerpc} option allows GCC to generate instructions that
10615 are found only in the 32-bit subset of the PowerPC architecture.
10616 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10617 GCC to use the optional PowerPC architecture instructions in the
10618 General Purpose group, including floating-point square root.  Specifying
10619 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10620 use the optional PowerPC architecture instructions in the Graphics
10621 group, including floating-point select.
10622
10623 The @option{-mpowerpc64} option allows GCC to generate the additional
10624 64-bit instructions that are found in the full PowerPC64 architecture
10625 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10626 @option{-mno-powerpc64}.
10627
10628 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10629 will use only the instructions in the common subset of both
10630 architectures plus some special AIX common-mode calls, and will not use
10631 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10632 permits GCC to use any instruction from either architecture and to
10633 allow use of the MQ register; specify this for the Motorola MPC601.
10634
10635 @item -mnew-mnemonics
10636 @itemx -mold-mnemonics
10637 @opindex mnew-mnemonics
10638 @opindex mold-mnemonics
10639 Select which mnemonics to use in the generated assembler code.  With
10640 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10641 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10642 assembler mnemonics defined for the POWER architecture.  Instructions
10643 defined in only one architecture have only one mnemonic; GCC uses that
10644 mnemonic irrespective of which of these options is specified.
10645
10646 GCC defaults to the mnemonics appropriate for the architecture in
10647 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10648 value of these option.  Unless you are building a cross-compiler, you
10649 should normally not specify either @option{-mnew-mnemonics} or
10650 @option{-mold-mnemonics}, but should instead accept the default.
10651
10652 @item -mcpu=@var{cpu_type}
10653 @opindex mcpu
10654 Set architecture type, register usage, choice of mnemonics, and
10655 instruction scheduling parameters for machine type @var{cpu_type}.
10656 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10657 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10658 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10659 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10660 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10661 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10662 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10663 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10664 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10665
10666 @option{-mcpu=common} selects a completely generic processor.  Code
10667 generated under this option will run on any POWER or PowerPC processor.
10668 GCC will use only the instructions in the common subset of both
10669 architectures, and will not use the MQ register.  GCC assumes a generic
10670 processor model for scheduling purposes.
10671
10672 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10673 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10674 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10675 types, with an appropriate, generic processor model assumed for
10676 scheduling purposes.
10677
10678 The other options specify a specific processor.  Code generated under
10679 those options will run best on that processor, and may not run at all on
10680 others.
10681
10682 The @option{-mcpu} options automatically enable or disable the
10683 following options: @option{-maltivec}, @option{-mhard-float},
10684 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10685 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10686 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10687 @option{-mstring}.  The particular options set for any particular CPU
10688 will vary between compiler versions, depending on what setting seems
10689 to produce optimal code for that CPU; it doesn't necessarily reflect
10690 the actual hardware's capabilities.  If you wish to set an individual
10691 option to a particular value, you may specify it after the
10692 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10693
10694 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10695 not enabled or disabled by the @option{-mcpu} option at present, since
10696 AIX does not have full support for these options.  You may still
10697 enable or disable them individually if you're sure it'll work in your
10698 environment.
10699
10700 @item -mtune=@var{cpu_type}
10701 @opindex mtune
10702 Set the instruction scheduling parameters for machine type
10703 @var{cpu_type}, but do not set the architecture type, register usage, or
10704 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10705 values for @var{cpu_type} are used for @option{-mtune} as for
10706 @option{-mcpu}.  If both are specified, the code generated will use the
10707 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10708 scheduling parameters set by @option{-mtune}.
10709
10710 @item -maltivec
10711 @itemx -mno-altivec
10712 @opindex maltivec
10713 @opindex mno-altivec
10714 Generate code that uses (does not use) AltiVec instructions, and also
10715 enable the use of built-in functions that allow more direct access to
10716 the AltiVec instruction set.  You may also need to set
10717 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10718 enhancements.
10719
10720 @item -mvrsave
10721 @item -mno-vrsave
10722 @opindex mvrsave
10723 @opindex mno-vrsave
10724 Generate VRSAVE instructions when generating AltiVec code.
10725
10726 @item -mabi=spe
10727 @opindex mabi=spe
10728 Extend the current ABI with SPE ABI extensions.  This does not change
10729 the default ABI, instead it adds the SPE ABI extensions to the current
10730 ABI@.
10731
10732 @item -mabi=no-spe
10733 @opindex mabi=no-spe
10734 Disable Booke SPE ABI extensions for the current ABI@.
10735
10736 @item -misel
10737 @itemx -mno-isel
10738 @opindex misel
10739 @opindex mno-isel
10740 This switch enables or disables the generation of ISEL instructions.
10741
10742 @item -misel=@var{yes/no}
10743 This switch has been deprecated.  Use @option{-misel} and
10744 @option{-mno-isel} instead.
10745
10746 @item -mspe
10747 @itemx -mno-isel
10748 @opindex mspe
10749 @opindex mno-spe
10750 This switch enables or disables the generation of SPE simd
10751 instructions.
10752
10753 @item -mspe=@var{yes/no}
10754 This option has been deprecated.  Use @option{-mspe} and
10755 @option{-mno-spe} instead.
10756
10757 @item -mfloat-gprs=@var{yes/single/double/no}
10758 @itemx -mfloat-gprs
10759 @opindex mfloat-gprs
10760 This switch enables or disables the generation of floating point
10761 operations on the general purpose registers for architectures that
10762 support it.
10763
10764 The argument @var{yes} or @var{single} enables the use of
10765 single-precision floating point operations.
10766
10767 The argument @var{double} enables the use of single and
10768 double-precision floating point operations.
10769
10770 The argument @var{no} disables floating point operations on the
10771 general purpose registers.
10772
10773 This option is currently only available on the MPC854x.
10774
10775 @item -m32
10776 @itemx -m64
10777 @opindex m32
10778 @opindex m64
10779 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10780 targets (including GNU/Linux).  The 32-bit environment sets int, long
10781 and pointer to 32 bits and generates code that runs on any PowerPC
10782 variant.  The 64-bit environment sets int to 32 bits and long and
10783 pointer to 64 bits, and generates code for PowerPC64, as for
10784 @option{-mpowerpc64}.
10785
10786 @item -mfull-toc
10787 @itemx -mno-fp-in-toc
10788 @itemx -mno-sum-in-toc
10789 @itemx -mminimal-toc
10790 @opindex mfull-toc
10791 @opindex mno-fp-in-toc
10792 @opindex mno-sum-in-toc
10793 @opindex mminimal-toc
10794 Modify generation of the TOC (Table Of Contents), which is created for
10795 every executable file.  The @option{-mfull-toc} option is selected by
10796 default.  In that case, GCC will allocate at least one TOC entry for
10797 each unique non-automatic variable reference in your program.  GCC
10798 will also place floating-point constants in the TOC@.  However, only
10799 16,384 entries are available in the TOC@.
10800
10801 If you receive a linker error message that saying you have overflowed
10802 the available TOC space, you can reduce the amount of TOC space used
10803 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10804 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10805 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10806 generate code to calculate the sum of an address and a constant at
10807 run-time instead of putting that sum into the TOC@.  You may specify one
10808 or both of these options.  Each causes GCC to produce very slightly
10809 slower and larger code at the expense of conserving TOC space.
10810
10811 If you still run out of space in the TOC even when you specify both of
10812 these options, specify @option{-mminimal-toc} instead.  This option causes
10813 GCC to make only one TOC entry for every file.  When you specify this
10814 option, GCC will produce code that is slower and larger but which
10815 uses extremely little TOC space.  You may wish to use this option
10816 only on files that contain less frequently executed code.
10817
10818 @item -maix64
10819 @itemx -maix32
10820 @opindex maix64
10821 @opindex maix32
10822 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10823 @code{long} type, and the infrastructure needed to support them.
10824 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10825 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10826 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10827
10828 @item -mxl-compat
10829 @itemx -mno-xl-compat
10830 @opindex mxl-compat
10831 @opindex mno-xl-compat
10832 Produce code that conforms more closely to IBM XLC semantics when using
10833 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10834 functions beyond the register save area (RSA) on the stack in addition
10835 to argument FPRs.  Do not assume that most significant double in 128
10836 bit long double value is properly rounded when comparing values.
10837
10838 The AIX calling convention was extended but not initially documented to
10839 handle an obscure K&R C case of calling a function that takes the
10840 address of its arguments with fewer arguments than declared.  AIX XL
10841 compilers access floating point arguments which do not fit in the
10842 RSA from the stack when a subroutine is compiled without
10843 optimization.  Because always storing floating-point arguments on the
10844 stack is inefficient and rarely needed, this option is not enabled by
10845 default and only is necessary when calling subroutines compiled by AIX
10846 XL compilers without optimization.
10847
10848 @item -mpe
10849 @opindex mpe
10850 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10851 application written to use message passing with special startup code to
10852 enable the application to run.  The system must have PE installed in the
10853 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10854 must be overridden with the @option{-specs=} option to specify the
10855 appropriate directory location.  The Parallel Environment does not
10856 support threads, so the @option{-mpe} option and the @option{-pthread}
10857 option are incompatible.
10858
10859 @item -malign-natural
10860 @itemx -malign-power
10861 @opindex malign-natural
10862 @opindex malign-power
10863 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10864 @option{-malign-natural} overrides the ABI-defined alignment of larger
10865 types, such as floating-point doubles, on their natural size-based boundary.
10866 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10867 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10868
10869 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10870 is not supported.
10871
10872 @item -msoft-float
10873 @itemx -mhard-float
10874 @opindex msoft-float
10875 @opindex mhard-float
10876 Generate code that does not use (uses) the floating-point register set.
10877 Software floating point emulation is provided if you use the
10878 @option{-msoft-float} option, and pass the option to GCC when linking.
10879
10880 @item -mmultiple
10881 @itemx -mno-multiple
10882 @opindex mmultiple
10883 @opindex mno-multiple
10884 Generate code that uses (does not use) the load multiple word
10885 instructions and the store multiple word instructions.  These
10886 instructions are generated by default on POWER systems, and not
10887 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10888 endian PowerPC systems, since those instructions do not work when the
10889 processor is in little endian mode.  The exceptions are PPC740 and
10890 PPC750 which permit the instructions usage in little endian mode.
10891
10892 @item -mstring
10893 @itemx -mno-string
10894 @opindex mstring
10895 @opindex mno-string
10896 Generate code that uses (does not use) the load string instructions
10897 and the store string word instructions to save multiple registers and
10898 do small block moves.  These instructions are generated by default on
10899 POWER systems, and not generated on PowerPC systems.  Do not use
10900 @option{-mstring} on little endian PowerPC systems, since those
10901 instructions do not work when the processor is in little endian mode.
10902 The exceptions are PPC740 and PPC750 which permit the instructions
10903 usage in little endian mode.
10904
10905 @item -mupdate
10906 @itemx -mno-update
10907 @opindex mupdate
10908 @opindex mno-update
10909 Generate code that uses (does not use) the load or store instructions
10910 that update the base register to the address of the calculated memory
10911 location.  These instructions are generated by default.  If you use
10912 @option{-mno-update}, there is a small window between the time that the
10913 stack pointer is updated and the address of the previous frame is
10914 stored, which means code that walks the stack frame across interrupts or
10915 signals may get corrupted data.
10916
10917 @item -mfused-madd
10918 @itemx -mno-fused-madd
10919 @opindex mfused-madd
10920 @opindex mno-fused-madd
10921 Generate code that uses (does not use) the floating point multiply and
10922 accumulate instructions.  These instructions are generated by default if
10923 hardware floating is used.
10924
10925 @item -mno-bit-align
10926 @itemx -mbit-align
10927 @opindex mno-bit-align
10928 @opindex mbit-align
10929 On System V.4 and embedded PowerPC systems do not (do) force structures
10930 and unions that contain bit-fields to be aligned to the base type of the
10931 bit-field.
10932
10933 For example, by default a structure containing nothing but 8
10934 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10935 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10936 the structure would be aligned to a 1 byte boundary and be one byte in
10937 size.
10938
10939 @item -mno-strict-align
10940 @itemx -mstrict-align
10941 @opindex mno-strict-align
10942 @opindex mstrict-align
10943 On System V.4 and embedded PowerPC systems do not (do) assume that
10944 unaligned memory references will be handled by the system.
10945
10946 @item -mrelocatable
10947 @itemx -mno-relocatable
10948 @opindex mrelocatable
10949 @opindex mno-relocatable
10950 On embedded PowerPC systems generate code that allows (does not allow)
10951 the program to be relocated to a different address at runtime.  If you
10952 use @option{-mrelocatable} on any module, all objects linked together must
10953 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10954
10955 @item -mrelocatable-lib
10956 @itemx -mno-relocatable-lib
10957 @opindex mrelocatable-lib
10958 @opindex mno-relocatable-lib
10959 On embedded PowerPC systems generate code that allows (does not allow)
10960 the program to be relocated to a different address at runtime.  Modules
10961 compiled with @option{-mrelocatable-lib} can be linked with either modules
10962 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10963 with modules compiled with the @option{-mrelocatable} options.
10964
10965 @item -mno-toc
10966 @itemx -mtoc
10967 @opindex mno-toc
10968 @opindex mtoc
10969 On System V.4 and embedded PowerPC systems do not (do) assume that
10970 register 2 contains a pointer to a global area pointing to the addresses
10971 used in the program.
10972
10973 @item -mlittle
10974 @itemx -mlittle-endian
10975 @opindex mlittle
10976 @opindex mlittle-endian
10977 On System V.4 and embedded PowerPC systems compile code for the
10978 processor in little endian mode.  The @option{-mlittle-endian} option is
10979 the same as @option{-mlittle}.
10980
10981 @item -mbig
10982 @itemx -mbig-endian
10983 @opindex mbig
10984 @opindex mbig-endian
10985 On System V.4 and embedded PowerPC systems compile code for the
10986 processor in big endian mode.  The @option{-mbig-endian} option is
10987 the same as @option{-mbig}.
10988
10989 @item -mdynamic-no-pic
10990 @opindex mdynamic-no-pic
10991 On Darwin and Mac OS X systems, compile code so that it is not
10992 relocatable, but that its external references are relocatable.  The
10993 resulting code is suitable for applications, but not shared
10994 libraries.
10995
10996 @item -mprioritize-restricted-insns=@var{priority}
10997 @opindex mprioritize-restricted-insns
10998 This option controls the priority that is assigned to
10999 dispatch-slot restricted instructions during the second scheduling
11000 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11001 @var{no/highest/second-highest} priority to dispatch slot restricted
11002 instructions.
11003
11004 @item -msched-costly-dep=@var{dependence_type}
11005 @opindex msched-costly-dep
11006 This option controls which dependences are considered costly
11007 by the target during instruction scheduling.  The argument
11008 @var{dependence_type} takes one of the following values:
11009 @var{no}: no dependence is costly,
11010 @var{all}: all dependences are costly,
11011 @var{true_store_to_load}: a true dependence from store to load is costly,
11012 @var{store_to_load}: any dependence from store to load is costly,
11013 @var{number}: any dependence which latency >= @var{number} is costly.
11014
11015 @item -minsert-sched-nops=@var{scheme}
11016 @opindex minsert-sched-nops
11017 This option controls which nop insertion scheme will be used during
11018 the second scheduling pass.  The argument @var{scheme} takes one of the
11019 following values:
11020 @var{no}: Don't insert nops.
11021 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11022 according to the scheduler's grouping.
11023 @var{regroup_exact}: Insert nops to force costly dependent insns into
11024 separate groups.  Insert exactly as many nops as needed to force an insn
11025 to a new group, according to the estimated processor grouping.
11026 @var{number}: Insert nops to force costly dependent insns into
11027 separate groups.  Insert @var{number} nops to force an insn to a new group.
11028
11029 @item -mcall-sysv
11030 @opindex mcall-sysv
11031 On System V.4 and embedded PowerPC systems compile code using calling
11032 conventions that adheres to the March 1995 draft of the System V
11033 Application Binary Interface, PowerPC processor supplement.  This is the
11034 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11035
11036 @item -mcall-sysv-eabi
11037 @opindex mcall-sysv-eabi
11038 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11039
11040 @item -mcall-sysv-noeabi
11041 @opindex mcall-sysv-noeabi
11042 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11043
11044 @item -mcall-solaris
11045 @opindex mcall-solaris
11046 On System V.4 and embedded PowerPC systems compile code for the Solaris
11047 operating system.
11048
11049 @item -mcall-linux
11050 @opindex mcall-linux
11051 On System V.4 and embedded PowerPC systems compile code for the
11052 Linux-based GNU system.
11053
11054 @item -mcall-gnu
11055 @opindex mcall-gnu
11056 On System V.4 and embedded PowerPC systems compile code for the
11057 Hurd-based GNU system.
11058
11059 @item -mcall-netbsd
11060 @opindex mcall-netbsd
11061 On System V.4 and embedded PowerPC systems compile code for the
11062 NetBSD operating system.
11063
11064 @item -maix-struct-return
11065 @opindex maix-struct-return
11066 Return all structures in memory (as specified by the AIX ABI)@.
11067
11068 @item -msvr4-struct-return
11069 @opindex msvr4-struct-return
11070 Return structures smaller than 8 bytes in registers (as specified by the
11071 SVR4 ABI)@.
11072
11073 @item -mabi=@var{abi-type}
11074 @opindex mabi
11075 Extend the current ABI with a particular extension, or remove such extension.
11076 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11077 @var{no-spe}@.
11078
11079 @item -mprototype
11080 @itemx -mno-prototype
11081 @opindex mprototype
11082 @opindex mno-prototype
11083 On System V.4 and embedded PowerPC systems assume that all calls to
11084 variable argument functions are properly prototyped.  Otherwise, the
11085 compiler must insert an instruction before every non prototyped call to
11086 set or clear bit 6 of the condition code register (@var{CR}) to
11087 indicate whether floating point values were passed in the floating point
11088 registers in case the function takes a variable arguments.  With
11089 @option{-mprototype}, only calls to prototyped variable argument functions
11090 will set or clear the bit.
11091
11092 @item -msim
11093 @opindex msim
11094 On embedded PowerPC systems, assume that the startup module is called
11095 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11096 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11097 configurations.
11098
11099 @item -mmvme
11100 @opindex mmvme
11101 On embedded PowerPC systems, assume that the startup module is called
11102 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11103 @file{libc.a}.
11104
11105 @item -mads
11106 @opindex mads
11107 On embedded PowerPC systems, assume that the startup module is called
11108 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11109 @file{libc.a}.
11110
11111 @item -myellowknife
11112 @opindex myellowknife
11113 On embedded PowerPC systems, assume that the startup module is called
11114 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11115 @file{libc.a}.
11116
11117 @item -mvxworks
11118 @opindex mvxworks
11119 On System V.4 and embedded PowerPC systems, specify that you are
11120 compiling for a VxWorks system.
11121
11122 @item -mwindiss
11123 @opindex mwindiss
11124 Specify that you are compiling for the WindISS simulation environment.
11125
11126 @item -memb
11127 @opindex memb
11128 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11129 header to indicate that @samp{eabi} extended relocations are used.
11130
11131 @item -meabi
11132 @itemx -mno-eabi
11133 @opindex meabi
11134 @opindex mno-eabi
11135 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11136 Embedded Applications Binary Interface (eabi) which is a set of
11137 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11138 means that the stack is aligned to an 8 byte boundary, a function
11139 @code{__eabi} is called to from @code{main} to set up the eabi
11140 environment, and the @option{-msdata} option can use both @code{r2} and
11141 @code{r13} to point to two separate small data areas.  Selecting
11142 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11143 do not call an initialization function from @code{main}, and the
11144 @option{-msdata} option will only use @code{r13} to point to a single
11145 small data area.  The @option{-meabi} option is on by default if you
11146 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11147
11148 @item -msdata=eabi
11149 @opindex msdata=eabi
11150 On System V.4 and embedded PowerPC systems, put small initialized
11151 @code{const} global and static data in the @samp{.sdata2} section, which
11152 is pointed to by register @code{r2}.  Put small initialized
11153 non-@code{const} global and static data in the @samp{.sdata} section,
11154 which is pointed to by register @code{r13}.  Put small uninitialized
11155 global and static data in the @samp{.sbss} section, which is adjacent to
11156 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11157 incompatible with the @option{-mrelocatable} option.  The
11158 @option{-msdata=eabi} option also sets the @option{-memb} option.
11159
11160 @item -msdata=sysv
11161 @opindex msdata=sysv
11162 On System V.4 and embedded PowerPC systems, put small global and static
11163 data in the @samp{.sdata} section, which is pointed to by register
11164 @code{r13}.  Put small uninitialized global and static data in the
11165 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11166 The @option{-msdata=sysv} option is incompatible with the
11167 @option{-mrelocatable} option.
11168
11169 @item -msdata=default
11170 @itemx -msdata
11171 @opindex msdata=default
11172 @opindex msdata
11173 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11174 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11175 same as @option{-msdata=sysv}.
11176
11177 @item -msdata-data
11178 @opindex msdata-data
11179 On System V.4 and embedded PowerPC systems, put small global and static
11180 data in the @samp{.sdata} section.  Put small uninitialized global and
11181 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11182 to address small data however.  This is the default behavior unless
11183 other @option{-msdata} options are used.
11184
11185 @item -msdata=none
11186 @itemx -mno-sdata
11187 @opindex msdata=none
11188 @opindex mno-sdata
11189 On embedded PowerPC systems, put all initialized global and static data
11190 in the @samp{.data} section, and all uninitialized data in the
11191 @samp{.bss} section.
11192
11193 @item -G @var{num}
11194 @opindex G
11195 @cindex smaller data references (PowerPC)
11196 @cindex .sdata/.sdata2 references (PowerPC)
11197 On embedded PowerPC systems, put global and static items less than or
11198 equal to @var{num} bytes into the small data or bss sections instead of
11199 the normal data or bss section.  By default, @var{num} is 8.  The
11200 @option{-G @var{num}} switch is also passed to the linker.
11201 All modules should be compiled with the same @option{-G @var{num}} value.
11202
11203 @item -mregnames
11204 @itemx -mno-regnames
11205 @opindex mregnames
11206 @opindex mno-regnames
11207 On System V.4 and embedded PowerPC systems do (do not) emit register
11208 names in the assembly language output using symbolic forms.
11209
11210 @item -mlongcall
11211 @itemx -mno-longcall
11212 @opindex mlongcall
11213 @opindex mno-longcall
11214 Default to making all function calls indirectly, using a register, so
11215 that functions which reside further than 32 megabytes (33,554,432
11216 bytes) from the current location can be called.  This setting can be
11217 overridden by the @code{shortcall} function attribute, or by
11218 @code{#pragma longcall(0)}.
11219
11220 Some linkers are capable of detecting out-of-range calls and generating
11221 glue code on the fly.  On these systems, long calls are unnecessary and
11222 generate slower code.  As of this writing, the AIX linker can do this,
11223 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11224 to the GNU linker for 32-bit PowerPC systems as well.
11225
11226 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11227 callee, L42'', plus a ``branch island'' (glue code).  The two target
11228 addresses represent the callee and the ``branch island''.  The
11229 Darwin/PPC linker will prefer the first address and generate a ``bl
11230 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11231 otherwise, the linker will generate ``bl L42'' to call the ``branch
11232 island''.  The ``branch island'' is appended to the body of the
11233 calling function; it computes the full 32-bit address of the callee
11234 and jumps to it.
11235
11236 On Mach-O (Darwin) systems, this option directs the compiler emit to
11237 the glue for every direct call, and the Darwin linker decides whether
11238 to use or discard it.
11239
11240 In the future, we may cause GCC to ignore all longcall specifications
11241 when the linker is known to generate glue.
11242
11243 @item -pthread
11244 @opindex pthread
11245 Adds support for multithreading with the @dfn{pthreads} library.
11246 This option sets flags for both the preprocessor and linker.
11247
11248 @end table
11249
11250 @node S/390 and zSeries Options
11251 @subsection S/390 and zSeries Options
11252 @cindex S/390 and zSeries Options
11253
11254 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11255
11256 @table @gcctabopt
11257 @item -mhard-float
11258 @itemx -msoft-float
11259 @opindex mhard-float
11260 @opindex msoft-float
11261 Use (do not use) the hardware floating-point instructions and registers
11262 for floating-point operations.  When @option{-msoft-float} is specified,
11263 functions in @file{libgcc.a} will be used to perform floating-point
11264 operations.  When @option{-mhard-float} is specified, the compiler
11265 generates IEEE floating-point instructions.  This is the default.
11266
11267 @item -mbackchain
11268 @itemx -mno-backchain
11269 @opindex mbackchain
11270 @opindex mno-backchain
11271 Store (do not store) the address of the caller's frame as backchain pointer
11272 into the callee's stack frame.
11273 A backchain may be needed to allow debugging using tools that do not understand
11274 DWARF-2 call frame information.
11275 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11276 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11277 the backchain is placed into the topmost word of the 96/160 byte register
11278 save area.
11279
11280 In general, code compiled with @option{-mbackchain} is call-compatible with
11281 code compiled with @option{-mmo-backchain}; however, use of the backchain
11282 for debugging purposes usually requires that the whole binary is built with
11283 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11284 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11285 to build a linux kernel use @option{-msoft-float}.
11286
11287 The default is to not maintain the backchain.
11288
11289 @item -mpacked-stack
11290 @item -mno-packed-stack
11291 @opindex mpacked-stack
11292 @opindex mno-packed-stack
11293 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11294 specified, the compiler uses the all fields of the 96/160 byte register save
11295 area only for their default purpose; unused fields still take up stack space.
11296 When @option{-mpacked-stack} is specified, register save slots are densely
11297 packed at the top of the register save area; unused space is reused for other
11298 purposes, allowing for more efficient use of the available stack space.
11299 However, when @option{-mbackchain} is also in effect, the topmost word of
11300 the save area is always used to store the backchain, and the return address
11301 register is always saved two words below the backchain.
11302
11303 As long as the stack frame backchain is not used, code generated with
11304 @option{-mpacked-stack} is call-compatible with code generated with
11305 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11306 S/390 or zSeries generated code that uses the stack frame backchain at run
11307 time, not just for debugging purposes.  Such code is not call-compatible
11308 with code compiled with @option{-mpacked-stack}.  Also, note that the
11309 combination of @option{-mbackchain},
11310 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11311 to build a linux kernel use @option{-msoft-float}.
11312
11313 The default is to not use the packed stack layout.
11314
11315 @item -msmall-exec
11316 @itemx -mno-small-exec
11317 @opindex msmall-exec
11318 @opindex mno-small-exec
11319 Generate (or do not generate) code using the @code{bras} instruction
11320 to do subroutine calls.
11321 This only works reliably if the total executable size does not
11322 exceed 64k.  The default is to use the @code{basr} instruction instead,
11323 which does not have this limitation.
11324
11325 @item -m64
11326 @itemx -m31
11327 @opindex m64
11328 @opindex m31
11329 When @option{-m31} is specified, generate code compliant to the
11330 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11331 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11332 particular to generate 64-bit instructions.  For the @samp{s390}
11333 targets, the default is @option{-m31}, while the @samp{s390x}
11334 targets default to @option{-m64}.
11335
11336 @item -mzarch
11337 @itemx -mesa
11338 @opindex mzarch
11339 @opindex mesa
11340 When @option{-mzarch} is specified, generate code using the
11341 instructions available on z/Architecture.
11342 When @option{-mesa} is specified, generate code using the
11343 instructions available on ESA/390.  Note that @option{-mesa} is
11344 not possible with @option{-m64}.
11345 When generating code compliant to the GNU/Linux for S/390 ABI,
11346 the default is @option{-mesa}.  When generating code compliant
11347 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11348
11349 @item -mmvcle
11350 @itemx -mno-mvcle
11351 @opindex mmvcle
11352 @opindex mno-mvcle
11353 Generate (or do not generate) code using the @code{mvcle} instruction
11354 to perform block moves.  When @option{-mno-mvcle} is specified,
11355 use a @code{mvc} loop instead.  This is the default.
11356
11357 @item -mdebug
11358 @itemx -mno-debug
11359 @opindex mdebug
11360 @opindex mno-debug
11361 Print (or do not print) additional debug information when compiling.
11362 The default is to not print debug information.
11363
11364 @item -march=@var{cpu-type}
11365 @opindex march
11366 Generate code that will run on @var{cpu-type}, which is the name of a system
11367 representing a certain processor type.  Possible values for
11368 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11369 When generating code using the instructions available on z/Architecture,
11370 the default is @option{-march=z900}.  Otherwise, the default is
11371 @option{-march=g5}.
11372
11373 @item -mtune=@var{cpu-type}
11374 @opindex mtune
11375 Tune to @var{cpu-type} everything applicable about the generated code,
11376 except for the ABI and the set of available instructions.
11377 The list of @var{cpu-type} values is the same as for @option{-march}.
11378 The default is the value used for @option{-march}.
11379
11380 @item -mtpf-trace
11381 @itemx -mno-tpf-trace
11382 @opindex mtpf-trace
11383 @opindex mno-tpf-trace
11384 Generate code that adds (does not add) in TPF OS specific branches to trace
11385 routines in the operating system.  This option is off by default, even
11386 when compiling for the TPF OS@.
11387
11388 @item -mfused-madd
11389 @itemx -mno-fused-madd
11390 @opindex mfused-madd
11391 @opindex mno-fused-madd
11392 Generate code that uses (does not use) the floating point multiply and
11393 accumulate instructions.  These instructions are generated by default if
11394 hardware floating point is used.
11395
11396 @item -mwarn-framesize=@var{framesize}
11397 @opindex mwarn-framesize
11398 Emit a warning if the current function exceeds the given frame size.  Because
11399 this is a compile time check it doesn't need to be a real problem when the program
11400 runs.  It is intended to identify functions which most probably cause
11401 a stack overflow.  It is useful to be used in an environment with limited stack
11402 size e.g.@: the linux kernel.
11403
11404 @item -mwarn-dynamicstack
11405 @opindex mwarn-dynamicstack
11406 Emit a warning if the function calls alloca or uses dynamically
11407 sized arrays.  This is generally a bad idea with a limited stack size.
11408
11409 @item -mstack-guard=@var{stack-guard}
11410 @item -mstack-size=@var{stack-size}
11411 @opindex mstack-guard
11412 @opindex mstack-size
11413 These arguments always have to be used in conjunction.  If they are present the s390
11414 back end emits additional instructions in the function prologue which trigger a trap
11415 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11416 (remember that the stack on s390 grows downward).  These options are intended to
11417 be used to help debugging stack overflow problems.  The additionally emitted code
11418 cause only little overhead and hence can also be used in production like systems
11419 without greater performance degradation.  The given values have to be exact
11420 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11421 In order to be efficient the extra code makes the assumption that the stack starts
11422 at an address aligned to the value given by @var{stack-size}.
11423 @end table
11424
11425 @node SH Options
11426 @subsection SH Options
11427
11428 These @samp{-m} options are defined for the SH implementations:
11429
11430 @table @gcctabopt
11431 @item -m1
11432 @opindex m1
11433 Generate code for the SH1.
11434
11435 @item -m2
11436 @opindex m2
11437 Generate code for the SH2.
11438
11439 @item -m2e
11440 Generate code for the SH2e.
11441
11442 @item -m3
11443 @opindex m3
11444 Generate code for the SH3.
11445
11446 @item -m3e
11447 @opindex m3e
11448 Generate code for the SH3e.
11449
11450 @item -m4-nofpu
11451 @opindex m4-nofpu
11452 Generate code for the SH4 without a floating-point unit.
11453
11454 @item -m4-single-only
11455 @opindex m4-single-only
11456 Generate code for the SH4 with a floating-point unit that only
11457 supports single-precision arithmetic.
11458
11459 @item -m4-single
11460 @opindex m4-single
11461 Generate code for the SH4 assuming the floating-point unit is in
11462 single-precision mode by default.
11463
11464 @item -m4
11465 @opindex m4
11466 Generate code for the SH4.
11467
11468 @item -m4a-nofpu
11469 @opindex m4a-nofpu
11470 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11471 floating-point unit is not used.
11472
11473 @item -m4a-single-only
11474 @opindex m4a-single-only
11475 Generate code for the SH4a, in such a way that no double-precision
11476 floating point operations are used.
11477
11478 @item -m4a-single
11479 @opindex m4a-single
11480 Generate code for the SH4a assuming the floating-point unit is in
11481 single-precision mode by default.
11482
11483 @item -m4a
11484 @opindex m4a
11485 Generate code for the SH4a.
11486
11487 @item -m4al
11488 @opindex m4al
11489 Same as @option{-m4a-nofpu}, except that it implicitly passes
11490 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11491 instructions at the moment.
11492
11493 @item -mb
11494 @opindex mb
11495 Compile code for the processor in big endian mode.
11496
11497 @item -ml
11498 @opindex ml
11499 Compile code for the processor in little endian mode.
11500
11501 @item -mdalign
11502 @opindex mdalign
11503 Align doubles at 64-bit boundaries.  Note that this changes the calling
11504 conventions, and thus some functions from the standard C library will
11505 not work unless you recompile it first with @option{-mdalign}.
11506
11507 @item -mrelax
11508 @opindex mrelax
11509 Shorten some address references at link time, when possible; uses the
11510 linker option @option{-relax}.
11511
11512 @item -mbigtable
11513 @opindex mbigtable
11514 Use 32-bit offsets in @code{switch} tables.  The default is to use
11515 16-bit offsets.
11516
11517 @item -mfmovd
11518 @opindex mfmovd
11519 Enable the use of the instruction @code{fmovd}.
11520
11521 @item -mhitachi
11522 @opindex mhitachi
11523 Comply with the calling conventions defined by Renesas.
11524
11525 @item -mrenesas
11526 @opindex mhitachi
11527 Comply with the calling conventions defined by Renesas.
11528
11529 @item -mno-renesas
11530 @opindex mhitachi
11531 Comply with the calling conventions defined for GCC before the Renesas
11532 conventions were available.  This option is the default for all
11533 targets of the SH toolchain except for @samp{sh-symbianelf}.
11534
11535 @item -mnomacsave
11536 @opindex mnomacsave
11537 Mark the @code{MAC} register as call-clobbered, even if
11538 @option{-mhitachi} is given.
11539
11540 @item -mieee
11541 @opindex mieee
11542 Increase IEEE-compliance of floating-point code.
11543 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11544 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11545 comparisons of NANs / infinities incurs extra overhead in every
11546 floating point comparison, therefore the default is set to
11547 @option{-ffinite-math-only}.
11548
11549 @item -misize
11550 @opindex misize
11551 Dump instruction size and location in the assembly code.
11552
11553 @item -mpadstruct
11554 @opindex mpadstruct
11555 This option is deprecated.  It pads structures to multiple of 4 bytes,
11556 which is incompatible with the SH ABI@.
11557
11558 @item -mspace
11559 @opindex mspace
11560 Optimize for space instead of speed.  Implied by @option{-Os}.
11561
11562 @item -mprefergot
11563 @opindex mprefergot
11564 When generating position-independent code, emit function calls using
11565 the Global Offset Table instead of the Procedure Linkage Table.
11566
11567 @item -musermode
11568 @opindex musermode
11569 Generate a library function call to invalidate instruction cache
11570 entries, after fixing up a trampoline.  This library function call
11571 doesn't assume it can write to the whole memory address space.  This
11572 is the default when the target is @code{sh-*-linux*}.
11573
11574 @item -multcost=@var{number}
11575 @opindex multcost=@var{number}
11576 Set the cost to assume for a multiply insn.
11577
11578 @item -mdiv=@var{strategy}
11579 @opindex mdiv=@var{strategy}
11580 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11581 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11582 inv:call2, inv:fp .
11583 "fp" performs the operation in floating point.  This has a very high latency,
11584 but needs only a few instructions, so it might be a good choice if
11585 your code has enough easily exploitable ILP to allow the compiler to
11586 schedule the floating point instructions together with other instructions.
11587 Division by zero causes a floating point exception.
11588 "inv" uses integer operations to calculate the inverse of the divisor,
11589 and then multiplies the dividend with the inverse.  This strategy allows
11590 cse and hoisting of the inverse calculation.  Division by zero calculates
11591 an unspecified result, but does not trap.
11592 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11593 have been found, or if the entire operation has been hoisted to the same
11594 place, the last stages of the inverse calculation are intertwined with the
11595 final multiply to reduce the overall latency, at the expense of using a few
11596 more instructions, and thus offering fewer scheduling opportunities with
11597 other code.
11598 "call" calls a library function that usually implements the inv:minlat
11599 strategy.
11600 This gives high code density for m5-*media-nofpu compilations.
11601 "call2" uses a different entry point of the same library function, where it
11602 assumes that a pointer to a lookup table has already been set up, which
11603 exposes the pointer load to cse / code hoisting optimizations.
11604 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11605 code generation, but if the code stays unoptimized, revert to the "call",
11606 "call2", or "fp" strategies, respectively.  Note that the
11607 potentially-trapping side effect of division by zero is carried by a
11608 separate instruction, so it is possible that all the integer instructions
11609 are hoisted out, but the marker for the side effect stays where it is.
11610 A recombination to fp operations or a call is not possible in that case.
11611 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11612 that the inverse calculation was nor separated from the multiply, they speed
11613 up division where the dividend fits into 20 bits (plus sign where applicable),
11614 by inserting a test to skip a number of operations in this case; this test
11615 slows down the case of larger dividends.  inv20u assumes the case of a such
11616 a small dividend to be unlikely, and inv20l assumes it to be likely.
11617
11618 @item -mdivsi3_libfunc=@var{name}
11619 @opindex mdivsi3_libfunc=@var{name}
11620 Set the name of the library function used for 32 bit signed division to
11621 @var{name}.  This only affect the name used in the call and inv:call
11622 division strategies, and the compiler will still expect the same
11623 sets of input/output/clobbered registers as if this option was not present.
11624
11625 @item -madjust-unroll
11626 @opindex madjust-unroll
11627 Throttle unrolling to avoid thrashing target registers.
11628 This option only has an effect if the gcc code base supports the
11629 TARGET_ADJUST_UNROLL_MAX target hook.
11630
11631 @item -mindexed-addressing
11632 @opindex mindexed-addressing
11633 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11634 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11635 semantics for the indexed addressing mode.  The architecture allows the
11636 implementation of processors with 64 bit MMU, which the OS could use to
11637 get 32 bit addressing, but since no current hardware implementation supports
11638 this or any other way to make the indexed addressing mode safe to use in
11639 the 32 bit ABI, the default is -mno-indexed-addressing.
11640
11641 @item -mgettrcost=@var{number}
11642 @opindex mgettrcost=@var{number}
11643 Set the cost assumed for the gettr instruction to @var{number}.
11644 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11645
11646 @item -mpt-fixed
11647 @opindex mpt-fixed
11648 Assume pt* instructions won't trap.  This will generally generate better
11649 scheduled code, but is unsafe on current hardware.  The current architecture
11650 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11651 This has the unintentional effect of making it unsafe to schedule ptabs /
11652 ptrel before a branch, or hoist it out of a loop.  For example,
11653 __do_global_ctors, a part of libgcc that runs constructors at program
11654 startup, calls functions in a list which is delimited by -1.  With the
11655 -mpt-fixed option, the ptabs will be done before testing against -1.
11656 That means that all the constructors will be run a bit quicker, but when
11657 the loop comes to the end of the list, the program crashes because ptabs
11658 loads -1 into a target register.  Since this option is unsafe for any
11659 hardware implementing the current architecture specification, the default
11660 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11661 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11662 this deters register allocation using target registers for storing
11663 ordinary integers.
11664
11665 @item -minvalid-symbols
11666 @opindex minvalid-symbols
11667 Assume symbols might be invalid.  Ordinary function symbols generated by
11668 the compiler will always be valid to load with movi/shori/ptabs or
11669 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11670 to generate symbols that will cause ptabs / ptrel to trap.
11671 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11672 It will then prevent cross-basic-block cse, hoisting and most scheduling
11673 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11674 @end table
11675
11676 @node SPARC Options
11677 @subsection SPARC Options
11678 @cindex SPARC options
11679
11680 These @samp{-m} options are supported on the SPARC:
11681
11682 @table @gcctabopt
11683 @item -mno-app-regs
11684 @itemx -mapp-regs
11685 @opindex mno-app-regs
11686 @opindex mapp-regs
11687 Specify @option{-mapp-regs} to generate output using the global registers
11688 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11689 is the default.
11690
11691 To be fully SVR4 ABI compliant at the cost of some performance loss,
11692 specify @option{-mno-app-regs}.  You should compile libraries and system
11693 software with this option.
11694
11695 @item -mfpu
11696 @itemx -mhard-float
11697 @opindex mfpu
11698 @opindex mhard-float
11699 Generate output containing floating point instructions.  This is the
11700 default.
11701
11702 @item -mno-fpu
11703 @itemx -msoft-float
11704 @opindex mno-fpu
11705 @opindex msoft-float
11706 Generate output containing library calls for floating point.
11707 @strong{Warning:} the requisite libraries are not available for all SPARC
11708 targets.  Normally the facilities of the machine's usual C compiler are
11709 used, but this cannot be done directly in cross-compilation.  You must make
11710 your own arrangements to provide suitable library functions for
11711 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11712 @samp{sparclite-*-*} do provide software floating point support.
11713
11714 @option{-msoft-float} changes the calling convention in the output file;
11715 therefore, it is only useful if you compile @emph{all} of a program with
11716 this option.  In particular, you need to compile @file{libgcc.a}, the
11717 library that comes with GCC, with @option{-msoft-float} in order for
11718 this to work.
11719
11720 @item -mhard-quad-float
11721 @opindex mhard-quad-float
11722 Generate output containing quad-word (long double) floating point
11723 instructions.
11724
11725 @item -msoft-quad-float
11726 @opindex msoft-quad-float
11727 Generate output containing library calls for quad-word (long double)
11728 floating point instructions.  The functions called are those specified
11729 in the SPARC ABI@.  This is the default.
11730
11731 As of this writing, there are no SPARC implementations that have hardware
11732 support for the quad-word floating point instructions.  They all invoke
11733 a trap handler for one of these instructions, and then the trap handler
11734 emulates the effect of the instruction.  Because of the trap handler overhead,
11735 this is much slower than calling the ABI library routines.  Thus the
11736 @option{-msoft-quad-float} option is the default.
11737
11738 @item -mno-unaligned-doubles
11739 @itemx -munaligned-doubles
11740 @opindex mno-unaligned-doubles
11741 @opindex munaligned-doubles
11742 Assume that doubles have 8 byte alignment.  This is the default.
11743
11744 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11745 alignment only if they are contained in another type, or if they have an
11746 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11747 Specifying this option avoids some rare compatibility problems with code
11748 generated by other compilers.  It is not the default because it results
11749 in a performance loss, especially for floating point code.
11750
11751 @item -mno-faster-structs
11752 @itemx -mfaster-structs
11753 @opindex mno-faster-structs
11754 @opindex mfaster-structs
11755 With @option{-mfaster-structs}, the compiler assumes that structures
11756 should have 8 byte alignment.  This enables the use of pairs of
11757 @code{ldd} and @code{std} instructions for copies in structure
11758 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11759 However, the use of this changed alignment directly violates the SPARC
11760 ABI@.  Thus, it's intended only for use on targets where the developer
11761 acknowledges that their resulting code will not be directly in line with
11762 the rules of the ABI@.
11763
11764 @item -mimpure-text
11765 @opindex mimpure-text
11766 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11767 the compiler to not pass @option{-z text} to the linker when linking a
11768 shared object.  Using this option, you can link position-dependent
11769 code into a shared object.
11770
11771 @option{-mimpure-text} suppresses the ``relocations remain against
11772 allocatable but non-writable sections'' linker error message.
11773 However, the necessary relocations will trigger copy-on-write, and the
11774 shared object is not actually shared across processes.  Instead of
11775 using @option{-mimpure-text}, you should compile all source code with
11776 @option{-fpic} or @option{-fPIC}.
11777
11778 This option is only available on SunOS and Solaris.
11779
11780 @item -mcpu=@var{cpu_type}
11781 @opindex mcpu
11782 Set the instruction set, register set, and instruction scheduling parameters
11783 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11784 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11785 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11786 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11787 @samp{ultrasparc3}.
11788
11789 Default instruction scheduling parameters are used for values that select
11790 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11791 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11792
11793 Here is a list of each supported architecture and their supported
11794 implementations.
11795
11796 @smallexample
11797     v7:             cypress
11798     v8:             supersparc, hypersparc
11799     sparclite:      f930, f934, sparclite86x
11800     sparclet:       tsc701
11801     v9:             ultrasparc, ultrasparc3
11802 @end smallexample
11803
11804 By default (unless configured otherwise), GCC generates code for the V7
11805 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11806 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11807 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11808 SPARCStation 1, 2, IPX etc.
11809
11810 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11811 architecture.  The only difference from V7 code is that the compiler emits
11812 the integer multiply and integer divide instructions which exist in SPARC-V8
11813 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11814 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11815 2000 series.
11816
11817 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11818 the SPARC architecture.  This adds the integer multiply, integer divide step
11819 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11820 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11821 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11822 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11823 MB86934 chip, which is the more recent SPARClite with FPU@.
11824
11825 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11826 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11827 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11828 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11829 optimizes it for the TEMIC SPARClet chip.
11830
11831 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11832 architecture.  This adds 64-bit integer and floating-point move instructions,
11833 3 additional floating-point condition code registers and conditional move
11834 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11835 optimizes it for the Sun UltraSPARC I/II chips.  With
11836 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11837 Sun UltraSPARC III chip.
11838
11839 @item -mtune=@var{cpu_type}
11840 @opindex mtune
11841 Set the instruction scheduling parameters for machine type
11842 @var{cpu_type}, but do not set the instruction set or register set that the
11843 option @option{-mcpu=@var{cpu_type}} would.
11844
11845 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11846 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11847 that select a particular cpu implementation.  Those are @samp{cypress},
11848 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11849 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11850 @samp{ultrasparc3}.
11851
11852 @item -mv8plus
11853 @itemx -mno-v8plus
11854 @opindex mv8plus
11855 @opindex mno-v8plus
11856 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11857 difference from the V8 ABI is that the global and out registers are
11858 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11859 mode for all SPARC-V9 processors.
11860
11861 @item -mvis
11862 @itemx -mno-vis
11863 @opindex mvis
11864 @opindex mno-vis
11865 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11866 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11867 @end table
11868
11869 These @samp{-m} options are supported in addition to the above
11870 on SPARC-V9 processors in 64-bit environments:
11871
11872 @table @gcctabopt
11873 @item -mlittle-endian
11874 @opindex mlittle-endian
11875 Generate code for a processor running in little-endian mode.  It is only
11876 available for a few configurations and most notably not on Solaris and Linux.
11877
11878 @item -m32
11879 @itemx -m64
11880 @opindex m32
11881 @opindex m64
11882 Generate code for a 32-bit or 64-bit environment.
11883 The 32-bit environment sets int, long and pointer to 32 bits.
11884 The 64-bit environment sets int to 32 bits and long and pointer
11885 to 64 bits.
11886
11887 @item -mcmodel=medlow
11888 @opindex mcmodel=medlow
11889 Generate code for the Medium/Low code model: 64-bit addresses, programs
11890 must be linked in the low 32 bits of memory.  Programs can be statically
11891 or dynamically linked.
11892
11893 @item -mcmodel=medmid
11894 @opindex mcmodel=medmid
11895 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11896 must be linked in the low 44 bits of memory, the text and data segments must
11897 be less than 2GB in size and the data segment must be located within 2GB of
11898 the text segment.
11899
11900 @item -mcmodel=medany
11901 @opindex mcmodel=medany
11902 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11903 may be linked anywhere in memory, the text and data segments must be less
11904 than 2GB in size and the data segment must be located within 2GB of the
11905 text segment.
11906
11907 @item -mcmodel=embmedany
11908 @opindex mcmodel=embmedany
11909 Generate code for the Medium/Anywhere code model for embedded systems:
11910 64-bit addresses, the text and data segments must be less than 2GB in
11911 size, both starting anywhere in memory (determined at link time).  The
11912 global register %g4 points to the base of the data segment.  Programs
11913 are statically linked and PIC is not supported.
11914
11915 @item -mstack-bias
11916 @itemx -mno-stack-bias
11917 @opindex mstack-bias
11918 @opindex mno-stack-bias
11919 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11920 frame pointer if present, are offset by @minus{}2047 which must be added back
11921 when making stack frame references.  This is the default in 64-bit mode.
11922 Otherwise, assume no such offset is present.
11923 @end table
11924
11925 These switches are supported in addition to the above on Solaris:
11926
11927 @table @gcctabopt
11928 @item -threads
11929 @opindex threads
11930 Add support for multithreading using the Solaris threads library.  This
11931 option sets flags for both the preprocessor and linker.  This option does
11932 not affect the thread safety of object code produced by the compiler or
11933 that of libraries supplied with it.
11934
11935 @item -pthreads
11936 @opindex pthreads
11937 Add support for multithreading using the POSIX threads library.  This
11938 option sets flags for both the preprocessor and linker.  This option does
11939 not affect the thread safety of object code produced  by the compiler or
11940 that of libraries supplied with it.
11941 @end table
11942
11943 @node System V Options
11944 @subsection Options for System V
11945
11946 These additional options are available on System V Release 4 for
11947 compatibility with other compilers on those systems:
11948
11949 @table @gcctabopt
11950 @item -G
11951 @opindex G
11952 Create a shared object.
11953 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11954
11955 @item -Qy
11956 @opindex Qy
11957 Identify the versions of each tool used by the compiler, in a
11958 @code{.ident} assembler directive in the output.
11959
11960 @item -Qn
11961 @opindex Qn
11962 Refrain from adding @code{.ident} directives to the output file (this is
11963 the default).
11964
11965 @item -YP,@var{dirs}
11966 @opindex YP
11967 Search the directories @var{dirs}, and no others, for libraries
11968 specified with @option{-l}.
11969
11970 @item -Ym,@var{dir}
11971 @opindex Ym
11972 Look in the directory @var{dir} to find the M4 preprocessor.
11973 The assembler uses this option.
11974 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11975 @c the generic assembler that comes with Solaris takes just -Ym.
11976 @end table
11977
11978 @node TMS320C3x/C4x Options
11979 @subsection TMS320C3x/C4x Options
11980 @cindex TMS320C3x/C4x Options
11981
11982 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11983
11984 @table @gcctabopt
11985
11986 @item -mcpu=@var{cpu_type}
11987 @opindex mcpu
11988 Set the instruction set, register set, and instruction scheduling
11989 parameters for machine type @var{cpu_type}.  Supported values for
11990 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11991 @samp{c44}.  The default is @samp{c40} to generate code for the
11992 TMS320C40.
11993
11994 @item -mbig-memory
11995 @itemx -mbig
11996 @itemx -msmall-memory
11997 @itemx -msmall
11998 @opindex mbig-memory
11999 @opindex mbig
12000 @opindex msmall-memory
12001 @opindex msmall
12002 Generates code for the big or small memory model.  The small memory
12003 model assumed that all data fits into one 64K word page.  At run-time
12004 the data page (DP) register must be set to point to the 64K page
12005 containing the .bss and .data program sections.  The big memory model is
12006 the default and requires reloading of the DP register for every direct
12007 memory access.
12008
12009 @item -mbk
12010 @itemx -mno-bk
12011 @opindex mbk
12012 @opindex mno-bk
12013 Allow (disallow) allocation of general integer operands into the block
12014 count register BK@.
12015
12016 @item -mdb
12017 @itemx -mno-db
12018 @opindex mdb
12019 @opindex mno-db
12020 Enable (disable) generation of code using decrement and branch,
12021 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12022 on the safe side, this is disabled for the C3x, since the maximum
12023 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12024 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12025 that it can utilize the decrement and branch instruction, but will give
12026 up if there is more than one memory reference in the loop.  Thus a loop
12027 where the loop counter is decremented can generate slightly more
12028 efficient code, in cases where the RPTB instruction cannot be utilized.
12029
12030 @item -mdp-isr-reload
12031 @itemx -mparanoid
12032 @opindex mdp-isr-reload
12033 @opindex mparanoid
12034 Force the DP register to be saved on entry to an interrupt service
12035 routine (ISR), reloaded to point to the data section, and restored on
12036 exit from the ISR@.  This should not be required unless someone has
12037 violated the small memory model by modifying the DP register, say within
12038 an object library.
12039
12040 @item -mmpyi
12041 @itemx -mno-mpyi
12042 @opindex mmpyi
12043 @opindex mno-mpyi
12044 For the C3x use the 24-bit MPYI instruction for integer multiplies
12045 instead of a library call to guarantee 32-bit results.  Note that if one
12046 of the operands is a constant, then the multiplication will be performed
12047 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12048 then squaring operations are performed inline instead of a library call.
12049
12050 @item -mfast-fix
12051 @itemx -mno-fast-fix
12052 @opindex mfast-fix
12053 @opindex mno-fast-fix
12054 The C3x/C4x FIX instruction to convert a floating point value to an
12055 integer value chooses the nearest integer less than or equal to the
12056 floating point value rather than to the nearest integer.  Thus if the
12057 floating point number is negative, the result will be incorrectly
12058 truncated an additional code is necessary to detect and correct this
12059 case.  This option can be used to disable generation of the additional
12060 code required to correct the result.
12061
12062 @item -mrptb
12063 @itemx -mno-rptb
12064 @opindex mrptb
12065 @opindex mno-rptb
12066 Enable (disable) generation of repeat block sequences using the RPTB
12067 instruction for zero overhead looping.  The RPTB construct is only used
12068 for innermost loops that do not call functions or jump across the loop
12069 boundaries.  There is no advantage having nested RPTB loops due to the
12070 overhead required to save and restore the RC, RS, and RE registers.
12071 This is enabled by default with @option{-O2}.
12072
12073 @item -mrpts=@var{count}
12074 @itemx -mno-rpts
12075 @opindex mrpts
12076 @opindex mno-rpts
12077 Enable (disable) the use of the single instruction repeat instruction
12078 RPTS@.  If a repeat block contains a single instruction, and the loop
12079 count can be guaranteed to be less than the value @var{count}, GCC will
12080 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12081 then a RPTS will be emitted even if the loop count cannot be determined
12082 at compile time.  Note that the repeated instruction following RPTS does
12083 not have to be reloaded from memory each iteration, thus freeing up the
12084 CPU buses for operands.  However, since interrupts are blocked by this
12085 instruction, it is disabled by default.
12086
12087 @item -mloop-unsigned
12088 @itemx -mno-loop-unsigned
12089 @opindex mloop-unsigned
12090 @opindex mno-loop-unsigned
12091 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12092 is @math{2^{31} + 1} since these instructions test if the iteration count is
12093 negative to terminate the loop.  If the iteration count is unsigned
12094 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12095 exceeded.  This switch allows an unsigned iteration count.
12096
12097 @item -mti
12098 @opindex mti
12099 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12100 with.  This also enforces compatibility with the API employed by the TI
12101 C3x C compiler.  For example, long doubles are passed as structures
12102 rather than in floating point registers.
12103
12104 @item -mregparm
12105 @itemx -mmemparm
12106 @opindex mregparm
12107 @opindex mmemparm
12108 Generate code that uses registers (stack) for passing arguments to functions.
12109 By default, arguments are passed in registers where possible rather
12110 than by pushing arguments on to the stack.
12111
12112 @item -mparallel-insns
12113 @itemx -mno-parallel-insns
12114 @opindex mparallel-insns
12115 @opindex mno-parallel-insns
12116 Allow the generation of parallel instructions.  This is enabled by
12117 default with @option{-O2}.
12118
12119 @item -mparallel-mpy
12120 @itemx -mno-parallel-mpy
12121 @opindex mparallel-mpy
12122 @opindex mno-parallel-mpy
12123 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12124 provided @option{-mparallel-insns} is also specified.  These instructions have
12125 tight register constraints which can pessimize the code generation
12126 of large functions.
12127
12128 @end table
12129
12130 @node V850 Options
12131 @subsection V850 Options
12132 @cindex V850 Options
12133
12134 These @samp{-m} options are defined for V850 implementations:
12135
12136 @table @gcctabopt
12137 @item -mlong-calls
12138 @itemx -mno-long-calls
12139 @opindex mlong-calls
12140 @opindex mno-long-calls
12141 Treat all calls as being far away (near).  If calls are assumed to be
12142 far away, the compiler will always load the functions address up into a
12143 register, and call indirect through the pointer.
12144
12145 @item -mno-ep
12146 @itemx -mep
12147 @opindex mno-ep
12148 @opindex mep
12149 Do not optimize (do optimize) basic blocks that use the same index
12150 pointer 4 or more times to copy pointer into the @code{ep} register, and
12151 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12152 option is on by default if you optimize.
12153
12154 @item -mno-prolog-function
12155 @itemx -mprolog-function
12156 @opindex mno-prolog-function
12157 @opindex mprolog-function
12158 Do not use (do use) external functions to save and restore registers
12159 at the prologue and epilogue of a function.  The external functions
12160 are slower, but use less code space if more than one function saves
12161 the same number of registers.  The @option{-mprolog-function} option
12162 is on by default if you optimize.
12163
12164 @item -mspace
12165 @opindex mspace
12166 Try to make the code as small as possible.  At present, this just turns
12167 on the @option{-mep} and @option{-mprolog-function} options.
12168
12169 @item -mtda=@var{n}
12170 @opindex mtda
12171 Put static or global variables whose size is @var{n} bytes or less into
12172 the tiny data area that register @code{ep} points to.  The tiny data
12173 area can hold up to 256 bytes in total (128 bytes for byte references).
12174
12175 @item -msda=@var{n}
12176 @opindex msda
12177 Put static or global variables whose size is @var{n} bytes or less into
12178 the small data area that register @code{gp} points to.  The small data
12179 area can hold up to 64 kilobytes.
12180
12181 @item -mzda=@var{n}
12182 @opindex mzda
12183 Put static or global variables whose size is @var{n} bytes or less into
12184 the first 32 kilobytes of memory.
12185
12186 @item -mv850
12187 @opindex mv850
12188 Specify that the target processor is the V850.
12189
12190 @item -mbig-switch
12191 @opindex mbig-switch
12192 Generate code suitable for big switch tables.  Use this option only if
12193 the assembler/linker complain about out of range branches within a switch
12194 table.
12195
12196 @item -mapp-regs
12197 @opindex mapp-regs
12198 This option will cause r2 and r5 to be used in the code generated by
12199 the compiler.  This setting is the default.
12200
12201 @item -mno-app-regs
12202 @opindex mno-app-regs
12203 This option will cause r2 and r5 to be treated as fixed registers.
12204
12205 @item -mv850e1
12206 @opindex mv850e1
12207 Specify that the target processor is the V850E1.  The preprocessor
12208 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12209 this option is used.
12210
12211 @item -mv850e
12212 @opindex mv850e
12213 Specify that the target processor is the V850E@.  The preprocessor
12214 constant @samp{__v850e__} will be defined if this option is used.
12215
12216 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12217 are defined then a default target processor will be chosen and the
12218 relevant @samp{__v850*__} preprocessor constant will be defined.
12219
12220 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12221 defined, regardless of which processor variant is the target.
12222
12223 @item -mdisable-callt
12224 @opindex mdisable-callt
12225 This option will suppress generation of the CALLT instruction for the
12226 v850e and v850e1 flavors of the v850 architecture.  The default is
12227 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12228
12229 @end table
12230
12231 @node VAX Options
12232 @subsection VAX Options
12233 @cindex VAX options
12234
12235 These @samp{-m} options are defined for the VAX:
12236
12237 @table @gcctabopt
12238 @item -munix
12239 @opindex munix
12240 Do not output certain jump instructions (@code{aobleq} and so on)
12241 that the Unix assembler for the VAX cannot handle across long
12242 ranges.
12243
12244 @item -mgnu
12245 @opindex mgnu
12246 Do output those jump instructions, on the assumption that you
12247 will assemble with the GNU assembler.
12248
12249 @item -mg
12250 @opindex mg
12251 Output code for g-format floating point numbers instead of d-format.
12252 @end table
12253
12254 @node x86-64 Options
12255 @subsection x86-64 Options
12256 @cindex x86-64 options
12257
12258 These are listed under @xref{i386 and x86-64 Options}.
12259
12260 @node Xstormy16 Options
12261 @subsection Xstormy16 Options
12262 @cindex Xstormy16 Options
12263
12264 These options are defined for Xstormy16:
12265
12266 @table @gcctabopt
12267 @item -msim
12268 @opindex msim
12269 Choose startup files and linker script suitable for the simulator.
12270 @end table
12271
12272 @node Xtensa Options
12273 @subsection Xtensa Options
12274 @cindex Xtensa Options
12275
12276 These options are supported for Xtensa targets:
12277
12278 @table @gcctabopt
12279 @item -mconst16
12280 @itemx -mno-const16
12281 @opindex mconst16
12282 @opindex mno-const16
12283 Enable or disable use of @code{CONST16} instructions for loading
12284 constant values.  The @code{CONST16} instruction is currently not a
12285 standard option from Tensilica.  When enabled, @code{CONST16}
12286 instructions are always used in place of the standard @code{L32R}
12287 instructions.  The use of @code{CONST16} is enabled by default only if
12288 the @code{L32R} instruction is not available.
12289
12290 @item -mfused-madd
12291 @itemx -mno-fused-madd
12292 @opindex mfused-madd
12293 @opindex mno-fused-madd
12294 Enable or disable use of fused multiply/add and multiply/subtract
12295 instructions in the floating-point option.  This has no effect if the
12296 floating-point option is not also enabled.  Disabling fused multiply/add
12297 and multiply/subtract instructions forces the compiler to use separate
12298 instructions for the multiply and add/subtract operations.  This may be
12299 desirable in some cases where strict IEEE 754-compliant results are
12300 required: the fused multiply add/subtract instructions do not round the
12301 intermediate result, thereby producing results with @emph{more} bits of
12302 precision than specified by the IEEE standard.  Disabling fused multiply
12303 add/subtract instructions also ensures that the program output is not
12304 sensitive to the compiler's ability to combine multiply and add/subtract
12305 operations.
12306
12307 @item -mtext-section-literals
12308 @itemx -mno-text-section-literals
12309 @opindex mtext-section-literals
12310 @opindex mno-text-section-literals
12311 Control the treatment of literal pools.  The default is
12312 @option{-mno-text-section-literals}, which places literals in a separate
12313 section in the output file.  This allows the literal pool to be placed
12314 in a data RAM/ROM, and it also allows the linker to combine literal
12315 pools from separate object files to remove redundant literals and
12316 improve code size.  With @option{-mtext-section-literals}, the literals
12317 are interspersed in the text section in order to keep them as close as
12318 possible to their references.  This may be necessary for large assembly
12319 files.
12320
12321 @item -mtarget-align
12322 @itemx -mno-target-align
12323 @opindex mtarget-align
12324 @opindex mno-target-align
12325 When this option is enabled, GCC instructs the assembler to
12326 automatically align instructions to reduce branch penalties at the
12327 expense of some code density.  The assembler attempts to widen density
12328 instructions to align branch targets and the instructions following call
12329 instructions.  If there are not enough preceding safe density
12330 instructions to align a target, no widening will be performed.  The
12331 default is @option{-mtarget-align}.  These options do not affect the
12332 treatment of auto-aligned instructions like @code{LOOP}, which the
12333 assembler will always align, either by widening density instructions or
12334 by inserting no-op instructions.
12335
12336 @item -mlongcalls
12337 @itemx -mno-longcalls
12338 @opindex mlongcalls
12339 @opindex mno-longcalls
12340 When this option is enabled, GCC instructs the assembler to translate
12341 direct calls to indirect calls unless it can determine that the target
12342 of a direct call is in the range allowed by the call instruction.  This
12343 translation typically occurs for calls to functions in other source
12344 files.  Specifically, the assembler translates a direct @code{CALL}
12345 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12346 The default is @option{-mno-longcalls}.  This option should be used in
12347 programs where the call target can potentially be out of range.  This
12348 option is implemented in the assembler, not the compiler, so the
12349 assembly code generated by GCC will still show direct call
12350 instructions---look at the disassembled object code to see the actual
12351 instructions.  Note that the assembler will use an indirect call for
12352 every cross-file call, not just those that really will be out of range.
12353 @end table
12354
12355 @node zSeries Options
12356 @subsection zSeries Options
12357 @cindex zSeries options
12358
12359 These are listed under @xref{S/390 and zSeries Options}.
12360
12361 @node Code Gen Options
12362 @section Options for Code Generation Conventions
12363 @cindex code generation conventions
12364 @cindex options, code generation
12365 @cindex run-time options
12366
12367 These machine-independent options control the interface conventions
12368 used in code generation.
12369
12370 Most of them have both positive and negative forms; the negative form
12371 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12372 one of the forms is listed---the one which is not the default.  You
12373 can figure out the other form by either removing @samp{no-} or adding
12374 it.
12375
12376 @table @gcctabopt
12377 @item -fbounds-check
12378 @opindex fbounds-check
12379 For front-ends that support it, generate additional code to check that
12380 indices used to access arrays are within the declared range.  This is
12381 currently only supported by the Java and Fortran 77 front-ends, where
12382 this option defaults to true and false respectively.
12383
12384 @item -ftrapv
12385 @opindex ftrapv
12386 This option generates traps for signed overflow on addition, subtraction,
12387 multiplication operations.
12388
12389 @item -fwrapv
12390 @opindex fwrapv
12391 This option instructs the compiler to assume that signed arithmetic
12392 overflow of addition, subtraction and multiplication wraps around
12393 using twos-complement representation.  This flag enables some optimizations
12394 and disables other.  This option is enabled by default for the Java
12395 front-end, as required by the Java language specification.
12396
12397 @item -fexceptions
12398 @opindex fexceptions
12399 Enable exception handling.  Generates extra code needed to propagate
12400 exceptions.  For some targets, this implies GCC will generate frame
12401 unwind information for all functions, which can produce significant data
12402 size overhead, although it does not affect execution.  If you do not
12403 specify this option, GCC will enable it by default for languages like
12404 C++ which normally require exception handling, and disable it for
12405 languages like C that do not normally require it.  However, you may need
12406 to enable this option when compiling C code that needs to interoperate
12407 properly with exception handlers written in C++.  You may also wish to
12408 disable this option if you are compiling older C++ programs that don't
12409 use exception handling.
12410
12411 @item -fnon-call-exceptions
12412 @opindex fnon-call-exceptions
12413 Generate code that allows trapping instructions to throw exceptions.
12414 Note that this requires platform-specific runtime support that does
12415 not exist everywhere.  Moreover, it only allows @emph{trapping}
12416 instructions to throw exceptions, i.e.@: memory references or floating
12417 point instructions.  It does not allow exceptions to be thrown from
12418 arbitrary signal handlers such as @code{SIGALRM}.
12419
12420 @item -funwind-tables
12421 @opindex funwind-tables
12422 Similar to @option{-fexceptions}, except that it will just generate any needed
12423 static data, but will not affect the generated code in any other way.
12424 You will normally not enable this option; instead, a language processor
12425 that needs this handling would enable it on your behalf.
12426
12427 @item -fasynchronous-unwind-tables
12428 @opindex fasynchronous-unwind-tables
12429 Generate unwind table in dwarf2 format, if supported by target machine.  The
12430 table is exact at each instruction boundary, so it can be used for stack
12431 unwinding from asynchronous events (such as debugger or garbage collector).
12432
12433 @item -fpcc-struct-return
12434 @opindex fpcc-struct-return
12435 Return ``short'' @code{struct} and @code{union} values in memory like
12436 longer ones, rather than in registers.  This convention is less
12437 efficient, but it has the advantage of allowing intercallability between
12438 GCC-compiled files and files compiled with other compilers, particularly
12439 the Portable C Compiler (pcc).
12440
12441 The precise convention for returning structures in memory depends
12442 on the target configuration macros.
12443
12444 Short structures and unions are those whose size and alignment match
12445 that of some integer type.
12446
12447 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12448 switch is not binary compatible with code compiled with the
12449 @option{-freg-struct-return} switch.
12450 Use it to conform to a non-default application binary interface.
12451
12452 @item -freg-struct-return
12453 @opindex freg-struct-return
12454 Return @code{struct} and @code{union} values in registers when possible.
12455 This is more efficient for small structures than
12456 @option{-fpcc-struct-return}.
12457
12458 If you specify neither @option{-fpcc-struct-return} nor
12459 @option{-freg-struct-return}, GCC defaults to whichever convention is
12460 standard for the target.  If there is no standard convention, GCC
12461 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12462 the principal compiler.  In those cases, we can choose the standard, and
12463 we chose the more efficient register return alternative.
12464
12465 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12466 switch is not binary compatible with code compiled with the
12467 @option{-fpcc-struct-return} switch.
12468 Use it to conform to a non-default application binary interface.
12469
12470 @item -fshort-enums
12471 @opindex fshort-enums
12472 Allocate to an @code{enum} type only as many bytes as it needs for the
12473 declared range of possible values.  Specifically, the @code{enum} type
12474 will be equivalent to the smallest integer type which has enough room.
12475
12476 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12477 code that is not binary compatible with code generated without that switch.
12478 Use it to conform to a non-default application binary interface.
12479
12480 @item -fshort-double
12481 @opindex fshort-double
12482 Use the same size for @code{double} as for @code{float}.
12483
12484 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12485 code that is not binary compatible with code generated without that switch.
12486 Use it to conform to a non-default application binary interface.
12487
12488 @item -fshort-wchar
12489 @opindex fshort-wchar
12490 Override the underlying type for @samp{wchar_t} to be @samp{short
12491 unsigned int} instead of the default for the target.  This option is
12492 useful for building programs to run under WINE@.
12493
12494 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12495 code that is not binary compatible with code generated without that switch.
12496 Use it to conform to a non-default application binary interface.
12497
12498 @item -fshared-data
12499 @opindex fshared-data
12500 Requests that the data and non-@code{const} variables of this
12501 compilation be shared data rather than private data.  The distinction
12502 makes sense only on certain operating systems, where shared data is
12503 shared between processes running the same program, while private data
12504 exists in one copy per process.
12505
12506 @item -fno-common
12507 @opindex fno-common
12508 In C, allocate even uninitialized global variables in the data section of the
12509 object file, rather than generating them as common blocks.  This has the
12510 effect that if the same variable is declared (without @code{extern}) in
12511 two different compilations, you will get an error when you link them.
12512 The only reason this might be useful is if you wish to verify that the
12513 program will work on other systems which always work this way.
12514
12515 @item -fno-ident
12516 @opindex fno-ident
12517 Ignore the @samp{#ident} directive.
12518
12519 @item -finhibit-size-directive
12520 @opindex finhibit-size-directive
12521 Don't output a @code{.size} assembler directive, or anything else that
12522 would cause trouble if the function is split in the middle, and the
12523 two halves are placed at locations far apart in memory.  This option is
12524 used when compiling @file{crtstuff.c}; you should not need to use it
12525 for anything else.
12526
12527 @item -fverbose-asm
12528 @opindex fverbose-asm
12529 Put extra commentary information in the generated assembly code to
12530 make it more readable.  This option is generally only of use to those
12531 who actually need to read the generated assembly code (perhaps while
12532 debugging the compiler itself).
12533
12534 @option{-fno-verbose-asm}, the default, causes the
12535 extra information to be omitted and is useful when comparing two assembler
12536 files.
12537
12538 @item -fpic
12539 @opindex fpic
12540 @cindex global offset table
12541 @cindex PIC
12542 Generate position-independent code (PIC) suitable for use in a shared
12543 library, if supported for the target machine.  Such code accesses all
12544 constant addresses through a global offset table (GOT)@.  The dynamic
12545 loader resolves the GOT entries when the program starts (the dynamic
12546 loader is not part of GCC; it is part of the operating system).  If
12547 the GOT size for the linked executable exceeds a machine-specific
12548 maximum size, you get an error message from the linker indicating that
12549 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12550 instead.  (These maximums are 8k on the SPARC and 32k
12551 on the m68k and RS/6000.  The 386 has no such limit.)
12552
12553 Position-independent code requires special support, and therefore works
12554 only on certain machines.  For the 386, GCC supports PIC for System V
12555 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12556 position-independent.
12557
12558 @item -fPIC
12559 @opindex fPIC
12560 If supported for the target machine, emit position-independent code,
12561 suitable for dynamic linking and avoiding any limit on the size of the
12562 global offset table.  This option makes a difference on the m68k,
12563 PowerPC and SPARC@.
12564
12565 Position-independent code requires special support, and therefore works
12566 only on certain machines.
12567
12568 @item -fpie
12569 @itemx -fPIE
12570 @opindex fpie
12571 @opindex fPIE
12572 These options are similar to @option{-fpic} and @option{-fPIC}, but
12573 generated position independent code can be only linked into executables.
12574 Usually these options are used when @option{-pie} GCC option will be
12575 used during linking.
12576
12577 @item -ffixed-@var{reg}
12578 @opindex ffixed
12579 Treat the register named @var{reg} as a fixed register; generated code
12580 should never refer to it (except perhaps as a stack pointer, frame
12581 pointer or in some other fixed role).
12582
12583 @var{reg} must be the name of a register.  The register names accepted
12584 are machine-specific and are defined in the @code{REGISTER_NAMES}
12585 macro in the machine description macro file.
12586
12587 This flag does not have a negative form, because it specifies a
12588 three-way choice.
12589
12590 @item -fcall-used-@var{reg}
12591 @opindex fcall-used
12592 Treat the register named @var{reg} as an allocable register that is
12593 clobbered by function calls.  It may be allocated for temporaries or
12594 variables that do not live across a call.  Functions compiled this way
12595 will not save and restore the register @var{reg}.
12596
12597 It is an error to used this flag with the frame pointer or stack pointer.
12598 Use of this flag for other registers that have fixed pervasive roles in
12599 the machine's execution model will produce disastrous results.
12600
12601 This flag does not have a negative form, because it specifies a
12602 three-way choice.
12603
12604 @item -fcall-saved-@var{reg}
12605 @opindex fcall-saved
12606 Treat the register named @var{reg} as an allocable register saved by
12607 functions.  It may be allocated even for temporaries or variables that
12608 live across a call.  Functions compiled this way will save and restore
12609 the register @var{reg} if they use it.
12610
12611 It is an error to used this flag with the frame pointer or stack pointer.
12612 Use of this flag for other registers that have fixed pervasive roles in
12613 the machine's execution model will produce disastrous results.
12614
12615 A different sort of disaster will result from the use of this flag for
12616 a register in which function values may be returned.
12617
12618 This flag does not have a negative form, because it specifies a
12619 three-way choice.
12620
12621 @item -fpack-struct[=@var{n}]
12622 @opindex fpack-struct
12623 Without a value specified, pack all structure members together without
12624 holes.  When a value is specified (which must be a small power of two), pack
12625 structure members according to this value, representing the maximum
12626 alignment (that is, objects with default alignment requirements larger than
12627 this will be output potentially unaligned at the next fitting location.
12628
12629 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12630 code that is not binary compatible with code generated without that switch.
12631 Additionally, it makes the code suboptimal.
12632 Use it to conform to a non-default application binary interface.
12633
12634 @item -finstrument-functions
12635 @opindex finstrument-functions
12636 Generate instrumentation calls for entry and exit to functions.  Just
12637 after function entry and just before function exit, the following
12638 profiling functions will be called with the address of the current
12639 function and its call site.  (On some platforms,
12640 @code{__builtin_return_address} does not work beyond the current
12641 function, so the call site information may not be available to the
12642 profiling functions otherwise.)
12643
12644 @smallexample
12645 void __cyg_profile_func_enter (void *this_fn,
12646                                void *call_site);
12647 void __cyg_profile_func_exit  (void *this_fn,
12648                                void *call_site);
12649 @end smallexample
12650
12651 The first argument is the address of the start of the current function,
12652 which may be looked up exactly in the symbol table.
12653
12654 This instrumentation is also done for functions expanded inline in other
12655 functions.  The profiling calls will indicate where, conceptually, the
12656 inline function is entered and exited.  This means that addressable
12657 versions of such functions must be available.  If all your uses of a
12658 function are expanded inline, this may mean an additional expansion of
12659 code size.  If you use @samp{extern inline} in your C code, an
12660 addressable version of such functions must be provided.  (This is
12661 normally the case anyways, but if you get lucky and the optimizer always
12662 expands the functions inline, you might have gotten away without
12663 providing static copies.)
12664
12665 A function may be given the attribute @code{no_instrument_function}, in
12666 which case this instrumentation will not be done.  This can be used, for
12667 example, for the profiling functions listed above, high-priority
12668 interrupt routines, and any functions from which the profiling functions
12669 cannot safely be called (perhaps signal handlers, if the profiling
12670 routines generate output or allocate memory).
12671
12672 @item -fstack-check
12673 @opindex fstack-check
12674 Generate code to verify that you do not go beyond the boundary of the
12675 stack.  You should specify this flag if you are running in an
12676 environment with multiple threads, but only rarely need to specify it in
12677 a single-threaded environment since stack overflow is automatically
12678 detected on nearly all systems if there is only one stack.
12679
12680 Note that this switch does not actually cause checking to be done; the
12681 operating system must do that.  The switch causes generation of code
12682 to ensure that the operating system sees the stack being extended.
12683
12684 @item -fstack-limit-register=@var{reg}
12685 @itemx -fstack-limit-symbol=@var{sym}
12686 @itemx -fno-stack-limit
12687 @opindex fstack-limit-register
12688 @opindex fstack-limit-symbol
12689 @opindex fno-stack-limit
12690 Generate code to ensure that the stack does not grow beyond a certain value,
12691 either the value of a register or the address of a symbol.  If the stack
12692 would grow beyond the value, a signal is raised.  For most targets,
12693 the signal is raised before the stack overruns the boundary, so
12694 it is possible to catch the signal without taking special precautions.
12695
12696 For instance, if the stack starts at absolute address @samp{0x80000000}
12697 and grows downwards, you can use the flags
12698 @option{-fstack-limit-symbol=__stack_limit} and
12699 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12700 of 128KB@.  Note that this may only work with the GNU linker.
12701
12702 @cindex aliasing of parameters
12703 @cindex parameters, aliased
12704 @item -fargument-alias
12705 @itemx -fargument-noalias
12706 @itemx -fargument-noalias-global
12707 @opindex fargument-alias
12708 @opindex fargument-noalias
12709 @opindex fargument-noalias-global
12710 Specify the possible relationships among parameters and between
12711 parameters and global data.
12712
12713 @option{-fargument-alias} specifies that arguments (parameters) may
12714 alias each other and may alias global storage.@*
12715 @option{-fargument-noalias} specifies that arguments do not alias
12716 each other, but may alias global storage.@*
12717 @option{-fargument-noalias-global} specifies that arguments do not
12718 alias each other and do not alias global storage.
12719
12720 Each language will automatically use whatever option is required by
12721 the language standard.  You should not need to use these options yourself.
12722
12723 @item -fleading-underscore
12724 @opindex fleading-underscore
12725 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12726 change the way C symbols are represented in the object file.  One use
12727 is to help link with legacy assembly code.
12728
12729 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12730 generate code that is not binary compatible with code generated without that
12731 switch.  Use it to conform to a non-default application binary interface.
12732 Not all targets provide complete support for this switch.
12733
12734 @item -ftls-model=@var{model}
12735 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12736 The @var{model} argument should be one of @code{global-dynamic},
12737 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12738
12739 The default without @option{-fpic} is @code{initial-exec}; with
12740 @option{-fpic} the default is @code{global-dynamic}.
12741
12742 @item -fvisibility=@var{default|internal|hidden|protected}
12743 @opindex fvisibility
12744 Set the default ELF image symbol visibility to the specified option---all
12745 symbols will be marked with this unless overridden within the code.
12746 Using this feature can very substantially improve linking and
12747 load times of shared object libraries, produce more optimized
12748 code, provide near-perfect API export and prevent symbol clashes.
12749 It is @strong{strongly} recommended that you use this in any shared objects
12750 you distribute.
12751
12752 Despite the nomenclature, @code{default} always means public ie;
12753 available to be linked against from outside the shared object.
12754 @code{protected} and @code{internal} are pretty useless in real-world
12755 usage so the only other commonly used option will be @code{hidden}.
12756 The default if @option{-fvisibility} isn't specified is
12757 @code{default}, i.e., make every
12758 symbol public---this causes the same behavior as previous versions of
12759 GCC@.
12760
12761 A good explanation of the benefits offered by ensuring ELF
12762 symbols have the correct visibility is given by ``How To Write
12763 Shared Libraries'' by Ulrich Drepper (which can be found at
12764 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12765 solution made possible by this option to marking things hidden when
12766 the default is public is to make the default hidden and mark things
12767 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12768 and @code{__attribute__ ((visibility("default")))} instead of
12769 @code{__declspec(dllexport)} you get almost identical semantics with
12770 identical syntax.  This is a great boon to those working with
12771 cross-platform projects.
12772
12773 For those adding visibility support to existing code, you may find
12774 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12775 the declarations you wish to set visibility for with (for example)
12776 @samp{#pragma GCC visibility push(hidden)} and
12777 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12778 times.  Bear in mind that symbol visibility should be viewed @strong{as
12779 part of the API interface contract} and thus all new code should
12780 always specify visibility when it is not the default ie; declarations
12781 only for use within the local DSO should @strong{always} be marked explicitly
12782 as hidden as so to avoid PLT indirection overheads---making this
12783 abundantly clear also aids readability and self-documentation of the code.
12784 Note that due to ISO C++ specification requirements, operator new and
12785 operator delete must always be of default visibility.
12786
12787 An overview of these techniques, their benefits and how to use them
12788 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12789
12790 @end table
12791
12792 @c man end
12793
12794 @node Environment Variables
12795 @section Environment Variables Affecting GCC
12796 @cindex environment variables
12797
12798 @c man begin ENVIRONMENT
12799 This section describes several environment variables that affect how GCC
12800 operates.  Some of them work by specifying directories or prefixes to use
12801 when searching for various kinds of files.  Some are used to specify other
12802 aspects of the compilation environment.
12803
12804 Note that you can also specify places to search using options such as
12805 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12806 take precedence over places specified using environment variables, which
12807 in turn take precedence over those specified by the configuration of GCC@.
12808 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12809 GNU Compiler Collection (GCC) Internals}.
12810
12811 @table @env
12812 @item LANG
12813 @itemx LC_CTYPE
12814 @c @itemx LC_COLLATE
12815 @itemx LC_MESSAGES
12816 @c @itemx LC_MONETARY
12817 @c @itemx LC_NUMERIC
12818 @c @itemx LC_TIME
12819 @itemx LC_ALL
12820 @findex LANG
12821 @findex LC_CTYPE
12822 @c @findex LC_COLLATE
12823 @findex LC_MESSAGES
12824 @c @findex LC_MONETARY
12825 @c @findex LC_NUMERIC
12826 @c @findex LC_TIME
12827 @findex LC_ALL
12828 @cindex locale
12829 These environment variables control the way that GCC uses
12830 localization information that allow GCC to work with different
12831 national conventions.  GCC inspects the locale categories
12832 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12833 so.  These locale categories can be set to any value supported by your
12834 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12835 Kingdom encoded in UTF-8.
12836
12837 The @env{LC_CTYPE} environment variable specifies character
12838 classification.  GCC uses it to determine the character boundaries in
12839 a string; this is needed for some multibyte encodings that contain quote
12840 and escape characters that would otherwise be interpreted as a string
12841 end or escape.
12842
12843 The @env{LC_MESSAGES} environment variable specifies the language to
12844 use in diagnostic messages.
12845
12846 If the @env{LC_ALL} environment variable is set, it overrides the value
12847 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12848 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12849 environment variable.  If none of these variables are set, GCC
12850 defaults to traditional C English behavior.
12851
12852 @item TMPDIR
12853 @findex TMPDIR
12854 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12855 files.  GCC uses temporary files to hold the output of one stage of
12856 compilation which is to be used as input to the next stage: for example,
12857 the output of the preprocessor, which is the input to the compiler
12858 proper.
12859
12860 @item GCC_EXEC_PREFIX
12861 @findex GCC_EXEC_PREFIX
12862 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12863 names of the subprograms executed by the compiler.  No slash is added
12864 when this prefix is combined with the name of a subprogram, but you can
12865 specify a prefix that ends with a slash if you wish.
12866
12867 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12868 an appropriate prefix to use based on the pathname it was invoked with.
12869
12870 If GCC cannot find the subprogram using the specified prefix, it
12871 tries looking in the usual places for the subprogram.
12872
12873 The default value of @env{GCC_EXEC_PREFIX} is
12874 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12875 of @code{prefix} when you ran the @file{configure} script.
12876
12877 Other prefixes specified with @option{-B} take precedence over this prefix.
12878
12879 This prefix is also used for finding files such as @file{crt0.o} that are
12880 used for linking.
12881
12882 In addition, the prefix is used in an unusual way in finding the
12883 directories to search for header files.  For each of the standard
12884 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12885 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12886 replacing that beginning with the specified prefix to produce an
12887 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12888 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12889 These alternate directories are searched first; the standard directories
12890 come next.
12891
12892 @item COMPILER_PATH
12893 @findex COMPILER_PATH
12894 The value of @env{COMPILER_PATH} is a colon-separated list of
12895 directories, much like @env{PATH}.  GCC tries the directories thus
12896 specified when searching for subprograms, if it can't find the
12897 subprograms using @env{GCC_EXEC_PREFIX}.
12898
12899 @item LIBRARY_PATH
12900 @findex LIBRARY_PATH
12901 The value of @env{LIBRARY_PATH} is a colon-separated list of
12902 directories, much like @env{PATH}.  When configured as a native compiler,
12903 GCC tries the directories thus specified when searching for special
12904 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12905 using GCC also uses these directories when searching for ordinary
12906 libraries for the @option{-l} option (but directories specified with
12907 @option{-L} come first).
12908
12909 @item LANG
12910 @findex LANG
12911 @cindex locale definition
12912 This variable is used to pass locale information to the compiler.  One way in
12913 which this information is used is to determine the character set to be used
12914 when character literals, string literals and comments are parsed in C and C++.
12915 When the compiler is configured to allow multibyte characters,
12916 the following values for @env{LANG} are recognized:
12917
12918 @table @samp
12919 @item C-JIS
12920 Recognize JIS characters.
12921 @item C-SJIS
12922 Recognize SJIS characters.
12923 @item C-EUCJP
12924 Recognize EUCJP characters.
12925 @end table
12926
12927 If @env{LANG} is not defined, or if it has some other value, then the
12928 compiler will use mblen and mbtowc as defined by the default locale to
12929 recognize and translate multibyte characters.
12930 @end table
12931
12932 @noindent
12933 Some additional environments variables affect the behavior of the
12934 preprocessor.
12935
12936 @include cppenv.texi
12937
12938 @c man end
12939
12940 @node Precompiled Headers
12941 @section Using Precompiled Headers
12942 @cindex precompiled headers
12943 @cindex speed of compilation
12944
12945 Often large projects have many header files that are included in every
12946 source file.  The time the compiler takes to process these header files
12947 over and over again can account for nearly all of the time required to
12948 build the project.  To make builds faster, GCC allows users to
12949 `precompile' a header file; then, if builds can use the precompiled
12950 header file they will be much faster.
12951
12952 To create a precompiled header file, simply compile it as you would any
12953 other file, if necessary using the @option{-x} option to make the driver
12954 treat it as a C or C++ header file.  You will probably want to use a
12955 tool like @command{make} to keep the precompiled header up-to-date when
12956 the headers it contains change.
12957
12958 A precompiled header file will be searched for when @code{#include} is
12959 seen in the compilation.  As it searches for the included file
12960 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12961 compiler looks for a precompiled header in each directory just before it
12962 looks for the include file in that directory.  The name searched for is
12963 the name specified in the @code{#include} with @samp{.gch} appended.  If
12964 the precompiled header file can't be used, it is ignored.
12965
12966 For instance, if you have @code{#include "all.h"}, and you have
12967 @file{all.h.gch} in the same directory as @file{all.h}, then the
12968 precompiled header file will be used if possible, and the original
12969 header will be used otherwise.
12970
12971 Alternatively, you might decide to put the precompiled header file in a
12972 directory and use @option{-I} to ensure that directory is searched
12973 before (or instead of) the directory containing the original header.
12974 Then, if you want to check that the precompiled header file is always
12975 used, you can put a file of the same name as the original header in this
12976 directory containing an @code{#error} command.
12977
12978 This also works with @option{-include}.  So yet another way to use
12979 precompiled headers, good for projects not designed with precompiled
12980 header files in mind, is to simply take most of the header files used by
12981 a project, include them from another header file, precompile that header
12982 file, and @option{-include} the precompiled header.  If the header files
12983 have guards against multiple inclusion, they will be skipped because
12984 they've already been included (in the precompiled header).
12985
12986 If you need to precompile the same header file for different
12987 languages, targets, or compiler options, you can instead make a
12988 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12989 header in the directory, perhaps using @option{-o}.  It doesn't matter
12990 what you call the files in the directory, every precompiled header in
12991 the directory will be considered.  The first precompiled header
12992 encountered in the directory that is valid for this compilation will
12993 be used; they're searched in no particular order.
12994
12995 There are many other possibilities, limited only by your imagination,
12996 good sense, and the constraints of your build system.
12997
12998 A precompiled header file can be used only when these conditions apply:
12999
13000 @itemize
13001 @item
13002 Only one precompiled header can be used in a particular compilation.
13003
13004 @item
13005 A precompiled header can't be used once the first C token is seen.  You
13006 can have preprocessor directives before a precompiled header; you can
13007 even include a precompiled header from inside another header, so long as
13008 there are no C tokens before the @code{#include}.
13009
13010 @item
13011 The precompiled header file must be produced for the same language as
13012 the current compilation.  You can't use a C precompiled header for a C++
13013 compilation.
13014
13015 @item
13016 The precompiled header file must have been produced by the same compiler
13017 binary as the current compilation is using.
13018
13019 @item
13020 Any macros defined before the precompiled header is included must
13021 either be defined in the same way as when the precompiled header was
13022 generated, or must not affect the precompiled header, which usually
13023 means that they don't appear in the precompiled header at all.
13024
13025 The @option{-D} option is one way to define a macro before a
13026 precompiled header is included; using a @code{#define} can also do it.
13027 There are also some options that define macros implicitly, like
13028 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13029 defined this way.
13030
13031 @item If debugging information is output when using the precompiled
13032 header, using @option{-g} or similar, the same kind of debugging information
13033 must have been output when building the precompiled header.  However,
13034 a precompiled header built using @option{-g} can be used in a compilation
13035 when no debugging information is being output.
13036
13037 @item The same @option{-m} options must generally be used when building
13038 and using the precompiled header.  @xref{Submodel Options},
13039 for any cases where this rule is relaxed.
13040
13041 @item Each of the following options must be the same when building and using
13042 the precompiled header:
13043
13044 @gccoptlist{-fexceptions -funit-at-a-time}
13045
13046 @item
13047 Some other command-line options starting with @option{-f},
13048 @option{-p}, or @option{-O} must be defined in the same way as when
13049 the precompiled header was generated.  At present, it's not clear
13050 which options are safe to change and which are not; the safest choice
13051 is to use exactly the same options when generating and using the
13052 precompiled header.  The following are known to be safe:
13053
13054 @gccoptlist{-fpreprocessed
13055 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13056 -fsched-verbose=<number> -fschedule-insns
13057 -pedantic-errors}
13058
13059 @end itemize
13060
13061 For all of these except the last, the compiler will automatically
13062 ignore the precompiled header if the conditions aren't met.  If you
13063 find an option combination that doesn't work and doesn't cause the
13064 precompiled header to be ignored, please consider filing a bug report,
13065 see @ref{Bugs}.
13066
13067 If you do use differing options when generating and using the
13068 precompiled header, the actual behavior will be a mixture of the
13069 behavior for the options.  For instance, if you use @option{-g} to
13070 generate the precompiled header but not when using it, you may or may
13071 not get debugging information for routines in the precompiled header.
13072
13073 @node Running Protoize
13074 @section Running Protoize
13075
13076 The program @code{protoize} is an optional part of GCC@.  You can use
13077 it to add prototypes to a program, thus converting the program to ISO
13078 C in one respect.  The companion program @code{unprotoize} does the
13079 reverse: it removes argument types from any prototypes that are found.
13080
13081 When you run these programs, you must specify a set of source files as
13082 command line arguments.  The conversion programs start out by compiling
13083 these files to see what functions they define.  The information gathered
13084 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13085
13086 After scanning comes actual conversion.  The specified files are all
13087 eligible to be converted; any files they include (whether sources or
13088 just headers) are eligible as well.
13089
13090 But not all the eligible files are converted.  By default,
13091 @code{protoize} and @code{unprotoize} convert only source and header
13092 files in the current directory.  You can specify additional directories
13093 whose files should be converted with the @option{-d @var{directory}}
13094 option.  You can also specify particular files to exclude with the
13095 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13096 directory name matches one of the specified directory names, and its
13097 name within the directory has not been excluded.
13098
13099 Basic conversion with @code{protoize} consists of rewriting most
13100 function definitions and function declarations to specify the types of
13101 the arguments.  The only ones not rewritten are those for varargs
13102 functions.
13103
13104 @code{protoize} optionally inserts prototype declarations at the
13105 beginning of the source file, to make them available for any calls that
13106 precede the function's definition.  Or it can insert prototype
13107 declarations with block scope in the blocks where undeclared functions
13108 are called.
13109
13110 Basic conversion with @code{unprotoize} consists of rewriting most
13111 function declarations to remove any argument types, and rewriting
13112 function definitions to the old-style pre-ISO form.
13113
13114 Both conversion programs print a warning for any function declaration or
13115 definition that they can't convert.  You can suppress these warnings
13116 with @option{-q}.
13117
13118 The output from @code{protoize} or @code{unprotoize} replaces the
13119 original source file.  The original file is renamed to a name ending
13120 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13121 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13122 for DOS) file already exists, then the source file is simply discarded.
13123
13124 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13125 scan the program and collect information about the functions it uses.
13126 So neither of these programs will work until GCC is installed.
13127
13128 Here is a table of the options you can use with @code{protoize} and
13129 @code{unprotoize}.  Each option works with both programs unless
13130 otherwise stated.
13131
13132 @table @code
13133 @item -B @var{directory}
13134 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13135 usual directory (normally @file{/usr/local/lib}).  This file contains
13136 prototype information about standard system functions.  This option
13137 applies only to @code{protoize}.
13138
13139 @item -c @var{compilation-options}
13140 Use @var{compilation-options} as the options when running @command{gcc} to
13141 produce the @samp{.X} files.  The special option @option{-aux-info} is
13142 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13143
13144 Note that the compilation options must be given as a single argument to
13145 @code{protoize} or @code{unprotoize}.  If you want to specify several
13146 @command{gcc} options, you must quote the entire set of compilation options
13147 to make them a single word in the shell.
13148
13149 There are certain @command{gcc} arguments that you cannot use, because they
13150 would produce the wrong kind of output.  These include @option{-g},
13151 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13152 the @var{compilation-options}, they are ignored.
13153
13154 @item -C
13155 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13156 systems) instead of @samp{.c}.  This is convenient if you are converting
13157 a C program to C++.  This option applies only to @code{protoize}.
13158
13159 @item -g
13160 Add explicit global declarations.  This means inserting explicit
13161 declarations at the beginning of each source file for each function
13162 that is called in the file and was not declared.  These declarations
13163 precede the first function definition that contains a call to an
13164 undeclared function.  This option applies only to @code{protoize}.
13165
13166 @item -i @var{string}
13167 Indent old-style parameter declarations with the string @var{string}.
13168 This option applies only to @code{protoize}.
13169
13170 @code{unprotoize} converts prototyped function definitions to old-style
13171 function definitions, where the arguments are declared between the
13172 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13173 uses five spaces as the indentation.  If you want to indent with just
13174 one space instead, use @option{-i " "}.
13175
13176 @item -k
13177 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13178 is finished.
13179
13180 @item -l
13181 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13182 a prototype declaration for each function in each block which calls the
13183 function without any declaration.  This option applies only to
13184 @code{protoize}.
13185
13186 @item -n
13187 Make no real changes.  This mode just prints information about the conversions
13188 that would have been done without @option{-n}.
13189
13190 @item -N
13191 Make no @samp{.save} files.  The original files are simply deleted.
13192 Use this option with caution.
13193
13194 @item -p @var{program}
13195 Use the program @var{program} as the compiler.  Normally, the name
13196 @file{gcc} is used.
13197
13198 @item -q
13199 Work quietly.  Most warnings are suppressed.
13200
13201 @item -v
13202 Print the version number, just like @option{-v} for @command{gcc}.
13203 @end table
13204
13205 If you need special compiler options to compile one of your program's
13206 source files, then you should generate that file's @samp{.X} file
13207 specially, by running @command{gcc} on that source file with the
13208 appropriate options and the option @option{-aux-info}.  Then run
13209 @code{protoize} on the entire set of files.  @code{protoize} will use
13210 the existing @samp{.X} file because it is newer than the source file.
13211 For example:
13212
13213 @smallexample
13214 gcc -Dfoo=bar file1.c -aux-info file1.X
13215 protoize *.c
13216 @end smallexample
13217
13218 @noindent
13219 You need to include the special files along with the rest in the
13220 @code{protoize} command, even though their @samp{.X} files already
13221 exist, because otherwise they won't get converted.
13222
13223 @xref{Protoize Caveats}, for more information on how to use
13224 @code{protoize} successfully.